Mercurial > hg > orthanc
annotate OrthancServer/Sources/ServerJobs/ArchiveJob.h @ 4462:da460bef88f8
"/modalities/{...}/query": New string argument "LocalAet"
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 20 Jan 2021 17:02:10 +0100 |
| parents | d9473bd5ed43 |
| children | b02dc8303cf6 |
| 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 | |
|
4437
d9473bd5ed43
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4341
diff
changeset
|
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
| 2632 | 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 | |
| 4045 | 36 #include "../../../OrthancFramework/Sources/Compatibility.h" |
| 37 #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h" | |
| 38 #include "../../../OrthancFramework/Sources/TemporaryFile.h" | |
|
3095
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
39 |
|
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
40 #include <boost/shared_ptr.hpp> |
| 3113 | 41 #include <stdint.h> |
| 2632 | 42 |
| 43 namespace Orthanc | |
| 44 { | |
|
3095
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
45 class ServerContext; |
|
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
46 |
| 2632 | 47 class ArchiveJob : public IJob |
| 48 { | |
| 49 private: | |
| 50 class ArchiveIndex; | |
| 51 class ArchiveIndexVisitor; | |
| 52 class IArchiveVisitor; | |
| 53 class MediaIndexVisitor; | |
| 54 class ResourceIdentifiers; | |
| 55 class ZipCommands; | |
| 56 class ZipWriterIterator; | |
| 57 | |
|
2965
9c0b0a6d8b54
MediaArchiveSize configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
58 boost::shared_ptr<TemporaryFile> synchronousTarget_; |
|
3712
2a170a8f1faf
replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
59 std::unique_ptr<TemporaryFile> asynchronousTarget_; |
| 2730 | 60 ServerContext& context_; |
| 61 boost::shared_ptr<ArchiveIndex> archive_; | |
| 62 bool isMedia_; | |
| 63 bool enableExtendedSopClass_; | |
| 64 std::string description_; | |
| 2632 | 65 |
| 2730 | 66 boost::shared_ptr<ZipWriterIterator> writer_; |
| 67 size_t currentStep_; | |
| 68 unsigned int instancesCount_; | |
| 69 uint64_t uncompressedSize_; | |
|
4341
977c2759eb0a
Archive/media jobs report the size of the created ZIP file in content field "ArchiveSizeMB"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4045
diff
changeset
|
70 uint64_t archiveSize_; |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
71 std::string mediaArchiveId_; |
| 2632 | 72 |
|
3913
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
73 // New in Orthanc 1.7.0 |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
74 bool transcode_; |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
75 DicomTransferSyntax transferSyntax_; |
|
4341
977c2759eb0a
Archive/media jobs report the size of the created ZIP file in content field "ArchiveSizeMB"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4045
diff
changeset
|
76 |
|
977c2759eb0a
Archive/media jobs report the size of the created ZIP file in content field "ArchiveSizeMB"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4045
diff
changeset
|
77 void RefreshArchiveSize(); |
|
3913
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
78 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
79 void FinalizeTarget(); |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
80 |
| 2632 | 81 public: |
| 2966 | 82 ArchiveJob(ServerContext& context, |
| 2632 | 83 bool isMedia, |
| 84 bool enableExtendedSopClass); | |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
85 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
86 virtual ~ArchiveJob(); |
| 2966 | 87 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
88 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
|
89 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
90 void SetDescription(const std::string& description); |
| 2632 | 91 |
| 92 const std::string& GetDescription() const | |
| 93 { | |
| 94 return description_; | |
| 95 } | |
| 96 | |
| 97 void AddResource(const std::string& publicId); | |
| 98 | |
|
3913
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
99 void SetTranscode(DicomTransferSyntax transferSyntax); |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
100 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
101 virtual void Reset() ORTHANC_OVERRIDE; |
| 2632 | 102 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
103 virtual void Start() ORTHANC_OVERRIDE; |
| 2632 | 104 |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
105 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2632 | 106 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3762
diff
changeset
|
107 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE |
| 2632 | 108 { |
| 109 } | |
| 110 | |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
111 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2632 | 112 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
113 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE; |
| 2632 | 114 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
115 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2632 | 116 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
117 virtual bool Serialize(Json::Value& value) ORTHANC_OVERRIDE |
|
2663
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
118 { |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
119 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
|
120 } |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
121 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
122 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
|
123 MimeType& mime, |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
124 const std::string& key) ORTHANC_OVERRIDE; |
| 2632 | 125 }; |
| 126 } |