Mercurial > hg > orthanc
annotate OrthancServer/Sources/ServerJobs/ArchiveJob.h @ 4815:cd6dc99e0470
cppcheck
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Thu, 25 Nov 2021 12:13:53 +0100 |
| parents | 7afbb54bd028 |
| children | 70d2a97ca8cb 7053502fbf97 |
| 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" |
|
4674
cdab941fe17d
ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4641
diff
changeset
|
37 #include "../../../OrthancFramework/Sources/Compression/ZipWriter.h" |
| 4045 | 38 #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h" |
| 39 #include "../../../OrthancFramework/Sources/TemporaryFile.h" | |
|
3095
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
40 |
|
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
41 #include <boost/shared_ptr.hpp> |
| 3113 | 42 #include <stdint.h> |
| 2632 | 43 |
| 44 namespace Orthanc | |
| 45 { | |
|
3095
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
46 class ServerContext; |
|
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
47 |
| 2632 | 48 class ArchiveJob : public IJob |
| 49 { | |
| 50 private: | |
| 51 class ArchiveIndex; | |
| 52 class ArchiveIndexVisitor; | |
| 53 class IArchiveVisitor; | |
| 54 class MediaIndexVisitor; | |
| 55 class ResourceIdentifiers; | |
| 56 class ZipCommands; | |
| 57 class ZipWriterIterator; | |
|
4797
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
58 class InstanceLoader; |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
59 class SynchronousInstanceLoader; |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
60 class ThreadedInstanceLoader; |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
61 |
|
4674
cdab941fe17d
ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4641
diff
changeset
|
62 std::unique_ptr<ZipWriter::IOutputStream> synchronousTarget_; // Only valid before "Start()" |
|
3712
2a170a8f1faf
replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
63 std::unique_ptr<TemporaryFile> asynchronousTarget_; |
| 2730 | 64 ServerContext& context_; |
|
4797
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
65 std::unique_ptr<InstanceLoader> instanceLoader_; |
| 2730 | 66 boost::shared_ptr<ArchiveIndex> archive_; |
| 67 bool isMedia_; | |
| 68 bool enableExtendedSopClass_; | |
| 69 std::string description_; | |
| 2632 | 70 |
| 2730 | 71 boost::shared_ptr<ZipWriterIterator> writer_; |
| 72 size_t currentStep_; | |
| 73 unsigned int instancesCount_; | |
| 74 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
|
75 uint64_t archiveSize_; |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
76 std::string mediaArchiveId_; |
| 2632 | 77 |
|
3913
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
78 // New in Orthanc 1.7.0 |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
79 bool transcode_; |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
80 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
|
81 |
|
4797
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
82 // New in Orthanc 1.9.8 |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
83 unsigned int loaderThreads_; |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
84 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
85 void FinalizeTarget(); |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
86 |
| 2632 | 87 public: |
| 2966 | 88 ArchiveJob(ServerContext& context, |
| 2632 | 89 bool isMedia, |
| 90 bool enableExtendedSopClass); | |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
91 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
92 virtual ~ArchiveJob(); |
|
4674
cdab941fe17d
ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4641
diff
changeset
|
93 |
|
cdab941fe17d
ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4641
diff
changeset
|
94 void AcquireSynchronousTarget(ZipWriter::IOutputStream* synchronousTarget); |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
95 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
96 void SetDescription(const std::string& description); |
| 2632 | 97 |
| 98 const std::string& GetDescription() const | |
| 99 { | |
| 100 return description_; | |
| 101 } | |
| 102 | |
| 103 void AddResource(const std::string& publicId); | |
| 104 | |
|
3913
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
105 void SetTranscode(DicomTransferSyntax transferSyntax); |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
106 |
|
4797
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
107 void SetLoaderThreads(unsigned int loaderThreads); |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
108 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
109 virtual void Reset() ORTHANC_OVERRIDE; |
| 2632 | 110 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
111 virtual void Start() ORTHANC_OVERRIDE; |
| 2632 | 112 |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
113 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2632 | 114 |
|
4641
b02dc8303cf6
Fixed the lifetime of temporary files associated with jobs that create ZIP archive/media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
115 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE; |
| 2632 | 116 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
117 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2632 | 118 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
119 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE; |
| 2632 | 120 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
121 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2632 | 122 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
123 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
|
124 { |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
125 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
|
126 } |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
127 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
128 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
|
129 MimeType& mime, |
|
4805
0a38000b086d
Archive jobs response now contains a header Content-Disposition:filename='archive.zip'
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
130 std::string& filename, |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
131 const std::string& key) ORTHANC_OVERRIDE; |
| 2632 | 132 }; |
| 133 } |