Mercurial > hg > orthanc
view OrthancServer/Plugins/Engine/OrthancPlugins.h @ 5211:27e6ec2811e3 db-protobuf
completed first implementation of OrthancPluginDatabaseV4
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 03 Apr 2023 10:29:45 +0200 |
parents | 0ea402b4d901 |
children | f2e1ad71e49c |
line wrap: on
line source
/** * Orthanc - A Lightweight, RESTful DICOM Store * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics * Department, University Hospital of Liege, Belgium * Copyright (C) 2017-2023 Osimis S.A., Belgium * Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium * * This program is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. **/ #pragma once #include "PluginsErrorDictionary.h" #if !defined(ORTHANC_ENABLE_PLUGINS) # error The macro ORTHANC_ENABLE_PLUGINS must be defined #endif #if ORTHANC_ENABLE_PLUGINS != 1 #include <boost/noncopyable.hpp> namespace Orthanc { class OrthancPlugins : public boost::noncopyable { }; } #else #include "../../../OrthancFramework/Sources/DicomNetworking/IFindRequestHandlerFactory.h" #include "../../../OrthancFramework/Sources/DicomNetworking/IMoveRequestHandlerFactory.h" #include "../../../OrthancFramework/Sources/DicomNetworking/IWorklistRequestHandlerFactory.h" #include "../../../OrthancFramework/Sources/DicomParsing/MemoryBufferTranscoder.h" #include "../../../OrthancFramework/Sources/FileStorage/IStorageArea.h" #include "../../../OrthancFramework/Sources/HttpServer/IHttpHandler.h" #include "../../../OrthancFramework/Sources/HttpServer/IIncomingHttpRequestFilter.h" #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h" #include "../../../OrthancFramework/Sources/MallocMemoryBuffer.h" #include "../../Sources/Database/IDatabaseWrapper.h" #include "../../Sources/IDicomImageDecoder.h" #include "../../Sources/IServerListener.h" #include "../../Sources/ServerJobs/IStorageCommitmentFactory.h" #include "PluginsManager.h" #include <list> #include <boost/shared_ptr.hpp> namespace Orthanc { class HttpServer; class ServerContext; class OrthancPlugins : public IHttpHandler, public IPluginServiceProvider, public IServerListener, public IWorklistRequestHandlerFactory, public IDicomImageDecoder, public IFindRequestHandlerFactory, public IMoveRequestHandlerFactory, public IStorageCommitmentFactory, public MemoryBufferTranscoder { private: class PImpl; boost::shared_ptr<PImpl> pimpl_; class WorklistHandler; class FindHandler; class MoveHandler; class HttpClientChunkedRequest; class HttpClientChunkedAnswer; class HttpServerChunkedReader; class IDicomInstance; class DicomInstanceFromCallback; class DicomInstanceFromBuffer; class DicomInstanceFromTranscoded; class WebDavCollection; void RegisterRestCallback(const void* parameters, bool lock); void RegisterChunkedRestCallback(const void* parameters); bool HandleChunkedGetDelete(HttpOutput& output, HttpMethod method, const UriComponents& uri, const HttpToolbox::Arguments& headers, const HttpToolbox::GetArguments& getArguments); void RegisterOnStoredInstanceCallback(const void* parameters); void RegisterOnChangeCallback(const void* parameters); void RegisterWorklistCallback(const void* parameters); void RegisterFindCallback(const void* parameters); void RegisterMoveCallback(const void* parameters); void RegisterDecodeImageCallback(const void* parameters); void RegisterTranscoderCallback(const void* parameters); void RegisterJobsUnserializer(const void* parameters); void RegisterIncomingHttpRequestFilter(const void* parameters); void RegisterIncomingHttpRequestFilter2(const void* parameters); void RegisterIncomingDicomInstanceFilter(const void* parameters); void RegisterIncomingCStoreInstanceFilter(const void* parameters); void RegisterReceivedInstanceCallback(const void* parameters); void RegisterRefreshMetricsCallback(const void* parameters); void RegisterStorageCommitmentScpCallback(const void* parameters); void AnswerBuffer(const void* parameters); void Redirect(const void* parameters); void CompressAndAnswerPngImage(const void* parameters); void CompressAndAnswerImage(const void* parameters); void GetDicomForInstance(const void* parameters); void RestApiGet(const void* parameters, bool afterPlugins); void RestApiGet2(const void* parameters); void RestApiPostPut(bool isPost, const void* parameters, bool afterPlugins); void RestApiDelete(const void* parameters, bool afterPlugins); void LookupResource(_OrthancPluginService service, const void* parameters); void AccessDicomInstance(_OrthancPluginService service, const void* parameters); void AccessDicomInstance2(_OrthancPluginService service, const void* parameters); void SendHttpStatusCode(const void* parameters); void SendHttpStatus(const void* parameters); void SendUnauthorized(const void* parameters); void SendMethodNotAllowed(const void* parameters); void SetCookie(const void* parameters); void SetHttpHeader(const void* parameters); void SetHttpErrorDetails(const void* parameters); void BufferCompression(const void* parameters); void UncompressImage(const void* parameters); void CompressImage(const void* parameters); void ConvertPixelFormat(const void* parameters); void CallHttpClient(const void* parameters); void CallHttpClient2(const void* parameters); void ChunkedHttpClient(const void* parameters); void CallRestApi(const void* parameters); void CallPeerApi(const void* parameters); void GetFontInfo(const void* parameters); void DrawText(const void* parameters); void DatabaseAnswer(const void* parameters); void ApplyDicomToJson(_OrthancPluginService service, const void* parameters); void ApplyCreateDicom(const _OrthancPluginCreateDicom& parameters, const char* privateCreatorC); void ApplyCreateImage(_OrthancPluginService service, const void* parameters); void ApplyLookupDictionary(const void* parameters); void ApplySendMultipartItem(const void* parameters); void ApplySendMultipartItem2(const void* parameters); void ComputeHash(_OrthancPluginService service, const void* parameters); void GetTagName(const void* parameters); void SignalChangeInternal(OrthancPluginChangeType changeType, OrthancPluginResourceType resourceType, const char* resource); bool InvokeSafeService(SharedLibrary& plugin, _OrthancPluginService service, const void* parameters); bool InvokeProtectedService(SharedLibrary& plugin, _OrthancPluginService service, const void* parameters); protected: // From "MemoryBufferTranscoder" virtual bool TranscodeBuffer(std::string& target, const void* buffer, size_t size, const std::set<DicomTransferSyntax>& allowedSyntaxes, bool allowNewSopInstanceUid) ORTHANC_OVERRIDE; public: explicit OrthancPlugins(const std::string& databaseServerIdentifier); virtual ~OrthancPlugins(); void SetServerContext(ServerContext& context); void ResetServerContext(); virtual bool Handle(HttpOutput& output, RequestOrigin origin, const char* remoteIp, const char* username, HttpMethod method, const UriComponents& uri, const HttpToolbox::Arguments& headers, const HttpToolbox::GetArguments& getArguments, const void* bodyData, size_t bodySize) ORTHANC_OVERRIDE; virtual bool InvokeService(SharedLibrary& plugin, _OrthancPluginService service, const void* parameters) ORTHANC_OVERRIDE; virtual void SignalChange(const ServerIndexChange& change) ORTHANC_OVERRIDE; virtual void SignalStoredInstance(const std::string& instanceId, const DicomInstanceToStore& instance, const Json::Value& simplifiedTags) ORTHANC_OVERRIDE; virtual bool FilterIncomingInstance(const DicomInstanceToStore& instance, const Json::Value& simplified) ORTHANC_OVERRIDE; virtual bool FilterIncomingCStoreInstance(uint16_t& dimseStatus, const DicomInstanceToStore& instance, const Json::Value& simplified) ORTHANC_OVERRIDE; OrthancPluginReceivedInstanceAction ApplyReceivedInstanceCallbacks(MallocMemoryBuffer& modified, const void* receivedDicomBuffer, size_t receivedDicomBufferSize, RequestOrigin origin); bool HasStorageArea() const; IStorageArea* CreateStorageArea(); // To be freed after use const SharedLibrary& GetStorageAreaLibrary() const; bool HasDatabaseBackend() const; IDatabaseWrapper& GetDatabaseBackend(); const SharedLibrary& GetDatabaseBackendLibrary() const; const char* GetProperty(const char* plugin, _OrthancPluginProperty property) const; void SetCommandLineArguments(int argc, char* argv[]); PluginsManager& GetManager(); const PluginsManager& GetManager() const; PluginsErrorDictionary& GetErrorDictionary(); void SignalOrthancStarted() { SignalChangeInternal(OrthancPluginChangeType_OrthancStarted, OrthancPluginResourceType_None, NULL); } void SignalOrthancStopped() { SignalChangeInternal(OrthancPluginChangeType_OrthancStopped, OrthancPluginResourceType_None, NULL); } void SignalJobSubmitted(const std::string& jobId) { SignalChangeInternal(OrthancPluginChangeType_JobSubmitted, OrthancPluginResourceType_None, jobId.c_str()); } void SignalJobSuccess(const std::string& jobId) { SignalChangeInternal(OrthancPluginChangeType_JobSuccess, OrthancPluginResourceType_None, jobId.c_str()); } void SignalJobFailure(const std::string& jobId) { SignalChangeInternal(OrthancPluginChangeType_JobFailure, OrthancPluginResourceType_None, jobId.c_str()); } void SignalUpdatedPeers() { SignalChangeInternal(OrthancPluginChangeType_UpdatedPeers, OrthancPluginResourceType_None, NULL); } void SignalUpdatedModalities() { SignalChangeInternal(OrthancPluginChangeType_UpdatedModalities, OrthancPluginResourceType_None, NULL); } bool HasWorklistHandler(); virtual IWorklistRequestHandler* ConstructWorklistRequestHandler() ORTHANC_OVERRIDE; bool HasCustomImageDecoder(); bool HasCustomTranscoder(); virtual ImageAccessor* Decode(const void* dicom, size_t size, unsigned int frame) ORTHANC_OVERRIDE; bool IsAllowed(HttpMethod method, const char* uri, const char* ip, const char* username, const HttpToolbox::Arguments& httpHeaders, const HttpToolbox::GetArguments& getArguments); bool HasFindHandler(); virtual IFindRequestHandler* ConstructFindRequestHandler() ORTHANC_OVERRIDE; bool HasMoveHandler(); virtual IMoveRequestHandler* ConstructMoveRequestHandler() ORTHANC_OVERRIDE; IJob* UnserializeJob(const std::string& type, const Json::Value& value); void RefreshMetrics(); // New in Orthanc 1.5.7 virtual bool CreateChunkedRequestReader(std::unique_ptr<IChunkedRequestReader>& target, RequestOrigin origin, const char* remoteIp, const char* username, HttpMethod method, const UriComponents& uri, const HttpToolbox::Arguments& headers) ORTHANC_OVERRIDE; // New in Orthanc 1.6.0 IStorageCommitmentFactory::ILookupHandler* CreateStorageCommitment( const std::string& jobId, const std::string& transactionUid, const std::vector<std::string>& sopClassUids, const std::vector<std::string>& sopInstanceUids, const std::string& remoteAet, const std::string& calledAet) ORTHANC_OVERRIDE; // New in Orthanc 1.8.1 (cf. "OrthancPluginGenerateRestApiAuthorizationToken()") bool IsValidAuthorizationToken(const std::string& token) const; unsigned int GetMaxDatabaseRetries() const; void RegisterWebDavCollections(HttpServer& target); }; } #endif