chamilo / chamilo-lms

main/webservices/courses_list.soap.php

<?php

/* For licensing terms, see /license.txt */

/**
 * This script provides the caller service with a list
 * of courses that have a certain level of visibility
 * on this chamilo portal.
 * It is set to work with the Chamilo module for Drupal:
 * http://drupal.org/project/chamilo.
 *
 * @author Yannick Warnier <yannick.warnier@beeznest.com>
 *
 * @package chamilo.webservices
 */
require_once __DIR__.'/../inc/global.inc.php';

api_protect_webservices();

// Create the server instance
$server = new soap_server();
// Initialize WSDL support
$server->configureWSDL('WSCourseList', 'urn:WSCourseList');

/* Register WSCourseList function */
// Register the data structures used by the service

$server->wsdl->addComplexType(
    'courseDetails',
    'complexType',
    'struct',
    'all',
    '',
    [
        'name' => 'code',
        'type' => 'xsd:string',
        'name' => 'title',
        'type' => 'xsd:string',
        'name' => 'url',
        'type' => 'xsd:string',
        'name' => 'teacher',
        'type' => 'xsd:string',
        'name' => 'language',
        'type' => 'xsd:string',
    ]
);

$server->wsdl->addComplexType(
    'courseList',
    'complexType',
    'array',
    '',
    'SOAP-ENC:Array',
    [],
    [
        ['ref' => 'SOAP-ENC:arrayType',
        'wsdl:arrayType' => 'tns:courseDetails[]', ],
    ],
    'tns:courseDetails'
);

// Register the method to expose
$server->register(
    'WSCourseList', // method name
    ['username' => 'xsd:string',
          'signature' => 'xsd:string',
          'visibilities' => 'xsd:string', ], // input parameters
    ['return' => 'xsd:Array'], // output parameters
    'urn:WSCourseList', // namespace
    'urn:WSCourseList#WSCourseList', // soapaction
    'rpc', // style
    'encoded', // use
    'This service returns a list of courses'    // documentation
);

/**
 * Get a list of courses (code, url, title, teacher, language) and return to caller
 * Function registered as service. Returns strings in UTF-8.
 *
 * @param string User name in Chamilo
 * @param string Signature (composed of the sha1(username+apikey)
 * @param mixed  Array or string. Type of visibility of course (public, public-registered, private, closed)
 *
 * @return array Courses list (code=>[title=>'title',url='http://...',teacher=>'...',language=>''],code=>[...],...)
 */
function WSCourseList($username, $signature, $visibilities = 'public')
{
    if (empty($username) or empty($signature)) {
        return -1;
    }

    global $_configuration;

    $info = api_get_user_info_from_username($username);
    $user_id = $info['user_id'];
    if (!UserManager::is_admin($user_id)) {
        return -1;
    }

    $list = UserManager::get_api_keys($user_id, 'dokeos');
    $key = '';
    foreach ($list as $key) {
        break;
    }

    $local_key = $username.$key;

    if (!api_is_valid_secret_key($signature, $local_key) &&
        !api_is_valid_secret_key($signature, $username.$_configuration['security_key'])
    ) {
        return -1; // The secret key is incorrect.
    }
    //public-registered = open
    $vis = ['public' => '3', 'public-registered' => '2', 'private' => '1', 'closed' => '0'];

    $courses_list = [];

    if (!is_array($visibilities)) {
        $visibilities = split(',', $visibilities);
    }
    foreach ($visibilities as $visibility) {
        if (!in_array($visibility, array_keys($vis))) {
            return ['error_msg' => 'Security check failed'];
        }
        $courses_list_tmp = CourseManager::get_courses_list(
            null,
            null,
            null,
            null,
            $vis[$visibility]
        );
        foreach ($courses_list_tmp as $index => $course) {
            $course_info = CourseManager::get_course_information($course['code']);

The function CourseManager::get_course_information() has been deprecated: Use api_get_course_info() instead

            $courses_list[] = [
                'code' => $course['code'],
                'title' => api_utf8_encode($course_info['title']),
                'url' => api_get_path(WEB_COURSE_PATH).$course_info['directory'].'/',
                'teacher' => api_utf8_encode($course_info['tutor_name']),
                'language' => $course_info['course_language'],
            ];
        }
    }

    return $courses_list;
}

// Use the request to (try to) invoke the service.
$HTTP_RAW_POST_DATA = isset($HTTP_RAW_POST_DATA) ? $HTTP_RAW_POST_DATA : '';
$server->service($HTTP_RAW_POST_DATA);