Changeset 19570 for plugins/sfCryptoCaptchaPlugin

Timestamp:

06/26/09 01:34:44 (4 years ago)

Author:

henearkrxern

Message:

Update to version 0.0.6

Files:

• plugins/sfCryptoCaptchaPlugin/trunk/README (modified) (4 diffs)
• plugins/sfCryptoCaptchaPlugin/trunk/config/app.yml (modified) (3 diffs)
• plugins/sfCryptoCaptchaPlugin/trunk/lib/helper/sfCryptoCaptchaHelper.php (modified) (1 diff)
• plugins/sfCryptoCaptchaPlugin/trunk/lib/sfCryptoCaptcha.class.php (modified) (8 diffs)
• plugins/sfCryptoCaptchaPlugin/trunk/package.xml (modified) (4 diffs)

plugins/sfCryptoCaptchaPlugin/trunk/README

@@ -119 +119 @@
-    $this->errorSchema = new sfValidatorErrorSchema($this->validatorSchema);
-
+## Configuration details
+
+Here are some useful configuration details
+
+The bg_img options can have many values:
+
+ 1. it can be a boolean (disable background image) 
+ 2. it can be a image name (path from the symfony root) 
+ 3. or it can be a file name (an image will be randomly chosen in the file)
+
+Here's how it looks in the configuration app.yml file
+
+    [yaml]
+    ---
+    bg_img:         false                                                  #1
+    bg_img:         '/plugins/sfCryptoCaptchaPlugin/media/bg/leaf_bg.png'  #2
+    bg_img:         '/plugins/sfCryptoCaptchaPlugin/media/bg'              #3
+
+When setting the letters for the captcha, be careful to exclude characters that look alike,
+for example: `o` and `0` or `B` and `8` (when there is noise and funky fonts, there symbols quickly look alike).
+
+``You want to make it difficult for robots but not for your users.``
+
+For configurations needing paths (backgrounds, refresh button, fonts)
+
+  * Be careful, the path to the refresh image must be from the __web__ root and not the symfony root dir.
+  * On the contrary, the path to the background images and the fonts is relative to the symfony root and the options need to start by a '/'
+
+The error messages are internationalized if the i18n is turned on for symfony.
+The images displayed will be in the `/plugins/sfCryptoCaptchaPlugin/media/error/%SF_CULTURE%/...`
+directory and the extension used will be the same as the configured `format`. If there is no i18n
+active, the three images will be taken from the `/plugins/sfCryptoCaptchaPlugin/media/error/` directory.
+
+The three needed images are:
+
+  * `unknown.xxx`   For unknown errors
+  * `too_many.xxx`  For too many requests per session (maximum 1000 requests per session)
+  * `refresh.xxx`   For too fast refreshes
+
+Each one of there images __must__ be present in each culture folder or in the main error folder.
+By default, a french and english version is provided. You can add as many languages and needed and customize the error images in any graphic editor(Gimp, Photoshop ...) as long as it is in jpeg, png or gif format.
-
-## Dependencies
@@ -134 +175 @@
-
- * The pear install seems to malfunction :(
- * The fonts directory is under the web directory so if you know the font name, you can download it (not very good)
- * The functionality to reuse a captcha (by saving it in clear in the user session) has been removed from the original library, it could be nice to code it back in and add an option to activate that feature - still, this is a less secure method than making a new captcha everytime.
- * The display of the error messages "refreshing too fast" is not localized and is cut if the catpcha is too small.
-
-## Troubleshooting
@@ -147 +186 @@
-      * you have executed the `plugin:publish-assets` command (under Windows, you may have to manually copy the sfCryptoCaptchaPlugin/web to the web/ directory)
-      * the fonts directory is properly configured (in the `app.yml` file)
-web/sfCryptoCaptchaPlugin/fonts direcot
+SF_ROOT/plugins/sfCryptoCaptchaPlugin/fonts directo
-      * all the permissions of the plugin are correct
-      * if there is still no image, check that the image is correctly destroyed in the sfCryptoCaptcha class with `imagedestroy($this->image);` line 220
@@ -154 +193 @@
-    * the final paths are correct (/captcha for the image and /sfCryptoCaptchaPlugin/images/refresh.png for the refresh image)
-    * there is no conflict in the url (/captcha not used by some other plugin or module of the same name)
-
-
+
-
-If your captcha does not display correctly:
-
-
+ (overflow)
-  * Play with some options and see what you come up with, hopefully, you should find where the problem is coming from.
+  * You have enabled the background image but your background is black: check that the path is correct and that it starts with a "/".
+  * If there is an error with the font (usually there will be no image - but in case you run out of problem-ideas, check the path to the font files and that it starts with a "/".
-
-## Copyright

plugins/sfCryptoCaptchaPlugin/trunk/config/app.yml

@@ -10 +10 @@
-    bg_blue:                          255                 #quantity of blue color (0->255)
-    bg_transparent:                   false               #transparent background - only works for PNG images
-image or file (randomly choses an image in the file) [can be false, image or file path
+boolean or image or file (randomly choses an image in the file) [path from sf root
-    bg_border:                        true                #add a border or not
-  #Paths
-    img_dir:                          '/sfCryptoCaptchaPlugin/images' #directory of the images in the web directory
-  #Characters
-    char_red:                         0                   # quantity of red color  (0->255)
@@ -27 +25 @@
-    char_vertical_offset:             true                # add a random vertical offset to letters
-  #Fonts
- 
-sfCryptoCaptchaPlugin/fonts/' #directory containing the fonts in the web
+
+plugins/sfCryptoCaptchaPlugin/media/fonts/' # directory containing the fonts in the symfony root
-    error_font:                       'arial.ttf'         # font used for error messages
-  #Authorized characters
@@ -58 +56 @@
-    noise_color:                      3                   # noise color to use (1=character color, 2= background color, 3= random color)
-    noise_on_top:                     false               # if noise is the top layer (above the caracters)
+  #Refresh
+    refresh_image:                    '/sfCryptoCaptchaPlugin/images/reload_original.png'  # use an other captcha reload image - must be in the web directory
+    error_images_dir:                 '/plugins/sfCryptoCaptchaPlugin/media/error/' # the path to the directory where the error images are - from the symfony root dir
+    
+    

plugins/sfCryptoCaptchaPlugin/trunk/lib/helper/sfCryptoCaptchaHelper.php

@@ -9 +9 @@
-function captcha_reload_button()
-{
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  return $ret;
-}

plugins/sfCryptoCaptchaPlugin/trunk/lib/sfCryptoCaptcha.class.php

@@ -59 +59 @@
-          if(!$this->testQueries()) { 
-            $this->config['constructor_error_reason'] = 'Error - too many queries';
+            $this->config['constructor_error_message'] = 'too_many';
-          }
-          elseif(!$this->testLastRequest())
-          {
-            $this->config['constructor_error_reason'] = 'Error - refreshing too fast';
+            $this->config['constructor_error_message'] = 'refresh';
-          }
-          else
-          {
-            $this->config['constructor_error_reason'] = 'Error - unknown reason';
+            $this->config['constructor_error_message'] = 'unknown';
-          }
-          return false;
@@ -149 +152 @@
-    if($this->config['constructor_test']===false) {
-      //generate error image
-generateErrorImage($this->config['constructor_error_reason
+sendErrorImage($this->config['constructor_error_message
-      {
-        if (sfConfig::get('sf_logging_enabled'))
-        {
-
+
+
+
+
+
+
+
+
+
+
+
+
-          $message .= ' - Critical Image Error - ';
-          $message .= 'The ERROR message(['.$this->config['constructor_error_reason'].']) image encoutered an error when sending to user.';
-bi
+ib
-          sfContext::getInstance()->getLogger()->crit($message);
-        } 
@@ -702 +716 @@
-    if($bg_type == '1')
-    {
-onfig
+aptcha
-    }
-    elseif($bg_type == '2')
-    {
-onfig
+aptcha
-    }
-    elseif($bg_type == '3')
-    {
-onfig
+aptcha
-    }
-    else
@@ -1117 +1131 @@
-  }
-  
+  private function sendErrorImage($error_message)
+  {
+    // 1) read the image depending on the sf_user culture
+    // 2) send it to the browser
+    
+    //get culture
+    $culture = $this->sf_user->getCulture();
+       
+    //set image path
+    if($this->config['use_i18n'] == true)
+    {
+      $image_path = $this->config['error_images_dir'].DIRECTORY_SEPARATOR.$culture.DIRECTORY_SEPARATOR.$error_message.'.'.$this->config['format'];
+    }
+    else
+    {
+      $image_path = $this->config['error_images_dir'].DIRECTORY_SEPARATOR.$error_message.'.'.$this->config['format'];
+    }
+    //send the finished image in JPG, GIF or PNG format
+    if(strtoupper($this->config['format']) == 'JPG' || strtoupper($this->config['format']) == 'JPEG')
+    {
+      header("Content-type: image/jpeg");
+      readfile($image_path); 
+      exit;
+    }
+    
+    if(strtoupper($this->config['format']) == 'GIF')
+    {
+      header("Content-type: image/gif");
+      readfile($image_path);
+      exit;
+    }
+    
+    if(strtoupper($this->config['format']) == 'PNG')
+    {
+      header("Content-type: image/png");
+      readfile($image_path);
+      exit;
+    }
+    
+    return true;
+  }
+  
+  
-  /**
-   * Captcha configuration getter from the app.yml
@@ -1127 +1184 @@
-  private function getConfiguration()
-  {
+    $root_dir = sfConfig::get('sf_root_dir');
-    $web_dir = sfConfig::get('sf_web_dir');
-    //Setting image size
@@ -1137 +1195 @@
-    $this->config['bg_blue'] = sfConfig::get('app_sf_crypto_captcha_bg_blue', 255); // quantity of blue (0->255)
-    $this->config['bg_transparent'] = sfConfig::get('app_sf_crypto_captcha_bg_transparent', false); // transparent backround, only for PNG
-
-
-
+
+
-    
-    $this->config['bg_border'] = sfConfig::get('app_sf_crypto_captcha_bg_border', true); //border or not
-    
-    $this->config['img_dir'] = sfConfig::get('app_sf_crypto_captcha_img_dir', '/sfCryptoCaptchaPlugin/images/'); // directory of images
-    $this->config['img_dir'] = $web_dir.$this->config['img_dir'];
-    
-    //Setting characters
@@ -1161 +1215 @@
-    //Setting fonts
-    $this->config['char_fonts'] = sfConfig::get('app_sf_crypto_captcha_char_fonts', array('luggerbu.ttf')); // the fonts used randomly to generate the characters
-sfCryptoCaptchaPlugin
-web
+plugins/sfCryptoCaptchaPlugin/media
+root
-    $this->config['error_font'] = sfConfig::get('app_sf_crypto_captcha_error_font', 'arial.ttf');
-    
@@ -1200 +1254 @@
-    $this->config['noise_on_top'] = sfConfig::get('app_sf_crypto_captcha_noise_on_top', false); // the noise is on the top layer
-    
+    //error config
+    $this->config['use_i18n'] = sfConfig::get('sf_i18n', false);
+    $this->config['error_images_dir'] = sfConfig::get('app_sf_crypto_captcha_error_images_dir', '/plugins/sfCryptoCaptchaPlugin/media/error/'); //the dir where the images are - from symfony root dir
+    $this->config['error_images_dir'] = $root_dir.$this->config['error_images_dir'];
+    
-    return true;
-  }

plugins/sfCryptoCaptchaPlugin/trunk/package.xml

@@ -11 +11 @@
-  <active>yes</active>
- </lead>
-5
-20:26:27
+6
+01:29:36
- <version>
-5
-5
+6
+6
- </version>
- <stability>
@@ -50 +50 @@
-    </dir>
-   </dir>
-web
-
+media
+ 
-     <file role="data" name="Alanden_.ttf" />
-     <file role="data" name="arial.ttf" />
@@ -61 +61 @@
-     <file role="data" name="WAVY.ttf" />
-    </dir>
+    <dir name="bg">
+     <file role="data" name="beige_marble.jpg" />
+     <file role="data" name="leaf_bg.jpg" />
+     <file role="data" name="metal_bg.jpg" />
+     <file role="data" name="styrofoam.jpg" />
+    </dir>
+    <dir name="error">
+     <file role="data" name="refresh.png" />
+     <file role="data" name="too_many.png" />
+     <file role="data" name="unknown.png" />
+     <dir name="en">
+      <file role="data" name="refresh.png" />
+      <file role="data" name="too_many.png" />
+      <file role="data" name="unknown.png" />
+     </dir>
+     <dir name="fr">
+      <file role="data" name="refresh.png" />
+      <file role="data" name="too_many.png" />
+      <file role="data" name="unknown.png" />
+     </dir>
+    </dir>
+   </dir>
+   <dir name="web">
-    <dir name="images">
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    </dir>
-   </dir>
@@ -90 +126 @@
-  <release>
-   <version>
+    <release>0.0.6</release>
+    <api>0.0.6</api>
+   </version>
+   <stability>
+    <release>beta</release>
+    <api>beta</api>
+   </stability>
+   <license uri="http://www.symfony-project.com/license">MIT license</license>
+   <license>MIT</license>
+   <date>2009-06-25</date>
+   <notes>
+     * henearkrxern: reorganisation of the plugin (media directory, fonts, backgrounds)
+     * henearkrxern: fonts dir specified from the symfony root and not the web dir and moved
+     * henearkrxern: added support for url suffixes (.php, .html, ...)
+     * henearkrxern: added free and/or GPL icons for the refresh button (check out the plugin web/images folder)
+     * henearkrxern: added some organic backgrounds
+     * henearkrxern: errors are now pre-generated graphics that can be internationalized
+   </notes>
+  </release>
+  <release>
+   <version>
-    <release>0.0.5</release>
-    <api>0.0.5</api>