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
56 * What to filter the search results by
70 * How to order search results, ascending or descending
86 * @return string Title of the page
90 // @fixme: This looks kinda gross
92 if ($this->filter == 'all') {
93 if ($this->page != 1) {
94 return(sprintf(_m('User Directory, page %d'), $this->page));
96 return _m('User directory');
97 } else if ($this->page == 1) {
99 _m('User directory - %s'),
100 strtoupper($this->filter)
104 _m('User directory - %s, page %d'),
105 strtoupper($this->filter),
112 * Instructions for use
114 * @return instructions for use
116 function getInstructions()
118 // TRANS: %%site.name%% is the name of the StatusNet site.
120 'Search for people on %%site.name%% by their name, '
121 . 'location, or interests. Separate the terms by spaces; '
122 . ' they must be 3 characters or more.'
127 * Is this page read-only?
129 * @return boolean true
131 function isReadOnly($args)
137 * Take arguments for running
139 * @param array $args $_REQUEST args
141 * @return boolean success flag
143 function prepare($args)
145 parent::prepare($args);
147 $this->page = ($this->arg('page')) ? ($this->arg('page') + 0) : 1;
148 $this->filter = $this->arg('filter', 'all');
149 $this->reverse = $this->boolean('reverse');
150 $this->q = $this->trimmed('q');
151 $this->sort = $this->arg('sort', 'nickname');
153 common_set_returnto($this->selfUrl());
163 * @param array $args $_REQUEST args; handled in prepare()
167 function handle($args)
169 parent::handle($args);
174 * Show the page notice
176 * Shows instructions for the page
180 function showPageNotice()
182 $instr = $this->getInstructions();
183 $output = common_markup_to_html($instr);
185 $this->elementStart('div', 'instructions');
187 $this->elementEnd('div');
193 * This page is part of the public group, so show that.
197 function showLocalNav()
199 $nav = new PublicGroupNav($this);
206 * Shows the list of popular notices
210 function showContent()
214 $this->elementStart('div', array('id' => 'user_directory'));
216 $alphaNav = new AlphaNav($this, true, array('All'));
220 $profile = $this->getUsers();
223 if (!empty($profile)) {
224 $profileList = new SortableSubscriptionList(
226 common_current_user(),
230 $cnt = $profileList->show();
234 $this->showEmptyListMessage();
239 if (isset($this->q)) {
240 $args['q'] = $this->q;
242 $args['filter'] = $this->filter;
247 $cnt > PROFILES_PER_PAGE,
253 $this->elementEnd('div');
257 function showForm($error=null)
263 'id' => 'form_search',
264 'class' => 'form_settings',
265 'action' => common_local_url('userdirectory')
269 $this->elementStart('fieldset');
271 $this->element('legend', null, _('Search site'));
272 $this->elementStart('ul', 'form_data');
273 $this->elementStart('li');
275 $this->input('q', _('Keyword(s)'), $this->q);
277 $this->submit('search', _m('BUTTON','Search'));
278 $this->elementEnd('li');
279 $this->elementEnd('ul');
280 $this->elementEnd('fieldset');
281 $this->elementEnd('form');
285 * Get users filtered by the current filter, sort key,
286 * sort order, and page
290 $profile = new Profile();
292 $offset = ($this->page - 1) * PROFILES_PER_PAGE;
293 $limit = PROFILES_PER_PAGE + 1;
295 if (isset($this->q)) {
296 // User is searching via query
297 $search_engine = $profile->getSearchEngine('profile');
299 $mode = 'reverse_chron';
301 if ($this->sort == 'nickname') {
302 if ($this->reverse) {
303 $mode = 'nickname_desc';
305 $mode = 'nickname_asc';
308 if ($this->reverse) {
313 $search_engine->set_sort_mode($mode);
314 $search_engine->limit($offset, $limit);
315 $search_engine->query($this->q);
319 // User is browsing via AlphaNav
320 $sort = $this->getSortKey();
321 $sql = 'SELECT profile.* FROM profile, user WHERE profile.id = user.id';
323 if ($this->filter != 'all') {
325 ' AND LEFT(LOWER(profile.nickname), 1) = \'%s\'',
331 ' ORDER BY profile.%s %s, profile.nickname ASC LIMIT %d, %d',
333 $this->reverse ? 'DESC' : 'ASC',
338 $profile->query($sql);
345 * Filter the sort parameter
347 * @return string a column name for sorting
349 function getSortKey()
351 switch ($this->sort) {
364 * Show a nice message when there's no search results
366 function showEmptyListMessage()
368 if (!empty($this->filter) && ($this->filter != 'all')) {
373 _m('No users starting with %s'),
378 $this->element('p', 'error', _('No results.'));
379 $message = _m(<<<E_O_T
380 * Make sure all words are spelled correctly.
381 * Try different keywords.
382 * Try more general keywords.
383 * Try fewer keywords.
386 $this->elementStart('div', 'help instructions');
387 $this->raw(common_markup_to_html($message));
388 $this->elementEnd('div');