X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fshowmessage.php;h=d737f85d3a0b2ba3b4bb0531f5344f023c5eb4ed;hb=e36399974e6ccd1ee3e53bfffa3c34edaf8bd488;hp=d13e9f671fc32f284ab9d3b0cc1b79efd9a984eb;hpb=4b0cf99e56f965e10eeb8b8b19e7b405bda49eaf;p=quix0rs-gnu-social.git

diff --git a/actions/showmessage.php b/actions/showmessage.php
index d13e9f671f..d737f85d3a 100644
--- a/actions/showmessage.php
+++ b/actions/showmessage.php
@@ -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
+ * Show a single message
+ *
+ * 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,94 +18,168 @@
  *
  * 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>
+ * @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('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
 
-if (!defined('LACONICA')) { exit(1); }
-
-require_once(INSTALLDIR.'/lib/mailbox.php');
+require_once INSTALLDIR.'/lib/mailbox.php';
 
+/**
+ * Show a single message
+ *
+ * // XXX: It is totally weird how this works!
+ *
+ * @category Personal
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@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 ShowmessageAction extends MailboxAction
 {
+    /**
+     * Message object to show
+     */
+    var $message = null;
 
-    function handle($args)
+    /**
+     * The current user
+     */
+
+    var $user = null;
+
+    /**
+     * Load attributes based on database arguments
+     *
+     * Loads all the DB stuff
+     *
+     * @param array $args $_REQUEST array
+     *
+     * @return success flag
+     */
+    function prepare($args)
     {
+        parent::prepare($args);
 
-        Action::handle($args);
+        $this->page = 1;
 
-        $message = $this->get_message();
+        $id            = $this->trimmed('message');
+        $this->message = Message::staticGet('id', $id);
 
-        if (!$message) {
+        if (!$this->message) {
+            // TRANS: Client error displayed requesting a single message that does not exist.
             $this->clientError(_('No such message.'), 404);
-            return;
+            return false;
         }
-        
-        $cur = common_current_user();
-        
-        if ($cur && ($cur->id == $message->from_profile || $cur->id == $message->to_profile)) {
-            $this->show_page($cur, 1);
+
+        $this->user = common_current_user();
+
+        return true;
+    }
+
+    function handle($args)
+    {
+        Action::handle($args);
+
+        if ($this->user && ($this->user->id == $this->message->from_profile ||
+            $this->user->id == $this->message->to_profile)) {
+                $this->showPage();
         } else {
-            $this->clientError(_('Only the sender and recipient may read this message.'), 403);
+            // TRANS: Client error displayed requesting a single direct message the requesting user was not a party in.
+            $this->clientError(_('Only the sender and recipient ' .
+                'may read this message.'), 403);
             return;
         }
     }
-    
-    function get_message()
-    {
-        $id = $this->trimmed('message');
-        $message = Message::staticGet('id', $id);
-        return $message;
-    }
-    
-    function get_title($user, $page)
+
+    function title()
     {
-        $message = $this->get_message();
-        if (!$message) {
-            return null;
-        }
-        
-        if ($user->id == $message->from_profile) {
-            $to = $message->getTo();
-            $title = sprintf(_("Message to %1\$s on %2\$s"),
+        if ($this->user->id == $this->message->from_profile) {
+            $to = $this->message->getTo();
+            // @todo FIXME: Might be nice if the timestamp could be localised.
+            // TRANS: Page title for single direct message display when viewing user is the sender.
+            // TRANS: %1$s is the addressed user's nickname, $2$s is a timestamp.
+            return sprintf(_('Message to %1$s on %2$s'),
                              $to->nickname,
-                             common_exact_date($message->created));
-        } else if ($user->id == $message->to_profile) {
-            $from = $message->getFrom();
-            $title = sprintf(_("Message from %1\$s on %2\$s"),
+                             common_exact_date($this->message->created));
+        } else if ($this->user->id == $this->message->to_profile) {
+            $from = $this->message->getFrom();
+            // @todo FIXME: Might be nice if the timestamp could be localised.
+            // TRANS: Page title for single message display.
+            // TRANS: %1$s is the sending user's nickname, $2$s is a timestamp.
+            return sprintf(_('Message from %1$s on %2$s'),
                              $from->nickname,
-                             common_exact_date($message->created));
+                             common_exact_date($this->message->created));
         }
-        return $title;
     }
 
-    function get_messages($user, $page)
+    function getMessages()
     {
-        $message = new Message();
-        $message->id = $this->trimmed('message');
+        $message     = new Message();
+        $message->id = $this->message->id;
         $message->find();
         return $message;
     }
-    
-    function get_message_profile($message)
+
+    function getMessageProfile()
     {
-        $user = common_current_user();
-        if ($user->id == $message->from_profile) {
-            return $message->getTo();
-        } else if ($user->id == $message->to_profile) {
-            return $message->getFrom();
+        if ($this->user->id == $this->message->from_profile) {
+            return $this->message->getTo();
+        } else if ($this->user->id == $this->message->to_profile) {
+            return $this->message->getFrom();
         } else {
-            # This shouldn't happen
+            // This shouldn't happen
             return null;
         }
     }
-    
-    function get_instructions()
+
+    /**
+     * Don't show local navigation
+     *
+     * @return void
+     */
+    function showLocalNavBlock()
+    {
+    }
+
+    /**
+     * Don't show page notice
+     *
+     * @return void
+     */
+    function showPageNoticeBlock()
+    {
+    }
+
+    /**
+     * Don't show aside
+     *
+     * @return void
+     */
+    function showAside()
+    {
+    }
+
+    /**
+     * Don't show any instructions
+     *
+     * @return string
+     */
+    function getInstructions()
     {
         return '';
     }
-    
-    function views_menu()
+
+    function isReadOnly($args)
     {
-        return;
+        return true;
     }
 }
-    
\ No newline at end of file