| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980 |
- <?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 linker.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file linker.php</h1>
- <p>Documentation is available at <a href="../sloodlepwreset/_mod---pwreset-1.0---linker.php.html">linker.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 password reset linker.</span></div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc"> * Allows users in-world to request a password reset.</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> * This is only intended for auto-registered users.</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"> sloodlepwreset</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) 2008 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></div></li>
- <li><div class="src-line"><a name="a11"></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="a12"></a><span class="src-doc"> *</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> </div></li>
- <li><div class="src-line"><a name="a15"></a> <span class="src-comm">// This script should be called with the following parameters:</span></div></li>
- <li><div class="src-line"><a name="a16"></a> <span class="src-comm">// sloodlecontrollerid = ID of a Sloodle Controller through which to access Moodle</span></div></li>
- <li><div class="src-line"><a name="a17"></a> <span class="src-comm">// sloodlepwd = the prim password or object-specific session key to authenticate the request</span></div></li>
- <li><div class="src-line"><a name="a18"></a> <span class="src-comm">// sloodleuuid = the UUID of a user agent</span></div></li>
- <li><div class="src-line"><a name="a19"></a> <span class="src-comm">// sloodleavname = the name of an avatar</span></div></li>
- <li><div class="src-line"><a name="a20"></a> <span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a21"></a> <span class="src-comm">// The following parameter is optional:</span></div></li>
- <li><div class="src-line"><a name="a22"></a> <span class="src-comm">// sloodleserveraccesslevel = indicates what access level to enforce: 0 = public, 1 = course, 2 = site, 3 = staff</span></div></li>
- <li><div class="src-line"><a name="a23"></a> <span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a24"></a> <span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a25"></a> <span class="src-comm">// If successful, the script will reset the user's password, returning status code 1.</span></div></li>
- <li><div class="src-line"><a name="a26"></a> <span class="src-comm">// The data line will contain: username|password</span></div></li>
- <li><div class="src-line"><a name="a27"></a> <span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a28"></a> <span class="src-comm">// If the user has an active email account associated with their Moodle account, then</span></div></li>
- <li><div class="src-line"><a name="a29"></a> <span class="src-comm">// status code -341 is returned, and the password is unchanged.</span></div></li>
- <li><div class="src-line"><a name="a30"></a> </div></li>
- <li><div class="src-line"><a name="a31"></a> </div></li>
- <li><div class="src-line"><a name="a32"></a> <span class="src-doc">/** Lets Sloodle know we are in a linker script. */</span></div></li>
- <li><div class="src-line"><a name="a33"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_LINKER_SCRIPT'</span><span class="src-sym">, </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="a34"></a> </div></li>
- <li><div class="src-line"><a name="a35"></a> <span class="src-doc">/** Grab the Sloodle/Moodle configuration. */</span></div></li>
- <li><div class="src-line"><a name="a36"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-str">'../../sl_config.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a37"></a> <span class="src-doc">/** Include the Sloodle PHP API. */</span></div></li>
- <li><div class="src-line"><a name="a38"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_LIBROOT</span>.<span class="src-str">'/sloodle_session.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a39"></a> </div></li>
- <li><div class="src-line"><a name="a40"></a> <span class="src-comm">// Authenticate the request, and validate the user, but do not allow auto-registration/enrolment</span></div></li>
- <li><div class="src-line"><a name="a41"></a> <span class="src-var">$sloodle </span>= <span class="src-key">new </span><span class="src-id"><a href="../sloodle/SloodleSession.html">SloodleSession</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="a42"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">authenticate_request</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="a43"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">validate_user</span><span class="src-sym">(</span><span class="src-id">true</span><span class="src-sym">, </span><span class="src-id">true</span><span class="src-sym">, </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="a44"></a> </div></li>
- <li><div class="src-line"><a name="a45"></a> <span class="src-comm">// Request a password reset.</span></div></li>
- <li><div class="src-line"><a name="a46"></a> <span class="src-var">$password </span>= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">reset_password</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="a47"></a> </div></li>
- <li><div class="src-line"><a name="a48"></a> <span class="src-comm">// Prepare the response</span></div></li>
- <li><div class="src-line"><a name="a49"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</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="a50"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'OK'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a51"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">get_username</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-var">$password</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a52"></a> </div></li>
- <li><div class="src-line"><a name="a53"></a> <span class="src-comm">// If there are any pending password notifications for this user, then delete them</span></div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">purge_password_notifications</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="a55"></a> </div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-comm">// Output the response data</span></div></li>
- <li><div class="src-line"><a name="a57"></a> <a href="../sloodle/_sl_config.php.html#functionsloodle_debug">sloodle_debug</a><span class="src-sym">(</span><span class="src-str">'<pre>'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a58"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">response</span><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="a59"></a> <a href="../sloodle/_sl_config.php.html#functionsloodle_debug">sloodle_debug</a><span class="src-sym">(</span><span class="src-str">'</pre>'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a60"></a> </div></li>
- <li><div class="src-line"><a name="a61"></a><span class="src-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Fri, 17 Jul 2009 11:01:40 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|