MDL-55980 Scheduled tasks: Run individual scheduled tasks from web
[moodle.git] / lib / sessionlib.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  * @package    core
19  * @subpackage session
20  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
21  * @copyright  2008, 2009 Petr Skoda  {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Makes sure that $USER->sesskey exists, if $USER itself exists. It sets a new sesskey
30  * if one does not already exist, but does not overwrite existing sesskeys. Returns the
31  * sesskey string if $USER exists, or boolean false if not.
32  *
33  * @uses $USER
34  * @return string
35  */
36 function sesskey() {
37     // note: do not use $USER because it may not be initialised yet
38     if (empty($_SESSION['USER']->sesskey)) {
39         if (!isset($_SESSION['USER'])) {
40             // This should never happen,
41             // do not mess with session and globals here,
42             // let any checks fail instead!
43             return false;
44         }
45         $_SESSION['USER']->sesskey = random_string(10);
46     }
48     return $_SESSION['USER']->sesskey;
49 }
52 /**
53  * Check the sesskey and return true of false for whether it is valid.
54  * (You might like to imagine this function is called sesskey_is_valid().)
55  *
56  * Every script that lets the user perform a significant action (that is,
57  * changes data in the database) should check the sesskey before doing the action.
58  * Depending on your code flow, you may want to use the {@link require_sesskey()}
59  * helper function.
60  *
61  * @param string $sesskey The sesskey value to check (optional). Normally leave this blank
62  *      and this function will do required_param('sesskey', ...).
63  * @return bool whether the sesskey sent in the request matches the one stored in the session.
64  */
65 function confirm_sesskey($sesskey=NULL) {
66     global $USER;
68     if (!empty($USER->ignoresesskey)) {
69         return true;
70     }
72     if (empty($sesskey)) {
73         $sesskey = required_param('sesskey', PARAM_RAW);  // Check script parameters
74     }
76     return (sesskey() === $sesskey);
77 }
79 /**
80  * Check the session key using {@link confirm_sesskey()},
81  * and cause a fatal error if it does not match.
82  */
83 function require_sesskey() {
84     if (!confirm_sesskey()) {
85         print_error('invalidsesskey');
86     }
87 }
89 /**
90  * Determine wether the secure flag should be set on cookies
91  * @return bool
92  */
93 function is_moodle_cookie_secure() {
94     global $CFG;
96     if (!isset($CFG->cookiesecure)) {
97         return false;
98     }
99     if (!empty($CFG->loginhttps)) {
100         return false;
101     }
102     if (!is_https() and empty($CFG->sslproxy)) {
103         return false;
104     }
105     return !empty($CFG->cookiesecure);
108 /**
109  * Sets a moodle cookie with a weakly encrypted username
110  *
111  * @param string $username to encrypt and place in a cookie, '' means delete current cookie
112  * @return void
113  */
114 function set_moodle_cookie($username) {
115     global $CFG;
117     if (NO_MOODLE_COOKIES) {
118         return;
119     }
121     if (empty($CFG->rememberusername)) {
122         // erase current and do not store permanent cookies
123         $username = '';
124     }
126     if ($username === 'guest') {
127         // keep previous cookie in case of guest account login
128         return;
129     }
131     $cookiename = 'MOODLEID1_'.$CFG->sessioncookie;
133     $cookiesecure = is_moodle_cookie_secure();
135     // Delete old cookie.
136     setcookie($cookiename, '', time() - HOURSECS, $CFG->sessioncookiepath, $CFG->sessioncookiedomain, $cookiesecure, $CFG->cookiehttponly);
138     if ($username !== '') {
139         // Set username cookie for 60 days.
140         setcookie($cookiename, rc4encrypt($username), time() + (DAYSECS * 60), $CFG->sessioncookiepath, $CFG->sessioncookiedomain, $cookiesecure, $CFG->cookiehttponly);
141     }
144 /**
145  * Gets a moodle cookie with a weakly encrypted username
146  *
147  * @return string username
148  */
149 function get_moodle_cookie() {
150     global $CFG;
152     if (NO_MOODLE_COOKIES) {
153         return '';
154     }
156     if (empty($CFG->rememberusername)) {
157         return '';
158     }
160     $cookiename = 'MOODLEID1_'.$CFG->sessioncookie;
162     if (empty($_COOKIE[$cookiename])) {
163         return '';
164     } else {
165         $username = rc4decrypt($_COOKIE[$cookiename]);
166         if ($username === 'guest' or $username === 'nobody') {
167             // backwards compatibility - we do not set these cookies any more
168             $username = '';
169         }
170         return $username;
171     }
174 /**
175  * Sets up current user and course environment (lang, etc.) in cron.
176  * Do not use outside of cron script!
177  *
178  * @param stdClass $user full user object, null means default cron user (admin),
179  *                 value 'reset' means reset internal static caches.
180  * @param stdClass $course full course record, null means $SITE
181  * @param bool $leavepagealone If specified, stops it messing with global page object
182  * @return void
183  */
184 function cron_setup_user($user = null, $course = null, $leavepagealone = false) {
185     global $CFG, $SITE, $PAGE;
187     if (!CLI_SCRIPT && !$leavepagealone) {
188         throw new coding_exception('Function cron_setup_user() cannot be used in normal requests!');
189     }
191     static $cronuser    = NULL;
192     static $cronsession = NULL;
194     if ($user === 'reset') {
195         $cronuser = null;
196         $cronsession = null;
197         \core\session\manager::init_empty_session();
198         return;
199     }
201     if (empty($cronuser)) {
202         /// ignore admins timezone, language and locale - use site default instead!
203         $cronuser = get_admin();
204         $cronuser->timezone = $CFG->timezone;
205         $cronuser->lang     = '';
206         $cronuser->theme    = '';
207         unset($cronuser->description);
209         $cronsession = new stdClass();
210     }
212     if (!$user) {
213         // Cached default cron user (==modified admin for now).
214         \core\session\manager::init_empty_session();
215         \core\session\manager::set_user($cronuser);
216         $GLOBALS['SESSION'] = $cronsession;
218     } else {
219         // Emulate real user session - needed for caps in cron.
220         if ($GLOBALS['USER']->id != $user->id) {
221             \core\session\manager::init_empty_session();
222             \core\session\manager::set_user($user);
223         }
224     }
226     // TODO MDL-19774 relying on global $PAGE in cron is a bad idea.
227     // Temporary hack so that cron does not give fatal errors.
228     if (!$leavepagealone) {
229         $PAGE = new moodle_page();
230         if ($course) {
231             $PAGE->set_course($course);
232         } else {
233             $PAGE->set_course($SITE);
234         }
235     }
237     // TODO: it should be possible to improve perf by caching some limited number of users here ;-)