MediaWiki  1.28.0
UserRightsProxy.php
Go to the documentation of this file.
1 <?php
28 
39  private function __construct( $db, $database, $name, $id ) {
40  $this->db = $db;
41  $this->database = $database;
42  $this->name = $name;
43  $this->id = intval( $id );
44  $this->newOptions = [];
45  }
46 
52  public function getDBName() {
53  return $this->database;
54  }
55 
62  public static function validDatabase( $database ) {
64  return in_array( $database, $wgLocalDatabases );
65  }
66 
75  public static function whoIs( $database, $id, $ignoreInvalidDB = false ) {
76  $user = self::newFromId( $database, $id, $ignoreInvalidDB );
77  if ( $user ) {
78  return $user->name;
79  } else {
80  return false;
81  }
82  }
83 
92  public static function newFromId( $database, $id, $ignoreInvalidDB = false ) {
93  return self::newFromLookup( $database, 'user_id', intval( $id ), $ignoreInvalidDB );
94  }
95 
104  public static function newFromName( $database, $name, $ignoreInvalidDB = false ) {
105  return self::newFromLookup( $database, 'user_name', $name, $ignoreInvalidDB );
106  }
107 
115  private static function newFromLookup( $database, $field, $value, $ignoreInvalidDB = false ) {
117  // If the user table is shared, perform the user query on it,
118  // but don't pass it to the UserRightsProxy,
119  // as user rights are normally not shared.
120  if ( $wgSharedDB && in_array( 'user', $wgSharedTables ) ) {
121  $userdb = self::getDB( $wgSharedDB, $ignoreInvalidDB );
122  } else {
123  $userdb = self::getDB( $database, $ignoreInvalidDB );
124  }
125 
126  $db = self::getDB( $database, $ignoreInvalidDB );
127 
128  if ( $db && $userdb ) {
129  $row = $userdb->selectRow( 'user',
130  [ 'user_id', 'user_name' ],
131  [ $field => $value ],
132  __METHOD__ );
133 
134  if ( $row !== false ) {
135  return new UserRightsProxy( $db, $database,
136  $row->user_name,
137  intval( $row->user_id ) );
138  }
139  }
140  return null;
141  }
142 
151  public static function getDB( $database, $ignoreInvalidDB = false ) {
153  if ( $ignoreInvalidDB || self::validDatabase( $database ) ) {
154  if ( $database == $wgDBname ) {
155  // Hmm... this shouldn't happen though. :)
156  return wfGetDB( DB_MASTER );
157  } else {
158  return wfGetDB( DB_MASTER, [], $database );
159  }
160  }
161  return null;
162  }
163 
167  public function getId() {
168  return $this->id;
169  }
170 
174  public function isAnon() {
175  return $this->getId() == 0;
176  }
177 
183  public function getName() {
184  return $this->name . '@' . $this->database;
185  }
186 
192  public function getUserPage() {
193  return Title::makeTitle( NS_USER, $this->getName() );
194  }
195 
200  function getGroups() {
201  $res = $this->db->select( 'user_groups',
202  [ 'ug_group' ],
203  [ 'ug_user' => $this->id ],
204  __METHOD__ );
205  $groups = [];
206  foreach ( $res as $row ) {
207  $groups[] = $row->ug_group;
208  }
209  return $groups;
210  }
211 
218  function addGroup( $group ) {
219  $this->db->insert( 'user_groups',
220  [
221  'ug_user' => $this->id,
222  'ug_group' => $group,
223  ],
224  __METHOD__,
225  [ 'IGNORE' ] );
226 
227  return true;
228  }
229 
236  function removeGroup( $group ) {
237  $this->db->delete( 'user_groups',
238  [
239  'ug_user' => $this->id,
240  'ug_group' => $group,
241  ],
242  __METHOD__ );
243 
244  return true;
245  }
246 
252  public function setOption( $option, $value ) {
253  $this->newOptions[$option] = $value;
254  }
255 
256  public function saveSettings() {
257  $rows = [];
258  foreach ( $this->newOptions as $option => $value ) {
259  $rows[] = [
260  'up_user' => $this->id,
261  'up_property' => $option,
262  'up_value' => $value,
263  ];
264  }
265  $this->db->replace( 'user_properties',
266  [ [ 'up_user', 'up_property' ] ],
267  $rows, __METHOD__
268  );
269  $this->invalidateCache();
270  }
271 
275  function invalidateCache() {
276  $this->db->update(
277  'user',
278  [ 'user_touched' => $this->db->timestamp() ],
279  [ 'user_id' => $this->id ],
280  __METHOD__
281  );
282 
283  $wikiId = $this->db->getWikiID();
284  $userId = $this->id;
285  $this->db->onTransactionPreCommitOrIdle(
286  function () use ( $wikiId, $userId ) {
287  User::purge( $wikiId, $userId );
288  },
289  __METHOD__
290  );
291  }
292 }
static newFromId($database, $id, $ignoreInvalidDB=false)
Factory function; get a remote user entry by ID number.
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
getName()
Same as User::getName()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Cut-down copy of User interface for local-interwiki-database user rights manipulation.
static whoIs($database, $id, $ignoreInvalidDB=false)
Same as User::whoIs()
getDBName()
Accessor for $this->database.
static newFromName($database, $name, $ignoreInvalidDB=false)
Factory function; get a remote user entry by name.
$value
$wgSharedTables
static newFromLookup($database, $field, $value, $ignoreInvalidDB=false)
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
const DB_MASTER
Definition: defines.php:23
removeGroup($group)
Replaces User::removeUserGroup()
static purge($wikiId, $userId)
Definition: User.php:451
static validDatabase($database)
Confirm the selected database name is a valid local interwiki database name.
getUserPage()
Same as User::getUserPage()
setOption($option, $value)
Replaces User::setOption()
$res
Definition: database.txt:21
invalidateCache()
Replaces User::touchUser()
$wgSharedDB
Shared database for multiple wikis.
__construct($db, $database, $name, $id)
Constructor.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the database
Definition: design.txt:12
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static getDB($database, $ignoreInvalidDB=false)
Open a database connection to work on for the requested user.
$wgLocalDatabases
Other wikis on this site, can be administered from a single developer account.
getGroups()
Replaces User::getUserGroups()
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
controlled by $wgMainCacheType controlled by $wgParserCacheType controlled by $wgMessageCacheType If you set CACHE_NONE to one of the three control default value for MediaWiki still create a but requests to it are no ops and we always fall through to the database If the cache daemon can t be it should also disable itself fairly smoothly By $wgMemc is used but when it is $parserMemc or $messageMemc this is mentioned $wgDBname
Definition: memcached.txt:96
addGroup($group)
Replaces User::addUserGroup()
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300