ConfirmEdit.php

   1 <?php
   2
   3 /**
   4  * Experimental captcha plugin framework.
   5  * Not intended as a real production captcha system; derived classes
   6  * can extend the base to produce their fancy images in place of the
   7  * text-based test output here.
   8  *
   9  * Copyright (C) 2005-2007 Brion Vibber <brion@wikimedia.org>
  10  * http://www.mediawiki.org/
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License along
  23  * with this program; if not, write to the Free Software Foundation, Inc.,
  24  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25  * http://www.gnu.org/copyleft/gpl.html
  26  *
  27  * @addtogroup Extensions
  28  */
  29
  30 if ( defined( 'MEDIAWIKI' ) ) {
  31
  32 global $wgExtensionFunctions, $wgGroupPermissions;
  33
  34 $wgExtensionFunctions[] = 'ceSetup';
  35 $wgExtensionCredits['other'][] = array(
  36         'name' => 'ConfirmEdit',
  37         'author' => 'Brion Vibber',
  38         'url' => 'http://www.mediawiki.org/wiki/Extension:ConfirmEdit',
  39         'description' => 'Simple captcha implementation',
  40 );
  41
  42 # Internationalisation file
  43 require_once( 'ConfirmEdit.i18n.php' );
  44
  45 /**
  46  * The 'skipcaptcha' permission key can be given out to
  47  * let known-good users perform triggering actions without
  48  * having to go through the captcha.
  49  *
  50  * By default, sysops and registered bot accounts will be
  51  * able to skip, while others have to go through it.
  52  */
  53 $wgGroupPermissions['*'            ]['skipcaptcha'] = false;
  54 $wgGroupPermissions['user'         ]['skipcaptcha'] = false;
  55 $wgGroupPermissions['autoconfirmed']['skipcaptcha'] = false;
  56 $wgGroupPermissions['bot'          ]['skipcaptcha'] = true; // registered bots
  57 $wgGroupPermissions['sysop'        ]['skipcaptcha'] = true;
  58
  59 global $wgCaptcha, $wgCaptchaClass, $wgCaptchaTriggers;
  60 $wgCaptcha = null;
  61 $wgCaptchaClass = 'SimpleCaptcha';
  62
  63 /**
  64  * Actions which can trigger a captcha
  65  *
  66  * If the 'edit' trigger is on, *every* edit will trigger the captcha.
  67  * This may be useful for protecting against vandalbot attacks.
  68  *
  69  * If using the default 'addurl' trigger, the captcha will trigger on
  70  * edits that include URLs that aren't in the current version of the page.
  71  * This should catch automated linkspammers without annoying people when
  72  * they make more typical edits.
  73  *
  74  * The captcha code should not use $wgCaptchaTriggers, but CaptchaTriggers()
  75  * which also takes into account per namespace triggering.
  76  */
  77 $wgCaptchaTriggers = array();
  78 $wgCaptchaTriggers['edit']          = false; // Would check on every edit
  79 $wgCaptchaTriggers['create']            = false; // Check on page creation.
  80 $wgCaptchaTriggers['addurl']        = true;  // Check on edits that add URLs
  81 $wgCaptchaTriggers['createaccount'] = true;  // Special:Userlogin&type=signup
  82 $wgCaptchaTriggers['badlogin']      = true;  // Special:Userlogin after failure
  83
  84 /**
  85  * You may wish to apply special rules for captcha triggering on some namespaces.
  86  * $wgCaptchaTriggersOnNamespace[<namespace id>][<trigger>] forces an always on /
  87  * always off configuration with that trigger for the given namespace.
  88  * Leave unset to use the global options ($wgCaptchaTriggers).
  89  *
  90  * Shall not be used with 'createaccount' (it is not checked).
  91  */
  92 $wgCaptchaTriggersOnNamespace = array();
  93
  94 #Example:
  95 #$wgCaptchaTriggersOnNamespace[NS_TALK]['create'] = false; //Allow creation of talk pages without captchas.
  96 #$wgCaptchaTriggersOnNamespace[NS_PROJECT]['edit'] = true; //Show captcha whenever editing Project pages.
  97
  98 /**
  99  * Indicate how to store per-session data required to match up the
 100  * internal captcha data with the editor.
 101  *
 102  * 'CaptchaSessionStore' uses PHP's session storage, which is cookie-based
 103  * and may fail for anons with cookies disabled.
 104  *
 105  * 'CaptchaCacheStore' uses $wgMemc, which avoids the cookie dependency
 106  * but may be fragile depending on cache configuration.
 107  */
 108 global $wgCaptchaStorageClass;
 109 $wgCaptchaStorageClass = 'CaptchaSessionStore';
 110
 111 /**
 112  * Number of seconds a captcha session should last in the data cache
 113  * before expiring when managing through CaptchaCacheStore class.
 114  *
 115  * Default is a half hour.
 116  */
 117 global $wgCaptchaSessionExpiration;
 118 $wgCaptchaSessionExpiration = 30 * 60;
 119
 120 /**
 121  * Number of seconds after a bad login that a captcha will be shown to
 122  * that client on the login form to slow down password-guessing bots.
 123  *
 124  * Has no effect if 'badlogin' is disabled in $wgCaptchaTriggers or
 125  * if there is not a caching engine enabled.
 126  *
 127  * Default is five minutes.
 128  */
 129 global $wgCaptchaBadLoginExpiration;
 130 $wgCaptchaBadLoginExpiration = 5 * 60;
 131
 132 /**
 133  * Allow users who have confirmed their e-mail addresses to post
 134  * URL links without being harassed by the captcha.
 135  */
 136 global $ceAllowConfirmedEmail;
 137 $ceAllowConfirmedEmail = false;
 138
 139 /**
 140  * Regex to whitelist URLs to known-good sites...
 141  * For instance:
 142  * $wgCaptchaWhitelist = '#^https?://([a-z0-9-]+\\.)?(wikimedia|wikipedia)\.org/#i';
 143  * Local admins can define a whitelist under [[MediaWiki:captcha-addurl-whitelist]]
 144  */
 145 $wgCaptchaWhitelist = false;
 146
 147 /**
 148  * Additional regexes to check for. Use full regexes; can match things
 149  * other than URLs such as junk edits.
 150  *
 151  * If the new version matches one and the old version doesn't,
 152  * toss up the captcha screen.
 153  *
 154  * @fixme Add a message for local admins to add items as well.
 155  */
 156 $wgCaptchaRegexes = array();
 157
 158 /** Register special page */
 159 global $wgSpecialPages;
 160 $wgSpecialPages['Captcha'] = array( /*class*/ 'SpecialPage', /*name*/'Captcha', /*restriction*/ '',
 161         /*listed*/ false, /*function*/ false, /*file*/ false );
 162
 163 /**
 164  * Set up message strings for captcha utilities.
 165  */
 166 function ceSetup() {
 167         # Add messages
 168         global $wgMessageCache, $wgConfirmEditMessages;
 169         foreach( $wgConfirmEditMessages as $lang => $messages )
 170                 $wgMessageCache->addMessages( $messages, $lang );
 171
 172         global $wgHooks, $wgCaptcha, $wgCaptchaClass, $wgSpecialPages;
 173         $wgCaptcha = new $wgCaptchaClass();
 174         $wgHooks['EditFilter'][] = array( &$wgCaptcha, 'confirmEdit' );
 175
 176         $wgHooks['UserCreateForm'][] = array( &$wgCaptcha, 'injectUserCreate' );
 177         $wgHooks['AbortNewAccount'][] = array( &$wgCaptcha, 'confirmUserCreate' );
 178
 179         $wgHooks['LoginAuthenticateAudit'][] = array( &$wgCaptcha, 'triggerUserLogin' );
 180         $wgHooks['UserLoginForm'][] = array( &$wgCaptcha, 'injectUserLogin' );
 181         $wgHooks['AbortLogin'][] = array( &$wgCaptcha, 'confirmUserLogin' );
 182
 183         global $wgGroupPermissions, $wgCaptchaTriggers;
 184         if( !$wgGroupPermissions['*']['read'] && $wgCaptchaTriggers['badlogin'] ) {
 185                 // We need to ensure that the captcha interface is accessible
 186                 // so that unauthenticated users can actually get in after a
 187                 // mistaken password typing.
 188                 global $wgWhitelistRead;
 189                 $image = Title::makeTitle( NS_SPECIAL, 'Captcha/image' );
 190                 $help = Title::makeTitle( NS_SPECIAL, 'Captcha/help' );
 191                 $wgWhitelistRead[] = $image->getPrefixedText();
 192                 $wgWhitelistRead[] = $help->getPrefixedText();
 193         }
 194 }
 195
 196 /**
 197  * Entry point for Special:Captcha
 198  */
 199 function wfSpecialCaptcha( $par = null ) {
 200         global $wgCaptcha;
 201         switch( $par ) {
 202         case "image":
 203                 return $wgCaptcha->showImage();
 204         case "help":
 205         default:
 206                 return $wgCaptcha->showHelp();
 207         }
 208 }
 209
 210 class SimpleCaptcha {
 211         function SimpleCaptcha() {
 212                 global $wgCaptchaStorageClass;
 213                 $this->storage = new $wgCaptchaStorageClass;
 214         }
 215
 216         /**
 217          * Insert a captcha prompt into the edit form.
 218          * This sample implementation generates a simple arithmetic operation;
 219          * it would be easy to defeat by machine.
 220          *
 221          * Override this!
 222          *
 223          * @return string HTML
 224          */
 225         function getForm() {
 226                 $a = mt_rand(0, 100);
 227                 $b = mt_rand(0, 10);
 228                 $op = mt_rand(0, 1) ? '+' : '-';
 229
 230                 $test = "$a $op $b";
 231                 $answer = ($op == '+') ? ($a + $b) : ($a - $b);
 232
 233                 $index = $this->storeCaptcha( array( 'answer' => $answer ) );
 234
 235                 return "<p><label for=\"wpCaptchaWord\">$test</label> = " .
 236                         wfElement( 'input', array(
 237                                 'name' => 'wpCaptchaWord',
 238                                 'id'   => 'wpCaptchaWord',
 239                                 'tabindex' => 1 ) ) . // tab in before the edit textarea
 240                         "</p>\n" .
 241                         wfElement( 'input', array(
 242                                 'type'  => 'hidden',
 243                                 'name'  => 'wpCaptchaId',
 244                                 'id'    => 'wpCaptchaId',
 245                                 'value' => $index ) );
 246         }
 247
 248         /**
 249          * Insert the captcha prompt into an edit form.
 250          * @param OutputPage $out
 251          */
 252         function editCallback( &$out ) {
 253                 $out->addWikiText( $this->getMessage( $this->action ) );
 254                 $out->addHTML( $this->getForm() );
 255         }
 256
 257         /**
 258          * Show a message asking the user to enter a captcha on edit
 259          * The result will be treated as wiki text
 260          *
 261          * @param $action Action being performed
 262          * @return string
 263          */
 264         function getMessage( $action ) {
 265                 $name = 'captcha-' . $action;
 266                 $text = wfMsg( $name );
 267                 # Obtain a more tailored message, if possible, otherwise, fall back to
 268                 # the default for edits
 269                 return wfEmptyMsg( $name, $text ) ? wfMsg( 'captcha-edit' ) : $text;
 270         }
 271
 272         /**
 273          * Inject whazawhoo
 274          * @fixme if multiple thingies insert a header, could break
 275          * @param SimpleTemplate $template
 276          * @return bool true to keep running callbacks
 277          */
 278         function injectUserCreate( &$template ) {
 279                 global $wgCaptchaTriggers, $wgOut;
 280                 if( $wgCaptchaTriggers['createaccount'] ) {
 281                         $template->set( 'header',
 282                                 "<div class='captcha'>" .
 283                                 $wgOut->parse( $this->getMessage( 'createaccount' ) ) .
 284                                 $this->getForm() .
 285                                 "</div>\n" );
 286                 }
 287                 return true;
 288         }
 289
 290         /**
 291          * Inject a captcha into the user login form after a failed
 292          * password attempt as a speedbump for mass attacks.
 293          * @fixme if multiple thingies insert a header, could break
 294          * @param SimpleTemplate $template
 295          * @return bool true to keep running callbacks
 296          */
 297         function injectUserLogin( &$template ) {
 298                 if( $this->isBadLoginTriggered() ) {
 299                         global $wgOut;
 300                         $template->set( 'header',
 301                                 "<div class='captcha'>" .
 302                                 $wgOut->parse( $this->getMessage( 'badlogin' ) ) .
 303                                 $this->getForm() .
 304                                 "</div>\n" );
 305                 }
 306                 return true;
 307         }
 308
 309         /**
 310          * When a bad login attempt is made, increment an expiring counter
 311          * in the memcache cloud. Later checks for this may trigger a
 312          * captcha display to prevent too many hits from the same place.
 313          * @param User $user
 314          * @param string $password
 315          * @param int $retval authentication return value
 316          * @return bool true to keep running callbacks
 317          */
 318         function triggerUserLogin( $user, $password, $retval ) {
 319                 global $wgCaptchaTriggers, $wgCaptchaBadLoginExpiration, $wgMemc;
 320                 if( $retval == LoginForm::WRONG_PASS && $wgCaptchaTriggers['badlogin'] ) {
 321                         $key = $this->badLoginKey();
 322                         $count = $wgMemc->get( $key );
 323                         if( !$count ) {
 324                                 $wgMemc->add( $key, 0, $wgCaptchaBadLoginExpiration );
 325                         }
 326                         $count = $wgMemc->incr( $key );
 327                 }
 328                 return true;
 329         }
 330
 331         /**
 332          * Check if a bad login has already been registered for this
 333          * IP address. If so, require a captcha.
 334          * @return bool
 335          * @access private
 336          */
 337         function isBadLoginTriggered() {
 338                 global $wgMemc;
 339                 return intval( $wgMemc->get( $this->badLoginKey() ) ) > 0;
 340         }
 341
 342         /**
 343          * Internal cache key for badlogin checks.
 344          * @return string
 345          * @access private
 346          */
 347         function badLoginKey() {
 348                 return wfMemcKey( 'captcha', 'badlogin', 'ip', wfGetIP() );
 349         }
 350
 351         /**
 352          * Check if the submitted form matches the captcha session data provided
 353          * by the plugin when the form was generated.
 354          *
 355          * Override this!
 356          *
 357          * @param WebRequest $request
 358          * @param array $info
 359          * @return bool
 360          */
 361         function keyMatch( $request, $info ) {
 362                 return $request->getVal( 'wpCaptchaWord' ) == $info['answer'];
 363         }
 364
 365         // ----------------------------------
 366
 367         /**
 368          * @param EditPage $editPage
 369          * @param string $action (edit/create/addurl...)
 370          * @return bool true if action triggers captcha on editPage's namespace
 371          */
 372         function captchaTriggers( &$editPage, $action) {
 373                 global $wgCaptchaTriggers, $wgCaptchaTriggersOnNamespace;
 374                 //Special config for this NS?
 375                 if (isset( $wgCaptchaTriggersOnNamespace[$editPage->mTitle->getNamespace()][$action] ) )
 376                         return $wgCaptchaTriggersOnNamespace[$editPage->mTitle->getNamespace()][$action];
 377
 378                 return ( !empty( $wgCaptchaTriggers[$action] ) ); //Default
 379         }
 380
 381
 382         /**
 383          * @param EditPage $editPage
 384          * @param string $newtext
 385          * @param string $section
 386          * @return bool true if the captcha should run
 387          */
 388         function shouldCheck( &$editPage, $newtext, $section ) {
 389                 $this->trigger = '';
 390
 391                 global $wgUser;
 392                 if( $wgUser->isAllowed( 'skipcaptcha' ) ) {
 393                         wfDebug( "ConfirmEdit: user group allows skipping captcha\n" );
 394                         return false;
 395                 }
 396
 397                 global $wgEmailAuthentication, $ceAllowConfirmedEmail;
 398                 if( $wgEmailAuthentication && $ceAllowConfirmedEmail &&
 399                         $wgUser->isEmailConfirmed() ) {
 400                         wfDebug( "ConfirmEdit: user has confirmed mail, skipping captcha\n" );
 401                         return false;
 402                 }
 403
 404                 if( $this->captchaTriggers( $editPage, 'edit' ) ) {
 405                         // Check on all edits
 406                         global $wgUser, $wgTitle;
 407                         $this->trigger = sprintf( "edit trigger by '%s' at [[%s]]",
 408                                 $wgUser->getName(),
 409                                 $wgTitle->getPrefixedText() );
 410                         $this->action = 'edit';
 411                         wfDebug( "ConfirmEdit: checking all edits...\n" );
 412                         return true;
 413                 }
 414
 415                 if( $this->captchaTriggers( $editPage, 'create' )  && !$editPage->mTitle->exists() ) {
 416                         //Check if creating a page
 417                         global $wgUser, $wgTitle;
 418                         $this->trigger = sprintf( "Create trigger by '%s' at [[%s]]",
 419                                 $wgUser->getName(),
 420                                 $wgTitle->getPrefixedText() );
 421                         $this->action = 'create';
 422                         wfDebug( "ConfirmEdit: checking on page creation...\n" );
 423                         return true;
 424                 }
 425
 426                 if( $this->captchaTriggers( $editPage, 'addurl' ) ) {
 427                         // Only check edits that add URLs
 428                         $oldtext = $this->loadText( $editPage, $section );
 429
 430                         $oldLinks = $this->findLinks( $oldtext );
 431                         $newLinks = $this->findLinks( $newtext );
 432                         $unknownLinks = array_filter( $newLinks, array( &$this, 'filterLink' ) );
 433
 434                         $addedLinks = array_diff( $unknownLinks, $oldLinks );
 435                         $numLinks = count( $addedLinks );
 436
 437                         if( $numLinks > 0 ) {
 438                                 global $wgUser, $wgTitle;
 439                                 $this->trigger = sprintf( "%dx url trigger by '%s' at [[%s]]: %s",
 440                                         $numLinks,
 441                                         $wgUser->getName(),
 442                                         $wgTitle->getPrefixedText(),
 443                                         implode( ", ", $addedLinks ) );
 444                                 $this->action = 'addurl';
 445                                 return true;
 446                         }
 447                 }
 448
 449                 global $wgCaptchaRegexes;
 450                 if( !empty( $wgCaptchaRegexes ) ) {
 451                         // Custom regex checks
 452                         $oldtext = $this->loadText( $editPage, $section );
 453
 454                         foreach( $wgCaptchaRegexes as $regex ) {
 455                                 $newMatches = array();
 456                                 if( preg_match_all( $regex, $newtext, $newMatches ) ) {
 457                                         $oldMatches = array();
 458                                         preg_match_all( $regex, $oldtext, $oldMatches );
 459
 460                                         $addedMatches = array_diff( $newMatches[0], $oldMatches[0] );
 461
 462                                         $numHits = count( $addedMatches );
 463                                         if( $numHits > 0 ) {
 464                                                 global $wgUser, $wgTitle;
 465                                                 $this->trigger = sprintf( "%dx %s at [[%s]]: %s",
 466                                                         $numHits,
 467                                                         $regex,
 468                                                         $wgUser->getName(),
 469                                                         $wgTitle->getPrefixedText(),
 470                                                         implode( ", ", $addedMatches ) );
 471                                                 $this->action = 'edit';
 472                                                 return true;
 473                                         }
 474                                 }
 475                         }
 476                 }
 477
 478                 return false;
 479         }
 480
 481         /**
 482          * Filter callback function for URL whitelisting
 483          * @param string url to check
 484          * @return bool true if unknown, false if whitelisted
 485          * @access private
 486          */
 487         function filterLink( $url ) {
 488                 global $wgCaptchaWhitelist;
 489                 $source = wfMsgForContent( 'captcha-addurl-whitelist' );
 490
 491                 $whitelist = wfEmptyMsg( 'captcha-addurl-whitelist', $source )
 492                         ? false
 493                         : $this->buildRegexes( explode( "\n", $source ) );
 494
 495                 $cwl = $wgCaptchaWhitelist !== false ? preg_match( $wgCaptchaWhitelist, $url ) : false;
 496                 $wl  = $whitelist          !== false ? preg_match( $whitelist, $url )          : false;
 497
 498                 return !( $cwl || $wl );
 499         }
 500
 501         /**
 502          * Build regex from whitelist
 503          * @param string lines from [[MediaWiki:Captcha-addurl-whitelist]]
 504          * @return string Regex or bool false if whitelist is empty
 505          * @access private
 506          */
 507         function buildRegexes( $lines ) {
 508                 # Code duplicated from the SpamBlacklist extension (r19197)
 509
 510                 # Strip comments and whitespace, then remove blanks
 511                 $lines = array_filter( array_map( 'trim', preg_replace( '/#.*$/', '', $lines ) ) );
 512
 513                 # No lines, don't make a regex which will match everything
 514                 if ( count( $lines ) == 0 ) {
 515                         wfDebug( "No lines\n" );
 516                         return false;
 517                 } else {
 518                         # Make regex
 519                         # It's faster using the S modifier even though it will usually only be run once
 520                         //$regex = 'http://+[a-z0-9_\-.]*(' . implode( '|', $lines ) . ')';
 521                         //return '/' . str_replace( '/', '\/', preg_replace('|\\\*/|', '/', $regex) ) . '/Si';
 522                         $regexes = '';
 523                         $regexStart = '/http:\/\/+[a-z0-9_\-.]*(';
 524                         $regexEnd = ')/Si';
 525                         $regexMax = 4096;
 526                         $build = false;
 527                         foreach( $lines as $line ) {
 528                                 // FIXME: not very robust size check, but should work. :)
 529                                 if( $build === false ) {
 530                                         $build = $line;
 531                                 } elseif( strlen( $build ) + strlen( $line ) > $regexMax ) {
 532                                         $regexes .= $regexStart .
 533                                                 str_replace( '/', '\/', preg_replace('|\\\*/|', '/', $build) ) .
 534                                                 $regexEnd;
 535                                         $build = $line;
 536                                 } else {
 537                                         $build .= '|' . $line;
 538                                 }
 539                         }
 540                         if( $build !== false ) {
 541                                 $regexes .= $regexStart .
 542                                         str_replace( '/', '\/', preg_replace('|\\\*/|', '/', $build) ) .
 543                                         $regexEnd;
 544                         }
 545                         return $regexes;
 546                 }
 547         }
 548
 549         /**
 550          * The main callback run on edit attempts.
 551          * @param EditPage $editPage
 552          * @param string $newtext
 553          * @param string $section
 554          * @param bool true to continue saving, false to abort and show a captcha form
 555          */
 556         function confirmEdit( &$editPage, $newtext, $section ) {
 557                 if( $this->shouldCheck( $editPage, $newtext, $section ) ) {
 558                         if( $this->passCaptcha() ) {
 559                                 return true;
 560                         } else {
 561                                 $editPage->showEditForm( array( &$this, 'editCallback' ) );
 562                                 return false;
 563                         }
 564                 } else {
 565                         wfDebug( "ConfirmEdit: no need to show captcha.\n" );
 566                         return true;
 567                 }
 568         }
 569
 570         /**
 571          * Hook for user creation form submissions.
 572          * @param User $u
 573          * @param string $message
 574          * @return bool true to continue, false to abort user creation
 575          */
 576         function confirmUserCreate( $u, &$message ) {
 577                 global $wgCaptchaTriggers;
 578                 if( $wgCaptchaTriggers['createaccount'] ) {
 579                         $this->trigger = "new account '" . $u->getName() . "'";
 580                         if( !$this->passCaptcha() ) {
 581                                 $message = wfMsg( 'captcha-createaccount-fail' );
 582                                 return false;
 583                         }
 584                 }
 585                 return true;
 586         }
 587
 588         /**
 589          * Hook for user login form submissions.
 590          * @param User $u
 591          * @param string $message
 592          * @return bool true to continue, false to abort user creation
 593          */
 594         function confirmUserLogin( $u, $pass, &$retval ) {
 595                 if( $this->isBadLoginTriggered() ) {
 596                         $this->trigger = "post-badlogin login '" . $u->getName() . "'";
 597                         if( !$this->passCaptcha() ) {
 598                                 $message = wfMsg( 'captcha-badlogin-fail' );
 599                                 // Emulate a bad-password return to confuse the shit out of attackers
 600                                 $retval = LoginForm::WRONG_PASS;
 601                                 return false;
 602                         }
 603                 }
 604                 return true;
 605         }
 606
 607         /**
 608          * Given a required captcha run, test form input for correct
 609          * input on the open session.
 610          * @return bool if passed, false if failed or new session
 611          */
 612         function passCaptcha() {
 613                 $info = $this->retrieveCaptcha();
 614                 if( $info ) {
 615                         global $wgRequest;
 616                         if( $this->keyMatch( $wgRequest, $info ) ) {
 617                                 $this->log( "passed" );
 618                                 $this->clearCaptcha( $info );
 619                                 return true;
 620                         } else {
 621                                 $this->clearCaptcha( $info );
 622                                 $this->log( "bad form input" );
 623                                 return false;
 624                         }
 625                 } else {
 626                         $this->log( "new captcha session" );
 627                         return false;
 628                 }
 629         }
 630
 631         /**
 632          * Log the status and any triggering info for debugging or statistics
 633          * @param string $message
 634          */
 635         function log( $message ) {
 636                 wfDebugLog( 'captcha', 'ConfirmEdit: ' . $message . '; ' .  $this->trigger );
 637         }
 638
 639         /**
 640          * Generate a captcha session ID and save the info in PHP's session storage.
 641          * (Requires the user to have cookies enabled to get through the captcha.)
 642          *
 643          * A random ID is used so legit users can make edits in multiple tabs or
 644          * windows without being unnecessarily hobbled by a serial order requirement.
 645          * Pass the returned id value into the edit form as wpCaptchaId.
 646          *
 647          * @param array $info data to store
 648          * @return string captcha ID key
 649          */
 650         function storeCaptcha( $info ) {
 651                 if( !isset( $info['index'] ) ) {
 652                         // Assign random index if we're not udpating
 653                         $info['index'] = strval( mt_rand() );
 654                 }
 655                 $this->storage->store( $info['index'], $info );
 656                 return $info['index'];
 657         }
 658
 659         /**
 660          * Fetch this session's captcha info.
 661          * @return mixed array of info, or false if missing
 662          */
 663         function retrieveCaptcha() {
 664                 global $wgRequest;
 665                 $index = $wgRequest->getVal( 'wpCaptchaId' );
 666                 return $this->storage->retrieve( $index );
 667         }
 668
 669         /**
 670          * Clear out existing captcha info from the session, to ensure
 671          * it can't be reused.
 672          */
 673         function clearCaptcha( $info ) {
 674                 $this->storage->clear( $info['index'] );
 675         }
 676
 677         /**
 678          * Retrieve the current version of the page or section being edited...
 679          * @param EditPage $editPage
 680          * @param string $section
 681          * @return string
 682          * @access private
 683          */
 684         function loadText( $editPage, $section ) {
 685                 $rev = Revision::newFromTitle( $editPage->mTitle );
 686                 if( is_null( $rev ) ) {
 687                         return "";
 688                 } else {
 689                         $text = $rev->getText();
 690                         if( $section != '' ) {
 691                                 return Article::getSection( $text, $section );
 692                         } else {
 693                                 return $text;
 694                         }
 695                 }
 696         }
 697
 698         /**
 699          * Extract a list of all recognized HTTP links in the text.
 700          * @param string $text
 701          * @return array of strings
 702          */
 703         function findLinks( $text ) {
 704                 global $wgParser, $wgTitle, $wgUser;
 705
 706                 $options = new ParserOptions();
 707                 $text = $wgParser->preSaveTransform( $text, $wgTitle, $wgUser, $options );
 708                 $out = $wgParser->parse( $text, $wgTitle, $options );
 709
 710                 return array_keys( $out->getExternalLinks() );
 711         }
 712
 713         /**
 714          * Show a page explaining what this wacky thing is.
 715          */
 716         function showHelp() {
 717                 global $wgOut, $ceAllowConfirmedEmail;
 718                 $wgOut->setPageTitle( wfMsg( 'captchahelp-title' ) );
 719                 $wgOut->addWikiText( wfMsg( 'captchahelp-text' ) );
 720                 if ( $this->storage->cookiesNeeded() ) {
 721                         $wgOut->addWikiText( wfMsg( 'captchahelp-cookies-needed' ) );
 722                 }
 723         }
 724
 725 }
 726
 727 class CaptchaSessionStore {
 728         function store( $index, $info ) {
 729                 $_SESSION['captcha' . $info['index']] = $info;
 730         }
 731
 732         function retrieve( $index ) {
 733                 if( isset( $_SESSION['captcha' . $index] ) ) {
 734                         return $_SESSION['captcha' . $index];
 735                 } else {
 736                         return false;
 737                 }
 738         }
 739
 740         function clear( $index ) {
 741                 unset( $_SESSION['captcha' . $index] );
 742         }
 743
 744         function cookiesNeeded() {
 745                 return true;
 746         }
 747 }
 748
 749 class CaptchaCacheStore {
 750         function store( $index, $info ) {
 751                 global $wgMemc, $wgCaptchaSessionExpiration;
 752                 $wgMemc->set( wfMemcKey( 'captcha', $index ), $info,
 753                         $wgCaptchaSessionExpiration );
 754         }
 755
 756         function retrieve( $index ) {
 757                 global $wgMemc;
 758                 $info = $wgMemc->get( wfMemcKey( 'captcha', $index ) );
 759                 if( $info ) {
 760                         return $info;
 761                 } else {
 762                         return false;
 763                 }
 764         }
 765
 766         function clear( $index ) {
 767                 global $wgMemc;
 768                 $wgMemc->delete( wfMemcKey( 'captcha', $index ) );
 769         }
 770
 771         function cookiesNeeded() {
 772                 return false;
 773         }
 774 }
 775
 776 } # End invocation guard
 777
 778