| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>File Source for lsl.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file lsl.php</h1>
- <p>Documentation is available at <a href="../sloodle/_sloodle---lib---lsl.php.html">lsl.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php </span></div></li>
- <li><div class="src-line"><a name="a2"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a3"></a><span class="src-doc"> * Sloodle LSL handling library.</span></div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> * Provides the central API functionality, automatically combining several other API elements.</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2007-8 Sloodle (various contributors)</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@since</span><span class="src-doc"> Sloodle 0.2</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc"> * </span><span class="src-doc-tag">@contributor</span><span class="src-doc"> Peter R. Bloomfield</span></div></li>
- <li><div class="src-line"><a name="a13"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a14"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a15"></a> </div></li>
- <li><div class="src-line"><a name="a16"></a> <span class="src-comm">// This library expects that the Sloodle config file has already been included</span></div></li>
- <li><div class="src-line"><a name="a17"></a> <span class="src-comm">// (along with the Moodle libraries)</span></div></li>
- <li><div class="src-line"><a name="a18"></a> </div></li>
- <li><div class="src-line"><a name="a19"></a> <span class="src-doc">/** Include the general Sloodle functionality. */</span></div></li>
- <li><div class="src-line"><a name="a20"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_DIRROOT</span>.<span class="src-str">'/lib/general.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a21"></a> <span class="src-doc">/** Include the Sloodle IO library. */</span></div></li>
- <li><div class="src-line"><a name="a22"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_DIRROOT</span>.<span class="src-str">'/lib/io.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a23"></a> <span class="src-doc">/** Include the Sloodle user management library. */</span></div></li>
- <li><div class="src-line"><a name="a24"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_DIRROOT</span>.<span class="src-str">'/lib/user.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a25"></a> </div></li>
- <li><div class="src-line"><a name="a26"></a> </div></li>
- <li><div class="src-line"><a name="a27"></a> <span class="src-doc">/** </span></div></li>
- <li><div class="src-line"><a name="a28"></a><span class="src-doc"> * A helper class to automate many API features.</span></div></li>
- <li><div class="src-line"><a name="a29"></a><span class="src-doc"> * Most interaction with the object-oriented parts of the Sloodle API should occur via this class.</span></div></li>
- <li><div class="src-line"><a name="a30"></a><span class="src-doc"> * It brings together the other classes, and automatically handles various features.</span></div></li>
- <li><div class="src-line"><a name="a31"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a32"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a33"></a> <span class="src-key">class </span><a href="../sloodle/SloodleLSLHandler.html">SloodleLSLHandler</a></div></li>
- <li><div class="src-line"><a name="a34"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a35"></a> <span class="src-comm">///// PUBLIC DATA /////</span></div></li>
- <li><div class="src-line"><a name="a36"></a> </div></li>
- <li><div class="src-line"><a name="a37"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a38"></a><span class="src-doc"> * A Sloodle user object.</span></div></li>
- <li><div class="src-line"><a name="a39"></a><span class="src-doc"> * Instantiated to the {@link: SloodleUser} type in the class constructor.</span></div></li>
- <li><div class="src-line"><a name="a40"></a><span class="src-doc"> * No accessors - should be accessed directly.</span></div></li>
- <li><div class="src-line"><a name="a41"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">SloodleUser </span></div></li>
- <li><div class="src-line"><a name="a42"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a43"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a44"></a> <span class="src-key">var </span><a href="../sloodle/SloodleLSLHandler.html#var$user">$user</a> = <span class="src-id">NULL</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a45"></a> </div></li>
- <li><div class="src-line"><a name="a46"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a47"></a><span class="src-doc"> * A Sloodle request handling object.</span></div></li>
- <li><div class="src-line"><a name="a48"></a><span class="src-doc"> * Instantiated to the {@link: SloodleLSLRequest} type in the class constructor.</span></div></li>
- <li><div class="src-line"><a name="a49"></a><span class="src-doc"> * No accessors - should be accessed directly.</span></div></li>
- <li><div class="src-line"><a name="a50"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">SloodleLSLRequest </span></div></li>
- <li><div class="src-line"><a name="a51"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a52"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a53"></a> <span class="src-key">var </span><a href="../sloodle/SloodleLSLHandler.html#var$request">$request</a> = <span class="src-id">NULL</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a54"></a> </div></li>
- <li><div class="src-line"><a name="a55"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a56"></a><span class="src-doc"> * A Sloodle response handling object.</span></div></li>
- <li><div class="src-line"><a name="a57"></a><span class="src-doc"> * Instantiated to the {@link: SloodleLSLResponse} type in the class constructor.</span></div></li>
- <li><div class="src-line"><a name="a58"></a><span class="src-doc"> * No accessors - should be accessed directly.</span></div></li>
- <li><div class="src-line"><a name="a59"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">SloodleLSLHandler </span></div></li>
- <li><div class="src-line"><a name="a60"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a61"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a62"></a> <span class="src-key">var </span><a href="../sloodle/SloodleLSLHandler.html#var$response">$response</a> = <span class="src-id">NULL</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a63"></a> </div></li>
- <li><div class="src-line"><a name="a64"></a> </div></li>
- <li><div class="src-line"><a name="a65"></a> <span class="src-comm">///// FUNCTIONS /////</span></div></li>
- <li><div class="src-line"><a name="a66"></a> </div></li>
- <li><div class="src-line"><a name="a67"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a68"></a><span class="src-doc"> * Class constructor.</span></div></li>
- <li><div class="src-line"><a name="a69"></a><span class="src-doc"> * Instantiates member objects.</span></div></li>
- <li><div class="src-line"><a name="a70"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a71"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a72"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a73"></a> <span class="src-key">function </span><a href="../sloodle/SloodleLSLHandler.html#methodSloodleLSLHandler">SloodleLSLHandler</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a74"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a75"></a> <span class="src-comm">// Instantiate and link our components</span></div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a> = <span class="src-key">new </span><span class="src-id"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a77"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a> = <span class="src-key">new </span><span class="src-id">SloodleLSLResponse</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a78"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a> = <span class="src-key">new </span><span class="src-id">SloodleLSLRequest</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a79"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a80"></a> </div></li>
- <li><div class="src-line"><a name="a81"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a82"></a><span class="src-doc"> * Performs an internal 'login' based on user identified in request.</span></div></li>
- <li><div class="src-line"><a name="a83"></a><span class="src-doc"> * Checks for avatar UUID and/or name request parameters, and checks for an associated Moodle account.</span></div></li>
- <li><div class="src-line"><a name="a84"></a><span class="src-doc"> * If found, the user is logged-in (details stored in Moodle's global $USER variable).</span></div></li>
- <li><div class="src-line"><a name="a85"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$require </span><span class="src-doc">If true (default), the function will terminate the script with an error message if login fails. (Error message will be LSL-friendly).</span></div></li>
- <li><div class="src-line"><a name="a86"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$suppress_autoreg </span><span class="src-doc">If true (not default), the function will always suppress auto-registration of new users. Note: this parameter will be ignored if auto-registration is disabled.</span></div></li>
- <li><div class="src-line"><a name="a87"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if login was successful. False if login failed, but parameter $require was false.</span></div></li>
- <li><div class="src-line"><a name="a88"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a89"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a90"></a> <span class="src-key">function </span><a href="../sloodle/SloodleLSLHandler.html#methodlogin_by_request">login_by_request</a><span class="src-sym">(</span><span class="src-var">$require </span>= <span class="src-id">TRUE</span><span class="src-sym">, </span><span class="src-var">$suppress_autoreg </span>= <span class="src-id">FALSE</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a91"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a92"></a> <span class="src-comm">// Make sure the request is processed and authenticated</span></div></li>
- <li><div class="src-line"><a name="a93"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">process_request_data</span><span class="src-sym">(</span><span class="src-id">TRUE</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// Force re-processing to ensure accurate user data</span></div></li>
- <li><div class="src-line"><a name="a94"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">authenticate_request</span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a95"></a> </div></li>
- <li><div class="src-line"><a name="a96"></a> <span class="src-comm">// Make sure the items of data were specified</span></div></li>
- <li><div class="src-line"><a name="a97"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_avatar_uuid</span><span class="src-sym">(</span><span class="src-sym">) </span>== <span class="src-id">NULL </span>&& <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_avatar_name</span><span class="src-sym">(</span><span class="src-sym">) </span>== <span class="src-id">NULL</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a98"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a99"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">311</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a100"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTH'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a101"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'User not identified in request.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a102"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a103"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a104"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a105"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a106"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a107"></a> </div></li>
- <li><div class="src-line"><a name="a108"></a> <span class="src-comm">// Is the user already fully registered?</span></div></li>
- <li><div class="src-line"><a name="a109"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">get_sloodle_user_id</span><span class="src-sym">(</span><span class="src-sym">) </span>> <span class="src-num">0 </span>&& <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">get_moodle_user_id</span><span class="src-sym">(</span><span class="src-sym">) </span>> <span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a110"></a> <span class="src-comm">// Yes - attempt to login</span></div></li>
- <li><div class="src-line"><a name="a111"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">login_moodle_user</span><span class="src-sym">(</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a112"></a> <span class="src-comm">// Login failed</span></div></li>
- <li><div class="src-line"><a name="a113"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a114"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">301</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a115"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTH'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a116"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'Failed to login Moodle user for unkown reason.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a117"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a118"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a119"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a120"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a121"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a122"></a> </div></li>
- <li><div class="src-line"><a name="a123"></a> <span class="src-comm">// Login succeeded</span></div></li>
- <li><div class="src-line"><a name="a124"></a> <span class="src-key">return </span><span class="src-id">TRUE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a125"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a126"></a> </div></li>
- <li><div class="src-line"><a name="a127"></a> <span class="src-comm">// Is auto-registration disabled or suppressed?</span></div></li>
- <li><div class="src-line"><a name="a128"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-id">sloodle_is_automatic_registration_on</span><span class="src-sym">(</span><span class="src-sym">) </span>== <span class="src-id">FALSE </span>|| <span class="src-var">$suppress_autoreg </span>== <span class="src-id">TRUE</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a129"></a> <span class="src-comm">// We cannot do auto-registration</span></div></li>
- <li><div class="src-line"><a name="a130"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a131"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">321</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a132"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTH'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a133"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'User not registered, and auto registration was not permitted.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a134"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$suppress_autoreg</span><span class="src-sym">) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'Note: auto registration was explicitly suppressed.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a135"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a136"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a137"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a138"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a139"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a140"></a> </div></li>
- <li><div class="src-line"><a name="a141"></a> </div></li>
- <li><div class="src-line"><a name="a142"></a> <span class="src-comm">// Make sure we have both the avatar name and UUID</span></div></li>
- <li><div class="src-line"><a name="a143"></a> <span class="src-comm">// [Note: if the user was fully registered with Sloodle and not Moodle, and only name OR UUID was provided,</span></div></li>
- <li><div class="src-line"><a name="a144"></a> <span class="src-comm">// then the earlier data processing will have retrieved the missing value... cunning, eh? :-)]</span></div></li>
- <li><div class="src-line"><a name="a145"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_avatar_uuid</span><span class="src-sym">(</span><span class="src-sym">))) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a146"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a147"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">311</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a148"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTO_REG'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a149"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'User auto registration not possible - avatar UUID was not provided or found in the database.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a150"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a151"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a152"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a153"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a154"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a155"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_avatar_name</span><span class="src-sym">(</span><span class="src-sym">))) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a156"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a157"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">311</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a158"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTO_REG'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a159"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'User auto registration not possible - avatar name was not provided or found in the database.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a160"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a161"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a162"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a163"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a164"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a165"></a> </div></li>
- <li><div class="src-line"><a name="a166"></a> <span class="src-comm">// Do we need to register a Moodle account?</span></div></li>
- <li><div class="src-line"><a name="a167"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">get_moodle_user_id</span><span class="src-sym">(</span><span class="src-sym">) </span><= <span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a168"></a> <span class="src-comm">// Extract the first and last name parts</span></div></li>
- <li><div class="src-line"><a name="a169"></a> <span class="src-var">$firstname </span>= <span class="src-id">NULL</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a170"></a> <span class="src-var">$lastname </span>= <span class="src-id">NULL</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a171"></a> <span class="src-var">$avname </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_avatar_name</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a172"></a> <span class="src-var">$avbits </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a173"></a> <span class="src-comm">// Expecting that all SL names are first last, with a space in between</span></div></li>
- <li><div class="src-line"><a name="a174"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/preg_match">preg_match</a><span class="src-sym">(</span><span class="src-str">'/^(.*)\s(.*?)$/'</span><span class="src-sym">, </span><span class="src-var">$avname</span><span class="src-sym">, </span><span class="src-var">$avbits</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a175"></a> <span class="src-var">$firstname </span>= <span class="src-var">$avbits</span><span class="src-sym">[</span><span class="src-num">1</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a176"></a> <span class="src-var">$lastname </span>= <span class="src-var">$avbits</span><span class="src-sym">[</span><span class="src-num">2</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a177"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a178"></a> <span class="src-comm">// Something wasn't quite right about the name</span></div></li>
- <li><div class="src-line"><a name="a179"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a180"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">322</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a181"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTO_REG'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a182"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'User auto registration failed - could not extract first and last names from avatar name "'</span>.<span class="src-var">$avname</span>.<span class="src-str">'".'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a183"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a184"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a185"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a186"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a187"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a188"></a> </div></li>
- <li><div class="src-line"><a name="a189"></a> <span class="src-comm">// Register the new Moodle account</span></div></li>
- <li><div class="src-line"><a name="a190"></a> <span class="src-var">$autoreg </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">create_moodle_user</span><span class="src-sym">(</span><span class="src-var">$firstname</span><span class="src-sym">, </span><span class="src-var">$lastname</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_avatar_uuid</span><span class="src-sym">(</span><span class="src-sym">)</span>.<span class="src-str">'@lsl.secondlife.com'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a191"></a> <span class="src-comm">// Did something go wrong?</span></div></li>
- <li><div class="src-line"><a name="a192"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$autoreg </span>!== <span class="src-id">TRUE</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a193"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a194"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">322</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a195"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTO_REG'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a196"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'Moodle user creation failed.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a197"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_string">is_string</a><span class="src-sym">(</span><span class="src-var">$autoreg</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-var">$autoreg</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a198"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a199"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a200"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a201"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a202"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a203"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a204"></a> </div></li>
- <li><div class="src-line"><a name="a205"></a> <span class="src-comm">// Do we need to register a Sloodle entry?</span></div></li>
- <li><div class="src-line"><a name="a206"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">get_sloodle_user_id</span><span class="src-sym">(</span><span class="src-sym">) </span><= <span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a207"></a> <span class="src-comm">// Create the Sloodle entry</span></div></li>
- <li><div class="src-line"><a name="a208"></a> <span class="src-var">$newsloodle </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">create_sloodle_user</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a209"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_avatar_uuid</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a210"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_avatar_name</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a211"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">get_moodle_user_id</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a212"></a> <span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// Other parameters can be default</span></div></li>
- <li><div class="src-line"><a name="a213"></a> <span class="src-comm">// Did it fail?</span></div></li>
- <li><div class="src-line"><a name="a214"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$newsloodle </span>!== <span class="src-id">TRUE</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a215"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a216"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">322</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a217"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTO_REG'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a218"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'Sloodle user creation failed.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a219"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_string">is_string</a><span class="src-sym">(</span><span class="src-var">$newsloodle</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-var">$newsloodle</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a220"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a221"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a222"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a223"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a224"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a225"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a226"></a> <span class="src-comm">// We already have a Sloodle user</span></div></li>
- <li><div class="src-line"><a name="a227"></a> <span class="src-comm">// Just link the users together</span></div></li>
- <li><div class="src-line"><a name="a228"></a> <span class="src-var">$link </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">link_users</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a229"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$link </span>!== <span class="src-id">TRUE</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a230"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a231"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">322</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a232"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_AUTO_REG'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a233"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'Failed to link new Sloodle and Moodle users together.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a234"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_string">is_string</a><span class="src-sym">(</span><span class="src-var">$link</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-var">$link</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a235"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a236"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a237"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a238"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a239"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a240"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a241"></a> </div></li>
- <li><div class="src-line"><a name="a242"></a> <span class="src-comm">// User has been auto-registered, so add a side-effect code to our response</span></div></li>
- <li><div class="src-line"><a name="a243"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_side_effect</span><span class="src-sym">(</span><span class="src-num">322</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a244"></a> <span class="src-comm">// Finally, attempt to login the new user</span></div></li>
- <li><div class="src-line"><a name="a245"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">login_moodle_user</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a246"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a247"></a> </div></li>
- <li><div class="src-line"><a name="a248"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a249"></a><span class="src-doc"> * Authenticates the avatar identified in the request by the login security token.</span></div></li>
- <li><div class="src-line"><a name="a250"></a><span class="src-doc"> * Uses the avatar UUID and/or name, and the security token request to parameters to</span></div></li>
- <li><div class="src-line"><a name="a251"></a><span class="src-doc"> * check against the details in the database.</span></div></li>
- <li><div class="src-line"><a name="a252"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$use_cache </span><span class="src-doc">If true (not default) then the function will use the user data stored in Sloodle user cache of the {@link: $user} member object (instead of querying the database for new data).</span></div></li>
- <li><div class="src-line"><a name="a253"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if authentication was successful, or false if not.</span></div></li>
- <li><div class="src-line"><a name="a254"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a255"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a256"></a> <span class="src-key">function </span><a href="../sloodle/SloodleLSLHandler.html#methodconfirm_by_login_security_token">confirm_by_login_security_token</a><span class="src-sym">(</span><span class="src-var">$use_cache </span>= <span class="src-id">FALSE</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a257"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a258"></a> <span class="src-comm">// Was a login security token specified in the request? Do nothing if not</span></div></li>
- <li><div class="src-line"><a name="a259"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_login_security_token</span><span class="src-sym">(</span><span class="src-sym">) </span>== <span class="src-id">NULL</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a260"></a> <span class="src-comm">// Are we using the cache?</span></div></li>
- <li><div class="src-line"><a name="a261"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$use_cache</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a262"></a> <span class="src-comm">// No - fetch fresh data and ensure it worked</span></div></li>
- <li><div class="src-line"><a name="a263"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">update_sloodle_user_cache_from_db</span><span class="src-sym">(</span><span class="src-sym">) </span>!== <span class="src-id">TRUE</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a264"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a265"></a> </div></li>
- <li><div class="src-line"><a name="a266"></a> <span class="src-comm">// Make sure the login security token is specified in the cache</span></div></li>
- <li><div class="src-line"><a name="a267"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-var">sloodle_user_cache</span><span class="src-sym">-></span><span class="src-id">loginsecuritytoken</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a268"></a> <span class="src-comm">// Compare the security tokens</span></div></li>
- <li><div class="src-line"><a name="a269"></a> <span class="src-key">return </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_login_security_token</span><span class="src-sym">(</span><span class="src-sym">) </span>=== <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-var">sloodle_user_cache</span><span class="src-sym">-></span><span class="src-id">loginsecuritytoken</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a270"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a271"></a> </div></li>
- <li><div class="src-line"><a name="a272"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a273"></a><span class="src-doc"> * Checks that a user is enrolled in a course, based on request data.</span></div></li>
- <li><div class="src-line"><a name="a274"></a><span class="src-doc"> * Fetches user and course identification from the standard request parameters.</span></div></li>
- <li><div class="src-line"><a name="a275"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$require </span><span class="src-doc">If true (default) then the function will terminate with an LSL-friendly error message if user is not enrolled, or not all data was present.</span></div></li>
- <li><div class="src-line"><a name="a276"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$use_cache </span><span class="src-doc">If true (not default) then the courses cache in the {@link: $user} member will be used, instead of querying the database for fresh data.</span></div></li>
- <li><div class="src-line"><a name="a277"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if the user is enrolled, or false otherwise.</span></div></li>
- <li><div class="src-line"><a name="a278"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a279"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a280"></a> <span class="src-key">function </span><a href="../sloodle/SloodleLSLHandler.html#methodis_user_enrolled_by_request">is_user_enrolled_by_request</a><span class="src-sym">( </span><span class="src-var">$require </span>= <span class="src-id">TRUE</span><span class="src-sym">, </span><span class="src-var">$use_cache </span>= <span class="src-id">FALSE </span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a281"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a282"></a> <span class="src-comm">// Make sure the course exists</span></div></li>
- <li><div class="src-line"><a name="a283"></a> <span class="src-var">$course </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$request">request</a><span class="src-sym">-></span><span class="src-id">get_course_record</span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a284"></a> <span class="src-comm">// Is the user enrolled?</span></div></li>
- <li><div class="src-line"><a name="a285"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$user">user</a><span class="src-sym">-></span><span class="src-id">is_user_in_course</span><span class="src-sym">(</span><span class="src-var">$course</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">, </span><span class="src-var">$use_cache</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a286"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a287"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">421</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a288"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'USER_ENROL'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a289"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'User not enroled in course, and auto-enrolment is not yet implemented.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a290"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleLSLHandler.html#var$response">response</a><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a291"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a292"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a293"></a> <span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a294"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a295"></a> </div></li>
- <li><div class="src-line"><a name="a296"></a> <span class="src-comm">// Everything seems fine</span></div></li>
- <li><div class="src-line"><a name="a297"></a> <span class="src-key">return </span><span class="src-id">TRUE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a298"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a299"></a> </div></li>
- <li><div class="src-line"><a name="a300"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a301"></a> </div></li>
- <li><div class="src-line"><a name="a302"></a> </div></li>
- <li><div class="src-line"><a name="a303"></a><span class="src-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Mon, 16 Jun 2008 15:56:41 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|