f7029bb767f5216a916b2373a12046a3840fe784
[moodle.git] / analytics / classes / insights_generator.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  * Insights generator.
19  *
20  * @package   core_analytics
21  * @copyright 2019 David Monllao {@link http://www.davidmonllao.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_analytics;
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/lib/messagelib.php');
31 /**
32  * Insights generator.
33  *
34  * @package   core_analytics
35  * @copyright 2019 David Monllao {@link http://www.davidmonllao.com}
36  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class insights_generator {
40     /**
41      * @var int
42      */
43     private $modelid;
45     /**
46      * @var \core_analytics\local\target\base
47      */
48     private $target;
50     /**
51      * @var int[]
52      */
53     private $contextcourseids;
55     /**
56      * Constructor.
57      *
58      * @param int $modelid
59      * @param \core_analytics\local\target\base $target
60      */
61     public function __construct(int $modelid, \core_analytics\local\target\base $target) {
62         $this->modelid = $modelid;
63         $this->target = $target;
64     }
66     /**
67      * Generates insight notifications.
68      *
69      * @param array                         $samplecontexts    The contexts these predictions belong to
70      * @param \core_analytics\prediction[]  $predictions       The prediction records
71      * @return  null
72      */
73     public function generate($samplecontexts, $predictions) {
74         global $OUTPUT;
76         $analyserclass = $this->target->get_analyser_class();
78         if ($analyserclass::one_sample_per_analysable()) {
79             foreach ($predictions as $prediction) {
81                 $context = $samplecontexts[$prediction->get_prediction_data()->contextid];
82                 list($insighturl, $fullmessage, $fullmessagehtml) = $this->prediction_info($prediction);
83                 $this->notifications($context, $insighturl, $fullmessage, $fullmessagehtml);
84             }
86         } else {
87             foreach ($samplecontexts as $context) {
89                 $insighturl = $this->target->get_insight_context_url($this->modelid, $context);
90                 $fullmessage = get_string('insightinfomessage', 'analytics', $insighturl->out(false));
92                 $fullmessagehtml = $OUTPUT->render_from_template('core_analytics/insight_info_message',
93                     ['url' => $insighturl->out(false)]);
94                 $this->notifications($context, $insighturl, $fullmessage, $fullmessagehtml);
95             }
96         }
97     }
99     /**
100      * Generates a insight notification for the user.
101      *
102      * @param  \context    $context
103      * @param  \moodle_url $insighturl    The insight URL
104      * @param  string      $fullmessage
105      * @param  string      $fullmessagehtml
106      * @return null
107      */
108     private function notifications(\context $context, \moodle_url $insighturl, string $fullmessage, string $fullmessagehtml) {
109         $users = $this->target->get_insights_users($context);
110         foreach ($users as $user) {
112             $subject = $this->target->get_insight_subject($this->modelid, $context);
114             $message = new \core\message\message();
115             $message->component = 'moodle';
116             $message->name = 'insights';
118             $message->userfrom = \core_user::get_noreply_user();
119             $message->userto = $user;
121             $message->subject = $subject;
123             // Same than the subject.
124             $message->contexturlname = $message->subject;
125             $message->courseid = $this->get_context_courseid($context);
127             $message->fullmessage = $fullmessage;
128             $message->fullmessageformat = FORMAT_PLAIN;
129             $message->fullmessagehtml = $fullmessagehtml;
130             $message->smallmessage = $fullmessage;
131             $message->contexturl = $insighturl->out(false);
133             message_send($message);
134         }
135     }
137     /**
138      * Returns the course context of the provided context reading an internal cache first.
139      *
140      * @param  \context $context
141      * @return int
142      */
143     private function get_context_courseid(\context $context) {
145         if (empty($this->contextcourseids[$context->id])) {
147             $coursecontext = $context->get_course_context(false);
148             if (!$coursecontext) {
149                 // Default to the frontpage course context.
150                 $coursecontext = \context_course::instance(SITEID);
151             }
152             $this->contextcourseids[$context->id] = $coursecontext->instanceid;
153         }
155         return $this->contextcourseids[$context->id];
156     }
158     /**
159      * Extracts info from the prediction for display purposes.
160      *
161      * @param  \core_analytics\prediction $prediction
162      * @return array Three items array with formats [\moodle_url, string, string]
163      */
164     private function prediction_info(\core_analytics\prediction $prediction) {
165         global $OUTPUT;
167         $predictionactions = $this->target->prediction_actions($prediction, true, true);
169         // For FORMAT_PLAIN.
170         $fullmessageplaintext  = '';
172         // For FORMAT_HTML.
173         $messageactions  = [];
174         $insighturl = null;
175         foreach ($predictionactions as $action) {
176             $actionurl = $action->get_url();
177             if (!$actionurl->get_param('forwardurl')) {
179                 $actiondoneurl = new \moodle_url('/report/insights/done.php');
180                 // Set the forward url to the 'done' script.
181                 $actionurl->param('forwardurl', $actiondoneurl->out(false));
182             }
184             if (empty($insighturl)) {
185                 // We use the primary action url as insight url so we log that the user followed the provided link.
186                 $insighturl = $action->get_url();
187             }
188             $actiondata = (object)['url' => $action->get_url()->out(false), 'text' => $action->get_text()];
189             $fullmessageplaintext .= get_string('insightinfomessageaction', 'analytics', $actiondata) . PHP_EOL;
190             $messageactions[] = $actiondata;
191         }
193         $fullmessagehtml = $OUTPUT->render_from_template('core_analytics/insight_info_message_prediction',
194             ['actions' => $messageactions]);
195         return [$insighturl, $fullmessageplaintext, $fullmessagehtml];
196     }