Merged branch 'MDL-26777-wip' of git://github.com/mouneyrac/moodle.git

lang/en/webservice.php

@@ -117,6 +117,7 @@ $string['missingcaps'] = 'Missing capabilities';
 $string['missingcaps_help'] = 'List of required capabilities for the service which the selected user does not have. Missing capabilities must be added to the user\'s role in order to use the service.';
 $string['missingpassword'] = 'Missing password';
 $string['missingusername'] = 'Missing username';
+$string['missingversionfile'] = 'Coding error: version.php file is missing for the component {$a}';
 $string['nofunctions'] = 'This service has no functions.';
 $string['norequiredcapability'] = 'No required capability';
 $string['notoken'] = 'The token list is empty.';

lib/db/services.php

@@ -228,6 +228,16 @@ $functions = array(
         'capabilities'=> 'moodle/notes:manage',
     ),
 
+    // === webservice related functions ===
+
+    'moodle_webservice_get_siteinfo' => array(
+        'classname'   => 'moodle_webservice_external',
+        'methodname'  => 'get_siteinfo',
+        'classpath'   => 'webservice/externallib.php',
+        'description' => 'Return some site info / user info / list web service functions',
+        'type'        => 'read',
+    ),
+
 );
 
 $services = array(

webservice/externallib.php

@@ -0,0 +1,136 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * external API for mobile web services
+ *
+ * @package    core
+ * @subpackage webservice
+ * @copyright  2011 Moodle Pty Ltd (http://moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+class moodle_webservice_external extends external_api {
+
+    public static function get_siteinfo_parameters() {
+        return new external_function_parameters(
+            array('serviceshortnames' => new external_multiple_structure (
+                new external_value(
+                    PARAM_ALPHANUMEXT,
+                    'service shortname'),
+                    'service shortnames - by default, if the list is empty and mobile web services are enabled,
+                    we return the mobile service functions',
+                    VALUE_DEFAULT,
+                    array()
+                ),
+            )
+        );
+    }
+
+    /**
+     * Return user information including profile picture + basic site information
+     * Note:
+     * - no capability checking because we return just known information by logged user
+     * @param array $serviceshortnames of service shortnames - the functions of these services will be returned
+     * @return array
+     */
+    function get_siteinfo($serviceshortnames = array()) {
+        global $USER, $SITE, $CFG;
+
+        $params = self::validate_parameters(self::get_siteinfo_parameters(),
+                      array('serviceshortnames'=>$serviceshortnames));
+
+        $profileimageurl = moodle_url::make_pluginfile_url(
+                get_context_instance(CONTEXT_USER, $USER->id)->id, 'user', 'icon', NULL, '/', 'f1');
+
+        require_once($CFG->dirroot . "/webservice/lib.php");
+        $webservice = new webservice();
+
+        //If no service listed always return the mobile one by default
+        if (empty($params['serviceshortnames']) and $CFG->enablewebservices) {
+           $mobileservice = $webservice->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE);
+           if ($mobileservice->enabled) {
+               $params['serviceshortnames'] = array(MOODLE_OFFICIAL_MOBILE_SERVICE); //return mobile service by default
+           }
+        }
+
+        //retrieve the functions related to the services
+        $functions = $webservice->get_external_functions_by_enabled_services($params['serviceshortnames']);
+
+        //built up the returned values of the list of functions
+        $componentversions = array();
+        $avalaiblefunctions = array();
+        foreach ($functions as $function) {
+            $functioninfo = array();
+            $functioninfo['name'] = $function->name;
+            if ($function->component == 'moodle') {
+                $version = $CFG->version; //moodle version
+            } else {
+                $versionpath = get_component_directory($function->component).'/version.php';
+                if (is_readable($versionpath)) {
+                    //we store the component version once retrieved (so we don't load twice the version.php)
+                    if (!isset($componentversions[$function->component])) {
+                        include($versionpath);
+                        $componentversions[$function->component] = $plugin->version;
+                        $version = $plugin->version;
+                    } else {
+                        $version = $componentversions[$function->component];
+                    }
+                } else {
+                    //function component should always have a version.php,
+                    //otherwise the function should have been described with component => 'moodle'
+                    throw new moodle_exception('missingversionfile', 'webservice', '', $function->component);
+                }
+            }
+            $functioninfo['version'] = $version;
+            $avalaiblefunctions[] = $functioninfo;
+        }
+
+        return array(
+            'sitename' => $SITE->fullname,
+            'siteurl' => $CFG->wwwroot,
+            'username' => $USER->username,
+            'firstname' => $USER->firstname,
+            'lastname' => $USER->lastname,
+            'fullname' => fullname($USER),
+            'userid' => $USER->id,
+            'userpictureurl' => $profileimageurl->out(false),
+            'functions' => $avalaiblefunctions
+        );
+    }
+
+    public static function get_siteinfo_returns() {
+        return new external_single_structure(
+            array(
+                'sitename'       => new external_value(PARAM_RAW, 'site name'),
+                'username'       => new external_value(PARAM_RAW, 'username'),
+                'firstname'      => new external_value(PARAM_TEXT, 'first name'),
+                'lastname'       => new external_value(PARAM_TEXT, 'last name'),
+                'fullname'       => new external_value(PARAM_TEXT, 'user full name'),
+                'userid'         => new external_value(PARAM_INT, 'user id'),
+                'siteurl'        => new external_value(PARAM_RAW, 'site url'),
+                'userpictureurl' => new external_value(PARAM_URL, 'the user profile picture'),
+                'functions'      => new external_multiple_structure(
+                    new external_single_structure(
+                        array(
+                            'name' => new external_value(PARAM_RAW, 'function name'),
+                            'version' => new external_value(PARAM_FLOAT, 'The version number of moodle site/local plugin linked to the function')
+                        ), 'functions that are available')
+                    ),
+            )
+        );
+    }
+}

webservice/lib.php

@@ -271,6 +271,31 @@ class webservice {
         return $functions;
     }
 
+    /**
+     * Get the list of all functions for given service shortnames
+     * @param array $serviceshortnames
+     * @param $enabledonly if true then only return function for the service that has been enabled
+     * @return array functions
+     */
+    public function get_external_functions_by_enabled_services($serviceshortnames, $enabledonly = true) {
+        global $DB;
+        if (!empty($serviceshortnames)) {
+            $enabledonlysql = $enabledonly?' AND s.enabled = 1 ':'';
+            list($serviceshortnames, $params) = $DB->get_in_or_equal($serviceshortnames);
+            $sql = "SELECT f.*
+                      FROM {external_functions} f
+                     WHERE f.name IN (SELECT sf.functionname
+                                        FROM {external_services_functions} sf, {external_services} s
+                                       WHERE s.shortname $serviceshortnames
+                                             AND sf.externalserviceid = s.id
+                                             " . $enabledonlysql . ")";
+            $functions = $DB->get_records_sql($sql, $params);
+        } else {
+            $functions = array();
+        }
+        return $functions;
+    }
+
     /**
      * Get the list of all functions not in the given service id
      * @param int $serviceid

webservice/simpletest/testwebservice.php

@@ -73,7 +73,8 @@ class webservice_test extends UnitTestCase {
             'moodle_user_get_users_by_id' => false,
             'moodle_enrol_get_enrolled_users' => false,
             'moodle_group_get_course_groups' => false,
-            'moodle_group_get_groupmembers' => false
+            'moodle_group_get_groupmembers' => false,
+            'moodle_webservice_get_siteinfo' => false
         );
 
         ////// WRITE DB tests ////
@@ -219,6 +220,18 @@ class webservice_test extends UnitTestCase {
         $this->assertEqual(count($groups), count($groupids));
     }
 
+    function moodle_webservice_get_siteinfo($client) {
+        global $SITE, $CFG;
+
+        $function = 'moodle_webservice_get_siteinfo';
+
+        $params = array();
+        $info = $client->call($function, $params);
+
+        $this->assertEqual($info['sitename'], $SITE->fullname);
+        $this->assertEqual($info['siteurl'],  $CFG->wwwroot);
+    }
+
     function moodle_user_get_users_by_id($client) {
         global $DB;
         $dbusers = $DB->get_records('user', array('deleted' => 0));