Source for file sl_welcome_reg.php

Documentation is available at sl_welcome_reg.php

  1. <?php
  2.     /**
  3.     * Sloodle avatar registration page.
  4.     *
  5.     * Allows users who have clicked an in-world registration booth to complete their
  6.     *  avatar registration by logging-in to their Moodle account (or creating one).
  7.     *
  8.     * @package sloodleregenrol
  9.     * @copyright Copyright (c) 2007 Sloodle (various contributors)
  10.     * @license http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3
  11.     *
  12.     * @contributor Edmund Edgar
  13.     * @contributor Peter R. Bloomfield
  14.     *
  15.     */
  16.     
  17.     // This script is expected to be visited by a user with a web browser.
  18.     // The following request parameters (GET or POST) are required for an initial page view:
  19.     //
  20.     //  sloodleuuid - the UUID of the avatar which is being registered
  21.     //  sloodlelst - the login security token generated for the registration attempt
  22.     //
  23.     // Optionally, objects which need to know when registration has been accomplished can provide the following:
  24.     //
  25.     //  sloodlechannel - UUID of an XMLRPC channel
  26.     //
  27.     // In most cases, after login, the above parameters will be sufficient.
  28.     // However, where the same avatar is already registered to another Moodle user,
  29.     //  the user will be asked for confirmation. At this point, an additional
  30.     //  parameter will be added:
  31.     //
  32.     //  sloodleconfirm - 'true' if the change/overwrite of existing details is confirmed
  33.     //
  34.     // A new optional parameter is the following:
  35.     //
  36.     //  sloodlecourseid - the integer ID of the course which the user should be enrolled in after registration
  37.     
  38.     /** Include Sloodle/Moodle configuration. */
  39.     require_once('../sl_config.php');
  40.     require_once(SLOODLE_LIBROOT.'/general.php');
  41.     
  42.     sloodle_require_login_no_guest();
  43.  
  44.     // Make sure the user has permission to register their avatar
  45.     require_capability('mod/sloodle:registeravatar', get_context_instance(CONTEXT_SYSTEM));
  46.     
  47.     /** Include the Sloodle API. */
  48.     require_once(SLOODLE_LIBROOT.'/sloodle_session.php');
  49.     
  50.     // Display the page header
  51.     print_header_simple(get_string('welcometosloodle', 'sloodle'), "", get_string('welcometosloodle', 'sloodle'), "", "", true);
  52.     
  53.     
  54.     // Process the request data
  55.     $sloodle = new SloodleSession();
  56.     
  57.     // Check parameters
  58.     $sloodleuuid = required_param('sloodleuuid', PARAM_TEXT);
  59.     $sloodlelst = required_param('sloodlelst', PARAM_TEXT);
  60.     $sloodlechannel = optional_param('sloodlechannel', NULL, PARAM_RAW);
  61.     $sloodlecourseid = optional_param('sloodlecourseid', NULL, PARAM_INT);
  62.     
  63.     // Attempt to find a pending avatar entry which matches the given details
  64.     $pa = get_record('sloodle_pending_avatars', 'uuid', $sloodleuuid, 'lst', $sloodlelst);
  65.     if (!$pa) {
  66.         ?>
  67.         <div style="text-align:center;">
  68.          <h3><?php print_string('error', 'sloodle'); ?></h3>
  69.          <p><?php print_string('pendingavatarnotfound', 'sloodle'); ?></p>
  70.         </div>
  71.         <?php
  72.         print_footer();
  73.         exit();
  74.     }
  75.     
  76.     // Add the new avatar
  77.     if (!$sloodle->user->add_linked_avatar($USER->id, $sloodleuuid, $pa->avname)) {
  78.         // Failed
  79.         ?>
  80.         <div style="text-align:center;">
  81.          <h3><?php print_string('error', 'sloodle'); ?></h3>
  82.          <p><?php print_string('failedcreatesloodleuser', 'sloodle'); ?></p>
  83.         </div>
  84.         <?php
  85.         print_footer();
  86.         exit();
  87.     }
  88.  
  89. /// /// MOODLE-SPECIFIC /// ///
  90.  
  91.     // This is a slightly dirty hack, but is needed just now to prevent multiple avatar registrations.
  92.     // Delete any avatar belonging to this user, which doesn't match the one just registered.
  93.     delete_records_select('sloodle_users', "userid = {$USER->id} AND uuid <> '{$sloodleuuid}'");
  94.  
  95. /// /// END MOODLE-SPECIFIC /// ///
  96.     
  97.     echo "<div style=\"text-align:center; font-size:140%;\">\n";
  98.     echo get_string('welcometosloodle','sloodle').', '.$pa->avname.'<br /><br />'.get_string('userlinksuccessful','sloodle');
  99.     echo "</div>\n";
  100.     
  101.     // If the object passed us a channel parameter, we'll use it to tell the object that the authentication is done.
  102.     // (Parameter name: sloodlechannel)
  103.     if (is_string($sloodlechannel) && !empty($sloodlechannel)) {
  104.         flush();
  105.         
  106.         // XMLRPC messages going into SL strip \n, so we use \\n instead
  107.         $sloodle->response->set_line_separator("\\n");
  108.         // Prepare a response as a string
  109.         $str = '';
  110.         $sloodle->response->set_status_code(1);
  111.         $sloodle->response->set_status_descriptor('USER_AUTH');
  112.         $sloodle->response->add_data_line('User has been successfully registered.');
  113.         $sloodle->response->render_to_string($str);
  114.         
  115.         // Send the message
  116.         $xmlrpcresult = sloodle_send_xmlrpc_message($channel, 0, $str);
  117.         if (!$xmlrpcresult) {
  118.             echo '<div style="text-align:center;">';
  119.             echo 'ERROR: Unable to tell the object that sent you here that you have been authenticated.';
  120.             echo '</div>';
  121.         }
  122.     }
  123.     
  124.     
  125.     // We we asked to enrol the user as well?
  126.     if ($sloodlecourseid != NULL) {
  127.         echo "<br/><br/><br/>";
  128.         redirect("{$CFG->wwwroot}/course/enrol.php?id=$sloodlecourseid", get_string('nowenrol','sloodle'), 3);
  129.     }
  130.     
  131.     
  132.     print_footer();
  133.     exit();
  134.  
  135. ?>

Documentation generated on Fri, 17 Jul 2009 11:02:32 +0100 by phpDocumentor 1.4.0