added Minguo calendar support for the Taiwan Chinese language
[lhc/web/wiklou.git] / includes / User.php
index cc861ad..d10bc34 100644 (file)
@@ -14,7 +14,7 @@ define( 'USER_TOKEN_LENGTH', 32 );
  * \int Serialized record version.
  * @ingroup Constants
  */
-define( 'MW_USER_VERSION', 6 );
+define( 'MW_USER_VERSION', 8 );
 
 /**
  * \string Some punctuation to prevent editing from broken text-mangling proxies.
@@ -109,7 +109,6 @@ class User {
                'mNewpassword',
                'mNewpassTime',
                'mEmail',
-               'mOptions',
                'mTouched',
                'mToken',
                'mEmailAuthenticated',
@@ -119,6 +118,8 @@ class User {
                'mEditCount',
                // user_group table
                'mGroups',
+               // user_properties table
+               'mOptionOverrides',
        );
 
        /**
@@ -187,14 +188,14 @@ class User {
        /** @name Cache variables */
        //@{
        var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
-               $mEmail, $mOptions, $mTouched, $mToken, $mEmailAuthenticated,
-               $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups;
+               $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
+               $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
        //@}
 
        /**
         * \bool Whether the cache variables have been loaded.
         */
-       var $mDataLoaded, $mAuthLoaded;
+       var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
 
        /**
         * \string Initialization data source if mDataLoaded==false. May be one of:
@@ -211,7 +212,7 @@ class User {
        //@{
        var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
                $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally, 
-               $mLocked, $mHideName;
+               $mLocked, $mHideName, $mOptions;
        //@}
 
        /**
@@ -310,6 +311,7 @@ class User {
        function saveToCache() {
                $this->load();
                $this->loadGroups();
+               $this->loadOptions();
                if ( $this->isAnon() ) {
                        // Anonymous users are uncached
                        return;
@@ -770,7 +772,8 @@ class User {
                $this->mPassword = $this->mNewpassword = '';
                $this->mNewpassTime = null;
                $this->mEmail = '';
-               $this->mOptions = null; # Defer init
+               $this->mOptionOverrides = null;
+               $this->mOptionsLoaded = false;
 
                if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
                        $this->mTouched = wfTimestamp( TS_MW, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
@@ -969,6 +972,7 @@ class User {
                $this->mSkin = null;
                $this->mRights = null;
                $this->mEffectiveGroups = null;
+               $this->mOptions = null;
 
                if ( $reloadFrom ) {
                        $this->mDataLoaded = false;
@@ -987,7 +991,7 @@ class User {
                /**
                 * Site defaults will override the global/language defaults
                 */
-               global $wgDefaultUserOptions, $wgContLang;
+               global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
                $defOpt = $wgDefaultUserOptions + $wgContLang->getDefaultUserOptionOverrides();
 
                /**
@@ -996,10 +1000,11 @@ class User {
                $variant = $wgContLang->getPreferredVariant( false );
                $defOpt['variant'] = $variant;
                $defOpt['language'] = $variant;
-
-               foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
-                       $defOpt['searchNs'.$nsnum] = $val;
+               foreach(  SearchEngine::searchableNamespaces() as $nsnum => $nsname ) {
+                       $defOpt['searchNs'.$nsnum] = !empty($wgNamespacesToBeSearchedDefault[$nsnum]);
                }
+               $defOpt['skin'] = $wgDefaultSkin;
+               
                return $defOpt;
        }
 
@@ -1014,7 +1019,7 @@ class User {
                if( isset( $defOpts[$opt] ) ) {
                        return $defOpts[$opt];
                } else {
-                       return '';
+                       return null;
                }
        }
 
@@ -1866,8 +1871,8 @@ class User {
         * @see getBoolOption()
         * @see getIntOption()
         */
-       function getOption( $oname, $defaultOverride = '' ) {
-               $this->load();
+       function getOption( $oname, $defaultOverride = null ) {
+               $this->loadOptions();
 
                if ( is_null( $this->mOptions ) ) {
                        if($defaultOverride != '') {
@@ -1877,7 +1882,7 @@ class User {
                }
 
                if ( array_key_exists( $oname, $this->mOptions ) ) {
-                       return trim( $this->mOptions[$oname] );
+                       return $this->mOptions[$oname];
                } else {
                        return $defaultOverride;
                }
@@ -1919,32 +1924,26 @@ class User {
         */
        function setOption( $oname, $val ) {
                $this->load();
-               if ( is_null( $this->mOptions ) ) {
-                       $this->mOptions = User::getDefaultOptions();
-               }
+               $this->loadOptions();
+               
                if ( $oname == 'skin' ) {
                        # Clear cached skin, so the new one displays immediately in Special:Preferences
                        unset( $this->mSkin );
                }
-               // Filter out any newlines that may have passed through input validation.
-               // Newlines are used to separate items in the options blob.
-               if( $val ) {
-                       $val = str_replace( "\r\n", "\n", $val );
-                       $val = str_replace( "\r", "\n", $val );
-                       $val = str_replace( "\n", " ", $val );
-               }
+               
                // Explicitly NULL values should refer to defaults
                global $wgDefaultUserOptions;
                if( is_null($val) && isset($wgDefaultUserOptions[$oname]) ) {
                        $val = $wgDefaultUserOptions[$oname];
                }
+               
                $this->mOptions[$oname] = $val;
        }
        
        /**
         * Reset all options to the site defaults
         */     
-       function restoreOptions() {
+       function resetOptions() {
                $this->mOptions = User::getDefaultOptions();
        }
 
@@ -2144,11 +2143,12 @@ class User {
        }
 
        /**
-        * Get the current skin, loading it if required
-        * @return \type{Skin} Current skin
+        * 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]
         */
-       function &getSkin() {
+       function &getSkin( $t = null ) {
                global $wgRequest, $wgAllowUserSkin, $wgDefaultSkin;
                if ( ! isset( $this->mSkin ) ) {
                        wfProfileIn( __METHOD__ );
@@ -2165,6 +2165,13 @@ class User {
                        $this->mSkin =& Skin::newFromKey( $userSkin );
                        wfProfileOut( __METHOD__ );
                }
+               if( $t || !$this->mSkin->getTitle() ) {
+                       if ( !$t ) {
+                               global $wgOut;
+                               $t = $wgOut->getTitle();
+                       }
+                       $this->mSkin->setTitle( $t );
+               }
                return $this->mSkin;
        }
 
@@ -2285,36 +2292,25 @@ class User {
                }
        }
 
-       /**
-        * Encode this user's options as a string
-        * @return \string Encoded options
-        * @private
-        */
-       function encodeOptions() {
-               $this->load();
-               if ( is_null( $this->mOptions ) ) {
-                       $this->mOptions = User::getDefaultOptions();
-               }
-               $a = array();
-               foreach ( $this->mOptions as $oname => $oval ) {
-                       array_push( $a, $oname.'='.$oval );
-               }
-               $s = implode( "\n", $a );
-               return $s;
-       }
-
        /**
         * Set this user's options from an encoded string
         * @param $str \string Encoded options to import
         * @private
         */
        function decodeOptions( $str ) {
+               if (!$str)
+                       return;
+                       
+               $this->mOptionsLoaded = true;
+               $this->mOptionOverrides = array();
+               
                $this->mOptions = array();
                $a = explode( "\n", $str );
                foreach ( $a as $s ) {
                        $m = array();
                        if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
                                $this->mOptions[$m[1]] = $m[2];
+                               $this->mOptionOverrides[$m[1]] = $m[2];
                        }
                }
        }
@@ -2379,7 +2375,6 @@ class User {
         * Log this user out.
         */
        function logout() {
-               global $wgUser;
                if( wfRunHooks( 'UserLogout', array(&$this) ) ) {
                        $this->doLogout();
                }
@@ -2423,7 +2418,7 @@ class User {
                                'user_real_name' => $this->mRealName,
                                'user_email' => $this->mEmail,
                                'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
-                               'user_options' => $this->encodeOptions(),
+                               'user_options' => '',
                                'user_touched' => $dbw->timestamp($this->mTouched),
                                'user_token' => $this->mToken,
                                'user_email_token' => $this->mEmailToken,
@@ -2432,6 +2427,9 @@ class User {
                                'user_id' => $this->mId
                        ), __METHOD__
                );
+               
+               $this->saveOptions();
+               
                wfRunHooks( 'UserSaveSettings', array( $this ) );
                $this->clearSharedCache();
                $this->getUserPage()->invalidateCache();
@@ -2520,7 +2518,7 @@ class User {
                                'user_email' => $this->mEmail,
                                'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
                                'user_real_name' => $this->mRealName,
-                               'user_options' => $this->encodeOptions(),
+                               'user_options' => '',
                                'user_token' => $this->mToken,
                                'user_registration' => $dbw->timestamp( $this->mRegistration ),
                                'user_editcount' => 0,
@@ -2530,6 +2528,8 @@ class User {
 
                // Clear instance cache other than user table data, which is already accurate
                $this->clearInstanceCache();
+               
+               $this->saveOptions();
        }
 
        /**
@@ -3205,7 +3205,7 @@ class User {
                if( $title ) {
                        global $wgUser;
                        $sk = $wgUser->getSkin();
-                       return $sk->makeLinkObj( $title, htmlspecialchars( $text ) );
+                       return $sk->link( $title, htmlspecialchars( $text ) );
                } else {
                        return $text;
                }
@@ -3231,6 +3231,114 @@ class User {
                        return $text;
                }
        }
+       
+       /**
+        * Returns an array of the groups that a particular group can add/remove.
+        *
+        * @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) )
+        */
+       static function changeableByGroup( $group ) {
+               global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
+
+               $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
+               if( empty($wgAddGroups[$group]) ) {
+                       // Don't add anything to $groups
+               } elseif( $wgAddGroups[$group] === true ) {
+                       // You get everything
+                       $groups['add'] = self::getAllGroups();
+               } elseif( is_array($wgAddGroups[$group]) ) {
+                       $groups['add'] = $wgAddGroups[$group];
+               }
+
+               // Same thing for remove
+               if( empty($wgRemoveGroups[$group]) ) {
+               } elseif($wgRemoveGroups[$group] === true ) {
+                       $groups['remove'] = self::getAllGroups();
+               } elseif( is_array($wgRemoveGroups[$group]) ) {
+                       $groups['remove'] = $wgRemoveGroups[$group];
+               }
+               
+               // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
+               if( empty($wgGroupsAddToSelf['user']) || $wgGroupsAddToSelf['user'] !== true ) {
+                       foreach($wgGroupsAddToSelf as $key => $value) {
+                               if( is_int($key) ) {
+                                       $wgGroupsAddToSelf['user'][] = $value;
+                               }
+                       }
+               }
+               
+               if( empty($wgGroupsRemoveFromSelf['user']) || $wgGroupsRemoveFromSelf['user'] !== true ) {
+                       foreach($wgGroupsRemoveFromSelf as $key => $value) {
+                               if( is_int($key) ) {
+                                       $wgGroupsRemoveFromSelf['user'][] = $value;
+                               }
+                       }
+               }
+               
+               // Now figure out what groups the user can add to him/herself
+               if( empty($wgGroupsAddToSelf[$group]) ) {
+               } elseif( $wgGroupsAddToSelf[$group] === true ) {
+                       // No idea WHY this would be used, but it's there
+                       $groups['add-self'] = User::getAllGroups();
+               } elseif( is_array($wgGroupsAddToSelf[$group]) ) {
+                       $groups['add-self'] = $wgGroupsAddToSelf[$group];
+               }
+               
+               if( empty($wgGroupsRemoveFromSelf[$group]) ) {
+               } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
+                       $groups['remove-self'] = User::getAllGroups();
+               } elseif( is_array($wgGroupsRemoveFromSelf[$group]) ) {
+                       $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
+               }
+               
+               return $groups;
+       }
+       
+       /**
+        * Returns an array of groups that this user can add and remove
+        * @return Array array( 'add' => array( addablegroups ),
+        *  'remove' => array( removablegroups ),
+        *  'add-self' => array( addablegroups to self),
+        *  'remove-self' => array( removable groups from self) )
+        */
+       function changeableGroups() {
+               if( $this->isAllowed( 'userrights' ) ) {
+                       // This group gives the right to modify everything (reverse-
+                       // compatibility with old "userrights lets you change
+                       // everything")
+                       // Using array_merge to make the groups reindexed
+                       $all = array_merge( User::getAllGroups() );
+                       return array(
+                               'add' => $all,
+                               'remove' => $all,
+                               'add-self' => array(),
+                               'remove-self' => array()
+                       );
+               }
+
+               // Okay, it's not so simple, we will have to go through the arrays
+               $groups = array(
+                               'add' => array(),
+                               'remove' => array(),
+                               'add-self' => array(),
+                               'remove-self' => array() );
+               $addergroups = $this->getEffectiveGroups();
+
+               foreach ($addergroups as $addergroup) {
+                       $groups = array_merge_recursive(
+                               $groups, $this->changeableByGroup($addergroup)
+                       );
+                       $groups['add']    = array_unique( $groups['add'] );
+                       $groups['remove'] = array_unique( $groups['remove'] );
+                       $groups['add-self'] = array_unique( $groups['add-self'] );
+                       $groups['remove-self'] = array_unique( $groups['remove-self'] );
+               }
+               return $groups;
+       }
 
        /**
         * Increment the user's edit-count field.
@@ -3400,5 +3508,72 @@ class User {
                $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
                return true;
        }
+       
+       protected function loadOptions() {
+               $this->load();
+               if ($this->mOptionsLoaded || !$this->getId() )
+                       return;
+       
+               $this->mOptions = self::getDefaultOptions();
+               
+               // Maybe load from the object
+               
+               if ( !is_null($this->mOptionOverrides) ) {
+                       wfDebug( "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" );
+                       // Load from database
+                       $dbr = wfGetDB( DB_SLAVE );
+                       
+                       $res = $dbr->select( 'user_properties',
+                                                                       '*',
+                                                                       array('up_user' => $this->getId()),
+                                                                       __METHOD__
+                                                               );
+                       
+                       while( $row = $dbr->fetchObject( $res ) ) {
+                               $this->mOptionOverrides[$row->up_property] = $row->up_value;
+                               $this->mOptions[$row->up_property] = $row->up_value;
+                       }
+               }
+               
+               $this->mOptionsLoaded = true;
+               
+               wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions ) );
+       }
+       
+       protected function saveOptions() {
+               $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) ) )
+                       return;
+               
+               foreach( $saveOptions as $key => $value ) {
+                       if ( ( is_null(self::getDefaultOption($key)) &&
+                                       !( $value === false || is_null($value) ) ) ||
+                                       $value != self::getDefaultOption( $key ) ) {
+                               $insert_rows[] = array(
+                                               'up_user' => $this->getId(),
+                                               'up_property' => $key,
+                                               'up_value' => $value,
+                                       );
+                       }
+               }
+               
+               $dbw->begin();
+               $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__ );
+               $dbw->insert( 'user_properties', $insert_rows, __METHOD__ );
+               $dbw->commit();
+       }
 
 }