2f7173e992d1e0e5b35f2d0554f970819275e7d6
[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         exit;
32 }
33
34 global $wgExtensionFunctions, $wgGroupPermissions;
35
36 $wgExtensionFunctions[] = 'confirmEditSetup';
37 $wgExtensionCredits['other'][] = array(
38         'name' => 'ConfirmEdit',
39         'author' => 'Brion Vibber',
40         'svn-date' => '$LastChangedDate$',
41         'svn-revision' => '$LastChangedRevision$',
42         'url' => 'http://www.mediawiki.org/wiki/Extension:ConfirmEdit',
43         'description' => 'Simple captcha implementation',
44         'descriptionmsg' => 'captcha-desc',
45 );
46
47 /**
48  * The 'skipcaptcha' permission key can be given out to
49  * let known-good users perform triggering actions without
50  * having to go through the captcha.
51  *
52  * By default, sysops and registered bot accounts will be
53  * able to skip, while others have to go through it.
54  */
55 $wgGroupPermissions['*'            ]['skipcaptcha'] = false;
56 $wgGroupPermissions['user'         ]['skipcaptcha'] = false;
57 $wgGroupPermissions['autoconfirmed']['skipcaptcha'] = false;
58 $wgGroupPermissions['bot'          ]['skipcaptcha'] = true; // registered bots
59 $wgGroupPermissions['sysop'        ]['skipcaptcha'] = true;
60 $wgAvailableRights[] = 'skipcaptcha';
61
62 /**
63  * List of IP ranges to allow to skip the captcha, similar to the group setting:
64  * "$wgGroupPermission[...]['skipcaptcha'] = true"
65  *
66  * Specific IP addresses or CIDR-style ranges may be used,
67  * for instance:
68  * $wgCaptchaWhitelistIP = array('192.168.1.0/24', '10.1.0.0/16');
69  */
70 $wgCaptchaWhitelistIP = false;
71
72 global $wgCaptcha, $wgCaptchaClass, $wgCaptchaTriggers;
73 $wgCaptcha = null;
74 $wgCaptchaClass = 'SimpleCaptcha';
75
76 /**
77  * Actions which can trigger a captcha
78  *
79  * If the 'edit' trigger is on, *every* edit will trigger the captcha.
80  * This may be useful for protecting against vandalbot attacks.
81  *
82  * If using the default 'addurl' trigger, the captcha will trigger on
83  * edits that include URLs that aren't in the current version of the page.
84  * This should catch automated linkspammers without annoying people when
85  * they make more typical edits.
86  *
87  * The captcha code should not use $wgCaptchaTriggers, but CaptchaTriggers()
88  * which also takes into account per namespace triggering.
89  */
90 $wgCaptchaTriggers = array();
91 $wgCaptchaTriggers['edit']          = false; // Would check on every edit
92 $wgCaptchaTriggers['create']            = false; // Check on page creation.
93 $wgCaptchaTriggers['addurl']        = true;  // Check on edits that add URLs
94 $wgCaptchaTriggers['createaccount'] = true;  // Special:Userlogin&type=signup
95 $wgCaptchaTriggers['badlogin']      = true;  // Special:Userlogin after failure
96
97 /**
98  * You may wish to apply special rules for captcha triggering on some namespaces.
99  * $wgCaptchaTriggersOnNamespace[<namespace id>][<trigger>] forces an always on / 
100  * always off configuration with that trigger for the given namespace.
101  * Leave unset to use the global options ($wgCaptchaTriggers).
102  *
103  * Shall not be used with 'createaccount' (it is not checked).
104  */
105 $wgCaptchaTriggersOnNamespace = array();
106
107 #Example:
108 #$wgCaptchaTriggersOnNamespace[NS_TALK]['create'] = false; //Allow creation of talk pages without captchas.
109 #$wgCaptchaTriggersOnNamespace[NS_PROJECT]['edit'] = true; //Show captcha whenever editing Project pages.
110
111 /**
112  * Indicate how to store per-session data required to match up the
113  * internal captcha data with the editor.
114  *
115  * 'CaptchaSessionStore' uses PHP's session storage, which is cookie-based
116  * and may fail for anons with cookies disabled.
117  *
118  * 'CaptchaCacheStore' uses $wgMemc, which avoids the cookie dependency
119  * but may be fragile depending on cache configuration.
120  */
121 global $wgCaptchaStorageClass;
122 $wgCaptchaStorageClass = 'CaptchaSessionStore';
123
124 /**
125  * Number of seconds a captcha session should last in the data cache
126  * before expiring when managing through CaptchaCacheStore class.
127  *
128  * Default is a half hour.
129  */
130 global $wgCaptchaSessionExpiration;
131 $wgCaptchaSessionExpiration = 30 * 60;
132
133 /**
134  * Number of seconds after a bad login that a captcha will be shown to
135  * that client on the login form to slow down password-guessing bots.
136  *
137  * Has no effect if 'badlogin' is disabled in $wgCaptchaTriggers or
138  * if there is not a caching engine enabled.
139  *
140  * Default is five minutes.
141  */
142 global $wgCaptchaBadLoginExpiration;
143 $wgCaptchaBadLoginExpiration = 5 * 60;
144
145 /**
146  * Allow users who have confirmed their e-mail addresses to post
147  * URL links without being harassed by the captcha.
148  */
149 global $ceAllowConfirmedEmail;
150 $ceAllowConfirmedEmail = false;
151
152 /**
153  * Regex to whitelist URLs to known-good sites...
154  * For instance:
155  * $wgCaptchaWhitelist = '#^https?://([a-z0-9-]+\\.)?(wikimedia|wikipedia)\.org/#i';
156  * Local admins can define a whitelist under [[MediaWiki:captcha-addurl-whitelist]]
157  */
158 $wgCaptchaWhitelist = false;
159
160 /**
161  * Additional regexes to check for. Use full regexes; can match things
162  * other than URLs such as junk edits.
163  *
164  * If the new version matches one and the old version doesn't,
165  * toss up the captcha screen.
166  *
167  * @fixme Add a message for local admins to add items as well.
168  */
169 $wgCaptchaRegexes = array();
170
171 /** Register special page */
172 $wgSpecialPages['Captcha'] = array( /*class*/'CaptchaSpecialPage', /*name*/'Captcha' );
173
174 $wgConfirmEditIP = dirname( __FILE__ );
175 $wgExtensionMessagesFiles['ConfirmEdit'] = "$wgConfirmEditIP/ConfirmEdit.i18n.php";
176
177 if ( defined( 'MW_SUPPORTS_EDITFILTERMERGED' ) ) {
178         $wgHooks['EditFilterMerged'][] = 'ConfirmEditHooks::confirmEditMerged';
179 } else {
180         $wgHooks['EditFilter'][] = 'ConfirmEditHooks::confirmEdit';
181 }
182 $wgHooks['UserCreateForm'][] = 'ConfirmEditHooks::injectUserCreate';
183 $wgHooks['AbortNewAccount'][] = 'ConfirmEditHooks::confirmUserCreate';
184 $wgHooks['LoginAuthenticateAudit'][] = 'ConfirmEditHooks::triggerUserLogin';
185 $wgHooks['UserLoginForm'][] = 'ConfirmEditHooks::injectUserLogin';
186 $wgHooks['AbortLogin'][] = 'ConfirmEditHooks::confirmUserLogin';
187 # Register API hook
188 $wgHooks['APIEditBeforeSave'][] = 'ConfirmEditHooks::confirmEditAPI';
189
190 $wgAutoloadClasses['ConfirmEditHooks'] 
191         = $wgAutoloadClasses['SimpleCaptcha'] 
192         = $wgAutoloadClasses['CaptchaSessionStore']
193         = $wgAutoloadClasses['CaptchaCacheStore']
194         = $wgAutoloadClasses['CaptchaSpecialPage']
195         = "$wgConfirmEditIP/ConfirmEdit_body.php";
196
197 /**
198  * Set up $wgWhitelistRead
199  */
200 function confirmEditSetup() {
201         global $wgGroupPermissions, $wgCaptchaTriggers;
202         if( !$wgGroupPermissions['*']['read'] && $wgCaptchaTriggers['badlogin'] ) {
203                 // We need to ensure that the captcha interface is accessible
204                 // so that unauthenticated users can actually get in after a
205                 // mistaken password typing.
206                 global $wgWhitelistRead;
207                 $image = Title::makeTitle( NS_SPECIAL, 'Captcha/image' );
208                 $help = Title::makeTitle( NS_SPECIAL, 'Captcha/help' );
209                 $wgWhitelistRead[] = $image->getPrefixedText();
210                 $wgWhitelistRead[] = $help->getPrefixedText();
211         }
212 }
213
214