blob: 387e3d142702de1872023fc9e4ec1e2f480ce0b7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_FRAMEWORK_INC_JOBS_SHELLJOB_HXX
#define INCLUDED_FRAMEWORK_INC_JOBS_SHELLJOB_HXX
#include <macros/xserviceinfo.hxx>
#include <cppuhelper/implbase.hxx>
#include <com/sun/star/task/XJob.hpp>
namespace framework{
/** @short implements a job component which can be used
to execute system shell commands.
@descr Because the job will be implemented generic
it can be bound to any event where jobs can be
registered for. Further there is a generic
way to configure the shell command and it's list
of arguments.
*/
class ShellJob final : public ::cppu::WeakImplHelper< css::lang::XServiceInfo,css::task::XJob >
{
// member
private:
/** @short reference to a uno service manager. */
css::uno::Reference< css::uno::XComponentContext > m_xContext;
// native interface
public:
/** @short create new instance of this class.
@param xContext
reference to the uno service manager, which created this instance.
Can be used later to create own needed uno resources on demand.
*/
ShellJob(const css::uno::Reference< css::uno::XComponentContext >& xContext);
/** @short does nothing real ...
@descr But it should exists as virtual function,
so this class can't make trouble
related to inline/symbols etcpp.!
*/
virtual ~ShellJob() override;
// uno interface
public:
// css.lang.XServiceInfo
DECLARE_XSERVICEINFO_NOFACTORY
/* Helper for registry */
/// @throws css::uno::Exception
static css::uno::Reference< css::uno::XInterface > SAL_CALL impl_createInstance ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager );
static css::uno::Reference< css::lang::XSingleServiceFactory > impl_createFactory ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager );
// css.task.XJob
virtual css::uno::Any SAL_CALL execute(const css::uno::Sequence< css::beans::NamedValue >& lArguments) override;
// helper
private:
/** generate a return value for method execute()
which will force deactivation of this job for further requests.
@return an Any following the job protocol for deactivation.
*/
static css::uno::Any impl_generateAnswer4Deactivation();
/** substitute all might existing placeholder variables
within the configured command.
The command is part of the job configuration.
These will make changes more easy (no code changes required).
Further the command can use placeholder as they are supported
by the global substitution service (e.g. $(prog) etcpp)
@param sCommand
the command containing placeholder variables.
@return the substituted command.
*/
OUString impl_substituteCommandVariables(const OUString& sCommand);
/** executes the command.
@param sCommand
the absolute command as URL or system path (without any argument !).
@param lArguments
the complete list of arguments configured for these job.
@param bCheckExitCode
bind the execution result to the exit code of the started process.
If it's set to false we return false only in case executable couldn't be found
or couldn't be started.
@return sal_True if command was executed successfully; sal_False otherwise.
*/
bool impl_execute(const OUString& sCommand ,
const css::uno::Sequence< OUString >& lArguments ,
bool bCheckExitCode);
};
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_JOBS_SHELLJOB_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
