Converted direct messaging actions to new uiredesign

3 files changed, 115 insertions, 90 deletions

diff --git a/actions/inbox.php b/actions/inbox.php
index da27814a6..b553ab26c 100644
--- a/actions/inbox.php
+++ b/actions/inbox.php
@@ -46,66 +46,57 @@ require_once INSTALLDIR.'/lib/mailbox.php';
 
 class InboxAction extends MailboxAction
 {
+    
     /**
-     * returns the title of the page
+     * Title of the page
      *
-     * @param User $user current user
-     * @param int  $page current page
-     *
-     * @return string localised title of the page
-     *
-     * @see MailboxAction::getTitle()
+     * @return string page title
      */
-
-    function getTitle($user, $page)
-    {
-        if ($page > 1) {
-            $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page);
+    
+    function title()
+    {        
+        if ($this->page > 1) {
+            return sprintf(_("Inbox for %s - page %d"), $this->user->nickname,
+                $this->page);
         } else {
-            $title = sprintf(_("Inbox for %s"), $user->nickname);
+            return sprintf(_("Inbox for %s"), $this->user->nickname);
         }
-        return $title;
     }
 
     /**
-     * retrieve the messages for this user and this page
+     * Retrieve the messages for this user and this page
      *
      * Does a query for the right messages
-     *
-     * @param User $user The current user
-     * @param int  $page The page the user is on
-     *
+     *  
      * @return Message data object with stream for messages
      *
      * @see MailboxAction::getMessages()
      */
 
-    function getMessages($user, $page)
+    function getMessages()
     {
         $message = new Message();
 
-        $message->to_profile = $user->id;
-
+        $message->to_profile = $this->user->id;
         $message->orderBy('created DESC, id DESC');
-        $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1);
+        $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
+            MESSAGES_PER_PAGE + 1);
 
         if ($message->find()) {
             return $message;
-        } else {
+        } else {            
             return null;
         }
     }
 
     /**
-     * returns the profile we want to show with the message
+     * Returns the profile we want to show with the message
      *
-     * For inboxes, we show the sender.
+     * For inboxes, we show the sender; for outboxes, the recipient.
      *
      * @param Message $message The message to get the profile for
      *
-     * @return Profile The profile of the message sender
-     *
-     * @see MailboxAction::getMessageProfile()
+     * @return Profile The profile that matches the message
      */
 
     function getMessageProfile($message)
@@ -114,7 +105,7 @@ class InboxAction extends MailboxAction
     }
 
     /**
-     * instructions for using this page
+     * Instructions for using this page
      *
      * @return string localised instructions for using the page
      */
diff --git a/actions/newmessage.php b/actions/newmessage.php
index 510a5f8f3..aa94f8c4f 100644
--- a/actions/newmessage.php
+++ b/actions/newmessage.php
@@ -1,9 +1,12 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Laconica, the distributed open-source microblogging tool
  *
- * This program is free software: you can redistribute it and/or modify
+ * Handler for posting new notices
+ *
+ * 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.
@@ -15,13 +18,63 @@
  *
  * 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   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @author    Zach Copley <zach@controlyourself.ca>
+ * @author    Sarven Capadisli <csarven@controlyourself.ca>
+ * @copyright 2008-2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
  */
+ 
+if (!defined('LACONICA')) { 
+    exit(1); 
+}
 
-if (!defined('LACONICA')) { exit(1); }
+/**
+ * Action for posting new direct messages
+ *
+ * @category Personal
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Zach Copley <zach@controlyourself.ca>
+ * @author   Sarven Capadisli <csarven@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ */
 
 class NewmessageAction extends Action
 {
     
+    /**
+     * Error message, if any
+     */
+
+    var $msg = null;
+
+    /**
+     * Title of the page
+     *
+     * Note that this usually doesn't get called unless something went wrong
+     *
+     * @return string page title
+     */
+     
+    function title()
+    {
+        return _('New message');
+    }
+    
+    /**
+     * Handle input, produce output
+     *
+     * @param array $args $_REQUEST contents
+     *
+     * @return void
+     */
+    
     function handle($args)
     {
         parent::handle($args);
@@ -29,38 +82,42 @@ class NewmessageAction extends Action
         if (!common_logged_in()) {
             $this->clientError(_('Not logged in.'), 403);
         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            $this->save_new_message();
+            $this->saveNewMessage();
         } else {
-            $this->show_form();
+            $this->showForm();
         }
     }
 
-    function save_new_message()
+    function saveNewMessage()
     {
         $user = common_current_user();
-        assert($user); # XXX: maybe an error instead...
+        assert($user); // XXX: maybe an error instead...
 
-        # CSRF protection
+        // CSRF protection
         
         $token = $this->trimmed('token');
         if (!$token || $token != common_session_token()) {
-            $this->show_form(_('There was a problem with your session token. Try again, please.'));
+            $this->showForm(_('There was a problem with your session token. ' .
+                'Try again, please.'));
             return;
         }
         
         $content = $this->trimmed('content');
-        $to = $this->trimmed('to');
+        $to      = $this->trimmed('to');
         
         if (!$content) {
-            $this->show_form(_('No content!'));
+            $this->showForm(_('No content!'));
             return;
         } else {
             $content_shortened = common_shorten_links($content);
 
             if (mb_strlen($content_shortened) > 140) {
                 common_debug("Content = '$content_shortened'", __FILE__);
-                common_debug("mb_strlen(\$content) = " . mb_strlen($content_shortened), __FILE__);
-                $this->show_form(_('That\'s too long. Max message size is 140 chars.'));
+                common_debug("mb_strlen(\$content) = " . 
+                    mb_strlen($content_shortened),
+                    __FILE__);
+                $this->showForm(_('That\'s too long. ' .
+                    'Max message size is 140 chars.'));
                 return;
             }
         }
@@ -68,20 +125,21 @@ class NewmessageAction extends Action
         $other = User::staticGet('id', $to);
         
         if (!$other) {
-            $this->show_form(_('No recipient specified.'));
+            $this->showForm(_('No recipient specified.'));
             return;
         } else if (!$user->mutuallySubscribed($other)) {
             $this->clientError(_('You can\'t send a message to this user.'), 404);
             return;
         } else if ($user->id == $other->id) {
-            $this->clientError(_('Don\'t send a message to yourself; just say it to yourself quietly instead.'), 403);
+            $this->clientError(_('Don\'t send a message to yourself; ' .
+                'just say it to yourself quietly instead.'), 403);
             return;
         }
         
         $message = Message::saveNew($user->id, $other->id, $content, 'web');
         
         if (is_string($message)) {
-            $this->show_form($message);
+            $this->showForm($message);
             return;
         }
 
@@ -92,21 +150,10 @@ class NewmessageAction extends Action
         common_redirect($url, 303);
     }
 
-    function show_top($params)
+    function showForm($msg = null)
     {
-
-        list($content, $user, $to) = $params;
-        
-        assert(!is_null($user));
-
-        common_message_form($content, $user, $to);
-    }
-
-    function show_form($msg=null)
-    {
-        
         $content = $this->trimmed('content');
-        $user = common_current_user();
+        $user    = common_current_user();
 
         $to = $this->trimmed('to');
         
@@ -120,22 +167,16 @@ class NewmessageAction extends Action
         if (!$user->mutuallySubscribed($other)) {
             $this->clientError(_('You can\'t send a message to this user.'), 404);
             return;
-        }
+        }        
         
-        common_show_header(_('New message'), null,
-                           array($content, $user, $other),
-                           array($this, 'show_top'));
-        
-        if ($msg) {
-            $this->element('p', array('id'=>'error'), $msg);
-        }
+        $this->msg = $msg;
         
-        common_show_footer();
+        $this->showPage();
     }
     
     function notify($from, $to, $message)
     {
         mail_notify_message($message, $from, $to);
-        # XXX: Jabber, SMS notifications... probably queued
+        // XXX: Jabber, SMS notifications... probably queued
     }
 }
diff --git a/actions/outbox.php b/actions/outbox.php
index 9fb6dbf9f..c8d7f2812 100644
--- a/actions/outbox.php
+++ b/actions/outbox.php
@@ -47,46 +47,39 @@ require_once INSTALLDIR.'/lib/mailbox.php';
 class OutboxAction extends MailboxAction
 {
     /**
-     * returns the title of the page
+     * Title of the page
      *
-     * @param User $user current user
-     * @param int  $page current page
-     *
-     * @return string localised title of the page
-     *
-     * @see MailboxAction::getTitle()
+     * @return string page title
      */
 
-    function getTitle($user, $page)
+    function title()
     {
-        if ($page > 1) {
-            $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page);
+        if ($this->page > 1) {
+            return sprintf(_("Outbox for %s - page %d"),
+                $this->user->nickname, $page);
         } else {
-            $title = sprintf(_("Outbox for %s"), $user->nickname);
+            return sprintf(_("Outbox for %s"), $this->user->nickname);
         }
-        return $title;
     }
 
     /**
      * retrieve the messages for this user and this page
      *
      * Does a query for the right messages
-     *
-     * @param User $user The current user
-     * @param int  $page The page the user is on
-     *
+     *  
      * @return Message data object with stream for messages
      *
      * @see MailboxAction::getMessages()
      */
 
-    function getMessages($user, $page)
+    function getMessages()
     {
         $message = new Message();
 
-        $message->from_profile = $user->id;
+        $message->from_profile = $this->user->id;
         $message->orderBy('created DESC, id DESC');
-        $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1);
+        $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
+            MESSAGES_PER_PAGE + 1);
 
         if ($message->find()) {
             return $message;