<?php
-
/**
* Cut-down copy of User interface for local-interwiki-database
* user rights manipulation.
*/
class UserRightsProxy {
+
+ /**
+ * Constructor.
+ *
+ * @see newFromId()
+ * @see newFromName()
+ * @param $db DatabaseBase: db connection
+ * @param $database String: database name
+ * @param $name String: user name
+ * @param $id Integer: user ID
+ */
private function __construct( $db, $database, $name, $id ) {
$this->db = $db;
$this->database = $database;
$this->name = $name;
$this->id = intval( $id );
+ $this->newOptions = array();
+ }
+
+ /**
+ * Accessor for $this->database
+ *
+ * @return String: database name
+ */
+ public function getDBName() {
+ return $this->database;
}
/**
* Confirm the selected database name is a valid local interwiki database name.
- * @return bool
+ *
+ * @param $database String: database name
+ * @return Boolean
*/
public static function validDatabase( $database ) {
global $wgLocalDatabases;
return in_array( $database, $wgLocalDatabases );
}
- public static function whoIs( $database, $id ) {
- $user = self::newFromId( $database, $id );
+ /**
+ * Same as User::whoIs()
+ *
+ * @param $database String: database name
+ * @param $id Integer: user ID
+ * @param $ignoreInvalidDB Boolean: if true, don't check if $database is in $wgLocalDatabases
+ * @return String: user name or false if the user doesn't exist
+ */
+ public static function whoIs( $database, $id, $ignoreInvalidDB = false ) {
+ $user = self::newFromId( $database, $id, $ignoreInvalidDB );
if( $user ) {
return $user->name;
} else {
/**
* Factory function; get a remote user entry by ID number.
+ *
+ * @param $database String: database name
+ * @param $id Integer: user ID
+ * @param $ignoreInvalidDB Boolean: if true, don't check if $database is in $wgLocalDatabases
* @return UserRightsProxy or null if doesn't exist
*/
- public static function newFromId( $database, $id ) {
- return self::newFromLookup( $database, 'user_id', intval( $id ) );
+ public static function newFromId( $database, $id, $ignoreInvalidDB = false ) {
+ return self::newFromLookup( $database, 'user_id', intval( $id ), $ignoreInvalidDB );
}
- public static function newFromName( $database, $name ) {
- return self::newFromLookup( $database, 'user_name', $name );
+ /**
+ * Factory function; get a remote user entry by name.
+ *
+ * @param $database String: database name
+ * @param $name String: user name
+ * @param $ignoreInvalidDB Boolean: if true, don't check if $database is in $wgLocalDatabases
+ * @return UserRightsProxy or null if doesn't exist
+ */
+ public static function newFromName( $database, $name, $ignoreInvalidDB = false ) {
+ return self::newFromLookup( $database, 'user_name', $name, $ignoreInvalidDB );
}
- private static function newFromLookup( $database, $field, $value ) {
- $db = self::getDB( $database );
+ private static function newFromLookup( $database, $field, $value, $ignoreInvalidDB = false ) {
+ $db = self::getDB( $database, $ignoreInvalidDB );
if( $db ) {
$row = $db->selectRow( 'user',
array( 'user_id', 'user_name' ),
/**
* Open a database connection to work on for the requested user.
* This may be a new connection to another database for remote users.
- * @param $database string
- * @return Database or null if invalid selection
+ *
+ * @param $database String
+ * @param $ignoreInvalidDB Boolean: if true, don't check if $database is in $wgLocalDatabases
+ * @return DatabaseBase or null if invalid selection
*/
- public static function getDB( $database ) {
- global $wgLocalDatabases, $wgDBname;
+ public static function getDB( $database, $ignoreInvalidDB = false ) {
+ global $wgDBname;
if( self::validDatabase( $database ) ) {
if( $database == $wgDBname ) {
// Hmm... this shouldn't happen though. :)
return $this->getId() == 0;
}
+ /**
+ * Same as User::getName()
+ *
+ * @return String
+ */
public function getName() {
return $this->name . '@' . $this->database;
}
+ /**
+ * Same as User::getUserPage()
+ *
+ * @return Title object
+ */
public function getUserPage() {
return Title::makeTitle( NS_USER, $this->getName() );
}
- // Replaces getUserGroups()
+ /**
+ * Replaces User::getUserGroups()
+ */
function getGroups() {
$res = $this->db->select( 'user_groups',
array( 'ug_group' ),
array( 'ug_user' => $this->id ),
__METHOD__ );
$groups = array();
- while( $row = $this->db->fetchObject( $res ) ) {
+ foreach ( $res as $row ) {
$groups[] = $row->ug_group;
}
return $groups;
}
- // replaces addUserGroup
+ /**
+ * Replaces User::addUserGroup()
+ */
function addGroup( $group ) {
$this->db->insert( 'user_groups',
array(
array( 'IGNORE' ) );
}
- // replaces removeUserGroup
+ /**
+ * Replaces User::removeUserGroup()
+ */
function removeGroup( $group ) {
$this->db->delete( 'user_groups',
array(
),
__METHOD__ );
}
+
+ /**
+ * Replaces User::setOption()
+ */
+ public function setOption( $option, $value ) {
+ $this->newOptions[$option] = $value;
+ }
+
+ public function saveSettings() {
+ $rows = array();
+ foreach ( $this->newOptions as $option => $value ) {
+ $rows[] = array(
+ 'up_user' => $this->id,
+ 'up_property' => $option,
+ 'up_value' => $value,
+ );
+ }
+ $this->db->replace( 'user_properties',
+ array( array( 'up_user', 'up_property' ) ),
+ $rows, __METHOD__
+ );
+ $this->invalidateCache();
+ }
- // replaces touchUser
+ /**
+ * Replaces User::touchUser()
+ */
function invalidateCache() {
$this->db->update( 'user',
array( 'user_touched' => $this->db->timestamp() ),
__METHOD__ );
global $wgMemc;
- if ( function_exists( 'wfForeignMemcKey' ) ) {
- $key = wfForeignMemcKey( $this->database, false, 'user', 'id', $this->id );
- } else {
- $key = "$this->database:user:id:" . $this->id;
- }
+ $key = wfForeignMemcKey( $this->database, false, 'user', 'id', $this->id );
$wgMemc->delete( $key );
}
}