MediaWiki  1.29.2
UserRightsProxy.php
Go to the documentation of this file.
1 <?php
24 
30 
41  private function __construct( $db, $database, $name, $id ) {
42  $this->db = $db;
43  $this->database = $database;
44  $this->name = $name;
45  $this->id = intval( $id );
46  $this->newOptions = [];
47  }
48 
54  public function getDBName() {
55  return $this->database;
56  }
57 
64  public static function validDatabase( $database ) {
66  return in_array( $database, $wgLocalDatabases );
67  }
68 
77  public static function whoIs( $database, $id, $ignoreInvalidDB = false ) {
78  $user = self::newFromId( $database, $id, $ignoreInvalidDB );
79  if ( $user ) {
80  return $user->name;
81  } else {
82  return false;
83  }
84  }
85 
94  public static function newFromId( $database, $id, $ignoreInvalidDB = false ) {
95  return self::newFromLookup( $database, 'user_id', intval( $id ), $ignoreInvalidDB );
96  }
97 
106  public static function newFromName( $database, $name, $ignoreInvalidDB = false ) {
107  return self::newFromLookup( $database, 'user_name', $name, $ignoreInvalidDB );
108  }
109 
117  private static function newFromLookup( $database, $field, $value, $ignoreInvalidDB = false ) {
119  // If the user table is shared, perform the user query on it,
120  // but don't pass it to the UserRightsProxy,
121  // as user rights are normally not shared.
122  if ( $wgSharedDB && in_array( 'user', $wgSharedTables ) ) {
123  $userdb = self::getDB( $wgSharedDB, $ignoreInvalidDB );
124  } else {
125  $userdb = self::getDB( $database, $ignoreInvalidDB );
126  }
127 
128  $db = self::getDB( $database, $ignoreInvalidDB );
129 
130  if ( $db && $userdb ) {
131  $row = $userdb->selectRow( 'user',
132  [ 'user_id', 'user_name' ],
133  [ $field => $value ],
134  __METHOD__ );
135 
136  if ( $row !== false ) {
137  return new UserRightsProxy( $db, $database,
138  $row->user_name,
139  intval( $row->user_id ) );
140  }
141  }
142  return null;
143  }
144 
153  public static function getDB( $database, $ignoreInvalidDB = false ) {
155  if ( $ignoreInvalidDB || self::validDatabase( $database ) ) {
156  if ( $database == $wgDBname ) {
157  // Hmm... this shouldn't happen though. :)
158  return wfGetDB( DB_MASTER );
159  } else {
160  return wfGetDB( DB_MASTER, [], $database );
161  }
162  }
163  return null;
164  }
165 
169  public function getId() {
170  return $this->id;
171  }
172 
176  public function isAnon() {
177  return $this->getId() == 0;
178  }
179 
185  public function getName() {
186  return $this->name . '@' . $this->database;
187  }
188 
194  public function getUserPage() {
195  return Title::makeTitle( NS_USER, $this->getName() );
196  }
197 
202  function getGroups() {
203  return array_keys( self::getGroupMemberships() );
204  }
205 
212  function getGroupMemberships() {
213  return UserGroupMembership::getMembershipsForUser( $this->id, $this->db );
214  }
215 
223  function addGroup( $group, $expiry = null ) {
224  if ( $expiry ) {
225  $expiry = wfTimestamp( TS_MW, $expiry );
226  }
227 
228  $ugm = new UserGroupMembership( $this->id, $group, $expiry );
229  return $ugm->insert( true, $this->db );
230  }
231 
238  function removeGroup( $group ) {
239  $ugm = UserGroupMembership::getMembership( $this->id, $group, $this->db );
240  if ( !$ugm ) {
241  return false;
242  }
243  return $ugm->delete( $this->db );
244  }
245 
251  public function setOption( $option, $value ) {
252  $this->newOptions[$option] = $value;
253  }
254 
255  public function saveSettings() {
256  $rows = [];
257  foreach ( $this->newOptions as $option => $value ) {
258  $rows[] = [
259  'up_user' => $this->id,
260  'up_property' => $option,
261  'up_value' => $value,
262  ];
263  }
264  $this->db->replace( 'user_properties',
265  [ [ 'up_user', 'up_property' ] ],
266  $rows, __METHOD__
267  );
268  $this->invalidateCache();
269  }
270 
274  function invalidateCache() {
275  $this->db->update(
276  'user',
277  [ 'user_touched' => $this->db->timestamp() ],
278  [ 'user_id' => $this->id ],
279  __METHOD__
280  );
281 
282  $wikiId = $this->db->getWikiID();
283  $userId = $this->id;
284  $this->db->onTransactionPreCommitOrIdle(
285  function () use ( $wikiId, $userId ) {
286  User::purge( $wikiId, $userId );
287  },
288  __METHOD__
289  );
290  }
291 }
$wgSharedTables
$wgSharedTables
Definition: DefaultSettings.php:1887
$wgSharedDB
$wgSharedDB
Shared database for multiple wikis.
Definition: DefaultSettings.php:1877
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1994
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
UserRightsProxy\saveSettings
saveSettings()
Definition: UserRightsProxy.php:255
$user
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 account $user
Definition: hooks.txt:246
UserRightsProxy\getGroupMemberships
getGroupMemberships()
Replaces User::getGroupMemberships()
Definition: UserRightsProxy.php:212
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
UserRightsProxy\getId
getId()
Definition: UserRightsProxy.php:169
UserRightsProxy
Cut-down copy of User interface for local-interwiki-database user rights manipulation.
Definition: UserRightsProxy.php:29
php
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
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
UserGroupMembership\getMembershipsForUser
static getMembershipsForUser( $userId, IDatabase $db=null)
Returns UserGroupMembership objects for all the groups a user currently belongs to.
Definition: UserGroupMembership.php:281
$wgDBname
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
UserRightsProxy\setOption
setOption( $option, $value)
Replaces User::setOption()
Definition: UserRightsProxy.php:251
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3060
UserRightsProxy\invalidateCache
invalidateCache()
Replaces User::touchUser()
Definition: UserRightsProxy.php:274
UserRightsProxy\getUserPage
getUserPage()
Same as User::getUserPage()
Definition: UserRightsProxy.php:194
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:514
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
DB_MASTER
const DB_MASTER
Definition: defines.php:26
UserRightsProxy\newFromId
static newFromId( $database, $id, $ignoreInvalidDB=false)
Factory function; get a remote user entry by ID number.
Definition: UserRightsProxy.php:94
$wgLocalDatabases
$wgLocalDatabases
Other wikis on this site, can be administered from a single developer account.
Definition: DefaultSettings.php:2047
database
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
UserRightsProxy\newFromLookup
static newFromLookup( $database, $field, $value, $ignoreInvalidDB=false)
Definition: UserRightsProxy.php:117
$value
$value
Definition: styleTest.css.php:45
UserRightsProxy\validDatabase
static validDatabase( $database)
Confirm the selected database name is a valid local interwiki database name.
Definition: UserRightsProxy.php:64
UserRightsProxy\removeGroup
removeGroup( $group)
Replaces User::removeGroup()
Definition: UserRightsProxy.php:238
UserRightsProxy\getName
getName()
Same as User::getName()
Definition: UserRightsProxy.php:185
UserRightsProxy\newFromName
static newFromName( $database, $name, $ignoreInvalidDB=false)
Factory function; get a remote user entry by name.
Definition: UserRightsProxy.php:106
UserRightsProxy\__construct
__construct( $db, $database, $name, $id)
Constructor.
Definition: UserRightsProxy.php:41
as
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
NS_USER
const NS_USER
Definition: Defines.php:64
UserRightsProxy\getDB
static getDB( $database, $ignoreInvalidDB=false)
Open a database connection to work on for the requested user.
Definition: UserRightsProxy.php:153
UserRightsProxy\isAnon
isAnon()
Definition: UserRightsProxy.php:176
name
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
UserGroupMembership\getMembership
static getMembership( $userId, $group, IDatabase $db=null)
Returns a UserGroupMembership object that pertains to the given user and group, or false if the user ...
Definition: UserGroupMembership.php:312
UserRightsProxy\whoIs
static whoIs( $database, $id, $ignoreInvalidDB=false)
Same as User::whoIs()
Definition: UserRightsProxy.php:77
UserRightsProxy\getDBName
getDBName()
Accessor for $this->database.
Definition: UserRightsProxy.php:54
User\purge
static purge( $wikiId, $userId)
Definition: User.php:460
UserRightsProxy\addGroup
addGroup( $group, $expiry=null)
Replaces User::addGroup()
Definition: UserRightsProxy.php:223
UserGroupMembership
Represents a "user group membership" – a specific instance of a user belonging to a group.
Definition: UserGroupMembership.php:36
UserRightsProxy\getGroups
getGroups()
Replaces User::getUserGroups()
Definition: UserRightsProxy.php:202