|
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 array $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
|
|
|
} |
|
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 |
|
$language ??= midcom::get()->i18n->get_current_language(); |
|
51
|
|
|
|
|
52
|
8 |
|
$file = self::get_documentation_dir($component) . "{$help_id}.{$language}.txt"; |
|
53
|
8 |
|
if (!file_exists($file)) { |
|
54
|
8 |
|
if ($language != midcom::get()->i18n->get_fallback_language()) { |
|
55
|
|
|
// Try MidCOM's default fallback language |
|
56
|
1 |
|
return self::generate_file_path($help_id, $component, midcom::get()->i18n->get_fallback_language()); |
|
57
|
|
|
} |
|
58
|
8 |
|
return null; |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
5 |
|
return $file; |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
4 |
|
private function get_help_title(string $help_id, string $component) : string |
|
65
|
|
|
{ |
|
66
|
4 |
|
if ($path = self::generate_file_path($help_id, $component)) { |
|
67
|
4 |
|
$file_contents = file($path); |
|
68
|
4 |
|
if (trim($file_contents[0])) { |
|
69
|
4 |
|
return trim($file_contents[0]); |
|
70
|
|
|
} |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
1 |
|
return $this->_l10n->get("help_" . $help_id); |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* Load the file from the component's documentation directory. |
|
78
|
|
|
*/ |
|
79
|
5 |
|
private function _load_file(string $help_id, string $component) : ?string |
|
80
|
|
|
{ |
|
81
|
|
|
// Try loading the file |
|
82
|
5 |
|
$file = self::generate_file_path($help_id, $component); |
|
83
|
5 |
|
if (!$file) { |
|
84
|
4 |
|
return null; |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
|
|
// Load the contents |
|
88
|
1 |
|
$help_contents = file_get_contents($file); |
|
89
|
|
|
|
|
90
|
|
|
// Replace static URLs (URLs for screenshots etc) |
|
91
|
1 |
|
return str_replace('MIDCOM_STATIC_URL', MIDCOM_STATIC_URL, $help_contents); |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* Load a help file and markdownize it |
|
96
|
|
|
*/ |
|
97
|
5 |
|
public function get_help_contents(string $help_id, string $component) : ?string |
|
98
|
|
|
{ |
|
99
|
5 |
|
$text = $this->_load_file($help_id, $component); |
|
100
|
5 |
|
if (!$text) { |
|
101
|
4 |
|
return null; |
|
102
|
|
|
} |
|
103
|
1 |
|
return MarkdownExtra::defaultTransform($text); |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
5 |
|
public function list_files(string $component, bool $with_index = false) : array |
|
107
|
|
|
{ |
|
108
|
5 |
|
$files = $this->_list_physical_files($component); |
|
109
|
5 |
|
$files = $this->_add_virtual_files($files, $component); |
|
110
|
|
|
|
|
111
|
5 |
|
ksort($files); |
|
112
|
|
|
// prepend 'index' URL if required |
|
113
|
5 |
|
if ($with_index) { |
|
114
|
1 |
|
$files = array_merge([ |
|
115
|
1 |
|
'index' => [ |
|
116
|
1 |
|
'path' => '/', |
|
117
|
1 |
|
'subject' => $this->_l10n->get('help_index'), |
|
118
|
1 |
|
'lang' => 'en', |
|
119
|
1 |
|
]], |
|
120
|
1 |
|
$files |
|
121
|
1 |
|
); |
|
122
|
|
|
} |
|
123
|
5 |
|
return $files; |
|
124
|
|
|
} |
|
125
|
|
|
|
|
126
|
5 |
|
private function _add_virtual_files(array $files, string $component) : array |
|
127
|
|
|
{ |
|
128
|
5 |
|
$options = [ |
|
129
|
5 |
|
'mgdschemas' => midcom::get()->dbclassloader->get_component_classes($component), |
|
130
|
5 |
|
'urlmethods' => $this->read_url_methods($component) |
|
131
|
5 |
|
]; |
|
132
|
5 |
|
if ($component != 'midcom') { |
|
133
|
5 |
|
$options['handlers'] = $this->read_component_handlers($component); |
|
134
|
|
|
} |
|
135
|
5 |
|
foreach ($options as $key => $values) { |
|
136
|
5 |
|
if (!empty($values)) { |
|
137
|
5 |
|
$files[$key] = [ |
|
138
|
5 |
|
'path' => '/' . $key, |
|
139
|
5 |
|
'subject' => $this->_l10n->get('help_' . $key), |
|
140
|
5 |
|
'lang' => 'en', |
|
141
|
5 |
|
]; |
|
142
|
|
|
} |
|
143
|
5 |
|
$this->_request_data[$key] = $values; |
|
144
|
|
|
} |
|
145
|
|
|
|
|
146
|
5 |
|
return $files; |
|
147
|
|
|
} |
|
148
|
|
|
|
|
149
|
5 |
|
private function _list_physical_files(string $component) : array |
|
150
|
|
|
{ |
|
151
|
5 |
|
$component_dir = self::get_documentation_dir($component); |
|
152
|
5 |
|
if (!is_dir($component_dir)) { |
|
153
|
1 |
|
return []; |
|
154
|
|
|
} |
|
155
|
|
|
|
|
156
|
4 |
|
$files = []; |
|
157
|
4 |
|
$pattern = $component_dir . '*.{' . $this->_i18n->get_current_language() . ',' . $this->_i18n->get_fallback_language() . '}.txt'; |
|
158
|
|
|
|
|
159
|
4 |
|
foreach (glob($pattern, GLOB_NOSORT|GLOB_BRACE) as $path) { |
|
160
|
4 |
|
$entry = basename($path); |
|
161
|
4 |
|
if ( str_starts_with($entry, 'index') |
|
162
|
4 |
|
|| str_starts_with($entry, 'handler') |
|
163
|
4 |
|
|| str_starts_with($entry, 'urlmethod')) { |
|
164
|
|
|
// Ignore dotfiles, handlers & index.lang.txt |
|
165
|
1 |
|
continue; |
|
166
|
|
|
} |
|
167
|
|
|
|
|
168
|
4 |
|
$filename_parts = explode('.', $entry); |
|
169
|
|
|
|
|
170
|
4 |
|
$files[$filename_parts[0]] = [ |
|
171
|
4 |
|
'path' => $path, |
|
172
|
4 |
|
'subject' => $this->get_help_title($filename_parts[0], $component), |
|
173
|
4 |
|
'lang' => $filename_parts[1], |
|
174
|
4 |
|
]; |
|
175
|
|
|
} |
|
176
|
|
|
|
|
177
|
4 |
|
return $files; |
|
178
|
|
|
} |
|
179
|
|
|
|
|
180
|
5 |
|
private function read_component_handlers(string $component) : array |
|
181
|
|
|
{ |
|
182
|
5 |
|
$data = []; |
|
183
|
|
|
|
|
184
|
5 |
|
$handler = midcom::get()->componentloader->get_interface_class($component); |
|
185
|
5 |
|
$viewer = $handler->get_viewer(new midcom_db_topic); |
|
186
|
5 |
|
$routes = $viewer->get_router()->getRouteCollection()->all(); |
|
187
|
5 |
|
foreach ($routes as $request_handler_id => $route) { |
|
188
|
4 |
|
$details = [ |
|
189
|
4 |
|
'route' => preg_replace('/args_(\d+)/', 'args[\1]', $route->getPath()) |
|
190
|
4 |
|
]; |
|
191
|
|
|
|
|
192
|
4 |
|
list ($details['controller'], $details['action']) = explode('::', $route->getDefault('_controller'), 2); |
|
193
|
|
|
|
|
194
|
4 |
|
if (self::generate_file_path('handlers_' . $request_handler_id, $component)) { |
|
195
|
1 |
|
$details['info'] = $this->get_help_contents('handlers_' . $request_handler_id, $component); |
|
196
|
1 |
|
$details['handler_help_url'] = 'handlers_' . $request_handler_id; |
|
197
|
|
|
} |
|
198
|
4 |
|
$data[$request_handler_id] = $details; |
|
199
|
|
|
} |
|
200
|
|
|
|
|
201
|
5 |
|
return $data; |
|
202
|
|
|
} |
|
203
|
|
|
|
|
204
|
5 |
|
private function read_url_methods(string $component) : array |
|
205
|
|
|
{ |
|
206
|
5 |
|
$data = []; |
|
207
|
|
|
|
|
208
|
5 |
|
$exec_path = midcom::get()->componentloader->path_to_snippetpath($component) . '/exec/'; |
|
209
|
5 |
|
if ( !is_dir($exec_path) |
|
210
|
5 |
|
|| !is_readable($exec_path)) { |
|
211
|
|
|
// Directory not accessible, skip loading it |
|
212
|
1 |
|
return $data; |
|
213
|
|
|
} |
|
214
|
|
|
|
|
215
|
4 |
|
foreach (glob($exec_path . '/*.php', GLOB_NOSORT) as $path) { |
|
216
|
4 |
|
$file = basename($path); |
|
217
|
4 |
|
$info_id = "urlmethod_" . str_replace('.php', '', $file); |
|
218
|
|
|
|
|
219
|
4 |
|
$data[$file] = [ |
|
220
|
4 |
|
'url' => '/midcom-exec-' . $component . '/' . $file, |
|
221
|
4 |
|
]; |
|
222
|
|
|
|
|
223
|
4 |
|
if (self::generate_file_path($info_id, $component)) { |
|
224
|
|
|
$data[$file]['handler_help_url'] = $info_id; |
|
225
|
|
|
$data[$file]['description'] = $this->get_help_contents($info_id, $component); |
|
226
|
|
|
} |
|
227
|
|
|
} |
|
228
|
|
|
|
|
229
|
4 |
|
return $data; |
|
230
|
|
|
} |
|
231
|
|
|
|
|
232
|
1 |
|
private function read_schema_properties() |
|
233
|
|
|
{ |
|
234
|
1 |
|
foreach (array_keys($this->_request_data['mgdschemas']) as $mgdschema_class) { |
|
235
|
1 |
|
$mrp = new midgard_reflection_property($mgdschema_class); |
|
236
|
1 |
|
$class_props = connection::get_em()->getClassMetadata($mgdschema_class)->get_schema_properties(); |
|
|
|
|
|
|
237
|
|
|
|
|
238
|
1 |
|
unset($class_props['metadata']); |
|
239
|
1 |
|
$default_properties = []; |
|
240
|
1 |
|
$additional_properties = []; |
|
241
|
|
|
|
|
242
|
1 |
|
foreach ($class_props as $prop) { |
|
243
|
|
|
switch ($prop) { |
|
244
|
1 |
|
case 'action': |
|
245
|
|
|
// Midgard-internal properties, skip |
|
246
|
|
|
break; |
|
247
|
1 |
|
case 'guid': |
|
248
|
1 |
|
case 'id': |
|
249
|
1 |
|
$default_properties[$prop] = $this->_get_property_data($mrp, $prop); |
|
250
|
1 |
|
break; |
|
251
|
|
|
default: |
|
252
|
1 |
|
$additional_properties[$prop] = $this->_get_property_data($mrp, $prop); |
|
253
|
1 |
|
break; |
|
254
|
|
|
} |
|
255
|
|
|
} |
|
256
|
1 |
|
ksort($default_properties); |
|
257
|
1 |
|
ksort($additional_properties); |
|
258
|
|
|
|
|
259
|
1 |
|
$this->_request_data['properties'][$mgdschema_class] = array_merge($default_properties, $additional_properties); |
|
260
|
|
|
} |
|
261
|
|
|
} |
|
262
|
|
|
|
|
263
|
1 |
|
private function _get_property_data(midgard_reflection_property $mrp, string $prop) : array |
|
264
|
|
|
{ |
|
265
|
1 |
|
return [ |
|
266
|
1 |
|
'value' => $mrp->description($prop) ?? '', |
|
267
|
1 |
|
'link' => $mrp->is_link($prop), |
|
268
|
1 |
|
'link_name' => $mrp->get_link_name($prop), |
|
269
|
1 |
|
'link_target' => $mrp->get_link_target($prop), |
|
270
|
1 |
|
'midgard_type' => $this->mgdtypes[$mrp->get_midgard_type($prop)] |
|
271
|
1 |
|
]; |
|
272
|
|
|
} |
|
273
|
|
|
|
|
274
|
3 |
|
private function _prepare_breadcrumb(string $handler_id) |
|
275
|
|
|
{ |
|
276
|
3 |
|
$this->add_breadcrumb($this->router->generate('welcome'), $this->_l10n->get('help')); |
|
277
|
|
|
|
|
278
|
3 |
|
if (in_array($handler_id, ['help', 'component'])) { |
|
279
|
2 |
|
$this->add_breadcrumb( |
|
280
|
2 |
|
$this->router->generate('component', ['component' => $this->_request_data['component']]), |
|
281
|
2 |
|
$this->_i18n->get_string($this->_request_data['component'], $this->_request_data['component']) |
|
282
|
2 |
|
); |
|
283
|
|
|
} |
|
284
|
|
|
} |
|
285
|
|
|
|
|
286
|
1 |
|
public function _handler_welcome(string $handler_id, array &$data) |
|
287
|
|
|
{ |
|
288
|
1 |
|
$data['view_title'] = $this->_l10n->get($this->_component); |
|
289
|
1 |
|
midcom::get()->head->set_pagetitle($data['view_title']); |
|
290
|
|
|
|
|
291
|
1 |
|
$data['components'] = []; |
|
292
|
1 |
|
$data['libraries'] = []; |
|
293
|
|
|
|
|
294
|
1 |
|
foreach (midcom::get()->componentloader->get_manifests() as $manifest) { |
|
295
|
1 |
|
$type = $manifest->purecode ? 'libraries' : 'components'; |
|
296
|
1 |
|
$title = $manifest->get_name_translated(); |
|
297
|
1 |
|
if ($title == $manifest->name) { |
|
298
|
1 |
|
$title = ''; |
|
299
|
|
|
} |
|
300
|
|
|
|
|
301
|
1 |
|
$data[$type][$manifest->name] = [ |
|
302
|
1 |
|
'name' => $manifest->name, |
|
303
|
1 |
|
'title' => $title, |
|
304
|
1 |
|
'icon' => midcom::get()->componentloader->get_component_icon($manifest->name), |
|
305
|
1 |
|
'description' => $manifest->description, |
|
306
|
1 |
|
]; |
|
307
|
|
|
} |
|
308
|
|
|
|
|
309
|
1 |
|
asort($data['components']); |
|
310
|
1 |
|
asort($data['libraries']); |
|
311
|
|
|
|
|
312
|
1 |
|
$this->_prepare_breadcrumb($handler_id); |
|
313
|
|
|
} |
|
314
|
|
|
|
|
315
|
|
|
/** |
|
316
|
|
|
* Shows the help system main screen |
|
317
|
|
|
*/ |
|
318
|
1 |
|
public function _show_welcome(string $handler_id, array &$data) |
|
319
|
|
|
{ |
|
320
|
1 |
|
midcom_show_style('midcom_admin_help_header'); |
|
321
|
1 |
|
midcom_show_style('midcom_admin_help_about'); |
|
322
|
1 |
|
$list_types = ['components', 'libraries']; |
|
323
|
|
|
|
|
324
|
1 |
|
foreach ($list_types as $list_type) { |
|
325
|
1 |
|
$data['list_type'] = $list_type; |
|
326
|
1 |
|
midcom_show_style('midcom_admin_help_list_header'); |
|
327
|
1 |
|
foreach ($data[$list_type] as $component_data) { |
|
328
|
1 |
|
$data['component_data'] = $component_data; |
|
329
|
1 |
|
midcom_show_style('midcom_admin_help_list_item'); |
|
330
|
|
|
} |
|
331
|
1 |
|
midcom_show_style('midcom_admin_help_list_footer'); |
|
332
|
|
|
} |
|
333
|
|
|
|
|
334
|
1 |
|
midcom_show_style('midcom_admin_help_footer'); |
|
335
|
|
|
} |
|
336
|
|
|
|
|
337
|
1 |
|
public function _handler_component(string $handler_id, string $component, array &$data) |
|
338
|
|
|
{ |
|
339
|
1 |
|
$data['component'] = $component; |
|
340
|
1 |
|
$data['view_title'] = sprintf($this->_l10n->get('help for %s'), $this->_i18n->get_string($component, $component)); |
|
341
|
1 |
|
midcom::get()->head->set_pagetitle($data['view_title']); |
|
342
|
|
|
|
|
343
|
1 |
|
$data['help_files'] = $this->list_files($component); |
|
344
|
1 |
|
$data['html'] = $this->get_help_contents('index', $component); |
|
345
|
1 |
|
$this->_prepare_breadcrumb($handler_id); |
|
346
|
|
|
} |
|
347
|
|
|
|
|
348
|
|
|
/** |
|
349
|
|
|
* Shows the component help ToC. |
|
350
|
|
|
*/ |
|
351
|
1 |
|
public function _show_component(string $handler_id, array &$data) |
|
352
|
|
|
{ |
|
353
|
1 |
|
midcom_show_style('midcom_admin_help_header'); |
|
354
|
|
|
|
|
355
|
1 |
|
midcom_show_style('midcom_admin_help_show'); |
|
356
|
1 |
|
midcom_show_style('midcom_admin_help_component'); |
|
357
|
|
|
|
|
358
|
1 |
|
midcom_show_style('midcom_admin_help_footer'); |
|
359
|
|
|
} |
|
360
|
|
|
|
|
361
|
1 |
|
public function _handler_help(string $handler_id, string $component, string $help_id, array &$data) |
|
362
|
|
|
{ |
|
363
|
1 |
|
$data['help_id'] = $help_id; |
|
364
|
1 |
|
$data['component'] = $component; |
|
365
|
1 |
|
$data['help_files'] = $this->list_files($component); |
|
366
|
|
|
|
|
367
|
1 |
|
if ($help_id == 'mgdschemas') { |
|
368
|
1 |
|
$this->read_schema_properties(); |
|
369
|
|
|
} |
|
370
|
1 |
|
$data['html'] = $this->get_help_contents($help_id, $component); |
|
371
|
|
|
|
|
372
|
1 |
|
midcom::get()->head->add_jsfile(MIDCOM_STATIC_URL . '/midcom.admin.help/twisty.js'); |
|
373
|
1 |
|
$this->add_stylesheet(MIDCOM_STATIC_URL . '/stock-icons/font-awesome-4.7.0/css/font-awesome.min.css'); |
|
374
|
|
|
|
|
375
|
|
|
// Table of contents navi |
|
376
|
1 |
|
$data['view_title'] = sprintf( |
|
377
|
1 |
|
$this->_l10n->get('help for %s in %s'), |
|
378
|
1 |
|
$this->get_help_title($help_id, $component), |
|
379
|
1 |
|
$this->_i18n->get_string($component, $component) |
|
380
|
1 |
|
); |
|
381
|
1 |
|
midcom::get()->head->set_pagetitle($data['view_title']); |
|
382
|
1 |
|
$this->_prepare_breadcrumb($handler_id); |
|
383
|
1 |
|
if (in_array($help_id, ['handlers', 'urlmethods', 'mgdschemas'])) { |
|
384
|
1 |
|
$this->add_breadcrumb("", $this->_l10n->get($help_id)); |
|
385
|
|
|
} else { |
|
386
|
|
|
$this->add_breadcrumb("", $this->get_help_title($help_id, $component)); |
|
387
|
|
|
} |
|
388
|
|
|
} |
|
389
|
|
|
|
|
390
|
|
|
/** |
|
391
|
|
|
* Shows the help page. |
|
392
|
|
|
*/ |
|
393
|
1 |
|
public function _show_help(string $handler_id, array &$data) |
|
394
|
|
|
{ |
|
395
|
1 |
|
midcom_show_style('midcom_admin_help_header'); |
|
396
|
1 |
|
midcom_show_style('midcom_admin_help_show'); |
|
397
|
1 |
|
if (in_array($data['help_id'], ['handlers', 'mgdschemas', 'urlmethods'])) { |
|
398
|
1 |
|
midcom_show_style('midcom_admin_help_' . $data['help_id']); |
|
399
|
|
|
} elseif (!$data['html']) { |
|
400
|
|
|
$data['html'] = $this->get_help_contents('notfound', $this->_component); |
|
401
|
|
|
midcom_show_style('midcom_admin_help_show'); |
|
402
|
|
|
midcom_show_style('midcom_admin_help_component'); |
|
403
|
|
|
} |
|
404
|
1 |
|
midcom_show_style('midcom_admin_help_footer'); |
|
405
|
|
|
} |
|
406
|
|
|
} |
|
407
|
|
|
|
flack /
openpsa
Loading history...