MDL-66091 analytics: Targets choose if there should be a report or not
[moodle.git] / analytics / classes / manager.php
CommitLineData
369389c9
DM
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
b94dbb55 18 * Analytics basic actions manager.
369389c9
DM
19 *
20 * @package core_analytics
21 * @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace core_analytics;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
b94dbb55 30 * Analytics basic actions manager.
369389c9
DM
31 *
32 * @package core_analytics
33 * @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 */
36class manager {
37
ed12ba6b
DM
38 /**
39 * Default mlbackend
40 */
41 const DEFAULT_MLBACKEND = '\mlbackend_php\processor';
42
f0584045
DM
43 /**
44 * Name of the file where components declare their models.
45 */
46 const ANALYTICS_FILENAME = 'db/analytics.php';
47
369389c9
DM
48 /**
49 * @var \core_analytics\predictor[]
50 */
51 protected static $predictionprocessors = null;
52
e4453adc
DM
53 /**
54 * @var \core_analytics\local\target\base[]
55 */
56 protected static $alltargets = null;
57
369389c9
DM
58 /**
59 * @var \core_analytics\local\indicator\base[]
60 */
61 protected static $allindicators = null;
62
63 /**
64 * @var \core_analytics\local\time_splitting\base[]
65 */
66 protected static $alltimesplittings = null;
67
1611308b
DM
68 /**
69 * Checks that the user can manage models
70 *
71 * @throws \required_capability_exception
72 * @return void
73 */
74 public static function check_can_manage_models() {
75 require_capability('moodle/analytics:managemodels', \context_system::instance());
76 }
77
78 /**
79 * Checks that the user can list that context insights
80 *
81 * @throws \required_capability_exception
82 * @param \context $context
50935afb 83 * @param bool $return The method returns a bool if true.
1611308b
DM
84 * @return void
85 */
50935afb
DM
86 public static function check_can_list_insights(\context $context, bool $return = false) {
87 global $USER;
88
89 if ($context->contextlevel === CONTEXT_USER && $context->instanceid == $USER->id) {
90 $capability = 'moodle/analytics:listowninsights';
91 } else {
92 $capability = 'moodle/analytics:listinsights';
93 }
94
95 if ($return) {
96 return has_capability($capability, $context);
97 } else {
98 require_capability($capability, $context);
99 }
1611308b
DM
100 }
101
584ffa4f
DM
102 /**
103 * Returns all system models that match the provided filters.
104 *
105 * @param bool $enabled
106 * @param bool $trained
08015e18 107 * @param \context|false $predictioncontext
584ffa4f
DM
108 * @return \core_analytics\model[]
109 */
369389c9
DM
110 public static function get_all_models($enabled = false, $trained = false, $predictioncontext = false) {
111 global $DB;
112
1611308b
DM
113 $params = array();
114
88777c57 115 $sql = "SELECT am.* FROM {analytics_models} am";
1611308b 116
88777c57 117 if ($enabled || $trained || $predictioncontext) {
1611308b
DM
118 $conditions = [];
119 if ($enabled) {
120 $conditions[] = 'am.enabled = :enabled';
121 $params['enabled'] = 1;
122 }
123 if ($trained) {
124 $conditions[] = 'am.trained = :trained';
125 $params['trained'] = 1;
126 }
88777c57 127 if ($predictioncontext) {
d887b0c7
DM
128 $conditions[] = "EXISTS (SELECT 'x'
129 FROM {analytics_predictions} ap
130 WHERE ap.modelid = am.id AND ap.contextid = :contextid)";
88777c57
DM
131 $params['contextid'] = $predictioncontext->id;
132 }
e10b29ed 133 $sql .= ' WHERE ' . implode(' AND ', $conditions);
369389c9 134 }
e10b29ed
DM
135 $sql .= ' ORDER BY am.enabled DESC, am.timemodified DESC';
136
1611308b 137 $modelobjs = $DB->get_records_sql($sql, $params);
369389c9
DM
138
139 $models = array();
140 foreach ($modelobjs as $modelobj) {
3a396286
DM
141 $model = new \core_analytics\model($modelobj);
142 if ($model->is_available()) {
143 $models[$modelobj->id] = $model;
144 }
369389c9 145 }
35b10d09
DM
146
147 // Sort the models by the model name using the current session language.
148 \core_collator::asort_objects_by_method($models, 'get_name');
149
369389c9
DM
150 return $models;
151 }
152
153 /**
ed12ba6b 154 * Returns the provided predictions processor class.
369389c9 155 *
ed12ba6b 156 * @param false|string $predictionclass Returns the system default processor if false
369389c9
DM
157 * @param bool $checkisready
158 * @return \core_analytics\predictor
159 */
160 public static function get_predictions_processor($predictionclass = false, $checkisready = true) {
161
162 // We want 0 or 1 so we can use it as an array key for caching.
163 $checkisready = intval($checkisready);
164
ed12ba6b 165 if (!$predictionclass) {
369389c9
DM
166 $predictionclass = get_config('analytics', 'predictionsprocessor');
167 }
168
169 if (empty($predictionclass)) {
170 // Use the default one if nothing set.
ed12ba6b 171 $predictionclass = self::default_mlbackend();
369389c9
DM
172 }
173
174 if (!class_exists($predictionclass)) {
175 throw new \coding_exception('Invalid predictions processor ' . $predictionclass . '.');
176 }
177
178 $interfaces = class_implements($predictionclass);
179 if (empty($interfaces['core_analytics\predictor'])) {
180 throw new \coding_exception($predictionclass . ' should implement \core_analytics\predictor.');
181 }
182
183 // Return it from the cached list.
184 if (!isset(self::$predictionprocessors[$checkisready][$predictionclass])) {
185
186 $instance = new $predictionclass();
187 if ($checkisready) {
188 $isready = $instance->is_ready();
189 if ($isready !== true) {
190 throw new \moodle_exception('errorprocessornotready', 'analytics', '', $isready);
191 }
192 }
193 self::$predictionprocessors[$checkisready][$predictionclass] = $instance;
194 }
195
196 return self::$predictionprocessors[$checkisready][$predictionclass];
197 }
198
1611308b
DM
199 /**
200 * Return all system predictions processors.
201 *
08015e18 202 * @return \core_analytics\predictor[]
1611308b 203 */
369389c9
DM
204 public static function get_all_prediction_processors() {
205
206 $mlbackends = \core_component::get_plugin_list('mlbackend');
207
208 $predictionprocessors = array();
209 foreach ($mlbackends as $mlbackend => $unused) {
206d7aa9 210 $classfullpath = '\mlbackend_' . $mlbackend . '\processor';
369389c9
DM
211 $predictionprocessors[$classfullpath] = self::get_predictions_processor($classfullpath, false);
212 }
213 return $predictionprocessors;
214 }
215
ed12ba6b
DM
216 /**
217 * Returns the name of the provided predictions processor.
218 *
219 * @param \core_analytics\predictor $predictionsprocessor
220 * @return string
221 */
222 public static function get_predictions_processor_name(\core_analytics\predictor $predictionsprocessor) {
223 $component = substr(get_class($predictionsprocessor), 0, strpos(get_class($predictionsprocessor), '\\', 1));
224 return get_string('pluginname', $component);
225 }
226
227 /**
228 * Whether the provided plugin is used by any model.
229 *
230 * @param string $plugin
231 * @return bool
232 */
233 public static function is_mlbackend_used($plugin) {
234 $models = self::get_all_models();
235 foreach ($models as $model) {
236 $processor = $model->get_predictions_processor();
237 $noprefixnamespace = ltrim(get_class($processor), '\\');
238 $processorplugin = substr($noprefixnamespace, 0, strpos($noprefixnamespace, '\\'));
239 if ($processorplugin == $plugin) {
240 return true;
241 }
242 }
243
244 // Default predictions processor.
245 $defaultprocessorclass = get_config('analytics', 'predictionsprocessor');
246 $pluginclass = '\\' . $plugin . '\\processor';
247 if ($pluginclass === $defaultprocessorclass) {
248 return true;
249 }
250
251 return false;
252 }
253
369389c9
DM
254 /**
255 * Get all available time splitting methods.
256 *
1cc2b4ba 257 * @return \core_analytics\local\time_splitting\base[]
369389c9
DM
258 */
259 public static function get_all_time_splittings() {
260 if (self::$alltimesplittings !== null) {
261 return self::$alltimesplittings;
262 }
263
264 $classes = self::get_analytics_classes('time_splitting');
265
266 self::$alltimesplittings = [];
267 foreach ($classes as $fullclassname => $classpath) {
268 $instance = self::get_time_splitting($fullclassname);
269 // We need to check that it is a valid time splitting method, it may be an abstract class.
270 if ($instance) {
271 self::$alltimesplittings[$instance->get_id()] = $instance;
272 }
273 }
274
275 return self::$alltimesplittings;
276 }
277
278 /**
279 * Returns the enabled time splitting methods.
280 *
3576b66b
DM
281 * @deprecated since Moodle 3.7
282 * @todo MDL-65086 This will be deleted in Moodle 4.1
283 * @see \core_analytics\manager::get_time_splitting_methods_for_evaluation
369389c9
DM
284 * @return \core_analytics\local\time_splitting\base[]
285 */
286 public static function get_enabled_time_splitting_methods() {
3576b66b
DM
287 debugging('This function has been deprecated. You can use self::get_time_splitting_methods_for_evaluation if ' .
288 'you want to get the default time splitting methods for evaluation, or you can use self::get_all_time_splittings if ' .
289 'you want to get all the time splitting methods available on this site.');
290 return self::get_time_splitting_methods_for_evaluation();
291 }
292
293 /**
5f1f0ee6 294 * Returns the time-splitting methods for model evaluation.
3576b66b 295 *
5f1f0ee6 296 * @param bool $all Return all the time-splitting methods that can potentially be used for evaluation or the default ones.
3576b66b
DM
297 * @return \core_analytics\local\time_splitting\base[]
298 */
5f1f0ee6 299 public static function get_time_splitting_methods_for_evaluation(bool $all = false) {
369389c9 300
5f1f0ee6
DM
301 if ($all === false) {
302 if ($enabledtimesplittings = get_config('analytics', 'defaulttimesplittingsevaluation')) {
303 $enabledtimesplittings = array_flip(explode(',', $enabledtimesplittings));
304 }
369389c9
DM
305 }
306
307 $timesplittings = self::get_all_time_splittings();
308 foreach ($timesplittings as $key => $timesplitting) {
309
5f1f0ee6 310 if (!$timesplitting->valid_for_evaluation()) {
369389c9
DM
311 unset($timesplittings[$key]);
312 }
5f1f0ee6
DM
313
314 if ($all === false) {
315 // We remove the ones that are not enabled. This also respects the default value (all methods enabled).
316 if (!empty($enabledtimesplittings) && !isset($enabledtimesplittings[$key])) {
317 unset($timesplittings[$key]);
318 }
319 }
369389c9
DM
320 }
321 return $timesplittings;
322 }
323
324 /**
325 * Returns a time splitting method by its classname.
326 *
327 * @param string $fullclassname
328 * @return \core_analytics\local\time_splitting\base|false False if it is not valid.
329 */
330 public static function get_time_splitting($fullclassname) {
331 if (!self::is_valid($fullclassname, '\core_analytics\local\time_splitting\base')) {
332 return false;
333 }
334 return new $fullclassname();
335 }
336
e4453adc
DM
337 /**
338 * Return all targets in the system.
339 *
340 * @return \core_analytics\local\target\base[]
341 */
342 public static function get_all_targets() : array {
343 if (self::$alltargets !== null) {
344 return self::$alltargets;
345 }
346
347 $classes = self::get_analytics_classes('target');
348
349 self::$alltargets = [];
350 foreach ($classes as $fullclassname => $classpath) {
351 $instance = self::get_target($fullclassname);
352 if ($instance) {
353 self::$alltargets[$instance->get_id()] = $instance;
354 }
355 }
356
357 return self::$alltargets;
358 }
369389c9
DM
359 /**
360 * Return all system indicators.
361 *
362 * @return \core_analytics\local\indicator\base[]
363 */
364 public static function get_all_indicators() {
365 if (self::$allindicators !== null) {
366 return self::$allindicators;
367 }
368
369 $classes = self::get_analytics_classes('indicator');
370
371 self::$allindicators = [];
372 foreach ($classes as $fullclassname => $classpath) {
373 $instance = self::get_indicator($fullclassname);
374 if ($instance) {
b0c24929 375 self::$allindicators[$instance->get_id()] = $instance;
369389c9
DM
376 }
377 }
378
379 return self::$allindicators;
380 }
381
1611308b
DM
382 /**
383 * Returns the specified target
384 *
385 * @param mixed $fullclassname
386 * @return \core_analytics\local\target\base|false False if it is not valid
387 */
369389c9
DM
388 public static function get_target($fullclassname) {
389 if (!self::is_valid($fullclassname, 'core_analytics\local\target\base')) {
390 return false;
391 }
392 return new $fullclassname();
393 }
394
395 /**
396 * Returns an instance of the provided indicator.
397 *
398 * @param string $fullclassname
399 * @return \core_analytics\local\indicator\base|false False if it is not valid.
400 */
401 public static function get_indicator($fullclassname) {
402 if (!self::is_valid($fullclassname, 'core_analytics\local\indicator\base')) {
403 return false;
404 }
405 return new $fullclassname();
406 }
407
408 /**
409 * Returns whether a time splitting method is valid or not.
410 *
411 * @param string $fullclassname
1611308b 412 * @param string $baseclass
369389c9
DM
413 * @return bool
414 */
415 public static function is_valid($fullclassname, $baseclass) {
416 if (is_subclass_of($fullclassname, $baseclass)) {
417 if ((new \ReflectionClass($fullclassname))->isInstantiable()) {
418 return true;
419 }
420 }
421 return false;
422 }
423
f67f35f3 424 /**
1611308b 425 * Returns the logstore used for analytics.
f67f35f3 426 *
2db6e981 427 * @return \core\log\sql_reader|false False if no log stores are enabled.
f67f35f3
DM
428 */
429 public static function get_analytics_logstore() {
430 $readers = get_log_manager()->get_readers('core\log\sql_reader');
431 $analyticsstore = get_config('analytics', 'logstore');
85e50ba4
DM
432
433 if (!empty($analyticsstore) && !empty($readers[$analyticsstore])) {
f67f35f3 434 $logstore = $readers[$analyticsstore];
85e50ba4
DM
435 } else if (empty($analyticsstore) && !empty($readers)) {
436 // The first one, it is the same default than in settings.
437 $logstore = reset($readers);
2db6e981 438 } else if (!empty($readers)) {
f67f35f3
DM
439 $logstore = reset($readers);
440 debugging('The selected log store for analytics is not available anymore. Using "' .
441 $logstore->get_name() . '"', DEBUG_DEVELOPER);
442 }
443
2db6e981
DM
444 if (empty($logstore)) {
445 debugging('No system log stores available to use for analytics', DEBUG_DEVELOPER);
446 return false;
447 }
448
f67f35f3
DM
449 if (!$logstore->is_logging()) {
450 debugging('The selected log store for analytics "' . $logstore->get_name() .
451 '" is not logging activity logs', DEBUG_DEVELOPER);
452 }
453
454 return $logstore;
455 }
456
0690a271
DM
457 /**
458 * Returns this analysable calculations during the provided period.
459 *
460 * @param \core_analytics\analysable $analysable
461 * @param int $starttime
462 * @param int $endtime
463 * @param string $samplesorigin The samples origin as sampleid is not unique across models.
464 * @return array
465 */
466 public static function get_indicator_calculations($analysable, $starttime, $endtime, $samplesorigin) {
467 global $DB;
468
469 $params = array('starttime' => $starttime, 'endtime' => $endtime, 'contextid' => $analysable->get_context()->id,
470 'sampleorigin' => $samplesorigin);
471 $calculations = $DB->get_recordset('analytics_indicator_calc', $params, '', 'indicator, sampleid, value');
472
473 $existingcalculations = array();
474 foreach ($calculations as $calculation) {
475 if (empty($existingcalculations[$calculation->indicator])) {
476 $existingcalculations[$calculation->indicator] = array();
477 }
478 $existingcalculations[$calculation->indicator][$calculation->sampleid] = $calculation->value;
479 }
a938e409 480 $calculations->close();
0690a271
DM
481 return $existingcalculations;
482 }
483
1611308b
DM
484 /**
485 * Returns the models with insights at the provided context.
486 *
486e797c
DM
487 * Note that this method is used for display purposes. It filters out models whose insights
488 * are not linked from the reports page.
489 *
1611308b
DM
490 * @param \context $context
491 * @return \core_analytics\model[]
492 */
493 public static function get_models_with_insights(\context $context) {
494
495 self::check_can_list_insights($context);
496
413f19bc 497 $models = self::get_all_models(true, true, $context);
1611308b
DM
498 foreach ($models as $key => $model) {
499 // Check that it not only have predictions but also generates insights from them.
486e797c 500 if (!$model->uses_insights() || !$model->get_target()->link_insights_report()) {
1611308b
DM
501 unset($models[$key]);
502 }
503 }
504 return $models;
505 }
506
507 /**
508 * Returns a prediction
509 *
510 * @param int $predictionid
511 * @param bool $requirelogin
512 * @return array array($model, $prediction, $context)
513 */
514 public static function get_prediction($predictionid, $requirelogin = false) {
515 global $DB;
516
517 if (!$predictionobj = $DB->get_record('analytics_predictions', array('id' => $predictionid))) {
4a210b06
DM
518 throw new \moodle_exception('errorpredictionnotfound', 'analytics');
519 }
520
521 $context = \context::instance_by_id($predictionobj->contextid, IGNORE_MISSING);
522 if (!$context) {
523 throw new \moodle_exception('errorpredictioncontextnotavailable', 'analytics');
1611308b
DM
524 }
525
526 if ($requirelogin) {
527 list($context, $course, $cm) = get_context_info_array($predictionobj->contextid);
528 require_login($course, false, $cm);
1611308b
DM
529 }
530
413f19bc 531 self::check_can_list_insights($context);
1611308b
DM
532
533 $model = new \core_analytics\model($predictionobj->modelid);
534 $sampledata = $model->prediction_sample_data($predictionobj);
535 $prediction = new \core_analytics\prediction($predictionobj, $sampledata);
536
537 return array($model, $prediction, $context);
538 }
539
e709e544 540 /**
3b7c7918 541 * Used to be used to add models included with the Moodle core.
e709e544 542 *
3b7c7918
DM
543 * @deprecated Deprecated since Moodle 3.7 (MDL-61667) - Use lib/db/analytics.php instead.
544 * @todo Remove this method in Moodle 4.1 (MDL-65186).
e709e544
DM
545 * @return void
546 */
547 public static function add_builtin_models() {
548
3b7c7918
DM
549 debugging('core_analytics\manager::add_builtin_models() has been deprecated. Core models are now automatically '.
550 'updated according to their declaration in the lib/db/analytics.php file.', DEBUG_DEVELOPER);
e709e544
DM
551 }
552
f9222c49
DM
553 /**
554 * Cleans up analytics db tables that do not directly depend on analysables that may have been deleted.
555 */
556 public static function cleanup() {
557 global $DB;
558
4fd74fba
DM
559 $DB->execute("DELETE FROM {analytics_prediction_actions} WHERE predictionid IN
560 (SELECT ap.id FROM {analytics_predictions} ap
561 LEFT JOIN {context} ctx ON ap.contextid = ctx.id
562 WHERE ctx.id IS NULL)");
f9222c49 563
4fd74fba
DM
564 $contextsql = "SELECT id FROM {context} ctx";
565 $DB->delete_records_select('analytics_predictions', "contextid NOT IN ($contextsql)");
566 $DB->delete_records_select('analytics_indicator_calc', "contextid NOT IN ($contextsql)");
f9222c49
DM
567
568 // Clean up stuff that depends on analysable ids that do not exist anymore.
500111c5 569
f9222c49
DM
570 $models = self::get_all_models();
571 foreach ($models as $model) {
500111c5
DM
572
573 // We first dump into memory the list of analysables we have in the database (we could probably do this with 1 single
574 // query for the 3 tables, but it may be safer to do it separately).
575 $predictsamplesanalysableids = $DB->get_fieldset_select('analytics_predict_samples', 'DISTINCT analysableid',
576 'modelid = :modelid', ['modelid' => $model->get_id()]);
577 $predictsamplesanalysableids = array_flip($predictsamplesanalysableids);
578 $trainsamplesanalysableids = $DB->get_fieldset_select('analytics_train_samples', 'DISTINCT analysableid',
579 'modelid = :modelid', ['modelid' => $model->get_id()]);
580 $trainsamplesanalysableids = array_flip($trainsamplesanalysableids);
581 $usedanalysablesanalysableids = $DB->get_fieldset_select('analytics_used_analysables', 'DISTINCT analysableid',
582 'modelid = :modelid', ['modelid' => $model->get_id()]);
583 $usedanalysablesanalysableids = array_flip($usedanalysablesanalysableids);
584
f9222c49 585 $analyser = $model->get_analyser(array('notimesplitting' => true));
fccc728f
DM
586 $analysables = $analyser->get_analysables_iterator();
587
588 $analysableids = [];
589 foreach ($analysables as $analysable) {
590 if (!$analysable) {
591 continue;
592 }
500111c5
DM
593 unset($predictsamplesanalysableids[$analysable->get_id()]);
594 unset($trainsamplesanalysableids[$analysable->get_id()]);
595 unset($usedanalysablesanalysableids[$analysable->get_id()]);
f9222c49
DM
596 }
597
500111c5 598 $param = ['modelid' => $model->get_id()];
f9222c49 599
500111c5 600 if ($predictsamplesanalysableids) {
4fd74fba
DM
601 list($idssql, $idsparams) = $DB->get_in_or_equal(array_flip($predictsamplesanalysableids), SQL_PARAMS_NAMED);
602 $DB->delete_records_select('analytics_predict_samples', "modelid = :modelid AND analysableid $idssql",
603 $param + $idsparams);
500111c5
DM
604 }
605 if ($trainsamplesanalysableids) {
4fd74fba
DM
606 list($idssql, $idsparams) = $DB->get_in_or_equal(array_flip($trainsamplesanalysableids), SQL_PARAMS_NAMED);
607 $DB->delete_records_select('analytics_train_samples', "modelid = :modelid AND analysableid $idssql",
608 $param + $idsparams);
500111c5
DM
609 }
610 if ($usedanalysablesanalysableids) {
4fd74fba
DM
611 list($idssql, $idsparams) = $DB->get_in_or_equal(array_flip($usedanalysablesanalysableids), SQL_PARAMS_NAMED);
612 $DB->delete_records_select('analytics_used_analysables', "modelid = :modelid AND analysableid $idssql",
613 $param + $idsparams);
500111c5 614 }
f9222c49
DM
615 }
616 }
617
ed12ba6b
DM
618 /**
619 * Default system backend.
620 *
621 * @return string
622 */
623 public static function default_mlbackend() {
624 return self::DEFAULT_MLBACKEND;
625 }
626
369389c9
DM
627 /**
628 * Returns the provided element classes in the site.
629 *
630 * @param string $element
631 * @return string[] Array keys are the FQCN and the values the class path.
632 */
633 private static function get_analytics_classes($element) {
634
635 // Just in case...
1611308b 636 $element = clean_param($element, PARAM_ALPHANUMEXT);
369389c9 637
0d6a45d2 638 $classes = \core_component::get_component_classes_in_namespace(null, 'analytics\\' . $element);
1cc2b4ba 639
369389c9
DM
640 return $classes;
641 }
f0584045 642
606c3be0
DM
643 /**
644 * Check that all the models declared by the component are up to date.
645 *
646 * This is intended to be called during the installation / upgrade to automatically create missing models.
647 *
648 * @param string $componentname The name of the component to load models for.
649 * @return array \core_analytics\model[] List of actually created models.
650 */
651 public static function update_default_models_for_component(string $componentname): array {
652
653 $result = [];
654
655 foreach (static::load_default_models_for_component($componentname) as $definition) {
656 if (!\core_analytics\model::exists(static::get_target($definition['target']))) {
657 $result[] = static::create_declared_model($definition);
658 }
659 }
660
661 return $result;
662 }
663
f0584045
DM
664 /**
665 * Return the list of models declared by the given component.
666 *
667 * @param string $componentname The name of the component to load models for.
668 * @throws \coding_exception Exception thrown in case of invalid syntax.
669 * @return array The $models description array.
670 */
671 public static function load_default_models_for_component(string $componentname): array {
672
673 $dir = \core_component::get_component_directory($componentname);
674
675 if (!$dir) {
676 // This is either an invalid component, or a core subsystem without its own root directory.
677 return [];
678 }
679
680 $file = $dir . '/' . self::ANALYTICS_FILENAME;
681
682 if (!is_readable($file)) {
683 return [];
684 }
685
686 $models = null;
687 include($file);
688
689 if (!isset($models) || !is_array($models) || empty($models)) {
690 return [];
691 }
692
693 foreach ($models as &$model) {
694 if (!isset($model['enabled'])) {
695 $model['enabled'] = false;
696 } else {
697 $model['enabled'] = clean_param($model['enabled'], PARAM_BOOL);
698 }
699 }
700
701 static::validate_models_declaration($models);
702
703 return $models;
704 }
705
1297fa41
DM
706 /**
707 * Return the list of all the models declared anywhere in this Moodle installation.
708 *
709 * Models defined by the core and core subsystems come first, followed by those provided by plugins.
710 *
711 * @return array indexed by the frankenstyle component
712 */
713 public static function load_default_models_for_all_components(): array {
714
715 $tmp = [];
716
717 foreach (\core_component::get_component_list() as $type => $components) {
718 foreach (array_keys($components) as $component) {
719 if ($loaded = static::load_default_models_for_component($component)) {
720 $tmp[$type][$component] = $loaded;
721 }
722 }
723 }
724
725 $result = [];
726
727 if ($loaded = static::load_default_models_for_component('core')) {
728 $result['core'] = $loaded;
729 }
730
731 if (!empty($tmp['core'])) {
732 $result += $tmp['core'];
733 unset($tmp['core']);
734 }
735
736 foreach ($tmp as $components) {
737 $result += $components;
738 }
739
740 return $result;
741 }
742
f0584045
DM
743 /**
744 * Validate the declaration of prediction models according the syntax expected in the component's db folder.
745 *
746 * The expected structure looks like this:
747 *
748 * [
749 * [
750 * 'target' => '\fully\qualified\name\of\the\target\class',
751 * 'indicators' => [
752 * '\fully\qualified\name\of\the\first\indicator',
753 * '\fully\qualified\name\of\the\second\indicator',
754 * ],
755 * 'timesplitting' => '\optional\name\of\the\time_splitting\class',
756 * 'enabled' => true,
757 * ],
758 * ];
759 *
760 * @param array $models List of declared models.
761 * @throws \coding_exception Exception thrown in case of invalid syntax.
762 */
763 public static function validate_models_declaration(array $models) {
764
765 foreach ($models as $model) {
766 if (!isset($model['target'])) {
767 throw new \coding_exception('Missing target declaration');
768 }
769
770 if (!static::is_valid($model['target'], '\core_analytics\local\target\base')) {
771 throw new \coding_exception('Invalid target classname', $model['target']);
772 }
773
774 if (empty($model['indicators']) || !is_array($model['indicators'])) {
775 throw new \coding_exception('Missing indicators declaration');
776 }
777
778 foreach ($model['indicators'] as $indicator) {
779 if (!static::is_valid($indicator, '\core_analytics\local\indicator\base')) {
780 throw new \coding_exception('Invalid indicator classname', $indicator);
781 }
782 }
783
784 if (isset($model['timesplitting'])) {
785 if (substr($model['timesplitting'], 0, 1) !== '\\') {
786 throw new \coding_exception('Expecting fully qualified time splitting classname', $model['timesplitting']);
787 }
788 if (!static::is_valid($model['timesplitting'], '\core_analytics\local\time_splitting\base')) {
789 throw new \coding_exception('Invalid time splitting classname', $model['timesplitting']);
790 }
791 }
792
793 if (!empty($model['enabled']) && !isset($model['timesplitting'])) {
794 throw new \coding_exception('Cannot enable a model without time splitting method specified');
795 }
796 }
797 }
6187213f
DM
798
799 /**
800 * Create the defined model.
801 *
802 * @param array $definition See {@link self::validate_models_declaration()} for the syntax.
803 * @return \core_analytics\model
804 */
805 public static function create_declared_model(array $definition): \core_analytics\model {
806
7dba0c27 807 list($target, $indicators) = static::get_declared_target_and_indicators_instances($definition);
6187213f
DM
808
809 if (isset($definition['timesplitting'])) {
810 $timesplitting = $definition['timesplitting'];
811 } else {
812 $timesplitting = false;
813 }
814
815 $created = \core_analytics\model::create($target, $indicators, $timesplitting);
816
817 if (!empty($definition['enabled'])) {
818 $created->enable();
819 }
820
821 return $created;
822 }
01d620ee
DM
823
824 /**
825 * Returns a string uniquely representing the given model declaration.
826 *
827 * @param array $model Model declaration
828 * @return string complying with PARAM_ALPHANUM rules and starting with an 'id' prefix
829 */
830 public static function model_declaration_identifier(array $model) : string {
831 return 'id'.sha1(serialize($model));
832 }
7dba0c27
DM
833
834 /**
835 * Given a model definition, return actual target and indicators instances.
836 *
837 * @param array $definition See {@link self::validate_models_declaration()} for the syntax.
838 * @return array [0] => target instance, [1] => array of indicators instances
839 */
840 public static function get_declared_target_and_indicators_instances(array $definition): array {
841
842 $target = static::get_target($definition['target']);
843
844 $indicators = [];
845
846 foreach ($definition['indicators'] as $indicatorname) {
847 $indicator = static::get_indicator($indicatorname);
848 $indicators[$indicator->get_id()] = $indicator;
849 }
850
851 return [$target, $indicators];
852 }
369389c9 853}