1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<?php
/**
* Prefix search of user names.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\User;
use InvalidArgumentException;
use MediaWiki\Permissions\Authority;
use Wikimedia\Rdbms\ILoadBalancer;
/**
* Handles searching prefixes of user names
*
* @note There are two classes called UserNamePrefixSearch. You should use this first one, in
* namespace MediaWiki\User, which is a service. \UserNamePrefixSearch is a deprecated static wrapper
* that forwards to the global service.
*
* @since 1.36 as a service in the current namespace
* @author DannyS712
*/
class UserNamePrefixSearch {
/** @var string */
public const AUDIENCE_PUBLIC = 'public';
/** @var ILoadBalancer */
private $loadBalancer;
/** @var UserFactory */
private $userFactory;
/** @var UserNameUtils */
private $userNameUtils;
/**
* @param ILoadBalancer $loadBalancer
* @param UserFactory $userFactory
* @param UserNameUtils $userNameUtils
*/
public function __construct(
ILoadBalancer $loadBalancer,
UserFactory $userFactory,
UserNameUtils $userNameUtils
) {
$this->loadBalancer = $loadBalancer;
$this->userFactory = $userFactory;
$this->userNameUtils = $userNameUtils;
}
/**
* Do a prefix search of user names and return a list of matching user names.
*
* @param string|UserIdentity|Authority $audience Either AUDIENCE_PUBLIC or a user to
* show the search for, providing a UserIdentity is deprecated since 1.37
* @param string $search
* @param int $limit
* @param int $offset How many results to offset from the beginning
* @return string[]
* @throws InvalidArgumentException if $audience is invalid
*/
public function search( $audience, string $search, int $limit, int $offset = 0 ) : array {
if ( $audience instanceof UserIdentity && !( $audience instanceof Authority ) ) {
wfDeprecated( __METHOD__ . ' with a UserIdentity', '1.37' );
$audience = $this->userFactory->newFromUserIdentity( $audience );
}
if ( $audience !== self::AUDIENCE_PUBLIC &&
!( $audience instanceof Authority )
) {
throw new InvalidArgumentException(
'$audience must be AUDIENCE_PUBLIC or an Authority object'
);
}
// Invalid user names are treated as empty strings
$prefix = $this->userNameUtils->getCanonical( $search ) ?: '';
$dbr = $this->loadBalancer->getConnectionRef( DB_REPLICA );
$tables = [ 'user' ];
$conds = [ 'user_name ' . $dbr->buildLike( $prefix, $dbr->anyString() ) ];
$joinConds = [];
// Filter out hidden user names
if ( $audience === self::AUDIENCE_PUBLIC || !$audience->isAllowed( 'hideuser' ) ) {
$tables[] = 'ipblocks';
$conds['ipb_deleted'] = [ 0, null ];
$joinConds['ipblocks'] = [ 'LEFT JOIN', 'user_id=ipb_user' ];
}
$res = $dbr->selectFieldValues(
$tables,
'user_name',
$conds,
__METHOD__,
[
'LIMIT' => $limit,
'ORDER BY' => 'user_name',
'OFFSET' => $offset
],
$joinConds
);
return $res;
}
}
|
