Add $wgCaptchaRegexes array; if set, captcha also triggers on new matches
[toast/cookiecaptcha.git] / 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  * @fixme Use the 'spam-whitelist' thingy instead?
83  */
84 $wgCaptchaWhitelist = false;
85
86 /**
87  * Additional regexes to check for. Use full regexes; can match things
88  * other than URLs such as junk edits.
89  *
90  * If the new version matches one and the old version doesn't,
91  * toss up the captcha screen.
92  *
93  * @fixme Add a message for local admins to add items as well.
94  */
95 $wgCaptchaRegexes = array();
96
97 /**
98  * Set up message strings for captcha utilities.
99  */
100 function ceSetup() {
101         global $wgMessageCache, $wgHooks, $wgCaptcha, $wgCaptchaClass;
102         $wgMessageCache->addMessages( array(
103                 'captcha-short' =>
104                         "Your edit includes new URL links; as a protection against automated " .
105                         "spam, you'll need to type in the words that appear in this image:\n" .
106                         "<br />([[Special:Captcha/help|What is this?]])",
107                 'captchahelp-title' =>
108                         'Captcha help',
109                 'captchahelp-text' =>
110                         "Web sites that accept postings from the public, like this wiki, " .
111                         "are often abused by spammers who use automated tools to post their " .
112                         "links to many sites. While these spam links can be removed, they " .
113                         "are a significant nuisance." .
114                         "\n\n" .
115                         "Sometimes, especially when adding new web links to a page, " .
116                         "the wiki may show you an image of colored or distorted text and " .
117                         "ask you to type the words shown. Since this is a task that's hard " .
118                         "to automate, it will allow most real humans to make their posts " . 
119                         "while stopping most spammers and other robotic attackers." .
120                         "\n\n" .
121                         "Unfortunately this may inconvenience users with limited vision or " .
122                         "using text-based or speech-based browsers. At the moment we do not " .
123                         "have an audio alternative available. Please contact the site " .
124                         "administrators for assistance if this is unexpectedly preventing " .
125                         "you from making legitimate posts." . 
126                         "\n\n" .
127                         "Hit the 'back' button in your browser to return to the page editor.",
128                 'captcha-createaccount' =>
129                         "As a protection against automated spam, you'll need to type in the " .
130                         "words that appear in this image to register an account:\n" .
131                         "<br />([[Special:Captcha/help|What is this?]])",
132                 'captcha-createaccount-fail' =>
133                         "Incorrect or missing confirmation code." ) );
134         
135         SpecialPage::addPage( new SpecialPage( 'Captcha', false,
136                 /*listed*/ false, /*function*/ false, /*file*/ false ) );
137         
138         $wgCaptcha = new $wgCaptchaClass();
139         $wgHooks['EditFilter'][] = array( &$wgCaptcha, 'confirmEdit' );
140         
141         $wgHooks['UserCreateForm'][] = array( &$wgCaptcha, 'injectUserCreate' );
142         $wgHooks['AbortNewAccount'][] = array( &$wgCaptcha, 'confirmUserCreate' );
143 }
144
145 /**
146  * Entry point for Special:Captcha
147  */
148 function wfSpecialCaptcha( $par = null ) {
149         global $wgCaptcha;
150         switch( $par ) {
151         case "image":
152                 return $wgCaptcha->showImage();
153         case "help":
154         default:
155                 return $wgCaptcha->showHelp();
156         }
157 }
158
159 class SimpleCaptcha {
160         /**
161          * Insert a captcha prompt into the edit form.
162          * This sample implementation generates a simple arithmetic operation;
163          * it would be easy to defeat by machine.
164          *
165          * Override this!
166          *
167          * @return string HTML
168          */
169         function getForm() {
170                 $a = mt_rand(0, 100);
171                 $b = mt_rand(0, 10);
172                 $op = mt_rand(0, 1) ? '+' : '-';
173                 
174                 $test = "$a $op $b";
175                 $answer = ($op == '+') ? ($a + $b) : ($a - $b);
176                 
177                 $index = $this->storeCaptcha( array( 'answer' => $answer ) );
178                 
179                 return "<p><label for=\"wpCaptchaWord\">$test</label> = " .
180                         wfElement( 'input', array(
181                                 'name' => 'wpCaptchaWord',
182                                 'id'   => 'wpCaptchaWord',
183                                 'tabindex' => 1 ) ) . // tab in before the edit textarea
184                         "</p>\n" .
185                         wfElement( 'input', array(
186                                 'type'  => 'hidden',
187                                 'name'  => 'wpCaptchaId',
188                                 'id'    => 'wpCaptchaId',
189                                 'value' => $index ) );
190         }
191         
192         /**
193          * Insert the captcha prompt into an edit form.
194          * @param OutputPage $out
195          */
196         function editCallback( &$out ) {
197                 $out->addWikiText( wfMsg( "captcha-short" ) );  
198                 $out->addHTML( $this->getForm() );
199         }
200         
201         /**
202          * Inject whazawhoo
203          * @fixme if multiple thingies insert a header, could break
204          * @param SimpleTemplate $template
205          * @return bool true to keep running callbacks
206          */
207         function injectUserCreate( &$template ) {
208                 global $wgCaptchaTriggers, $wgOut;
209                 if( $wgCaptchaTriggers['createaccount'] ) {
210                         $template->set( 'header',
211                                 "<div class='captcha'>" .
212                                 $wgOut->parse( wfMsg( 'captcha-createaccount' ) ) .
213                                 $this->getForm() .
214                                 "</div>\n" );
215                 }
216                 return true;
217         }
218         
219         /**
220          * Check if the submitted form matches the captcha session data provided
221          * by the plugin when the form was generated.
222          *
223          * Override this!
224          *
225          * @param WebRequest $request
226          * @param array $info
227          * @return bool
228          */
229         function keyMatch( $request, $info ) {
230                 return $request->getVal( 'wpCaptchaWord' ) == $info['answer'];
231         }
232         
233         // ----------------------------------
234         
235         /**
236          * @param EditPage $editPage
237          * @param string $newtext
238          * @param string $section
239          * @return bool true if the captcha should run
240          */
241         function shouldCheck( &$editPage, $newtext, $section ) {
242                 $this->trigger = '';
243                 
244                 global $wgUser;
245                 if( $wgUser->isAllowed( 'skipcaptcha' ) ) {
246                         wfDebug( "ConfirmEdit: user group allows skipping captcha\n" );
247                         return false;
248                 }
249         
250                 global $wgEmailAuthentication, $ceAllowConfirmedEmail;
251                 if( $wgEmailAuthentication && $ceAllowConfirmedEmail &&
252                         $wgUser->isEmailConfirmed() ) {
253                         wfDebug( "ConfirmEdit: user has confirmed mail, skipping captcha\n" );
254                         return false;
255                 }
256                 
257                 global $wgCaptchaTriggers;
258                 if( !empty( $wgCaptchaTriggers['edit'] ) ) {
259                         // Check on all edits
260                         global $wgUser, $wgTitle;
261                         $this->trigger = sprintf( "edit trigger by '%s' at [[%s]]",
262                                 $wgUser->getName(),
263                                 $wgTitle->getPrefixedText() );
264                         wfDebug( "ConfirmEdit: checking all edits...\n" );
265                         return true;
266                 }
267                 
268                 if( !empty( $wgCaptchaTriggers['addurl'] ) ) {
269                         // Only check edits that add URLs
270                         $oldtext = $this->loadText( $editPage, $section );
271                         
272                         $oldLinks = $this->findLinks( $oldtext );
273                         $newLinks = $this->findLinks( $newtext );
274                         $unknownLinks = array_filter( $newLinks, array( &$this, 'filterLink' ) );
275                         
276                         $addedLinks = array_diff( $unknownLinks, $oldLinks );
277                         $numLinks = count( $addedLinks );
278                         
279                         if( $numLinks > 0 ) {
280                                 global $wgUser, $wgTitle;
281                                 $this->trigger = sprintf( "%dx url trigger by '%s' at [[%s]]: %s",
282                                         $numLinks,
283                                         $wgUser->getName(),
284                                         $wgTitle->getPrefixedText(),
285                                         implode( ", ", $addedLinks ) );
286                                 return true;
287                         }
288                 }
289                 
290                 global $wgCaptchaRegexes;
291                 if( !empty( $wgCaptchaRegexes ) ) {
292                         // Custom regex checks
293                         $oldtext = $this->loadText( $editPage, $section );
294                         
295                         foreach( $wgCaptchaRegexes as $regex ) {
296                                 $newMatches = array();
297                                 if( preg_match_all( $regex, $newtext, $newMatches ) ) {
298                                         $oldMatches = array();
299                                         preg_match_all( $regex, $oldtext, $oldMatches );
300                                         
301                                         $addedMatches = array_diff( $newMatches[0], $oldMatches[0] );
302                                         
303                                         $numHits = count( $addedMatches );
304                                         if( $numHits > 0 ) {
305                                                 global $wgUser, $wgTitle;
306                                                 $this->trigger = sprintf( "%dx %s at [[%s]]: %s",
307                                                         $numHits,
308                                                         $regex,
309                                                         $wgUser->getName(),
310                                                         $wgTitle->getPrefixedText(),
311                                                         implode( ", ", $addedMatches ) );
312                                                 return true;
313                                         }
314                                 }
315                         }
316                 }
317                 
318                 return false;
319         }
320         
321         /**
322          * Filter callback function for URL whitelisting
323          * @return bool true if unknown, false if whitelisted
324          * @access private
325          */
326         function filterLink( $url ) {
327                 global $wgCaptchaWhitelist;
328                 return !( $wgCaptchaWhitelist && preg_match( $wgCaptchaWhitelist, $url ) );
329         }
330         
331         /**
332          * The main callback run on edit attempts.
333          * @param EditPage $editPage
334          * @param string $newtext
335          * @param string $section
336          * @param bool true to continue saving, false to abort and show a captcha form
337          */
338         function confirmEdit( &$editPage, $newtext, $section ) {
339                 if( $this->shouldCheck( $editPage, $newtext, $section ) ) {
340                         if( $this->passCaptcha() ) {
341                                 return true;
342                         } else {
343                                 $editPage->showEditForm( array( &$this, 'editCallback' ) );
344                                 return false;
345                         }
346                 } else {
347                         wfDebug( "ConfirmEdit: no new links.\n" );
348                         return true;
349                 }
350         }
351         
352         /**
353          * Hook for user creation form submissions.
354          * @param User $u
355          * @param string $message
356          * @return bool true to continue, false to abort user creation
357          */
358         function confirmUserCreate( $u, &$message ) {
359                 global $wgCaptchaTriggers;
360                 if( $wgCaptchaTriggers['createaccount'] ) {
361                         $this->trigger = "new account '" . $u->getName() . "'";
362                         if( !$this->passCaptcha() ) {
363                                 $message = wfMsg( 'captcha-createaccount-fail' );
364                                 return false;
365                         }
366                 }
367                 return true;
368         }
369         
370         /**
371          * Given a required captcha run, test form input for correct
372          * input on the open session.
373          * @return bool if passed, false if failed or new session
374          */
375         function passCaptcha() {
376                 $info = $this->retrieveCaptcha();
377                 if( $info ) {
378                         global $wgRequest;
379                         if( $this->keyMatch( $wgRequest, $info ) ) {
380                                 $this->log( "passed" );
381                                 $this->clearCaptcha( $info );
382                                 return true;
383                         } else {
384                                 $this->clearCaptcha( $info );
385                                 $this->log( "bad form input" );
386                                 return false;
387                         }
388                 } else {
389                         $this->log( "new captcha session" );
390                         return false;
391                 }
392         }
393         
394         /**
395          * Log the status and any triggering info for debugging or statistics
396          * @param string $message
397          */
398         function log( $message ) {
399                 wfDebugLog( 'captcha', 'ConfirmEdit: ' . $message . '; ' .  $this->trigger );
400         }
401         
402         /**
403          * Generate a captcha session ID and save the info in PHP's session storage.
404          * (Requires the user to have cookies enabled to get through the captcha.)
405          *
406          * A random ID is used so legit users can make edits in multiple tabs or
407          * windows without being unnecessarily hobbled by a serial order requirement.
408          * Pass the returned id value into the edit form as wpCaptchaId.
409          *
410          * @param array $info data to store
411          * @return string captcha ID key
412          */
413         function storeCaptcha( $info ) {
414                 if( !isset( $info['index'] ) ) {
415                         // Assign random index if we're not udpating
416                         $info['index'] = strval( mt_rand() );
417                 }
418                 $_SESSION['captcha' . $info['index']] = $info;
419                 return $info['index'];
420         }
421         
422         /**
423          * Fetch this session's captcha info.
424          * @return mixed array of info, or false if missing
425          */
426         function retrieveCaptcha() {
427                 global $wgRequest;
428                 $index = $wgRequest->getVal( 'wpCaptchaId' );
429                 if( isset( $_SESSION['captcha' . $index] ) ) {
430                         return $_SESSION['captcha' . $index];
431                 } else {
432                         return false;
433                 }
434         }
435         
436         /**
437          * Clear out existing captcha info from the session, to ensure
438          * it can't be reused.
439          */
440         function clearCaptcha( $info ) {
441                 unset( $_SESSION['captcha' . $info['index']] );
442         }
443         
444         /**
445          * Retrieve the current version of the page or section being edited...
446          * @param EditPage $editPage
447          * @param string $section
448          * @return string
449          * @access private
450          */
451         function loadText( $editPage, $section ) {
452                 $rev = Revision::newFromTitle( $editPage->mTitle );
453                 if( is_null( $rev ) ) {
454                         return "";
455                 } else {
456                         $text = $rev->getText();
457                         if( $section != '' ) {
458                                 return Article::getSection( $text, $section );
459                         } else {
460                                 return $text;
461                         }
462                 }
463         }
464         
465         /**
466          * Extract a list of all recognized HTTP links in the text.
467          * @param string $text
468          * @return array of strings
469          */
470         function findLinks( $text ) {
471                 $regex = '/((?:' . HTTP_PROTOCOLS . ')' . EXT_LINK_URL_CLASS . '+)/';
472                 
473                 if( preg_match_all( $regex, $text, $matches, PREG_PATTERN_ORDER ) ) {
474                         return $matches[1];
475                 } else {
476                         return array();
477                 }
478         }
479         
480         /**
481          * Show a page explaining what this wacky thing is.
482          */
483         function showHelp() {
484                 global $wgOut, $ceAllowConfirmedEmail;
485                 $wgOut->setPageTitle( wfMsg( 'captchahelp-title' ) );
486                 $wgOut->addWikiText( wfMsg( 'captchahelp-text' ) );
487         }
488         
489 }
490
491 } # End invocation guard
492
493 ?>