Mercurial > hg > orthanc
annotate OrthancServer/ServerJobs/ArchiveJob.h @ 3767:c6658187e4b1
cppcheck
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 17 Mar 2020 14:46:06 +0100 |
parents | 5ff5d5a0fd28 |
children | 6ddad3e0b569 |
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 | |
3640
94f4a18a79cc
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3113
diff
changeset
|
5 * Copyright (C) 2017-2020 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 | |
3712
2a170a8f1faf
replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
36 #include "../../Core/Compatibility.h" |
2632 | 37 #include "../../Core/JobsEngine/IJob.h" |
38 #include "../../Core/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_; | |
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
70 std::string mediaArchiveId_; |
2632 | 71 |
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
72 void FinalizeTarget(); |
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
73 |
2632 | 74 public: |
2966 | 75 ArchiveJob(ServerContext& context, |
2632 | 76 bool isMedia, |
77 bool enableExtendedSopClass); | |
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
78 |
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
79 virtual ~ArchiveJob(); |
2966 | 80 |
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
81 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
|
82 |
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
83 void SetDescription(const std::string& description); |
2632 | 84 |
85 const std::string& GetDescription() const | |
86 { | |
87 return description_; | |
88 } | |
89 | |
90 void AddResource(const std::string& publicId); | |
91 | |
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
92 virtual void Reset() ORTHANC_OVERRIDE; |
2632 | 93 |
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
94 virtual void Start() ORTHANC_OVERRIDE; |
2632 | 95 |
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
96 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
2632 | 97 |
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3762
diff
changeset
|
98 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE |
2632 | 99 { |
100 } | |
101 | |
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
102 virtual float GetProgress() ORTHANC_OVERRIDE; |
2632 | 103 |
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
104 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE; |
2632 | 105 |
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
106 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
2632 | 107 |
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
108 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
|
109 { |
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
110 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
|
111 } |
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
112 |
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2966
diff
changeset
|
113 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
|
114 MimeType& mime, |
3762
1a346a4dc1b4
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3713
diff
changeset
|
115 const std::string& key) ORTHANC_OVERRIDE; |
2632 | 116 }; |
117 } |