actions/inbox.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * action handler for message inbox
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Message
  23  * @package   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @copyright 2008 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 if (!defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/mailbox.php';
  35
  36 /**
  37  * action handler for message inbox
  38  *
  39  * @category Message
  40  * @package  Laconica
  41  * @author   Evan Prodromou <evan@controlyourself.ca>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://laconi.ca/
  44  * @see      MailboxAction
  45  */
  46
  47 class InboxAction extends MailboxAction
  48 {
  49
  50     /**
  51      * Title of the page
  52      *
  53      * @return string page title
  54      */
  55
  56     function title()
  57     {
  58         if ($this->page > 1) {
  59             return sprintf(_("Inbox for %s - page %d"), $this->user->nickname,
  60                 $this->page);
  61         } else {
  62             return sprintf(_("Inbox for %s"), $this->user->nickname);
  63         }
  64     }
  65
  66     /**
  67      * Output document relationship links
  68      *
  69      * @return void
  70      */
  71     function showRelationshipLinks()
  72     {
  73         // Machine-readable pagination
  74         if ($this->page > 1) {
  75             $this->element('link', array('rel' => 'next',
  76                                          'href' => common_local_url('inbox',
  77                                                                     array('nickname' => $this->user->nickname,
  78                                                                           'page' => $this->page - 1)),
  79                                          'title' => _('Next Messages')));
  80         }
  81         $this->element('link', array('rel' => 'prev',
  82                                      'href' => common_local_url('inbox',
  83                                                                 array('nickname' => $this->user->nickname,
  84                                                                       'page' => $this->page + 1)),
  85                                      'title' => _('Previous Messages')));
  86     }
  87
  88     /**
  89      * Retrieve the messages for this user and this page
  90      *
  91      * Does a query for the right messages
  92      *
  93      * @return Message data object with stream for messages
  94      *
  95      * @see MailboxAction::getMessages()
  96      */
  97
  98     function getMessages()
  99     {
 100         $message = new Message();
 101
 102         $message->to_profile = $this->user->id;
 103         $message->orderBy('created DESC, id DESC');
 104         $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
 105             MESSAGES_PER_PAGE + 1);
 106
 107         if ($message->find()) {
 108             return $message;
 109         } else {
 110             return null;
 111         }
 112     }
 113
 114     /**
 115      * Returns the profile we want to show with the message
 116      *
 117      * For inboxes, we show the sender; for outboxes, the recipient.
 118      *
 119      * @param Message $message The message to get the profile for
 120      *
 121      * @return Profile The profile that matches the message
 122      */
 123
 124     function getMessageProfile($message)
 125     {
 126         return $message->getFrom();
 127     }
 128
 129     /**
 130      * Instructions for using this page
 131      *
 132      * @return string localised instructions for using the page
 133      */
 134
 135     function getInstructions()
 136     {
 137         return _('This is your inbox, which lists your incoming private messages.');
 138     }
 139 }