<?php
-# See user.doc
-
+/**
+ * See user.doc
+ *
+ * @package MediaWiki
+ */
+
+/**
+ *
+ */
require_once( 'WatchedItem.php' );
+/**
+ *
+ * @package MediaWiki
+ */
class User {
- /* private */ var $mId, $mName, $mPassword, $mEmail, $mNewtalk;
- /* private */ var $mRights, $mOptions;
- /* private */ var $mDataLoaded, $mNewpassword;
- /* private */ var $mSkin;
- /* private */ var $mBlockedby, $mBlockreason;
- /* private */ var $mTouched;
- /* private */ var $mCookiePassword;
- /* private */ var $mRealName;
- /* private */ var $mHash;
-
+ /**#@+
+ * @access private
+ */
+ var $mId, $mName, $mPassword, $mEmail, $mNewtalk;
+ var $mRights, $mOptions;
+ var $mDataLoaded, $mNewpassword;
+ var $mSkin;
+ var $mBlockedby, $mBlockreason;
+ var $mTouched;
+ var $mCookiePassword;
+ var $mRealName;
+ var $mHash;
+ /**#@-*/
+
+ /** Construct using User:loadDefaults() */
function User() {
$this->loadDefaults();
}
- # Static factory method
- #
+ /**
+ * Static factory method
+ * @static
+ * @param string $name Username, validated by Title:newFromText()
+ */
function newFromName( $name ) {
$u = new User();
# Clean up name according to title rules
$t = Title::newFromText( $name );
- $u->setName( $t->getText() );
- return $u;
+ if( is_null( $t ) ) {
+ return NULL;
+ } else {
+ $u->setName( $t->getText() );
+ return $u;
+ }
}
- /* static */ function whoIs( $id ) {
+ /**
+ * Get username given an id.
+ * @param integer $id Database user id
+ * @return string Nickname of a user
+ * @static
+ */
+ function whoIs( $id ) {
$dbr =& wfGetDB( DB_SLAVE );
- return $dbr->getField( 'user', 'user_name', array( 'user_id' => $id ) );
+ return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ) );
}
- /* static */ function whoIsReal( $id ) {
+ /**
+ * Get real username given an id.
+ * @param integer $id Database user id
+ * @return string Realname of a user
+ * @static
+ */
+ function whoIsReal( $id ) {
$dbr =& wfGetDB( DB_SLAVE );
- return $dbr->getField( 'user', 'user_real_name', array( 'user_id' => $id ) );
+ return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ) );
}
- /* static */ function idFromName( $name ) {
+ /**
+ * Get database id given a user name
+ * @param string $name Nickname of a user
+ * @return integer|null Database user id (null: if non existent
+ * @static
+ */
+ function idFromName( $name ) {
$fname = "User::idFromName";
$nt = Title::newFromText( $name );
return null;
}
$dbr =& wfGetDB( DB_SLAVE );
- $s = $dbr->getArray( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), $fname );
+ $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), $fname );
if ( $s === false ) {
return 0;
}
}
- # does the string match an anonymous user IP address?
- /* static */ function isIP( $name ) {
+ /**
+ * does the string match an anonymous user IP address?
+ * @param string $name Nickname of a user
+ * @static
+ */
+ function isIP( $name ) {
return preg_match("/^\d{1,3}\.\d{1,3}.\d{1,3}\.\d{1,3}$/",$name);
-
}
- /* static */ function randomPassword() {
+ /**
+ * probably return a random password
+ * @return string probably a random password
+ * @static
+ * @todo Check what is doing really [AV]
+ */
+ function randomPassword() {
$pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
$l = strlen( $pwchars ) - 1;
return $np;
}
+ /**
+ * Set properties to default
+ * Used at construction. It will load per language default settings only
+ * if we have an available language object.
+ */
function loadDefaults() {
global $wgLang, $wgIP;
global $wgNamespacesToBeSearchedDefault;
$this->mRealName = $this->mEmail = '';
$this->mPassword = $this->mNewpassword = '';
$this->mRights = array();
- $defOpt = $wgLang->getDefaultUserOptions() ;
- foreach ( $defOpt as $oname => $val ) {
- $this->mOptions[$oname] = $val;
- }
+ // Getting user defaults only if we have an available language
+ if(isset($wgLang)) { $this->loadDefaultFromLanguage(); }
+
foreach ($wgNamespacesToBeSearchedDefault as $nsnum => $val) {
$this->mOptions['searchNs'.$nsnum] = $val;
}
$this->cookiePassword = '';
$this->mHash = false;
}
-
- /* private */ function getBlockedStatus()
- {
+
+ /**
+ * Used to load user options from a language.
+ * This is not in loadDefault() cause we sometime create user before having
+ * a language object.
+ */
+ function loadDefaultFromLanguage(){
+ global $wgLang;
+ $defOpt = $wgLang->getDefaultUserOptions() ;
+ foreach ( $defOpt as $oname => $val ) {
+ $this->mOptions[$oname] = $val;
+ }
+ /* so that new user will have a default
+ language variant set using info from the http header
+ */
+ $this->setOption('variant', $wgLang->getPreferredVariant());
+ }
+
+ /**
+ * Get blocking information
+ * @access private
+ */
+ function getBlockedStatus() {
global $wgIP, $wgBlockCache, $wgProxyList;
if ( -1 != $this->mBlockedby ) { return; }
}
}
- function isBlocked()
- {
+ /**
+ * Check if user is blocked
+ * @return bool True if blocked, false otherwise
+ */
+ function isBlocked() {
$this->getBlockedStatus();
if ( 0 === $this->mBlockedby ) { return false; }
return true;
}
-
+
+ /**
+ * Get name of blocker
+ * @return string name of blocker
+ */
function blockedBy() {
$this->getBlockedStatus();
return $this->mBlockedby;
}
-
+
+ /**
+ * Get blocking reason
+ * @return string Blocking reason
+ */
function blockedFor() {
$this->getBlockedStatus();
return $this->mBlockreason;
}
+ /**
+ * Initialise php session
+ */
function SetupSession() {
global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain;
if( $wgSessionsInMemcached ) {
@session_start();
}
- /* static */ function loadFromSession()
- {
+ /**
+ * Read datas from session
+ * @static
+ */
+ function loadFromSession() {
global $wgMemc, $wgDBname;
if ( isset( $_SESSION['wsUserID'] ) ) {
return new User(); # Can't log in from session
}
- function loadFromDatabase()
- {
+ /**
+ * Load a user from the database
+ */
+ function loadFromDatabase() {
global $wgCommandLineMode;
$fname = "User::loadFromDatabase";
if ( $this->mDataLoaded || $wgCommandLineMode ) {
return;
} # the following stuff is for non-anonymous users only
- $s = $dbr->getArray( 'user', array( 'user_name','user_password','user_newpassword','user_email',
+ $s = $dbr->selectRow( 'user', array( 'user_name','user_password','user_newpassword','user_email',
'user_real_name','user_options','user_touched' ),
array( 'user_id' => $this->mId ), $fname );
$this->decodeOptions( $s->user_options );
$this->mTouched = wfTimestamp(TS_MW,$s->user_touched);
$this->mRights = explode( ",", strtolower(
- $dbr->getField( 'user_rights', 'user_rights', array( 'user_id' => $this->mId ) )
+ $dbr->selectField( 'user_rights', 'user_rights', array( 'user_id' => $this->mId ) )
) );
}
return ( 0 != $this->mNewtalk );
}
- function setNewtalk( $val )
- {
+ function setNewtalk( $val ) {
$this->loadFromDatabase();
$this->mNewtalk = $val;
$this->invalidateCache();
return ($timestamp >= $this->mTouched);
}
+ /**
+ * Salt a password.
+ * Will only be salted if $wgPasswordSalt is true
+ * @param string Password.
+ * @return string Salted password or clear password.
+ */
function addSalt( $p ) {
global $wgPasswordSalt;
if($wgPasswordSalt)
return $p;
}
+ /**
+ * Encrypt a password.
+ * It can eventuall salt a password @see User::addSalt()
+ * @param string $p clear Password.
+ * @param string Encrypted password.
+ */
function encryptPassword( $p ) {
return $this->addSalt( md5( $p ) );
}
return in_array( 'bureaucrat', $this->mRights );
}
+ /**
+ * Whether the user is a bot
+ */
function isBot() {
$this->loadFromDatabase();
return in_array( 'bot', $this->mRights );
}
- # Load a skin if it doesn't exist or return it
- # FIXME : need to check the old failback system [AV]
+ /**
+ * Load a skin if it doesn't exist or return it
+ * @todo FIXME : need to check the old failback system [AV]
+ */
function &getSkin() {
global $IP, $wgUsePHPTal;
if ( ! isset( $this->mSkin ) ) {
# Check if we got if not failback to default skin
$sn = 'Skin'.$sn;
if(!class_exists($sn)) {
- #FIXME : should we print an error message instead of loading
- # standard skin ?
+ # FIXME : should we print an error message instead of loading
+ # standard skin ? Let's die for now. [AV]
+ die("Class $sn doesn't exist in $IP/skins/$sn.php");
$sn = 'SkinStandard';
require_once( $IP.'/skins/Standard.php' );
}
return $this->mSkin;
}
+ /**#@+
+ * @param string $title Article title to look at
+ */
+
+ /**
+ * Check watched status of an article
+ * @return bool True if article is watched
+ */
function isWatched( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
return $wl->isWatched();
}
+ /**
+ * Watch an article
+ */
function addWatch( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
$wl->addWatch();
$this->invalidateCache();
}
+ /**
+ * Stop watching an article
+ */
function removeWatch( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
$wl->removeWatch();
$this->invalidateCache();
}
+ /**#@-*/
-
- /* private */ function encodeOptions() {
+ /**
+ * @access private
+ * @return string Encoding options
+ */
+ function encodeOptions() {
$a = array();
foreach ( $this->mOptions as $oname => $oval ) {
array_push( $a, $oname.'='.$oval );
return $s;
}
- /* private */ function decodeOptions( $str ) {
+ /**
+ * @access private
+ */
+ function decodeOptions( $str ) {
$a = explode( "\n", $str );
foreach ( $a as $s ) {
if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
}
}
+ /**
+ * Logout user
+ * It will clean the session cookie
+ */
function logout() {
global $wgCookiePath, $wgCookieDomain, $wgDBname;
$this->mId = 0;
setcookie( $wgDBname.'Password', '', time() - 3600, $wgCookiePath, $wgCookieDomain );
}
+ /**
+ * Save object settings into database
+ */
function saveSettings() {
global $wgMemc, $wgDBname;
$fname = 'User::saveSettings';
$wgMemc->delete( "$wgDBname:user:id:$this->mId" );
}
- # Checks if a user with the given name exists, returns the ID
- #
+ /**
+ * Checks if a user with the given name exists, returns the ID
+ */
function idForName() {
$fname = 'User::idForName';
return $id;
}
+ /**
+ * Add user object to the database
+ */
function addToDatabase() {
$fname = 'User::addToDatabase';
$dbw =& wfGetDB( DB_MASTER );
}
- function spreadBlock()
- {
+ function spreadBlock() {
global $wgIP;
# If the (non-anonymous) user is blocked, this function will block any IP address
# that they successfully log on from.
}
- function getPageRenderingHash(){
+ function getPageRenderingHash() {
+ global $wgLang;
if( $this->mHash ){
return $this->mHash;
}
$confstr .= '!' . $this->getOption( 'date' );
$confstr .= '!' . $this->getOption( 'numberheadings' );
+ // add in language variant option if there are multiple variants
+ // supported by the language object
+ if(sizeof($wgLang->getVariants())>1) {
+ $confstr .= '!' . $this->getOption( 'variant' );
+ }
+
$this->mHash = $confstr;
return $confstr ;
}
return $allowed;
}
- # Set mDataLoaded, return previous value
- # Use this to prevent DB access in command-line scripts or similar situations
- function setLoaded( $loaded )
- {
+ /**
+ * Set mDataLoaded, return previous value
+ * Use this to prevent DB access in command-line scripts or similar situations
+ */
+ function setLoaded( $loaded ) {
return wfSetVar( $this->mDataLoaded, $loaded );
}
return Title::makeTitle( NS_USER, $this->mName );
}
- /* static */ function getMaxID() {
+ /**
+ * @static
+ */
+ function getMaxID() {
$dbr =& wfGetDB( DB_SLAVE );
return $dbr->selectField( 'user', 'max(user_id)', false );
}
+ /**
+ * Determine whether the user is a newbie. Newbies are either
+ * anonymous IPs, or the 1% most recently created accounts.
+ * Bots and sysops are excluded.
+ * @return bool True if it is a newbie.
+ */
function isNewbie() {
return $this->mId > User::getMaxID() * 0.99 && !$this->isSysop() && !$this->isBot() || $this->getID() == 0;
}
- # Check to see if the given clear-text password is one of the accepted passwords
+ /**
+ * Check to see if the given clear-text password is one of the accepted passwords
+ * @param string $password User password.
+ * @return bool True if the given password is correct otherwise False.
+ */
function checkPassword( $password ) {
$this->loadFromDatabase();
$ep = $this->encryptPassword( $password );
dépôts / lhc / web / wiklou.git / blobdiff