Using the right restriction parameter - empty string instead of 'false'.
[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 # Internationalisation file
37 if ( !function_exists( 'extAddMessages' ) ) {
38         require( dirname(__FILE__) . '/../ExtensionFunctions.php' );
39 }
40 require_once( 'ConfirmEdit.i18n.php' );
41
42 /**
43  * The 'skipcaptcha' permission key can be given out to
44  * let known-good users perform triggering actions without
45  * having to go through the captcha.
46  *
47  * By default, sysops and registered bot accounts will be
48  * able to skip, while others have to go through it.
49  */
50 $wgGroupPermissions['*'            ]['skipcaptcha'] = false;
51 $wgGroupPermissions['user'         ]['skipcaptcha'] = false;
52 $wgGroupPermissions['autoconfirmed']['skipcaptcha'] = false;
53 $wgGroupPermissions['bot'          ]['skipcaptcha'] = true; // registered bots
54 $wgGroupPermissions['sysop'        ]['skipcaptcha'] = true;
55
56 global $wgCaptcha, $wgCaptchaClass, $wgCaptchaTriggers;
57 $wgCaptcha = null;
58 $wgCaptchaClass = 'SimpleCaptcha';
59
60 /**
61  * Currently the captcha works only for page edits.
62  *
63  * If the 'edit' trigger is on, *every* edit will trigger the captcha.
64  * This may be useful for protecting against vandalbot attacks.
65  *
66  * If using the default 'addurl' trigger, the captcha will trigger on
67  * edits that include URLs that aren't in the current version of the page.
68  * This should catch automated linkspammers without annoying people when
69  * they make more typical edits.
70  */
71 $wgCaptchaTriggers = array();
72 $wgCaptchaTriggers['edit']          = false; // Would check on every edit
73 $wgCaptchaTriggers['addurl']        = true;  // Check on edits that add URLs
74 $wgCaptchaTriggers['createaccount'] = true;  // Special:Userlogin&type=signup
75
76
77 /**
78  * Allow users who have confirmed their e-mail addresses to post
79  * URL links without being harassed by the captcha.
80  */
81 global $ceAllowConfirmedEmail;
82 $ceAllowConfirmedEmail = false;
83
84 /**
85  * Regex to whitelist URLs to known-good sites...
86  * For instance:
87  * $wgCaptchaWhitelist = '#^https?://([a-z0-9-]+\\.)?(wikimedia|wikipedia)\.org/#i';
88  * @fixme Use the 'spam-whitelist' thingy instead?
89  */
90 $wgCaptchaWhitelist = false;
91
92 /**
93  * Additional regexes to check for. Use full regexes; can match things
94  * other than URLs such as junk edits.
95  *
96  * If the new version matches one and the old version doesn't,
97  * toss up the captcha screen.
98  *
99  * @fixme Add a message for local admins to add items as well.
100  */
101 $wgCaptchaRegexes = array();
102
103 /** Register special page */
104 global $wgSpecialPages;
105 $wgSpecialPages['Captcha'] = array( /*class*/ 'SpecialPage', /*name*/'Captcha', /*restriction*/ '',
106         /*listed*/ false, /*function*/ false, /*file*/ false );
107
108 /**
109  * Set up message strings for captcha utilities.
110  */
111 function ceSetup() {
112         # Add messages
113         global $wgConfirmEditMessages;
114         extAddMessages( $wgConfirmEditMessages );
115         
116         global $wgHooks, $wgCaptcha, $wgCaptchaClass, $wgSpecialPages;
117         $wgCaptcha = new $wgCaptchaClass();
118         $wgHooks['EditFilter'][] = array( &$wgCaptcha, 'confirmEdit' );
119         
120         $wgHooks['UserCreateForm'][] = array( &$wgCaptcha, 'injectUserCreate' );
121         $wgHooks['AbortNewAccount'][] = array( &$wgCaptcha, 'confirmUserCreate' );
122 }
123
124 /**
125  * Entry point for Special:Captcha
126  */
127 function wfSpecialCaptcha( $par = null ) {
128         global $wgCaptcha;
129         switch( $par ) {
130         case "image":
131                 return $wgCaptcha->showImage();
132         case "help":
133         default:
134                 return $wgCaptcha->showHelp();
135         }
136 }
137
138 class SimpleCaptcha {
139         /**
140          * Insert a captcha prompt into the edit form.
141          * This sample implementation generates a simple arithmetic operation;
142          * it would be easy to defeat by machine.
143          *
144          * Override this!
145          *
146          * @return string HTML
147          */
148         function getForm() {
149                 $a = mt_rand(0, 100);
150                 $b = mt_rand(0, 10);
151                 $op = mt_rand(0, 1) ? '+' : '-';
152                 
153                 $test = "$a $op $b";
154                 $answer = ($op == '+') ? ($a + $b) : ($a - $b);
155                 
156                 $index = $this->storeCaptcha( array( 'answer' => $answer ) );
157                 
158                 return "<p><label for=\"wpCaptchaWord\">$test</label> = " .
159                         wfElement( 'input', array(
160                                 'name' => 'wpCaptchaWord',
161                                 'id'   => 'wpCaptchaWord',
162                                 'tabindex' => 1 ) ) . // tab in before the edit textarea
163                         "</p>\n" .
164                         wfElement( 'input', array(
165                                 'type'  => 'hidden',
166                                 'name'  => 'wpCaptchaId',
167                                 'id'    => 'wpCaptchaId',
168                                 'value' => $index ) );
169         }
170         
171         /**
172          * Insert the captcha prompt into an edit form.
173          * @param OutputPage $out
174          */
175         function editCallback( &$out ) {
176                 $out->addWikiText( wfMsg( "captcha-short" ) );  
177                 $out->addHTML( $this->getForm() );
178         }
179         
180         /**
181          * Inject whazawhoo
182          * @fixme if multiple thingies insert a header, could break
183          * @param SimpleTemplate $template
184          * @return bool true to keep running callbacks
185          */
186         function injectUserCreate( &$template ) {
187                 global $wgCaptchaTriggers, $wgOut;
188                 if( $wgCaptchaTriggers['createaccount'] ) {
189                         $template->set( 'header',
190                                 "<div class='captcha'>" .
191                                 $wgOut->parse( wfMsg( 'captcha-createaccount' ) ) .
192                                 $this->getForm() .
193                                 "</div>\n" );
194                 }
195                 return true;
196         }
197         
198         /**
199          * Check if the submitted form matches the captcha session data provided
200          * by the plugin when the form was generated.
201          *
202          * Override this!
203          *
204          * @param WebRequest $request
205          * @param array $info
206          * @return bool
207          */
208         function keyMatch( $request, $info ) {
209                 return $request->getVal( 'wpCaptchaWord' ) == $info['answer'];
210         }
211         
212         // ----------------------------------
213         
214         /**
215          * @param EditPage $editPage
216          * @param string $newtext
217          * @param string $section
218          * @return bool true if the captcha should run
219          */
220         function shouldCheck( &$editPage, $newtext, $section ) {
221                 $this->trigger = '';
222                 
223                 global $wgUser;
224                 if( $wgUser->isAllowed( 'skipcaptcha' ) ) {
225                         wfDebug( "ConfirmEdit: user group allows skipping captcha\n" );
226                         return false;
227                 }
228         
229                 global $wgEmailAuthentication, $ceAllowConfirmedEmail;
230                 if( $wgEmailAuthentication && $ceAllowConfirmedEmail &&
231                         $wgUser->isEmailConfirmed() ) {
232                         wfDebug( "ConfirmEdit: user has confirmed mail, skipping captcha\n" );
233                         return false;
234                 }
235                 
236                 global $wgCaptchaTriggers;
237                 if( !empty( $wgCaptchaTriggers['edit'] ) ) {
238                         // Check on all edits
239                         global $wgUser, $wgTitle;
240                         $this->trigger = sprintf( "edit trigger by '%s' at [[%s]]",
241                                 $wgUser->getName(),
242                                 $wgTitle->getPrefixedText() );
243                         wfDebug( "ConfirmEdit: checking all edits...\n" );
244                         return true;
245                 }
246                 
247                 if( !empty( $wgCaptchaTriggers['addurl'] ) ) {
248                         // Only check edits that add URLs
249                         $oldtext = $this->loadText( $editPage, $section );
250                         
251                         $oldLinks = $this->findLinks( $oldtext );
252                         $newLinks = $this->findLinks( $newtext );
253                         $unknownLinks = array_filter( $newLinks, array( &$this, 'filterLink' ) );
254                         
255                         $addedLinks = array_diff( $unknownLinks, $oldLinks );
256                         $numLinks = count( $addedLinks );
257                         
258                         if( $numLinks > 0 ) {
259                                 global $wgUser, $wgTitle;
260                                 $this->trigger = sprintf( "%dx url trigger by '%s' at [[%s]]: %s",
261                                         $numLinks,
262                                         $wgUser->getName(),
263                                         $wgTitle->getPrefixedText(),
264                                         implode( ", ", $addedLinks ) );
265                                 return true;
266                         }
267                 }
268                 
269                 global $wgCaptchaRegexes;
270                 if( !empty( $wgCaptchaRegexes ) ) {
271                         // Custom regex checks
272                         $oldtext = $this->loadText( $editPage, $section );
273                         
274                         foreach( $wgCaptchaRegexes as $regex ) {
275                                 $newMatches = array();
276                                 if( preg_match_all( $regex, $newtext, $newMatches ) ) {
277                                         $oldMatches = array();
278                                         preg_match_all( $regex, $oldtext, $oldMatches );
279                                         
280                                         $addedMatches = array_diff( $newMatches[0], $oldMatches[0] );
281                                         
282                                         $numHits = count( $addedMatches );
283                                         if( $numHits > 0 ) {
284                                                 global $wgUser, $wgTitle;
285                                                 $this->trigger = sprintf( "%dx %s at [[%s]]: %s",
286                                                         $numHits,
287                                                         $regex,
288                                                         $wgUser->getName(),
289                                                         $wgTitle->getPrefixedText(),
290                                                         implode( ", ", $addedMatches ) );
291                                                 return true;
292                                         }
293                                 }
294                         }
295                 }
296                 
297                 return false;
298         }
299         
300         /**
301          * Filter callback function for URL whitelisting
302          * @return bool true if unknown, false if whitelisted
303          * @access private
304          */
305         function filterLink( $url ) {
306                 global $wgCaptchaWhitelist;
307                 return !( $wgCaptchaWhitelist && preg_match( $wgCaptchaWhitelist, $url ) );
308         }
309         
310         /**
311          * The main callback run on edit attempts.
312          * @param EditPage $editPage
313          * @param string $newtext
314          * @param string $section
315          * @param bool true to continue saving, false to abort and show a captcha form
316          */
317         function confirmEdit( &$editPage, $newtext, $section ) {
318                 if( $this->shouldCheck( $editPage, $newtext, $section ) ) {
319                         if( $this->passCaptcha() ) {
320                                 return true;
321                         } else {
322                                 $editPage->showEditForm( array( &$this, 'editCallback' ) );
323                                 return false;
324                         }
325                 } else {
326                         wfDebug( "ConfirmEdit: no new links.\n" );
327                         return true;
328                 }
329         }
330         
331         /**
332          * Hook for user creation form submissions.
333          * @param User $u
334          * @param string $message
335          * @return bool true to continue, false to abort user creation
336          */
337         function confirmUserCreate( $u, &$message ) {
338                 global $wgCaptchaTriggers;
339                 if( $wgCaptchaTriggers['createaccount'] ) {
340                         $this->trigger = "new account '" . $u->getName() . "'";
341                         if( !$this->passCaptcha() ) {
342                                 $message = wfMsg( 'captcha-createaccount-fail' );
343                                 return false;
344                         }
345                 }
346                 return true;
347         }
348         
349         /**
350          * Given a required captcha run, test form input for correct
351          * input on the open session.
352          * @return bool if passed, false if failed or new session
353          */
354         function passCaptcha() {
355                 $info = $this->retrieveCaptcha();
356                 if( $info ) {
357                         global $wgRequest;
358                         if( $this->keyMatch( $wgRequest, $info ) ) {
359                                 $this->log( "passed" );
360                                 $this->clearCaptcha( $info );
361                                 return true;
362                         } else {
363                                 $this->clearCaptcha( $info );
364                                 $this->log( "bad form input" );
365                                 return false;
366                         }
367                 } else {
368                         $this->log( "new captcha session" );
369                         return false;
370                 }
371         }
372         
373         /**
374          * Log the status and any triggering info for debugging or statistics
375          * @param string $message
376          */
377         function log( $message ) {
378                 wfDebugLog( 'captcha', 'ConfirmEdit: ' . $message . '; ' .  $this->trigger );
379         }
380         
381         /**
382          * Generate a captcha session ID and save the info in PHP's session storage.
383          * (Requires the user to have cookies enabled to get through the captcha.)
384          *
385          * A random ID is used so legit users can make edits in multiple tabs or
386          * windows without being unnecessarily hobbled by a serial order requirement.
387          * Pass the returned id value into the edit form as wpCaptchaId.
388          *
389          * @param array $info data to store
390          * @return string captcha ID key
391          */
392         function storeCaptcha( $info ) {
393                 if( !isset( $info['index'] ) ) {
394                         // Assign random index if we're not udpating
395                         $info['index'] = strval( mt_rand() );
396                 }
397                 $_SESSION['captcha' . $info['index']] = $info;
398                 return $info['index'];
399         }
400         
401         /**
402          * Fetch this session's captcha info.
403          * @return mixed array of info, or false if missing
404          */
405         function retrieveCaptcha() {
406                 global $wgRequest;
407                 $index = $wgRequest->getVal( 'wpCaptchaId' );
408                 if( isset( $_SESSION['captcha' . $index] ) ) {
409                         return $_SESSION['captcha' . $index];
410                 } else {
411                         return false;
412                 }
413         }
414         
415         /**
416          * Clear out existing captcha info from the session, to ensure
417          * it can't be reused.
418          */
419         function clearCaptcha( $info ) {
420                 unset( $_SESSION['captcha' . $info['index']] );
421         }
422         
423         /**
424          * Retrieve the current version of the page or section being edited...
425          * @param EditPage $editPage
426          * @param string $section
427          * @return string
428          * @access private
429          */
430         function loadText( $editPage, $section ) {
431                 $rev = Revision::newFromTitle( $editPage->mTitle );
432                 if( is_null( $rev ) ) {
433                         return "";
434                 } else {
435                         $text = $rev->getText();
436                         if( $section != '' ) {
437                                 return Article::getSection( $text, $section );
438                         } else {
439                                 return $text;
440                         }
441                 }
442         }
443         
444         /**
445          * Extract a list of all recognized HTTP links in the text.
446          * @param string $text
447          * @return array of strings
448          */
449         function findLinks( $text ) {
450                 $regex = '/((?:' . HTTP_PROTOCOLS . ')' . EXT_LINK_URL_CLASS . '+)/';
451                 
452                 if( preg_match_all( $regex, $text, $matches, PREG_PATTERN_ORDER ) ) {
453                         return $matches[1];
454                 } else {
455                         return array();
456                 }
457         }
458         
459         /**
460          * Show a page explaining what this wacky thing is.
461          */
462         function showHelp() {
463                 global $wgOut, $ceAllowConfirmedEmail;
464                 $wgOut->setPageTitle( wfMsg( 'captchahelp-title' ) );
465                 $wgOut->addWikiText( wfMsg( 'captchahelp-text' ) );
466         }
467         
468 }
469
470 } # End invocation guard
471
472 ?>