*/
/**
- * \int Number of characters in user_token field.
+ * Int Number of characters in user_token field.
* @ingroup Constants
*/
define( 'USER_TOKEN_LENGTH', 32 );
/**
- * \int Serialized record version.
+ * Int Serialized record version.
* @ingroup Constants
*/
define( 'MW_USER_VERSION', 8 );
/**
- * \string Some punctuation to prevent editing from broken text-mangling proxies.
+ * String Some punctuation to prevent editing from broken text-mangling proxies.
* @ingroup Constants
*/
define( 'EDIT_TOKEN_SUFFIX', '+\\' );
* of the database.
*/
class User {
-
/**
- * \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
+ * Global constants made accessible as class constants so that autoloader
+ * magic can be used.
*/
- public static $mToggles = array(
- 'highlightbroken',
- 'justify',
- 'hideminor',
- 'extendwatchlist',
- 'usenewrc',
- 'numberheadings',
- 'showtoolbar',
- 'editondblclick',
- 'editsection',
- 'editsectiononrightclick',
- 'showtoc',
- 'rememberpassword',
- 'editwidth',
- 'watchcreations',
- 'watchdefault',
- 'watchmoves',
- 'watchdeletion',
- 'minordefault',
- 'previewontop',
- 'previewonfirst',
- 'nocache',
- 'enotifwatchlistpages',
- 'enotifusertalkpages',
- 'enotifminoredits',
- 'enotifrevealaddr',
- 'shownumberswatching',
- 'fancysig',
- 'externaleditor',
- 'externaldiff',
- 'showjumplinks',
- 'uselivepreview',
- 'forceeditsummary',
- 'watchlisthideminor',
- 'watchlisthidebots',
- 'watchlisthideown',
- 'watchlisthideanons',
- 'watchlisthideliu',
- 'ccmeonemails',
- 'diffonly',
- 'showhiddencats',
- 'noconvertlink',
- 'norollbackdiff',
- );
+ const USER_TOKEN_LENGTH = USER_TOKEN_LENGTH;
+ const MW_USER_VERSION = MW_USER_VERSION;
+ const EDIT_TOKEN_SUFFIX = EDIT_TOKEN_SUFFIX;
/**
- * \type{\arrayof{\string}} List of member variables which are saved to the
+ * Array of Strings 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
);
/**
- * \type{\arrayof{\string}} Core rights.
+ * Array of Strings Core rights.
* Each of these should have a corresponding message of the form
* "right-$right".
* @showinitializer
'deletedhistory',
'deletedtext',
'deleterevision',
+ 'disableaccount',
'edit',
'editinterface',
'editusercssjs',
'reupload',
'reupload-shared',
'rollback',
+ 'selenium',
'sendemail',
'siteadmin',
'suppressionlog',
'writeapi',
);
/**
- * \string Cached results of getAllRights()
+ * String Cached results of getAllRights()
*/
static $mAllRights = false;
//@}
/**
- * \bool Whether the cache variables have been loaded.
+ * Bool Whether the cache variables have been loaded.
*/
var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
/**
- * \string Initialization data source if mDataLoaded==false. May be one of:
+ * 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
*/
var $mFrom;
- /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
- //@{
+ /**
+ * Lazy-initialized variables, invalidated with clearInstanceCache
+ */
var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
$mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
$mLocked, $mHideName, $mOptions;
- //@}
-
+
static $idCacheByName = array();
/**
* @see newFromSession()
* @see newFromRow()
*/
- function User() {
+ function __construct() {
$this->clearInstanceCache( 'defaults' );
}
/**
* Load user table data, given mId has already been set.
- * @return \bool false if the ID does not exist, true otherwise
+ * @return Bool false if the ID does not exist, true otherwise
* @private
*/
function loadFromId() {
}
if ( !$data ) {
- wfDebug( "Cache miss for user {$this->mId}\n" );
+ wfDebug( "User: cache miss for user {$this->mId}\n" );
# Load from DB
if ( !$this->loadFromDatabase() ) {
# Can't load from ID, user is anonymous
}
$this->saveToCache();
} else {
- wfDebug( "Got user {$this->mId} from cache\n" );
+ wfDebug( "User: got user {$this->mId} from cache\n" );
# Restore from cache
foreach ( self::$mCacheVars as $name ) {
$this->$name = $data[$name];
* 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 String Username, validated by Title::newFromText()
+ * @param $validate String|Bool Validate username. Takes the same parameters as
* User::getCanonicalName(), except that true is accepted as an alias
* for 'valid', for BC.
*
- * @return \type{User} The User object, or null if the username is invalid. If the
+ * @return User object, or false if the username is invalid
+ * (e.g. if it contains illegal characters or is an IP address). 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.
*/
$validate = 'valid';
}
$name = self::getCanonicalName( $name, $validate );
- if ( WikiError::isError( $name ) ) {
- return $name;
- } elseif ( $name === false ) {
+ if ( $name === false ) {
return false;
} else {
# Create unloaded user object
/**
* Static factory method for creation from a given user ID.
*
- * @param $id \int Valid user ID
- * @return \type{User} The corresponding User object
+ * @param $id Int Valid user ID
+ * @return User The corresponding User object
*/
static function newFromId( $id ) {
$u = new User;
*
* If the code is invalid or has expired, returns NULL.
*
- * @param $code \string Confirmation code
- * @return \type{User}
+ * @param $code String Confirmation code
+ * @return 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 \type{User}
+ * @return 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}
+ * @param $row Array A row from the user table
+ * @return User
*/
static function newFromRow( $row ) {
$user = new User;
/**
* Get the username corresponding to a given user ID
- * @param $id \int User ID
- * @return \string The corresponding username
+ * @param $id Int User ID
+ * @return String The corresponding username
*/
static function whoIs( $id ) {
$dbr = wfGetDB( DB_SLAVE );
- return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
+ return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__ );
}
/**
* Get the real name of a user given their user ID
*
- * @param $id \int User ID
- * @return \string The corresponding user's real name
+ * @param $id Int User ID
+ * @return 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 Username
- * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
+ * @param $name String Username
+ * @return Int|Null The corresponding user's ID, or null if user is nonexistent
*/
static function idFromName( $name ) {
$nt = Title::makeTitleSafe( NS_USER, $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 String to match
- * @return \bool True or false
+ * @param $name String to match
+ * @return Bool
*/
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 String to match
- * @return \bool True or false
+ * @param $name String to match
+ * @return Bool
*/
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 String to match
- * @return \bool True or false
+ * @param $name String to match
+ * @return Bool
*/
static function isUsableName( $name ) {
global $wgReservedUsernames;
* either by batch processes or by user accounts which have
* already been created.
*
- * Additional character blacklisting may be added here
- * rather than in isValidUserName() to avoid disrupting
- * existing accounts.
+ * Additional blacklisting may be added here rather than in
+ * isValidUserName() to avoid disrupting existing accounts.
*
- * @param $name \string String to match
- * @return \bool True or false
+ * @param $name String to match
+ * @return Bool
*/
static function isCreatableName( $name ) {
global $wgInvalidUsernameCharacters;
- return
- self::isUsableName( $name ) &&
- // Registration-time character blacklisting...
- !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
+ // Ensure that the username isn't longer than 235 bytes, so that
+ // (at least for the builtin skins) user javascript and css files
+ // will work. (bug 23080)
+ if( strlen( $name ) > 235 ) {
+ wfDebugLog( 'username', __METHOD__ .
+ ": '$name' invalid due to length" );
+ return false;
+ }
+
+ if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
+ wfDebugLog( 'username', __METHOD__ .
+ ": '$name' invalid due to wgInvalidUsernameCharacters" );
+ return false;
+ }
+
+ return self::isUsableName( $name );
}
/**
* Is the input a valid password for this user?
*
* @param $password String Desired password
- * @return bool True or false
+ * @return Bool
*/
function isValidPassword( $password ) {
//simple boolean wrapper for getPasswordValidity
function getPasswordValidity( $password ) {
global $wgMinimalPasswordLength, $wgContLang;
+ static $blockedLogins = array(
+ 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
+ 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
+ );
+
$result = false; //init $result to false for the internal checks
-
+
if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
return $result;
-
+
if ( $result === false ) {
if( strlen( $password ) < $wgMinimalPasswordLength ) {
return 'passwordtooshort';
} elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName ) ) {
return 'password-name-match';
+ } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
+ return 'password-login-forbidden';
} else {
//it seems weird returning true here, but this is because of the
//initialization of $result to false above. If the hook is never run or it
*
* @todo Check for RFC 2822 compilance (bug 959)
*
- * @param $addr \string E-mail address
- * @return \bool True or false
+ * @param $addr String E-mail address
+ * @return Bool
*/
public static function isValidEmailAddr( $addr ) {
$result = null;
if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
return $result;
}
+ $rfc5322_atext = "a-z0-9!#$%&'*+-\/=?^_`{|}—~" ;
+ $rfc1034_ldh_str = "a-z0-9-" ;
+
+ $HTML5_email_regexp = "/
+ ^ # start of string
+ [$rfc5322_atext\\.]+ # user part which is liberal :p
+ @ # 'apostrophe'
+ [$rfc1034_ldh_str]+ # First domain part
+ (\\.[$rfc1034_ldh_str]+)+ # Following part prefixed with a dot
+ $ # End of string
+ /ix" ; // case Insensitive, eXtended
- return strpos( $addr, '@' ) !== false;
+ return (bool) preg_match( $HTML5_email_regexp, $addr );
}
/**
* Given unvalidated user input, return a canonical username, or false if
* the username is invalid.
- * @param $name \string User input
- * @param $validate \types{\string,\bool} Type of validation to use:
+ * @param $name String User input
+ * @param $validate 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' ) {
- # Maybe force usernames to capital
- $name = Title::capitalize( $name, NS_USER );
+ # Force usernames to capital
+ global $wgContLang;
+ $name = $wgContLang->ucfirst( $name );
# Reject names containing '#'; these will be cleaned up
# with title normalisation, but then it's too late to
# check elsewhere
if( strpos( $name, '#' ) !== false )
- return new WikiError( 'usernamehasherror' );
+ return false;
# Clean up name according to title rules
$t = ( $validate === 'valid' ) ?
}
# Reject various classes of invalid names
- $name = $t->getText();
global $wgAuth;
$name = $wgAuth->getCanonicalName( $t->getText() );
* 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
*
- * @param $uid \int User ID to check
- * @return \int The user's edit count
+ * @param $uid Int User ID to check
+ * @return 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 New random password
+ * @return String new random password
*/
static function randomPassword() {
global $wgMinimalPasswordLength;
function loadDefaults( $name = false ) {
wfProfileIn( __METHOD__ );
- global $wgCookiePrefix;
+ global $wgRequest;
$this->mId = 0;
$this->mName = $name;
$this->mOptionOverrides = null;
$this->mOptionsLoaded = false;
- if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
- $this->mTouched = wfTimestamp( TS_MW, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
+ if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
+ $this->mTouched = wfTimestamp( TS_MW, $wgRequest->getCookie( 'LoggedOut' ) );
} else {
$this->mTouched = '0'; # Allow any pages to be cached
}
wfProfileOut( __METHOD__ );
}
- /**
- * @deprecated Use wfSetupSession().
- */
- function SetupSession() {
- wfDeprecated( __METHOD__ );
- wfSetupSession();
- }
-
/**
* Load user data from the session or login cookie. If there are no valid
* credentials, initialises the user as an anonymous user.
- * @return \bool True if the user is logged in, false otherwise.
+ * @return Bool True if the user is logged in, false otherwise.
*/
private function loadFromSession() {
- global $wgMemc, $wgCookiePrefix;
+ global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
$result = null;
wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
return $result;
}
- if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
- $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
+ if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
+ $extUser = ExternalUser::newFromCookie();
+ if ( $extUser ) {
+ # TODO: Automatically create the user here (or probably a bit
+ # lower down, in fact)
+ }
+ }
+
+ if ( $wgRequest->getCookie( 'UserID' ) !== null ) {
+ $sId = intval( $wgRequest->getCookie( 'UserID' ) );
if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
$this->loadDefaults(); // Possible collision!
wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
if ( isset( $_SESSION['wsUserName'] ) ) {
$sName = $_SESSION['wsUserName'];
- } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
- $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
+ } else if ( $wgRequest->getCookie('UserName') !== null ) {
+ $sName = $wgRequest->getCookie('UserName');
$_SESSION['wsUserName'] = $sName;
} else {
$this->loadDefaults();
return false;
}
- $passwordCorrect = FALSE;
$this->mId = $sId;
if ( !$this->loadFromId() ) {
# Not a valid ID, loadFromId has switched the object to anon for us
return false;
}
+ global $wgBlockDisablesLogin;
+ if( $wgBlockDisablesLogin && $this->isBlocked() ) {
+ # User blocked and we've disabled blocked user logins
+ $this->loadDefaults();
+ return false;
+ }
+
if ( isset( $_SESSION['wsToken'] ) ) {
$passwordCorrect = $_SESSION['wsToken'] == $this->mToken;
$from = 'session';
- } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
- $passwordCorrect = $this->mToken == $_COOKIE["{$wgCookiePrefix}Token"];
+ } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
+ $passwordCorrect = $this->mToken == $wgRequest->getCookie( 'Token' );
$from = 'cookie';
} else {
# No session or persistent login cookie
if ( ( $sName == $this->mName ) && $passwordCorrect ) {
$_SESSION['wsToken'] = $this->mToken;
- wfDebug( "Logged in from $from\n" );
+ wfDebug( "User: logged in from $from\n" );
return true;
} else {
# Invalid credentials
- wfDebug( "Can't log in from $from, invalid credentials\n" );
+ wfDebug( "User: can't log in from $from, invalid credentials\n" );
$this->loadDefaults();
return false;
}
* Load user and user_group data from the database.
* $this::mId must be set, this is how the user is identified.
*
- * @return \bool True if the user exists, false if the user is anonymous
+ * @return Bool True if the user exists, false if the user is anonymous
* @private
*/
function loadFromDatabase() {
/**
* Initialize this object from a row from the user table.
*
- * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
+ * @param $row Array Row from the user table to load.
*/
function loadFromRow( $row ) {
$this->mDataLoaded = true;
array( 'ug_user' => $this->mId ),
__METHOD__ );
$this->mGroups = array();
- while( $row = $dbr->fetchObject( $res ) ) {
+ foreach ( $res as $row ) {
$this->mGroups[] = $row->ug_group;
}
}
/**
* Clear various cached data stored in this object.
- * @param $reloadFrom \string Reload user and user_groups table data from a
+ * @param $reloadFrom String Reload user and user_groups table data from a
* given source. May be "name", "id", "defaults", "session", or false for
* no reload.
*/
* Combine the language default options with any site-specific options
* and add the default language variants.
*
- * @return \type{\arrayof{\string}} Array of options
+ * @return Array of String options
*/
static function getDefaultOptions() {
global $wgNamespacesToBeSearchedDefault;
/**
* default language setting
*/
- $variant = $wgContLang->getPreferredVariant( false );
+ $variant = $wgContLang->getDefaultVariant();
$defOpt['variant'] = $variant;
$defOpt['language'] = $variant;
foreach( SearchEngine::searchableNamespaces() as $nsnum => $nsname ) {
$defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
}
$defOpt['skin'] = $wgDefaultSkin;
-
+
return $defOpt;
}
/**
* Get a given default option value.
*
- * @param $opt \string Name of option to retrieve
- * @return \string Default option value
+ * @param $opt String Name of option to retrieve
+ * @return String Default option value
*/
public static function getDefaultOption( $opt ) {
$defOpts = self::getDefaultOptions();
}
}
- /**
- * Get a list of user toggle names
- * @return \type{\arrayof{\string}} Array of user toggle names
- */
- static function getToggles() {
- global $wgContLang, $wgUseRCPatrol;
- $extraToggles = array();
- wfRunHooks( 'UserToggles', array( &$extraToggles ) );
- if( $wgUseRCPatrol ) {
- $extraToggles[] = 'hidepatrolled';
- $extraToggles[] = 'newpageshidepatrolled';
- $extraToggles[] = 'watchlisthidepatrolled';
- }
- return array_merge( self::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
- }
-
/**
* Get blocking information
* @private
- * @param $bFromSlave \bool Whether to check the slave database first. To
+ * @param $bFromSlave 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.
*/
function getBlockedStatus( $bFromSlave = true ) {
- global $wgEnableSorbs, $wgProxyWhitelist, $wgUser;
+ global $wgProxyWhitelist, $wgUser;
if ( -1 != $this->mBlockedby ) {
- wfDebug( "User::getBlockedStatus: already loaded.\n" );
return;
}
# Check if we are looking at an IP or a logged-in user
if ( $this->isIP( $this->getName() ) ) {
- $ip = $this->getName();
+ $ip = $this->getName();
} else {
# Check if we are looking at the current user
# If we don't, and the user is logged in, we don't know about
if ( $this->mBlock->load( $ip , $this->mId ) ) {
wfDebug( __METHOD__ . ": Found block.\n" );
$this->mBlockedby = $this->mBlock->mBy;
+ if( $this->mBlockedby == 0 )
+ $this->mBlockedby = $this->mBlock->mByName;
$this->mBlockreason = $this->mBlock->mReason;
$this->mHideName = $this->mBlock->mHideName;
$this->mAllowUsertalk = $this->mBlock->mAllowUsertalk;
}
# DNSBL
- if ( !$this->mBlockedby && $wgEnableSorbs && !$this->getID() ) {
- if ( $this->inSorbsBlacklist( $ip ) ) {
+ if ( !$this->mBlockedby && !$this->getID() ) {
+ if ( $this->isDnsBlacklisted( $ip ) ) {
$this->mBlockedby = wfMsg( 'sorbs' );
$this->mBlockreason = wfMsg( 'sorbsreason' );
}
}
/**
- * Whether the given IP is in the SORBS blacklist.
+ * Whether the given IP is in a DNS blacklist.
*
- * @param $ip \string IP to check
- * @return \bool True if blacklisted.
+ * @param $ip String IP to check
+ * @param $checkWhitelist Bool: whether to check the whitelist first
+ * @return Bool True if blacklisted.
*/
- function inSorbsBlacklist( $ip ) {
- global $wgEnableSorbs, $wgSorbsUrl;
+ function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
+ global $wgEnableSorbs, $wgEnableDnsBlacklist,
+ $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
- return $wgEnableSorbs &&
- $this->inDnsBlacklist( $ip, $wgSorbsUrl );
+ if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
+ return false;
+
+ if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
+ return false;
+
+ $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
+ return $this->inDnsBlacklist( $ip, $urls );
}
/**
* Whether the given IP is in a given DNS blacklist.
*
- * @param $ip \string IP to check
- * @param $bases \string or Array of Strings: URL of the DNS blacklist
- * @return \bool True if blacklisted.
+ * @param $ip String IP to check
+ * @param $bases String|Array of Strings: URL of the DNS blacklist
+ * @return Bool True if blacklisted.
*/
function inDnsBlacklist( $ip, $bases ) {
wfProfileIn( __METHOD__ );
$found = false;
- $host = '';
// FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
if( IP::isIPv4( $ip ) ) {
# Reverse IP, bug 21255
/**
* Is this user subject to rate limiting?
*
- * @return \bool True if rate limited
+ * @return Bool True if rate limited
*/
public function isPingLimitable() {
global $wgRateLimitsExcludedGroups;
* @note When using a shared cache like memcached, IP-address
* last-hit counters will be shared across wikis.
*
- * @param $action \string Action to enforce; 'edit' if unspecified
- * @return \bool True if a rate limiter was tripped
+ * @param $action String Action to enforce; 'edit' if unspecified
+ * @return Bool True if a rate limiter was tripped
*/
function pingLimiter( $action = 'edit' ) {
# Call the 'PingLimiter' hook
} else {
wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" );
}
- $wgMemc->incr( $key );
} else {
wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
- $wgMemc->set( $key, 1, intval( $period ) ); // first ping
+ $wgMemc->add( $key, 0, intval( $period ) ); // first ping
}
+ $wgMemc->incr( $key );
}
wfProfileOut( __METHOD__ );
/**
* Check if user is blocked
*
- * @param $bFromSlave \bool Whether to check the slave database instead of the master
- * @return \bool True if blocked, false otherwise
+ * @param $bFromSlave Bool Whether to check the slave database instead of the master
+ * @return Bool True if blocked, false otherwise
*/
function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
- wfDebug( "User::isBlocked: enter\n" );
$this->getBlockedStatus( $bFromSlave );
return $this->mBlockedby !== 0;
}
/**
* Check if user is blocked from editing a particular article
*
- * @param $title \string Title to check
- * @param $bFromSlave \bool Whether to check the slave database instead of the master
- * @return \bool True if blocked, false otherwise
+ * @param $title Title to check
+ * @param $bFromSlave Bool whether to check the slave database instead of the master
+ * @return Bool
*/
function isBlockedFrom( $title, $bFromSlave = false ) {
global $wgBlockAllowsUTEdit;
wfProfileIn( __METHOD__ );
- wfDebug( __METHOD__ . ": enter\n" );
- wfDebug( __METHOD__ . ": asking isBlocked()\n" );
$blocked = $this->isBlocked( $bFromSlave );
$allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false );
# If a user's name is suppressed, they cannot make edits anywhere
$blocked = false;
wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
}
-
+
wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
-
+
wfProfileOut( __METHOD__ );
return $blocked;
}
/**
* If user is blocked, return the name of the user who placed the block
- * @return \string name of blocker
+ * @return String name of blocker
*/
function blockedBy() {
$this->getBlockedStatus();
/**
* If user is blocked, return the specified reason for the block
- * @return \string Blocking reason
+ * @return String Blocking reason
*/
function blockedFor() {
$this->getBlockedStatus();
/**
* If user is blocked, return the ID for the block
- * @return \int Block ID
+ * @return Int Block ID
*/
function getBlockId() {
$this->getBlockedStatus();
* Do not use for actual edit permission checks!
* This is intented for quick UI checks.
*
- * @param $ip \type{\string} IP address, uses current client if none given
- * @return \type{\bool} True if blocked, false otherwise
+ * @param $ip String IP address, uses current client if none given
+ * @return Bool True if blocked, false otherwise
*/
function isBlockedGlobally( $ip = '' ) {
if( $this->mBlockedGlobally !== null ) {
/**
* Check if user account is locked
*
- * @return \type{\bool} True if locked, false otherwise
+ * @return Bool True if locked, false otherwise
*/
function isLocked() {
if( $this->mLocked !== null ) {
/**
* Check if user account is hidden
*
- * @return \type{\bool} True if hidden, false otherwise
+ * @return Bool True if hidden, false otherwise
*/
function isHidden() {
if( $this->mHideName !== null ) {
/**
* Get the user's ID.
- * @return \int The user's ID; 0 if the user is anonymous or nonexistent
+ * @return 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 a given ID
- * @param $v \int User ID to reload
+ * @param $v Int User ID to reload
*/
function setId( $v ) {
$this->mId = $v;
/**
* Get the user name, or the IP of an anonymous user
- * @return \string User's name or IP address
+ * @return String User's name or IP address
*/
function getName() {
if ( !$this->mDataLoaded && $this->mFrom == 'name' ) {
*
* @note User::newFromName() has rougly the same function, when the named user
* does not exist.
- * @param $str \string New user name to set
+ * @param $str String New user name to set
*/
function setName( $str ) {
$this->load();
/**
* Get the user's name escaped by underscores.
- * @return \string Username escaped by underscores.
+ * @return String Username escaped by underscores.
*/
function getTitleKey() {
return str_replace( ' ', '_', $this->getName() );
/**
* Check if the user has new messages.
- * @return \bool True if the user has new messages
+ * @return 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
+ * @return Array of String page URLs
*/
function getNewMessageLinks() {
$talks = array();
* Internal uncached check for new messages
*
* @see getNewtalk()
- * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
- * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
- * @param $fromMaster \bool true to fetch from the master, false for a slave
- * @return \bool True if the user has new messages
+ * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id String|Int User's IP address for anonymous users, User ID otherwise
+ * @param $fromMaster Bool true to fetch from the master, false for a slave
+ * @return Bool True if the user has new messages
* @private
*/
function checkNewtalk( $field, $id, $fromMaster = false ) {
/**
* Add or update the new messages flag
- * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
- * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
- * @return \bool True if successful, false otherwise
+ * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id String|Int User's IP address for anonymous users, User ID otherwise
+ * @return Bool True if successful, false otherwise
* @private
*/
function updateNewtalk( $field, $id ) {
/**
* Clear the new messages flag for the given user
- * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
- * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
- * @return \bool True if successful, false otherwise
+ * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id String|Int User's IP address for anonymous users, User ID otherwise
+ * @return Bool True if successful, false otherwise
* @private
*/
function deleteNewtalk( $field, $id ) {
/**
* Update the 'You have new messages!' status.
- * @param $val \bool Whether the user has new messages
+ * @param $val 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 \string Timestamp in TS_MW format
+ * @return String Timestamp in TS_MW format
*/
private static function newTouchedTimestamp() {
global $wgClockSkewFudge;
/**
* Validate the cache for this account.
- * @param $timestamp \string A timestamp in TS_MW format
+ * @param $timestamp String A timestamp in TS_MW format
*/
function validateCache( $timestamp ) {
$this->load();
/**
* Get the user touched timestamp
+ * @return String timestamp
*/
function getTouched() {
$this->load();
* wipes it, so the account cannot be logged in until
* a new password is set, for instance via e-mail.
*
- * @param $str \string New password to set
+ * @param $str String New password to set
* @throws PasswordError on failure
*/
function setPassword( $str ) {
if( !$wgAuth->allowPasswordChange() ) {
throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
}
-
+
if( !$this->isValidPassword( $str ) ) {
- global $wgMinimalPasswordLength;
+ global $wgMinimalPasswordLength;
$valid = $this->getPasswordValidity( $str );
throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
$wgMinimalPasswordLength ) );
- }
+ }
}
if( !$wgAuth->setPassword( $this, $str ) ) {
/**
* Set the password and reset the random token unconditionally.
*
- * @param $str \string New password to set
+ * @param $str String New password to set
*/
function setInternalPassword( $str ) {
$this->load();
/**
* Get the user's current token.
- * @return \string Token
+ * @return String Token
*/
function getToken() {
$this->load();
* Set the random token (used for persistent authentication)
* Called from loadDefaults() among other places.
*
- * @param $token \string If specified, set the token to this value
+ * @param $token String If specified, set the token to this value
* @private
*/
function setToken( $token = false ) {
/**
* Set the cookie password
*
- * @param $str \string New cookie password
+ * @param $str String New cookie password
* @private
*/
function setCookiePassword( $str ) {
/**
* Set the password for a password reminder or new account email
*
- * @param $str \string New password to set
- * @param $throttle \bool If true, reset the throttle timestamp to the present
+ * @param $str String New password to set
+ * @param $throttle Bool If true, reset the throttle timestamp to the present
*/
function setNewpassword( $str, $throttle = true ) {
$this->load();
/**
* Has password reminder email been sent within the last
* $wgPasswordReminderResendTime hours?
- * @return \bool True or false
+ * @return Bool
*/
function isPasswordReminderThrottled() {
global $wgPasswordReminderResendTime;
/**
* Get the user's e-mail address
- * @return \string User's email address
+ * @return String User's email address
*/
function getEmail() {
$this->load();
/**
* Get the timestamp of the user's e-mail authentication
- * @return \string TS_MW timestamp
+ * @return String TS_MW timestamp
*/
function getEmailAuthenticationTimestamp() {
$this->load();
/**
* Set the user's e-mail address
- * @param $str \string New e-mail address
+ * @param $str String New e-mail address
*/
function setEmail( $str ) {
$this->load();
/**
* Get the user's real name
- * @return \string User's real name
+ * @return String User's real name
*/
function getRealName() {
$this->load();
/**
* Set the user's real name
- * @param $str \string New real name
+ * @param $str String New real name
*/
function setRealName( $str ) {
$this->load();
/**
* Get the user's current setting for a given option.
*
- * @param $oname \string The option to check
- * @param $defaultOverride \string A default value returned if the option does not exist
- * @return \string User's current value for the option
+ * @param $oname String The option to check
+ * @param $defaultOverride String A default value returned if the option does not exist
+ * @return String User's current value for the option
* @see getBoolOption()
* @see getIntOption()
*/
}
}
+ /**
+ * Get all user's options
+ *
+ * @return array
+ */
+ public function getOptions() {
+ $this->loadOptions();
+ return $this->mOptions;
+ }
+
/**
* Get the user's current setting for a given option, as a boolean value.
*
- * @param $oname \string The option to check
- * @return \bool User's current value for the option
+ * @param $oname String The option to check
+ * @return Bool User's current value for the option
* @see getOption()
*/
function getBoolOption( $oname ) {
/**
* Get the user's current setting for a given option, as a boolean value.
*
- * @param $oname \string The option to check
- * @param $defaultOverride \int A default value returned if the option does not exist
- * @return \int User's current value for the option
+ * @param $oname String The option to check
+ * @param $defaultOverride Int A default value returned if the option does not exist
+ * @return Int User's current value for the option
* @see getOption()
*/
function getIntOption( $oname, $defaultOverride=0 ) {
/**
* Set the given option for a user.
*
- * @param $oname \string The option to set
- * @param $val \mixed New value to set
+ * @param $oname String The option to set
+ * @param $val mixed New value to set
*/
function setOption( $oname, $val ) {
$this->load();
if ( $oname == 'skin' ) {
# Clear cached skin, so the new one displays immediately in Special:Preferences
- unset( $this->mSkin );
+ $this->mSkin = null;
}
// Explicitly NULL values should refer to defaults
/**
* Get the user's preferred date format.
- * @return \string User's preferred date format
+ * @return String User's preferred date format
*/
function getDatePreference() {
// Important migration for old data rows
return $this->mDatePreference;
}
+ /**
+ * Get the user preferred stub threshold
+ */
+ function getStubThreshold() {
+ global $wgMaxArticleSize; # Maximum article size, in Kb
+ $threshold = intval( $this->getOption( 'stubthreshold' ) );
+ if ( $threshold > $wgMaxArticleSize * 1024 ) {
+ # If they have set an impossible value, disable the preference
+ # so we can use the parser cache again.
+ $threshold = 0;
+ }
+ return $threshold;
+ }
+
/**
* Get the permissions this user has.
- * @return \type{\arrayof{\string}} Array of permission names
+ * @return Array of String permission names
*/
function getRights() {
if ( is_null( $this->mRights ) ) {
/**
* Get the list of explicit group memberships this user has.
* The implicit * and user groups are not included.
- * @return \type{\arrayof{\string}} Array of internal group names
+ * @return Array of String 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 \bool Whether to avoid the cache
- * @return \type{\arrayof{\string}} Array of internal group names
+ * '*' for all accounts, and autopromoted groups
+ * @param $recache Bool Whether to avoid the cache
+ * @return Array of String internal group names
*/
function getEffectiveGroups( $recache = false ) {
if ( $recache || is_null( $this->mEffectiveGroups ) ) {
/**
* Get the user's edit count.
- * @return \int User'e edit count
+ * @return Int
*/
function getEditCount() {
if( $this->getId() ) {
/**
* Add the user to the given group.
* This takes immediate effect.
- * @param $group \string Name of the group to add
+ * @param $group String Name of the group to add
*/
function addGroup( $group ) {
$dbw = wfGetDB( DB_MASTER );
'ug_user' => $this->getID(),
'ug_group' => $group,
),
- 'User::addGroup',
+ __METHOD__,
array( 'IGNORE' ) );
}
/**
* Remove the user from the given group.
* This takes immediate effect.
- * @param $group \string Name of the group to remove
+ * @param $group String Name of the group to remove
*/
function removeGroup( $group ) {
$this->load();
array(
'ug_user' => $this->getID(),
'ug_group' => $group,
- ),
- 'User::removeGroup' );
+ ), __METHOD__ );
$this->loadGroups();
$this->mGroups = array_diff( $this->mGroups, array( $group ) );
/**
* Get whether the user is logged in
- * @return \bool True or false
+ * @return Bool
*/
function isLoggedIn() {
return $this->getID() != 0;
/**
* Get whether the user is anonymous
- * @return \bool True or false
+ * @return Bool
*/
function isAnon() {
return !$this->isLoggedIn();
}
- /**
- * Get whether the user is a bot
- * @return \bool True or false
- * @deprecated
- */
- function isBot() {
- wfDeprecated( __METHOD__ );
- return $this->isAllowed( 'bot' );
- }
-
/**
* Check if user is allowed to access a feature / make an action
- * @param $action \string action to be checked
- * @return \bool True if action is allowed, else false
+ * @param $action String action to be checked
+ * @return Boolean: True if action is allowed, else false
*/
function isAllowed( $action = '' ) {
- if ( $action === '' )
+ if ( $action === '' ) {
return true; // In the spirit of DWIM
+ }
# Patrolling may not be enabled
if( $action === 'patrol' || $action === 'autopatrol' ) {
global $wgUseRCPatrol, $wgUseNPPatrol;
/**
* Check whether to enable recent changes patrol features for this user
- * @return \bool True or false
+ * @return Boolean: True or false
*/
public function useRCPatrol() {
global $wgUseRCPatrol;
/**
* Check whether to enable new pages patrol features for this user
- * @return \bool True or false
+ * @return Bool True or false
*/
public function useNPPatrol() {
global $wgUseRCPatrol, $wgUseNPPatrol;
* Get the current skin, loading it if required, and setting a title
* @param $t Title: the title to use in the skin
* @return Skin The current skin
- * @todo FIXME : need to check the old failback system [AV]
+ * @todo: FIXME : need to check the old failback system [AV]
*/
- function &getSkin( $t = null ) {
- if ( !isset( $this->mSkin ) ) {
- wfProfileIn( __METHOD__ );
-
- global $wgHiddenPrefs;
- if( !in_array( 'skin', $wgHiddenPrefs ) ) {
- # get the user skin
- global $wgRequest;
- $userSkin = $this->getOption( 'skin' );
- $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
- } else {
- # if we're not allowing users to override, then use the default
- global $wgDefaultSkin;
- $userSkin = $wgDefaultSkin;
+ function getSkin( $t = null ) {
+ if ( $t ) {
+ $skin = $this->createSkinObject();
+ $skin->setTitle( $t );
+ return $skin;
+ } else {
+ if ( !$this->mSkin ) {
+ $this->mSkin = $this->createSkinObject();
}
- $this->mSkin =& Skin::newFromKey( $userSkin );
- wfProfileOut( __METHOD__ );
- }
- if( $t || !$this->mSkin->getTitle() ) {
- if ( !$t ) {
+ if ( !$this->mSkin->getTitle() ) {
global $wgOut;
$t = $wgOut->getTitle();
+ $this->mSkin->setTitle($t);
}
- $this->mSkin->setTitle( $t );
+
+ return $this->mSkin;
+ }
+ }
+
+ // Creates a Skin object, for getSkin()
+ private function createSkinObject() {
+ wfProfileIn( __METHOD__ );
+
+ global $wgHiddenPrefs;
+ if( !in_array( 'skin', $wgHiddenPrefs ) ) {
+ global $wgRequest;
+ # get the user skin
+ $userSkin = $this->getOption( 'skin' );
+ $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
+ } else {
+ # if we're not allowing users to override, then use the default
+ global $wgDefaultSkin;
+ $userSkin = $wgDefaultSkin;
}
- return $this->mSkin;
+
+ $skin = Skin::newFromKey( $userSkin );
+ wfProfileOut( __METHOD__ );
+
+ return $skin;
}
/**
* Check the watched status of an article.
- * @param $title \type{Title} Title of the article to look at
- * @return \bool True if article is watched
+ * @param $title Title of the article to look at
+ * @return Bool
*/
function isWatched( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
/**
* Watch an article.
- * @param $title \type{Title} Title of the article to look at
+ * @param $title Title of the article to look at
*/
function addWatch( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
/**
* Stop watching an article.
- * @param $title \type{Title} Title of the article to look at
+ * @param $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
+ * @param $title Title of the article to look at
*/
function clearNotification( &$title ) {
global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
$dbw = wfGetDB( DB_MASTER );
$dbw->update( 'watchlist',
array( /* SET */
- 'wl_notificationtimestamp' => NULL
+ 'wl_notificationtimestamp' => null
), array( /* WHERE */
'wl_title' => $title->getDBkey(),
'wl_namespace' => $title->getNamespace(),
* 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
+ * @param $currentUser Int User ID
*/
function clearAllNotifications( $currentUser ) {
global $wgUseEnotif, $wgShowUpdatedMarker;
$dbw = wfGetDB( DB_MASTER );
$dbw->update( 'watchlist',
array( /* SET */
- 'wl_notificationtimestamp' => NULL
+ 'wl_notificationtimestamp' => null
), array( /* WHERE */
'wl_user' => $currentUser
), __METHOD__
/**
* Set this user's options from an encoded string
- * @param $str \string Encoded options to import
+ * @param $str String Encoded options to import
* @private
*/
function decodeOptions( $str ) {
$this->mOptionsLoaded = true;
$this->mOptionOverrides = array();
- $this->mOptions = array();
+ // If an option is not set in $str, use the default value
+ $this->mOptions = self::getDefaultOptions();
+
$a = explode( "\n", $str );
foreach ( $a as $s ) {
$m = array();
/**
* Set a cookie on the user's client. Wrapper for
* WebResponse::setCookie
- * @param $name \string Name of the cookie to set
- * @param $value \string Value to set
- * @param $exp \int Expiration time, as a UNIX time value;
+ * @param $name String Name of the cookie to set
+ * @param $value String Value to set
+ * @param $exp Int Expiration time, as a UNIX time value;
* if 0 or not specified, use the default $wgCookieExpiration
*/
protected function setCookie( $name, $value, $exp = 0 ) {
/**
* Clear a cookie on the user's client
- * @param $name \string Name of the cookie to clear
+ * @param $name String Name of the cookie to clear
*/
protected function clearCookie( $name ) {
$this->setCookie( $name, '', time() - 86400 );
'user_newpassword' => $this->mNewpassword,
'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
'user_real_name' => $this->mRealName,
- 'user_email' => $this->mEmail,
- 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
+ 'user_email' => $this->mEmail,
+ 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
'user_options' => '',
'user_touched' => $dbw->timestamp( $this->mTouched ),
'user_token' => $this->mToken,
'user_id' => $this->mId
), __METHOD__
);
-
+
$this->saveOptions();
-
+
wfRunHooks( 'UserSaveSettings', array( $this ) );
$this->clearSharedCache();
$this->getUserPage()->invalidateCache();
/**
* If only this user's username is known, and it exists, return the user ID.
+ * @return Int
*/
function idForName() {
$s = trim( $this->getName() );
/**
* Add a user to the database, return the user object
*
- * @param $name \string Username to add
- * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
+ * @param $name String Username to add
+ * @param $params Array of Strings 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
* - token Random authentication token. Do not set.
* - registration Registration timestamp. Do not set.
*
- * @return \type{User} A new User object, or null if the username already exists
+ * @return User object, or null if the username already exists
*/
static function createNew( $name, $params = array() ) {
$user = new User;
}
$dbw = wfGetDB( DB_MASTER );
$seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
+
$fields = array(
'user_id' => $seqVal,
'user_name' => $name,
'user_password' => $user->mPassword,
'user_newpassword' => $user->mNewpassword,
- 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime ),
+ 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime ),
'user_email' => $user->mEmail,
'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
'user_real_name' => $user->mRealName,
'user_name' => $this->mName,
'user_password' => $this->mPassword,
'user_newpassword' => $this->mNewpassword,
- 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime ),
+ 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime ),
'user_email' => $this->mEmail,
'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
'user_real_name' => $this->mRealName,
// Clear instance cache other than user table data, which is already accurate
$this->clearInstanceCache();
-
+
$this->saveOptions();
}
* which will give them a chance to modify this key based on their own
* settings.
*
- * @return \string Page rendering hash
+ * @deprecated @since 1.17 use the ParserOptions object to get the relevant options
+ * @return String Page rendering hash
*/
function getPageRenderingHash() {
global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
if( $this->mHash ){
return $this->mHash;
}
+ wfDeprecated( __METHOD__ );
// stubthreshold is only included below for completeness,
- // it will always be 0 when this function is called by parsercache.
+ // since it disables the parser cache, its value will always
+ // be 0 when this function is called by parsercache.
$confstr = $this->getOption( 'math' );
- $confstr .= '!' . $this->getOption( 'stubthreshold' );
- if ( $wgUseDynamicDates ) {
+ $confstr .= '!' . $this->getStubThreshold();
+ if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
$confstr .= '!' . $this->getDatePreference();
}
$confstr .= '!' . ( $this->getOption( 'numberheadings' ) ? '1' : '' );
$extra = $wgContLang->getExtraHashOptions();
$confstr .= $extra;
+ // Since the skin could be overloading link(), it should be
+ // included here but in practice, none of our skins do that.
+
$confstr .= $wgRenderHashAppend;
// Give a chance for extensions to modify the hash, if they have
/**
* Get whether the user is explicitly blocked from account creation.
- * @return \bool True if blocked
+ * @return Bool
*/
function isBlockedFromCreateAccount() {
$this->getBlockedStatus();
/**
* Get whether the user is blocked from using Special:Emailuser.
- * @return \bool True if blocked
+ * @return Bool
*/
function isBlockedFromEmailuser() {
$this->getBlockedStatus();
/**
* Get whether the user is allowed to create an account.
- * @return \bool True if allowed
+ * @return Bool
*/
function isAllowedToCreateAccount() {
return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
}
- /**
- * @deprecated
- */
- function setLoaded( $loaded ) {
- wfDeprecated( __METHOD__ );
- }
-
/**
* Get this user's personal page title.
*
- * @return \type{Title} User's personal page title
+ * @return Title: User's personal page title
*/
function getUserPage() {
return Title::makeTitle( NS_USER, $this->getName() );
/**
* Get this user's talk page title.
*
- * @return \type{Title} User's talk page title
+ * @return Title: User's talk page title
*/
function getTalkPage() {
$title = $this->getUserPage();
/**
* Get the maximum valid user ID.
- * @return \int User ID
+ * @return Integer: User ID
* @static
*/
function getMaxID() {
static $res; // cache
- if ( isset( $res ) )
+ if ( isset( $res ) ) {
return $res;
- else {
+ } else {
$dbr = wfGetDB( DB_SLAVE );
- return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
+ return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__ );
}
}
/**
* Determine whether the user is a newbie. Newbies are either
* anonymous IPs, or the most recently created accounts.
- * @return \bool True if the user is a newbie
+ * @return Bool
*/
function isNewbie() {
return !$this->isAllowed( 'autoconfirmed' );
/**
* 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 String: user password.
+ * @return Boolean: True if the given password is correct, otherwise False.
*/
function checkPassword( $password ) {
global $wgAuth;
// are shorter than this, doesn't mean people wont be able
// to. Certain authentication plugins do NOT want to save
// domain passwords in a mysql database, so we should
- // check this (incase $wgAuth->strict() is false).
+ // check this (in case $wgAuth->strict() is false).
if( !$this->isValidPassword( $password ) ) {
return false;
}
/**
* Check if the given clear-text password matches the temporary password
* sent by e-mail for password reset operations.
- * @return \bool True if matches, false otherwise
+ * @return Boolean: True if matches, false otherwise
*/
function checkTemporaryPassword( $plaintext ) {
global $wgNewPasswordExpiry;
if( self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ) ) {
- $this->load();
+ if ( is_null( $this->mNewpassTime ) ) {
+ return true;
+ }
$expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgNewPasswordExpiry;
return ( time() < $expiry );
} else {
* login credentials aren't being hijacked with a foreign form
* submission.
*
- * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
- * @return \string The new edit token
+ * @param $salt String|Array of Strings Optional function-specific data for hashing
+ * @return String The new edit token
*/
function editToken( $salt = '' ) {
if ( $this->isAnon() ) {
return EDIT_TOKEN_SUFFIX;
} else {
if( !isset( $_SESSION['wsEditToken'] ) ) {
- $token = $this->generateToken();
+ $token = self::generateToken();
$_SESSION['wsEditToken'] = $token;
} else {
$token = $_SESSION['wsEditToken'];
/**
* Generate a looking random token for various uses.
*
- * @param $salt \string Optional salt value
- * @return \string The new random token
+ * @param $salt String Optional salt value
+ * @return String The new random token
*/
- function generateToken( $salt = '' ) {
+ public static function generateToken( $salt = '' ) {
$token = dechex( mt_rand() ) . dechex( mt_rand() );
return md5( $token . $salt );
}
* user's own login session, not a form submission from a third-party
* site.
*
- * @param $val \string Input value to compare
- * @param $salt \string Optional function-specific data for hashing
- * @return \bool Whether the token matches
+ * @param $val String Input value to compare
+ * @param $salt String Optional function-specific data for hashing
+ * @return Boolean: Whether the token matches
*/
function matchEditToken( $val, $salt = '' ) {
$sessionToken = $this->editToken( $salt );
* Check given value against the token value stored in the session,
* ignoring the suffix.
*
- * @param $val \string Input value to compare
- * @param $salt \string Optional function-specific data for hashing
- * @return \bool Whether the token matches
+ * @param $val String Input value to compare
+ * @param $salt String Optional function-specific data for hashing
+ * @return Boolean: 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.
*
- * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
+ * @param $changed Boolean: whether the adress changed
+ * @return Status object
*/
- function sendConfirmationMail() {
+ function sendConfirmationMail( $changed = false ) {
global $wgLang;
$expiration = null; // gets passed-by-ref and defined in next line.
$token = $this->confirmationToken( $expiration );
$invalidateURL = $this->invalidationTokenUrl( $token );
$this->saveSettings();
+ $message = $changed ? 'confirmemail_body_changed' : 'confirmemail_body';
return $this->sendMail( wfMsg( 'confirmemail_subject' ),
- wfMsg( 'confirmemail_body',
+ wfMsg( $message,
wfGetIP(),
$this->getName(),
$url,
* Send an e-mail to this user's account. Does not check for
* confirmed status or validity.
*
- * @param $subject \string Message subject
- * @param $body \string Message body
- * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
- * @param $replyto \string Reply-To address
- * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
+ * @param $subject String Message subject
+ * @param $body String Message body
+ * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
+ * @param $replyto String Reply-To address
+ * @return Status
*/
function sendMail( $subject, $body, $from = null, $replyto = null ) {
if( is_null( $from ) ) {
- global $wgPasswordSender;
- $from = $wgPasswordSender;
+ global $wgPasswordSender, $wgPasswordSenderName;
+ $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
+ } else {
+ $sender = new MailAddress( $from );
}
$to = new MailAddress( $this );
- $sender = new MailAddress( $from );
return UserMailer::send( $to, $sender, $subject, $body, $replyto );
}
* this change to the database.
*
* @param[out] &$expiration \mixed Accepts the expiration time
- * @return \string New token
+ * @return String New token
* @private
*/
function confirmationToken( &$expiration ) {
$now = time();
$expires = $now + 7 * 24 * 60 * 60;
$expiration = wfTimestamp( TS_MW, $expires );
- $token = $this->generateToken( $this->mId . $this->mEmail . $expires );
+ $token = self::generateToken( $this->mId . $this->mEmail . $expires );
$hash = md5( $token );
$this->load();
$this->mEmailToken = $hash;
/**
* Return a URL the user can use to confirm their email address.
- * @param $token \string Accepts the email confirmation token
- * @return \string New token URL
+ * @param $token String Accepts the email confirmation token
+ * @return String New token URL
* @private
*/
function confirmationTokenUrl( $token ) {
/**
* Return a URL the user can use to invalidate their email address.
- * @param $token \string Accepts the email confirmation token
- * @return \string New token URL
+ * @param $token String Accepts the email confirmation token
+ * @return String New token URL
* @private
*/
function invalidationTokenUrl( $token ) {
* also sometimes can get corrupted in some browsers/mailers
* (bug 6957 with Gmail and Internet Explorer).
*
- * @param $page \string Special page
- * @param $token \string Token
- * @return \string Formatted URL
+ * @param $page String Special page
+ * @param $token String Token
+ * @return String Formatted URL
*/
protected function getTokenUrl( $page, $token ) {
global $wgArticlePath;
/**
* Set the e-mail authentication timestamp.
- * @param $timestamp \string TS_MW timestamp
+ * @param $timestamp String TS_MW timestamp
*/
function setEmailAuthenticationTimestamp( $timestamp ) {
$this->load();
/**
* Is this user allowed to send e-mails within limits of current
* site configuration?
- * @return \bool True if allowed
+ * @return Bool
*/
function canSendEmail() {
- global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
- if( !$wgEnableEmail || !$wgEnableUserEmail || !$wgUser->isAllowed( 'sendemail' ) ) {
+ global $wgEnableEmail, $wgEnableUserEmail;
+ if( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
return false;
}
$canSend = $this->isEmailConfirmed();
/**
* Is this user allowed to receive e-mails within limits of current
* site configuration?
- * @return \bool True if allowed
+ * @return Bool
*/
function canReceiveEmail() {
return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
* confirmed their address by returning a code or using a password
* sent to the address from the wiki.
*
- * @return \bool True if confirmed
+ * @return Bool
*/
function isEmailConfirmed() {
global $wgEmailAuthentication;
/**
* Check whether there is an outstanding request for e-mail confirmation.
- * @return \bool True if pending
+ * @return Bool
*/
function isEmailConfirmationPending() {
global $wgEmailAuthentication;
/**
* Get the timestamp of account creation.
*
- * @return \types{\string,\bool} string Timestamp of account creation, or false for
- * non-existent/anonymous user accounts.
+ * @return String|Bool Timestamp of account creation, or false for
+ * non-existent/anonymous user accounts.
*/
public function getRegistration() {
return $this->getId() > 0
/**
* Get the timestamp of the first edit
*
- * @return \types{\string,\bool} string Timestamp of first edit, or false for
- * non-existent/anonymous user accounts.
+ * @return String|Bool Timestamp of first edit, or false for
+ * non-existent/anonymous user accounts.
*/
public function getFirstEditTimestamp() {
- if( $this->getId() == 0 ) return false; // anons
+ if( $this->getId() == 0 ) {
+ return false; // anons
+ }
$dbr = wfGetDB( DB_SLAVE );
$time = $dbr->selectField( 'revision', 'rev_timestamp',
array( 'rev_user' => $this->getId() ),
__METHOD__,
array( 'ORDER BY' => 'rev_timestamp ASC' )
);
- if( !$time ) return false; // no edits
+ if( !$time ) {
+ return false; // no edits
+ }
return wfTimestamp( TS_MW, $time );
}
/**
* 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
+ * @param $groups Array of Strings List of internal group names
+ * @return Array of Strings List of permission key names for given groups combined
*/
static function getGroupPermissions( $groups ) {
global $wgGroupPermissions, $wgRevokePermissions;
/**
* Get all the groups who have a given permission
*
- * @param $role \string Role to check
- * @return \type{\arrayof{\string}} List of internal group names with the given permission
+ * @param $role String Role to check
+ * @return Array of Strings List of internal group names with the given permission
*/
static function getGroupsWithPermission( $role ) {
global $wgGroupPermissions;
/**
* Get the localized descriptive name for a group, if it exists
*
- * @param $group \string Internal group name
- * @return \string Localized descriptive group name
+ * @param $group String Internal group name
+ * @return String Localized descriptive group name
*/
static function getGroupName( $group ) {
- global $wgMessageCache;
- $wgMessageCache->loadAllMessages();
$key = "group-$group";
$name = wfMsg( $key );
return $name == '' || wfEmptyMsg( $key, $name )
/**
* Get the localized descriptive name for a member of a group, if it exists
*
- * @param $group \string Internal group name
- * @return \string Localized name for group member
+ * @param $group String Internal group name
+ * @return String Localized name for group member
*/
static function getGroupMember( $group ) {
- global $wgMessageCache;
- $wgMessageCache->loadAllMessages();
$key = "group-$group-member";
$name = wfMsg( $key );
return $name == '' || wfEmptyMsg( $key, $name )
* 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 \type{\arrayof{\string}} Array of internal group names
+ * @return Array of internal group names
*/
static function getAllGroups() {
global $wgGroupPermissions, $wgRevokePermissions;
/**
* Get a list of all available permissions.
- * @return \type{\arrayof{\string}} Array of permission names
+ * @return Array of permission names
*/
static function getAllRights() {
if ( self::$mAllRights === false ) {
/**
* Get a list of implicit groups
- * @return \type{\arrayof{\string}} Array of internal group names
+ * @return Array of Strings Array of internal group names
*/
public static function getImplicitGroups() {
global $wgImplicitGroups;
/**
* Get the title of a page describing a particular group
*
- * @param $group \string Internal group name
- * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
+ * @param $group String Internal group name
+ * @return Title|Bool Title of the page if it exists, false otherwise
*/
static function getGroupPage( $group ) {
- global $wgMessageCache;
- $wgMessageCache->loadAllMessages();
$page = wfMsgForContent( 'grouppage-' . $group );
if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
$title = Title::newFromText( $page );
* Create a link to the group in HTML, if available;
* else return the group name.
*
- * @param $group \string Internal name of the group
- * @param $text \string The text of the link
- * @return \string HTML link to the group
+ * @param $group String Internal name of the group
+ * @param $text String The text of the link
+ * @return String HTML link to the group
*/
static function makeGroupLinkHTML( $group, $text = '' ) {
if( $text == '' ) {
* Create a link to the group in Wikitext, if available;
* else return the group name.
*
- * @param $group \string Internal name of the group
- * @param $text \string The text of the link
- * @return \string Wikilink to the group
+ * @param $group String Internal name of the group
+ * @param $text String The text of the link
+ * @return String Wikilink to the group
*/
static function makeGroupLinkWiki( $group, $text = '' ) {
if( $text == '' ) {
*
* @param $group String: the group to check for whether it can add/remove
* @return Array array( 'add' => array( addablegroups ),
- * 'remove' => array( removablegroups ),
- * 'add-self' => array( addablegroups to self),
- * 'remove-self' => array( removable groups from self) )
+ * 'remove' => array( removablegroups ),
+ * 'add-self' => array( addablegroups to self),
+ * 'remove-self' => array( removable groups from self) )
*/
static function changeableByGroup( $group ) {
global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
/**
* Get the description of a given right
*
- * @param $right \string Right to query
- * @return \string Localized description of the right
+ * @param $right String Right to query
+ * @return String Localized description of the right
*/
static function getRightDescription( $right ) {
- global $wgMessageCache;
- $wgMessageCache->loadAllMessages();
$key = "right-$right";
$name = wfMsg( $key );
return $name == '' || wfEmptyMsg( $key, $name )
/**
* Make an old-style password hash
*
- * @param $password \string Plain-text password
- * @param $userId \string User ID
- * @return \string Password hash
+ * @param $password String Plain-text password
+ * @param $userId String User ID
+ * @return 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 Optional salt, may be random or the user ID.
+ * @param $password String Plain-text password
+ * @param $salt String Optional salt, may be random or the user ID.
* If unspecified or false, will generate one automatically
- * @return \string Password hash
+ * @return 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
- * @return \bool
+ * @param $hash String Password hash
+ * @param $password String Plain-text password to compare
+ * @param $userId String User ID for old-style password salt
+ * @return Boolean:
*/
static function comparePasswords( $hash, $password, $userId = false ) {
- $m = false;
$type = substr( $hash, 0, 3 );
$result = false;
/**
* Add a newuser log entry for this user
+ *
* @param $byEmail Boolean: account made by email?
+ * @param $reason String: user supplied reason
*/
- public function addNewUserLogEntry( $byEmail = false ) {
+ public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
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' )
- : '';
+ if ( $byEmail ) {
+ if ( $reason === '' ) {
+ $reason = wfMsgForContent( 'newuserlog-byemail' );
+ } else {
+ $reason = $wgContLang->commaList( array(
+ $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
+ }
+ }
}
$log = new LogPage( 'newusers' );
$log->addEntry(
$action,
$this->getUserPage(),
- $message,
+ $reason,
array( $this->getId() )
);
return true;
* Used by things like CentralAuth and perhaps other authplugins.
*/
public function addNewUserLogEntryAutoCreate() {
- global $wgNewUserLog;
- if( empty( $wgNewUserLog ) ) {
+ global $wgNewUserLog, $wgLogAutocreatedAccounts;
+ if( !$wgNewUserLog || !$wgLogAutocreatedAccounts ) {
return true; // disabled
}
$log = new LogPage( 'newusers', false );
}
protected function loadOptions() {
- global $wgCookiePrefix;
$this->load();
if ( $this->mOptionsLoaded || !$this->getId() )
return;
// Maybe load from the object
if ( !is_null( $this->mOptionOverrides ) ) {
- wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
+ wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
foreach( $this->mOptionOverrides as $key => $value ) {
$this->mOptions[$key] = $value;
}
} else {
- wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
+ wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
// Load from database
$dbr = wfGetDB( DB_SLAVE );
__METHOD__
);
- while( $row = $dbr->fetchObject( $res ) ) {
+ foreach ( $res as $row ) {
$this->mOptionOverrides[$row->up_property] = $row->up_value;
$this->mOptions[$row->up_property] = $row->up_value;
}
-
- //null skin if User::mId is loaded out of session data without persistant credentials
- if ( !isset( $_SESSION['wsToken'] ) && !isset( $_COOKIE["{$wgCookiePrefix}Token"] ) )
- $this->mOptions['skin'] = null;
-
}
$this->mOptionsLoaded = true;
$this->loadOptions();
$dbw = wfGetDB( DB_MASTER );
-
+
$insert_rows = array();
-
+
$saveOptions = $this->mOptions;
-
+
// Allow hooks to abort, for instance to save to a global profile.
// Reset options to default state before saving.
if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
}
/**
- * Provide an array of HTML 5 attributes to put on an input element
+ * Provide an array of HTML5 attributes to put on an input element
* intended for the user to enter a new password. This may include
* required, title, and/or pattern, depending on $wgMinimalPasswordLength.
*
*
* Obviously, you still need to do server-side checking.
*
+ * NOTE: A combination of bugs in various browsers means that this function
+ * actually just returns array() unconditionally at the moment. May as
+ * well keep it around for when the browser bugs get fixed, though.
+ *
+ * FIXME : This does not belong here; put it in Html or Linker or somewhere
+ *
* @return array Array of HTML attributes suitable for feeding to
* Html::element(), directly or indirectly. (Don't feed to Xml::*()!
* That will potentially output invalid XHTML 1.0 Transitional, and will
# Note that the pattern requirement will always be satisfied if the
# input is empty, so we need required in all cases.
- $ret = array( 'required' );
+ #
+ # FIXME (bug 23769): This needs to not claim the password is required
+ # if e-mail confirmation is being used. Since HTML5 input validation
+ # is b0rked anyway in some browsers, just return nothing. When it's
+ # re-enabled, fix this code to not output required for e-mail
+ # registration.
+ #$ret = array( 'required' );
+ $ret = array();
# We can't actually do this right now, because Opera 9.6 will print out
# the entered password visibly in its error message! When other
return $ret;
}
+
+ /**
+ * Format the user message using a hook, a template, or, failing these, a static format.
+ * @param $subject String the subject of the message
+ * @param $text String the content of the message
+ * @param $signature String the signature, if provided.
+ */
+ static protected function formatUserMessage( $subject, $text, $signature ) {
+ if ( wfRunHooks( 'FormatUserMessage',
+ array( $subject, &$text, $signature ) ) ) {
+
+ $signature = empty($signature) ? "~~~~~" : "{$signature} ~~~~~";
+
+ $template = Title::newFromText( wfMsgForContent( 'usermessage-template' ) );
+ if ( !$template
+ || $template->getNamespace() !== NS_TEMPLATE
+ || !$template->exists() ) {
+ $text = "\n== $subject ==\n\n$text\n\n-- $signature";
+ } else {
+ $text = '{{'. $template->getText()
+ . " | subject=$subject | body=$text | signature=$signature }}";
+ }
+ }
+
+ return $text;
+ }
+
+ /**
+ * Leave a user a message
+ * @param $subject String the subject of the message
+ * @param $text String the message to leave
+ * @param $signature String Text to leave in the signature
+ * @param $summary String the summary for this change, defaults to
+ * "Leave system message."
+ * @param $editor User The user leaving the message, defaults to
+ * "{{MediaWiki:usermessage-editor}}"
+ * @param $flags Int default edit flags
+ *
+ * @return boolean true if it was successful
+ */
+ public function leaveUserMessage( $subject, $text, $signature = "",
+ $summary = null, $editor = null, $flags = 0 ) {
+ if ( !isset( $summary ) ) {
+ $summary = wfMsgForContent( 'usermessage-summary' );
+ }
+
+ if ( !isset( $editor ) ) {
+ $editor = User::newFromName( wfMsgForContent( 'usermessage-editor' ) );
+ if ( !$editor->isLoggedIn() ) {
+ $editor->addToDatabase();
+ }
+ }
+
+ $article = new Article( $this->getTalkPage() );
+ wfRunHooks( 'SetupUserMessageArticle',
+ array( $this, &$article, $subject, $text, $signature, $summary, $editor ) );
+
+
+ $text = self::formatUserMessage( $subject, $text, $signature );
+ $flags = $article->checkFlags( $flags );
+
+ if ( $flags & EDIT_UPDATE ) {
+ $text = $article->getContent() . $text;
+ }
+
+ $dbw = wfGetDB( DB_MASTER );
+ $dbw->begin();
+
+ try {
+ $status = $article->doEdit( $text, $summary, $flags, false, $editor );
+ } catch ( DBQueryError $e ) {
+ $status = Status::newFatal("DB Error");
+ }
+
+ if ( $status->isGood() ) {
+ // Set newtalk with the right user ID
+ $this->setNewtalk( true );
+ wfRunHooks( 'AfterUserMessage',
+ array( $this, $article, $summary, $text, $signature, $summary, $editor ) );
+ $dbw->commit();
+ } else {
+ // The article was concurrently created
+ wfDebug( __METHOD__ . ": Error ".$status->getWikiText() );
+ $dbw->rollback();
+ }
+
+ return $status->isGood();
+ }
}
dépôts / lhc / web / wiklou.git / blobdiff