Mercurial > hg > orthanc

annotate OrthancServer/Sources/ServerJobs/ArchiveJob.h @ 5281:3de0235dedb6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
typo
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 15 Apr 2023 18:45:07 +0200
parents 0ea402b4d901
children b5c502bcaf99
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
5185
0ea402b4d901 upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5169
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
0ea402b4d901 upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5169
diff changeset
6 * Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU General Public License as
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * License, or (at your option) any later version.
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * General Public License for more details.
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
25 #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
26 #include "../../../OrthancFramework/Sources/Compression/ZipWriter.h"
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
27 #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
28 #include "../../../OrthancFramework/Sources/TemporaryFile.h"
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
29
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
30 #include <boost/shared_ptr.hpp>
3113
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3095
diff changeset
31 #include <stdint.h>
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 namespace Orthanc
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
35 class ServerContext;
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
36
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 class ArchiveJob : public IJob
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 private:
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 class ArchiveIndex;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 class ArchiveIndexVisitor;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 class IArchiveVisitor;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 class MediaIndexVisitor;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 class ResourceIdentifiers;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 class ZipCommands;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 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
47 class InstanceLoader;
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4674
diff changeset
48 class SynchronousInstanceLoader;
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4674
diff changeset
49 class ThreadedInstanceLoader;
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4674
diff changeset
50
4674
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4641
diff changeset
51 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
52 std::unique_ptr<TemporaryFile> asynchronousTarget_;
2730
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
53 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
54 std::unique_ptr<InstanceLoader> instanceLoader_;
2730
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
55 boost::shared_ptr<ArchiveIndex> archive_;
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
56 bool isMedia_;
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
57 bool enableExtendedSopClass_;
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
58 std::string description_;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
2730
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
60 boost::shared_ptr<ZipWriterIterator> writer_;
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
61 size_t currentStep_;
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
62 unsigned int instancesCount_;
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
63 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
64 uint64_t archiveSize_;
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
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
3913
6ddad3e0b569 transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
67 // New in Orthanc 1.7.0
6ddad3e0b569 transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
68 bool transcode_;
6ddad3e0b569 transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
69 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
70
4902
df86d2505df8 Orthanc 1.9.8 is now known as Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4892
diff changeset
71 // New in Orthanc 1.10.0
4797
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4674
diff changeset
72 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
73
2976
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2966
diff changeset
74 void FinalizeTarget();
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2966
diff changeset
75
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 public:
2966
10c610e80b15 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2965
diff changeset
77 ArchiveJob(ServerContext& context,
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 bool isMedia,
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 bool enableExtendedSopClass);
2976
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2966
diff changeset
80
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2966
diff changeset
81 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
82
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4641
diff changeset
83 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
84
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2966
diff changeset
85 void SetDescription(const std::string& description);
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 const std::string& GetDescription() const
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 {
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 return description_;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 }
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
5169
8b74aa4f3515 enforce the existence of the patient/study/instance while creating its archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4902
diff changeset
92 void AddResource(const std::string& publicId,
8b74aa4f3515 enforce the existence of the patient/study/instance while creating its archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4902
diff changeset
93 bool mustExist,
8b74aa4f3515 enforce the existence of the patient/study/instance while creating its archive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4902
diff changeset
94 ResourceType expectedType);
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
3913
6ddad3e0b569 transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
96 void SetTranscode(DicomTransferSyntax transferSyntax);
6ddad3e0b569 transcoding ZIP archive and media
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
97
4797
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4674
diff changeset
98 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
99
3762
1a346a4dc1b4 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
100 virtual void Reset() ORTHANC_OVERRIDE;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
3762
1a346a4dc1b4 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
102 virtual void Start() ORTHANC_OVERRIDE;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
3658
2d90dd30858c providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
104 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
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
106 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
3762
1a346a4dc1b4 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
108 virtual float GetProgress() ORTHANC_OVERRIDE;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
3762
1a346a4dc1b4 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
110 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111
3762
1a346a4dc1b4 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
112 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113
3762
1a346a4dc1b4 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
114 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
115 {
228e2783ce83 some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2648
diff changeset
116 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
117 }
2976
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2966
diff changeset
118
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2966
diff changeset
119 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
120 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
121 std::string& filename,
3762
1a346a4dc1b4 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3713
diff changeset
122 const std::string& key) ORTHANC_OVERRIDE;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 };
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 }