Mercurial > hg > orthanc

comparison OrthancServer/Sources/ServerJobs/ArchiveJob.h @ 4092:fb64d481940a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
making the "framework" branch the new "default"
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 30 Jun 2020 15:53:17 +0200
parents 05b8fd21089c
children 977c2759eb0a
comparison
equal deleted inserted replaced
4089:a2060a76ed6a 4092:fb64d481940a
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-2020 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 "../../../OrthancFramework/Sources/Compatibility.h"
37 #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h"
38 #include "../../../OrthancFramework/Sources/TemporaryFile.h"
39
40 #include <boost/shared_ptr.hpp>
41 #include <stdint.h>
42
43 namespace Orthanc
44 {
45 class ServerContext;
46
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
58 boost::shared_ptr<TemporaryFile> synchronousTarget_;
59 std::unique_ptr<TemporaryFile> asynchronousTarget_;
60 ServerContext& context_;
61 boost::shared_ptr<ArchiveIndex> archive_;
62 bool isMedia_;
63 bool enableExtendedSopClass_;
64 std::string description_;
65
66 boost::shared_ptr<ZipWriterIterator> writer_;
67 size_t currentStep_;
68 unsigned int instancesCount_;
69 uint64_t uncompressedSize_;
70 std::string mediaArchiveId_;
71
72 // New in Orthanc 1.7.0
73 bool transcode_;
74 DicomTransferSyntax transferSyntax_;
75
76 void FinalizeTarget();
77
78 public:
79 ArchiveJob(ServerContext& context,
80 bool isMedia,
81 bool enableExtendedSopClass);
82
83 virtual ~ArchiveJob();
84
85 void SetSynchronousTarget(boost::shared_ptr<TemporaryFile>& synchronousTarget);
86
87 void SetDescription(const std::string& description);
88
89 const std::string& GetDescription() const
90 {
91 return description_;
92 }
93
94 void AddResource(const std::string& publicId);
95
96 void SetTranscode(DicomTransferSyntax transferSyntax);
97
98 virtual void Reset() ORTHANC_OVERRIDE;
99
100 virtual void Start() ORTHANC_OVERRIDE;
101
102 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE;
103
104 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE
105 {
106 }
107
108 virtual float GetProgress() ORTHANC_OVERRIDE;
109
110 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE;
111
112 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE;
113
114 virtual bool Serialize(Json::Value& value) ORTHANC_OVERRIDE
115 {
116 return false; // Cannot serialize this kind of job
117 }
118
119 virtual bool GetOutput(std::string& output,
120 MimeType& mime,
121 const std::string& key) ORTHANC_OVERRIDE;
122 };
123 }