annotate OrthancServer/Sources/ServerJobs/Operations/SystemCallOperation.h @ 5638:4535194cbb8a

document TLS 1.3 in SslMinimumProtocolVersion
author Alain Mazy <am@orthanc.team>
date Wed, 22 May 2024 16:06:30 +0200
parents 48b8dae6dc77
children f7adfb22e20e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2606
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
2606
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU General Public License as
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * License, or (at your option) any later version.
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * General Public License for more details.
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
25 #include "../../../../OrthancFramework/Sources/Compatibility.h" // For ORTHANC_OVERRIDE
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
26 #include "../../../../OrthancFramework/Sources/JobsEngine/Operations/IJobOperation.h"
2606
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include <string>
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 namespace Orthanc
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 {
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 class SystemCallOperation : public IJobOperation
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 private:
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 std::string command_;
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 std::vector<std::string> preArguments_;
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 std::vector<std::string> postArguments_;
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 public:
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
40 explicit SystemCallOperation(const std::string& command) :
2606
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 command_(command)
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 }
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
45 explicit SystemCallOperation(const Json::Value& serialized);
2655
c196d76cb8fa serialization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2641
diff changeset
46
2606
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 SystemCallOperation(const std::string& command,
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 const std::vector<std::string>& preArguments,
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 const std::vector<std::string>& postArguments) :
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 command_(command),
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 preArguments_(preArguments),
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 postArguments_(postArguments)
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 {
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 }
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 void AddPreArgument(const std::string& argument)
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 {
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 preArguments_.push_back(argument);
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 }
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 void AddPostArgument(const std::string& argument)
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 postArguments_.push_back(argument);
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 }
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
2659
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
66 const std::string& GetCommand() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
67 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
68 return command_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
69 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
70
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
71 size_t GetPreArgumentsCount() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
72 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
73 return preArguments_.size();
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
74 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
75
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
76 size_t GetPostArgumentsCount() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
77 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
78 return postArguments_.size();
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
79 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
80
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
81 const std::string& GetPreArgument(size_t i) const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
82
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
83 const std::string& GetPostArgument(size_t i) const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2655
diff changeset
84
2606
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 virtual void Apply(JobOperationValues& outputs,
4310
2ae905070221 renaming pure interface JobOperationValue as IJobOperationValue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4205
diff changeset
86 const IJobOperationValue& input) ORTHANC_OVERRIDE;
2616
2f3007bf0708 event queues in Lua, serialization of sequence of operations
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2608
diff changeset
87
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
88 virtual void Serialize(Json::Value& result) const ORTHANC_OVERRIDE;
2606
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 };
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 }
f2b9d3256060 SystemCallOperation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91