Merge branch 'MDL-65081-master' of git://github.com/junpataleta/moodle
[moodle.git] / admin / tool / mobile / lib.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  * Lib functions, mostly callbacks.
19  *
20  * @package    tool_mobile
21  * @copyright  2017 Juan Leyva
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * Callback to add head elements.
29  *
30  * @return str valid html head content
31  * @since  Moodle 3.3
32  */
33 function tool_mobile_before_standard_html_head() {
34     global $CFG, $PAGE;
35     $output = '';
36     // Smart App Banners meta tag is only displayed if mobile services are enabled and configured.
37     if (!empty($CFG->enablemobilewebservice)) {
38         $mobilesettings = get_config('tool_mobile');
39         if (!empty($mobilesettings->enablesmartappbanners)) {
40             if (!empty($mobilesettings->iosappid)) {
41                 $output .= '<meta name="apple-itunes-app" content="app-id=' . s($mobilesettings->iosappid) . ', ';
42                 $output .= 'app-argument=' . $PAGE->url->out() . '"/>';
43             }
45             if (!empty($mobilesettings->androidappid)) {
46                 $mobilemanifesturl = "$CFG->wwwroot/$CFG->admin/tool/mobile/mobile.webmanifest.php";
47                 $output .= '<link rel="manifest" href="'.$mobilemanifesturl.'" />';
48             }
49         }
50     }
51     return $output;
52 }
54 /**
55  * Generate the app download url to promote moodle mobile.
56  *
57  * @return moodle_url|void App download moodle_url object or return if setuplink is not set.
58  */
59 function tool_mobile_create_app_download_url() {
60     global $CFG;
62     $mobilesettings = get_config('tool_mobile');
64     if (empty($mobilesettings->setuplink)) {
65         return;
66     }
68     $downloadurl = new moodle_url($mobilesettings->setuplink);
70     // Do not update the URL if it is a custom one (we may break it completely).
71     if ($mobilesettings->setuplink != 'https://download.moodle.org/mobile') {
72         return $downloadurl;
73     }
75     $downloadurl->param('version', $CFG->version);
76     $downloadurl->param('lang', current_language());
78     if (!empty($mobilesettings->iosappid)) {
79         $downloadurl->param('iosappid', $mobilesettings->iosappid);
80     }
82     if (!empty($mobilesettings->androidappid)) {
83         $downloadurl->param('androidappid', $mobilesettings->androidappid);
84     }
86     return $downloadurl;
87 }
89 /**
90  * Checks if the given user has a mobile token (has used recently the app).
91  *
92  * @param  int $userid the user to check
93  * @return bool        true if the user has a token, false otherwise.
94  */
95 function tool_mobile_user_has_token($userid) {
96     global $DB;
98     $sql = "SELECT 1
99               FROM {external_tokens} t, {external_services} s
100              WHERE t.externalserviceid = s.id
101                AND s.enabled = 1
102                AND s.shortname IN ('moodle_mobile_app', 'local_mobile')
103                AND t.userid = ?";
105     return $DB->record_exists_sql($sql, [$userid]);
108 /**
109  * User profile page callback.
110  *
111  * Used add a section about the moodle mobile app.
112  *
113  * @param \core_user\output\myprofile\tree $tree My profile tree where the setting will be added.
114  * @param stdClass $user The user object.
115  * @param bool $iscurrentuser Is this the current user viewing
116  * @return void Return if the mobile web services setting is disabled or if not the current user.
117  */
118 function tool_mobile_myprofile_navigation(\core_user\output\myprofile\tree $tree, $user, $iscurrentuser) {
119     global $CFG;
121     if (empty($CFG->enablemobilewebservice)) {
122         return;
123     }
125     if (!$iscurrentuser) {
126         return;
127     }
129     if (!$url = tool_mobile_create_app_download_url()) {
130         return;
131     }
133     $userhastoken = tool_mobile_user_has_token($user->id);
135     $mobilecategory = new core_user\output\myprofile\category('mobile', get_string('mobileapp', 'tool_mobile'),
136             'loginactivity');
137     $tree->add_category($mobilecategory);
139     if ($userhastoken) {
140         $mobilestr = get_string('mobileappconnected', 'tool_mobile');
141     } else {
142         $mobilestr = get_string('mobileappenabled', 'tool_mobile', $url->out());
143     }
145     $node = new  core_user\output\myprofile\node('mobile', 'mobileappnode', $mobilestr, null);
146     $tree->add_node($node);
149 /**
150  * Callback to add footer elements.
151  *
152  * @return str valid html footer content
153  * @since  Moodle 3.4
154  */
155 function tool_mobile_standard_footer_html() {
156     global $CFG;
157     $output = '';
158     if (!empty($CFG->enablemobilewebservice) && $url = tool_mobile_create_app_download_url()) {
159         $output .= html_writer::link($url, get_string('getmoodleonyourmobile', 'tool_mobile'));
160     }
161     return $output;
164 /**
165  * Callback to be able to change a message/notification data per processor.
166  *
167  * @param  str $procname    processor name
168  * @param  stdClass $data   message or notification data
169  */
170 function tool_mobile_pre_processor_message_send($procname, $data) {
171     global $CFG;
173     if (empty($CFG->enablemobilewebservice)) {
174         return;
175     }
177     if (empty($data->userto)) {
178         return;
179     }
181     // Only hack email.
182     if ($procname == 'email') {
184         // Send a message only when there is an HTML version of the email, mobile services are enabled,
185         // the user receiving the message has not used the app and there is an app download URL set.
186         if (empty($data->fullmessagehtml)) {
187             return;
188         }
190         if (!$url = tool_mobile_create_app_download_url()) {
191             return;
192         }
194         $userto = is_object($data->userto) ? $data->userto->id : $data->userto;
195         if (tool_mobile_user_has_token($userto)) {
196             return;
197         }
199         $data->fullmessagehtml .= html_writer::tag('p', get_string('readingthisemailgettheapp', 'tool_mobile', $url->out()));
200     }