Merged branch 'MDL-27566-wip' of git://github.com/mouneyrac/moodle.git with changes...
authorSam Hemelryk <sam@moodle.com>
Wed, 8 Jun 2011 02:02:59 +0000 (10:02 +0800)
committerSam Hemelryk <sam@moodle.com>
Wed, 8 Jun 2011 02:02:59 +0000 (10:02 +0800)
1  2 
message/externallib.php
version.php

index 0000000,02dd156..7836f8f
mode 000000,100644..100644
--- /dev/null
@@@ -1,0 -1,161 +1,159 @@@
 -            //check that user preference
+ <?php
+ // This file is part of Moodle - http://moodle.org/
+ //
+ // Moodle is free software: you can redistribute it and/or modify
+ // it under the terms of the GNU General Public License as published by
+ // the Free Software Foundation, either version 3 of the License, or
+ // (at your option) any later version.
+ //
+ // Moodle is distributed in the hope that it will be useful,
+ // but WITHOUT ANY WARRANTY; without even the implied warranty of
+ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ // GNU General Public License for more details.
+ //
+ // You should have received a copy of the GNU General Public License
+ // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+ /**
+  * External message API
+  *
+  * @package    moodlecore
+  * @subpackage message
+  * @copyright  2011 Moodle Pty Ltd (http://moodle.com)
+  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+  */
+ require_once("$CFG->libdir/externallib.php");
+ class moodle_message_external extends external_api {
+     /**
+      * Returns description of method parameters
+      * @return external_function_parameters
+      */
+     public static function send_messages_parameters() {
+         return new external_function_parameters(
+             array(
+                 'messages' => new external_multiple_structure(
+                     new external_single_structure(
+                         array(
+                             'touserid' => new external_value(PARAM_INT, 'id of the user to send the private message'),
+                             'text' => new external_value(PARAM_RAW, 'the text of the message - not that you can send anything it will be automatically cleaned to PARAM_TEXT and used againt MOODLE_FORMAT'),
+                             'clientmsgid' => new external_value(PARAM_ALPHANUMEXT, 'your own client id for the message. If this id is provided, the fail message id will be returned to you', VALUE_OPTIONAL),
+                         )
+                     )
+                 )
+             )
+         );
+     }
+     /**
+      * Send private messages from the current USER to other users
+      *
+      * @param $messages  An array of message to send.
+      * @return boolean
+      */
+     public static function send_messages($messages = array()) {
+         global $CFG, $USER, $DB;
+         require_once($CFG->dirroot . "/message/lib.php");
+         //check if messaging is enabled
+         if (!$CFG->messaging) {
+             throw new moodle_exception('disabled', 'message');
+         }
+         // Ensure the current user is allowed to run this function
+         $context = get_context_instance(CONTEXT_SYSTEM);
+         self::validate_context($context);
+         require_capability('moodle/site:sendmessage', $context);
+         $params = self::validate_parameters(self::send_messages_parameters(), array('messages' => $messages));
+         //retrieve all tousers of the messages
+         $touserids = array();
+         foreach($params['messages'] as $message) {
+             $touserids[] = $message['touserid'];
+         }
+         list($sqluserids, $sqlparams) = $DB->get_in_or_equal($touserids, SQL_PARAMS_NAMED, 'userid_');
+         $tousers = $DB->get_records_select("user", "id " . $sqluserids . " AND deleted = 0", $sqlparams);
+         //retrieve the tousers who are blocking the $USER
+         $sqlparams['contactid'] = $USER->id;
+         $sqlparams['blocked'] = 1;
+         //Note: return userid field should be unique for the below request,
+         //so we'll use this field as key of $blockingcontacts
+         $blockingcontacts = $DB->get_records_select("message_contacts",
+                 "userid " . $sqluserids . " AND contactid = :contactid AND blocked = :blocked",
+                 $sqlparams, '', "userid");
+         $canreadallmessages = has_capability('moodle/site:readallmessages', $context);
+         $resultmessages = array();
+         foreach ($params['messages'] as $message) {
+             $text = clean_param($message['text'], PARAM_TEXT);
+             $resultmsg = array(); //the infos about the success of the operation
+             //we are going to do some checking
+             //code should match /messages/index.php checks
+             $success = true;
+             //check the user exists
+             if (empty($tousers[$message['touserid']])) {
+                 $success = false;
+                 $errormessage = get_string('touserdoesntexist', 'message', $message['touserid']);
+             }
+             //check that the touser is not blocking the current user
+             if ($success and isset($blockingcontacts[$message['touserid']]) and !$canreadallmessages) {
+                 $success = false;
+                 $errormessage = get_string('userisblockingyou', 'message');
+             }
 -            if ($success and empty($contact)) {
 -               $userpreferences = get_user_preferences(NULL, NULL, $message['touserid']);
 -               if (!empty($userpreferences['message_blocknoncontacts'])) {
 -                   $success = false;
 -                   $errormessage = get_string('userisblockingyounoncontact', 'message');
 -               }
++            // Check if the user is a contact
+             //TODO: performance improvement - edit the function so we can pass an array instead userid
 -                    $resultmsg['clientmsgid'] = $message['clientmsgid'];
++            if ($success && empty($contact) && !empty(get_user_preferences('message_blocknoncontacts', NULL, $message['touserid']))) {
++                // The user isn't a contact and they have selected to block non contacts so this message won't be sent.
++                $success = false;
++                $errormessage = get_string('userisblockingyounoncontact', 'message');
+             }
+             //now we can send the message (at least try)
+             if ($success) {
+                 //TODO: performance improvement - edit the function so we can pass an array instead one touser object
+                 $success = message_post_message($USER, $tousers[$message['touserid']], $text, FORMAT_MOODLE);
+             }
+             //build the resultmsg
+             if (isset($message['clientmsgid'])) {
 -                    'msgid' => new external_value(PARAM_INT, 'test this to know if it success:  id of the created message when successed, -1 when failed'),
 -                    'errormessage' => new external_value(PARAM_TEXT, 'error message - if failed', VALUE_OPTIONAL)
++                $resultmsg['clientmsgid'] = $message['clientmsgid'];
+             }
+             if ($success) {
+                 $resultmsg['msgid'] = $success;
+             } else {
+                 $resultmsg['msgid'] = -1;
+                 $resultmsg['errormessage'] = $errormessage;
+             }
+             $resultmessages[] = $resultmsg;
+         }
+         return $resultmessages;
+     }
+     /**
+      * Returns description of method result value
+      * @return external_description
+      */
+     public static function send_messages_returns() {
+         return new external_multiple_structure(
+             new external_single_structure(
+                 array(
+                     'clientmsgid' => new external_value(PARAM_ALPHANUMEXT, 'your own id for the message', VALUE_OPTIONAL),
++                    'msgid' => new external_value(PARAM_INT, 'test this to know if it succeeds:  id of the created message if it succeeded, -1 when failed'),
++                    'errormessage' => new external_value(PARAM_TEXT, 'error message - if it failed', VALUE_OPTIONAL)
+                 )
+             )
+         );
+     }
+ }
diff --cc version.php
@@@ -30,7 -30,7 +30,7 @@@
  defined('MOODLE_INTERNAL') || die();
  
  
- $version  = 2011060500.00;              // YYYYMMDD      = weekly release date of this DEV branch
 -$version  = 2011060200.036;              // YYYYMMDD      = weekly release date of this DEV branch
++$version  = 2011060500.01;              // YYYYMMDD      = weekly release date of this DEV branch
                                          //         RR    = release increments - 00 in DEV branches
                                          //           .XX = incremental changes