annotate OrthancServer/ServerJobs/ArchiveJob.h @ 2790:c7313e1f7644

MongooseServer::SetRealm()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 26 Jul 2018 20:43:03 +0200
parents fe4fe52f0c94
children 7cfc8d266f41
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
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "../../Core/JobsEngine/IJob.h"
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include "../../Core/TemporaryFile.h"
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include "../ServerContext.h"
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 namespace Orthanc
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 class ArchiveJob : public IJob
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 private:
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 class ArchiveIndex;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 class ArchiveIndexVisitor;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 class IArchiveVisitor;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 class MediaIndexVisitor;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 class ResourceIdentifiers;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 class ZipCommands;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 class ZipWriterIterator;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
2730
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
53 boost::shared_ptr<TemporaryFile> target_;
cb1b26a7db98 fix mingw compilation
s.jodogne@gmail.com
parents: 2663
diff changeset
54 ServerContext& context_;
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_;
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 public:
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 ArchiveJob(boost::shared_ptr<TemporaryFile>& target,
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 ServerContext& context,
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 bool isMedia,
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 bool enableExtendedSopClass);
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 void SetDescription(const std::string& description)
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 {
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 description_ = description;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 }
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 const std::string& GetDescription() const
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 {
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 return description_;
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 }
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 void AddResource(const std::string& publicId);
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 virtual void SignalResubmit();
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 virtual void Start();
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 virtual JobStepResult ExecuteStep();
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 virtual void ReleaseResources()
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 {
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 }
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 virtual float GetProgress();
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 virtual void GetJobType(std::string& target);
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 virtual void GetPublicContent(Json::Value& value);
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
2663
228e2783ce83 some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2648
diff changeset
99 virtual bool Serialize(Json::Value& value)
228e2783ce83 some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2648
diff changeset
100 {
228e2783ce83 some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2648
diff changeset
101 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
102 }
2632
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 };
2406ae891747 ArchiveJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 }