3 * StatusNet, the distributed open-source microblogging tool
5 * Output a user directory
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.
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.
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/>.
24 * @author Zach Copley <zach@status.net>
25 * @copyright 2011 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET'))
35 require_once INSTALLDIR . '/lib/publicgroupnav.php';
42 * @author Zach Copley <zach@status.net>
43 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
44 * @link http://status.net/
46 class UserdirectoryAction extends Action
49 * @var $page integer the page we're on
51 protected $page = null;
54 * @var $filter string what to filter the search results by
56 protected $filter = null;
61 * @return string Title of the page
65 // @fixme: This looks kinda gross
67 if ($this->filter == 'all') {
68 if ($this->page != 1) {
69 return(sprintf(_m('All users, page %d'), $this->page));
71 return _m('All users');
74 if ($this->page == 1) {
76 _m('Users with nicknames beginning with %s'),
81 _m('Users with nicknames starting with %s, page %d'),
89 * Instructions for use
91 * @return instructions for use
93 function getInstructions()
95 return _('User directory');
99 * Is this page read-only?
101 * @return boolean true
103 function isReadOnly($args)
109 * Take arguments for running
111 * @param array $args $_REQUEST args
113 * @return boolean success flag
115 * @todo move queries from showContent() to here
117 function prepare($args)
119 parent::prepare($args);
121 $this->page = ($this->arg('page')) ? ($this->arg('page') + 0) : 1;
122 $this->filter = $this->arg('filter') ? $this->arg('filter') : 'all';
123 $this->sort = $this->arg('sort');
124 $this->order = $this->boolean('asc'); // ascending or decending
126 common_set_returnto($this->selfUrl());
136 * @param array $args $_REQUEST args; handled in prepare()
140 function handle($args)
142 parent::handle($args);
147 * Show the page notice
149 * Shows instructions for the page
153 function showPageNotice()
155 $instr = $this->getInstructions();
156 $output = common_markup_to_html($instr);
158 $this->elementStart('div', 'instructions');
160 $this->elementEnd('div');
166 * This page is part of the public group, so show that.
170 function showLocalNav()
172 $nav = new PublicGroupNav($this);
179 * Shows the list of popular notices
183 function showContent()
185 // XXX Need search bar
187 $this->elementStart('div', array('id' => 'user_directory'));
189 $alphaNav = new AlphaNav($this, true, array('All'));
192 // XXX Maybe use a more specialized version of ProfileList here
194 $profile = $this->getUsers();
197 if (!empty($profile)) {
198 $profileList = new SortableSubscriptionList(
200 common_current_user(),
204 $cnt = $profileList->show();
207 $this->showEmptyListMessage();
213 $cnt > PROFILES_PER_PAGE,
216 array('filter' => $this->filter)
219 $this->elementEnd('div');
224 * Get users filtered by the current filter and page
228 $offset = ($this->page - 1) * PROFILES_PER_PAGE;
229 $limit = PROFILES_PER_PAGE + 1;
231 $profile = new Profile();
233 // XXX Any chance of SQL injection here?
235 if ($this->filter != 'all') {
237 sprintf('LEFT(lower(nickname), 1) = \'%s\'', $this->filter)
241 $sort = $this->getSortKey();
242 $order = ($this->order) ? 'ASC' : 'DESC';
244 $profile->orderBy("$sort $order, nickname");
245 $profile->limit($limit, $offset);
253 * Filter the sort parameter
255 * @return string a column name for sorting
257 function getSortKey()
259 switch ($this->sort) {
272 * Show a nice message when there's no search results
274 function showEmptyListMessage()
276 $message = sprintf(_m('No users starting with %s'), $this->filter);
278 $this->elementStart('div', 'guide');
279 $this->raw(common_markup_to_html($message));
280 $this->elementEnd('div');