Use Doxygen @addtogroup instead of phpdoc @package && @subpackage
[toast/cookiecaptcha.git] / FancyCaptcha.php
1 <?php
2 /**
3  * Experimental image-based captcha plugin, using images generated by an
4  * external tool.
5  *
6  * Copyright (C) 2005, 2006 Brion Vibber <brion@pobox.com>
7  * http://www.mediawiki.org/
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, write to the Free Software Foundation, Inc.,
21  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22  * http://www.gnu.org/copyleft/gpl.html
23  *
24  * @addtogroup Extensions
25  */
26
27 if ( defined( 'MEDIAWIKI' ) ) {
28
29 global $wgCaptchaDirectory;
30 $wgCaptchaDirectory = "$wgUploadDirectory/captcha"; // bad default :D
31
32 global $wgCaptchaSecret;
33 $wgCaptchaSecret = "CHANGE_THIS_SECRET!";
34
35 $wgExtensionFunctions[] = 'efFancyCaptcha';
36
37 function efFancyCaptcha() {
38         global $wgMessageCache;
39         require_once( dirname( __FILE__ ) . '/FancyCaptcha.i18n.php' );
40         foreach( efFancyCaptchaMessages() as $lang => $messages )
41                 $wgMessageCache->addMessages( $messages, $lang );
42 }
43
44 class FancyCaptcha extends SimpleCaptcha {
45         /**
46          * Check if the submitted form matches the captcha session data provided
47          * by the plugin when the form was generated.
48          *
49          * @param WebRequest $request
50          * @param array $info
51          * @return bool
52          */
53         function keyMatch( $request, $info ) {
54                 global $wgCaptchaSecret;
55
56                 $answer = $request->getVal( 'wpCaptchaWord' );
57                 $digest = $wgCaptchaSecret . $info['salt'] . $answer . $wgCaptchaSecret . $info['salt'];
58                 $answerHash = substr( md5( $digest ), 0, 16 );
59
60                 if( $answerHash == $info['hash'] ) {
61                         wfDebug( "FancyCaptcha: answer hash matches expected {$info['hash']}\n" );
62                         return true;
63                 } else {
64                         wfDebug( "FancyCaptcha: answer hashes to $answerHash, expected {$info['hash']}\n" );
65                         return false;
66                 }
67         }
68
69         /**
70          * Insert the captcha prompt into the edit form.
71          */
72         function getForm() {
73                 $info = $this->pickImage();
74                 if( !$info ) {
75                         die( "out of captcha images; this shouldn't happen" );
76                 }
77
78                 // Generate a random key for use of this captcha image in this session.
79                 // This is needed so multiple edits in separate tabs or windows can
80                 // go through without extra pain.
81                 $index = $this->storeCaptcha( $info );
82
83                 wfDebug( "Captcha id $index using hash ${info['hash']}, salt ${info['salt']}.\n" );
84
85                 $title = Title::makeTitle( NS_SPECIAL, 'Captcha/image' );
86
87                 return "<p>" .
88                         wfElement( 'img', array(
89                                 'src'    => $title->getLocalUrl( 'wpCaptchaId=' . urlencode( $index ) ),
90                                 'width'  => $info['width'],
91                                 'height' => $info['height'],
92                                 'alt'    => '' ) ) .
93                         "</p>\n" .
94                         wfElement( 'input', array(
95                                 'type'  => 'hidden',
96                                 'name'  => 'wpCaptchaId',
97                                 'id'    => 'wpCaptchaId',
98                                 'value' => $index ) ) .
99                         "<p>" .
100                         wfElement( 'input', array(
101                                 'name' => 'wpCaptchaWord',
102                                 'id'   => 'wpCaptchaWord',
103                                 'tabindex' => 1 ) ) . // tab in before the edit textarea
104                         "</p>\n";
105         }
106
107         /**
108          * Select a previously generated captcha image from the queue.
109          * @fixme subject to race conditions if lots of files vanish
110          * @return mixed tuple of (salt key, text hash) or false if no image to find
111          */
112         function pickImage() {
113                 global $wgCaptchaDirectory;
114                 $n = mt_rand( 0, $this->countFiles( $wgCaptchaDirectory ) );
115                 $dir = opendir( $wgCaptchaDirectory );
116
117                 $count = 0;
118
119                 $entry = readdir( $dir );
120                 $pick = false;
121                 while( false !== $entry ) {
122                         $entry = readdir( $dir );
123                         if( preg_match( '/^image_([0-9a-f]+)_([0-9a-f]+)\\.png$/', $entry, $matches ) ) {
124                                 $size = getimagesize( "$wgCaptchaDirectory/$entry" );
125                                 $pick = array(
126                                         'salt' => $matches[1],
127                                         'hash' => $matches[2],
128                                         'width' => $size[0],
129                                         'height' => $size[1],
130                                         'viewed' => false,
131                                 );
132                                 if( $count++ == $n ) {
133                                         break;
134                                 }
135                         }
136                 }
137                 closedir( $dir );
138                 return $pick;
139         }
140
141         /**
142          * Count the number of files in a directory.
143          * @return int
144          */
145         function countFiles( $dirname ) {
146                 $dir = opendir( $dirname );
147                 $count = 0;
148                 while( false !== ($entry = readdir( $dir ) ) ) {
149                         if( $dir != '.' && $dir != '..' ) {
150                                 $count++;
151                         }
152                 }
153                 closedir( $dir );
154                 return $count;
155         }
156
157         function showImage() {
158                 global $wgOut, $wgRequest;
159                 global $wgCaptchaDirectory;
160
161                 $wgOut->disable();
162
163                 $info = $this->retrieveCaptcha();
164                 if( $info ) {
165                         if( $info['viewed'] ) {
166                                 wfHttpError( 403, 'Access Forbidden', "Can't view captcha image a second time." );
167                                 return false;
168                         }
169
170                         $info['viewed'] = wfTimestamp();
171                         $this->storeCaptcha( $info );
172
173                         $salt = $info['salt'];
174                         $hash = $info['hash'];
175                         $file = $wgCaptchaDirectory . DIRECTORY_SEPARATOR . "image_{$salt}_{$hash}.png";
176
177                         if( file_exists( $file ) ) {
178                                 header( 'Content-type: image/png' );
179                                 readfile( $file );
180                                 return true;
181                         }
182                 }
183                 wfHttpError( 500, 'Internal Error', 'Requested bogus captcha image' );
184                 return false;
185         }
186
187         /**
188          * Show a message asking the user to enter a captcha on edit
189          * The result will be treated as wiki text
190          *
191          * @param $action Action being performed
192          * @return string
193          */
194         function getMessage( $action ) {
195                 $name = 'fancycaptcha-' . $action;
196                 $text = wfMsg( $name );
197                 # Obtain a more tailored message, if possible, otherwise, fall back to
198                 # the default for edits
199                 return wfEmptyMsg( $name, $text ) ? wfMsg( 'fancycaptcha-edit' ) : $text;
200         }
201
202 }
203
204 } # End invocation guard
205
206 ?>