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  */
  32 class LocalIdLookup extends CentralIdLookup {
  33
  34         public function isAttached( User $user, $wikiId = null ) {
  35                 global $wgSharedDB, $wgSharedTables, $wgLocalDatabases;
  36
  37                 // If the user has no ID, it can't be attached
  38                 if ( !$user->getId() ) {
  39                         return false;
  40                 }
  41
  42                 // Easy case, we're checking locally
  43                 if ( $wikiId === null || $wikiId === wfWikiID() ) {
  44                         return true;
  45                 }
  46
  47                 // Assume that shared user tables are set up as described above, if
  48                 // they're being used at all.
  49                 return $wgSharedDB !== null &&
  50                         in_array( 'user', $wgSharedTables, true ) &&
  51                         in_array( $wikiId, $wgLocalDatabases, true );
  52         }
  53
  54         public function lookupCentralIds(
  55                 array $idToName, $audience = self::AUDIENCE_PUBLIC, $flags = self::READ_NORMAL
  56         ) {
  57                 if ( !$idToName ) {
  58                         return array();
  59                 }
  60
  61                 $audience = $this->checkAudience( $audience );
  62                 $db = wfGetDB( ( $flags & self::READ_LATEST ) ? DB_MASTER : DB_SLAVE );
  63                 $options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
  64                         ? array( 'LOCK IN SHARE MODE' )
  65                         : array();
  66
  67                 $tables = array( 'user' );
  68                 $fields = array( 'user_id', 'user_name' );
  69                 $where = array(
  70                         'user_id' => array_map( 'intval', array_keys( $idToName ) ),
  71                 );
  72                 $join = array();
  73                 if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
  74                         $tables[] = 'ipblocks';
  75                         $join['ipblocks'] = array( 'LEFT JOIN', 'ipb_user=user_id' );
  76                         $fields[] = 'ipb_deleted';
  77                 }
  78
  79                 $res = $db->select( $tables, $fields, $where, __METHOD__, $options, $join );
  80                 foreach ( $res as $row ) {
  81                         $idToName[$row->user_id] = empty( $row->ipb_deleted ) ? $row->user_name : '';
  82                 }
  83
  84                 return $idToName;
  85         }
  86
  87         public function lookupUserNames(
  88                 array $nameToId, $audience = self::AUDIENCE_PUBLIC, $flags = self::READ_NORMAL
  89         ) {
  90                 if ( !$nameToId ) {
  91                         return array();
  92                 }
  93
  94                 $audience = $this->checkAudience( $audience );
  95                 $db = wfGetDB( ( $flags & self::READ_LATEST ) ? DB_MASTER : DB_SLAVE );
  96                 $options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
  97                         ? array( 'LOCK IN SHARE MODE' )
  98                         : array();
  99
 100                 $tables = array( 'user' );
 101                 $fields = array( 'user_id', 'user_name' );
 102                 $where = array(
 103                         'user_name' => array_map( 'strval', array_keys( $nameToId ) ),
 104                 );
 105                 $join = array();
 106                 if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
 107                         $tables[] = 'ipblocks';
 108                         $join['ipblocks'] = array( 'LEFT JOIN', 'ipb_user=user_id' );
 109                         $where[] = 'ipb_deleted = 0 OR ipb_deleted IS NULL';
 110                 }
 111
 112                 $res = $db->select( $tables, $fields, $where, __METHOD__, $options, $join );
 113                 foreach ( $res as $row ) {
 114                         $nameToId[$row->user_name] = (int)$row->user_id;
 115                 }
 116
 117                 return $nameToId;
 118         }
 119 }