plugins/GroupPrivateMessage/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             return false;
  77         }
  78
  79         $localGroup = Local_group::getKV('nickname', $nickname);
  80
  81         if (empty($localGroup)) {
  82             // TRANS: Client exception thrown when trying to view group inbox for non-existing group.
  83             throw new ClientException(_m('No such group.'), 404);
  84         }
  85
  86         $this->group = User_group::getKV('id', $localGroup->group_id);
  87
  88         if (empty($this->group)) {
  89             // TRANS: Client exception thrown when trying to view group inbox for non-existing group.
  90             throw new ClientException(_m('No such group.'), 404);
  91         }
  92
  93         if (!$cur->isMember($this->group)) {
  94             // TRANS: Client exception thrown when trying to view group inbox while not a member.
  95             throw new ClientException(_m('Only for members.'), 403);
  96         }
  97
  98         $this->page = $this->trimmed('page');
  99
 100         if (!$this->page) {
 101             $this->page = 1;
 102         }
 103
 104         $this->gm = Group_message::forGroup($this->group,
 105                                             ($this->page - 1) * MESSAGES_PER_PAGE,
 106                                             MESSAGES_PER_PAGE + 1);
 107         return true;
 108     }
 109
 110     function showLocalNav()
 111     {
 112         $nav = new GroupNav($this, $this->group);
 113         $nav->show();
 114     }
 115
 116     function showNoticeForm()
 117     {
 118         $form = new GroupMessageForm($this, $this->group);
 119         $form->show();
 120     }
 121
 122     function showContent()
 123     {
 124         $gml = new GroupMessageList($this, $this->gm);
 125         $cnt = $gml->show();
 126
 127         if ($cnt == 0) {
 128             // TRANS: Text of group inbox if no private messages were sent to it.
 129             $this->element('p', 'guide', _m('This group has not received any private messages.'));
 130         }
 131         $this->pagination($this->page > 1,
 132                           $cnt > MESSAGES_PER_PAGE,
 133                           $this->page,
 134                           'groupinbox',
 135                           array('nickname' => $this->group->nickname));
 136     }
 137
 138     /**
 139      * Handler method
 140      *
 141      * @param array $argarray is ignored since it's now passed in in prepare()
 142      *
 143      * @return void
 144      */
 145     function handle($argarray=null)
 146     {
 147         $this->showPage();
 148     }
 149
 150     /**
 151      * Return true if read only.
 152      *
 153      * MAY override
 154      *
 155      * @param array $args other arguments
 156      *
 157      * @return boolean is read only action?
 158      */
 159     function isReadOnly($args)
 160     {
 161         return true;
 162     }
 163
 164     /**
 165      * Title of the page
 166      *
 167      * @return string page title, with page number
 168      */
 169     function title()
 170     {
 171         $base = $this->group->getFancyName();
 172
 173         if ($this->page == 1) {
 174             // TRANS: Title of inbox for group %s.
 175             return sprintf(_m('%s group inbox'), $base);
 176         } else {
 177             // TRANS: Page title for any but first group page.
 178             // TRANS: %1$s is a group name, $2$s is a page number.
 179             return sprintf(_m('%1$s group inbox, page %2$d'),
 180                            $base,
 181                            $this->page);
 182         }
 183     }
 184
 185     /**
 186      * Show the page notice
 187      *
 188      * Shows instructions for the page
 189      *
 190      * @return void
 191      */
 192     function showPageNotice()
 193     {
 194         $instr  = $this->getInstructions();
 195         $output = common_markup_to_html($instr);
 196
 197         $this->elementStart('div', 'instructions');
 198         $this->raw($output);
 199         $this->elementEnd('div');
 200     }
 201
 202     /**
 203      * Instructions for using this page
 204      *
 205      * @return string localised instructions for using the page
 206      */
 207     function getInstructions()
 208     {
 209         // TRANS: Instructions for user inbox page.
 210         return _m('This is the group inbox, which lists all incoming private messages for this group.');
 211     }
 212 }