MDL-64777 analytics: Add method to load all model definitions
[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
DM
145 }
146 return $models;
147 }
148
149 /**
ed12ba6b 150 * Returns the provided predictions processor class.
369389c9 151 *
ed12ba6b 152 * @param false|string $predictionclass Returns the system default processor if false
369389c9
DM
153 * @param bool $checkisready
154 * @return \core_analytics\predictor
155 */
156 public static function get_predictions_processor($predictionclass = false, $checkisready = true) {
157
158 // We want 0 or 1 so we can use it as an array key for caching.
159 $checkisready = intval($checkisready);
160
ed12ba6b 161 if (!$predictionclass) {
369389c9
DM
162 $predictionclass = get_config('analytics', 'predictionsprocessor');
163 }
164
165 if (empty($predictionclass)) {
166 // Use the default one if nothing set.
ed12ba6b 167 $predictionclass = self::default_mlbackend();
369389c9
DM
168 }
169
170 if (!class_exists($predictionclass)) {
171 throw new \coding_exception('Invalid predictions processor ' . $predictionclass . '.');
172 }
173
174 $interfaces = class_implements($predictionclass);
175 if (empty($interfaces['core_analytics\predictor'])) {
176 throw new \coding_exception($predictionclass . ' should implement \core_analytics\predictor.');
177 }
178
179 // Return it from the cached list.
180 if (!isset(self::$predictionprocessors[$checkisready][$predictionclass])) {
181
182 $instance = new $predictionclass();
183 if ($checkisready) {
184 $isready = $instance->is_ready();
185 if ($isready !== true) {
186 throw new \moodle_exception('errorprocessornotready', 'analytics', '', $isready);
187 }
188 }
189 self::$predictionprocessors[$checkisready][$predictionclass] = $instance;
190 }
191
192 return self::$predictionprocessors[$checkisready][$predictionclass];
193 }
194
1611308b
DM
195 /**
196 * Return all system predictions processors.
197 *
08015e18 198 * @return \core_analytics\predictor[]
1611308b 199 */
369389c9
DM
200 public static function get_all_prediction_processors() {
201
202 $mlbackends = \core_component::get_plugin_list('mlbackend');
203
204 $predictionprocessors = array();
205 foreach ($mlbackends as $mlbackend => $unused) {
206d7aa9 206 $classfullpath = '\mlbackend_' . $mlbackend . '\processor';
369389c9
DM
207 $predictionprocessors[$classfullpath] = self::get_predictions_processor($classfullpath, false);
208 }
209 return $predictionprocessors;
210 }
211
ed12ba6b
DM
212 /**
213 * Returns the name of the provided predictions processor.
214 *
215 * @param \core_analytics\predictor $predictionsprocessor
216 * @return string
217 */
218 public static function get_predictions_processor_name(\core_analytics\predictor $predictionsprocessor) {
219 $component = substr(get_class($predictionsprocessor), 0, strpos(get_class($predictionsprocessor), '\\', 1));
220 return get_string('pluginname', $component);
221 }
222
223 /**
224 * Whether the provided plugin is used by any model.
225 *
226 * @param string $plugin
227 * @return bool
228 */
229 public static function is_mlbackend_used($plugin) {
230 $models = self::get_all_models();
231 foreach ($models as $model) {
232 $processor = $model->get_predictions_processor();
233 $noprefixnamespace = ltrim(get_class($processor), '\\');
234 $processorplugin = substr($noprefixnamespace, 0, strpos($noprefixnamespace, '\\'));
235 if ($processorplugin == $plugin) {
236 return true;
237 }
238 }
239
240 // Default predictions processor.
241 $defaultprocessorclass = get_config('analytics', 'predictionsprocessor');
242 $pluginclass = '\\' . $plugin . '\\processor';
243 if ($pluginclass === $defaultprocessorclass) {
244 return true;
245 }
246
247 return false;
248 }
249
369389c9
DM
250 /**
251 * Get all available time splitting methods.
252 *
1cc2b4ba 253 * @return \core_analytics\local\time_splitting\base[]
369389c9
DM
254 */
255 public static function get_all_time_splittings() {
256 if (self::$alltimesplittings !== null) {
257 return self::$alltimesplittings;
258 }
259
260 $classes = self::get_analytics_classes('time_splitting');
261
262 self::$alltimesplittings = [];
263 foreach ($classes as $fullclassname => $classpath) {
264 $instance = self::get_time_splitting($fullclassname);
265 // We need to check that it is a valid time splitting method, it may be an abstract class.
266 if ($instance) {
267 self::$alltimesplittings[$instance->get_id()] = $instance;
268 }
269 }
270
271 return self::$alltimesplittings;
272 }
273
274 /**
275 * Returns the enabled time splitting methods.
276 *
3576b66b
DM
277 * @deprecated since Moodle 3.7
278 * @todo MDL-65086 This will be deleted in Moodle 4.1
279 * @see \core_analytics\manager::get_time_splitting_methods_for_evaluation
369389c9
DM
280 * @return \core_analytics\local\time_splitting\base[]
281 */
282 public static function get_enabled_time_splitting_methods() {
3576b66b
DM
283 debugging('This function has been deprecated. You can use self::get_time_splitting_methods_for_evaluation if ' .
284 'you want to get the default time splitting methods for evaluation, or you can use self::get_all_time_splittings if ' .
285 'you want to get all the time splitting methods available on this site.');
286 return self::get_time_splitting_methods_for_evaluation();
287 }
288
289 /**
5f1f0ee6 290 * Returns the time-splitting methods for model evaluation.
3576b66b 291 *
5f1f0ee6 292 * @param bool $all Return all the time-splitting methods that can potentially be used for evaluation or the default ones.
3576b66b
DM
293 * @return \core_analytics\local\time_splitting\base[]
294 */
5f1f0ee6 295 public static function get_time_splitting_methods_for_evaluation(bool $all = false) {
369389c9 296
5f1f0ee6
DM
297 if ($all === false) {
298 if ($enabledtimesplittings = get_config('analytics', 'defaulttimesplittingsevaluation')) {
299 $enabledtimesplittings = array_flip(explode(',', $enabledtimesplittings));
300 }
369389c9
DM
301 }
302
303 $timesplittings = self::get_all_time_splittings();
304 foreach ($timesplittings as $key => $timesplitting) {
305
5f1f0ee6 306 if (!$timesplitting->valid_for_evaluation()) {
369389c9
DM
307 unset($timesplittings[$key]);
308 }
5f1f0ee6
DM
309
310 if ($all === false) {
311 // We remove the ones that are not enabled. This also respects the default value (all methods enabled).
312 if (!empty($enabledtimesplittings) && !isset($enabledtimesplittings[$key])) {
313 unset($timesplittings[$key]);
314 }
315 }
369389c9
DM
316 }
317 return $timesplittings;
318 }
319
320 /**
321 * Returns a time splitting method by its classname.
322 *
323 * @param string $fullclassname
324 * @return \core_analytics\local\time_splitting\base|false False if it is not valid.
325 */
326 public static function get_time_splitting($fullclassname) {
327 if (!self::is_valid($fullclassname, '\core_analytics\local\time_splitting\base')) {
328 return false;
329 }
330 return new $fullclassname();
331 }
332
e4453adc
DM
333 /**
334 * Return all targets in the system.
335 *
336 * @return \core_analytics\local\target\base[]
337 */
338 public static function get_all_targets() : array {
339 if (self::$alltargets !== null) {
340 return self::$alltargets;
341 }
342
343 $classes = self::get_analytics_classes('target');
344
345 self::$alltargets = [];
346 foreach ($classes as $fullclassname => $classpath) {
347 $instance = self::get_target($fullclassname);
348 if ($instance) {
349 self::$alltargets[$instance->get_id()] = $instance;
350 }
351 }
352
353 return self::$alltargets;
354 }
369389c9
DM
355 /**
356 * Return all system indicators.
357 *
358 * @return \core_analytics\local\indicator\base[]
359 */
360 public static function get_all_indicators() {
361 if (self::$allindicators !== null) {
362 return self::$allindicators;
363 }
364
365 $classes = self::get_analytics_classes('indicator');
366
367 self::$allindicators = [];
368 foreach ($classes as $fullclassname => $classpath) {
369 $instance = self::get_indicator($fullclassname);
370 if ($instance) {
b0c24929 371 self::$allindicators[$instance->get_id()] = $instance;
369389c9
DM
372 }
373 }
374
375 return self::$allindicators;
376 }
377
1611308b
DM
378 /**
379 * Returns the specified target
380 *
381 * @param mixed $fullclassname
382 * @return \core_analytics\local\target\base|false False if it is not valid
383 */
369389c9
DM
384 public static function get_target($fullclassname) {
385 if (!self::is_valid($fullclassname, 'core_analytics\local\target\base')) {
386 return false;
387 }
388 return new $fullclassname();
389 }
390
391 /**
392 * Returns an instance of the provided indicator.
393 *
394 * @param string $fullclassname
395 * @return \core_analytics\local\indicator\base|false False if it is not valid.
396 */
397 public static function get_indicator($fullclassname) {
398 if (!self::is_valid($fullclassname, 'core_analytics\local\indicator\base')) {
399 return false;
400 }
401 return new $fullclassname();
402 }
403
404 /**
405 * Returns whether a time splitting method is valid or not.
406 *
407 * @param string $fullclassname
1611308b 408 * @param string $baseclass
369389c9
DM
409 * @return bool
410 */
411 public static function is_valid($fullclassname, $baseclass) {
412 if (is_subclass_of($fullclassname, $baseclass)) {
413 if ((new \ReflectionClass($fullclassname))->isInstantiable()) {
414 return true;
415 }
416 }
417 return false;
418 }
419
f67f35f3 420 /**
1611308b 421 * Returns the logstore used for analytics.
f67f35f3 422 *
2db6e981 423 * @return \core\log\sql_reader|false False if no log stores are enabled.
f67f35f3
DM
424 */
425 public static function get_analytics_logstore() {
426 $readers = get_log_manager()->get_readers('core\log\sql_reader');
427 $analyticsstore = get_config('analytics', 'logstore');
85e50ba4
DM
428
429 if (!empty($analyticsstore) && !empty($readers[$analyticsstore])) {
f67f35f3 430 $logstore = $readers[$analyticsstore];
85e50ba4
DM
431 } else if (empty($analyticsstore) && !empty($readers)) {
432 // The first one, it is the same default than in settings.
433 $logstore = reset($readers);
2db6e981 434 } else if (!empty($readers)) {
f67f35f3
DM
435 $logstore = reset($readers);
436 debugging('The selected log store for analytics is not available anymore. Using "' .
437 $logstore->get_name() . '"', DEBUG_DEVELOPER);
438 }
439
2db6e981
DM
440 if (empty($logstore)) {
441 debugging('No system log stores available to use for analytics', DEBUG_DEVELOPER);
442 return false;
443 }
444
f67f35f3
DM
445 if (!$logstore->is_logging()) {
446 debugging('The selected log store for analytics "' . $logstore->get_name() .
447 '" is not logging activity logs', DEBUG_DEVELOPER);
448 }
449
450 return $logstore;
451 }
452
0690a271
DM
453 /**
454 * Returns this analysable calculations during the provided period.
455 *
456 * @param \core_analytics\analysable $analysable
457 * @param int $starttime
458 * @param int $endtime
459 * @param string $samplesorigin The samples origin as sampleid is not unique across models.
460 * @return array
461 */
462 public static function get_indicator_calculations($analysable, $starttime, $endtime, $samplesorigin) {
463 global $DB;
464
465 $params = array('starttime' => $starttime, 'endtime' => $endtime, 'contextid' => $analysable->get_context()->id,
466 'sampleorigin' => $samplesorigin);
467 $calculations = $DB->get_recordset('analytics_indicator_calc', $params, '', 'indicator, sampleid, value');
468
469 $existingcalculations = array();
470 foreach ($calculations as $calculation) {
471 if (empty($existingcalculations[$calculation->indicator])) {
472 $existingcalculations[$calculation->indicator] = array();
473 }
474 $existingcalculations[$calculation->indicator][$calculation->sampleid] = $calculation->value;
475 }
a938e409 476 $calculations->close();
0690a271
DM
477 return $existingcalculations;
478 }
479
1611308b
DM
480 /**
481 * Returns the models with insights at the provided context.
482 *
483 * @param \context $context
484 * @return \core_analytics\model[]
485 */
486 public static function get_models_with_insights(\context $context) {
487
488 self::check_can_list_insights($context);
489
413f19bc 490 $models = self::get_all_models(true, true, $context);
1611308b
DM
491 foreach ($models as $key => $model) {
492 // Check that it not only have predictions but also generates insights from them.
493 if (!$model->uses_insights()) {
494 unset($models[$key]);
495 }
496 }
497 return $models;
498 }
499
500 /**
501 * Returns a prediction
502 *
503 * @param int $predictionid
504 * @param bool $requirelogin
505 * @return array array($model, $prediction, $context)
506 */
507 public static function get_prediction($predictionid, $requirelogin = false) {
508 global $DB;
509
510 if (!$predictionobj = $DB->get_record('analytics_predictions', array('id' => $predictionid))) {
4a210b06
DM
511 throw new \moodle_exception('errorpredictionnotfound', 'analytics');
512 }
513
514 $context = \context::instance_by_id($predictionobj->contextid, IGNORE_MISSING);
515 if (!$context) {
516 throw new \moodle_exception('errorpredictioncontextnotavailable', 'analytics');
1611308b
DM
517 }
518
519 if ($requirelogin) {
520 list($context, $course, $cm) = get_context_info_array($predictionobj->contextid);
521 require_login($course, false, $cm);
1611308b
DM
522 }
523
413f19bc 524 self::check_can_list_insights($context);
1611308b
DM
525
526 $model = new \core_analytics\model($predictionobj->modelid);
527 $sampledata = $model->prediction_sample_data($predictionobj);
528 $prediction = new \core_analytics\prediction($predictionobj, $sampledata);
529
530 return array($model, $prediction, $context);
531 }
532
e709e544 533 /**
3b7c7918 534 * Used to be used to add models included with the Moodle core.
e709e544 535 *
3b7c7918
DM
536 * @deprecated Deprecated since Moodle 3.7 (MDL-61667) - Use lib/db/analytics.php instead.
537 * @todo Remove this method in Moodle 4.1 (MDL-65186).
e709e544
DM
538 * @return void
539 */
540 public static function add_builtin_models() {
541
3b7c7918
DM
542 debugging('core_analytics\manager::add_builtin_models() has been deprecated. Core models are now automatically '.
543 'updated according to their declaration in the lib/db/analytics.php file.', DEBUG_DEVELOPER);
e709e544
DM
544 }
545
f9222c49
DM
546 /**
547 * Cleans up analytics db tables that do not directly depend on analysables that may have been deleted.
548 */
549 public static function cleanup() {
550 global $DB;
551
552 // Clean up stuff that depends on contexts that do not exist anymore.
553 $sql = "SELECT DISTINCT ap.contextid FROM {analytics_predictions} ap
554 LEFT JOIN {context} ctx ON ap.contextid = ctx.id
555 WHERE ctx.id IS NULL";
556 $apcontexts = $DB->get_records_sql($sql);
557
558 $sql = "SELECT DISTINCT aic.contextid FROM {analytics_indicator_calc} aic
559 LEFT JOIN {context} ctx ON aic.contextid = ctx.id
560 WHERE ctx.id IS NULL";
561 $indcalccontexts = $DB->get_records_sql($sql);
562
563 $contexts = $apcontexts + $indcalccontexts;
564 if ($contexts) {
565 list($sql, $params) = $DB->get_in_or_equal(array_keys($contexts));
e08c74f5 566 $DB->execute("DELETE FROM {analytics_prediction_actions} WHERE predictionid IN
f9222c49
DM
567 (SELECT ap.id FROM {analytics_predictions} ap WHERE ap.contextid $sql)", $params);
568
569 $DB->delete_records_select('analytics_predictions', "contextid $sql", $params);
570 $DB->delete_records_select('analytics_indicator_calc', "contextid $sql", $params);
571 }
572
573 // Clean up stuff that depends on analysable ids that do not exist anymore.
574 $models = self::get_all_models();
575 foreach ($models as $model) {
576 $analyser = $model->get_analyser(array('notimesplitting' => true));
fccc728f
DM
577 $analysables = $analyser->get_analysables_iterator();
578
579 $analysableids = [];
580 foreach ($analysables as $analysable) {
581 if (!$analysable) {
582 continue;
583 }
584 $analysableids[] = $analysable->get_id();
585 }
586 if (empty($analysableids)) {
f9222c49
DM
587 continue;
588 }
589
f9222c49
DM
590 list($notinsql, $params) = $DB->get_in_or_equal($analysableids, SQL_PARAMS_NAMED, 'param', false);
591 $params['modelid'] = $model->get_id();
592
593 $DB->delete_records_select('analytics_predict_samples', "modelid = :modelid AND analysableid $notinsql", $params);
594 $DB->delete_records_select('analytics_train_samples', "modelid = :modelid AND analysableid $notinsql", $params);
595 }
596 }
597
ed12ba6b
DM
598 /**
599 * Default system backend.
600 *
601 * @return string
602 */
603 public static function default_mlbackend() {
604 return self::DEFAULT_MLBACKEND;
605 }
606
369389c9
DM
607 /**
608 * Returns the provided element classes in the site.
609 *
610 * @param string $element
611 * @return string[] Array keys are the FQCN and the values the class path.
612 */
613 private static function get_analytics_classes($element) {
614
615 // Just in case...
1611308b 616 $element = clean_param($element, PARAM_ALPHANUMEXT);
369389c9 617
0d6a45d2 618 $classes = \core_component::get_component_classes_in_namespace(null, 'analytics\\' . $element);
1cc2b4ba 619
369389c9
DM
620 return $classes;
621 }
f0584045 622
606c3be0
DM
623 /**
624 * Check that all the models declared by the component are up to date.
625 *
626 * This is intended to be called during the installation / upgrade to automatically create missing models.
627 *
628 * @param string $componentname The name of the component to load models for.
629 * @return array \core_analytics\model[] List of actually created models.
630 */
631 public static function update_default_models_for_component(string $componentname): array {
632
633 $result = [];
634
635 foreach (static::load_default_models_for_component($componentname) as $definition) {
636 if (!\core_analytics\model::exists(static::get_target($definition['target']))) {
637 $result[] = static::create_declared_model($definition);
638 }
639 }
640
641 return $result;
642 }
643
f0584045
DM
644 /**
645 * Return the list of models declared by the given component.
646 *
647 * @param string $componentname The name of the component to load models for.
648 * @throws \coding_exception Exception thrown in case of invalid syntax.
649 * @return array The $models description array.
650 */
651 public static function load_default_models_for_component(string $componentname): array {
652
653 $dir = \core_component::get_component_directory($componentname);
654
655 if (!$dir) {
656 // This is either an invalid component, or a core subsystem without its own root directory.
657 return [];
658 }
659
660 $file = $dir . '/' . self::ANALYTICS_FILENAME;
661
662 if (!is_readable($file)) {
663 return [];
664 }
665
666 $models = null;
667 include($file);
668
669 if (!isset($models) || !is_array($models) || empty($models)) {
670 return [];
671 }
672
673 foreach ($models as &$model) {
674 if (!isset($model['enabled'])) {
675 $model['enabled'] = false;
676 } else {
677 $model['enabled'] = clean_param($model['enabled'], PARAM_BOOL);
678 }
679 }
680
681 static::validate_models_declaration($models);
682
683 return $models;
684 }
685
1297fa41
DM
686 /**
687 * Return the list of all the models declared anywhere in this Moodle installation.
688 *
689 * Models defined by the core and core subsystems come first, followed by those provided by plugins.
690 *
691 * @return array indexed by the frankenstyle component
692 */
693 public static function load_default_models_for_all_components(): array {
694
695 $tmp = [];
696
697 foreach (\core_component::get_component_list() as $type => $components) {
698 foreach (array_keys($components) as $component) {
699 if ($loaded = static::load_default_models_for_component($component)) {
700 $tmp[$type][$component] = $loaded;
701 }
702 }
703 }
704
705 $result = [];
706
707 if ($loaded = static::load_default_models_for_component('core')) {
708 $result['core'] = $loaded;
709 }
710
711 if (!empty($tmp['core'])) {
712 $result += $tmp['core'];
713 unset($tmp['core']);
714 }
715
716 foreach ($tmp as $components) {
717 $result += $components;
718 }
719
720 return $result;
721 }
722
f0584045
DM
723 /**
724 * Validate the declaration of prediction models according the syntax expected in the component's db folder.
725 *
726 * The expected structure looks like this:
727 *
728 * [
729 * [
730 * 'target' => '\fully\qualified\name\of\the\target\class',
731 * 'indicators' => [
732 * '\fully\qualified\name\of\the\first\indicator',
733 * '\fully\qualified\name\of\the\second\indicator',
734 * ],
735 * 'timesplitting' => '\optional\name\of\the\time_splitting\class',
736 * 'enabled' => true,
737 * ],
738 * ];
739 *
740 * @param array $models List of declared models.
741 * @throws \coding_exception Exception thrown in case of invalid syntax.
742 */
743 public static function validate_models_declaration(array $models) {
744
745 foreach ($models as $model) {
746 if (!isset($model['target'])) {
747 throw new \coding_exception('Missing target declaration');
748 }
749
750 if (!static::is_valid($model['target'], '\core_analytics\local\target\base')) {
751 throw new \coding_exception('Invalid target classname', $model['target']);
752 }
753
754 if (empty($model['indicators']) || !is_array($model['indicators'])) {
755 throw new \coding_exception('Missing indicators declaration');
756 }
757
758 foreach ($model['indicators'] as $indicator) {
759 if (!static::is_valid($indicator, '\core_analytics\local\indicator\base')) {
760 throw new \coding_exception('Invalid indicator classname', $indicator);
761 }
762 }
763
764 if (isset($model['timesplitting'])) {
765 if (substr($model['timesplitting'], 0, 1) !== '\\') {
766 throw new \coding_exception('Expecting fully qualified time splitting classname', $model['timesplitting']);
767 }
768 if (!static::is_valid($model['timesplitting'], '\core_analytics\local\time_splitting\base')) {
769 throw new \coding_exception('Invalid time splitting classname', $model['timesplitting']);
770 }
771 }
772
773 if (!empty($model['enabled']) && !isset($model['timesplitting'])) {
774 throw new \coding_exception('Cannot enable a model without time splitting method specified');
775 }
776 }
777 }
6187213f
DM
778
779 /**
780 * Create the defined model.
781 *
782 * @param array $definition See {@link self::validate_models_declaration()} for the syntax.
783 * @return \core_analytics\model
784 */
785 public static function create_declared_model(array $definition): \core_analytics\model {
786
787 $target = static::get_target($definition['target']);
788
789 $indicators = [];
790
791 foreach ($definition['indicators'] as $indicatorname) {
792 $indicator = static::get_indicator($indicatorname);
793 $indicators[$indicator->get_id()] = $indicator;
794 }
795
796 if (isset($definition['timesplitting'])) {
797 $timesplitting = $definition['timesplitting'];
798 } else {
799 $timesplitting = false;
800 }
801
802 $created = \core_analytics\model::create($target, $indicators, $timesplitting);
803
804 if (!empty($definition['enabled'])) {
805 $created->enable();
806 }
807
808 return $created;
809 }
01d620ee
DM
810
811 /**
812 * Returns a string uniquely representing the given model declaration.
813 *
814 * @param array $model Model declaration
815 * @return string complying with PARAM_ALPHANUM rules and starting with an 'id' prefix
816 */
817 public static function model_declaration_identifier(array $model) : string {
818 return 'id'.sha1(serialize($model));
819 }
369389c9 820}