gnu-social/plugins/Directory/actions/userdirectory.php

367 lines
10 KiB
PHP
Raw Normal View History

2011-03-02 03:35:20 +00:00
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Output a user directory
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Public
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @copyright 2011 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
2019-06-02 13:46:39 +01:00
if (!defined('GNUSOCIAL')) {
exit(1);
}
2011-03-02 03:35:20 +00:00
/**
* User directory
*
* @category Personal
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
class UserdirectoryAction extends ManagedAction
2011-03-02 03:35:20 +00:00
{
/**
2011-03-05 01:55:56 +00:00
* The page we're on
*
* @var integer
*/
public $page;
2011-03-02 03:35:20 +00:00
/**
* What to filter the search results by
2011-03-05 01:55:56 +00:00
*
* @var string
*/
public $filter;
/**
* Column to sort by
*
* @var string
*/
public $sort;
/**
* How to order search results, ascending or descending
*
* @var string
*/
public $reverse;
/**
* Query
*
* @var string
*/
public $q;
2011-03-02 03:35:20 +00:00
/**
* Title of the page
*
* @return string Title of the page
*/
2019-06-02 13:46:39 +01:00
public function title()
2011-03-02 03:35:20 +00:00
{
// @todo fixme: This looks kinda gross
2011-03-02 03:35:20 +00:00
if ($this->filter == 'all') {
2011-03-02 03:35:20 +00:00
if ($this->page != 1) {
// TRANS: Page title for user directory. %d is a page number.
return(sprintf(_m('User Directory, page %d'), $this->page));
2011-03-02 03:35:20 +00:00
}
// TRANS: Page title for user directory.
return _m('User directory');
2019-06-02 13:46:39 +01:00
} elseif ($this->page == 1) {
2011-03-02 03:35:20 +00:00
return sprintf(
// TRANS: Page title for user directory. %s is the applied filter.
_m('User directory - %s'),
strtoupper($this->filter)
2011-03-02 03:35:20 +00:00
);
} else {
return sprintf(
// TRANS: Page title for user directory.
// TRANS: %1$s is the applied filter, %2$d is a page number.
_m('User directory - %1$s, page %2$d'),
strtoupper($this->filter),
2011-03-02 03:35:20 +00:00
$this->page
);
}
}
/**
* Instructions for use
*
* @return instructions for use
*/
2019-06-02 13:46:39 +01:00
public function getInstructions()
2011-03-02 03:35:20 +00:00
{
// TRANS: %%site.name%% is the name of the StatusNet site.
return _m('Search for people on %%site.name%% by their name, '
2019-06-02 13:46:39 +01:00
. 'location, or interests. Separate the terms by spaces; '
. ' they must be 3 characters or more.');
2011-03-02 03:35:20 +00:00
}
/**
* Is this page read-only?
*
* @return boolean true
*/
2019-06-02 13:46:39 +01:00
public function isReadOnly($args)
2011-03-02 03:35:20 +00:00
{
return true;
}
protected function doPreparation()
2011-03-02 03:35:20 +00:00
{
$this->page = ($this->arg('page')) ? ($this->arg('page') + 0) : 1;
$this->filter = $this->arg('filter', 'all');
$this->reverse = $this->boolean('reverse');
$this->q = $this->trimmed('q');
$this->sort = $this->arg('sort', 'nickname');
2011-03-02 03:35:20 +00:00
common_set_returnto($this->selfUrl());
}
/**
* Show the page notice
*
* Shows instructions for the page
*
* @return void
*/
2019-06-02 13:46:39 +01:00
public function showPageNotice()
2011-03-02 03:35:20 +00:00
{
$instr = $this->getInstructions();
$output = common_markup_to_html($instr);
$this->elementStart('div', 'instructions');
$this->raw($output);
$this->elementEnd('div');
}
/**
* Content area
*
* Shows the list of popular notices
*
* @return void
*/
2019-06-02 13:46:39 +01:00
public function showContent()
2011-03-02 03:35:20 +00:00
{
$this->showForm();
2011-03-02 03:35:20 +00:00
2019-06-02 13:46:39 +01:00
$this->elementStart('div', ['id' => 'profile_directory']);
2019-06-02 13:46:39 +01:00
$alphaNav = new AlphaNav($this, false, false, ['0-9', 'All']);
2011-03-02 03:35:20 +00:00
$alphaNav->show();
$profile = null;
2011-03-02 03:35:20 +00:00
$profile = $this->getUsers();
$cnt = 0;
if (!empty($profile)) {
$profileList = new SortableSubscriptionList(
2011-03-02 03:35:20 +00:00
$profile,
common_current_user(),
$this
);
$cnt = $profileList->show();
$profile->free();
2011-03-02 03:35:20 +00:00
if (0 == $cnt) {
$this->showEmptyListMessage();
}
}
2019-06-02 13:46:39 +01:00
$args = [];
if (isset($this->q)) {
$args['q'] = $this->q;
} elseif (isset($this->filter) && $this->filter != 'all') {
$args['filter'] = $this->filter;
}
if (isset($this->sort)) {
$args['sort'] = $this->sort;
2019-06-02 13:46:39 +01:00
}
if (!empty($this->reverse)) {
$args['reverse'] = $this->reverse;
}
$this->pagination(
$this->page > 1,
$cnt > PROFILES_PER_PAGE,
$this->page,
'userdirectory',
$args
);
$this->elementEnd('div');
2011-03-02 03:35:20 +00:00
}
2019-06-02 13:46:39 +01:00
public function showForm($error=null)
{
2019-06-02 13:46:39 +01:00
$this->elementStart('form',
['method' => 'get',
'id' => 'form_search',
'class' => 'form_settings',
'action' => common_local_url('userdirectory')]);
$this->elementStart('fieldset');
// TRANS: Fieldset legend.
$this->element('legend', null, _m('Search site'));
$this->elementStart('ul', 'form_data');
$this->elementStart('li');
// TRANS: Field label for user directory filter.
$this->input('q', _m('Keyword(s)'), $this->q);
// TRANS: Button text.
2019-06-02 13:46:39 +01:00
$this->submit('search', _m('BUTTON', 'Search'));
$this->elementEnd('li');
$this->elementEnd('ul');
$this->elementEnd('fieldset');
$this->elementEnd('form');
}
2011-03-02 03:35:20 +00:00
/*
2011-03-05 01:55:56 +00:00
* Get users filtered by the current filter, sort key,
* sort order, and page
2011-03-02 03:35:20 +00:00
*/
2019-06-02 13:46:39 +01:00
public function getUsers()
2011-03-02 03:35:20 +00:00
{
$profile = new Profile();
// Comment this out or disable to get global profile searches
2019-06-02 13:46:39 +01:00
$profile->joinAdd(['id', 'user:id']);
2011-03-05 01:25:58 +00:00
$offset = ($this->page - 1) * PROFILES_PER_PAGE;
$limit = PROFILES_PER_PAGE + 1;
if (!empty($this->q)) {
2019-06-02 13:46:39 +01:00
// User is searching via query
$search_engine = $profile->getSearchEngine('profile');
$mode = 'reverse_chron';
if ($this->sort == 'nickname') {
if ($this->reverse) {
$mode = 'nickname_desc';
} else {
$mode = 'nickname_asc';
}
} else {
if ($this->reverse) {
$mode = 'chron';
}
}
$search_engine->set_sort_mode($mode);
$search_engine->limit($offset, $limit);
$search_engine->query($this->q);
$profile->find();
} else {
// User is browsing via AlphaNav
switch ($this->filter) {
2011-03-07 22:32:14 +00:00
case 'all':
// NOOP
break;
case '0-9':
$profile->whereAdd(sprintf('LEFT(%1$s.%2$s, 1) BETWEEN %3$s AND %4$s',
2019-06-02 13:46:39 +01:00
$profile->escapedTableName(),
'nickname',
$profile->_quote("0"),
$profile->_quote("9")));
2011-03-07 22:32:14 +00:00
break;
default:
$profile->whereAdd(sprintf('LEFT(LOWER(%1$s.%2$s), 1) = %3$s',
2019-06-02 13:46:39 +01:00
$profile->escapedTableName(),
'nickname',
$profile->_quote($this->filter)));
}
$order = sprintf('%1$s.%2$s %3$s, %1$s.%4$s ASC',
2019-06-02 13:46:39 +01:00
$profile->escapedTableName(),
$this->getSortKey('nickname'),
$this->reverse ? 'DESC' : 'ASC',
'nickname');
$profile->orderBy($order);
$profile->limit($offset, $limit);
$profile->find();
}
2011-03-02 03:35:20 +00:00
return $profile;
}
/**
* Filter the sort parameter
*
* @return string a column name for sorting
*/
2019-06-02 13:46:39 +01:00
public function getSortKey($def='nickname')
{
switch ($this->sort) {
case 'nickname':
case 'created':
return $this->sort;
default:
return 'nickname';
}
}
2011-03-02 03:35:20 +00:00
/**
* Show a nice message when there's no search results
*/
2019-06-02 13:46:39 +01:00
public function showEmptyListMessage()
2011-03-02 03:35:20 +00:00
{
if (!empty($this->filter) && ($this->filter != 'all')) {
2019-06-02 13:46:39 +01:00
$this->element('p',
'error',
sprintf(
// TRANS: Empty list message for user directory.
_m('No users starting with %s'),
$this->filter));
} else {
// TRANS: Empty list message for user directory.
$this->element('p', 'error', _m('No results.'));
// TRANS: Standard search suggestions shown when a search does not give any results.
$message = _m("* Make sure all words are spelled correctly.
* Try different keywords.
* Try more general keywords.
* Try fewer keywords.");
$message .= "\n";
$this->elementStart('div', 'help instructions');
$this->raw(common_markup_to_html($message));
$this->elementEnd('div');
}
2011-03-02 03:35:20 +00:00
}
}