Big-Data-HPC-Platform/esp/services/ws_packageprocess/ws_packageprocessService.hpp

/*##############################################################################

    HPCC SYSTEMS software Copyright (C) 2012 HPCC Systems®.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
############################################################################## */

#ifndef _ESPWIZ_ws_packageprocess_HPP__
#define _ESPWIZ_ws_packageprocess_HPP__

#include "ws_packageprocess_esp.ipp"
#include "dasds.hpp"
#include "environment.hpp"

#define THORCLUSTER "thor"
#define HTHORCLUSTER "hthor"
#define ROXIECLUSTER "roxie"

#define PMAS_RELOAD_PACKAGE_SET 0x01
#define PMAS_RELOAD_PACKAGE_MAP 0x02

class PackageMapAndSet : public CInterface, implements ISDSSubscription
{
    Owned<IPropertyTree> tree;
    SubscriptionId pmChange;
    SubscriptionId psChange;
    mutable CriticalSection crit;
    mutable CriticalSection dirtyCrit; //if there were an atomic_or I would just use atomic
    unsigned dirty;

    void load(unsigned flags);
    void load(const char* path, IPropertyTree* t);

public:
    IMPLEMENT_IINTERFACE;
    PackageMapAndSet() : pmChange(0), psChange(0), dirty(PMAS_RELOAD_PACKAGE_SET | PMAS_RELOAD_PACKAGE_MAP)
    {
        tree.setown(createPTree("PackageMapAndSet"));
    }

    virtual void notify(SubscriptionId subid, const char *xpath, SDSNotifyFlags flags, unsigned valueLen, const void *valueData)
    {
        Linked<PackageMapAndSet> me = this;  // Ensure that I am not released by the notify call (which would then access freed memory to release the critsec)
        CriticalBlock b(dirtyCrit);
        if (subid == pmChange)
            dirty |= PMAS_RELOAD_PACKAGE_MAP;
        else if (subid == psChange)
            dirty |= PMAS_RELOAD_PACKAGE_SET;
    }

    virtual bool subscribe()
    {
        CriticalBlock b(crit);
        if (!pmChange)
            pmChange = querySDS().subscribe("PackageMaps", *this, true);
        if(!psChange)
            psChange = querySDS().subscribe("PackageSets", *this, true);

        return pmChange != 0 && psChange != 0;
    }

    virtual bool unsubscribe()
    {
        CriticalBlock b(crit);
        bool success = true;
        try
        {
            if (pmChange)
                querySDS().unsubscribe(pmChange);
            if (psChange)
                querySDS().unsubscribe(psChange);
        }
        catch (IException *E)
        {
            E->Release();
            success = false;
        }
        pmChange = 0;
        psChange = 0;
        return success;
    }

    IPropertyTree *getTree()
    {
        CriticalBlock b(crit);
        unsigned flags;
        {
            CriticalBlock b(dirtyCrit);
            flags = dirty;
            dirty = 0;
        }
        if (flags)
            load(flags);
        return LINK(tree);
    }

    IPropertyTree *getPackageMaps()
    {
        Owned<IPropertyTree> root = getTree();
        return root->getPropTree("PackageMaps");
    }

    IPropertyTree *getPackageSets()
    {
        Owned<IPropertyTree> root = getTree();
        return root->getPropTree("PackageSets");
    }

    StringBuffer &toStr(StringBuffer &s)
    {
        Owned<IPropertyTree> t = getTree();
        return toXML(t, s);
    }
};

class CWsPackageProcessSoapBindingEx : public CWsPackageProcessSoapBinding
{
public:
    CWsPackageProcessSoapBindingEx(IPropertyTree *cfg, const char *name, const char *process, http_soap_log_level llevel=hsl_none) : CWsPackageProcessSoapBinding(cfg, name, process, llevel)
    {
    }

    virtual void getNavigationData(IEspContext &context, IPropertyTree & data)
    {
        if (queryComponentConfig().getPropBool("@api_only"))
        {
            CHttpSoapBinding::getNavigationData(context, data);
            return;
        }
        //Add navigation link here
        IPropertyTree *folderQueryset = ensureNavFolder(data, "Queries", NULL);
        CEspBinding::ensureNavLink(*folderQueryset, "Package Maps", "/esp/files/stub.htm?Widget=PackageMapQueryWidget", "Browse Package Maps", NULL, NULL, 2);
    }
    int onFinishUpload(IEspContext &ctx, CHttpRequest* request, CHttpResponse* response, const char *service,
        const char *method, StringArray& fileNames, StringArray& files, IMultiException *me);
};


class CWsPackageProcessEx : public CWsPackageProcess
{
    bool readPackageMapString(const char *packageMapString, StringBuffer &target, StringBuffer &process, StringBuffer &packageMap);
    void getPkgInfoById(const char *target, const char *packageMapId, IPropertyTree* tree);
    void getPkgInfoById(const char *packageMapId, IPropertyTree* tree);
    void deletePackage(const char *packageMap, const char *target, const char *process, bool globalScope, StringBuffer &returnMsg, int &returnCode);
    void validatePackage(IEspContext &context, IEspValidatePackageRequest &req, IPropertyTree *packageMapTree, IConstWUClusterInfo *clusterInfo,
        StringArray &queriesToVerify, StringArray &queriesToIgnore, IEspValidatePackageResponse *resp, IArrayOf<IEspValidateResult>& results);
public:
    IMPLEMENT_IINTERFACE;
    virtual ~CWsPackageProcessEx()
    {
        packageMapAndSet.unsubscribe();
    };

    virtual void init(IPropertyTree *cfg, const char *process, const char *service);

    virtual bool onEcho(IEspContext &context, IEspEchoRequest &req, IEspEchoResponse &resp);
    virtual bool onAddPackage(IEspContext &context, IEspAddPackageRequest &req, IEspAddPackageResponse &resp);
    virtual bool onCopyPackageMap(IEspContext &context, IEspCopyPackageMapRequest &req, IEspCopyPackageMapResponse &resp);
    virtual bool onDeletePackage(IEspContext &context, IEspDeletePackageRequest &req, IEspDeletePackageResponse &resp);
    virtual bool onActivatePackage(IEspContext &context, IEspActivatePackageRequest &req, IEspActivatePackageResponse &resp);
    virtual bool onDeActivatePackage(IEspContext &context, IEspDeActivatePackageRequest &req, IEspDeActivatePackageResponse &resp);
    virtual bool onListPackage(IEspContext &context, IEspListPackageRequest &req, IEspListPackageResponse &resp);
    virtual bool onGetPackage(IEspContext &context, IEspGetPackageRequest &req, IEspGetPackageResponse &resp);
    virtual bool onValidatePackage(IEspContext &context, IEspValidatePackageRequest &req, IEspValidatePackageResponse &resp);
    virtual bool onGetQueryFileMapping(IEspContext &context, IEspGetQueryFileMappingRequest &req, IEspGetQueryFileMappingResponse &resp);
    virtual bool onListPackages(IEspContext &context, IEspListPackagesRequest &req, IEspListPackagesResponse &resp);
    virtual bool onGetPackageMapSelectOptions(IEspContext &context, IEspGetPackageMapSelectOptionsRequest &req, IEspGetPackageMapSelectOptionsResponse &resp);
    virtual bool onGetPackageMapById(IEspContext &context, IEspGetPackageMapByIdRequest &req, IEspGetPackageMapByIdResponse &resp);
    virtual bool onAddPartToPackageMap(IEspContext &context, IEspAddPartToPackageMapRequest &req, IEspAddPartToPackageMapResponse &resp);
    virtual bool onGetPartFromPackageMap(IEspContext &context, IEspGetPartFromPackageMapRequest &req, IEspGetPartFromPackageMapResponse &resp);
    virtual bool onRemovePartFromPackageMap(IEspContext &context, IEspRemovePartFromPackageMapRequest &req, IEspRemovePartFromPackageMapResponse &resp);

    virtual bool unsubscribeServiceFromDali() override
    {
        return packageMapAndSet.unsubscribe();
    }

    virtual bool subscribeServiceToDali() override
    {
        return packageMapAndSet.subscribe();
    }

    PackageMapAndSet packageMapAndSet;
};

#endif //_ESPWIZ_ws_packageprocess_HPP__