098c4966f9fa0ecf4d27a9e3a2e445541020b40d
[moodle.git] / lib / ajax / ajaxlib.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/>.
18 /**
19  * Library functions to facilitate the use of ajax JavaScript in Moodle.
20  *
21  * @package   core
22  * @copyright 2009 Tim Hunt
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 /**
27  * You need to call this function if you wish to use the set_user_preference method in javascript_static.php, to white-list the
28  * preference you want to update from JavaScript, and to specify the type of cleaning you expect to be done on values.
29  *
30  * @package  core
31  * @category preference
32  * @param    string          $name      the name of the user_perference we should allow to be updated by remote calls.
33  * @param    integer         $paramtype one of the PARAM_{TYPE} constants, user to clean submitted values before set_user_preference is called.
34  * @return   null
35  */
36 function user_preference_allow_ajax_update($name, $paramtype) {
37     global $USER, $PAGE;
39     // Make sure that the required JavaScript libraries are loaded.
40     $PAGE->requires->yui2_lib('connection');
42     // Record in the session that this user_preference is allowed to updated remotely.
43     $USER->ajax_updatable_user_prefs[$name] = $paramtype;
44 }
46 /**
47  * Returns whether ajax is enabled/allowed or not.
48  * @param array $browsers optional list of alowed browsers, empty means use default list
49  * @return bool
50  */
51 function ajaxenabled(array $browsers = null) {
52     global $CFG, $USER;
54     if (!empty($browsers)) {
55         $valid = false;
56         foreach ($browsers as $brand => $version) {
57             if (check_browser_version($brand, $version)) {
58                 $valid = true;
59             }
60         }
62         if (!$valid) {
63             return false;
64         }
65     }
67     $ie = check_browser_version('MSIE', 6.0);
68     $ff = check_browser_version('Gecko', 20051106);
69     $op = check_browser_version('Opera', 9.0);
70     $sa = check_browser_version('Safari', 412);
71     $ch = check_browser_version('Chrome', 6);
73     if (!$ie && !$ff && !$op && !$sa && !$ch) {
74         /** @see http://en.wikipedia.org/wiki/User_agent */
75         // Gecko build 20051107 is what is in Firefox 1.5.
76         // We still have issues with AJAX in other browsers.
77         return false;
78     }
80     if (!empty($CFG->enableajax) && (!empty($USER->ajax) || !isloggedin())) {
81         return true;
82     } else {
83         return false;
84     }
85 }