| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899 |
- <?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="../sloodlechat/_mod---chat-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 chat linker (for Sloodle 0.3).</span></div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc"> * Allows a Sloodle WebIntercom tool link into a Moodle chatroom.</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> * Fetches a recent chat history, and optionally inserts a new message.</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"> sloodlechat</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></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Implement capabilities to make sure users can write to the chatroom (will need special handling to let guest users be permitted if desired)</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><span class="src-doc-tag">@contributor</span><span class="src-doc"> (various)</span></div></li>
- <li><div class="src-line"><a name="a14"></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="a15"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a16"></a> </div></li>
- <li><div class="src-line"><a name="a17"></a> <span class="src-comm">// This script should be called with the following parameters:</span></div></li>
- <li><div class="src-line"><a name="a18"></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="a19"></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="a20"></a> <span class="src-comm">// sloodlemoduleid = ID of a chatroom</span></div></li>
- <li><div class="src-line"><a name="a21"></a> <span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a22"></a> <span class="src-comm">// If adding a new message, the following parameters should be provided:</span></div></li>
- <li><div class="src-line"><a name="a23"></a> <span class="src-comm">// sloodleuuid = UUID of the avatar</span></div></li>
- <li><div class="src-line"><a name="a24"></a> <span class="src-comm">// sloodleavname = name of the avatar</span></div></li>
- <li><div class="src-line"><a name="a25"></a> <span class="src-comm">// message = the body of the message</span></div></li>
- <li><div class="src-line"><a name="a26"></a> <span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a27"></a> <span class="src-comm">// The following parameter is optional:</span></div></li>
- <li><div class="src-line"><a name="a28"></a> <span class="src-comm">// sloodledebug = if 'true', then Sloodle debugging mode is activated </span></div></li>
- <li><div class="src-line"><a name="a29"></a> </div></li>
- <li><div class="src-line"><a name="a30"></a> </div></li>
- <li><div class="src-line"><a name="a31"></a> <span class="src-doc">/** Lets Sloodle know we are in a linker script. */</span></div></li>
- <li><div class="src-line"><a name="a32"></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="a33"></a> </div></li>
- <li><div class="src-line"><a name="a34"></a> <span class="src-doc">/** Grab the Sloodle/Moodle configuration. */</span></div></li>
- <li><div class="src-line"><a name="a35"></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="a36"></a> <span class="src-doc">/** Include the Sloodle PHP API. */</span></div></li>
- <li><div class="src-line"><a name="a37"></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="a38"></a> </div></li>
- <li><div class="src-line"><a name="a39"></a> <span class="src-comm">// Authenticate the request, and load a chat module</span></div></li>
- <li><div class="src-line"><a name="a40"></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="a41"></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="a42"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">load_module</span><span class="src-sym">(</span><span class="src-str">'chat'</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="a43"></a> <span class="src-comm">// Attempt to validate the user</span></div></li>
- <li><div class="src-line"><a name="a44"></a> <span class="src-comm">// (this will auto-register/enrol users where necessary and allowed)</span></div></li>
- <li><div class="src-line"><a name="a45"></a> <span class="src-comm">// If server access level is public, then validation is not essential... otherwise, it is</span></div></li>
- <li><div class="src-line"><a name="a46"></a> <span class="src-var">$sloodleserveraccesslevel </span>= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">request</span><span class="src-sym">-></span><span class="src-id">get_server_access_level</span><span class="src-sym">(</span><span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a47"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$sloodleserveraccesslevel </span>== <span class="src-num">0</span><span class="src-sym">) </span><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">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a48"></a> <span class="src-key">else </span><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-sym">;</span></div></li>
- <li><div class="src-line"><a name="a49"></a> </div></li>
- <li><div class="src-line"><a name="a50"></a> </div></li>
- <li><div class="src-line"><a name="a51"></a> <span class="src-comm">// Has an incoming message been provided?</span></div></li>
- <li><div class="src-line"><a name="a52"></a> <span class="src-var">$message </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_clean_for_db">sloodle_clean_for_db</a><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">request</span><span class="src-sym">-></span><span class="src-id">optional_param</span><span class="src-sym">(</span><span class="src-str">'message'</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="a53"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$message </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="a54"></a> <span class="src-comm">// Add it to the chatroom - if it fails add a negative side effect code to our response.</span></div></li>
- <li><div class="src-line"><a name="a55"></a> <span class="src-comm">// The positive side effect will be added by the function if successful.</span></div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">module</span><span class="src-sym">-></span><span class="src-id">add_message</span><span class="src-sym">(</span><span class="src-var">$message</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a57"></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_side_effect</span><span class="src-sym">(</span>-<span class="src-num">10101</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-id">add_to_log</span><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">-></span><span class="src-id">get_course_id</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">, </span><span class="src-str">'add message'</span><span class="src-sym">, </span><span class="src-str">''</span><span class="src-sym">, </span><span class="src-str">'Failed to add chat message to chatroom'</span><span class="src-sym">, </span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">request</span><span class="src-sym">-></span><span class="src-id">get_module_id</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> <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="a60"></a> <span class="src-id">add_to_log</span><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">-></span><span class="src-id">get_course_id</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">, </span><span class="src-str">'add message'</span><span class="src-sym">, </span><span class="src-str">''</span><span class="src-sym">, </span><span class="src-str">'Added chat message to chatroom'</span><span class="src-sym">, </span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">request</span><span class="src-sym">-></span><span class="src-id">get_module_id</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="a61"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a62"></a> <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> <span class="src-comm">// Start preparing the response</span></div></li>
- <li><div class="src-line"><a name="a65"></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="a66"></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="a67"></a> </div></li>
- <li><div class="src-line"><a name="a68"></a> <span class="src-comm">// Fetch a chat history </span></div></li>
- <li><div class="src-line"><a name="a69"></a> <span class="src-var">$messages </span>= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">module</span><span class="src-sym">-></span><span class="src-id">get_chat_history</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="a70"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$messages </span><span class="src-key">as </span><span class="src-var">$m</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-var">$author </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_clean_for_output">sloodle_clean_for_output</a><span class="src-sym">(</span><span class="src-var">$m</span><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">get_user_firstname</span><span class="src-sym">(</span><span class="src-sym">)</span>.<span class="src-str">' '</span>.<span class="src-var">$m</span><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">get_user_lastname</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="a72"></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">$m</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">, </span><span class="src-var">$author</span><span class="src-sym">, </span><a href="../sloodle/_lib---general.php.html#functionsloodle_clean_for_output">sloodle_clean_for_output</a><span class="src-sym">(</span><span class="src-var">$m</span><span class="src-sym">-></span><span class="src-id">message</span><span class="src-sym">)))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a73"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a74"></a> </div></li>
- <li><div class="src-line"><a name="a75"></a> <span class="src-comm">// Output our response</span></div></li>
- <li><div class="src-line"><a name="a76"></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><span class="src-comm">// For debug mode, lets us see the response in a browser</span></div></li>
- <li><div class="src-line"><a name="a77"></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="a78"></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="a79"></a> </div></li>
- <li><div class="src-line"><a name="a80"></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:38 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|