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