]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/newmessage.php
replace 'public' in documentation with 'top'
[quix0rs-gnu-social.git] / actions / newmessage.php
index b324b8bf84986842cd1efafd95d05356a9da5690..fa1922c4a0a5fe3a7e13ba6ee536cee9f6d2a04b 100644 (file)
@@ -1,9 +1,12 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * StatusNet, the distributed open-source microblogging tool
  *
- * This program is free software: you can redistribute it and/or modify
+ * Handler for posting new messages
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Personal
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @author    Zach Copley <zach@status.net>
+ * @author    Sarven Capadisli <csarven@status.net>
+ * @copyright 2008-2009 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
  */
 
-if (!defined('LACONICA')) { exit(1); }
-
-class NewmessageAction extends Action {
-       
-       function handle($args) {
-               parent::handle($args);
-
-               if (!common_logged_in()) {
-                       $this->client_error(_('Not logged in.'), 403);
-               } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-                       $this->save_new_message();
-               } else {
-                       $this->show_form();
-               }
-       }
-
-       function save_new_message() {
-
-               $user = common_current_user();
-               assert($user); # XXX: maybe an error instead...
-               
-               $content = $this->trimmed('content');
-               $to = $this->trimmed('to');
-               
-               if (!$content) {
-                       $this->show_form(_('No content!'));
-                       return;
-               } else if (mb_strlen($content) > 140) {
-                       common_debug("Content = '$content'", __FILE__);
-                       common_debug("mb_strlen(\$content) = " . mb_strlen($content), __FILE__);
-                       $this->show_form(_('That\'s too long. Max message size is 140 chars.'));
-                       return;
-               }
-
-               $other = User::staticGet('id', $to);
-               
-               if (!$other) {
-                       $this->show_form(_('No recipient specified.'));
-                       return;
-               } else if (!$user->mutuallySubscribed($other)) {
-                       $this->client_error(_('You can\'t send a message to this user.'), 404);
-                       return;
-               }
-               
-               $message = Message::saveNew($user->id, $other->id, $content, 'web');
-               
-               if (is_string($message)) {
-                       $this->show_form($message);
-                       return;
-               }
-
-               $this->notify($user, $to, $message);
-
-               $url = common_local_url('showmessage',
-                                                               array('message' => $message->id));
-
-               common_redirect($url, 303);
-       }
-
-       function show_top($params) {
-
-               list($content, $user, $to) = $params;
-               
-               assert(!is_null($user));
-               
-               common_element_start('form', array('id' => 'message_form',
-                                                                                  'method' => 'post',
-                                                                                  'action' => $this->self_url()));
-               
-               common_element_start('p');
-               
-               $mutual_users = $user->mutuallySubscribedUsers();
-               
-               $mutual = array();
-               
-               while ($mutual_users->fetch()) {
-                       $mutual[$mutual_users->id] = $mutual_users->nickname;
-               }
-
-               $mutual_users->free();
-               unset($mutual_users);
-
-               common_dropdown('to', _('To'), $mutual,
-                                               _('User you want to send a message to'), FALSE,
-                                               $to->id);
-               
-               common_element('textarea', array('id' => 'content',
-                                                                                'cols' => 60,
-                                                                                'rows' => 3,
-                                                                                'name' => 'content'),
-                                          ($content) ? $content : '');
-                                               
-               common_element('input', array('id' => 'message_send',
-                                                                         'name' => 'message_send',
-                                                                         'type' => 'submit',
-                                                                         'value' => _('Send')));
-               
-               common_element_end('p');
-               common_element_end('form');
-       }
-
-       function show_form($msg=NULL) {
-               
-               $content = $this->trimmed('content');
-               $user = common_current_user();
-
-               $to = $this->trimmed('to');
-               
-               $other = User::staticGet('id', $to);
-
-               if (!$other) {
-                       $this->client_error(_('No such user'), 404);
-                       return;
-               }
-
-               if (!$user->mutuallySubscribed($other)) {
-                       $this->client_error(_('You can\'t send a message to this user.'), 404);
-                       return;
-               }
-               
-               common_show_header(_('New message'), NULL,
-                                                  array($content, $user, $to),
-                                  array($this, 'show_top'));
-               
-               if ($msg) {
-                       common_element('p', 'error', $msg);
-               }
-               
-               common_show_footer();
-       }
-       
-       function notify($from, $to, $message) {
-               mail_notify_message($message, $from, $to);
-               # XXX: Jabber, SMS notifications... probably queued
-       }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
+
+/**
+ * Action for posting new direct messages
+ *
+ * @category Personal
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Zach Copley <zach@status.net>
+ * @author   Sarven Capadisli <csarven@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+
+class NewmessageAction extends Action
+{
+
+    /**
+     * Error message, if any
+     */
+
+    var $msg = null;
+
+    var $content = null;
+    var $to = null;
+    var $other = null;
+
+    /**
+     * Title of the page
+     *
+     * Note that this usually doesn't get called unless something went wrong
+     *
+     * @return string page title
+     */
+
+    function title()
+    {
+        // TRANS: Page title for new direct message page.
+        return _('New message');
+    }
+
+    /**
+     * Handle input, produce output
+     *
+     * @param array $args $_REQUEST contents
+     *
+     * @return void
+     */
+
+    function handle($args)
+    {
+        parent::handle($args);
+
+        if (!common_logged_in()) {
+            // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
+            $this->clientError(_('Not logged in.'), 403);
+        } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+            $this->saveNewMessage();
+        } else {
+            $this->showForm();
+        }
+    }
+
+    function prepare($args)
+    {
+        parent::prepare($args);
+
+        $user = common_current_user();
+
+        if (!$user) {
+            /* Go log in, and then come back. */
+            common_set_returnto($_SERVER['REQUEST_URI']);
+            common_redirect(common_local_url('login'));
+            return false;
+        }
+
+        $this->content = $this->trimmed('content');
+        $this->to = $this->trimmed('to');
+
+        if ($this->to) {
+
+            $this->other = User::staticGet('id', $this->to);
+
+            if (!$this->other) {
+                // TRANS: Client error displayed trying to send a direct message to a non-existing user.
+                $this->clientError(_('No such user.'), 404);
+                return false;
+            }
+
+            if (!$user->mutuallySubscribed($this->other)) {
+                // TRANS: Client error displayed trying to send a direct message to a user while sender and
+                // TRANS: receiver are not subscribed to each other.
+                $this->clientError(_('You cannot send a message to this user.'), 404);
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    function saveNewMessage()
+    {
+        // CSRF protection
+
+        $token = $this->trimmed('token');
+        if (!$token || $token != common_session_token()) {
+            // TRANS: Client error displayed when the session token does not match or is not given.
+            $this->showForm(_('There was a problem with your session token. ' .
+                'Try again, please.'));
+            return;
+        }
+
+        $user = common_current_user();
+        assert($user); // XXX: maybe an error instead...
+
+        if (!$this->content) {
+            // TRANS: Form validator error displayed trying to send a direct message without content.
+            $this->showForm(_('No content!'));
+            return;
+        } else {
+            $content_shortened = $user->shortenLinks($this->content);
+
+            if (Message::contentTooLong($content_shortened)) {
+                // TRANS: Form validation error displayed when message content is too long.
+                // TRANS: %d is the maximum number of characters for a message.
+                $this->showForm(sprintf(_m('That\'s too long. Maximum message size is %d character.',
+                                           'That\'s too long. Maximum message size is %d characters.',
+                                           Message::maxContent()),
+                                        Message::maxContent()));
+                return;
+            }
+        }
+
+        if (!$this->other) {
+            // TRANS: Form validation error displayed trying to send a direct message without specifying a recipient.
+            $this->showForm(_('No recipient specified.'));
+            return;
+        } else if (!$user->mutuallySubscribed($this->other)) {
+            // TRANS: Client error displayed trying to send a direct message to a user while sender and
+            // TRANS: receiver are not subscribed to each other.
+            $this->clientError(_('You cannot send a message to this user.'), 404);
+            return;
+        } else if ($user->id == $this->other->id) {
+            // TRANS: Client error displayed trying to send a direct message to self.
+            $this->clientError(_('Do not send a message to yourself; ' .
+                'just say it to yourself quietly instead.'), 403);
+            return;
+        }
+
+        $message = Message::saveNew($user->id, $this->other->id, $this->content, 'web');
+
+        if (is_string($message)) {
+            $this->showForm($message);
+            return;
+        }
+
+        $message->notify();
+
+        if ($this->boolean('ajax')) {
+            $this->startHTML('text/xml;charset=utf-8');
+            $this->elementStart('head');
+            // TRANS: Page title after sending a direct message.
+            $this->element('title', null, _('Message sent'));
+            $this->elementEnd('head');
+            $this->elementStart('body');
+            $this->element('p', array('id' => 'command_result'),
+                // TRANS: Confirmation text after sending a direct message.
+                // TRANS: %s is the direct message recipient.
+                sprintf(_('Direct message to %s sent.'),
+                    $this->other->nickname));
+            $this->elementEnd('body');
+            $this->elementEnd('html');
+        } else {
+            $url = common_local_url('outbox',
+                array('nickname' => $user->nickname));
+            common_redirect($url, 303);
+        }
+    }
+
+    /**
+     * Show an Ajax-y error message
+     *
+     * Goes back to the browser, where it's shown in a popup.
+     *
+     * @param string $msg Message to show
+     *
+     * @return void
+     */
+
+    function ajaxErrorMsg($msg)
+    {
+        $this->startHTML('text/xml;charset=utf-8', true);
+        $this->elementStart('head');
+        // TRANS: Page title after an AJAX error occurred on the "send direct message" page.
+        $this->element('title', null, _('Ajax Error'));
+        $this->elementEnd('head');
+        $this->elementStart('body');
+        $this->element('p', array('id' => 'error'), $msg);
+        $this->elementEnd('body');
+        $this->elementEnd('html');
+    }
+
+    function showForm($msg = null)
+    {
+        if ($msg && $this->boolean('ajax')) {
+            $this->ajaxErrorMsg($msg);
+            return;
+        }
+
+        $this->msg = $msg;
+        if ($this->trimmed('ajax')) {
+            header('Content-Type: text/xml;charset=utf-8');
+            $this->xw->startDocument('1.0', 'UTF-8');
+            $this->elementStart('html');
+            $this->elementStart('head');
+            // TRANS: Page title on page for sending a direct message.
+            $this->element('title', null, _('New message'));
+            $this->elementEnd('head');
+            $this->elementStart('body');
+            $this->showNoticeForm();
+            $this->elementEnd('body');
+            $this->endHTML();
+        }
+        else {
+            $this->showPage();
+        }
+    }
+
+    function showPageNotice()
+    {
+        if ($this->msg) {
+            $this->element('p', 'error', $this->msg);
+        }
+    }
+
+    // Do nothing (override)
+
+    function showNoticeForm()
+    {
+        $message_form = new MessageForm($this, $this->other, $this->content);
+        $message_form->show();
+    }
 }