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