Mercurial > hg > orthanc
annotate OrthancServer/Sources/ServerJobs/ArchiveJob.h @ 4834:bec432ee1094
download of numpy arrays from the REST API
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 26 Nov 2021 19:03:32 +0100 |
| parents | 7053502fbf97 |
| children | 2e71a08eea15 43e613a7756b |
| 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 |
|
4831
7053502fbf97
added copyright UCLouvain
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4810
diff
changeset
|
6 * Copyright (C) 2021-2021 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 2632 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
| 9 * modify it under the terms of the GNU General Public License as | |
| 10 * published by the Free Software Foundation, either version 3 of the | |
| 11 * License, or (at your option) any later version. | |
| 12 * | |
| 13 * In addition, as a special exception, the copyright holders of this | |
| 14 * program give permission to link the code of its release with the | |
| 15 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 16 * that use the same license as the "OpenSSL" library), and distribute | |
| 17 * the linked executables. You must obey the GNU General Public License | |
| 18 * in all respects for all of the code used other than "OpenSSL". If you | |
| 19 * modify file(s) with this exception, you may extend this exception to | |
| 20 * your version of the file(s), but you are not obligated to do so. If | |
| 21 * you do not wish to do so, delete this exception statement from your | |
| 22 * version. If you delete this exception statement from all source files | |
| 23 * in the program, then also delete it here. | |
| 24 * | |
| 25 * This program is distributed in the hope that it will be useful, but | |
| 26 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 28 * General Public License for more details. | |
| 29 * | |
| 30 * You should have received a copy of the GNU General Public License | |
| 31 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 32 **/ | |
| 33 | |
| 34 | |
| 35 #pragma once | |
| 36 | |
| 4045 | 37 #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
|
38 #include "../../../OrthancFramework/Sources/Compression/ZipWriter.h" |
| 4045 | 39 #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h" |
| 40 #include "../../../OrthancFramework/Sources/TemporaryFile.h" | |
|
3095
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
41 |
|
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
42 #include <boost/shared_ptr.hpp> |
| 3113 | 43 #include <stdint.h> |
| 2632 | 44 |
| 45 namespace Orthanc | |
| 46 { | |
|
3095
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
47 class ServerContext; |
|
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
48 |
| 2632 | 49 class ArchiveJob : public IJob |
| 50 { | |
| 51 private: | |
| 52 class ArchiveIndex; | |
| 53 class ArchiveIndexVisitor; | |
| 54 class IArchiveVisitor; | |
| 55 class MediaIndexVisitor; | |
| 56 class ResourceIdentifiers; | |
| 57 class ZipCommands; | |
| 58 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
|
59 class InstanceLoader; |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
60 class SynchronousInstanceLoader; |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
61 class ThreadedInstanceLoader; |
|
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
62 |
|
4674
cdab941fe17d
ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4641
diff
changeset
|
63 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
|
64 std::unique_ptr<TemporaryFile> asynchronousTarget_; |
| 2730 | 65 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
|
66 std::unique_ptr<InstanceLoader> instanceLoader_; |
| 2730 | 67 boost::shared_ptr<ArchiveIndex> archive_; |
| 68 bool isMedia_; | |
| 69 bool enableExtendedSopClass_; | |
| 70 std::string description_; | |
| 2632 | 71 |
| 2730 | 72 boost::shared_ptr<ZipWriterIterator> writer_; |
| 73 size_t currentStep_; | |
| 74 unsigned int instancesCount_; | |
| 75 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
|
76 uint64_t archiveSize_; |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
77 std::string mediaArchiveId_; |
| 2632 | 78 |
|
3913
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
79 // New in Orthanc 1.7.0 |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
80 bool transcode_; |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
81 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
|
82 |
|
4797
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
83 // 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
|
84 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
|
85 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
86 void FinalizeTarget(); |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
87 |
| 2632 | 88 public: |
| 2966 | 89 ArchiveJob(ServerContext& context, |
| 2632 | 90 bool isMedia, |
| 91 bool enableExtendedSopClass); | |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
92 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
93 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
|
94 |
|
cdab941fe17d
ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4641
diff
changeset
|
95 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
|
96 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
97 void SetDescription(const std::string& description); |
| 2632 | 98 |
| 99 const std::string& GetDescription() const | |
| 100 { | |
| 101 return description_; | |
| 102 } | |
| 103 | |
| 104 void AddResource(const std::string& publicId); | |
| 105 | |
|
3913
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
106 void SetTranscode(DicomTransferSyntax transferSyntax); |
|
6ddad3e0b569
transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
107 |
|
4797
4e765c18ace7
enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents:
4674
diff
changeset
|
108 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
|
109 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
110 virtual void Reset() ORTHANC_OVERRIDE; |
| 2632 | 111 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
112 virtual void Start() ORTHANC_OVERRIDE; |
| 2632 | 113 |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
114 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2632 | 115 |
|
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
|
116 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE; |
| 2632 | 117 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
118 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2632 | 119 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
120 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE; |
| 2632 | 121 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
122 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2632 | 123 |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
124 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
|
125 { |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
126 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
|
127 } |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
128 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
129 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
|
130 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
|
131 std::string& filename, |
|
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
132 const std::string& key) ORTHANC_OVERRIDE; |
| 2632 | 133 }; |
| 134 } |