Completed
Branch master (8d5465)
by
unknown
31:25
created

LocalIdLookup::lookupUserNames()   B

Complexity

Conditions 5
Paths 5

Size

Total Lines 30
Code Lines 20

Duplication

Lines 30
Ratio 100 %

Importance

Changes 0
Metric Value
cc 5
eloc 20
nc 5
nop 3
dl 30
loc 30
rs 8.439
c 0
b 0
f 0
1
<?php
2
/**
3
 * A central user id lookup service implementation
4
 *
5
 * This program is free software; you can redistribute it and/or modify
6
 * it under the terms of the GNU General Public License as published by
7
 * the Free Software Foundation; either version 2 of the License, or
8
 * (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License along
16
 * with this program; if not, write to the Free Software Foundation, Inc.,
17
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18
 * http://www.gnu.org/copyleft/gpl.html
19
 *
20
 * @file
21
 */
22
23
/**
24
 * A CentralIdLookup provider that just uses local IDs. Useful if the wiki
25
 * isn't part of a cluster or you're using shared user tables.
26
 *
27
 * @note Shared user table support expects that all wikis involved have
28
 *  $wgSharedDB and $wgSharedTables set, and that all wikis involved in the
29
 *  sharing are listed in $wgLocalDatabases, and that no wikis not involved in
30
 *  the sharing are listed in $wgLocalDatabases.
31
 * @since 1.27
32
 */
33
class LocalIdLookup extends CentralIdLookup {
34
35
	public function isAttached( User $user, $wikiId = null ) {
36
		global $wgSharedDB, $wgSharedTables, $wgLocalDatabases;
37
38
		// If the user has no ID, it can't be attached
39
		if ( !$user->getId() ) {
40
			return false;
41
		}
42
43
		// Easy case, we're checking locally
44
		if ( $wikiId === null || $wikiId === wfWikiID() ) {
45
			return true;
46
		}
47
48
		// Assume that shared user tables are set up as described above, if
49
		// they're being used at all.
50
		return $wgSharedDB !== null &&
51
			in_array( 'user', $wgSharedTables, true ) &&
52
			in_array( $wikiId, $wgLocalDatabases, true );
53
	}
54
55 View Code Duplication
	public function lookupCentralIds(
56
		array $idToName, $audience = self::AUDIENCE_PUBLIC, $flags = self::READ_NORMAL
57
	) {
58
		if ( !$idToName ) {
59
			return [];
60
		}
61
62
		$audience = $this->checkAudience( $audience );
63
		list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
64
		$db = wfGetDB( $index );
65
66
		$tables = [ 'user' ];
67
		$fields = [ 'user_id', 'user_name' ];
68
		$where = [
69
			'user_id' => array_map( 'intval', array_keys( $idToName ) ),
70
		];
71
		$join = [];
72
		if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
73
			$tables[] = 'ipblocks';
74
			$join['ipblocks'] = [ 'LEFT JOIN', 'ipb_user=user_id' ];
75
			$fields[] = 'ipb_deleted';
76
		}
77
78
		$res = $db->select( $tables, $fields, $where, __METHOD__, $options, $join );
79
		foreach ( $res as $row ) {
0 ignored issues
show
Bug introduced by
The expression $res of type object<ResultWrapper>|boolean is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
80
			$idToName[$row->user_id] = empty( $row->ipb_deleted ) ? $row->user_name : '';
81
		}
82
83
		return $idToName;
84
	}
85
86 View Code Duplication
	public function lookupUserNames(
87
		array $nameToId, $audience = self::AUDIENCE_PUBLIC, $flags = self::READ_NORMAL
88
	) {
89
		if ( !$nameToId ) {
90
			return [];
91
		}
92
93
		$audience = $this->checkAudience( $audience );
94
		list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
95
		$db = wfGetDB( $index );
96
97
		$tables = [ 'user' ];
98
		$fields = [ 'user_id', 'user_name' ];
99
		$where = [
100
			'user_name' => array_map( 'strval', array_keys( $nameToId ) ),
101
		];
102
		$join = [];
103
		if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
104
			$tables[] = 'ipblocks';
105
			$join['ipblocks'] = [ 'LEFT JOIN', 'ipb_user=user_id' ];
106
			$where[] = 'ipb_deleted = 0 OR ipb_deleted IS NULL';
107
		}
108
109
		$res = $db->select( $tables, $fields, $where, __METHOD__, $options, $join );
110
		foreach ( $res as $row ) {
0 ignored issues
show
Bug introduced by
The expression $res of type object<ResultWrapper>|boolean is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
111
			$nameToId[$row->user_name] = (int)$row->user_id;
112
		}
113
114
		return $nameToId;
115
	}
116
}
117