Localisation updates for core and extension messages from translatewiki.net (2010...
[lhc/web/wiklou.git] / includes / User.php
index 67fb66a..b5867d1 100644 (file)
@@ -62,7 +62,6 @@ class User {
                'editsectiononrightclick',
                'showtoc',
                'rememberpassword',
-               'editwidth',
                'watchcreations',
                'watchdefault',
                'watchmoves',
@@ -345,7 +344,8 @@ class User {
         *    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 \type{User} The 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.
         */
@@ -354,9 +354,7 @@ class User {
                        $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
@@ -437,7 +435,7 @@ class User {
         */
        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__ );
        }
 
        /**
@@ -601,20 +599,31 @@ class User {
         * 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
         */
        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 );
        }
 
        /**
@@ -701,7 +710,7 @@ class User {
                # 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' ) ?
@@ -1154,7 +1163,7 @@ class User {
                if ( $this->mBlock->load( $ip , $this->mId ) ) {
                        wfDebug( __METHOD__ . ": Found block.\n" );
                        $this->mBlockedby = $this->mBlock->mBy;
-                       if( $this->mBlockedby == "0" )
+                       if( $this->mBlockedby == 0 )
                                $this->mBlockedby = $this->mBlock->mByName;
                        $this->mBlockreason = $this->mBlock->mReason;
                        $this->mHideName = $this->mBlock->mHideName;
@@ -2151,7 +2160,7 @@ class User {
                                        'ug_user'  => $this->getID(),
                                        'ug_group' => $group,
                                ),
-                               'User::addGroup',
+                               __METHOD__,
                                array( 'IGNORE' ) );
                }
 
@@ -2174,8 +2183,7 @@ class User {
                        array(
                                'ug_user'  => $this->getID(),
                                'ug_group' => $group,
-                       ),
-                       'User::removeGroup' );
+                       ), __METHOD__ );
 
                $this->loadGroups();
                $this->mGroups = array_diff( $this->mGroups, array( $group ) );
@@ -2768,7 +2776,7 @@ class User {
                        return $res;
                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__ );
                }
        }
 
@@ -2851,7 +2859,7 @@ class User {
                        return EDIT_TOKEN_SUFFIX;
                } else {
                        if( !isset( $_SESSION['wsEditToken'] ) ) {
-                               $token = $this->generateToken();
+                               $token = self::generateToken();
                                $_SESSION['wsEditToken'] = $token;
                        } else {
                                $token = $_SESSION['wsEditToken'];
@@ -2869,7 +2877,7 @@ class User {
         * @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 );
        }
@@ -2909,9 +2917,10 @@ class User {
         * Generate a new e-mail confirmation token and send a confirmation/invalidation
         * mail to the user's given address.
         *
+        * @param $changed Boolean: whether the adress changed
         * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
         */
-       function sendConfirmationMail() {
+       function sendConfirmationMail( $changed = false ) {
                global $wgLang;
                $expiration = null; // gets passed-by-ref and defined in next line.
                $token = $this->confirmationToken( $expiration );
@@ -2919,8 +2928,9 @@ class User {
                $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,
@@ -2966,7 +2976,7 @@ class User {
                $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;
@@ -3601,8 +3611,8 @@ class User {
         * 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 );
@@ -3737,4 +3747,94 @@ class User {
 
                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 = "== $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 $article Article The article to update, defaults to the
+        *                        user's talk page.
+        * @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();
+               }
+
+               $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();
+       }
 }