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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
<?php
class Module
{
/*
* Static
*/
/**
* @var \Module[]
*/
private static $modules = false;
public static function get($name, $ignoreDepFail = false)
{
if (!isset(self::$modules[$name]))
return false;
if (!self::resolveDeps(self::$modules[$name]) && !$ignoreDepFail)
return false;
return self::$modules[$name];
}
/**
* Check whether given module is available, that is, all dependencies are
* met. If the module is available, it will be activated, so all its classes
* are available through the auto-loader, and any js or css is added to the
* final page output.
*
* @param string $moduleId module to check
* @return bool true if module is available and activated
*/
public static function isAvailable($moduleId)
{
$module = self::get($moduleId);
if ($module === false)
return false;
$module->activate();
return !$module->hasMissingDependencies();
}
private static function resolveDepsByName($name)
{
if (!isset(self::$modules[$name]))
return false;
return self::resolveDeps(self::$modules[$name]);
}
/**
*
* @param \Module $mod the module to check
* @return boolean true iff module deps are all found and enabled
*/
private static function resolveDeps($mod)
{
if (!$mod->depsChecked) {
$mod->depsChecked = true;
foreach ($mod->dependencies as $dep) {
if (!self::resolveDepsByName($dep)) {
error_log("Disabling module {$mod->name}: Dependency $dep failed.");
$mod->depsMissing = true;
return false;
}
}
}
return !$mod->depsMissing;
}
/**
* @return \Module[] List of valid, enabled modules
*/
public static function getEnabled($sortById = false)
{
$ret = array();
$sort = array();
foreach (self::$modules as $module) {
if (self::resolveDeps($module)) {
$ret[] = $module;
}
if ($sortById) {
$sort[] = $module->name;
}
}
if ($sortById) {
array_multisort($sort, SORT_ASC, $ret);
}
return $ret;
}
/**
* @return \Module[] List of all modules, including with missing deps
*/
public static function getAll()
{
foreach (self::$modules as $module) {
self::resolveDeps($module);
}
return self::$modules;
}
/**
* @return \Module[] List of modules that have been activated
*/
public static function getActivated()
{
$ret = array();
$i = 0;
foreach (self::$modules as $module) {
if ($module->activated !== false) {
$ret[sprintf('%05d_%d', $module->activated, $i++)] = $module;
}
}
ksort($ret);
return $ret;
}
public static function init()
{
if (self::$modules !== false)
return;
$dh = opendir('modules');
if ($dh === false)
return;
self::$modules = array();
while (($dir = readdir($dh)) !== false) {
if (empty($dir) || preg_match('/[^a-zA-Z0-9_]/', $dir))
continue;
if (!is_file('modules/' . $dir . '/config.json'))
continue;
$name = strtolower($dir);
self::$modules[$name] = new Module($dir);
}
closedir($dh);
}
/*
* Non-static
*/
private $category = false;
private $depsMissing = false;
private $depsChecked = false;
private $activated = false;
private $dependencies = array();
private $name;
private function __construct($name)
{
$file = 'modules/' . $name . '/config.json';
$json = @json_decode(@file_get_contents($file), true);
if (isset($json['dependencies']) && is_array($json['dependencies'])) {
$this->dependencies = $json['dependencies'];
}
if (isset($json['category']) && is_string($json['category'])) {
$this->category = $json['category'];
}
$this->name = $name;
}
public function hasMissingDependencies()
{
return $this->depsMissing;
}
public function newPage()
{
$modulePath = 'modules/' . $this->name . '/page.inc.php';
if (!file_exists($modulePath)) {
Util::traceError("Module doesn't have a page: " . $modulePath);
}
require_once $modulePath;
$class = 'Page_' . $this->name;
return new $class();
}
public function activate($depth = 1)
{
if ($this->activated !== false || $this->depsMissing)
return $this->activated !== false;
$this->activated = $depth;
spl_autoload_register(function($class) {
$file = 'modules/' . $this->name . '/inc/' . preg_replace('/[^a-z0-9]/', '', strtolower($class)) . '.inc.php';
if (!file_exists($file))
return;
require_once $file;
});
foreach ($this->dependencies as $dep) {
$get = self::get($dep);
if ($get !== false) {
$get->activate($depth + 1);
}
}
return true;
}
public function getDependencies()
{
$deps = array();
$this->getDepsInternal($deps);
return array_keys($deps);
}
private function getDepsInternal(&$deps)
{
if (!is_array($this->dependencies))
return array();
foreach ($this->dependencies as $dep) {
if (isset($deps[$dep])) // Handle cyclic dependencies
continue;
$deps[$dep] = true;
$mod = self::get($dep);
if ($mod === false)
continue;
$mod->getDepsInternal($deps);
}
}
public function getIdentifier()
{
return $this->name;
}
public function getDisplayName()
{
$string = Dictionary::translateFileModule($this->name, 'module', 'module_name');
if ($string === false) {
return '!!' . $this->name . '!!';
}
return $string;
}
public function getPageTitle()
{
$val = Dictionary::translateFileModule($this->name, 'module', 'page_title');
if ($val !== false)
return $val;
return $this->getDisplayName();
}
public function getCategory()
{
return $this->category;
}
public function getCategoryName()
{
return Dictionary::getCategoryName($this->category);
}
public function getDir()
{
return 'modules/' . $this->name;
}
}
|
