| 1 |
efrain |
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/>.
|
|
|
16 |
|
|
|
17 |
/**
|
|
|
18 |
* Flatfile CLI tool.
|
|
|
19 |
*
|
|
|
20 |
* Notes:
|
|
|
21 |
* - it is required to use the web server account when executing PHP CLI scripts
|
|
|
22 |
* - you need to change the "www-data" to match the apache user account
|
|
|
23 |
* - use "su" if "sudo" not available
|
|
|
24 |
*
|
|
|
25 |
* Update
|
|
|
26 |
*
|
|
|
27 |
* This plugin now has a enrolment sync scheduled task. Scheduled tasks were
|
|
|
28 |
* introduced in Moodle 2.7. It is possible to override the scheduled tasks
|
|
|
29 |
* configuration and run a single scheduled task immediately using the
|
|
|
30 |
* admin/cli/scheduled_task.php script. This is the recommended
|
|
|
31 |
* method to use for immediate enrollment synchronisation.
|
|
|
32 |
*
|
|
|
33 |
* Usage help:
|
|
|
34 |
* $ php admin/cli/scheduled_task.php -h
|
|
|
35 |
*
|
|
|
36 |
* Execute task:
|
|
|
37 |
* $ sudo -u www-data /usr/bin/php admin/cli/scheduled_task.php /
|
|
|
38 |
* --execute=\\enrol_flatfile\\task\\flatfile_sync_task
|
|
|
39 |
*
|
|
|
40 |
* @package enrol_flatfile
|
|
|
41 |
* @copyright 2012 Petr Skoda {@link http://skodak.org}
|
|
|
42 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
43 |
*/
|
|
|
44 |
|
|
|
45 |
define('CLI_SCRIPT', true);
|
|
|
46 |
|
|
|
47 |
require(__DIR__.'/../../../config.php');
|
|
|
48 |
require_once("$CFG->libdir/clilib.php");
|
|
|
49 |
|
|
|
50 |
// Now get cli options.
|
|
|
51 |
list($options, $unrecognized) = cli_get_params(array('verbose'=>false, 'help'=>false), array('v'=>'verbose', 'h'=>'help'));
|
|
|
52 |
|
|
|
53 |
if ($unrecognized) {
|
|
|
54 |
$unrecognized = implode("\n ", $unrecognized);
|
|
|
55 |
cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
|
|
|
56 |
}
|
|
|
57 |
|
|
|
58 |
if ($options['help']) {
|
|
|
59 |
$help =
|
|
|
60 |
"Process flat file enrolments, update expiration and send notifications.
|
|
|
61 |
|
|
|
62 |
Options:
|
|
|
63 |
-v, --verbose Print verbose progress information
|
|
|
64 |
-h, --help Print out this help
|
|
|
65 |
|
|
|
66 |
Example:
|
|
|
67 |
\$ sudo -u www-data /usr/bin/php enrol/flatfile/cli/sync.php
|
|
|
68 |
";
|
|
|
69 |
|
|
|
70 |
echo $help;
|
|
|
71 |
die;
|
|
|
72 |
}
|
|
|
73 |
|
|
|
74 |
if (!enrol_is_enabled('flatfile')) {
|
|
|
75 |
cli_error('enrol_flatfile plugin is disabled, synchronisation stopped', 2);
|
|
|
76 |
}
|
|
|
77 |
|
|
|
78 |
/** @var $plugin enrol_flatfile_plugin */
|
|
|
79 |
$plugin = enrol_get_plugin('flatfile');
|
|
|
80 |
|
|
|
81 |
if (empty($options['verbose'])) {
|
|
|
82 |
$trace = new null_progress_trace();
|
|
|
83 |
} else {
|
|
|
84 |
$trace = new text_progress_trace();
|
|
|
85 |
}
|
|
|
86 |
|
|
|
87 |
$result = $plugin->sync($trace);
|
|
|
88 |
|
|
|
89 |
exit($result);
|