Converted direct messaging actions to new uiredesign

actions/inbox.php

@@ -46,48 +46,41 @@ 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
+     * @return string page title
-     * @param int  $page current page
-     *
-     * @return string localised title of the page
-     *
-     * @see MailboxAction::getTitle()
      */
     
-    function getTitle($user, $page)
+    function title()
     {        
-        if ($page > 1) {
+        if ($this->page > 1) {
-            $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page);
+            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;
@@ -97,15 +90,13 @@ class InboxAction extends MailboxAction
     }
 
     /**
-     * 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
+     * @return Profile The profile that matches the message
-     *
-     * @see MailboxAction::getMessageProfile()
      */
 
     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
      */

actions/newmessage.php

@@ -1,9 +1,12 @@
 <?php
-/*
+/**
- * Laconica - a distributed open-source microblogging tool
+ * Laconica, the distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
  *
- * 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__);
+                common_debug("mb_strlen(\$content) = " . 
-                $this->show_form(_('That\'s too long. Max message size is 140 chars.'));
+                    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');
         
@@ -122,20 +169,14 @@ class NewmessageAction extends Action
             return;
         }        
         
-        common_show_header(_('New message'), null,
+        $this->msg = $msg;
-                           array($content, $user, $other),
-                           array($this, 'show_top'));
         
-        if ($msg) {
+        $this->showPage();
-            $this->element('p', array('id'=>'error'), $msg);
-        }
-        
-        common_show_footer();
     }
     
     function notify($from, $to, $message)
     {
         mail_notify_message($message, $from, $to);
-        # XXX: Jabber, SMS notifications... probably queued
+        // XXX: Jabber, SMS notifications... probably queued
     }
 }

actions/outbox.php

@@ -47,24 +47,19 @@ 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
+     * @return string page title
-     * @param int  $page current page
-     *
-     * @return string localised title of the page
-     *
-     * @see MailboxAction::getTitle()
      */
 
-    function getTitle($user, $page)
+    function title()
     {
-        if ($page > 1) {
+        if ($this->page > 1) {
-            $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page);
+            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;
     }
 
     /**
@@ -72,21 +67,19 @@ class OutboxAction extends MailboxAction
      *
      * 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;

lib/mailbox.php

@@ -49,6 +49,23 @@ define('MESSAGES_PER_PAGE', 20);
 
 class MailboxAction extends PersonalAction
 {
+    var $page = null;
+
+    function prepare($args) 
+    {
+        parent::prepare($args);
+
+        $nickname   = common_canonical_nickname($this->arg('nickname'));
+        $this->user = User::staticGet('nickname', $nickname);
+        $this->page = $this->trimmed('page');
+
+        if (!$this->page) {
+            $this->page = 1;
+        }
+
+        return true;
+    }
+
     /**
      * output page based on arguments
      *
@@ -61,134 +78,42 @@ class MailboxAction extends PersonalAction
     {
         parent::handle($args);
 
-        $nickname = common_canonical_nickname($this->arg('nickname'));
+        if (!$this->user) {
-
+            $this->clientError(_('No such user.'), 404);
-        $user = User::staticGet('nickname', $nickname);
-
-        if (!$user) {
-            $this->client_error(_('No such user.'), 404);
             return;
         }
 
         $cur = common_current_user();
 
-        if (!$cur || $cur->id != $user->id) {
+        if (!$cur || $cur->id != $this->user->id) {
-            $this->client_error(_('Only the user can read their own mailboxes.'),
+            $this->clientError(_('Only the user can read their own mailboxes.'),
-                                403);
+                403);
             return;
         }
 
-        $profile = $user->getProfile();
+        $this->showPage();
-
-        if (!$profile) {
-            $this->server_error(_('User has no profile.'));
-            return;
-        }
-
-        $page = $this->trimmed('page');
-
-        if (!$page) {
-            $page = 1;
-        }
-
-        $this->showPage($user, $page);
     }
 
-    /**
+    function showLocalNav()
-     * returns the title of the page
-     *
-     * @param User $user current user
-     * @param int  $page current page
-     *
-     * @return string localised title of the page
-     */
-
-    function getTitle($user, $page)
     {
-        return '';
+        $nav = new PersonalGroupNav($this);
+        $nav->show();
     }
 
-    /**
+    function showNoticeForm()
-     * instructions for using this page
-     *
-     * @return string localised instructions for using the page
-     */
-
-    function getInstructions()
     {
-        return '';
+        $message_form = new MessageForm($this);
+        $message_form->show();
     }
 
-    /**
+    function showContent()
-     * do structured output for the "instructions" are of the page
-     *
-     * @return void
-     */
-
-    function showTop()
     {
-        $cur = common_current_user();
+        $message = $this->getMessages();
-
-        common_message_form(null, $cur, null);
-
-        $this->views_menu();
-    }
-
-    /**
-     * show a full page of output
-     *
-     * @param User $user The current user
-     * @param int  $page The page the user is on
-     *
-     * @return void
-     */
-
-    function showPage($user, $page)
-    {
-        common_show_header($this->getTitle($user, $page),
-                           null, null,
-                           array($this, 'showTop'));
-
-        $this->showBox($user, $page);
-
-        common_show_footer();
-    }
-
-    /**
-     * retrieve the messages appropriate for this mailbox
-     *
-     * 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
-     */
-
-    function getMessages($user, $page)
-    {
-        return null;
-    }
-
-    /**
-     * show the messages for a mailbox in list format
-     *
-     * Includes the pagination links (before, after).
-     *
-     * @param User $user The current user
-     * @param int  $page The page the user is on
-     *
-     * @return void
-     */
-
-    function showBox($user, $page)
-    {
-        $message = $this->getMessages($user, $page);
 
         if ($message) {
 
             $cnt = 0;
-            common_element_start('ul', array('id' => 'messages'));
+            $this->elementStart('ul', array('id' => 'messages'));
 
             while ($message->fetch() && $cnt <= MESSAGES_PER_PAGE) {
                 $cnt++;
@@ -200,17 +125,22 @@ class MailboxAction extends PersonalAction
                 $this->showMessage($message);
             }
 
-            common_element_end('ul');
+            $this->elementEnd('ul');
 
-            common_pagination($page > 1, $cnt > MESSAGES_PER_PAGE,
+            $this->pagination($this->page > 1, $cnt > MESSAGES_PER_PAGE,
-                              $page, $this->trimmed('action'),
+                              $this->page, $this->trimmed('action'),
-                              array('nickname' => $user->nickname));
+                              array('nickname' => $this->user->nickname));
 
             $message->free();
             unset($message);
         }
     }
 
+    function getMessages()
+    {
+        return null;
+    }
+
     /**
      * returns the profile we want to show with the message
      *
@@ -229,6 +159,9 @@ class MailboxAction extends PersonalAction
     /**
      * show a single message in the list format
      *
+     * XXX: This needs to be extracted out into a MessageList similar
+     * to NoticeList.
+     *
      * @param Message $message the message to show
      *
      * @return void
@@ -236,14 +169,14 @@ class MailboxAction extends PersonalAction
 
     function showMessage($message)
     {
-        common_element_start('li', array('class' => 'message_single',
+        $this->elementStart('li', array('class' => 'message_single',
                                          'id' => 'message-' . $message->id));
 
         $profile = $this->getMessageProfile($message);
 
         $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
-        common_element_start('a', array('href' => $profile->profileurl));
+        $this->elementStart('a', array('href' => $profile->profileurl));
-        common_element('img', array('src' => ($avatar) ?
+        $this->element('img', array('src' => ($avatar) ?
                                     common_avatar_display_url($avatar) :
                                     common_default_avatar(AVATAR_STREAM_SIZE),
                                     'class' => 'avatar stream',
@@ -252,14 +185,14 @@ class MailboxAction extends PersonalAction
                                     'alt' =>
                                     ($profile->fullname) ? $profile->fullname :
                                     $profile->nickname));
-        common_element_end('a');
+        $this->elementEnd('a');
-        common_element('a', array('href' => $profile->profileurl,
+        $this->element('a', array('href' => $profile->profileurl,
                                   'class' => 'nickname'),
                        $profile->nickname);
         // FIXME: URL, image, video, audio
-        common_element_start('p', array('class' => 'content'));
+        $this->elementStart('p', array('class' => 'content'));
-        common_raw($message->rendered);
+        $this->raw($message->rendered);
-        common_element_end('p');
+        $this->elementEnd('p');
 
         $messageurl = common_local_url('showmessage',
                                        array('message' => $message->id));
@@ -269,18 +202,72 @@ class MailboxAction extends PersonalAction
             preg_match('/^http/', $message->uri)) {
             $messageurl = $message->uri;
         }
-        common_element_start('p', 'time');
+        $this->elementStart('p', 'time');
-        common_element('a', array('class' => 'permalink',
+        $this->element('a', array('class' => 'permalink',
                                   'href' => $messageurl,
                                   'title' => common_exact_date($message->created)),
                        common_date_string($message->created));
         if ($message->source) {
-            common_text(_(' from '));
+            $this->text(_(' from '));
-            $this->source_link($message->source);
+            $this->showSource($message->source);
         }
 
-        common_element_end('p');
+        $this->elementEnd('p');
 
-        common_element_end('li');
+        $this->elementEnd('li');
     }
+
+    /**
+     * Show the page notice
+     *
+     * Shows instructions for the page
+     *
+     * @return void
+     */
+
+    function showPageNotice()
+    {
+        $instr  = $this->getInstructions();
+        $output = common_markup_to_html($instr);
+
+        $this->elementStart('div', 'instructions');
+        $this->raw($output);
+        $this->elementEnd('div');
+    }
+
+    /**
+     * Show the source of the message
+     *
+     * Returns either the name (and link) of the API client that posted the notice,
+     * or one of other other channels.
+     *
+     * @param string $source the source of the message 
+     *
+     * @return void
+     */
+
+    function showSource($source) 
+    {
+        $source_name = _($source);
+        switch ($source) {
+        case 'web':
+        case 'xmpp':
+        case 'mail':
+        case 'omb':
+        case 'api':
+            $this->element('span', 'noticesource', $source_name);
+            break;
+        default:
+            $ns = Notice_source::staticGet($source);
+            if ($ns) {
+                $this->element('a', array('href' => $ns->url),
+                               $ns->name);
+            } else {
+                $this->element('span', 'noticesource', $source_name);
+            }
+            break;
+        }
+        return;
+    }
+
 }

lib/personal.php

@@ -1,9 +1,12 @@
 <?php
-/*
+/**
- * Laconica - a distributed open-source microblogging tool
+ * Laconica, the distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
  *
- * This program is free software: you can redistribute it and/or modify
+ * User profile page
+ *
+ * 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,16 +18,44 @@
  *
  * 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    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);
+}
+
+/**
+ * Base class for user profile page
+ *
+ * @category Personal
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@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 PersonalAction extends Action
 {
+
+    var $user = null;
+
+    function isReadOnly()
+    {
+         return true;
+    }
+
     function handle($args)
     {
         parent::handle($args);
-        common_set_returnto($this->self_url());
+        common_set_returnto($this->selfUrl());
     }
 
 }