MDL-64739 analytics: Contexts autocomplete with ajax
[moodle.git] / admin / tool / analytics / model.php
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/>.
17 /**
18  * Model-related actions.
19  *
20  * @package    tool_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  */
25 require_once(__DIR__ . '/../../../config.php');
26 require_once($CFG->libdir . '/filelib.php');
28 $id = required_param('id', PARAM_INT);
29 $action = required_param('action', PARAM_ALPHANUMEXT);
31 require_login();
33 $model = new \core_analytics\model($id);
34 \core_analytics\manager::check_can_manage_models();
36 if (!\core_analytics\manager::is_analytics_enabled()) {
37     $PAGE->set_context(\context_system::instance());
38     $renderer = $PAGE->get_renderer('tool_analytics');
39     echo $renderer->render_analytics_disabled();
40     exit(0);
41 }
43 $returnurl = new \moodle_url('/admin/tool/analytics/index.php');
44 $params = array('id' => $id, 'action' => $action);
45 $url = new \moodle_url('/admin/tool/analytics/model.php', $params);
47 switch ($action) {
49     case 'edit':
50         $title = get_string('editmodel', 'tool_analytics', $model->get_name());
51         break;
52     case 'evaluate':
53         $title = get_string('evaluatemodel', 'tool_analytics');
54         break;
55     case 'scheduledanalysis':
56         $title = get_string('analysis', 'tool_analytics');
57         break;
58     case 'log':
59         $title = get_string('viewlog', 'tool_analytics');
60         break;
61     case 'enable':
62         $title = get_string('enable');
63         break;
64     case 'disable':
65         $title = get_string('disable');
66         break;
67     case 'delete':
68         $title = get_string('delete');
69         break;
70     case 'exportdata':
71         $title = get_string('exporttrainingdata', 'tool_analytics');
72         break;
73     case 'exportmodel':
74         $title = get_string('exportmodel', 'tool_analytics');
75         break;
76     case 'clear':
77         $title = get_string('clearpredictions', 'tool_analytics');
78         break;
79     case 'insightsreport':
80         $title = get_string('insightsreport', 'tool_analytics');
81         break;
82     case 'invalidanalysables':
83         $title = get_string('invalidanalysables', 'tool_analytics');
84         break;
85     default:
86         throw new moodle_exception('errorunknownaction', 'analytics');
87 }
89 \tool_analytics\output\helper::set_navbar($title, $url);
91 $onlycli = get_config('analytics', 'onlycli');
92 if ($onlycli === false) {
93     // Default applied if no config found.
94     $onlycli = 1;
95 }
97 switch ($action) {
99     case 'enable':
100         confirm_sesskey();
102         $model->enable();
103         redirect($returnurl);
104         break;
106     case 'disable':
107         confirm_sesskey();
109         $model->update(0, false, false);
110         redirect($returnurl);
111         break;
113     case 'delete':
114         confirm_sesskey();
116         $model->delete();
117         redirect($returnurl);
118         break;
120     case 'edit':
121         confirm_sesskey();
123         $invalidcurrenttimesplitting = $model->invalid_timesplitting_selected();
124         $potentialtimesplittings = $model->get_potential_timesplittings();
125         $analyser = $model->get_analyser();
127         $customdata = array(
128             'id' => $model->get_id(),
129             'trainedmodel' => $model->is_trained(),
130             'staticmodel' => $model->is_static(),
131             'invalidcurrenttimesplitting' => (!empty($invalidcurrenttimesplitting)),
132             'targetclass' => $model->get_target()->get_id(),
133             'targetname' => $model->get_target()->get_name(),
134             'indicators' => $model->get_potential_indicators(),
135             'timesplittings' => $potentialtimesplittings,
136             'predictionprocessors' => \core_analytics\manager::get_all_prediction_processors(),
137             'supportscontexts' => ($analyser)::context_restriction_support(),
138             'contexts' => $model->get_contexts(),
139         );
140         $mform = new \tool_analytics\output\form\edit_model(null, $customdata);
142         if ($mform->is_cancelled()) {
143             redirect($returnurl);
145         } else if ($data = $mform->get_data()) {
147             $timesplitting = \tool_analytics\output\helper::option_to_class($data->timesplitting);
149             if (!$model->is_static()) {
150                 // Converting option names to class names.
151                 $indicators = array();
152                 foreach ($data->indicators as $indicator) {
153                     $indicatorclass = \tool_analytics\output\helper::option_to_class($indicator);
154                     $indicators[] = \core_analytics\manager::get_indicator($indicatorclass);
155                 }
156                 $predictionsprocessor = \tool_analytics\output\helper::option_to_class($data->predictionsprocessor);
157             } else {
158                 // These fields can not be modified.
159                 $indicators = false;
160                 $predictionsprocessor = false;
161             }
163             $model->update($data->enabled, $indicators, $timesplitting, $predictionsprocessor, $data->contexts);
164             redirect($returnurl);
165         }
167         echo $OUTPUT->header();
169         $modelobj = $model->get_model_obj();
171         $callable = array('\tool_analytics\output\helper', 'class_to_option');
172         $modelobj->indicators = array_map($callable, json_decode($modelobj->indicators));
173         $modelobj->timesplitting = \tool_analytics\output\helper::class_to_option($modelobj->timesplitting);
174         if ($modelobj->contextids) {
175             $modelobj->contexts = array_map($callable, json_decode($modelobj->contextids));
176         }
177         $modelobj->predictionsprocessor = \tool_analytics\output\helper::class_to_option($modelobj->predictionsprocessor);
178         $mform->set_data($modelobj);
179         $mform->display();
180         break;
182     case 'evaluate':
183         confirm_sesskey();
185         if ($model->is_static()) {
186             throw new moodle_exception('errornostaticevaluate', 'tool_analytics');
187         }
189         if ($onlycli) {
190             throw new moodle_exception('erroronlycli', 'tool_analytics');
191         }
193         // Web interface is used by people who can not use CLI nor code stuff, always use
194         // cached stuff as they will change the model through the web interface as well
195         // which invalidates the previously analysed stuff.
196         $options = ['reuseprevanalysed' => true];
198         $mode = optional_param('mode', false, PARAM_ALPHANUM);
199         if ($mode == 'trainedmodel') {
200             $options['mode'] = 'trainedmodel';
201         } else {
203             // All is the default in core_analytics\model::evaluate() as well.
204             $timesplitting = optional_param('timesplitting', 'all', PARAM_ALPHANUMEXT);
205             if ($timesplitting === 'current') {
206                 $options['timesplitting'] = \core_analytics\manager::get_time_splitting($model->get_model_obj()->timesplitting);
207             } else if ($timesplitting !== 'all') {
208                 $options['timesplitting'] = \core_analytics\manager::get_time_splitting(
209                     \tool_analytics\output\helper::option_to_class($timesplitting)
210                 );
211             }
212         }
214         $results = $model->evaluate($options);
216         // We reset the theme and the output as some indicators may be using external functions
217         // which reset $PAGE.
218         \tool_analytics\output\helper::reset_page();
219         echo $OUTPUT->header();
221         $renderer = $PAGE->get_renderer('tool_analytics');
222         echo $renderer->render_evaluate_results($results, $model->get_analyser()->get_logs());
223         break;
225     case 'scheduledanalysis':
226         confirm_sesskey();
228         if ($onlycli) {
229             throw new moodle_exception('erroronlycli', 'tool_analytics');
230         }
232         $trainresults = $model->train();
233         $trainlogs = $model->get_analyser()->get_logs();
235         // Looks dumb to get a new instance but better be conservative.
236         $model = new \core_analytics\model($model->get_model_obj());
237         if ($model->is_trained()) {
238             $predictresults = $model->predict();
239             $predictlogs = $model->get_analyser()->get_logs();
240         } else {
241             $predictresults = false;
242             $predictlogs = array();
243         }
245         // We reset the theme and the output as some indicators may be using external functions
246         // which reset $PAGE.
247         \tool_analytics\output\helper::reset_page();
248         echo $OUTPUT->header();
250         $renderer = $PAGE->get_renderer('tool_analytics');
251         echo $renderer->render_get_predictions_results($trainresults, $trainlogs, $predictresults, $predictlogs);
252         break;
254     case 'log':
255         echo $OUTPUT->header();
257         if ($model->is_static()) {
258             throw new moodle_exception('errornostaticlog', 'tool_analytics');
259         }
261         $renderer = $PAGE->get_renderer('tool_analytics');
262         $modellogstable = new \tool_analytics\output\model_logs('model-' . $model->get_id(), $model);
263         echo $renderer->render_table($modellogstable);
264         break;
266     case 'exportdata':
268         if ($model->is_static() || !$model->is_trained()) {
269             throw new moodle_exception('errornoexport', 'tool_analytics');
270         }
272         $file = $model->get_training_data();
273         if (!$file) {
274             redirect($returnurl, get_string('errortrainingdataexport', 'tool_analytics'),
275                 null, \core\output\notification::NOTIFY_ERROR);
276         }
278         $filename = 'training-data.' . $model->get_id() . '.' . time() . '.csv';
279         send_file($file, $filename, null, 0, false, true);
280         break;
282     case 'exportmodel':
284         $includeweights = optional_param('includeweights', 1, PARAM_INT);
286         $zipfilename = 'model-' . $model->get_unique_id() . '-' . microtime(false) . '.zip';
287         $zipfilepath = $model->export_model($zipfilename, $includeweights);
288         send_temp_file($zipfilepath, $zipfilename);
289         break;
291     case 'clear':
292         confirm_sesskey();
294         $model->clear();
295         redirect($returnurl);
296         break;
298     case 'insightsreport':
300         $contextid = optional_param('contextid', null, PARAM_INT);
302         echo $OUTPUT->header();
304         $renderable = new \tool_analytics\output\insights_report($model, $contextid);
305         $renderer = $PAGE->get_renderer('tool_analytics');
306         echo $renderer->render($renderable);
308         break;
310     case 'invalidanalysables':
312         echo $OUTPUT->header();
314         $page = optional_param('page', 0, PARAM_INT);
315         // No option in the UI to change this, only for url hackers ;).
316         $perpage = optional_param('perpage', 10, PARAM_INT);
318         $renderable = new \tool_analytics\output\invalid_analysables($model, $page, $perpage);
319         $renderer = $PAGE->get_renderer('tool_analytics');
320         echo $renderer->render($renderable);
322         break;
325 echo $OUTPUT->footer();