<?php
/**
- * See user.txt
+ * Implements the User class for the %MediaWiki software.
* @file
*/
-# Number of characters in user_token field
+/**
+ * \type{\int} Number of characters in user_token field.
+ * @ingroup Constants
+ */
define( 'USER_TOKEN_LENGTH', 32 );
-# Serialized record version
+/**
+ * \type{\int} Serialized record version.
+ * @ingroup Constants
+ */
define( 'MW_USER_VERSION', 6 );
-# Some punctuation to prevent editing from broken text-mangling proxies.
+/**
+ * \type{\string} Some punctuation to prevent editing from broken text-mangling proxies.
+ * @ingroup Constants
+ */
define( 'EDIT_TOKEN_SUFFIX', '+\\' );
/**
- * Thrown by User::setPassword() on error
+ * Thrown by User::setPassword() on error.
* @ingroup Exception
*/
class PasswordError extends MWException {
class User {
/**
- * A list of default user toggles, i.e. boolean user preferences that are
- * displayed by Special:Preferences as checkboxes. This list can be
- * extended via the UserToggles hook or $wgContLang->getExtraUserToggles().
+ * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user
+ * preferences that are displayed by Special:Preferences as checkboxes.
+ * This list can be extended via the UserToggles hook or by
+ * $wgContLang::getExtraUserToggles().
+ * @showinitializer
*/
- static public $mToggles = array(
+ public static $mToggles = array(
'highlightbroken',
'justify',
'hideminor',
'showjumplinks',
'uselivepreview',
'forceeditsummary',
- 'watchlisthideown',
- 'watchlisthidebots',
'watchlisthideminor',
+ 'watchlisthidebots',
+ 'watchlisthideown',
+ 'watchlisthideanons',
+ 'watchlisthideliu',
'ccmeonemails',
'diffonly',
'showhiddencats',
+ 'noconvertlink',
);
/**
- * List of member variables which are saved to the shared cache (memcached).
- * Any operation which changes the corresponding database fields must
- * call a cache-clearing function.
+ * \type{\arrayof{\string}} List of member variables which are saved to the
+ * shared cache (memcached). Any operation which changes the
+ * corresponding database fields must call a cache-clearing function.
+ * @showinitializer
*/
static $mCacheVars = array(
- # user table
+ // user table
'mId',
'mName',
'mRealName',
'mEmailTokenExpires',
'mRegistration',
'mEditCount',
- # user_group table
+ // user_group table
'mGroups',
);
/**
- * Core rights
- * Each of these should have a corresponding message of the form "right-$right"
+ * \type{\arrayof{\string}} Core rights.
+ * Each of these should have a corresponding message of the form
+ * "right-$right".
+ * @showinitializer
*/
static $mCoreRights = array(
'apihighlimits',
'reupload',
'reupload-shared',
'rollback',
+ 'siteadmin',
'suppressredirect',
'trackback',
'undelete',
'upload_by_url',
'userrights',
);
- static $mAllRights = false;
-
/**
- * The cache variable declarations
+ * \type{\string} Cached results of getAllRights()
*/
+ static $mAllRights = false;
+
+ /** @name Cache variables */
+ //@{
var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
$mEmail, $mOptions, $mTouched, $mToken, $mEmailAuthenticated,
$mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups;
+ //@}
/**
- * Whether the cache variables have been loaded
+ * \type{\bool} Whether the cache variables have been loaded.
*/
var $mDataLoaded;
/**
- * Initialisation data source if mDataLoaded==false. May be one of:
- * defaults anonymous user initialised from class defaults
- * name initialise from mName
- * id initialise from mId
- * session log in from cookies or session if possible
+ * \type{\string} Initialization data source if mDataLoaded==false. May be one of:
+ * - 'defaults' anonymous user initialised from class defaults
+ * - 'name' initialise from mName
+ * - 'id' initialise from mId
+ * - 'session' log in from cookies or session if possible
*
* Use the User::newFrom*() family of functions to set this.
*/
var $mFrom;
- /**
- * Lazy-initialised variables, invalidated with clearInstanceCache
- */
+ /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
+ //@{
var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
$mBlockreason, $mBlock, $mEffectiveGroups;
+ //@}
/**
- * Lightweight constructor for anonymous user
- * Use the User::newFrom* factory functions for other kinds of users
+ * Lightweight constructor for an anonymous user.
+ * Use the User::newFrom* factory functions for other kinds of users.
+ *
+ * @see newFromName()
+ * @see newFromId()
+ * @see newFromConfirmationCode()
+ * @see newFromSession()
+ * @see newFromRow()
*/
function User() {
$this->clearInstanceCache( 'defaults' );
}
/**
- * Load the user table data for this object from the source given by mFrom
+ * Load the user table data for this object from the source given by mFrom.
*/
function load() {
if ( $this->mDataLoaded ) {
}
/**
- * Load user table data given mId
- * @return false if the ID does not exist, true otherwise
+ * Load user table data, given mId has already been set.
+ * @return \type{\bool} false if the ID does not exist, true otherwise
* @private
*/
function loadFromId() {
global $wgMemc;
$wgMemc->set( $key, $data );
}
+
+
+ /** @name newFrom*() static factory methods */
+ //@{
/**
* Static factory method for creation from username.
* This is slightly less efficient than newFromId(), so use newFromId() if
* you have both an ID and a name handy.
*
- * @param $name String: username, validated by Title:newFromText()
- * @param $validate Mixed: validate username. Takes the same parameters as
+ * @param $name \type{\string} Username, validated by Title::newFromText()
+ * @param $validate \type{\mixed} Validate username. Takes the same parameters as
* User::getCanonicalName(), except that true is accepted as an alias
* for 'valid', for BC.
*
- * @return User object, or null if the username is invalid. If the username
- * is not present in the database, the result will be a user object with
- * a name, zero user ID and default settings.
+ * @return \type{User} The User object, or null if the username is invalid. If the
+ * username is not present in the database, the result will be a user object
+ * with a name, zero user ID and default settings.
*/
static function newFromName( $name, $validate = 'valid' ) {
if ( $validate === true ) {
}
}
+ /**
+ * Static factory method for creation from a given user ID.
+ *
+ * @param $id \type{\int} Valid user ID
+ * @return \type{User} The corresponding User object
+ */
static function newFromId( $id ) {
$u = new User;
$u->mId = $id;
*
* If the code is invalid or has expired, returns NULL.
*
- * @param $code string
- * @return User
+ * @param $code \type{\string} Confirmation code
+ * @return \type{User}
*/
static function newFromConfirmationCode( $code ) {
$dbr = wfGetDB( DB_SLAVE );
* Create a new user object using data from session or cookies. If the
* login credentials are invalid, the result is an anonymous user.
*
- * @return User
+ * @return \type{User}
*/
static function newFromSession() {
$user = new User;
/**
* Create a new user object from a user row.
* The row should have all fields from the user table in it.
+ * @param $row array A row from the user table
+ * @return \type{User}
*/
static function newFromRow( $row ) {
$user = new User;
$user->loadFromRow( $row );
return $user;
}
+
+ //@}
+
/**
- * Get username given an id.
- * @param $id Integer: database user id
- * @return string Nickname of a user
+ * Get the username corresponding to a given user ID
+ * @param $id \type{\int} %User ID
+ * @return \type{\string} The corresponding username
*/
static function whoIs( $id ) {
$dbr = wfGetDB( DB_SLAVE );
}
/**
- * Get the real name of a user given their identifier
+ * Get the real name of a user given their user ID
*
- * @param $id Int: database user id
- * @return string Real name of a user
+ * @param $id \type{\int} %User ID
+ * @return \type{\string} The corresponding user's real name
*/
static function whoIsReal( $id ) {
$dbr = wfGetDB( DB_SLAVE );
/**
* Get database id given a user name
- * @param $name String: nickname of a user
- * @return integer|null Database user id (null: if non existent
+ * @param $name \type{\string} Username
+ * @return \twotypes{\int,\null} The corresponding user's ID, or null if user is nonexistent
* @static
*/
static function idFromName( $name ) {
* addresses like this, if we allowed accounts like this to be created
* new users could get the old edits of these anonymous users.
*
- * @param $name String: nickname of a user
- * @return bool
+ * @param $name \type{\string} String to match
+ * @return \type{\bool} True or false
*/
static function isIP( $name ) {
return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP::isIPv6($name);
* is longer than the maximum allowed username size or doesn't begin with
* a capital letter.
*
- * @param $name string
- * @return bool
+ * @param $name \type{\string} String to match
+ * @return \type{\bool} True or false
*/
static function isValidUserName( $name ) {
global $wgContLang, $wgMaxNameChars;
* If an account already exists in this form, login will be blocked
* by a failure to pass this function.
*
- * @param $name string
- * @return bool
+ * @param $name \type{\string} String to match
+ * @return \type{\bool} True or false
*/
static function isUsableName( $name ) {
global $wgReservedUsernames;
return false;
}
+ static $reservedUsernames = false;
+ if ( !$reservedUsernames ) {
+ $reservedUsernames = $wgReservedUsernames;
+ wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
+ }
+
// Certain names may be reserved for batch processes.
- foreach ( $wgReservedUsernames as $reserved ) {
+ foreach ( $reservedUsernames as $reserved ) {
if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
$reserved = wfMsgForContent( substr( $reserved, 4 ) );
}
* rather than in isValidUserName() to avoid disrupting
* existing accounts.
*
- * @param $name string
- * @return bool
+ * @param $name \type{\string} String to match
+ * @return \type{\bool} True or false
*/
static function isCreatableName( $name ) {
return
/**
* Is the input a valid password for this user?
*
- * @param $password String: desired password
- * @return bool
+ * @param $password \type{\string} Desired password
+ * @return \type{\bool} True or false
*/
function isValidPassword( $password ) {
global $wgMinimalPasswordLength, $wgContLang;
}
/**
- * Does a string look like an email address?
+ * Does a string look like an e-mail address?
*
* There used to be a regular expression here, it got removed because it
* rejected valid addresses. Actually just check if there is '@' somewhere
*
* @todo Check for RFC 2822 compilance (bug 959)
*
- * @param $addr String: email address
- * @return bool
+ * @param $addr \type{\string} E-mail address
+ * @return \type{\bool} True or false
*/
public static function isValidEmailAddr( $addr ) {
$result = null;
/**
* Given unvalidated user input, return a canonical username, or false if
* the username is invalid.
- * @param $name string
- * @param $validate Mixed: type of validation to use:
- * false No validation
- * 'valid' Valid for batch processes
- * 'usable' Valid for batch processes and login
- * 'creatable' Valid for batch processes, login and account creation
+ * @param $name \type{\string} User input
+ * @param $validate \twotypes{\string,\bool} Type of validation to use:
+ * - false No validation
+ * - 'valid' Valid for batch processes
+ * - 'usable' Valid for batch processes and login
+ * - 'creatable' Valid for batch processes, login and account creation
*/
static function getCanonicalName( $name, $validate = 'valid' ) {
# Force usernames to capital
return false;
# Clean up name according to title rules
- $t = Title::newFromText( $name );
+ $t = ($validate === 'valid') ?
+ Title::newFromText( $name ) : Title::makeTitle( NS_USER, $name );
+ # Check for invalid titles
if( is_null( $t ) ) {
return false;
}
/**
* Count the number of edits of a user
+ * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
*
- * It should not be static and some day should be merged as proper member function / deprecated -- domas
- *
- * @param $uid Int: the user ID to check
- * @return int
+ * @param $uid \type{\int} %User ID to check
+ * @return \type{\int} The user's edit count
*/
static function edits( $uid ) {
wfProfileIn( __METHOD__ );
* Return a random password. Sourced from mt_rand, so it's not particularly secure.
* @todo hash random numbers to improve security, like generateToken()
*
- * @return string
+ * @return \type{\string} New random password
*/
static function randomPassword() {
global $wgMinimalPasswordLength;
}
/**
- * Set cached properties to default. Note: this no longer clears
- * uncached lazy-initialised properties. The constructor does that instead.
+ * Set cached properties to default.
*
+ * @note This no longer clears uncached lazy-initialised properties;
+ * the constructor does that instead.
* @private
*/
function loadDefaults( $name = false ) {
}
/**
- * Initialise php session
- * @deprecated use wfSetupSession()
+ * @deprecated Use wfSetupSession().
*/
function SetupSession() {
wfDeprecated( __METHOD__ );
/**
* Load user data from the session or login cookie. If there are no valid
- * credentials, initialises the user as an anon.
- * @return true if the user is logged in, false otherwise
+ * credentials, initialises the user as an anonymous user.
+ * @return \type{\bool} True if the user is logged in, false otherwise.
*/
private function loadFromSession() {
global $wgMemc, $wgCookiePrefix;
}
/**
- * Load user and user_group data from the database
- * $this->mId must be set, this is how the user is identified.
+ * Load user and user_group data from the database.
+ * $this::mId must be set, this is how the user is identified.
*
- * @return true if the user exists, false if the user is anonymous
+ * @return \type{\bool} True if the user exists, false if the user is anonymous
* @private
*/
function loadFromDatabase() {
}
/**
- * Initialise the user object from a row from the user table
+ * Initialize this object from a row from the user table.
+ *
+ * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
*/
function loadFromRow( $row ) {
$this->mDataLoaded = true;
}
/**
- * Load the groups from the database if they aren't already loaded
+ * Load the groups from the database if they aren't already loaded.
* @private
*/
function loadGroups() {
/**
* Clear various cached data stored in this object.
- * @param $reloadFrom String: reload user and user_groups table data from a
- * given source. May be "name", "id", "defaults", "session" or false for
+ * @param $reloadFrom \type{\string} Reload user and user_groups table data from a
+ * given source. May be "name", "id", "defaults", "session", or false for
* no reload.
*/
function clearInstanceCache( $reloadFrom = false ) {
/**
* Combine the language default options with any site-specific options
* and add the default language variants.
- * Not really private cause it's called by Language class
- * @return array
- * @private
+ *
+ * @return \type{\arrayof{\string}} Array of options
*/
static function getDefaultOptions() {
global $wgNamespacesToBeSearchedDefault;
/**
* Get a given default option value.
*
- * @param $opt string
- * @return string
+ * @param $opt \type{\string} Name of option to retrieve
+ * @return \type{\string} Default option value
*/
public static function getDefaultOption( $opt ) {
$defOpts = self::getDefaultOptions();
/**
* Get a list of user toggle names
- * @return array
+ * @return \type{\arrayof{\string}} Array of user toggle names
*/
static function getToggles() {
global $wgContLang;
/**
* Get blocking information
* @private
- * @param $bFromSlave Bool: specify whether to check slave or master. To
+ * @param $bFromSlave \type{\bool} Whether to check the slave database first. To
* improve performance, non-critical checks are done
* against slaves. Check when actually saving should be
* done against master.
$this->mBlockedby = 0;
$this->mHideName = 0;
+ $this->mAllowUsertalk = 0;
$ip = wfGetIP();
if ($this->isAllowed( 'ipblock-exempt' ) ) {
$this->mBlockedby = $this->mBlock->mBy;
$this->mBlockreason = $this->mBlock->mReason;
$this->mHideName = $this->mBlock->mHideName;
+ $this->mAllowUsertalk = $this->mBlock->mAllowUsertalk;
if ( $this->isLoggedIn() ) {
$this->spreadBlock();
}
} else {
- $this->mBlock = null;
- wfDebug( __METHOD__.": No block.\n" );
+ // Bug 13611: don't remove mBlock here, to allow account creation blocks to
+ // apply to users. Note that the existence of $this->mBlock is not used to
+ // check for edit blocks, $this->mBlockedby is instead.
}
# Proxy blocking
wfProfileOut( __METHOD__ );
}
+ /**
+ * Whether the given IP is in the SORBS blacklist.
+ *
+ * @param $ip \type{\string} IP to check
+ * @return \type{\bool} True if blacklisted
+ */
function inSorbsBlacklist( $ip ) {
global $wgEnableSorbs, $wgSorbsUrl;
$this->inDnsBlacklist( $ip, $wgSorbsUrl );
}
+ /**
+ * Whether the given IP is in a given DNS blacklist.
+ *
+ * @param $ip \type{\string} IP to check
+ * @param $base \type{\string} URL of the DNS blacklist
+ * @return \type{\bool} True if blacklisted
+ */
function inDnsBlacklist( $ip, $base ) {
wfProfileIn( __METHOD__ );
$found = false;
$host = '';
- // FIXME: IPv6 ???
- $m = array();
- if ( preg_match( '/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/', $ip, $m ) ) {
+ // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
+ if( IP::isIPv4($ip) ) {
# Make hostname
- for ( $i=4; $i>=1; $i-- ) {
- $host .= $m[$i] . '.';
- }
- $host .= $base;
+ $host = "$ip.$base";
# Send query
$ipList = gethostbynamel( $host );
- if ( $ipList ) {
+ if( $ipList ) {
wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
$found = true;
} else {
/**
* Is this user subject to rate limiting?
*
- * @return bool
+ * @return \type{\bool} True if rate limited
*/
public function isPingLimitable() {
global $wgRateLimitsExcludedGroups;
* Primitive rate limits: enforce maximum actions per time period
* to put a brake on flooding.
*
- * Note: when using a shared cache like memcached, IP-address
+ * @note When using a shared cache like memcached, IP-address
* last-hit counters will be shared across wikis.
*
- * @return bool true if a rate limiter was tripped
+ * @param $action \type{\string} Action to enforce; 'edit' if unspecified
+ * @return \type{\bool} True if a rate limiter was tripped
*/
function pingLimiter( $action='edit' ) {
/**
* Check if user is blocked
- * @return bool True if blocked, false otherwise
+ *
+ * @param $bFromSlave \type{\bool} Whether to check the slave database instead of the master
+ * @return \type{\bool} True if blocked, false otherwise
*/
function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
wfDebug( "User::isBlocked: enter\n" );
/**
* Check if user is blocked from editing a particular article
+ *
+ * @param $title \type{\string} Title to check
+ * @param $bFromSlave \type{\bool} Whether to check the slave database instead of the master
+ * @return \type{\bool} True if blocked, false otherwise
*/
function isBlockedFrom( $title, $bFromSlave = false ) {
global $wgBlockAllowsUTEdit;
wfDebug( __METHOD__.": asking isBlocked()\n" );
$blocked = $this->isBlocked( $bFromSlave );
# If a user's name is suppressed, they cannot make edits anywhere
- if ( !$this->mHideName && $wgBlockAllowsUTEdit && $title->getText() === $this->getName() &&
+ if ( !$this->mHideName && $this->mAllowUsertalk && $title->getText() === $this->getName() &&
$title->getNamespace() == NS_USER_TALK ) {
$blocked = false;
wfDebug( __METHOD__.": self-talk page, ignoring any blocks\n" );
}
/**
- * Get name of blocker
- * @return string name of blocker
+ * If user is blocked, return the name of the user who placed the block
+ * @return \type{\string} name of blocker
*/
function blockedBy() {
$this->getBlockedStatus();
}
/**
- * Get blocking reason
- * @return string Blocking reason
+ * If user is blocked, return the specified reason for the block
+ * @return \type{\string} Blocking reason
*/
function blockedFor() {
$this->getBlockedStatus();
}
/**
- * Get the user ID. Returns 0 if the user is anonymous or nonexistent.
+ * Get the user's ID.
+ * @return \type{\int} The user's ID; 0 if the user is anonymous or nonexistent
*/
function getId() {
if( $this->mId === null and $this->mName !== null
}
/**
- * Set the user and reload all fields according to that ID
+ * Set the user and reload all fields according to a given ID
+ * @param $v \type{\int} %User ID to reload
*/
function setId( $v ) {
$this->mId = $v;
}
/**
- * Get the user name, or the IP for anons
+ * Get the user name, or the IP of an anonymous user
+ * @return \type{\string} User's name or IP address
*/
function getName() {
if ( !$this->mDataLoaded && $this->mFrom == 'name' ) {
* address for an anonymous user to something other than the current
* remote IP.
*
- * User::newFromName() has rougly the same function, when the named user
+ * @note User::newFromName() has rougly the same function, when the named user
* does not exist.
+ * @param $str \type{\string} New user name to set
*/
function setName( $str ) {
$this->load();
}
/**
- * Return the title dbkey form of the name, for eg user pages.
- * @return string
+ * Get the user's name escaped by underscores.
+ * @return \type{\string} Username escaped by underscores
*/
function getTitleKey() {
return str_replace( ' ', '_', $this->getName() );
}
+ /**
+ * Check if the user has new messages.
+ * @return \type{\bool} True if the user has new messages
+ */
function getNewtalk() {
$this->load();
/**
* Return the talk page(s) this user has new messages on.
+ * @return \type{\arrayof{\string}} Array of page URLs
*/
function getNewMessageLinks() {
$talks = array();
/**
- * Perform a user_newtalk check, uncached.
- * Use getNewtalk for a cached check.
+ * Internal uncached check for new messages
*
- * @param $field string
- * @param $id mixed
- * @param $fromMaster Bool: true to fetch from the master, false for a slave
- * @return bool
+ * @see getNewtalk()
+ * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id \twotypes{\string,\int} User's IP address for anonymous users, %User ID otherwise
+ * @param $fromMaster \type{\bool} true to fetch from the master, false for a slave
+ * @return \type{\bool} True if the user has new messages
* @private
*/
function checkNewtalk( $field, $id, $fromMaster = false ) {
}
/**
- * Add or update the
- * @param $field string
- * @param $id mixed
+ * Add or update the new messages flag
+ * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id \twotypes{string,\int} User's IP address for anonymous users, %User ID otherwise
+ * @return \type{\bool} True if successful, false otherwise
* @private
*/
function updateNewtalk( $field, $id ) {
/**
* Clear the new messages flag for the given user
- * @param $field string
- * @param $id mixed
+ * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id \twotypes{\string,\int} User's IP address for anonymous users, %User ID otherwise
+ * @return \type{\bool} True if successful, false otherwise
* @private
*/
function deleteNewtalk( $field, $id ) {
/**
* Update the 'You have new messages!' status.
- * @param $val bool
+ * @param $val \type{\bool} Whether the user has new messages
*/
function setNewtalk( $val ) {
if( wfReadOnly() ) {
/**
* Generate a current or new-future timestamp to be stored in the
* user_touched field when we update things.
+ * @return \type{\string} Timestamp in TS_MW format
*/
private static function newTouchedTimestamp() {
global $wgClockSkewFudge;
}
}
+ /**
+ * Validate the cache for this account.
+ * @param $timestamp \type{\string} A timestamp in TS_MW format
+ */
function validateCache( $timestamp ) {
$this->load();
return ($timestamp >= $this->mTouched);
}
/**
- * Set the password and reset the random token
+ * Get the user touched timestamp
+ */
+ function getTouched() {
+ $this->load();
+ return $this->mTouched;
+ }
+
+ /**
+ * Set the password and reset the random token.
* Calls through to authentication plugin if necessary;
* will have no effect if the auth plugin refuses to
* pass the change through or if the legal password
* wipes it, so the account cannot be logged in until
* a new password is set, for instance via e-mail.
*
- * @param $str string
+ * @param $str \type{\string} New password to set
* @throws PasswordError on failure
*/
function setPassword( $str ) {
}
/**
- * Set the password and reset the random token no matter
- * what.
+ * Set the password and reset the random token unconditionally.
*
- * @param $str string
+ * @param $str \type{\string} New password to set
*/
function setInternalPassword( $str ) {
$this->load();
$this->mNewpassTime = null;
}
+ /**
+ * Get the user's current token.
+ * @return \type{\string} Token
+ */
function getToken() {
$this->load();
return $this->mToken;
/**
* Set the random token (used for persistent authentication)
* Called from loadDefaults() among other places.
+ *
+ * @param $token \type{\string} If specified, set the token to this value
* @private
*/
function setToken( $token = false ) {
$this->mToken = $token;
}
}
-
+
+ /**
+ * Set the cookie password
+ *
+ * @param $str \type{\string} New cookie password
+ * @private
+ */
function setCookiePassword( $str ) {
$this->load();
$this->mCookiePassword = md5( $str );
/**
* Set the password for a password reminder or new account email
- * Sets the user_newpass_time field if $throttle is true
+ *
+ * @param $str \type{\string} New password to set
+ * @param $throttle \type{\bool} If true, reset the throttle timestamp to the present
*/
function setNewpassword( $str, $throttle = true ) {
$this->load();
}
/**
- * Returns true if a password reminder email has already been sent within
- * the last $wgPasswordReminderResendTime hours
+ * Has password reminder email been sent within the last
+ * $wgPasswordReminderResendTime hours?
+ * @return \type{\bool} True or false
*/
function isPasswordReminderThrottled() {
global $wgPasswordReminderResendTime;
return time() < $expiry;
}
+ /**
+ * Get the user's e-mail address
+ * @return \type{\string} User's e-mail address
+ */
function getEmail() {
$this->load();
wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail ) );
return $this->mEmail;
}
+ /**
+ * Get the timestamp of the user's e-mail authentication
+ * @return \type{\string} TS_MW timestamp
+ */
function getEmailAuthenticationTimestamp() {
$this->load();
wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) );
return $this->mEmailAuthenticated;
}
+ /**
+ * Set the user's e-mail address
+ * @param $str \type{\string} New e-mail address
+ */
function setEmail( $str ) {
$this->load();
$this->mEmail = $str;
wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail ) );
}
+ /**
+ * Get the user's real name
+ * @return \type{\string} User's real name
+ */
function getRealName() {
$this->load();
return $this->mRealName;
}
+ /**
+ * Set the user's real name
+ * @param $str \type{\string} New real name
+ */
function setRealName( $str ) {
$this->load();
$this->mRealName = $str;
}
/**
- * @param $oname String: the option to check
- * @param $defaultOverride String: A default value returned if the option does not exist
- * @return string
+ * Get the user's current setting for a given option.
+ *
+ * @param $oname \type{\string} The option to check
+ * @param $defaultOverride \type{\string} A default value returned if the option does not exist
+ * @return \type{\string} User's current value for the option
+ * @see getBoolOption()
+ * @see getIntOption()
*/
function getOption( $oname, $defaultOverride = '' ) {
$this->load();
return $defaultOverride;
}
}
-
- /**
- * Get the user's date preference, including some important migration for
- * old user rows.
- */
- function getDatePreference() {
- if ( is_null( $this->mDatePreference ) ) {
- global $wgLang;
- $value = $this->getOption( 'date' );
- $map = $wgLang->getDatePreferenceMigrationMap();
- if ( isset( $map[$value] ) ) {
- $value = $map[$value];
- }
- $this->mDatePreference = $value;
- }
- return $this->mDatePreference;
- }
-
+
/**
- * @param $oname String: the option to check
- * @return bool False if the option is not selected, true if it is
+ * Get the user's current setting for a given option, as a boolean value.
+ *
+ * @param $oname \type{\string} The option to check
+ * @return \type{\bool} User's current value for the option
+ * @see getOption()
*/
function getBoolOption( $oname ) {
return (bool)$this->getOption( $oname );
}
+
/**
- * Get an option as an integer value from the source string.
- * @param $oname String: the option to check
- * @param $default Int: optional value to return if option is unset/blank.
- * @return int
+ * Get the user's current setting for a given option, as a boolean value.
+ *
+ * @param $oname \type{\string} The option to check
+ * @param $defaultOverride \type{\int} A default value returned if the option does not exist
+ * @return \type{\int} User's current value for the option
+ * @see getOption()
*/
- function getIntOption( $oname, $default=0 ) {
+ function getIntOption( $oname, $defaultOverride=0 ) {
$val = $this->getOption( $oname );
if( $val == '' ) {
- $val = $default;
+ $val = $defaultOverride;
}
return intval( $val );
}
+ /**
+ * Set the given option for a user.
+ *
+ * @param $oname \type{\string} The option to set
+ * @param $val \type{\mixed} New value to set
+ */
function setOption( $oname, $val ) {
$this->load();
if ( is_null( $this->mOptions ) ) {
$this->mOptions[$oname] = $val;
}
+ /**
+ * Get the user's preferred date format.
+ * @return \type{\string} User's preferred date format
+ */
+ function getDatePreference() {
+ // Important migration for old data rows
+ if ( is_null( $this->mDatePreference ) ) {
+ global $wgLang;
+ $value = $this->getOption( 'date' );
+ $map = $wgLang->getDatePreferenceMigrationMap();
+ if ( isset( $map[$value] ) ) {
+ $value = $map[$value];
+ }
+ $this->mDatePreference = $value;
+ }
+ return $this->mDatePreference;
+ }
+
+ /**
+ * Get the permissions this user has.
+ * @return \type{\arrayof{\string}} Array of permission names
+ */
function getRights() {
if ( is_null( $this->mRights ) ) {
$this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() );
/**
* Get the list of explicit group memberships this user has.
* The implicit * and user groups are not included.
- * @return array of strings
+ * @return \type{\arrayof{\string}} Array of internal group names
*/
function getGroups() {
$this->load();
* Get the list of implicit group memberships this user has.
* This includes all explicit groups, plus 'user' if logged in,
* '*' for all accounts and autopromoted groups
- * @param $recache Boolean: don't use the cache
- * @return array of strings
+ *
+ * @param $recache \type{\bool} Whether to avoid the cache
+ * @return \type{\arrayof{\string}} Array of internal group names
*/
function getEffectiveGroups( $recache = false ) {
if ( $recache || is_null( $this->mEffectiveGroups ) ) {
return $this->mEffectiveGroups;
}
- /* Return the edit count for the user. This is where User::edits should have been */
+ /**
+ * Get the user's edit count.
+ * @return \type{\int} User's edit count
+ */
function getEditCount() {
if ($this->mId) {
if ( !isset( $this->mEditCount ) ) {
/**
* Add the user to the given group.
* This takes immediate effect.
- * @param $group string
+ * @param $group \type{\string} Name of the group to add
*/
function addGroup( $group ) {
$dbw = wfGetDB( DB_MASTER );
/**
* Remove the user from the given group.
* This takes immediate effect.
- * @param $group string
+ * @param $group \type{\string} Name of the group to remove
*/
function removeGroup( $group ) {
$this->load();
/**
- * A more legible check for non-anonymousness.
- * Returns true if the user is not an anonymous visitor.
- *
- * @return bool
+ * Get whether the user is logged in
+ * @return \type{\bool} True or false
*/
function isLoggedIn() {
return $this->getID() != 0;
}
/**
- * A more legible check for anonymousness.
- * Returns true if the user is an anonymous visitor.
- *
- * @return bool
+ * Get whether the user is anonymous
+ * @return \type{\bool} True or false
*/
function isAnon() {
return !$this->isLoggedIn();
}
/**
- * Whether the user is a bot
+ * Get whether the user is a bot
+ * @return \type{\bool} True or false
* @deprecated
*/
function isBot() {
/**
* Check if user is allowed to access a feature / make an action
- * @param $action String: action to be checked
- * @return boolean True: action is allowed, False: action should not be allowed
+ * @param $action \type{\string} action to be checked
+ * @return \type{\bool} True if action is allowed, else false
*/
function isAllowed($action='') {
if ( $action === '' )
// In the spirit of DWIM
return true;
- return in_array( $action, $this->getRights() );
+ # Use strict parameter to avoid matching numeric 0 accidentally inserted
+ # by misconfiguration: 0 == 'foo'
+ return in_array( $action, $this->getRights(), true );
}
/**
* Check whether to enable recent changes patrol features for this user
- * @return bool
+ * @return \type{\bool} True or false
*/
public function useRCPatrol() {
global $wgUseRCPatrol;
}
/**
- * Check whether to enable recent changes patrol features for this user
- * @return bool
+ * Check whether to enable new pages patrol features for this user
+ * @return \type{\bool} True or false
*/
public function useNPPatrol() {
global $wgUseRCPatrol, $wgUseNPPatrol;
}
/**
- * Load a skin if it doesn't exist or return it
+ * Get the current skin, loading it if required
+ * @return \type{Skin} Current skin
* @todo FIXME : need to check the old failback system [AV]
*/
function &getSkin() {
return $this->mSkin;
}
- /**#@+
- * @param $title Title: article title to look at
- */
-
/**
- * Check watched status of an article
- * @return bool True if article is watched
+ * Check the watched status of an article.
+ * @param $title \type{Title} Title of the article to look at
+ * @return \type{\bool} True if article is watched
*/
function isWatched( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
}
/**
- * Watch an article
+ * Watch an article.
+ * @param $title \type{Title} Title of the article to look at
*/
function addWatch( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
}
/**
- * Stop watching an article
+ * Stop watching an article.
+ * @param $title \type{Title} Title of the article to look at
*/
function removeWatch( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
* Clear the user's notification timestamp for the given title.
* If e-notif e-mails are on, they will receive notification mails on
* the next change of the page if it's watched etc.
+ * @param $title \type{Title} Title of the article to look at
*/
function clearNotification( &$title ) {
global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
}
}
- /**#@-*/
-
/**
* Resets all of the given user's page-change notification timestamps.
* If e-notif e-mails are on, they will receive notification mails on
* the next change of any watched page.
*
- * @param $currentUser Int: user ID number
+ * @param $currentUser \type{\int} %User ID
*/
function clearAllNotifications( $currentUser ) {
global $wgUseEnotif, $wgShowUpdatedMarker;
}
/**
+ * Encode this user's options as a string
+ * @return \type{\string} Encoded options
* @private
- * @return string Encoding options
*/
function encodeOptions() {
$this->load();
}
/**
+ * Set this user's options from an encoded string
+ * @param $str \type{\string} Encoded options to import
* @private
*/
function decodeOptions( $str ) {
}
}
+ /**
+ * Set a cookie on the user's client. Wrapper for
+ * WebResponse::setCookie
+ */
protected function setCookie( $name, $value, $exp=0 ) {
- global $wgCookiePrefix,$wgCookieDomain,$wgCookieSecure,$wgCookieExpiration, $wgCookieHttpOnly;
- if( $exp == 0 ) {
- $exp = time() + $wgCookieExpiration;
- }
- $httpOnlySafe = wfHttpOnlySafe();
- wfDebugLog( 'cookie',
- 'setcookie: "' . implode( '", "',
- array(
- $wgCookiePrefix . $name,
- $value,
- $exp,
- '/',
- $wgCookieDomain,
- $wgCookieSecure,
- $httpOnlySafe && $wgCookieHttpOnly ) ) . '"' );
- if( $httpOnlySafe && isset( $wgCookieHttpOnly ) ) {
- setcookie( $wgCookiePrefix . $name,
- $value,
- $exp,
- '/',
- $wgCookieDomain,
- $wgCookieSecure,
- $wgCookieHttpOnly );
- } else {
- // setcookie() fails on PHP 5.1 if you give it future-compat paramters.
- // stab stab!
- setcookie( $wgCookiePrefix . $name,
- $value,
- $exp,
- '/',
- $wgCookieDomain,
- $wgCookieSecure );
- }
+ global $wgRequest;
+ $wgRequest->response()->setcookie( $name, $value, $exp );
}
+ /**
+ * Clear a cookie on the user's client
+ * @param $name \type{\string} Name of the cookie to clear
+ */
protected function clearCookie( $name ) {
$this->setCookie( $name, '', time() - 86400 );
}
+ /**
+ * Set the default cookies for this session on the user's client.
+ */
function setCookies() {
$this->load();
if ( 0 == $this->mId ) return;
}
/**
- * Logout user.
+ * Log this user out.
*/
function logout() {
global $wgUser;
}
/**
- * Really logout user
- * Clears the cookies and session, resets the instance cache
+ * Clear the user's cookies and session, and reset the instance cache.
+ * @private
+ * @see logout()
*/
function doLogout() {
$this->clearInstanceCache( 'defaults' );
}
/**
- * Save object settings into database
+ * Save this user's settings into the database.
* @todo Only rarely do all these fields need to be set!
*/
function saveSettings() {
}
/**
- * Checks if a user with the given name exists, returns the ID.
+ * If only this user's username is known, and it exists, return the user ID.
*/
function idForName() {
$s = trim( $this->getName() );
/**
* Add a user to the database, return the user object
*
- * @param $name String: the user's name
- * @param $params Associative array of non-default parameters to save to the database:
- * password The user's password. Password logins will be disabled if this is omitted.
- * newpassword A temporary password mailed to the user
- * email The user's email address
- * email_authenticated The email authentication timestamp
- * real_name The user's real name
- * options An associative array of non-default options
- * token Random authentication token. Do not set.
- * registration Registration timestamp. Do not set.
+ * @param $name \type{\string} Username to add
+ * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
+ * - password The user's password. Password logins will be disabled if this is omitted.
+ * - newpassword A temporary password mailed to the user
+ * - email The user's email address
+ * - email_authenticated The email authentication timestamp
+ * - real_name The user's real name
+ * - options An associative array of non-default options
+ * - token Random authentication token. Do not set.
+ * - registration Registration timestamp. Do not set.
*
- * @return User object, or null if the username already exists
+ * @return \type{User} A new User object, or null if the username already exists
*/
static function createNew( $name, $params = array() ) {
$user = new User;
}
/**
- * Add an existing user object to the database
+ * Add this existing user object to the database
*/
function addToDatabase() {
$this->load();
);
$this->mId = $dbw->insertId();
- # Clear instance cache other than user table data, which is already accurate
+ // Clear instance cache other than user table data, which is already accurate
$this->clearInstanceCache();
}
/**
- * If the (non-anonymous) user is blocked, this function will block any IP address
- * that they successfully log on from.
+ * If this (non-anonymous) user is blocked, block any IP address
+ * they've successfully logged in from.
*/
function spreadBlock() {
wfDebug( __METHOD__."()\n" );
* which will give them a chance to modify this key based on their own
* settings.
*
- * @return string
+ * @return \type{\string} Page rendering hash
*/
function getPageRenderingHash() {
- global $wgContLang, $wgUseDynamicDates, $wgLang;
+ global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
if( $this->mHash ){
return $this->mHash;
}
$extra = $wgContLang->getExtraHashOptions();
$confstr .= $extra;
+ $confstr .= $wgRenderHashAppend;
+
// Give a chance for extensions to modify the hash, if they have
// extra options or other effects on the parser cache.
wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
return $confstr;
}
+ /**
+ * Get whether the user is explicitly blocked from account creation.
+ * @return \type{\bool} True if blocked
+ */
function isBlockedFromCreateAccount() {
$this->getBlockedStatus();
return $this->mBlock && $this->mBlock->mCreateAccount;
}
/**
- * Determine if the user is blocked from using Special:Emailuser.
- *
- * @return boolean
+ * Get whether the user is blocked from using Special:Emailuser.
+ * @return \type{\bool} True if blocked
*/
function isBlockedFromEmailuser() {
$this->getBlockedStatus();
return $this->mBlock && $this->mBlock->mBlockEmail;
}
+ /**
+ * Get whether the user is allowed to create an account.
+ * @return \type{\bool} True if allowed
+ */
function isAllowedToCreateAccount() {
return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
}
/**
* Get this user's personal page title.
*
- * @return Title
+ * @return \type{Title} User's personal page title
*/
function getUserPage() {
return Title::makeTitle( NS_USER, $this->getName() );
/**
* Get this user's talk page title.
*
- * @return Title
+ * @return \type{Title} User's talk page title
*/
function getTalkPage() {
$title = $this->getUserPage();
}
/**
+ * Get the maximum valid user ID.
+ * @return \type{\int} %User ID
* @static
*/
function getMaxID() {
/**
* Determine whether the user is a newbie. Newbies are either
* anonymous IPs, or the most recently created accounts.
- * @return bool True if it is a newbie.
+ * @return \type{\bool} True if the user is a newbie
*/
function isNewbie() {
return !$this->isAllowed( 'autoconfirmed' );
* Is the user active? We check to see if they've made at least
* X number of edits in the last Y days.
*
- * @return bool true if the user is active, false if not
+ * @return \type{\bool} True if the user is active, false if not.
*/
public function isActiveEditor() {
global $wgActiveUserEditCount, $wgActiveUserDays;
/**
* Check to see if the given clear-text password is one of the accepted passwords
- * @param $password String: user password.
- * @return bool True if the given password is correct otherwise False.
+ * @param $password \type{\string} user password.
+ * @return \type{\bool} True if the given password is correct, otherwise False.
*/
function checkPassword( $password ) {
global $wgAuth;
/**
* Check if the given clear-text password matches the temporary password
* sent by e-mail for password reset operations.
- * @return bool
+ * @return \type{\bool} True if matches, false otherwise
*/
function checkTemporaryPassword( $plaintext ) {
return self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() );
* login credentials aren't being hijacked with a foreign form
* submission.
*
- * @param $salt Mixed: optional function-specific data for hash.
- * Use a string or an array of strings.
- * @return string
+ * @param $salt \twotypes{\string,\arrayof{\string}} Optional function-specific data for hashing
+ * @return \type{\string} The new edit token
*/
function editToken( $salt = '' ) {
if ( $this->isAnon() ) {
}
/**
- * Generate a hex-y looking random token for various uses.
- * Could be made more cryptographically sure if someone cares.
- * @return string
+ * Generate a looking random token for various uses.
+ *
+ * @param $salt \type{\string} Optional salt value
+ * @return \type{\string} The new random token
*/
function generateToken( $salt = '' ) {
$token = dechex( mt_rand() ) . dechex( mt_rand() );
* user's own login session, not a form submission from a third-party
* site.
*
- * @param $val String: the input value to compare
- * @param $salt String: optional function-specific data for hash
- * @return bool
+ * @param $val \type{\string} Input value to compare
+ * @param $salt \type{\string} Optional function-specific data for hashing
+ * @return \type{\bool} Whether the token matches
*/
function matchEditToken( $val, $salt = '' ) {
$sessionToken = $this->editToken( $salt );
}
/**
- * Check whether the edit token is fine except for the suffix
+ * Check given value against the token value stored in the session,
+ * ignoring the suffix.
+ *
+ * @param $val \type{\string} Input value to compare
+ * @param $salt \type{\string} Optional function-specific data for hashing
+ * @return \type{\bool} Whether the token matches
*/
function matchEditTokenNoSuffix( $val, $salt = '' ) {
$sessionToken = $this->editToken( $salt );
* Generate a new e-mail confirmation token and send a confirmation/invalidation
* mail to the user's given address.
*
- * Calls saveSettings() internally; as it has side effects, not committing changes
- * would be pretty silly.
- *
- * @return mixed True on success, a WikiError object on failure.
+ * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure.
*/
function sendConfirmationMail() {
global $wgLang;
* Send an e-mail to this user's account. Does not check for
* confirmed status or validity.
*
- * @param $subject string
- * @param $body string
- * @param $from string: optional from address; default $wgPasswordSender will be used otherwise.
- * @param $replyto string
- * @return mixed True on success, a WikiError object on failure.
+ * @param $subject \type{\string} Message subject
+ * @param $body \type{\string} Message body
+ * @param $from \type{\string} Optional From address; if unspecified, default $wgPasswordSender will be used
+ * @param $replyto \type{\string} Reply-to address
+ * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure
*/
function sendMail( $subject, $body, $from = null, $replyto = null ) {
if( is_null( $from ) ) {
/**
* Generate, store, and return a new e-mail confirmation code.
- * A hash (unsalted since it's used as a key) is stored.
+ * A hash (unsalted, since it's used as a key) is stored.
*
- * Call saveSettings() after calling this function to commit
+ * @note Call saveSettings() after calling this function to commit
* this change to the database.
*
- * @param &$expiration mixed output: accepts the expiration time
- * @return string
+ * @param[out] &$expiration \type{\mixed} Accepts the expiration time
+ * @return \type{\string} New token
* @private
*/
function confirmationToken( &$expiration ) {
/**
* Return a URL the user can use to confirm their email address.
- * @param $token accepts the email confirmation token
- * @return string
+ * @param $token \type{\string} Accepts the email confirmation token
+ * @return \type{\string} New token URL
* @private
*/
function confirmationTokenUrl( $token ) {
}
/**
* Return a URL the user can use to invalidate their email address.
- * @param $token accepts the email confirmation token
- * @return string
+ *
+ * @param $token \type{\string} Accepts the email confirmation token
+ * @return \type{\string} New token URL
* @private
*/
function invalidationTokenUrl( $token ) {
* This uses $wgArticlePath directly as a quickie hack to use the
* hardcoded English names of the Special: pages, for ASCII safety.
*
- * Since these URLs get dropped directly into emails, using the
+ * @note Since these URLs get dropped directly into emails, using the
* short English names avoids insanely long URL-encoded links, which
* also sometimes can get corrupted in some browsers/mailers
* (bug 6957 with Gmail and Internet Explorer).
+ *
+ * @param $page \type{\string} Special page
+ * @param $token \type{\string} Token
+ * @return \type{\string} Formatted URL
*/
protected function getTokenUrl( $page, $token ) {
global $wgArticlePath;
/**
* Mark the e-mail address confirmed.
*
- * Call saveSettings() after calling this function to commit the change.
+ * @note Call saveSettings() after calling this function to commit the change.
*/
function confirmEmail() {
$this->setEmailAuthenticationTimestamp( wfTimestampNow() );
}
/**
- * Invalidate the user's email confirmation, unauthenticate the email
- * if it was already confirmed.
+ * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
+ * address if it was already confirmed.
*
- * Call saveSettings() after calling this function to commit the change.
+ * @note Call saveSettings() after calling this function to commit the change.
*/
function invalidateEmail() {
$this->load();
return true;
}
+ /**
+ * Set the e-mail authentication timestamp.
+ * @param $timestamp \type{\string} TS_MW timestamp
+ */
function setEmailAuthenticationTimestamp( $timestamp ) {
$this->load();
$this->mEmailAuthenticated = $timestamp;
/**
* Is this user allowed to send e-mails within limits of current
* site configuration?
- * @return bool
+ * @return \type{\bool} True if allowed
*/
function canSendEmail() {
$canSend = $this->isEmailConfirmed();
/**
* Is this user allowed to receive e-mails within limits of current
* site configuration?
- * @return bool
+ * @return \type{\bool} True if allowed
*/
function canReceiveEmail() {
return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
* Is this user's e-mail address valid-looking and confirmed within
* limits of the current site configuration?
*
- * If $wgEmailAuthentication is on, this may require the user to have
+ * @note If $wgEmailAuthentication is on, this may require the user to have
* confirmed their address by returning a code or using a password
* sent to the address from the wiki.
*
- * @return bool
+ * @return \type{\bool} True if confirmed
*/
function isEmailConfirmed() {
global $wgEmailAuthentication;
}
/**
- * Return true if there is an outstanding request for e-mail confirmation.
- * @return bool
+ * Check whether there is an outstanding request for e-mail confirmation.
+ * @return \type{\bool} True if pending
*/
function isEmailConfirmationPending() {
global $wgEmailAuthentication;
}
/**
- * Get the timestamp of account creation, or false for
- * non-existent/anonymous user accounts
+ * Get the timestamp of account creation.
*
- * @return mixed
+ * @return \twotypes{\string,\bool} string Timestamp of account creation, or false for
+ * non-existent/anonymous user accounts.
*/
public function getRegistration() {
return $this->mId > 0
}
/**
- * @param $groups Array: list of groups
- * @return array list of permission key names for given groups combined
+ * Get the permissions associated with a given list of groups
+ *
+ * @param $groups \type{\arrayof{\string}} List of internal group names
+ * @return \type{\arrayof{\string}} List of permission key names for given groups combined
*/
static function getGroupPermissions( $groups ) {
global $wgGroupPermissions;
}
/**
- * @param $roles Array: list of roles
- * @return array list of groups with the given permission
+ * Get all the groups who have a given permission
+ *
+ * @param $role \type{\string} Role to check
+ * @return \type{\arrayof{\string}} List of internal group names with the given permission
*/
- static function getGroupsInRoles( $roles ) {
+ static function getGroupsWithPermission( $role ) {
global $wgGroupPermissions;
$allowedGroups = array();
- foreach ( $roles as $role ) {
- foreach ( $wgGroupPermissions as $group => $rights ) {
- if ( $rights[$role] === true ) {
- $allowedGroups[$role][] = $group;
- }
+ foreach ( $wgGroupPermissions as $group => $rights ) {
+ if ( isset( $rights[$role] ) && $rights[$role] ) {
+ $allowedGroups[] = $group;
}
}
return $allowedGroups;
}
/**
- * @param $group String: key name
- * @return string localized descriptive name for group, if provided
+ * Get the localized descriptive name for a group, if it exists
+ *
+ * @param $group \type{\string} Internal group name
+ * @return \type{\string} Localized descriptive group name
*/
static function getGroupName( $group ) {
global $wgMessageCache;
}
/**
- * @param $group String: key name
- * @return string localized descriptive name for member of a group, if provided
+ * Get the localized descriptive name for a member of a group, if it exists
+ *
+ * @param $group \type{\string} Internal group name
+ * @return \type{\string} Localized name for group member
*/
static function getGroupMember( $group ) {
global $wgMessageCache;
/**
* Return the set of defined explicit groups.
* The implicit groups (by default *, 'user' and 'autoconfirmed')
- * are not included, as they are defined automatically,
- * not in the database.
- * @return array
+ * are not included, as they are defined automatically, not in the database.
+ * @return \type{\arrayof{\string}} Array of internal group names
*/
static function getAllGroups() {
global $wgGroupPermissions;
}
/**
- * Get a list of all available permissions
+ * Get a list of all available permissions.
+ * @return \type{\arrayof{\string}} Array of permission names
*/
static function getAllRights() {
if ( self::$mAllRights === false ) {
/**
* Get a list of implicit groups
- *
- * @return array
+ * @return \type{\arrayof{\string}} Array of internal group names
*/
public static function getImplicitGroups() {
global $wgImplicitGroups;
/**
* Get the title of a page describing a particular group
*
- * @param $group Name of the group
- * @return mixed
+ * @param $group \type{\string} Internal group name
+ * @return \twotypes{Title,\bool} Title of the page if it exists, false otherwise
*/
static function getGroupPage( $group ) {
global $wgMessageCache;
}
/**
- * Create a link to the group in HTML, if available
+ * Create a link to the group in HTML, if available;
+ * else return the group name.
*
- * @param $group Name of the group
- * @param $text The text of the link
- * @return mixed
+ * @param $group \type{\string} Internal name of the group
+ * @param $text \type{\string} The text of the link
+ * @return \type{\string} HTML link to the group
*/
static function makeGroupLinkHTML( $group, $text = '' ) {
if( $text == '' ) {
}
/**
- * Create a link to the group in Wikitext, if available
+ * Create a link to the group in Wikitext, if available;
+ * else return the group name.
*
- * @param $group Name of the group
- * @param $text The text of the link (by default, the name of the group)
- * @return mixed
+ * @param $group \type{\string} Internal name of the group
+ * @param $text \type{\string} The text of the link
+ * @return \type{\string} Wikilink to the group
*/
static function makeGroupLinkWiki( $group, $text = '' ) {
if( $text == '' ) {
$this->invalidateCache();
}
+ /**
+ * Get the description of a given right
+ *
+ * @param $right \type{\string} Right to query
+ * @return \type{\string} Localized description of the right
+ */
static function getRightDescription( $right ) {
global $wgMessageCache;
$wgMessageCache->loadAllMessages();
/**
* Make an old-style password hash
*
- * @param $password String: plain-text password
- * @param $userId String: user ID
+ * @param $password \type{\string} Plain-text password
+ * @param $userId \type{\string} %User ID
+ * @return \type{\string} Password hash
*/
static function oldCrypt( $password, $userId ) {
global $wgPasswordSalt;
/**
* Make a new-style password hash
*
- * @param $password String: plain-text password
- * @param $salt String: salt, may be random or the user ID. False to generate a salt.
+ * @param $password \type{\string} Plain-text password
+ * @param $salt \type{\string} Optional salt, may be random or the user ID.
+ * If unspecified or false, will generate one automatically
+ * @return \type{\string} Password hash
*/
static function crypt( $password, $salt = false ) {
global $wgPasswordSalt;
* Compare a password hash with a plain-text password. Requires the user
* ID if there's a chance that the hash is an old-style hash.
*
- * @param $hash String: password hash
- * @param $password String: plain-text password to compare
- * @param $userId String: user ID for old-style password salt
+ * @param $hash \type{\string} Password hash
+ * @param $password \type{\string} Plain-text password to compare
+ * @param $userId \type{\string} %User ID for old-style password salt
+ * @return \type{\bool} True if matches, false otherwise
*/
static function comparePasswords( $hash, $password, $userId = false ) {
$m = false;
return self::oldCrypt( $password, $userId ) === $hash;
}
}
+
+ /**
+ * Add a newuser log entry for this user
+ * @param bool $byEmail, account made by email?
+ */
+ public function addNewUserLogEntry( $byEmail = false ) {
+ global $wgUser, $wgContLang, $wgNewUserLog;
+ if( empty($wgNewUserLog) ) {
+ return true; // disabled
+ }
+ $talk = $wgContLang->getFormattedNsText( NS_TALK );
+ if( $this->getName() == $wgUser->getName() ) {
+ $action = 'create';
+ $message = '';
+ } else {
+ $action = 'create2';
+ $message = $byEmail ? wfMsgForContent( 'newuserlog-byemail' ) : '';
+ }
+ $log = new LogPage( 'newusers' );
+ $log->addEntry( $action, $this->getUserPage(), $message, array( $this->getId() ) );
+ return true;
+ }
+
+ /**
+ * Add an autocreate newuser log entry for this user
+ * Used by things like CentralAuth and perhaps other authplugins.
+ */
+ public function addNewUserLogEntryAutoCreate() {
+ global $wgNewUserLog;
+ if( empty($wgNewUserLog) ) {
+ return true; // disabled
+ }
+ $log = new LogPage( 'newusers', false );
+ $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
+ return true;
+ }
+
}
dépôts / lhc / web / wiklou.git / blobdiff