MediaWiki  REL1_31
UserRightsProxy.php
Go to the documentation of this file.
1 <?php
24 
30 
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  return array_keys( self::getGroupMemberships() );
202  }
203 
210  function getGroupMemberships() {
211  return UserGroupMembership::getMembershipsForUser( $this->id, $this->db );
212  }
213 
221  function addGroup( $group, $expiry = null ) {
222  if ( $expiry ) {
223  $expiry = wfTimestamp( TS_MW, $expiry );
224  }
225 
226  $ugm = new UserGroupMembership( $this->id, $group, $expiry );
227  return $ugm->insert( true, $this->db );
228  }
229 
236  function removeGroup( $group ) {
237  $ugm = UserGroupMembership::getMembership( $this->id, $group, $this->db );
238  if ( !$ugm ) {
239  return false;
240  }
241  return $ugm->delete( $this->db );
242  }
243 
249  public function setOption( $option, $value ) {
250  $this->newOptions[$option] = $value;
251  }
252 
253  public function saveSettings() {
254  $rows = [];
255  foreach ( $this->newOptions as $option => $value ) {
256  $rows[] = [
257  'up_user' => $this->id,
258  'up_property' => $option,
259  'up_value' => $value,
260  ];
261  }
262  $this->db->replace( 'user_properties',
263  [ [ 'up_user', 'up_property' ] ],
264  $rows, __METHOD__
265  );
266  $this->invalidateCache();
267  }
268 
272  function invalidateCache() {
273  $this->db->update(
274  'user',
275  [ 'user_touched' => $this->db->timestamp() ],
276  [ 'user_id' => $this->id ],
277  __METHOD__
278  );
279 
280  $domainId = $this->db->getDomainID();
281  $userId = $this->id;
282  $this->db->onTransactionPreCommitOrIdle(
283  function () use ( $domainId, $userId ) {
284  User::purge( $domainId, $userId );
285  },
286  __METHOD__
287  );
288  }
289 }
$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:247
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
$rows
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2783
$wgSharedTables
$wgSharedTables
Definition: DefaultSettings.php:1931
$wgSharedDB
$wgSharedDB
Shared database for multiple wikis.
Definition: DefaultSettings.php:1921
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
UserRightsProxy\saveSettings
saveSettings()
Definition: UserRightsProxy.php:253
UserRightsProxy\getGroupMemberships
getGroupMemberships()
Replaces User::getGroupMemberships()
Definition: UserRightsProxy.php:210
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:13
UserRightsProxy\getId
getId()
Definition: UserRightsProxy.php:167
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:37
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
UserGroupMembership\getMembershipsForUser
static getMembershipsForUser( $userId, IDatabase $db=null)
Returns UserGroupMembership objects for all the groups a user currently belongs to.
Definition: UserGroupMembership.php:310
$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:138
UserRightsProxy\setOption
setOption( $option, $value)
Replaces User::setOption()
Definition: UserRightsProxy.php:249
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
UserRightsProxy\invalidateCache
invalidateCache()
Replaces User::touchUser()
Definition: UserRightsProxy.php:272
UserRightsProxy\getUserPage
getUserPage()
Same as User::getUserPage()
Definition: UserRightsProxy.php:192
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
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:92
$wgLocalDatabases
$wgLocalDatabases
Other wikis on this site, can be administered from a single developer account.
Definition: DefaultSettings.php:2094
UserRightsProxy\newFromLookup
static newFromLookup( $database, $field, $value, $ignoreInvalidDB=false)
Definition: UserRightsProxy.php:115
$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:62
UserRightsProxy\removeGroup
removeGroup( $group)
Replaces User::removeGroup()
Definition: UserRightsProxy.php:236
UserRightsProxy\getName
getName()
Same as User::getName()
Definition: UserRightsProxy.php:183
UserRightsProxy\newFromName
static newFromName( $database, $name, $ignoreInvalidDB=false)
Factory function; get a remote user entry by name.
Definition: UserRightsProxy.php:104
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
UserRightsProxy\__construct
__construct( $db, $database, $name, $id)
Definition: UserRightsProxy.php:39
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:22
NS_USER
const NS_USER
Definition: Defines.php:76
UserRightsProxy\getDB
static getDB( $database, $ignoreInvalidDB=false)
Open a database connection to work on for the requested user.
Definition: UserRightsProxy.php:151
UserRightsProxy\isAnon
isAnon()
Definition: UserRightsProxy.php:174
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:341
UserRightsProxy\whoIs
static whoIs( $database, $id, $ignoreInvalidDB=false)
Same as User::whoIs()
Definition: UserRightsProxy.php:75
UserRightsProxy\getDBName
getDBName()
Accessor for $this->database.
Definition: UserRightsProxy.php:52
User\purge
static purge( $wikiId, $userId)
Definition: User.php:496
UserRightsProxy\addGroup
addGroup( $group, $expiry=null)
Replaces User::addGroup()
Definition: UserRightsProxy.php:221
UserGroupMembership
Represents a "user group membership" – a specific instance of a user belonging to a group.
Definition: UserGroupMembership.php:37
UserRightsProxy\getGroups
getGroups()
Replaces User::getUserGroups()
Definition: UserRightsProxy.php:200