Captcha.php

   1 <?php
   2
   3 class SimpleCaptcha {
   4
   5         function getCaptcha() {
   6                 $a = mt_rand( 0, 100 );
   7                 $b = mt_rand( 0, 10 );
   8
   9                 /* Minus sign is used in the question. UTF-8,
  10                    since the api uses text/plain, not text/html */
  11                 $op = mt_rand( 0, 1 ) ? '+' : '−';
  12
  13                 // No space before and after $op, to ensure correct
  14                 // directionality.
  15                 $test = "$a$op$b";
  16                 $answer = ( $op == '+' ) ? ( $a + $b ) : ( $a - $b );
  17                 return array( 'question' => $test, 'answer' => $answer );
  18         }
  19
  20         function addCaptchaAPI( &$resultArr ) {
  21                 $captcha = $this->getCaptcha();
  22                 $index = $this->storeCaptcha( $captcha );
  23                 $resultArr['captcha']['type'] = 'simple';
  24                 $resultArr['captcha']['mime'] = 'text/plain';
  25                 $resultArr['captcha']['id'] = $index;
  26                 $resultArr['captcha']['question'] = $captcha['question'];
  27         }
  28
  29         /**
  30          * Insert a captcha prompt into the edit form.
  31          * This sample implementation generates a simple arithmetic operation;
  32          * it would be easy to defeat by machine.
  33          *
  34          * Override this!
  35          *
  36          * @return string HTML
  37          */
  38         function getForm() {
  39                 $captcha = $this->getCaptcha();
  40                 $index = $this->storeCaptcha( $captcha );
  41
  42                 return "<p><label for=\"wpCaptchaWord\">{$captcha['question']}</label> = " .
  43                         Xml::element( 'input', array(
  44                                 'name' => 'wpCaptchaWord',
  45                                 'id'   => 'wpCaptchaWord',
  46                                 'tabindex' => 1 ) ) . // tab in before the edit textarea
  47                         "</p>\n" .
  48                         Xml::element( 'input', array(
  49                                 'type'  => 'hidden',
  50                                 'name'  => 'wpCaptchaId',
  51                                 'id'    => 'wpCaptchaId',
  52                                 'value' => $index ) );
  53         }
  54
  55         /**
  56          * Insert the captcha prompt into an edit form.
  57          * @param OutputPage $out
  58          */
  59         function editCallback( &$out ) {
  60                 $out->addWikiText( $this->getMessage( $this->action ) );
  61                 $out->addHTML( $this->getForm() );
  62         }
  63
  64         /**
  65          * Show a message asking the user to enter a captcha on edit
  66          * The result will be treated as wiki text
  67          *
  68          * @param $action Action being performed
  69          * @return string
  70          */
  71         function getMessage( $action ) {
  72                 $name = 'captcha-' . $action;
  73                 $text = wfMsg( $name );
  74                 # Obtain a more tailored message, if possible, otherwise, fall back to
  75                 # the default for edits
  76                 return wfEmptyMsg( $name, $text ) ? wfMsg( 'captcha-edit' ) : $text;
  77         }
  78
  79         /**
  80          * Inject whazawhoo
  81          * @fixme if multiple thingies insert a header, could break
  82          * @param $form HTMLForm
  83          * @return bool true to keep running callbacks
  84          */
  85         function injectEmailUser( &$form ) {
  86                 global $wgCaptchaTriggers, $wgOut, $wgUser;
  87                 if ( $wgCaptchaTriggers['sendemail'] ) {
  88                         if ( $wgUser->isAllowed( 'skipcaptcha' ) ) {
  89                                 wfDebug( "ConfirmEdit: user group allows skipping captcha on email sending\n" );
  90                                 return true;
  91                         }
  92                         $form->addFooterText(
  93                                 "<div class='captcha'>" .
  94                                 $wgOut->parse( $this->getMessage( 'sendemail' ) ) .
  95                                 $this->getForm() .
  96                                 "</div>\n" );
  97                 }
  98                 return true;
  99         }
 100
 101         /**
 102          * Inject whazawhoo
 103          * @fixme if multiple thingies insert a header, could break
 104          * @param QuickTemplate $template
 105          * @return bool true to keep running callbacks
 106          */
 107         function injectUserCreate( &$template ) {
 108                 global $wgCaptchaTriggers, $wgOut, $wgUser;
 109                 if ( $wgCaptchaTriggers['createaccount'] ) {
 110                         if ( $wgUser->isAllowed( 'skipcaptcha' ) ) {
 111                                 wfDebug( "ConfirmEdit: user group allows skipping captcha on account creation\n" );
 112                                 return true;
 113                         }
 114                         $template->set( 'header',
 115                                 "<div class='captcha'>" .
 116                                 $wgOut->parse( $this->getMessage( 'createaccount' ) ) .
 117                                 $this->getForm() .
 118                                 "</div>\n" );
 119                 }
 120                 return true;
 121         }
 122
 123         /**
 124          * Inject a captcha into the user login form after a failed
 125          * password attempt as a speedbump for mass attacks.
 126          * @fixme if multiple thingies insert a header, could break
 127          * @param $template QuickTemplate
 128          * @return bool true to keep running callbacks
 129          */
 130         function injectUserLogin( &$template ) {
 131                 if ( $this->isBadLoginTriggered() ) {
 132                         global $wgOut;
 133                         $template->set( 'header',
 134                                 "<div class='captcha'>" .
 135                                 $wgOut->parse( $this->getMessage( 'badlogin' ) ) .
 136                                 $this->getForm() .
 137                                 "</div>\n" );
 138                 }
 139                 return true;
 140         }
 141
 142         /**
 143          * When a bad login attempt is made, increment an expiring counter
 144          * in the memcache cloud. Later checks for this may trigger a
 145          * captcha display to prevent too many hits from the same place.
 146          * @param User $user
 147          * @param string $password
 148          * @param int $retval authentication return value
 149          * @return bool true to keep running callbacks
 150          */
 151         function triggerUserLogin( $user, $password, $retval ) {
 152                 global $wgCaptchaTriggers, $wgCaptchaBadLoginExpiration, $wgMemc;
 153                 if ( $retval == LoginForm::WRONG_PASS && $wgCaptchaTriggers['badlogin'] ) {
 154                         $key = $this->badLoginKey();
 155                         $count = $wgMemc->get( $key );
 156                         if ( !$count ) {
 157                                 $wgMemc->add( $key, 0, $wgCaptchaBadLoginExpiration );
 158                         }
 159                         $count = $wgMemc->incr( $key );
 160                 }
 161                 return true;
 162         }
 163
 164         /**
 165          * Check if a bad login has already been registered for this
 166          * IP address. If so, require a captcha.
 167          * @return bool
 168          * @access private
 169          */
 170         function isBadLoginTriggered() {
 171                 global $wgMemc, $wgCaptchaTriggers, $wgCaptchaBadLoginAttempts;
 172                 return $wgCaptchaTriggers['badlogin'] && intval( $wgMemc->get( $this->badLoginKey() ) ) >= $wgCaptchaBadLoginAttempts;
 173         }
 174
 175         /**
 176          * Check if the IP is allowed to skip captchas
 177          */
 178         function isIPWhitelisted() {
 179                 global $wgCaptchaWhitelistIP;
 180
 181                 if ( $wgCaptchaWhitelistIP ) {
 182                         global $wgRequest;
 183
 184                         // Compat: WebRequest::getIP is only available since MW 1.19.
 185                         $ip = method_exists( $wgRequest, 'getIP' ) ? $wgRequest->getIP() : wfGetIP();
 186
 187                         foreach ( $wgCaptchaWhitelistIP as $range ) {
 188                                 if ( IP::isInRange( $ip, $range ) ) {
 189                                         return true;
 190                                 }
 191                         }
 192                 }
 193                 return false;
 194         }
 195
 196         /**
 197          * Internal cache key for badlogin checks.
 198          * @return string
 199          * @access private
 200          */
 201         function badLoginKey() {
 202                 global $wgRequest;
 203                 // Compat: WebRequest::getIP is only available since MW 1.19.
 204                 $ip = method_exists( $wgRequest, 'getIP' ) ? $wgRequest->getIP() : wfGetIP();
 205                 return wfMemcKey( 'captcha', 'badlogin', 'ip', $ip );
 206         }
 207
 208         /**
 209          * Check if the submitted form matches the captcha session data provided
 210          * by the plugin when the form was generated.
 211          *
 212          * Override this!
 213          *
 214          * @param string $answer
 215          * @param array $info
 216          * @return bool
 217          */
 218         function keyMatch( $answer, $info ) {
 219                 return $answer == $info['answer'];
 220         }
 221
 222         // ----------------------------------
 223
 224         /**
 225          * @param EditPage $editPage
 226          * @param string $action (edit/create/addurl...)
 227          * @return bool true if action triggers captcha on editPage's namespace
 228          */
 229         function captchaTriggers( &$editPage, $action ) {
 230                 global $wgCaptchaTriggers, $wgCaptchaTriggersOnNamespace;
 231                 // Special config for this NS?
 232                 if ( isset( $wgCaptchaTriggersOnNamespace[$editPage->mTitle->getNamespace()][$action] ) )
 233                         return $wgCaptchaTriggersOnNamespace[$editPage->mTitle->getNamespace()][$action];
 234
 235                 return ( !empty( $wgCaptchaTriggers[$action] ) ); // Default
 236         }
 237
 238         /**
 239          * @param EditPage $editPage
 240          * @param string $newtext
 241          * @param string $section
 242          * @return bool true if the captcha should run
 243          */
 244         function shouldCheck( &$editPage, $newtext, $section, $merged = false ) {
 245                 $this->trigger = '';
 246                 $title = $editPage->mArticle->getTitle();
 247
 248                 global $wgUser;
 249                 if ( $wgUser->isAllowed( 'skipcaptcha' ) ) {
 250                         wfDebug( "ConfirmEdit: user group allows skipping captcha\n" );
 251                         return false;
 252                 }
 253                 if ( $this->isIPWhitelisted() )
 254                         return false;
 255
 256
 257                 global $wgEmailAuthentication, $ceAllowConfirmedEmail;
 258                 if ( $wgEmailAuthentication && $ceAllowConfirmedEmail &&
 259                         $wgUser->isEmailConfirmed() ) {
 260                         wfDebug( "ConfirmEdit: user has confirmed mail, skipping captcha\n" );
 261                         return false;
 262                 }
 263
 264                 if ( $this->captchaTriggers( $editPage, 'edit' ) ) {
 265                         // Check on all edits
 266                         global $wgUser;
 267                         $this->trigger = sprintf( "edit trigger by '%s' at [[%s]]",
 268                                 $wgUser->getName(),
 269                                 $title->getPrefixedText() );
 270                         $this->action = 'edit';
 271                         wfDebug( "ConfirmEdit: checking all edits...\n" );
 272                         return true;
 273                 }
 274
 275                 if ( $this->captchaTriggers( $editPage, 'create' )  && !$editPage->mTitle->exists() ) {
 276                         // Check if creating a page
 277                         global $wgUser;
 278                         $this->trigger = sprintf( "Create trigger by '%s' at [[%s]]",
 279                                 $wgUser->getName(),
 280                                 $title->getPrefixedText() );
 281                         $this->action = 'create';
 282                         wfDebug( "ConfirmEdit: checking on page creation...\n" );
 283                         return true;
 284                 }
 285
 286                 if ( $this->captchaTriggers( $editPage, 'addurl' ) ) {
 287                         // Only check edits that add URLs
 288                         if ( $merged ) {
 289                                 // Get links from the database
 290                                 $oldLinks = $this->getLinksFromTracker( $title );
 291                                 // Share a parse operation with Article::doEdit()
 292                                 $editInfo = $editPage->mArticle->prepareTextForEdit( $newtext );
 293                                 $newLinks = array_keys( $editInfo->output->getExternalLinks() );
 294                         } else {
 295                                 // Get link changes in the slowest way known to man
 296                                 $oldtext = $this->loadText( $editPage, $section );
 297                                 $oldLinks = $this->findLinks( $editPage, $oldtext );
 298                                 $newLinks = $this->findLinks( $editPage, $newtext );
 299                         }
 300
 301                         $unknownLinks = array_filter( $newLinks, array( &$this, 'filterLink' ) );
 302                         $addedLinks = array_diff( $unknownLinks, $oldLinks );
 303                         $numLinks = count( $addedLinks );
 304
 305                         if ( $numLinks > 0 ) {
 306                                 global $wgUser;
 307                                 $this->trigger = sprintf( "%dx url trigger by '%s' at [[%s]]: %s",
 308                                         $numLinks,
 309                                         $wgUser->getName(),
 310                                         $title->getPrefixedText(),
 311                                         implode( ", ", $addedLinks ) );
 312                                 $this->action = 'addurl';
 313                                 return true;
 314                         }
 315                 }
 316
 317                 global $wgCaptchaRegexes;
 318                 if ( $wgCaptchaRegexes ) {
 319                         // Custom regex checks
 320                         $oldtext = $this->loadText( $editPage, $section );
 321
 322                         foreach ( $wgCaptchaRegexes as $regex ) {
 323                                 $newMatches = array();
 324                                 if ( preg_match_all( $regex, $newtext, $newMatches ) ) {
 325                                         $oldMatches = array();
 326                                         preg_match_all( $regex, $oldtext, $oldMatches );
 327
 328                                         $addedMatches = array_diff( $newMatches[0], $oldMatches[0] );
 329
 330                                         $numHits = count( $addedMatches );
 331                                         if ( $numHits > 0 ) {
 332                                                 global $wgUser;
 333                                                 $this->trigger = sprintf( "%dx %s at [[%s]]: %s",
 334                                                         $numHits,
 335                                                         $regex,
 336                                                         $wgUser->getName(),
 337                                                         $title->getPrefixedText(),
 338                                                         implode( ", ", $addedMatches ) );
 339                                                 $this->action = 'edit';
 340                                                 return true;
 341                                         }
 342                                 }
 343                         }
 344                 }
 345
 346                 return false;
 347         }
 348
 349         /**
 350          * Filter callback function for URL whitelisting
 351          * @param string url to check
 352          * @return bool true if unknown, false if whitelisted
 353          * @access private
 354          */
 355         function filterLink( $url ) {
 356                 global $wgCaptchaWhitelist;
 357                 $source = wfMsgForContent( 'captcha-addurl-whitelist' );
 358
 359                 $whitelist = wfEmptyMsg( 'captcha-addurl-whitelist', $source )
 360                         ? false
 361                         : $this->buildRegexes( explode( "\n", $source ) );
 362
 363                 $cwl = $wgCaptchaWhitelist !== false ? preg_match( $wgCaptchaWhitelist, $url ) : false;
 364                 $wl  = $whitelist          !== false ? preg_match( $whitelist, $url )          : false;
 365
 366                 return !( $cwl || $wl );
 367         }
 368
 369         /**
 370          * Build regex from whitelist
 371          * @param string lines from [[MediaWiki:Captcha-addurl-whitelist]]
 372          * @return string Regex or bool false if whitelist is empty
 373          * @access private
 374          */
 375         function buildRegexes( $lines ) {
 376                 # Code duplicated from the SpamBlacklist extension (r19197)
 377
 378                 # Strip comments and whitespace, then remove blanks
 379                 $lines = array_filter( array_map( 'trim', preg_replace( '/#.*$/', '', $lines ) ) );
 380
 381                 # No lines, don't make a regex which will match everything
 382                 if ( count( $lines ) == 0 ) {
 383                         wfDebug( "No lines\n" );
 384                         return false;
 385                 } else {
 386                         # Make regex
 387                         # It's faster using the S modifier even though it will usually only be run once
 388                         // $regex = 'http://+[a-z0-9_\-.]*(' . implode( '|', $lines ) . ')';
 389                         // return '/' . str_replace( '/', '\/', preg_replace('|\\\*/|', '/', $regex) ) . '/Si';
 390                         $regexes = '';
 391                         $regexStart = '/^https?:\/\/+[a-z0-9_\-.]*(';
 392                         $regexEnd = ')/Si';
 393                         $regexMax = 4096;
 394                         $build = false;
 395                         foreach ( $lines as $line ) {
 396                                 // FIXME: not very robust size check, but should work. :)
 397                                 if ( $build === false ) {
 398                                         $build = $line;
 399                                 } elseif ( strlen( $build ) + strlen( $line ) > $regexMax ) {
 400                                         $regexes .= $regexStart .
 401                                                 str_replace( '/', '\/', preg_replace( '|\\\*/|', '/', $build ) ) .
 402                                                 $regexEnd;
 403                                         $build = $line;
 404                                 } else {
 405                                         $build .= '|' . $line;
 406                                 }
 407                         }
 408                         if ( $build !== false ) {
 409                                 $regexes .= $regexStart .
 410                                         str_replace( '/', '\/', preg_replace( '|\\\*/|', '/', $build ) ) .
 411                                         $regexEnd;
 412                         }
 413                         return $regexes;
 414                 }
 415         }
 416
 417         /**
 418          * Load external links from the externallinks table
 419          * @param $title Title
 420          * @return Array
 421          */
 422         function getLinksFromTracker( $title ) {
 423                 $dbr = wfGetDB( DB_SLAVE );
 424                 $id = $title->getArticleID(); // should be zero queries
 425                 $res = $dbr->select( 'externallinks', array( 'el_to' ),
 426                         array( 'el_from' => $id ), __METHOD__ );
 427                 $links = array();
 428                 foreach ( $res as $row ) {
 429                         $links[] = $row->el_to;
 430                 }
 431                 return $links;
 432         }
 433
 434         /**
 435          * Backend function for confirmEdit() and confirmEditAPI()
 436          * @return bool false if the CAPTCHA is rejected, true otherwise
 437          */
 438         private function doConfirmEdit( $editPage, $newtext, $section, $merged = false ) {
 439                 global $wgRequest;
 440                 if ( $wgRequest->getVal( 'captchaid' ) ) {
 441                         $wgRequest->setVal( 'wpCaptchaId', $wgRequest->getVal( 'captchaid' ) );
 442                 }
 443                 if ( $wgRequest->getVal( 'captchaword' ) ) {
 444                         $wgRequest->setVal( 'wpCaptchaWord', $wgRequest->getVal( 'captchaword' ) );
 445                 }
 446                 if ( $this->shouldCheck( $editPage, $newtext, $section, $merged ) ) {
 447                         return $this->passCaptcha();
 448                 } else {
 449                         wfDebug( "ConfirmEdit: no need to show captcha.\n" );
 450                         return true;
 451                 }
 452         }
 453
 454         /**
 455          * The main callback run on edit attempts.
 456          * @param EditPage $editPage
 457          * @param string $newtext
 458          * @param string $section
 459          * @param bool $merged
 460          * @return bool true to continue saving, false to abort and show a captcha form
 461          */
 462         function confirmEdit( $editPage, $newtext, $section, $merged = false ) {
 463                 if ( defined( 'MW_API' ) ) {
 464                         # API mode
 465                         # The CAPTCHA was already checked and approved
 466                         return true;
 467                 }
 468                 if ( !$this->doConfirmEdit( $editPage, $newtext, $section, $merged ) ) {
 469                         $editPage->showEditForm( array( &$this, 'editCallback' ) );
 470                         return false;
 471                 }
 472                 return true;
 473         }
 474
 475         /**
 476          * A more efficient edit filter callback based on the text after section merging
 477          * @param EditPage $editPage
 478          * @param string $newtext
 479          */
 480         function confirmEditMerged( $editPage, $newtext ) {
 481                 return $this->confirmEdit( $editPage, $newtext, false, true );
 482         }
 483
 484         function confirmEditAPI( $editPage, $newtext, &$resultArr ) {
 485                 if ( !$this->doConfirmEdit( $editPage, $newtext, false, false ) ) {
 486                         $this->addCaptchaAPI( $resultArr );
 487                         return false;
 488                 }
 489
 490                 return true;
 491         }
 492
 493         /**
 494          * Hook for user creation form submissions.
 495          * @param User $u
 496          * @param string $message
 497          * @return bool true to continue, false to abort user creation
 498          */
 499         function confirmUserCreate( $u, &$message ) {
 500                 global $wgCaptchaTriggers, $wgUser;
 501                 if ( $wgCaptchaTriggers['createaccount'] ) {
 502                         if ( $wgUser->isAllowed( 'skipcaptcha' ) ) {
 503                                 wfDebug( "ConfirmEdit: user group allows skipping captcha on account creation\n" );
 504                                 return true;
 505                         }
 506                         if ( $this->isIPWhitelisted() )
 507                                 return true;
 508
 509                         $this->trigger = "new account '" . $u->getName() . "'";
 510                         if ( !$this->passCaptcha() ) {
 511                                 $message = wfMsg( 'captcha-createaccount-fail' );
 512                                 return false;
 513                         }
 514                 }
 515                 return true;
 516         }
 517
 518         /**
 519          * Hook for user login form submissions.
 520          * @param User $u
 521          * @param string $message
 522          * @return bool true to continue, false to abort user creation
 523          */
 524         function confirmUserLogin( $u, $pass, &$retval ) {
 525                 if ( $this->isBadLoginTriggered() ) {
 526                         if ( $this->isIPWhitelisted() )
 527                                 return true;
 528
 529                         $this->trigger = "post-badlogin login '" . $u->getName() . "'";
 530                         if ( !$this->passCaptcha() ) {
 531                                 // Emulate a bad-password return to confuse the shit out of attackers
 532                                 $retval = LoginForm::WRONG_PASS;
 533                                 return false;
 534                         }
 535                 }
 536                 return true;
 537         }
 538
 539         /**
 540          * Check the captcha on Special:EmailUser
 541          * @param $from MailAddress
 542          * @param $to MailAddress
 543          * @param $subject String
 544          * @param $text String
 545          * @param $error String reference
 546          * @return Bool true to continue saving, false to abort and show a captcha form
 547          */
 548         function confirmEmailUser( $from, $to, $subject, $text, &$error ) {
 549                 global $wgCaptchaTriggers, $wgUser;
 550                 if ( $wgCaptchaTriggers['sendemail'] ) {
 551                         if ( $wgUser->isAllowed( 'skipcaptcha' ) ) {
 552                                 wfDebug( "ConfirmEdit: user group allows skipping captcha on email sending\n" );
 553                                 return true;
 554                         }
 555                         if ( $this->isIPWhitelisted() )
 556                                 return true;
 557
 558                         if ( defined( 'MW_API' ) ) {
 559                                 # API mode
 560                                 # Asking for captchas in the API is really silly
 561                                 $error = wfMsg( 'captcha-disabledinapi' );
 562                                 return false;
 563                         }
 564                         $this->trigger = "{$wgUser->getName()} sending email";
 565                         if ( !$this->passCaptcha() ) {
 566                                 $error = wfMsg( 'captcha-sendemail-fail' );
 567                                 return false;
 568                         }
 569                 }
 570                 return true;
 571         }
 572
 573         /**
 574          * @param $module ApiBase
 575          * @param $params array
 576          * @return bool
 577          */
 578         public function APIGetAllowedParams( &$module, &$params ) {
 579                 if ( !$module instanceof ApiEditPage ) {
 580                         return true;
 581                 }
 582                 $params['captchaword'] = null;
 583                 $params['captchaid'] = null;
 584
 585                 return true;
 586         }
 587
 588         /**
 589          * @param $module ApiBae
 590          * @param $desc array
 591          * @return bool
 592          */
 593         public function APIGetParamDescription( &$module, &$desc ) {
 594                 if ( !$module instanceof ApiEditPage ) {
 595                         return true;
 596                 }
 597                 $desc['captchaid'] = 'CAPTCHA ID from previous request';
 598                 $desc['captchaword'] = 'Answer to the CAPTCHA';
 599
 600                 return true;
 601         }
 602
 603         /**
 604          * Given a required captcha run, test form input for correct
 605          * input on the open session.
 606          * @return bool if passed, false if failed or new session
 607          */
 608         function passCaptcha() {
 609                 $info = $this->retrieveCaptcha();
 610                 if ( $info ) {
 611                         global $wgRequest;
 612                         if ( $this->keyMatch( $wgRequest->getVal( 'wpCaptchaWord' ), $info ) ) {
 613                                 $this->log( "passed" );
 614                                 $this->clearCaptcha( $info );
 615                                 return true;
 616                         } else {
 617                                 $this->clearCaptcha( $info );
 618                                 $this->log( "bad form input" );
 619                                 return false;
 620                         }
 621                 } else {
 622                         $this->log( "new captcha session" );
 623                         return false;
 624                 }
 625         }
 626
 627         /**
 628          * Log the status and any triggering info for debugging or statistics
 629          * @param string $message
 630          */
 631         function log( $message ) {
 632                 wfDebugLog( 'captcha', 'ConfirmEdit: ' . $message . '; ' .  $this->trigger );
 633         }
 634
 635         /**
 636          * Generate a captcha session ID and save the info in PHP's session storage.
 637          * (Requires the user to have cookies enabled to get through the captcha.)
 638          *
 639          * A random ID is used so legit users can make edits in multiple tabs or
 640          * windows without being unnecessarily hobbled by a serial order requirement.
 641          * Pass the returned id value into the edit form as wpCaptchaId.
 642          *
 643          * @param array $info data to store
 644          * @return string captcha ID key
 645          */
 646         function storeCaptcha( $info ) {
 647                 if ( !isset( $info['index'] ) ) {
 648                         // Assign random index if we're not udpating
 649                         $info['index'] = strval( mt_rand() );
 650                 }
 651                 CaptchaStore::get()->store( $info['index'], $info );
 652                 return $info['index'];
 653         }
 654
 655         /**
 656          * Fetch this session's captcha info.
 657          * @return mixed array of info, or false if missing
 658          */
 659         function retrieveCaptcha() {
 660                 global $wgRequest;
 661                 $index = $wgRequest->getVal( 'wpCaptchaId' );
 662                 return CaptchaStore::get()->retrieve( $index );
 663         }
 664
 665         /**
 666          * Clear out existing captcha info from the session, to ensure
 667          * it can't be reused.
 668          */
 669         function clearCaptcha( $info ) {
 670                 CaptchaStore::get()->clear( $info['index'] );
 671         }
 672
 673         /**
 674          * Retrieve the current version of the page or section being edited...
 675          * @param EditPage $editPage
 676          * @param string $section
 677          * @return string
 678          * @access private
 679          */
 680         function loadText( $editPage, $section ) {
 681                 $rev = Revision::newFromTitle( $editPage->mTitle );
 682                 if ( is_null( $rev ) ) {
 683                         return "";
 684                 } else {
 685                         $text = $rev->getText();
 686                         if ( $section != '' ) {
 687                                 global $wgParser;
 688                                 return $wgParser->getSection( $text, $section );
 689                         } else {
 690                                 return $text;
 691                         }
 692                 }
 693         }
 694
 695         /**
 696          * Extract a list of all recognized HTTP links in the text.
 697          * @param string $text
 698          * @return array of strings
 699          */
 700         function findLinks( &$editpage, $text ) {
 701                 global $wgParser, $wgUser;
 702
 703                 $options = new ParserOptions();
 704                 $text = $wgParser->preSaveTransform( $text, $editpage->mTitle, $wgUser, $options );
 705                 $out = $wgParser->parse( $text, $editpage->mTitle, $options );
 706
 707                 return array_keys( $out->getExternalLinks() );
 708         }
 709
 710         /**
 711          * Show a page explaining what this wacky thing is.
 712          */
 713         function showHelp() {
 714                 global $wgOut;
 715                 $wgOut->setPageTitle( wfMsg( 'captchahelp-title' ) );
 716                 $wgOut->addWikiText( wfMsg( 'captchahelp-text' ) );
 717                 if ( CaptchaStore::get()->cookiesNeeded() ) {
 718                         $wgOut->addWikiText( wfMsg( 'captchahelp-cookies-needed' ) );
 719                 }
 720         }
 721 }