includes/user/LocalIdLookup.php

   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         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                 $db = wfGetDB( ( $flags & self::READ_LATEST ) ? DB_MASTER : DB_SLAVE );
  64                 $options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
  65                         ? [ 'LOCK IN SHARE MODE' ]
  66                         : [];
  67
  68                 $tables = [ 'user' ];
  69                 $fields = [ 'user_id', 'user_name' ];
  70                 $where = [
  71                         'user_id' => array_map( 'intval', array_keys( $idToName ) ),
  72                 ];
  73                 $join = [];
  74                 if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
  75                         $tables[] = 'ipblocks';
  76                         $join['ipblocks'] = [ 'LEFT JOIN', 'ipb_user=user_id' ];
  77                         $fields[] = 'ipb_deleted';
  78                 }
  79
  80                 $res = $db->select( $tables, $fields, $where, __METHOD__, $options, $join );
  81                 foreach ( $res as $row ) {
  82                         $idToName[$row->user_id] = empty( $row->ipb_deleted ) ? $row->user_name : '';
  83                 }
  84
  85                 return $idToName;
  86         }
  87
  88         public function lookupUserNames(
  89                 array $nameToId, $audience = self::AUDIENCE_PUBLIC, $flags = self::READ_NORMAL
  90         ) {
  91                 if ( !$nameToId ) {
  92                         return [];
  93                 }
  94
  95                 $audience = $this->checkAudience( $audience );
  96                 $db = wfGetDB( ( $flags & self::READ_LATEST ) ? DB_MASTER : DB_SLAVE );
  97                 $options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
  98                         ? [ 'LOCK IN SHARE MODE' ]
  99                         : [];
 100
 101                 $tables = [ 'user' ];
 102                 $fields = [ 'user_id', 'user_name' ];
 103                 $where = [
 104                         'user_name' => array_map( 'strval', array_keys( $nameToId ) ),
 105                 ];
 106                 $join = [];
 107                 if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
 108                         $tables[] = 'ipblocks';
 109                         $join['ipblocks'] = [ 'LEFT JOIN', 'ipb_user=user_id' ];
 110                         $where[] = 'ipb_deleted = 0 OR ipb_deleted IS NULL';
 111                 }
 112
 113                 $res = $db->select( $tables, $fields, $where, __METHOD__, $options, $join );
 114                 foreach ( $res as $row ) {
 115                         $nameToId[$row->user_name] = (int)$row->user_id;
 116                 }
 117
 118                 return $nameToId;
 119         }
 120 }