|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Moodle component manager. |
|
5
|
|
|
* |
|
6
|
|
|
* @author Luke Carrier <[email protected]> |
|
7
|
|
|
* @copyright 2016 Luke Carrier |
|
8
|
|
|
* @license GPL-3.0+ |
|
9
|
|
|
*/ |
|
10
|
|
|
|
|
11
|
|
|
namespace ComponentManager; |
|
12
|
|
|
|
|
13
|
|
|
use ComponentManager\Exception\MoodleException; |
|
14
|
|
|
use ComponentManager\Platform\Platform; |
|
15
|
|
|
use Symfony\Component\Process\Process; |
|
16
|
|
|
use Symfony\Component\Process\ProcessBuilder; |
|
17
|
|
|
|
|
18
|
|
|
/** |
|
19
|
|
|
* Moodle installation client. |
|
20
|
|
|
*/ |
|
21
|
|
|
class Moodle { |
|
22
|
|
|
/** |
|
23
|
|
|
* Moodle root directory. |
|
24
|
|
|
* |
|
25
|
|
|
* @var string |
|
26
|
|
|
*/ |
|
27
|
|
|
protected $moodleDir; |
|
28
|
|
|
|
|
29
|
|
|
/** |
|
30
|
|
|
* Platform support library. |
|
31
|
|
|
* |
|
32
|
|
|
* @var Platform |
|
33
|
|
|
*/ |
|
34
|
|
|
protected $platform; |
|
35
|
|
|
|
|
36
|
|
|
/** |
|
37
|
|
|
* Initialiser. |
|
38
|
|
|
* |
|
39
|
|
|
* @param string $moodleDir |
|
40
|
|
|
*/ |
|
41
|
|
|
public function __construct($moodleDir, Platform $platform) { |
|
42
|
|
|
$this->moodleDir = $moodleDir; |
|
43
|
|
|
$this->platform = $platform; |
|
44
|
|
|
} |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* Get plugin types. |
|
48
|
|
|
* |
|
49
|
|
|
* @return string[] |
|
50
|
|
|
*/ |
|
51
|
|
|
public function getPluginTypes() { |
|
52
|
|
|
$process = $this->getProcess(['list-plugin-types']); |
|
53
|
|
|
$process->run(); |
|
54
|
|
|
|
|
55
|
|
|
$this->ensureSuccess($process); |
|
56
|
|
|
|
|
57
|
|
|
return json_decode($process->getOutput()); |
|
58
|
|
|
} |
|
59
|
|
|
|
|
60
|
|
|
/** |
|
61
|
|
|
* Get the root directory for a plugin type. |
|
62
|
|
|
* |
|
63
|
|
|
* @param string $type |
|
64
|
|
|
* |
|
65
|
|
|
* @return string |
|
66
|
|
|
*/ |
|
67
|
|
|
public function getPluginTypeDirectory($type) { |
|
68
|
|
|
$pluginTypes = $this->getPluginTypes(); |
|
69
|
|
|
|
|
70
|
|
|
return property_exists($pluginTypes, $type) ? $pluginTypes->{$type} : null; |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
|
|
/** |
|
74
|
|
|
* Get a ready-to-run process instance. |
|
75
|
|
|
* |
|
76
|
|
|
* @param mixed[] $arguments |
|
77
|
|
|
* |
|
78
|
|
|
* @return Process |
|
79
|
|
|
*/ |
|
80
|
|
|
protected function getProcess($arguments) { |
|
81
|
|
|
$prefix = [ |
|
82
|
|
|
$this->platform->getPhpExecutable(), |
|
83
|
|
|
$this->platform->getPhpScript(), |
|
84
|
|
|
'moodle', |
|
85
|
|
|
]; |
|
86
|
|
|
|
|
87
|
|
|
if ($this->moodleDir) { |
|
88
|
|
|
$prefix = array_merge($prefix, ['--moodle-dir', $this->moodleDir]); |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
$arguments = array_merge($prefix, $arguments); |
|
92
|
|
|
$builder = new ProcessBuilder($arguments); |
|
93
|
|
|
$builder->setEnv('XDEBUG_CONFIG', ''); |
|
94
|
|
|
|
|
95
|
|
|
return $builder->getProcess(); |
|
96
|
|
|
} |
|
97
|
|
|
|
|
98
|
|
|
/** |
|
99
|
|
|
* Ensure the specified command executed successfully. |
|
100
|
|
|
* |
|
101
|
|
|
* @param Process $process |
|
102
|
|
|
* |
|
103
|
|
|
* @throws MoodleException |
|
104
|
|
|
*/ |
|
105
|
|
|
protected function ensureSuccess(Process $process) { |
|
106
|
|
|
if (!$process->isSuccessful()) { |
|
107
|
|
|
$command = $process->getCommandLine(); |
|
108
|
|
|
throw new MoodleException("Unable to execute command \"{$command}\""); |
|
|
|
|
|
|
109
|
|
|
} |
|
110
|
|
|
} |
|
111
|
|
|
} |
|
112
|
|
|
|
It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings.