/**
* See user.doc
*
+ * @package MediaWiki
*/
/**
/**
*
+ * @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
+ * @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;
+ }
}
/**
+ * 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 ) );
}
/**
+ * 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 ) );
}
/**
+ * 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 ) {
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?
+ * @param string $name Nickname of a user
* @static
*/
function isIP( $name ) {
}
/**
- * static
+ * probably return a random password
+ * @return string probably a random password
+ * @static
+ * @todo Check what is doing really [AV]
*/
function randomPassword() {
$pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
}
/**
- *
+ * 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;
$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;
}
+
+ /**
+ * 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() {
}
}
+ /**
+ * 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 ) {
}
/**
+ * Read datas from session
* @static
*/
function loadFromSession() {
}
/**
- *
+ * Load a user from the database
*/
function loadFromDatabase() {
global $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 $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();
}
-
+ /**#@-*/
/**
* @access private
+ * @return string Encoding options
*/
function encodeOptions() {
$a = array();
}
}
+ /**
+ * 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';
return $id;
}
+ /**
+ * Add user object to the database
+ */
function addToDatabase() {
$fname = 'User::addToDatabase';
$dbw =& wfGetDB( DB_MASTER );
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
+ * @param string $password User password.
+ * @return bool True if the given password is correct otherwise False.
*/
function checkPassword( $password ) {
$this->loadFromDatabase();
dépôts / lhc / web / wiklou.git / blobdiff