plugins/GroupPrivateMessage/actions/groupinbox.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * List of private messages to this group
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  GroupPrivateMessage
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Show a list of private messages to this group
  39  *
  40  * @category  GroupPrivateMessage
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class GroupinboxAction extends GroupAction
  48 {
  49     var $gm;
  50
  51     /**
  52      * For initializing members of the class.
  53      *
  54      * @param array $argarray misc. arguments
  55      *
  56      * @return boolean true
  57      */
  58     function prepare($argarray)
  59     {
  60         parent::prepare($argarray);
  61
  62         $cur = common_current_user();
  63
  64         if (empty($cur)) {
  65             // TRANS: Client exception thrown when trying to view group inbox while not logged in.
  66             throw new ClientException(_m('Only for logged-in users.'), 403);
  67         }
  68
  69         $nicknameArg = $this->trimmed('nickname');
  70
  71         $nickname = common_canonical_nickname($nicknameArg);
  72
  73         if ($nickname != $nicknameArg) {
  74             $url = common_local_url('groupinbox', array('nickname' => $nickname));
  75             common_redirect($url);
  76         }
  77
  78         $localGroup = Local_group::getKV('nickname', $nickname);
  79
  80         if (empty($localGroup)) {
  81             // TRANS: Client exception thrown when trying to view group inbox for non-existing group.
  82             throw new ClientException(_m('No such group.'), 404);
  83         }
  84
  85         $this->group = User_group::getKV('id', $localGroup->group_id);
  86
  87         if (empty($this->group)) {
  88             // TRANS: Client exception thrown when trying to view group inbox for non-existing group.
  89             throw new ClientException(_m('No such group.'), 404);
  90         }
  91
  92         if (!$cur->isMember($this->group)) {
  93             // TRANS: Client exception thrown when trying to view group inbox while not a member.
  94             throw new ClientException(_m('Only for members.'), 403);
  95         }
  96
  97         $this->page = $this->trimmed('page');
  98
  99         if (!$this->page) {
 100             $this->page = 1;
 101         }
 102
 103         $this->gm = Group_message::forGroup($this->group,
 104                                             ($this->page - 1) * MESSAGES_PER_PAGE,
 105                                             MESSAGES_PER_PAGE + 1);
 106         return true;
 107     }
 108
 109     function showLocalNav()
 110     {
 111         $nav = new GroupNav($this, $this->group);
 112         $nav->show();
 113     }
 114
 115     function showNoticeForm()
 116     {
 117         $form = new GroupMessageForm($this, $this->group);
 118         $form->show();
 119     }
 120
 121     function showContent()
 122     {
 123         $gml = new GroupMessageList($this, $this->gm);
 124         $cnt = $gml->show();
 125
 126         if ($cnt == 0) {
 127             // TRANS: Text of group inbox if no private messages were sent to it.
 128             $this->element('p', 'guide', _m('This group has not received any private messages.'));
 129         }
 130         $this->pagination($this->page > 1,
 131                           $cnt > MESSAGES_PER_PAGE,
 132                           $this->page,
 133                           'groupinbox',
 134                           array('nickname' => $this->group->nickname));
 135     }
 136
 137     /**
 138      * Handler method
 139      *
 140      * @param array $argarray is ignored since it's now passed in in prepare()
 141      *
 142      * @return void
 143      */
 144     function handle($argarray=null)
 145     {
 146         $this->showPage();
 147     }
 148
 149     /**
 150      * Return true if read only.
 151      *
 152      * MAY override
 153      *
 154      * @param array $args other arguments
 155      *
 156      * @return boolean is read only action?
 157      */
 158     function isReadOnly($args)
 159     {
 160         return true;
 161     }
 162
 163     /**
 164      * Title of the page
 165      *
 166      * @return string page title, with page number
 167      */
 168     function title()
 169     {
 170         $base = $this->group->getFancyName();
 171
 172         if ($this->page == 1) {
 173             // TRANS: Title of inbox for group %s.
 174             return sprintf(_m('%s group inbox'), $base);
 175         } else {
 176             // TRANS: Page title for any but first group page.
 177             // TRANS: %1$s is a group name, $2$s is a page number.
 178             return sprintf(_m('%1$s group inbox, page %2$d'),
 179                            $base,
 180                            $this->page);
 181         }
 182     }
 183
 184     /**
 185      * Show the page notice
 186      *
 187      * Shows instructions for the page
 188      *
 189      * @return void
 190      */
 191     function showPageNotice()
 192     {
 193         $instr  = $this->getInstructions();
 194         $output = common_markup_to_html($instr);
 195
 196         $this->elementStart('div', 'instructions');
 197         $this->raw($output);
 198         $this->elementEnd('div');
 199     }
 200
 201     /**
 202      * Instructions for using this page
 203      *
 204      * @return string localised instructions for using the page
 205      */
 206     function getInstructions()
 207     {
 208         // TRANS: Instructions for user inbox page.
 209         return _m('This is the group inbox, which lists all incoming private messages for this group.');
 210     }
 211 }