1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* @package midcom.admin.help |
4
|
|
|
* @author The Midgard Project, http://www.midgard-project.org |
5
|
|
|
* @copyright The Midgard Project, http://www.midgard-project.org |
6
|
|
|
* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License |
7
|
|
|
*/ |
8
|
|
|
|
9
|
|
|
use Michelf\MarkdownExtra; |
10
|
|
|
use midgard\portable\storage\connection; |
11
|
|
|
|
12
|
|
|
/** |
13
|
|
|
* Online help display |
14
|
|
|
* |
15
|
|
|
* @package midcom.admin.help |
16
|
|
|
*/ |
17
|
|
|
class midcom_admin_help_help extends midcom_baseclasses_components_plugin |
18
|
|
|
{ |
19
|
|
|
private $mgdtypes = [ |
20
|
|
|
MGD_TYPE_STRING => "string", |
21
|
|
|
MGD_TYPE_INT => "integer", |
22
|
|
|
MGD_TYPE_UINT => "unsigned integer", |
23
|
|
|
MGD_TYPE_FLOAT => "float", |
24
|
|
|
MGD_TYPE_BOOLEAN => "boolean", |
25
|
|
|
MGD_TYPE_TIMESTAMP => "datetime", |
26
|
|
|
MGD_TYPE_LONGTEXT => "longtext", |
27
|
|
|
MGD_TYPE_GUID => "guid", |
28
|
|
|
MGD_TYPE_NONE => 'none' |
29
|
|
|
]; |
30
|
|
|
|
31
|
3 |
|
public function _on_initialize() |
32
|
|
|
{ |
33
|
3 |
|
midcom::get()->auth->require_valid_user(); |
34
|
|
|
|
35
|
3 |
|
midcom::get()->skip_page_style = true; |
36
|
|
|
// doing this here as this component most probably will not be called by itself. |
37
|
3 |
|
midcom::get()->style->prepend_component_styledir('midcom.admin.help'); |
38
|
3 |
|
} |
39
|
|
|
|
40
|
|
|
/** |
41
|
|
|
* Get component's documentation directory path |
42
|
|
|
*/ |
43
|
8 |
|
private static function get_documentation_dir(string $component) : string |
44
|
|
|
{ |
45
|
8 |
|
return midcom::get()->componentloader->path_to_snippetpath($component) . '/documentation/'; |
46
|
|
|
} |
47
|
|
|
|
48
|
8 |
|
public static function generate_file_path(string $help_id, string $component, string $language = null) : ?string |
49
|
|
|
{ |
50
|
8 |
|
if ($language === null) { |
51
|
8 |
|
$language = midcom::get()->i18n->get_current_language(); |
52
|
|
|
} |
53
|
|
|
|
54
|
8 |
|
$file = self::get_documentation_dir($component) . "{$help_id}.{$language}.txt"; |
55
|
8 |
|
if (!file_exists($file)) { |
56
|
8 |
|
if ($language != midcom::get()->i18n->get_fallback_language()) { |
57
|
|
|
// Try MidCOM's default fallback language |
58
|
1 |
|
return self::generate_file_path($help_id, $component, midcom::get()->i18n->get_fallback_language()); |
59
|
|
|
} |
60
|
8 |
|
return null; |
61
|
|
|
} |
62
|
|
|
|
63
|
5 |
|
return $file; |
64
|
|
|
} |
65
|
|
|
|
66
|
4 |
|
private function get_help_title(string $help_id, string $component) : string |
67
|
|
|
{ |
68
|
4 |
|
if ($path = self::generate_file_path($help_id, $component)) { |
69
|
4 |
|
$file_contents = file($path); |
70
|
4 |
|
if (trim($file_contents[0])) { |
71
|
4 |
|
return trim($file_contents[0]); |
72
|
|
|
} |
73
|
|
|
} |
74
|
|
|
|
75
|
1 |
|
return $this->_l10n->get("help_" . $help_id); |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* Load the file from the component's documentation directory. |
80
|
|
|
*/ |
81
|
5 |
|
private function _load_file(string $help_id, string $component) : ?string |
82
|
|
|
{ |
83
|
|
|
// Try loading the file |
84
|
5 |
|
$file = self::generate_file_path($help_id, $component); |
85
|
5 |
|
if (!$file) { |
86
|
4 |
|
return null; |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
// Load the contents |
90
|
1 |
|
$help_contents = file_get_contents($file); |
91
|
|
|
|
92
|
|
|
// Replace static URLs (URLs for screenshots etc) |
93
|
1 |
|
return str_replace('MIDCOM_STATIC_URL', MIDCOM_STATIC_URL, $help_contents); |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* Load a help file and markdownize it |
98
|
|
|
*/ |
99
|
5 |
|
public function get_help_contents(string $help_id, string $component) : ?string |
100
|
|
|
{ |
101
|
5 |
|
$text = $this->_load_file($help_id, $component); |
102
|
5 |
|
if (!$text) { |
103
|
4 |
|
return null; |
104
|
|
|
} |
105
|
1 |
|
return MarkdownExtra::defaultTransform($text); |
106
|
|
|
} |
107
|
|
|
|
108
|
5 |
|
public function list_files(string $component, bool $with_index = false) : array |
109
|
|
|
{ |
110
|
5 |
|
$files = $this->_list_physical_files($component); |
111
|
5 |
|
$files = $this->_add_virtual_files($files, $component); |
112
|
|
|
|
113
|
5 |
|
ksort($files); |
114
|
|
|
// prepend 'index' URL if required |
115
|
5 |
|
if ($with_index) { |
116
|
1 |
|
$files = array_merge([ |
117
|
|
|
'index' => [ |
118
|
1 |
|
'path' => '/', |
119
|
1 |
|
'subject' => $this->_l10n->get('help_index'), |
120
|
1 |
|
'lang' => 'en', |
121
|
|
|
]], |
122
|
1 |
|
$files |
123
|
|
|
); |
124
|
|
|
} |
125
|
5 |
|
return $files; |
126
|
|
|
} |
127
|
|
|
|
128
|
5 |
|
private function _add_virtual_files(array $files, string $component) : array |
129
|
|
|
{ |
130
|
|
|
// Schemas |
131
|
5 |
|
$this->_request_data['mgdschemas'] = midcom::get()->dbclassloader->get_component_classes($component); |
132
|
5 |
|
if (!empty($this->_request_data['mgdschemas'])) { |
133
|
3 |
|
$files['mgdschemas'] = [ |
134
|
3 |
|
'path' => '/mgdschemas', |
135
|
3 |
|
'subject' => $this->_l10n->get('help_mgdschemas'), |
136
|
3 |
|
'lang' => 'en', |
137
|
|
|
]; |
138
|
|
|
} |
139
|
|
|
|
140
|
|
|
// URL Methods |
141
|
5 |
|
$this->_request_data['urlmethods'] = $this->read_url_methods($component); |
142
|
5 |
|
if (!empty($this->_request_data['urlmethods'])) { |
143
|
4 |
|
$files['urlmethods'] = [ |
144
|
4 |
|
'path' => '/urlmethods', |
145
|
4 |
|
'subject' => $this->_l10n->get('help_urlmethods'), |
146
|
4 |
|
'lang' => 'en', |
147
|
|
|
]; |
148
|
|
|
} |
149
|
|
|
|
150
|
|
|
// Break if dealing with MidCOM Core docs |
151
|
5 |
|
if ($component == 'midcom') { |
152
|
|
|
ksort($files); |
153
|
|
|
return $files; |
154
|
|
|
} |
155
|
|
|
|
156
|
|
|
// handlers |
157
|
5 |
|
$this->_request_data['request_switch_info'] = $this->read_component_handlers($component); |
158
|
5 |
|
if (!empty($this->_request_data['request_switch_info'])) { |
159
|
4 |
|
$files['handlers'] = [ |
160
|
4 |
|
'path' => '/handlers', |
161
|
4 |
|
'subject' => $this->_l10n->get('help_handlers'), |
162
|
4 |
|
'lang' => 'en', |
163
|
|
|
]; |
164
|
|
|
} |
165
|
|
|
|
166
|
5 |
|
return $files; |
167
|
|
|
} |
168
|
|
|
|
169
|
5 |
|
private function _list_physical_files(string $component) : array |
170
|
|
|
{ |
171
|
5 |
|
$component_dir = self::get_documentation_dir($component); |
172
|
5 |
|
if (!is_dir($component_dir)) { |
173
|
1 |
|
return []; |
174
|
|
|
} |
175
|
|
|
|
176
|
4 |
|
$files = []; |
177
|
4 |
|
$pattern = $component_dir . '*.{' . $this->_i18n->get_current_language() . ',' . $this->_i18n->get_fallback_language() . '}.txt'; |
178
|
|
|
|
179
|
4 |
|
foreach (glob($pattern, GLOB_NOSORT|GLOB_BRACE) as $path) { |
180
|
4 |
|
$entry = basename($path); |
181
|
4 |
|
if ( str_starts_with($entry, 'index') |
182
|
4 |
|
|| str_starts_with($entry, 'handler') |
183
|
4 |
|
|| str_starts_with($entry, 'urlmethod')) { |
184
|
|
|
// Ignore dotfiles, handlers & index.lang.txt |
185
|
1 |
|
continue; |
186
|
|
|
} |
187
|
|
|
|
188
|
4 |
|
$filename_parts = explode('.', $entry); |
189
|
|
|
|
190
|
4 |
|
$files[$filename_parts[0]] = [ |
191
|
4 |
|
'path' => $path, |
192
|
4 |
|
'subject' => $this->get_help_title($filename_parts[0], $component), |
193
|
4 |
|
'lang' => $filename_parts[1], |
194
|
|
|
]; |
195
|
|
|
} |
196
|
|
|
|
197
|
4 |
|
return $files; |
198
|
|
|
} |
199
|
|
|
|
200
|
5 |
|
private function read_component_handlers(string $component) : array |
201
|
|
|
{ |
202
|
5 |
|
$data = []; |
203
|
|
|
|
204
|
5 |
|
$handler = midcom::get()->componentloader->get_interface_class($component); |
205
|
5 |
|
$viewer = $handler->get_viewer(new midcom_db_topic); |
206
|
5 |
|
$routes = $viewer->get_router()->getRouteCollection()->all(); |
207
|
5 |
|
foreach ($routes as $request_handler_id => $route) { |
208
|
4 |
|
$details = []; |
209
|
|
|
|
210
|
|
|
// Build the dynamic_loadable URI, starting from topic path |
211
|
4 |
|
$details['route'] = str_replace(midcom_connection::get_url('prefix') . '/', '', midcom_core_context::get()->get_key(MIDCOM_CONTEXT_ANCHORPREFIX)); |
212
|
|
|
|
213
|
|
|
// Add fixed arguments |
214
|
4 |
|
$details['route'] .= preg_replace('/args_(\d+)/', 'args[\1]', $route->getPath()); |
215
|
4 |
|
list ($details['controller'], $details['action']) = explode('::', $route->getDefault('_controller'), 2); |
|
|
|
|
216
|
|
|
|
217
|
4 |
|
if (self::generate_file_path('handlers_' . $request_handler_id, $component)) { |
218
|
1 |
|
$details['info'] = $this->get_help_contents('handlers_' . $request_handler_id, $component); |
219
|
1 |
|
$details['handler_help_url'] = 'handlers_' . $request_handler_id; |
220
|
|
|
} |
221
|
4 |
|
$data[$request_handler_id] = $details; |
222
|
|
|
} |
223
|
|
|
|
224
|
5 |
|
return $data; |
225
|
|
|
} |
226
|
|
|
|
227
|
5 |
|
private function read_url_methods(string $component) : array |
228
|
|
|
{ |
229
|
5 |
|
$data = []; |
230
|
|
|
|
231
|
5 |
|
$exec_path = midcom::get()->componentloader->path_to_snippetpath($component) . '/exec/'; |
232
|
5 |
|
if ( !is_dir($exec_path) |
233
|
5 |
|
|| !is_readable($exec_path)) { |
234
|
|
|
// Directory not accessible, skip loading it |
235
|
1 |
|
return $data; |
236
|
|
|
} |
237
|
|
|
|
238
|
4 |
|
foreach (glob($exec_path . '/*.php', GLOB_NOSORT) as $path) { |
239
|
4 |
|
$file = basename($path); |
240
|
4 |
|
$info_id = "urlmethod_" . str_replace('.php', '', $file); |
241
|
|
|
|
242
|
4 |
|
$data[$file] = [ |
243
|
4 |
|
'url' => '/midcom-exec-' . $component . '/' . $file, |
244
|
|
|
]; |
245
|
|
|
|
246
|
4 |
|
if (self::generate_file_path($info_id, $component)) { |
247
|
|
|
$data[$file]['handler_help_url'] = $info_id; |
248
|
|
|
$data[$file]['description'] = $this->get_help_contents($info_id, $component); |
249
|
|
|
} |
250
|
|
|
} |
251
|
|
|
|
252
|
4 |
|
return $data; |
253
|
|
|
} |
254
|
|
|
|
255
|
1 |
|
private function read_schema_properties() |
256
|
|
|
{ |
257
|
1 |
|
foreach (array_keys($this->_request_data['mgdschemas']) as $mgdschema_class) { |
258
|
1 |
|
$mrp = new midgard_reflection_property($mgdschema_class); |
259
|
1 |
|
$class_props = connection::get_em()->getClassMetadata($mgdschema_class)->get_schema_properties(); |
|
|
|
|
260
|
|
|
|
261
|
1 |
|
unset($class_props['metadata']); |
262
|
1 |
|
$default_properties = []; |
263
|
1 |
|
$additional_properties = []; |
264
|
|
|
|
265
|
1 |
|
foreach ($class_props as $prop) { |
266
|
1 |
|
switch ($prop) { |
267
|
1 |
|
case 'action': |
268
|
|
|
// Midgard-internal properties, skip |
269
|
|
|
break; |
270
|
1 |
|
case 'guid': |
271
|
1 |
|
case 'id': |
272
|
1 |
|
$default_properties[$prop] = $this->_get_property_data($mrp, $prop); |
273
|
1 |
|
break; |
274
|
|
|
default: |
275
|
1 |
|
$additional_properties[$prop] = $this->_get_property_data($mrp, $prop); |
276
|
1 |
|
break; |
277
|
|
|
} |
278
|
|
|
} |
279
|
1 |
|
ksort($default_properties); |
280
|
1 |
|
ksort($additional_properties); |
281
|
|
|
|
282
|
1 |
|
$this->_request_data['properties'][$mgdschema_class] = array_merge($default_properties, $additional_properties); |
283
|
|
|
} |
284
|
1 |
|
} |
285
|
|
|
|
286
|
1 |
|
private function _get_property_data(midgard_reflection_property $mrp, string $prop) : array |
287
|
|
|
{ |
288
|
|
|
return [ |
289
|
1 |
|
'value' => $mrp->description($prop), |
290
|
1 |
|
'link' => $mrp->is_link($prop), |
291
|
1 |
|
'link_name' => $mrp->get_link_name($prop), |
292
|
1 |
|
'link_target' => $mrp->get_link_target($prop), |
293
|
1 |
|
'midgard_type' => $this->mgdtypes[$mrp->get_midgard_type($prop)] |
294
|
|
|
]; |
295
|
|
|
} |
296
|
|
|
|
297
|
3 |
|
private function _prepare_breadcrumb(string $handler_id) |
298
|
|
|
{ |
299
|
3 |
|
$this->add_breadcrumb($this->router->generate('welcome'), $this->_l10n->get('help')); |
300
|
|
|
|
301
|
3 |
|
if (in_array($handler_id, ['help', 'component'])) { |
302
|
2 |
|
$this->add_breadcrumb( |
303
|
2 |
|
$this->router->generate('component', ['component' => $this->_request_data['component']]), |
304
|
2 |
|
$this->_i18n->get_string($this->_request_data['component'], $this->_request_data['component']) |
305
|
|
|
); |
306
|
|
|
} |
307
|
3 |
|
} |
308
|
|
|
|
309
|
1 |
|
public function _handler_welcome(string $handler_id, array &$data) |
310
|
|
|
{ |
311
|
1 |
|
$data['view_title'] = $this->_l10n->get($this->_component); |
312
|
1 |
|
midcom::get()->head->set_pagetitle($data['view_title']); |
313
|
|
|
|
314
|
1 |
|
$data['components'] = []; |
315
|
1 |
|
$data['libraries'] = []; |
316
|
|
|
|
317
|
1 |
|
foreach (midcom::get()->componentloader->get_manifests() as $manifest) { |
318
|
1 |
|
$type = $manifest->purecode ? 'libraries' : 'components'; |
319
|
1 |
|
$title = $manifest->get_name_translated(); |
320
|
1 |
|
if ($title == $manifest->name) { |
321
|
1 |
|
$title = ''; |
322
|
|
|
} |
323
|
|
|
|
324
|
1 |
|
$data[$type][$manifest->name] = [ |
325
|
1 |
|
'name' => $manifest->name, |
326
|
1 |
|
'title' => $title, |
327
|
1 |
|
'icon' => midcom::get()->componentloader->get_component_icon($manifest->name), |
328
|
1 |
|
'purecode' => $manifest->purecode, |
329
|
1 |
|
'description' => $manifest->description, |
330
|
|
|
]; |
331
|
|
|
} |
332
|
|
|
|
333
|
1 |
|
asort($data['components']); |
334
|
1 |
|
asort($data['libraries']); |
335
|
|
|
|
336
|
1 |
|
$this->_prepare_breadcrumb($handler_id); |
337
|
1 |
|
} |
338
|
|
|
|
339
|
|
|
/** |
340
|
|
|
* Shows the help system main screen |
341
|
|
|
*/ |
342
|
1 |
|
public function _show_welcome(string $handler_id, array &$data) |
343
|
|
|
{ |
344
|
1 |
|
midcom_show_style('midcom_admin_help_header'); |
345
|
1 |
|
midcom_show_style('midcom_admin_help_about'); |
346
|
1 |
|
$list_types = ['components', 'libraries']; |
347
|
|
|
|
348
|
1 |
|
foreach ($list_types as $list_type) { |
349
|
1 |
|
$data['list_type'] = $list_type; |
350
|
1 |
|
midcom_show_style('midcom_admin_help_list_header'); |
351
|
1 |
|
foreach ($data[$list_type] as $component_data) { |
352
|
1 |
|
$data['component_data'] = $component_data; |
353
|
1 |
|
midcom_show_style('midcom_admin_help_list_item'); |
354
|
|
|
} |
355
|
1 |
|
midcom_show_style('midcom_admin_help_list_footer'); |
356
|
|
|
} |
357
|
|
|
|
358
|
1 |
|
midcom_show_style('midcom_admin_help_footer'); |
359
|
1 |
|
} |
360
|
|
|
|
361
|
1 |
|
public function _handler_component(string $handler_id, string $component, array &$data) |
362
|
|
|
{ |
363
|
1 |
|
$data['component'] = $component; |
364
|
1 |
|
$data['view_title'] = sprintf($this->_l10n->get('help for %s'), $this->_i18n->get_string($component, $component)); |
365
|
1 |
|
midcom::get()->head->set_pagetitle($data['view_title']); |
366
|
|
|
|
367
|
1 |
|
$data['help_files'] = $this->list_files($component); |
368
|
1 |
|
$data['html'] = $this->get_help_contents('index', $component); |
369
|
1 |
|
$this->_prepare_breadcrumb($handler_id); |
370
|
1 |
|
} |
371
|
|
|
|
372
|
|
|
/** |
373
|
|
|
* Shows the component help ToC. |
374
|
|
|
*/ |
375
|
1 |
|
public function _show_component(string $handler_id, array &$data) |
376
|
|
|
{ |
377
|
1 |
|
midcom_show_style('midcom_admin_help_header'); |
378
|
|
|
|
379
|
1 |
|
midcom_show_style('midcom_admin_help_show'); |
380
|
1 |
|
midcom_show_style('midcom_admin_help_component'); |
381
|
|
|
|
382
|
1 |
|
midcom_show_style('midcom_admin_help_footer'); |
383
|
1 |
|
} |
384
|
|
|
|
385
|
1 |
|
public function _handler_help(string $handler_id, string $component, string $help_id, array &$data) |
386
|
|
|
{ |
387
|
1 |
|
$data['help_id'] = $help_id; |
388
|
1 |
|
$data['component'] = $component; |
389
|
1 |
|
$data['help_files'] = $this->list_files($component); |
390
|
|
|
|
391
|
1 |
|
if ($help_id == 'mgdschemas') { |
392
|
1 |
|
$this->read_schema_properties(); |
393
|
|
|
} |
394
|
1 |
|
$data['html'] = $this->get_help_contents($help_id, $component); |
395
|
|
|
|
396
|
1 |
|
midcom::get()->head->add_jsfile(MIDCOM_STATIC_URL . '/midcom.admin.help/twisty.js'); |
397
|
1 |
|
$this->add_stylesheet(MIDCOM_STATIC_URL . '/stock-icons/font-awesome-4.7.0/css/font-awesome.min.css'); |
398
|
|
|
|
399
|
|
|
// Table of contents navi |
400
|
1 |
|
$data['view_title'] = sprintf( |
401
|
1 |
|
$this->_l10n->get('help for %s in %s'), |
402
|
1 |
|
$this->get_help_title($help_id, $component), |
403
|
1 |
|
$this->_i18n->get_string($component, $component) |
404
|
|
|
); |
405
|
1 |
|
midcom::get()->head->set_pagetitle($data['view_title']); |
406
|
1 |
|
$this->_prepare_breadcrumb($handler_id); |
407
|
1 |
|
if (in_array($help_id, ['handlers', 'urlmethods', 'mgdschemas'])) { |
408
|
1 |
|
$this->add_breadcrumb("", $this->_l10n->get($help_id)); |
409
|
|
|
} else { |
410
|
|
|
$this->add_breadcrumb("", $this->get_help_title($help_id, $component)); |
411
|
|
|
} |
412
|
1 |
|
} |
413
|
|
|
|
414
|
|
|
/** |
415
|
|
|
* Shows the help page. |
416
|
|
|
*/ |
417
|
1 |
|
public function _show_help(string $handler_id, array &$data) |
418
|
|
|
{ |
419
|
1 |
|
midcom_show_style('midcom_admin_help_header'); |
420
|
1 |
|
midcom_show_style('midcom_admin_help_show'); |
421
|
1 |
|
if (in_array($data['help_id'], ['handlers', 'mgdschemas', 'urlmethods'])) { |
422
|
1 |
|
midcom_show_style('midcom_admin_help_' . $data['help_id']); |
423
|
|
|
} elseif (!$data['html']) { |
424
|
|
|
$data['html'] = $this->get_help_contents('notfound', $this->_component); |
425
|
|
|
midcom_show_style('midcom_admin_help_show'); |
426
|
|
|
midcom_show_style('midcom_admin_help_component'); |
427
|
|
|
} |
428
|
1 |
|
midcom_show_style('midcom_admin_help_footer'); |
429
|
1 |
|
} |
430
|
|
|
} |
431
|
|
|
|