a round of static statements
[lhc/web/wiklou.git] / includes / User.php
index 53a85bf..81c45ec 100644 (file)
@@ -21,24 +21,35 @@ define( 'MW_USER_VERSION', 3 );
  * @package MediaWiki
  */
 class User {
-       /**#@+
-        * @access private
-        */
-       var $mId, $mName, $mPassword, $mEmail, $mNewtalk;
-       var $mEmailAuthenticated;
-       var $mRights, $mOptions;
-       var $mDataLoaded, $mNewpassword;
-       var $mSkin;
-       var $mBlockedby, $mBlockreason;
-       var $mTouched;
-       var $mToken;
-       var $mRealName;
-       var $mHash;
-       var $mGroups;
-       var $mVersion; // serialized version
-       var $mRegistration;
-
-       /** Construct using User:loadDefaults() */
+       /*
+        * When adding a new private variable, dont forget to add it to __sleep()
+        */
+       /**@{{
+        * @private
+        */
+       private $mBlockedby;    //!<
+       private $mBlockreason;  //!<
+       private $mDataLoaded;   //!<
+       private $mEmail;                //!<
+       private $mEmailAuthenticated; //!<
+       private $mGroups;               //!<
+       private $mHash;                 //!<
+       private $mId;                   //!<
+       private $mName;                 //!<
+       private $mNewpassword;  //!<
+       private $mNewtalk;              //!<
+       private $mOptions;              //!<
+       private $mPassword;             //!<
+       private $mRealName;             //!<
+       private $mRegistration; //!<
+       private $mRights;               //!<
+       private $mSkin;                 //!<
+       private $mToken;                //!<
+       private $mTouched;              //!<
+       private $mVersion;              //!< serialized version
+       /**@}} */
+
+       /** Constructor using User:loadDefaults() */
        function User() {
                $this->loadDefaults();
                $this->mVersion = MW_USER_VERSION;
@@ -102,13 +113,31 @@ class User {
 
        /**
         * Serialze sleep function, for better cache efficiency and avoidance of
-        * silly "incomplete type" errors when skins are cached
+        * silly "incomplete type" errors when skins are cached. The array should
+        * contain names of private variables (see at top of User.php).
         */
        function __sleep() {
-               return array( 'mId', 'mName', 'mPassword', 'mEmail', 'mNewtalk',
-                       'mEmailAuthenticated', 'mRights', 'mOptions', 'mDataLoaded',
-                       'mNewpassword', 'mBlockedby', 'mBlockreason', 'mTouched',
-                       'mToken', 'mRealName', 'mHash', 'mGroups', 'mRegistration' );
+               return array(
+'mBlockedby',
+'mBlockreason',
+'mDataLoaded',
+'mEmail',
+'mEmailAuthenticated',
+'mGroups',
+'mHash',
+'mId',
+'mName',
+'mNewpassword',
+'mNewtalk',
+'mOptions',
+'mPassword',
+'mRealName',
+'mRegistration',
+'mRights',
+'mToken',
+'mTouched',
+'mVersion',
+);
        }
 
        /**
@@ -347,7 +376,7 @@ class User {
         *
         * @return array
         * @static
-        * @access private
+        * @private
         */
        function getDefaultOptions() {
                /**
@@ -372,7 +401,7 @@ class User {
         * @param string $opt
         * @return string
         * @static
-        * @access public
+        * @public
         */
        function getDefaultOption( $opt ) {
                $defOpts = User::getDefaultOptions();
@@ -385,7 +414,7 @@ class User {
 
        /**
         * Get blocking information
-        * @access private
+        * @private
         * @param bool $bFromSlave Specify whether to check slave or master. To improve performance,
         *  non-critical checks are done against slaves. Check when actually saving should be done against
         *  master.
@@ -420,7 +449,8 @@ class User {
                }
 
                # Proxy blocking
-               if ( !$this->isSysop() && !in_array( $ip, $wgProxyWhitelist ) ) {
+               # FIXME ? proxyunbannable is to deprecate the old isSysop()
+               if ( !$this->isAllowed('proxyunbannable') && !in_array( $ip, $wgProxyWhitelist ) ) {
 
                        # Local list
                        if ( wfIsLocallyBlockedProxy( $ip ) ) {
@@ -492,7 +522,7 @@ class User {
         * last-hit counters will be shared across wikis.
         *
         * @return bool true if a rate limiter was tripped
-        * @access public
+        * @public
         */
        function pingLimiter( $action='edit' ) {
                global $wgRateLimits;
@@ -611,8 +641,9 @@ class User {
 
        /**
         * Initialise php session
+        * @static
         */
-       function SetupSession() {
+       static function SetupSession() {
                global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain;
                if( $wgSessionsInMemcached ) {
                        require_once( 'MemcachedSessions.php' );
@@ -630,7 +661,7 @@ class User {
         * Create a new user object using data from session
         * @static
         */
-       function loadFromSession() {
+       static function loadFromSession() {
                global $wgMemc, $wgDBname, $wgCookiePrefix;
 
                if ( isset( $_SESSION['wsUserID'] ) ) {
@@ -777,7 +808,7 @@ class User {
        /**
         * Return the title dbkey form of the name, for eg user pages.
         * @return string
-        * @access public
+        * @public
         */
        function getTitleKey() {
                return str_replace( ' ', '_', $this->getName() );
@@ -835,7 +866,7 @@ class User {
         * @param string $field
         * @param mixed $id
         * @return bool
-        * @access private
+        * @private
         */
        function checkNewtalk( $field, $id ) {
                $fname = 'User::checkNewtalk';
@@ -849,7 +880,7 @@ class User {
         * Add or update the
         * @param string $field
         * @param mixed $id
-        * @access private
+        * @private
         */
        function updateNewtalk( $field, $id ) {
                $fname = 'User::updateNewtalk';
@@ -870,7 +901,7 @@ class User {
         * Clear the new messages flag for the given user
         * @param string $field
         * @param mixed $id
-        * @access private
+        * @private
         */
        function deleteNewtalk( $field, $id ) {
                $fname = 'User::deleteNewtalk';
@@ -1142,21 +1173,30 @@ class User {
        }
 
        /**
-        * Check if a user is sysop
+        * Deprecated in 1.6, die in 1.7, to be removed in 1.8
         * @deprecated
         */
        function isSysop() {
-               return $this->isAllowed( 'protect' );
+               wfDebugDieBacktrace( "Call to deprecated (v1.7) User::isSysop() method\n" );
+               #return $this->isAllowed( 'protect' );
        }
 
-       /** @deprecated */
+       /**
+        * Deprecated in 1.6, die in 1.7, to be removed in 1.8
+        * @deprecated
+        */
        function isDeveloper() {
-               return $this->isAllowed( 'siteadmin' );
+               wfDebugDieBacktrace( "Call to deprecated (v1.7) User::isDeveloper() method\n" );
+               #return $this->isAllowed( 'siteadmin' );
        }
 
-       /** @deprecated */
+       /**
+        * Deprecated in 1.6, die in 1.7, to be removed in 1.8
+        * @deprecated
+        */
        function isBureaucrat() {
-               return $this->isAllowed( 'makesysop' );
+               wfDebugDieBacktrace( "Call to deprecated (v1.7) User::isBureaucrat() method\n" );
+               #return $this->isAllowed( 'makesysop' );
        }
 
        /**
@@ -1296,7 +1336,7 @@ class User {
         * the next change of any watched page.
         *
         * @param int $currentUser user ID number
-        * @access public
+        * @public
         */
        function clearAllNotifications( $currentUser ) {
                global $wgUseEnotif;
@@ -1321,7 +1361,7 @@ class User {
        }
 
        /**
-        * @access private
+        * @private
         * @return string Encoding options
         */
        function encodeOptions() {
@@ -1334,7 +1374,7 @@ class User {
        }
 
        /**
-        * @access private
+        * @private
         */
        function decodeOptions( $str ) {
                $a = explode( "\n", $str );
@@ -1562,7 +1602,7 @@ class User {
         * Get this user's personal page title.
         *
         * @return Title
-        * @access public
+        * @public
         */
        function getUserPage() {
                return Title::makeTitle( NS_USER, $this->getName() );
@@ -1572,7 +1612,7 @@ class User {
         * Get this user's talk page title.
         *
         * @return Title
-        * @access public
+        * @public
         */
        function getTalkPage() {
                $title = $this->getUserPage();
@@ -1651,7 +1691,7 @@ class User {
         * @param mixed $salt - Optional function-specific data for hash.
         *                      Use a string or an array of strings.
         * @return string
-        * @access public
+        * @public
         */
        function editToken( $salt = '' ) {
                if( !isset( $_SESSION['wsEditToken'] ) ) {
@@ -1685,23 +1725,13 @@ class User {
         * @param string $val - the input value to compare
         * @param string $salt - Optional function-specific data for hash
         * @return bool
-        * @access public
+        * @public
         */
        function matchEditToken( $val, $salt = '' ) {
                global $wgMemc;
                $sessionToken = $this->editToken( $salt );
                if ( $val != $sessionToken ) {
-                       $logfile = '/home/wikipedia/logs/session_debug/session.log';
-                       $mckey = memsess_key( session_id() );
-                       $uname = @posix_uname();
-                       $msg = date('r') . "\nEdit token mismatch, expected $sessionToken got $val\n" .
-                       'apache server=' . $uname['nodename'] . "\n" .
-                       'session_id = ' . session_id() . "\n" .
-                       '$_SESSION=' . var_export( $_SESSION, true ) . "\n" .
-                       '$_COOKIE=' . var_export( $_COOKIE, true ) . "\n" .
-                       "mc get($mckey) = " . var_export( $wgMemc->get( $mckey ), true ) . "\n\n\n";
-
-                       @error_log( $msg, 3, $logfile );
+                       wfDebug( "User::matchEditToken: broken session data\n" );
                }
                return $val == $sessionToken;
        }
@@ -1755,7 +1785,7 @@ class User {
         * A hash (unsalted since it's used as a key) is stored.
         * @param &$expiration mixed output: accepts the expiration time
         * @return string
-        * @access private
+        * @private
         */
        function confirmationToken( &$expiration ) {
                $fname = 'User::confirmationToken';
@@ -1782,7 +1812,7 @@ class User {
         * the URL the user can use to confirm.
         * @param &$expiration mixed output: accepts the expiration time
         * @return string
-        * @access private
+        * @private
         */
        function confirmationTokenUrl( &$expiration ) {
                $token = $this->confirmationToken( $expiration );
@@ -1831,13 +1861,18 @@ class User {
        function isEmailConfirmed() {
                global $wgEmailAuthentication;
                $this->loadFromDatabase();
-               if( $this->isAnon() )
-                       return false;
-               if( !$this->isValidEmailAddr( $this->mEmail ) )
-                       return false;
-               if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
-                       return false;
-               return true;
+               $confirmed = true;
+               if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
+                       if( $this->isAnon() )
+                               return false;
+                       if( !$this->isValidEmailAddr( $this->mEmail ) )
+                               return false;
+                       if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
+                               return false;
+                       return true;
+               } else {
+                       return $confirmed;
+               }
        }
 
        /**
@@ -1859,11 +1894,26 @@ class User {
 
        /**
         * @param string $group key name
-        * @return string localized descriptive name, if provided
+        * @return string localized descriptive name for group, if provided
         * @static
         */
        function getGroupName( $group ) {
-               $key = "group-$group-name";
+               $key = "group-$group";
+               $name = wfMsg( $key );
+               if( $name == '' || $name == "&lt;$key&gt;" ) {
+                       return $group;
+               } else {
+                       return $name;
+               }
+       }
+
+       /**
+        * @param string $group key name
+        * @return string localized descriptive name for member of a group, if provided
+        * @static
+        */
+       function getGroupMember( $group ) {
+               $key = "group-$group-member";
                $name = wfMsg( $key );
                if( $name == '' || $name == "&lt;$key&gt;" ) {
                        return $group;
@@ -1872,6 +1922,7 @@ class User {
                }
        }
 
+
        /**
         * Return the set of defined explicit groups.
         * The * and 'user' groups are not included.
@@ -1884,6 +1935,24 @@ class User {
                        array_keys( $wgGroupPermissions ),
                        array( '*', 'user', 'autoconfirmed' ) );
        }
+       
+       /**
+        * Get the title of a page describing a particular group
+        *
+        * @param $group Name of the group
+        * @return mixed
+        */
+       function getGroupPage( $group ) {
+               $page = wfMsgForContent( 'grouppage-' . $group );
+               if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
+                       $title = Title::newFromText( $page );
+                       if( is_object( $title ) )
+                               return $title;
+               }
+               return false;
+       }
+       
+       
 }
 
 ?>