Mercurial > hg > orthanc
annotate OrthancServer/ServerJobs/ArchiveJob.h @ 2997:5a6a2c5bf73f
fix basic plugin sample
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 10 Dec 2018 21:52:01 +0100 |
| parents | cb5d75143da0 |
| children | 4e43e67f8ecf |
| rev | line source |
|---|---|
| 2632 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
| 5 * Copyright (C) 2017-2018 Osimis S.A., Belgium | |
| 6 * | |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU General Public License as | |
| 9 * published by the Free Software Foundation, either version 3 of the | |
| 10 * License, or (at your option) any later version. | |
| 11 * | |
| 12 * In addition, as a special exception, the copyright holders of this | |
| 13 * program give permission to link the code of its release with the | |
| 14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 15 * that use the same license as the "OpenSSL" library), and distribute | |
| 16 * the linked executables. You must obey the GNU General Public License | |
| 17 * in all respects for all of the code used other than "OpenSSL". If you | |
| 18 * modify file(s) with this exception, you may extend this exception to | |
| 19 * your version of the file(s), but you are not obligated to do so. If | |
| 20 * you do not wish to do so, delete this exception statement from your | |
| 21 * version. If you delete this exception statement from all source files | |
| 22 * in the program, then also delete it here. | |
| 23 * | |
| 24 * This program is distributed in the hope that it will be useful, but | |
| 25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 27 * General Public License for more details. | |
| 28 * | |
| 29 * You should have received a copy of the GNU General Public License | |
| 30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 31 **/ | |
| 32 | |
| 33 | |
| 34 #pragma once | |
| 35 | |
| 36 #include "../../Core/JobsEngine/IJob.h" | |
| 37 #include "../../Core/TemporaryFile.h" | |
| 38 #include "../ServerContext.h" | |
| 39 | |
| 40 namespace Orthanc | |
| 41 { | |
| 42 class ArchiveJob : public IJob | |
| 43 { | |
| 44 private: | |
| 45 class ArchiveIndex; | |
| 46 class ArchiveIndexVisitor; | |
| 47 class IArchiveVisitor; | |
| 48 class MediaIndexVisitor; | |
| 49 class ResourceIdentifiers; | |
| 50 class ZipCommands; | |
| 51 class ZipWriterIterator; | |
| 52 | |
|
2965
9c0b0a6d8b54
MediaArchiveSize configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
53 boost::shared_ptr<TemporaryFile> synchronousTarget_; |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
54 std::auto_ptr<TemporaryFile> asynchronousTarget_; |
| 2730 | 55 ServerContext& context_; |
| 56 boost::shared_ptr<ArchiveIndex> archive_; | |
| 57 bool isMedia_; | |
| 58 bool enableExtendedSopClass_; | |
| 59 std::string description_; | |
| 2632 | 60 |
| 2730 | 61 boost::shared_ptr<ZipWriterIterator> writer_; |
| 62 size_t currentStep_; | |
| 63 unsigned int instancesCount_; | |
| 64 uint64_t uncompressedSize_; | |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
65 std::string mediaArchiveId_; |
| 2632 | 66 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
67 void FinalizeTarget(); |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
68 |
| 2632 | 69 public: |
| 2966 | 70 ArchiveJob(ServerContext& context, |
| 2632 | 71 bool isMedia, |
| 72 bool enableExtendedSopClass); | |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
73 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
74 virtual ~ArchiveJob(); |
| 2966 | 75 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
76 void SetSynchronousTarget(boost::shared_ptr<TemporaryFile>& synchronousTarget); |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
77 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
78 void SetDescription(const std::string& description); |
| 2632 | 79 |
| 80 const std::string& GetDescription() const | |
| 81 { | |
| 82 return description_; | |
| 83 } | |
| 84 | |
| 85 void AddResource(const std::string& publicId); | |
| 86 | |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
87 virtual void Reset(); |
| 2632 | 88 |
| 89 virtual void Start(); | |
| 90 | |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
91 virtual JobStepResult Step(); |
| 2632 | 92 |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
93 virtual void Stop(JobStopReason reason) |
| 2632 | 94 { |
| 95 } | |
| 96 | |
| 97 virtual float GetProgress(); | |
| 98 | |
| 99 virtual void GetJobType(std::string& target); | |
| 100 | |
| 101 virtual void GetPublicContent(Json::Value& value); | |
| 102 | |
|
2663
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
103 virtual bool Serialize(Json::Value& value) |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
104 { |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
105 return false; // Cannot serialize this kind of job |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
106 } |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
107 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
108 virtual bool GetOutput(std::string& output, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
109 MimeType& mime, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
110 const std::string& key); |
| 2632 | 111 }; |
| 112 } |