MDL-65081 core_output: Unit tests for single_select and url_select
[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);
69     $downloadurl->param('version', $CFG->version);
70     $downloadurl->param('lang', current_language());
72     if (!empty($mobilesettings->iosappid)) {
73         $downloadurl->param('iosappid', $mobilesettings->iosappid);
74     }
76     if (!empty($mobilesettings->androidappid)) {
77         $downloadurl->param('androidappid', $mobilesettings->androidappid);
78     }
80     return $downloadurl;
81 }
83 /**
84  * User profile page callback.
85  *
86  * Used add a section about the moodle mobile app.
87  *
88  * @param \core_user\output\myprofile\tree $tree My profile tree where the setting will be added.
89  * @param stdClass $user The user object.
90  * @param bool $iscurrentuser Is this the current user viewing
91  * @return void Return if the mobile web services setting is disabled or if not the current user.
92  */
93 function tool_mobile_myprofile_navigation(\core_user\output\myprofile\tree $tree, $user, $iscurrentuser) {
94     global $CFG, $DB;
96     if (empty($CFG->enablemobilewebservice)) {
97         return;
98     }
100     if (!$iscurrentuser) {
101         return;
102     }
104     if (!$url = tool_mobile_create_app_download_url()) {
105         return;
106     }
108     $sql = "SELECT 1
109               FROM {external_tokens} t, {external_services} s
110              WHERE t.externalserviceid = s.id
111                AND s.enabled = 1
112                AND s.shortname IN ('moodle_mobile_app', 'local_mobile')
113                AND t.userid = ?";
114     $userhastoken = $DB->record_exists_sql($sql, [$user->id]);
116     $mobilecategory = new core_user\output\myprofile\category('mobile', get_string('mobileapp', 'tool_mobile'),
117             'loginactivity');
118     $tree->add_category($mobilecategory);
120     if ($userhastoken) {
121         $mobilestr = get_string('mobileappconnected', 'tool_mobile');
122     } else {
123         $mobilestr = get_string('mobileappenabled', 'tool_mobile', $url->out());
124     }
126     $node = new  core_user\output\myprofile\node('mobile', 'mobileappnode', $mobilestr, null);
127     $tree->add_node($node);
130 /**
131  * Callback to add footer elements.
132  *
133  * @return str valid html footer content
134  * @since  Moodle 3.4
135  */
136 function tool_mobile_standard_footer_html() {
137     global $CFG;
138     $output = '';
139     if (!empty($CFG->enablemobilewebservice) && $url = tool_mobile_create_app_download_url()) {
140         $output .= html_writer::link($url, get_string('getmoodleonyourmobile', 'tool_mobile'));
141     }
142     return $output;