b1340388490bfda99a3f2f1e61c158abac4ec4cb
[moodle.git] / admin / registration / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
21 //// SITE PRIVACY /////
23 /**
24  * Site privacy: private
25  */
26 define('HUB_SITENOTPUBLISHED', 'notdisplayed');
28 /**
29  * Site privacy: public
30  */
31 define('HUB_SITENAMEPUBLISHED', 'named');
33 /**
34  * Site privacy: public and global
35  */
36 define('HUB_SITELINKPUBLISHED', 'linked');
38 /**
39  *
40  * Site registration library
41  *
42  * @package   course
43  * @copyright 2010 Moodle Pty Ltd (http://moodle.com)
44  * @author    Jerome Mouneyrac
45  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
46  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47  */
48 class registration_manager {
50     /**
51      * Automatically update the registration on all hubs
52      */
53     public function cron() {
54         global $CFG;
55         if (extension_loaded('xmlrpc')) {
56             //check if the last registration cron update was less than a week ago
57             $lastcron = get_config('registration', 'crontime');
58             if ($lastcron === false or $lastcron < strtotime("-7 day")) { //set to a week, see MDL-23704
59                 $function = 'hub_update_site_info';
60                 require_once($CFG->dirroot . "/webservice/xmlrpc/lib.php");
62                 //update all hub where the site is registered on
63                 $hubs = $this->get_registered_on_hubs();
64                 foreach ($hubs as $hub) {
65                     //update the registration
66                     $siteinfo = $this->get_site_info($hub->huburl);
67                     $params = array('siteinfo' => $siteinfo);
68                     $serverurl = $hub->huburl . "/local/hub/webservice/webservices.php";
69                     $xmlrpcclient = new webservice_xmlrpc_client($serverurl, $hub->token);
70                     try {
71                         $result = $xmlrpcclient->call($function, $params);
72                         mtrace(get_string('siteupdatedcron', 'hub', $hub->hubname));
73                     } catch (Exception $e) {
74                         $errorparam = new stdClass();
75                         $errorparam->errormessage = $e->getMessage();
76                         $errorparam->hubname = $hub->hubname;
77                         mtrace(get_string('errorcron', 'hub', $errorparam));
78                     }
79                 }
80                 set_config('crontime', time(), 'registration');
81             }
82         } else {
83             mtrace(get_string('errorcronnoxmlrpc', 'hub'));
84         }
85     }
87     /**
88      * When the site register on a hub, he must call this function
89      * @param object $hub where the site is registered on
90      * @return integer id of the record
91      */
92     public function add_registeredhub($hub) {
93         global $DB;
94         $id = $DB->insert_record('registration_hubs', $hub);
95         return $id;
96     }
98     /**
99      * When a site unregister from a hub, he must call this function
100      * @param string $huburl the huburl to delete
101      */
102     public function delete_registeredhub($huburl) {
103         global $DB;
104         $DB->delete_records('registration_hubs', array('huburl' => $huburl));
105     }
107     /**
108      * Get a hub on which the site is registered for a given url or token
109      * Mostly use to check if the site is registered on a specific hub
110      * @param string $huburl
111      * @param string $token
112      * @return object the  hub
113      */
114     public function get_registeredhub($huburl = null, $token = null) {
115         global $DB;
117         $params = array();
118         if (!empty($huburl)) {
119             $params['huburl'] = $huburl;
120         }
121         if (!empty($token)) {
122             $params['token'] = $token;
123         }
124         $params['confirmed'] = 1;
125         $token = $DB->get_record('registration_hubs', $params);
126         return $token;
127     }
129     /**
130      * Get the hub which has not confirmed that the site is registered on,
131      * but for which a request has been sent
132      * @param string $huburl
133      * @return object the  hub
134      */
135     public function get_unconfirmedhub($huburl) {
136         global $DB;
138         $params = array();
139         $params['huburl'] = $huburl;
140         $params['confirmed'] = 0;
141         $token = $DB->get_record('registration_hubs', $params);
142         return $token;
143     }
145     /**
146      * Update a registered hub (mostly use to update the confirmation status)
147      * @param object $communication the hub
148      */
149     public function update_registeredhub($communication) {
150         global $DB;
151         $DB->update_record('registration_hubs', $communication);
152     }
154     /**
155      * Return all hubs where the site is registered on
156      */
157     public function get_registered_on_hubs() {
158         global $DB;
159         $hubs = $DB->get_records('registration_hubs', array('confirmed' => 1));
160         return $hubs;
161     }
163     /**
164      * Return site information for a specific hub
165      * @param string $huburl
166      * @return array site info
167      */
168     public function get_site_info($huburl) {
169         global $CFG, $DB;
171         $siteinfo = array();
172         $cleanhuburl = clean_param($huburl, PARAM_ALPHANUMEXT);
173         $siteinfo['name'] = get_config('hub', 'site_name_' . $cleanhuburl);
174         $siteinfo['description'] = get_config('hub', 'site_description_' . $cleanhuburl);
175         $siteinfo['contactname'] = get_config('hub', 'site_contactname_' . $cleanhuburl);
176         $siteinfo['contactemail'] = get_config('hub', 'site_contactemail_' . $cleanhuburl);
177         $siteinfo['contactphone'] = get_config('hub', 'site_contactphone_' . $cleanhuburl);
178         $siteinfo['imageurl'] = get_config('hub', 'site_imageurl_' . $cleanhuburl);
179         $siteinfo['privacy'] = get_config('hub', 'site_privacy_' . $cleanhuburl);
180         $siteinfo['street'] = get_config('hub', 'site_address_' . $cleanhuburl);
181         $siteinfo['regioncode'] = get_config('hub', 'site_region_' . $cleanhuburl);
182         $siteinfo['countrycode'] = get_config('hub', 'site_country_' . $cleanhuburl);
183         $siteinfo['geolocation'] = get_config('hub', 'site_geolocation_' . $cleanhuburl);
184         $siteinfo['contactable'] = get_config('hub', 'site_contactable_' . $cleanhuburl);
185         $siteinfo['emailalert'] = get_config('hub', 'site_emailalert_' . $cleanhuburl);
186         if (get_config('hub', 'site_coursesnumber_' . $cleanhuburl) == -1) {
187             $coursecount = -1;
188         } else {
189             $coursecount = $DB->count_records('course') - 1;
190         }
191         $siteinfo['courses'] = $coursecount;
192         if (get_config('hub', 'site_usersnumber_' . $cleanhuburl) == -1) {
193             $usercount = -1;
194         } else {
195             $usercount = $DB->count_records('user', array('deleted' => 0));
196         }
197         $siteinfo['users'] = $usercount;
199         if (get_config('hub', 'site_roleassignmentsnumber_' . $cleanhuburl) == -1) {
200             $roleassigncount = -1;
201         } else {
202             $roleassigncount = $DB->count_records('role_assignments');
203         }
204         $siteinfo['enrolments'] = $roleassigncount;
205         if (get_config('hub', 'site_postsnumber_' . $cleanhuburl) == -1) {
206             $postcount = -1;
207         } else {
208             $postcount = $DB->count_records('forum_posts');
209         }
210         $siteinfo['posts'] = $postcount;
211         if (get_config('hub', 'site_questionsnumber_' . $cleanhuburl) == -1) {
212             $questioncount = -1;
213         } else {
214             $questioncount = $DB->count_records('question');
215         }
216         $siteinfo['questions'] = $questioncount;
217         if (get_config('hub', 'site_resourcesnumber_' . $cleanhuburl) == -1) {
218             $resourcecount = -1;
219         } else {
220             $resourcecount = $DB->count_records('resource');
221         }
222         $siteinfo['resources'] = $resourcecount;
223         //TODO
224         require_once($CFG->dirroot . "/course/lib.php");
225         if (get_config('hub', 'site_participantnumberaverage_' . $cleanhuburl) == -1) {
226             $participantnumberaverage = -1;
227         } else {
228             $participantnumberaverage = average_number_of_participants();
229         }
230         $siteinfo['participantnumberaverage'] = $participantnumberaverage;
231         if (get_config('hub', 'site_modulenumberaverage_' . $cleanhuburl) == -1) {
232             $modulenumberaverage = -1;
233         } else {
234             $modulenumberaverage = average_number_of_courses_modules();
235         }
236         $siteinfo['modulenumberaverage'] = $modulenumberaverage;
237         $siteinfo['language'] = current_language();
238         $siteinfo['moodleversion'] = $CFG->version;
239         $siteinfo['moodlerelease'] = $CFG->release;
240         $siteinfo['url'] = $CFG->wwwroot;
242         return $siteinfo;
243     }
245     /**
246      * Retrieve the site privacy string matching the define value
247      * @param string $privacy must match the define into moodlelib.php
248      * @return string
249      */
250     public function get_site_privacy_string($privacy) {
251         switch ($privacy) {
252             case HUB_SITENOTPUBLISHED:
253                 $privacystring = get_string('siteprivacynotpublished', 'hub');
254                 break;
255             case HUB_SITENAMEPUBLISHED:
256                 $privacystring = get_string('siteprivacypublished', 'hub');
257                 break;
258             case HUB_SITELINKPUBLISHED:
259                 $privacystring = get_string('siteprivacylinked', 'hub');
260                 break;
261         }
262         if (empty($privacystring)) {
263             throw new moodle_exception('unknownprivacy');
264         }
265         return $privacystring;
266     }
269 ?>