Localisation updates from Betawiki.
[toast/cookiecaptcha.git] / ConfirmEdit.php
index d82e0237bb8f40b7b30e9d57c9ffec3e7c17dc1e..ceb48427e0564d4b9d9da4a09f8db70bea1e23d5 100644 (file)
 <?php
 
-# Prelim in-progress code. Proof of concept for framework, not
-# intended as a real production captcha system!
-
-# Loader for simple captcha feature
-# Include this from LocalSettings.php
+/**
+ * Experimental captcha plugin framework.
+ * Not intended as a real production captcha system; derived classes
+ * can extend the base to produce their fancy images in place of the
+ * text-based test output here.
+ *
+ * Copyright (C) 2005-2007 Brion Vibber <brion@wikimedia.org>
+ * http://www.mediawiki.org/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @addtogroup Extensions
+ */
 
-if ( defined( 'MEDIAWIKI' ) ) {
+if ( !defined( 'MEDIAWIKI' ) ) {
+       exit;
+}
 
 global $wgExtensionFunctions, $wgGroupPermissions;
 
-$wgExtensionFunctions[] = 'ceSetup';
+$wgExtensionFunctions[] = 'confirmEditSetup';
+$wgExtensionCredits['other'][] = array(
+       'name' => 'ConfirmEdit',
+       'author' => 'Brion Vibber',
+       'url' => 'http://www.mediawiki.org/wiki/Extension:ConfirmEdit',
+       'description' => 'Simple captcha implementation',
+);
+
+/**
+ * The 'skipcaptcha' permission key can be given out to
+ * let known-good users perform triggering actions without
+ * having to go through the captcha.
+ *
+ * By default, sysops and registered bot accounts will be
+ * able to skip, while others have to go through it.
+ */
+$wgGroupPermissions['*'            ]['skipcaptcha'] = false;
+$wgGroupPermissions['user'         ]['skipcaptcha'] = false;
+$wgGroupPermissions['autoconfirmed']['skipcaptcha'] = false;
+$wgGroupPermissions['bot'          ]['skipcaptcha'] = true; // registered bots
+$wgGroupPermissions['sysop'        ]['skipcaptcha'] = true;
 
-$wgGroupPermissions['*'        ]['skipcaptcha'] = false;
-$wgGroupPermissions['user'     ]['skipcaptcha'] = false;
-$wgGroupPermissions['bot'      ]['skipcaptcha'] = true; // registered bots
-$wgGroupPermissions['sysop'    ]['skipcaptcha'] = true;
+/**
+ * List of IP ranges to allow to skip the captcha, similar to the group setting:
+ * "$wgGroupPermission[...]['skipcaptcha'] = true"
+ *
+ * Specific IP addresses or CIDR-style ranges may be used,
+ * for instance:
+ * $wgCaptchaWhitelistIP = array('192.168.1.0/24', '10.1.0.0/16');
+ */
+$wgCaptchaWhitelistIP = false;
 
 global $wgCaptcha, $wgCaptchaClass, $wgCaptchaTriggers;
 $wgCaptcha = null;
 $wgCaptchaClass = 'SimpleCaptcha';
 
+/**
+ * Actions which can trigger a captcha
+ *
+ * If the 'edit' trigger is on, *every* edit will trigger the captcha.
+ * This may be useful for protecting against vandalbot attacks.
+ *
+ * If using the default 'addurl' trigger, the captcha will trigger on
+ * edits that include URLs that aren't in the current version of the page.
+ * This should catch automated linkspammers without annoying people when
+ * they make more typical edits.
+ *
+ * The captcha code should not use $wgCaptchaTriggers, but CaptchaTriggers()
+ * which also takes into account per namespace triggering.
+ */
 $wgCaptchaTriggers = array();
-$wgCaptchaTriggers['edit']   = false; // Would check on every edit
-$wgCaptchaTriggers['addurl'] = true;  // Check on edits that add URLs
+$wgCaptchaTriggers['edit']          = false; // Would check on every edit
+$wgCaptchaTriggers['create']           = false; // Check on page creation.
+$wgCaptchaTriggers['addurl']        = true;  // Check on edits that add URLs
+$wgCaptchaTriggers['createaccount'] = true;  // Special:Userlogin&type=signup
+$wgCaptchaTriggers['badlogin']      = true;  // Special:Userlogin after failure
+
+/**
+ * You may wish to apply special rules for captcha triggering on some namespaces.
+ * $wgCaptchaTriggersOnNamespace[<namespace id>][<trigger>] forces an always on / 
+ * always off configuration with that trigger for the given namespace.
+ * Leave unset to use the global options ($wgCaptchaTriggers).
+ *
+ * Shall not be used with 'createaccount' (it is not checked).
+ */
+$wgCaptchaTriggersOnNamespace = array();
+
+#Example:
+#$wgCaptchaTriggersOnNamespace[NS_TALK]['create'] = false; //Allow creation of talk pages without captchas.
+#$wgCaptchaTriggersOnNamespace[NS_PROJECT]['edit'] = true; //Show captcha whenever editing Project pages.
+
+/**
+ * Indicate how to store per-session data required to match up the
+ * internal captcha data with the editor.
+ *
+ * 'CaptchaSessionStore' uses PHP's session storage, which is cookie-based
+ * and may fail for anons with cookies disabled.
+ *
+ * 'CaptchaCacheStore' uses $wgMemc, which avoids the cookie dependency
+ * but may be fragile depending on cache configuration.
+ */
+global $wgCaptchaStorageClass;
+$wgCaptchaStorageClass = 'CaptchaSessionStore';
+
+/**
+ * Number of seconds a captcha session should last in the data cache
+ * before expiring when managing through CaptchaCacheStore class.
+ *
+ * Default is a half hour.
+ */
+global $wgCaptchaSessionExpiration;
+$wgCaptchaSessionExpiration = 30 * 60;
+
+/**
+ * Number of seconds after a bad login that a captcha will be shown to
+ * that client on the login form to slow down password-guessing bots.
+ *
+ * Has no effect if 'badlogin' is disabled in $wgCaptchaTriggers or
+ * if there is not a caching engine enabled.
+ *
+ * Default is five minutes.
+ */
+global $wgCaptchaBadLoginExpiration;
+$wgCaptchaBadLoginExpiration = 5 * 60;
 
 /**
  * Allow users who have confirmed their e-mail addresses to post
@@ -33,165 +146,64 @@ global $ceAllowConfirmedEmail;
 $ceAllowConfirmedEmail = false;
 
 /**
- * Set up message strings for captcha utilities.
+ * Regex to whitelist URLs to known-good sites...
+ * For instance:
+ * $wgCaptchaWhitelist = '#^https?://([a-z0-9-]+\\.)?(wikimedia|wikipedia)\.org/#i';
+ * Local admins can define a whitelist under [[MediaWiki:captcha-addurl-whitelist]]
  */
-function ceSetup() {
-       global $wgMessageCache, $wgHooks, $wgCaptcha, $wgCaptchaClass;
-       $wgMessageCache->addMessage('captcha-short', "Your edit includes new URL links; as a protection
-               against automated spam, you'll need to enter the answer to this
-               simple arithmetic test:" );
-       
-       SpecialPage::addPage( new SpecialPage( 'Captcha', false,
-               /*listed*/ false, /*function*/ false, /*file*/ false ) );
-       
-       $wgCaptcha = new $wgCaptchaClass();
-       $wgHooks['EditFilter'][] = array( &$wgCaptcha, 'confirmEdit' );
-}
+$wgCaptchaWhitelist = false;
 
 /**
- * Entry point for Special:Captcha
+ * Additional regexes to check for. Use full regexes; can match things
+ * other than URLs such as junk edits.
+ *
+ * If the new version matches one and the old version doesn't,
+ * toss up the captcha screen.
+ *
+ * @fixme Add a message for local admins to add items as well.
  */
-function wfSpecialCaptcha( $par = null ) {
-       global $wgCaptcha;
-       switch( $par ) {
-       case "image":
-               return $wgCaptcha->showImage();
-       case "help":
-       default:
-               return $wgCaptcha->showHelp();
-       }
+$wgCaptchaRegexes = array();
+
+/** Register special page */
+global $wgSpecialPages;
+$wgSpecialPages['Captcha'] = array( /*class*/'CaptchaSpecialPage', /*name*/'Captcha' );
+
+$wgConfirmEditIP = dirname( __FILE__ );
+$wgExtensionMessagesFiles['ConfirmEdit'] = "$wgConfirmEditIP/ConfirmEdit.i18n.php";
+
+if ( defined( 'MW_SUPPORTS_EDITFILTERMERGED' ) ) {
+       $wgHooks['EditFilterMerged'][] = 'ConfirmEditHooks::confirmEditMerged';
+} else {
+       $wgHooks['EditFilter'][] = 'ConfirmEditHooks::confirmEdit';
 }
+$wgHooks['UserCreateForm'][] = 'ConfirmEditHooks::injectUserCreate';
+$wgHooks['AbortNewAccount'][] = 'ConfirmEditHooks::confirmUserCreate';
+$wgHooks['LoginAuthenticateAudit'][] = 'ConfirmEditHooks::triggerUserLogin';
+$wgHooks['UserLoginForm'][] = 'ConfirmEditHooks::injectUserLogin';
+$wgHooks['AbortLogin'][] = 'ConfirmEditHooks::confirmUserLogin';
 
-class SimpleCaptcha {
-       /**
-        * @param EditPage $editPage
-        * @param string $newtext
-        * @param string $section
-        * @return bool true if the captcha should run
-        */
-       function shouldCheck( &$editPage, $newtext, $section ) {
-               global $wgUser;
-               if( $wgUser->isAllowed( 'skipcaptcha' ) ) {
-                       wfDebug( "SimpleCaptcha: user group allows skipping captcha\n" );
-                       return false;
-               }
-       
-               global $wgEmailAuthentication, $ceAllowConfirmedEmail;
-               if( $wgEmailAuthentication && $ceAllowConfirmedEmail &&
-                       $wgUser->isEmailConfirmed() ) {
-                       wfDebug( "SimpleCaptcha: user has confirmed mail, skipping captcha\n" );
-                       return false;
-               }
-               
-               global $wgCaptchaTriggers;
-               if( !empty( $wgCaptchaTriggers['edit'] ) ) {
-                       // Check on all edits
-                       wfDebug( "SimpleCaptcha: checking all edits...\n" );
-                       return true;
-               }
-               
-               if( !empty( $wgCaptchaTriggers['addurl'] ) ) {
-                       // Only check edits that add URLs
-                       $oldtext = $this->loadText( $editPage, $section );
-                       
-                       $oldLinks = $this->findLinks( $oldtext );
-                       $newLinks = $this->findLinks( $newtext );
-                       
-                       $addedLinks = array_diff( $newLinks, $oldLinks );
-                       $numLinks = count( $addedLinks );
-                       
-                       if( $numLinks > 0 ) {
-                               wfDebug( "SimpleCaptcha: found $numLinks new links; triggered...\n" );
-                               return true;
-                       }
-               }
-               
-               return false;
-       }
-       
-       function confirmEdit( &$editPage, $newtext, $section ) {
-               if( $this->shouldCheck( $editPage, $newtext, $section ) ) {
-                       if( $this->keyMatch() ) {
-                               wfDebug( "ConfirmEdit given proper key from form, passing.\n" );
-                               return true;
-                       } else {
-                               wfDebug( "ConfirmEdit missing form key, prompting.\n" );
-                               $editPage->showEditForm( array( &$this, 'formCallback' ) );
-                               return false;
-                       }
-               } else {
-                       wfDebug( "ConfirmEdit: no new links.\n" );
-                       return true;
-               }
-       }
-       
-       function keyMatch() {
-               if( !isset( $_SESSION['ceAnswerVar'] ) ) {
-                       wfDebug( "ConfirmEdit no session captcha key set, this is new visitor.\n" );
-                       return false;
-               }
-               global $wgRequest;
-               return $wgRequest->getVal( $_SESSION['ceAnswerVar'] ) == $_SESSION['ceAnswer'];
-       }
-       
-       function formCallback( &$out ) {
-               $source = 'ceSource' . mt_rand();
-               $dest = 'ceConfirm' . mt_rand();
-               
-               $a = mt_rand(0, 100);
-               $b = mt_rand(0, 10);
-               $op = mt_rand(0, 1) ? '+' : '-';
-               
-               $test = "$a $op $b";
-               $answer = ($op == '+') ? ($a + $b) : ($a - $b);
-               $_SESSION['ceAnswer'] = $answer;
-               $_SESSION['ceAnswerVar'] = $dest;
-               
-               
-               $out->addWikiText( wfMsg( "captcha-short" ) );  
-               $out->addHTML( <<<END
-                       <p><span id="$source">$test</span> = <input name="$dest" id="$dest" /></p>
-END
-                       );
-       }
-       
-       function loadText( $editPage, $section ) {
-               $rev = Revision::newFromTitle( $editPage->mTitle );
-               if( is_null( $rev ) ) {
-                       return "";
-               } else {
-                       $text = $rev->getText();
-                       if( $section != '' ) {
-                               return Article::getSection( $text, $section );
-                       } else {
-                               return $text;
-                       }
-               }
-       }
-       
-       function findLinks( $text ) {
-               $regex = '/((?:' . HTTP_PROTOCOLS . ')' . EXT_LINK_URL_CLASS . '+)/';
-               
-               if( preg_match_all( $regex, $text, $matches, PREG_PATTERN_ORDER ) ) {
-                       return $matches[1];
-               } else {
-                       return array();
-               }
-       }
-       
-       function showHelp() {
-               global $wgOut, $ceAllowConfirmedEmail;
-               $wgOut->setPageTitle( 'Captcha help' );
-               $wgOut->addWikiText( <<<END
-       So what's this wacky captcha thing about?
-       
-       It's your enemy. It's here to kill you. RUN WHILE YOU STILL CAN
-END
-                       );
+$wgAutoloadClasses['ConfirmEditHooks'] 
+       = $wgAutoloadClasses['SimpleCaptcha'] 
+       = $wgAutoloadClasses['CaptchaSessionStore']
+       = $wgAutoloadClasses['CaptchaCacheStore']
+       = $wgAutoloadClasses['CaptchaSpecialPage']
+       = "$wgConfirmEditIP/ConfirmEdit_body.php";
+
+/**
+ * Set up $wgWhitelistRead
+ */
+function confirmEditSetup() {
+       global $wgGroupPermissions, $wgCaptchaTriggers;
+       if( !$wgGroupPermissions['*']['read'] && $wgCaptchaTriggers['badlogin'] ) {
+               // We need to ensure that the captcha interface is accessible
+               // so that unauthenticated users can actually get in after a
+               // mistaken password typing.
+               global $wgWhitelistRead;
+               $image = Title::makeTitle( NS_SPECIAL, 'Captcha/image' );
+               $help = Title::makeTitle( NS_SPECIAL, 'Captcha/help' );
+               $wgWhitelistRead[] = $image->getPrefixedText();
+               $wgWhitelistRead[] = $help->getPrefixedText();
        }
-       
 }
 
-} # End invocation guard
 
-?>