CLegacyObjectCollectionControllerCompBase.h

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ImtCore-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QJsonObject>
#include <QtCore/QJsonArray>
 
// ACF includes
#include <iprm/CParamsSet.h>
 
// ImtCore includes
#include <imtbase/IObjectCollection.h>
#include <imtbase/IObjectCollectionIterator.h>
#include <imtbase/IOperationContext.h>
#include <imtbase/IDocumentChangeGenerator.h>
#include <imtbase/IOperationContextController.h>
#include <imtservergql/CPermissibleGqlRequestHandlerComp.h>
#include <imtserverapp/CTimeFilterParamRepresentationController.h>
#include <imtgql/IGqlRequestExtractor.h>
#include <imtbase/IComplexCollectionFilter.h>
 
 
#undef GetObject
 
 
namespace imtservergql
{
 
 
class CLegacyObjectCollectionControllerCompBase:
                     public imtgql::IGqlRequestExtractor,
                     public imtservergql::CPermissibleGqlRequestHandlerComp
{
public:
       typedef imtservergql::CPermissibleGqlRequestHandlerComp BaseClass;
 
       I_BEGIN_BASE_COMPONENT(CLegacyObjectCollectionControllerCompBase);
              I_REGISTER_INTERFACE(imtgql::IGqlRequestExtractor)
              I_ASSIGN_MULTI_0(m_replaceableFieldsAttrPtr, "ReplaceableFilterFields", "List of filter fields to be replaced", false);
              I_ASSIGN_MULTI_0(m_replacementFieldsAttrPtr, "ReplacementFilterFields", "List of filter fields to replace with", false);
              I_ASSIGN(m_objectCollectionCompPtr, "ObjectCollection", "Object collection", true, "ObjectCollection");
              I_ASSIGN(m_documentChangeGeneratorCompPtr, "DocumentChangeGenerator", "Change generator for the collection object", false, "DocumentChangeGenerator");
              I_ASSIGN(m_headersProviderCompPtr, "HeadersProvider", "Headers provider", false, "HeadersProvider");
              I_ASSIGN(m_translationManagerCompPtr, "TranslationManager", "Translation manager", false, "TranslationManager");
              I_ASSIGN(m_operationContextControllerCompPtr, "OperationContextController", "Operation context controller", false, "OperationContextController");
              I_ASSIGN_MULTI_0(m_objectTypeIdAttrPtr, "ObjectTypeIds", "Object type IDs", false);
              I_ASSIGN_MULTI_0(m_objectFactCompPtr, "CollectionObjectFactory", "Collection object factories", false);
              I_ASSIGN_MULTI_0(m_mimeTypeAttrPtr, "MimeType", "Mime type for the import/export object", false);
              I_ASSIGN_MULTI_0(m_importExportObjectFactCompPtr, "ImportExportObjectFactory", "Object factory for the import/export object", false);
              I_ASSIGN_MULTI_0(m_filePersistenceCompPtr, "FilePersistence", "File persistence for the import/export object", false);
       I_END_COMPONENT;
 
       enum OperationType
       {
              OT_UNKNOWN,
              OT_NEW,
              OT_GET,
              OT_UPDATE,
              OT_UPDATE_COLLECTION,
              OT_DELETE,
              OT_RENAME,
              OT_SET_DESCRIPTION,
              OT_LIST,
              OT_HEADERS,
              OT_INFO,
              OT_METAINFO,
              OT_DATAMETAINFO,
              OT_ELEMENTS_COUNT,
              OT_ELEMENT_IDS,
              OT_ELEMENT_HISTORY,
              OT_IMPORT,
              OT_EXPORT,
              OT_USER_OPERATION = 1000
       };
 
       // reimplemented (imtservergql::CGqlRequestHandlerCompBase)
       virtual QJsonObject CreateInternalResponse(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const override;
 
       // reimplemented (imtgql::IGqlRequestExtractor)
       virtual istd::IChangeableUniquePtr ExtractObject(const imtgql::CGqlRequest& gqlRequest, QByteArray& newObjectId, QString& errorMessage) const override;
 
protected:
       void ReplaceComplexFilterFields(imtbase::IComplexCollectionFilter& filter) const;
 
       virtual bool GetOperationFromRequest(const imtgql::CGqlRequest& gqlRequest, imtgql::CGqlParamObject& gqlObject, QString& errorMessage, int& operationType) const;
       virtual QByteArray GetObjectIdFromInputParams(const imtgql::CGqlParamObject &inputParams) const;
       virtual QByteArray GetObjectIdFromRequest(const imtgql::CGqlRequest& gqlRequest) const;
       virtual QJsonObject GetObject(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject InsertObject(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject UpdateObject(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject UpdateCollection(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject RenameObject(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject SetObjectDescription(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject ListObjects(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetElementsCount(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetElementIds(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject DeleteObject(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetHeaders(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetTreeItemModel(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetDependencies(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetMetaInfo(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetInfo(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetDataMetaInfo(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject GetObjectHistory(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject ImportObject(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
       virtual QJsonObject ExportObject(const imtgql::CGqlRequest& gqlRequest, QString& errorMessage) const;
 
       virtual bool ConvertObject(const istd::IChangeable& source, istd::IChangeable& target) const;
       virtual int GetObjectTypeIdIndex(const QByteArray& typeId) const;
       virtual int GetMimeTypeIndex(const QString& mimeType) const;
 
       virtual bool SetupGqlItem(
                     const imtgql::CGqlRequest& gqlRequest,
                     QJsonObject& itemObj,
                     const QByteArray& collectionId,
                     QString& errorMessage) const;
 
       virtual bool SetupGqlItem(
                     const imtgql::CGqlRequest& gqlRequest,
                     QJsonObject& itemObj,
                     const imtbase::IObjectCollectionIterator* objectCollectionIterator,
                     QString& errorMessage) const;
 
       virtual QByteArrayList GetInformationIds(const imtgql::CGqlRequest& gqlRequest, const QByteArray& objectId) const;
 
       virtual QVariant GetObjectInformation(const QByteArray& informationId, const QByteArray& objectId) const;
 
       QByteArray GetObjectTypeIdFromRequest(const imtgql::CGqlRequest& gqlRequest) const;
 
       virtual bool CreateRepresentationFromObject(
                            const istd::IChangeable& data,
                            const QByteArray& objectTypeId,
                            const imtgql::CGqlRequest& gqlRequest,
                            QJsonObject& dataObj,
                            QString& errorMessage) const;
 
       [[deprecated]] virtual istd::IChangeableUniquePtr CreateObjectFromInputParams(const QList<imtgql::CGqlParamObject>& inputParams, QByteArray &objectId, QString &name, QString &description, QString& errorMessage) const;
 
       virtual istd::IChangeableUniquePtr CreateObjectFromRequest(const imtgql::CGqlRequest& gqlRequest, QByteArray& newObjectId, QString& name, QString& description, QString& errorMessage) const;
 
       virtual void PrepareFilters(const imtgql::CGqlRequest& gqlRequest, const imtgql::CGqlParamObject& viewParamsGql, iprm::CParamsSet& filterParams) const;
 
       virtual void SetAdditionalFilters(const imtgql::CGqlRequest& gqlRequest,const imtgql::CGqlParamObject& viewParamsGql, iprm::CParamsSet* filterParams) const;
 
       virtual void SetObjectFilter(const imtgql::CGqlRequest& gqlRequest, const imtbase::CTreeItemModel& objectFilterModel, iprm::CParamsSet& filterParams) const;
 
       // reimplemented (icomp::CComponentBase)
       virtual void OnComponentCreated() override;
 
       virtual istd::IChangeableUniquePtr CreateObject(const QByteArray& typeId);
 
protected:
       QMap<QByteArray, QByteArray> m_fieldReplacementMap;
 
protected:
       I_MULTIATTR(QByteArray, m_replaceableFieldsAttrPtr);
       I_MULTIATTR(QByteArray, m_replacementFieldsAttrPtr);
       I_REF(imtbase::IDocumentChangeGenerator, m_documentChangeGeneratorCompPtr);
       I_REF(imtbase::IObjectCollection, m_objectCollectionCompPtr);
       I_REF(imtgql::IGqlRequestHandler, m_headersProviderCompPtr);
       I_REF(imtbase::IOperationContextController, m_operationContextControllerCompPtr);
 
       I_MULTIATTR(QByteArray, m_objectTypeIdAttrPtr);
       I_MULTIFACT(istd::IChangeable, m_objectFactCompPtr);
 
       I_MULTIATTR(QString, m_mimeTypeAttrPtr);
       I_MULTIFACT(istd::IChangeable, m_importExportObjectFactCompPtr);
       I_MULTIREF(ifile::IFilePersistence, m_filePersistenceCompPtr);
 
       imtserverapp::CTimeFilterParamRepresentationController m_timeFilterParamRepresentationController;
};
 
 
} // namespace imtservergql