ConfirmEdit.php

   1 <?php
   2 /**
   3  * Experimental captcha plugin framework.
   4  * Not intended as a real production captcha system; derived classes
   5  * can extend the base to produce their fancy images in place of the
   6  * text-based test output here.
   7  *
   8  * Copyright (C) 2005, 2006 Brion Vibber <brion@pobox.com>
   9  * http://www.mediawiki.org/
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  *
  26  * @package MediaWiki
  27  * @subpackage Extensions
  28  */
  29
  30 if ( defined( 'MEDIAWIKI' ) ) {
  31
  32 global $wgExtensionFunctions, $wgGroupPermissions;
  33
  34 $wgExtensionFunctions[] = 'ceSetup';
  35
  36 /**
  37  * The 'skipcaptcha' permission key can be given out to
  38  * let known-good users perform triggering actions without
  39  * having to go through the captcha.
  40  *
  41  * By default, sysops and registered bot accounts will be
  42  * able to skip, while others have to go through it.
  43  */
  44 $wgGroupPermissions['*'            ]['skipcaptcha'] = false;
  45 $wgGroupPermissions['user'         ]['skipcaptcha'] = false;
  46 $wgGroupPermissions['autoconfirmed']['skipcaptcha'] = false;
  47 $wgGroupPermissions['bot'          ]['skipcaptcha'] = true; // registered bots
  48 $wgGroupPermissions['sysop'        ]['skipcaptcha'] = true;
  49
  50 global $wgCaptcha, $wgCaptchaClass, $wgCaptchaTriggers;
  51 $wgCaptcha = null;
  52 $wgCaptchaClass = 'SimpleCaptcha';
  53
  54 /**
  55  * Currently the captcha works only for page edits.
  56  *
  57  * If the 'edit' trigger is on, *every* edit will trigger the captcha.
  58  * This may be useful for protecting against vandalbot attacks.
  59  *
  60  * If using the default 'addurl' trigger, the captcha will trigger on
  61  * edits that include URLs that aren't in the current version of the page.
  62  * This should catch automated linkspammers without annoying people when
  63  * they make more typical edits.
  64  */
  65 $wgCaptchaTriggers = array();
  66 $wgCaptchaTriggers['edit']          = false; // Would check on every edit
  67 $wgCaptchaTriggers['addurl']        = true;  // Check on edits that add URLs
  68 $wgCaptchaTriggers['createaccount'] = true;  // Special:Userlogin&type=signup
  69
  70
  71 /**
  72  * Allow users who have confirmed their e-mail addresses to post
  73  * URL links without being harassed by the captcha.
  74  */
  75 global $ceAllowConfirmedEmail;
  76 $ceAllowConfirmedEmail = false;
  77
  78 /**
  79  * Regex to whitelist URLs to known-good sites...
  80  * For instance:
  81  * $wgCaptchaWhitelist = '#^https?://([a-z0-9-]+\\.)?(wikimedia|wikipedia)\.org/#i';
  82  */
  83 $wgCaptchaWhitelist = false;
  84
  85 /**
  86  * Set up message strings for captcha utilities.
  87  */
  88 function ceSetup() {
  89         global $wgMessageCache, $wgHooks, $wgCaptcha, $wgCaptchaClass;
  90         $wgMessageCache->addMessages( array(
  91                 'captcha-short' =>
  92                         "Your edit includes new URL links; as a protection against automated " .
  93                         "spam, you'll need to type in the words that appear in this image:\n" .
  94                         "<br />([[Special:Captcha/help|What is this?]])",
  95                 'captchahelp-title' =>
  96                         'Captcha help',
  97                 'captchahelp-text' =>
  98                         "Web sites that accept postings from the public, like this wiki, " .
  99                         "are often abused by spammers who use automated tools to post their " .
 100                         "links to many sites. While these spam links can be removed, they " .
 101                         "are a significant nuisance." .
 102                         "\n\n" .
 103                         "Sometimes, especially when adding new web links to a page, " .
 104                         "the wiki may show you an image of colored or distorted text and " .
 105                         "ask you to type the words shown. Since this is a task that's hard " .
 106                         "to automate, it will allow most real humans to make their posts " .
 107                         "while stopping most spammers and other robotic attackers." .
 108                         "\n\n" .
 109                         "Unfortunately this may inconvenience users with limited vision or " .
 110                         "using text-based or speech-based browsers. At the moment we do not " .
 111                         "have an audio alternative available. Please contact the site " .
 112                         "administrators for assistance if this is unexpectedly preventing " .
 113                         "you from making legitimate posts." .
 114                         "\n\n" .
 115                         "Hit the 'back' button in your browser to return to the page editor.",
 116                 'captcha-createaccount' =>
 117                         "As a protection against automated spam, you'll need to type in the " .
 118                         "words that appear in this image to register an account:\n" .
 119                         "<br />([[Special:Captcha/help|What is this?]])",
 120                 'captcha-createaccount-fail' =>
 121                         "Incorrect or missing confirmation code." ) );
 122
 123         SpecialPage::addPage( new SpecialPage( 'Captcha', false,
 124                 /*listed*/ false, /*function*/ false, /*file*/ false ) );
 125
 126         $wgCaptcha = new $wgCaptchaClass();
 127         $wgHooks['EditFilter'][] = array( &$wgCaptcha, 'confirmEdit' );
 128
 129         $wgHooks['UserCreateForm'][] = array( &$wgCaptcha, 'injectUserCreate' );
 130         $wgHooks['AbortNewAccount'][] = array( &$wgCaptcha, 'confirmUserCreate' );
 131 }
 132
 133 /**
 134  * Entry point for Special:Captcha
 135  */
 136 function wfSpecialCaptcha( $par = null ) {
 137         global $wgCaptcha;
 138         switch( $par ) {
 139         case "image":
 140                 return $wgCaptcha->showImage();
 141         case "help":
 142         default:
 143                 return $wgCaptcha->showHelp();
 144         }
 145 }
 146
 147 class SimpleCaptcha {
 148         /**
 149          * Insert a captcha prompt into the edit form.
 150          * This sample implementation generates a simple arithmetic operation;
 151          * it would be easy to defeat by machine.
 152          *
 153          * Override this!
 154          *
 155          * @return string HTML
 156          */
 157         function getForm() {
 158                 $a = mt_rand(0, 100);
 159                 $b = mt_rand(0, 10);
 160                 $op = mt_rand(0, 1) ? '+' : '-';
 161
 162                 $test = "$a $op $b";
 163                 $answer = ($op == '+') ? ($a + $b) : ($a - $b);
 164
 165                 $index = $this->storeCaptcha( array( 'answer' => $answer ) );
 166
 167                 return "<p><label for=\"wpCaptchaWord\">$test</label> = " .
 168                         wfElement( 'input', array(
 169                                 'name' => 'wpCaptchaWord',
 170                                 'id'   => 'wpCaptchaWord',
 171                                 'tabindex' => 1 ) ) . // tab in before the edit textarea
 172                         "</p>\n" .
 173                         wfElement( 'input', array(
 174                                 'type'  => 'hidden',
 175                                 'name'  => 'wpCaptchaId',
 176                                 'id'    => 'wpCaptchaId',
 177                                 'value' => $index ) );
 178         }
 179
 180         /**
 181          * Insert the captcha prompt into an edit form.
 182          * @param OutputPage $out
 183          */
 184         function editCallback( &$out ) {
 185                 $out->addWikiText( wfMsg( "captcha-short" ) );
 186                 $out->addHTML( $this->getForm() );
 187         }
 188
 189         /**
 190          * Inject whazawhoo
 191          * @fixme if multiple thingies insert a header, could break
 192          * @param SimpleTemplate $template
 193          * @return bool true to keep running callbacks
 194          */
 195         function injectUserCreate( &$template ) {
 196                 global $wgCaptchaTriggers, $wgOut;
 197                 if( $wgCaptchaTriggers['createaccount'] ) {
 198                         $template->set( 'header',
 199                                 "<div class='captcha'>" .
 200                                 $wgOut->parse( wfMsg( 'captcha-createaccount' ) ) .
 201                                 $this->getForm() .
 202                                 "</div>\n" );
 203                 }
 204                 return true;
 205         }
 206
 207         /**
 208          * Check if the submitted form matches the captcha session data provided
 209          * by the plugin when the form was generated.
 210          *
 211          * Override this!
 212          *
 213          * @param WebRequest $request
 214          * @param array $info
 215          * @return bool
 216          */
 217         function keyMatch( $request, $info ) {
 218                 return $request->getVal( 'wpCaptchaWord' ) == $info['answer'];
 219         }
 220
 221         // ----------------------------------
 222
 223         /**
 224          * @param EditPage $editPage
 225          * @param string $newtext
 226          * @param string $section
 227          * @return bool true if the captcha should run
 228          */
 229         function shouldCheck( &$editPage, $newtext, $section ) {
 230                 $this->trigger = '';
 231
 232                 global $wgUser;
 233                 if( $wgUser->isAllowed( 'skipcaptcha' ) ) {
 234                         wfDebug( "ConfirmEdit: user group allows skipping captcha\n" );
 235                         return false;
 236                 }
 237
 238                 global $wgEmailAuthentication, $ceAllowConfirmedEmail;
 239                 if( $wgEmailAuthentication && $ceAllowConfirmedEmail &&
 240                         $wgUser->isEmailConfirmed() ) {
 241                         wfDebug( "ConfirmEdit: user has confirmed mail, skipping captcha\n" );
 242                         return false;
 243                 }
 244
 245                 global $wgCaptchaTriggers;
 246                 if( !empty( $wgCaptchaTriggers['edit'] ) ) {
 247                         // Check on all edits
 248                         wfDebug( "ConfirmEdit: checking all edits...\n" );
 249                         return true;
 250                 }
 251
 252                 if( !empty( $wgCaptchaTriggers['addurl'] ) ) {
 253                         // Only check edits that add URLs
 254                         $oldtext = $this->loadText( $editPage, $section );
 255
 256                         $oldLinks = $this->findLinks( $oldtext );
 257                         $newLinks = $this->findLinks( $newtext );
 258                         $unknownLinks = array_filter( $newLinks, array( &$this, 'filterLink' ) );
 259
 260                         $addedLinks = array_diff( $unknownLinks, $oldLinks );
 261                         $numLinks = count( $addedLinks );
 262
 263                         if( $numLinks > 0 ) {
 264                                 global $wgUser, $wgTitle;
 265                                 $this->trigger = sprintf( "%dx url trigger by '%s' at [[%s]]: %s",
 266                                         $numLinks,
 267                                         $wgUser->getName(),
 268                                         $wgTitle->getPrefixedText(),
 269                                         implode( ", ", $addedLinks ) );
 270                                 return true;
 271                         }
 272                 }
 273
 274                 return false;
 275         }
 276
 277         /**
 278          * Filter callback function for URL whitelisting
 279          * @return bool true if unknown, false if whitelisted
 280          * @access private
 281          */
 282         function filterLink( $url ) {
 283                 global $wgCaptchaWhitelist;
 284                 return !( $wgCaptchaWhitelist && preg_match( $wgCaptchaWhitelist, $url ) );
 285         }
 286
 287         /**
 288          * The main callback run on edit attempts.
 289          * @param EditPage $editPage
 290          * @param string $newtext
 291          * @param string $section
 292          * @param bool true to continue saving, false to abort and show a captcha form
 293          */
 294         function confirmEdit( &$editPage, $newtext, $section ) {
 295                 if( $this->shouldCheck( $editPage, $newtext, $section ) ) {
 296                         if( $this->passCaptcha() ) {
 297                                 return true;
 298                         } else {
 299                                 $editPage->showEditForm( array( &$this, 'editCallback' ) );
 300                                 return false;
 301                         }
 302                 } else {
 303                         wfDebug( "ConfirmEdit: no new links.\n" );
 304                         return true;
 305                 }
 306         }
 307
 308         /**
 309          * Hook for user creation form submissions.
 310          * @param User $u
 311          * @param string $message
 312          * @return bool true to continue, false to abort user creation
 313          */
 314         function confirmUserCreate( $u, &$message ) {
 315                 global $wgCaptchaTriggers;
 316                 if( $wgCaptchaTriggers['createaccount'] ) {
 317                         $this->trigger = "new account '" . $u->getName() . "'";
 318                         if( !$this->passCaptcha() ) {
 319                                 $message = wfMsg( 'captcha-createaccount-fail' );
 320                                 return false;
 321                         }
 322                 }
 323                 return true;
 324         }
 325
 326         /**
 327          * Given a required captcha run, test form input for correct
 328          * input on the open session.
 329          * @return bool if passed, false if failed or new session
 330          */
 331         function passCaptcha() {
 332                 $info = $this->retrieveCaptcha();
 333                 if( $info ) {
 334                         global $wgRequest;
 335                         if( $this->keyMatch( $wgRequest, $info ) ) {
 336                                 $this->log( "passed" );
 337                                 $this->clearCaptcha( $info );
 338                                 return true;
 339                         } else {
 340                                 $this->clearCaptcha( $info );
 341                                 $this->log( "bad form input" );
 342                                 return false;
 343                         }
 344                 } else {
 345                         $this->log( "new captcha session" );
 346                         return false;
 347                 }
 348         }
 349
 350         /**
 351          * Log the status and any triggering info for debugging or statistics
 352          * @param string $message
 353          */
 354         function log( $message ) {
 355                 wfDebugLog( 'captcha', 'ConfirmEdit: ' . $message . '; ' .  $this->trigger );
 356         }
 357
 358         /**
 359          * Generate a captcha session ID and save the info in PHP's session storage.
 360          * (Requires the user to have cookies enabled to get through the captcha.)
 361          *
 362          * A random ID is used so legit users can make edits in multiple tabs or
 363          * windows without being unnecessarily hobbled by a serial order requirement.
 364          * Pass the returned id value into the edit form as wpCaptchaId.
 365          *
 366          * @param array $info data to store
 367          * @return string captcha ID key
 368          */
 369         function storeCaptcha( $info ) {
 370                 if( !isset( $info['index'] ) ) {
 371                         // Assign random index if we're not udpating
 372                         $info['index'] = strval( mt_rand() );
 373                 }
 374                 $_SESSION['captcha' . $info['index']] = $info;
 375                 return $info['index'];
 376         }
 377
 378         /**
 379          * Fetch this session's captcha info.
 380          * @return mixed array of info, or false if missing
 381          */
 382         function retrieveCaptcha() {
 383                 global $wgRequest;
 384                 $index = $wgRequest->getVal( 'wpCaptchaId' );
 385                 if( isset( $_SESSION['captcha' . $index] ) ) {
 386                         return $_SESSION['captcha' . $index];
 387                 } else {
 388                         return false;
 389                 }
 390         }
 391
 392         /**
 393          * Clear out existing captcha info from the session, to ensure
 394          * it can't be reused.
 395          */
 396         function clearCaptcha( $info ) {
 397                 unset( $_SESSION['captcha' . $info['index']] );
 398         }
 399
 400         /**
 401          * Retrieve the current version of the page or section being edited...
 402          * @param EditPage $editPage
 403          * @param string $section
 404          * @return string
 405          * @access private
 406          */
 407         function loadText( $editPage, $section ) {
 408                 $rev = Revision::newFromTitle( $editPage->mTitle );
 409                 if( is_null( $rev ) ) {
 410                         return "";
 411                 } else {
 412                         $text = $rev->getText();
 413                         if( $section != '' ) {
 414                                 return Article::getSection( $text, $section );
 415                         } else {
 416                                 return $text;
 417                         }
 418                 }
 419         }
 420
 421         /**
 422          * Extract a list of all recognized HTTP links in the text.
 423          * @param string $text
 424          * @return array of strings
 425          */
 426         function findLinks( $text ) {
 427                 $regex = '/((?:' . HTTP_PROTOCOLS . ')' . EXT_LINK_URL_CLASS . '+)/';
 428
 429                 if( preg_match_all( $regex, $text, $matches, PREG_PATTERN_ORDER ) ) {
 430                         return $matches[1];
 431                 } else {
 432                         return array();
 433                 }
 434         }
 435
 436         /**
 437          * Show a page explaining what this wacky thing is.
 438          */
 439         function showHelp() {
 440                 global $wgOut, $ceAllowConfirmedEmail;
 441                 $wgOut->setPageTitle( wfMsg( 'captchahelp-title' ) );
 442                 $wgOut->addWikiText( wfMsg( 'captchahelp-text' ) );
 443         }
 444
 445 }
 446
 447 } # End invocation guard
 448
 449 ?>