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
  69 /**
  70  * Allow users who have confirmed their e-mail addresses to post
  71  * URL links without being harassed by the captcha.
  72  */
  73 global $ceAllowConfirmedEmail;
  74 $ceAllowConfirmedEmail = false;
  75
  76 /**
  77  * Regex to whitelist URLs to known-good sites...
  78  * For instance:
  79  * $wgCaptchaWhitelist = '#^https?://([a-z0-9-]+\\.)?(wikimedia|wikipedia)\.org/#i';
  80  */
  81 $wgCaptchaWhitelist = false;
  82
  83 /**
  84  * Set up message strings for captcha utilities.
  85  */
  86 function ceSetup() {
  87         global $wgMessageCache, $wgHooks, $wgCaptcha, $wgCaptchaClass;
  88         $wgMessageCache->addMessages( array(
  89                 'captcha-short' =>
  90                         "Your edit includes new URL links; as a protection against automated " .
  91                         "spam, you'll need to type in the words that appear in this image:\n" .
  92                         "<br />([[Special:Captcha/help|What is this?]])",
  93                 'captchahelp-title' =>
  94                         'Captcha help',
  95                 'captchahelp-text' =>
  96                         "Web sites that accept postings from the public, like this wiki, " .
  97                         "are often abused by spammers who use automated tools to post their " .
  98                         "links to many sites. While these spam links can be removed, they " .
  99                         "are a significant nuisance." .
 100                         "\n\n" .
 101                         "Sometimes, especially when adding new web links to a page, " .
 102                         "the wiki may show you an image of colored or distorted text and " .
 103                         "ask you to type the words shown. Since this is a task that's hard " .
 104                         "to automate, it will allow most real humans to make their posts " .
 105                         "while stopping most spammers and other robotic attackers." .
 106                         "\n\n" .
 107                         "Unfortunately this may inconvenience users with limited vision or " .
 108                         "using text-based or speech-based browsers. At the moment we do not " .
 109                         "have an audio alternative available. Please contact the site " .
 110                         "administrators for assistance if this is unexpectedly preventing " .
 111                         "you from making legitimate posts." .
 112                         "\n\n" .
 113                         "Hit the 'back' button in your browser to return to the page editor." ) );
 114
 115         SpecialPage::addPage( new SpecialPage( 'Captcha', false,
 116                 /*listed*/ false, /*function*/ false, /*file*/ false ) );
 117
 118         $wgCaptcha = new $wgCaptchaClass();
 119         $wgHooks['EditFilter'][] = array( &$wgCaptcha, 'confirmEdit' );
 120 }
 121
 122 /**
 123  * Entry point for Special:Captcha
 124  */
 125 function wfSpecialCaptcha( $par = null ) {
 126         global $wgCaptcha;
 127         switch( $par ) {
 128         case "image":
 129                 return $wgCaptcha->showImage();
 130         case "help":
 131         default:
 132                 return $wgCaptcha->showHelp();
 133         }
 134 }
 135
 136 class SimpleCaptcha {
 137         /**
 138          * Insert a captcha prompt into the edit form.
 139          * This sample implementation generates a simple arithmetic operation;
 140          * it would be easy to defeat by machine.
 141          *
 142          * Override this!
 143          *
 144          * @param OutputPage $out
 145          */
 146         function formCallback( &$out ) {
 147                 $a = mt_rand(0, 100);
 148                 $b = mt_rand(0, 10);
 149                 $op = mt_rand(0, 1) ? '+' : '-';
 150
 151                 $test = "$a $op $b";
 152                 $answer = ($op == '+') ? ($a + $b) : ($a - $b);
 153
 154                 $index = $this->storeCaptcha( array( 'answer' => $answer ) );
 155
 156                 $out->addWikiText( wfMsg( "captcha-short" ) );
 157                 $out->addHTML( "<p><label for=\"wpCaptchaWord\">$test</label> = " .
 158                         wfElement( 'input', array(
 159                                 'name' => 'wpCaptchaWord',
 160                                 'id'   => 'wpCaptchaWord',
 161                                 'tabindex' => 1 ) ) . // tab in before the edit textarea
 162                         "</p>\n" .
 163                         wfElement( 'input', array(
 164                                 'type'  => 'hidden',
 165                                 'name'  => 'wpCaptchaId',
 166                                 'id'    => 'wpCaptchaId',
 167                                 'value' => $index ) ) );
 168         }
 169
 170         /**
 171          * Check if the submitted form matches the captcha session data provided
 172          * by the plugin when the form was generated.
 173          *
 174          * Override this!
 175          *
 176          * @param WebRequest $request
 177          * @param array $info
 178          * @return bool
 179          */
 180         function keyMatch( $request, $info ) {
 181                 return $request->getVal( 'wpCaptchaWord' ) == $info['answer'];
 182         }
 183
 184         // ----------------------------------
 185
 186         /**
 187          * @param EditPage $editPage
 188          * @param string $newtext
 189          * @param string $section
 190          * @return bool true if the captcha should run
 191          */
 192         function shouldCheck( &$editPage, $newtext, $section ) {
 193                 global $wgUser;
 194                 if( $wgUser->isAllowed( 'skipcaptcha' ) ) {
 195                         wfDebug( "ConfirmEdit: user group allows skipping captcha\n" );
 196                         return false;
 197                 }
 198
 199                 global $wgEmailAuthentication, $ceAllowConfirmedEmail;
 200                 if( $wgEmailAuthentication && $ceAllowConfirmedEmail &&
 201                         $wgUser->isEmailConfirmed() ) {
 202                         wfDebug( "ConfirmEdit: user has confirmed mail, skipping captcha\n" );
 203                         return false;
 204                 }
 205
 206                 global $wgCaptchaTriggers;
 207                 if( !empty( $wgCaptchaTriggers['edit'] ) ) {
 208                         // Check on all edits
 209                         wfDebug( "ConfirmEdit: checking all edits...\n" );
 210                         return true;
 211                 }
 212
 213                 if( !empty( $wgCaptchaTriggers['addurl'] ) ) {
 214                         // Only check edits that add URLs
 215                         $oldtext = $this->loadText( $editPage, $section );
 216
 217                         $oldLinks = $this->findLinks( $oldtext );
 218                         $newLinks = $this->findLinks( $newtext );
 219                         $unknownLinks = array_filter( $newLinks, array( &$this, 'filterLink' ) );
 220
 221                         $addedLinks = array_diff( $unknownLinks, $oldLinks );
 222                         $numLinks = count( $addedLinks );
 223
 224                         if( $numLinks > 0 ) {
 225                                 global $wgUser, $wgTitle;
 226                                 wfDebugLog( "captcha", sprintf( "ConfirmEdit: %dx url trigger by %s at [[%s]]: %s",
 227                                         $numLinks,
 228                                         $wgUser->getName(),
 229                                         $wgTitle->getPrefixedText(),
 230                                         implode( ", ", $addedLinks ) ) );
 231                                 return true;
 232                         }
 233                 }
 234
 235                 return false;
 236         }
 237
 238         /**
 239          * Filter callback function for URL whitelisting
 240          * @return bool true if unknown, false if whitelisted
 241          * @access private
 242          */
 243         function filterLink( $url ) {
 244                 global $wgCaptchaWhitelist;
 245                 return !( $wgCaptchaWhitelist && preg_match( $wgCaptchaWhitelist, $url ) );
 246         }
 247
 248         /**
 249          * The main callback run on edit attempts.
 250          * @param EditPage $editPage
 251          * @param string $newtext
 252          * @param string $section
 253          * @param bool true to continue saving, false to abort and show a captcha form
 254          */
 255         function confirmEdit( &$editPage, $newtext, $section ) {
 256                 if( $this->shouldCheck( $editPage, $newtext, $section ) ) {
 257                         $info = $this->retrieveCaptcha();
 258                         if( $info ) {
 259                                 global $wgRequest;
 260                                 if( $this->keyMatch( $wgRequest, $info ) ) {
 261                                         wfDebug( "ConfirmEdit given proper key from form, passing.\n" );
 262                                         return true;
 263                                 } else {
 264                                         wfDebug( "ConfirmEdit missing form key, prompting.\n" );
 265                                 }
 266                         } else {
 267                                 wfDebug( "ConfirmEdit: no session captcha key set, this is new visitor.\n" );
 268                         }
 269                         $editPage->showEditForm( array( &$this, 'formCallback' ) );
 270                         return false;
 271                 } else {
 272                         wfDebug( "ConfirmEdit: no new links.\n" );
 273                         return true;
 274                 }
 275         }
 276
 277         /**
 278          * Generate a captcha session ID and save the info in PHP's session storage.
 279          * (Requires the user to have cookies enabled to get through the captcha.)
 280          *
 281          * A random ID is used so legit users can make edits in multiple tabs or
 282          * windows without being unnecessarily hobbled by a serial order requirement.
 283          * Pass the returned id value into the edit form as wpCaptchaId.
 284          *
 285          * @param array $info data to store
 286          * @param string $index optional, to overwrite used session
 287          * @return string captcha ID key
 288          */
 289         function storeCaptcha( $info, $index=null ) {
 290                 if( is_null( $index ) ) {
 291                         $index = strval( mt_rand() );
 292                         $info['index'] = $index;
 293                 }
 294                 $_SESSION['captcha' . $index] = $info;
 295                 return $index;
 296         }
 297
 298         /**
 299          * Fetch this session's captcha info.
 300          * @return mixed array of info, or false if missing
 301          */
 302         function retrieveCaptcha() {
 303                 global $wgRequest;
 304                 $index = $wgRequest->getVal( 'wpCaptchaId' );
 305                 if( isset( $_SESSION['captcha' . $index] ) ) {
 306                         return $_SESSION['captcha' . $index];
 307                 } else {
 308                         return false;
 309                 }
 310         }
 311
 312         /**
 313          * Retrieve the current version of the page or section being edited...
 314          * @param EditPage $editPage
 315          * @param string $section
 316          * @return string
 317          * @access private
 318          */
 319         function loadText( $editPage, $section ) {
 320                 $rev = Revision::newFromTitle( $editPage->mTitle );
 321                 if( is_null( $rev ) ) {
 322                         return "";
 323                 } else {
 324                         $text = $rev->getText();
 325                         if( $section != '' ) {
 326                                 return Article::getSection( $text, $section );
 327                         } else {
 328                                 return $text;
 329                         }
 330                 }
 331         }
 332
 333         /**
 334          * Extract a list of all recognized HTTP links in the text.
 335          * @param string $text
 336          * @return array of strings
 337          */
 338         function findLinks( $text ) {
 339                 $regex = '/((?:' . HTTP_PROTOCOLS . ')' . EXT_LINK_URL_CLASS . '+)/';
 340
 341                 if( preg_match_all( $regex, $text, $matches, PREG_PATTERN_ORDER ) ) {
 342                         return $matches[1];
 343                 } else {
 344                         return array();
 345                 }
 346         }
 347
 348         /**
 349          * Show a page explaining what this wacky thing is.
 350          */
 351         function showHelp() {
 352                 global $wgOut, $ceAllowConfirmedEmail;
 353                 $wgOut->setPageTitle( wfMsg( 'captchahelp-title' ) );
 354                 $wgOut->addWikiText( wfMsg( 'captchahelp-text' ) );
 355         }
 356
 357 }
 358
 359 } # End invocation guard
 360
 361 ?>