3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2011, StatusNet, Inc.
6 * List of private messages to this group
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.
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.
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/>.
23 * @category GroupPrivateMessage
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/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * Show a list of private messages to this group
40 * @category GroupPrivateMessage
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/
47 class GroupinboxAction extends GroupAction
52 * For initializing members of the class.
54 * @param array $argarray misc. arguments
56 * @return boolean true
58 function prepare($argarray)
60 parent::prepare($argarray);
62 $cur = common_current_user();
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);
69 $nicknameArg = $this->trimmed('nickname');
71 $nickname = common_canonical_nickname($nicknameArg);
73 if ($nickname != $nicknameArg) {
74 $url = common_local_url('groupinbox', array('nickname' => $nickname));
75 common_redirect($url);
78 $localGroup = Local_group::getKV('nickname', $nickname);
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);
85 $this->group = User_group::getKV('id', $localGroup->group_id);
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);
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);
97 $this->page = $this->trimmed('page');
103 $this->gm = Group_message::forGroup($this->group,
104 ($this->page - 1) * MESSAGES_PER_PAGE,
105 MESSAGES_PER_PAGE + 1);
109 function showLocalNav()
111 $nav = new GroupNav($this, $this->group);
115 function showNoticeForm()
117 $form = new GroupMessageForm($this, $this->group);
121 function showContent()
123 $gml = new GroupMessageList($this, $this->gm);
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.'));
130 $this->pagination($this->page > 1,
131 $cnt > MESSAGES_PER_PAGE,
134 array('nickname' => $this->group->nickname));
140 * @param array $argarray is ignored since it's now passed in in prepare()
144 function handle($argarray=null)
150 * Return true if read only.
154 * @param array $args other arguments
156 * @return boolean is read only action?
158 function isReadOnly($args)
166 * @return string page title, with page number
170 $base = $this->group->getFancyName();
172 if ($this->page == 1) {
173 // TRANS: Title of inbox for group %s.
174 return sprintf(_m('%s group inbox'), $base);
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'),
185 * Show the page notice
187 * Shows instructions for the page
191 function showPageNotice()
193 $instr = $this->getInstructions();
194 $output = common_markup_to_html($instr);
196 $this->elementStart('div', 'instructions');
198 $this->elementEnd('div');
202 * Instructions for using this page
204 * @return string localised instructions for using the page
206 function getInstructions()
208 // TRANS: Instructions for user inbox page.
209 return _m('This is the group inbox, which lists all incoming private messages for this group.');