Index: image_captcha.admin.inc
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/captcha/image_captcha/image_captcha.admin.inc,v
retrieving revision 1.29
diff -u -b -u -p -r1.29 image_captcha.admin.inc
--- image_captcha.admin.inc 11 Dec 2009 18:01:44 -0000 1.29
+++ image_captcha.admin.inc 13 Dec 2009 18:44:42 -0000
@@ -4,46 +4,25 @@
/**
* @file
* Functions for administration/settings interface.
+ *
*/
-/**
- * function to get a list of available fonts
- */
-function _image_captcha_available_fonts() {
- // List of folders to search through for TrueType fonts.
- $fontsdirectories = array(
- drupal_get_path('module', 'image_captcha') .'/fonts',
- file_directory_path(),
- 'sites/all/libraries/fonts',
- conf_path() .'/libraries/fonts',
- );
- // Search through the folders and build a list of available fonts.
- $available_fonts = array();
- foreach ($fontsdirectories as $fontsdirectory) {
- foreach (file_scan_directory($fontsdirectory, '\.[tT][tT][fF]$') as $filename => $font) {
- $available_fonts[$filename] = "{$font->basename} ($filename)";
- }
- }
-
- // Append the PHP built-in font at the end.
- $available_fonts['BUILTIN'] = t('Built-in font');
-
- return $available_fonts;
-}
/**
- * Configuration form for image_captcha
+ * Configuration form for image_captcha.
*/
function image_captcha_settings_form() {
+ // Add CSS for theming of admin form.
+ drupal_add_css(drupal_get_path('module', 'image_captcha') .'/image_captcha.css');
// Use javascript for some added usability on admin form.
drupal_add_js(drupal_get_path('module', 'image_captcha') .'/image_captcha.js');
$form = array();
// First some error checking.
- $image_captcha_setup_errno = _image_captcha_check_setup();
- if ($image_captcha_setup_errno & IMAGE_CAPTCHA_ERROR_NO_GDLIB_WITH_JPEG) {
+ $setup_status = _image_captcha_check_setup(FALSE);
+ if ($setup_status & IMAGE_CAPTCHA_ERROR_NO_GDLIB_WITH_JPEG) {
drupal_set_message(t(
'The Image CAPTCHA module can not generate images because your PHP setup does not support it (no GD library with JPEG support).',
array('!gdlib' => 'http://php.net/manual/en/book.image.php')
@@ -81,66 +60,8 @@ function image_captcha_settings_form() {
'#description' => t('The code length influences the size of the image. Note that larger values make the image generation more CPU intensive.'),
);
- // font related stuff
- $form['image_captcha_font_settings'] = array(
- '#type' => 'fieldset',
- '#title' => t('Font settings'),
- );
- $available_fonts = _image_captcha_available_fonts();
- list($default_font, $errno) = _image_captcha_get_font();
- $form['image_captcha_font_settings']['image_captcha_font'] = array(
- '#type' => 'select',
- '#title' => t('Font'),
- '#default_value' => $default_font,
- '#description' => t('Select the font to use for the text in the image CAPTCHA. Apart from the provided defaults, you can also use your own TrueType fonts (filename extension .ttf) by putting them in the Drupal "files" directory (directory %filesdir), %fonts_library_general or %fonts_library_specific.',
- array('%filesdir' => file_directory_path(),
- '%fonts_library_general' => 'sites/all/libraries/fonts',
- '%fonts_library_specific' => conf_path() .'/libraries/fonts',
- )
- ),
- '#options' => $available_fonts,
- );
-
- // add a prerender procedure for checking that a font should be set.
- $form['#pre_render'] = array('image_captcha_settings_form_pre_render');
- // font size
- if ($default_font != 'BUILTIN') {
- $form['image_captcha_font_settings']['image_captcha_font_size'] = array(
- '#type' => 'select',
- '#title' => t('Font size'),
- '#options' => array(
- 9 => '9 pt - ' . t('tiny'),
- 12 => '12 pt - ' . t('small'),
- 18 => '18 pt',
- 24 => '24 pt - ' . t('normal'),
- 30 => '30 pt',
- 36 => '36 pt - ' . t('large'),
- 48 => '48 pt',
- 64 => '64 pt - ' . t('extra large'),
- ),
- '#default_value' => (int) variable_get('image_captcha_font_size', 30),
- '#description' => t('The font size influences the size of the image. Note that larger values make the image generation more CPU intensive.'),
- );
- }
- // Disable some options when there is no TTF support
- if ($image_captcha_setup_errno & IMAGE_CAPTCHA_ERROR_NO_TTF_SUPPORT) {
- $form['image_captcha_font_settings']['image_captcha_font']['#disabled'] = TRUE;
- $form['image_captcha_font_settings']['image_captcha_font']['#default_value'] = 'BUILTIN';
- }
-
- // character spacing
- $form['image_captcha_font_settings']['image_captcha_character_spacing'] = array(
- '#type' => 'select',
- '#title' => t('Character spacing'),
- '#description' => t('Define the average spacing between characters. Note that larger values make the image generation more CPU intensive.'),
- '#default_value' => variable_get('image_captcha_character_spacing', '1.2'),
- '#options' => array(
- '0.75' => t('tight'),
- '1' => t('normal'),
- '1.2' => t('wide'),
- '1.5' => t('extra wide'),
- ),
- );
+ // Font related stuff.
+ $form['image_captcha_font_settings'] = _image_captcha_font_settings_form();
// Color and file format settings.
$form['image_captcha_color_settings'] = array(
@@ -248,30 +169,185 @@ function image_captcha_settings_form() {
),
'#default_value' => (int) variable_get('image_captcha_noise_level', 5),
);
+
+ // Add a validation handler.
$form['#validate'] = array('image_captcha_settings_form_validate');
- return system_settings_form($form);
+
+ // Make it a settings form.
+ $form = system_settings_form($form);
+ // But also do some custom submission handling.
+ $form['#submit'][] = 'image_captcha_settings_form_submit';
+
+ return $form;
}
+
/**
- * Pre render function for image_captcha_settings_form for providing
- * extra info about TTF fonts. We add these warnings in the pre-render
- * phase to avoid that these message whould show up twice after
- * submitting the form because it is build twice (first for submitting
- * the form and second for displaying the updated form).
+ * Form elements for the font specific setting.
+ *
+ * This is refactored to a separate function to avoid poluting the
+ * general form function image_captcha_settings_form with some
+ * specific logic.
+ *
+ * @return $form, the font settings specific form elements.
*/
-function image_captcha_settings_form_pre_render($form) {
- $errno = _image_captcha_check_setup();
+function _image_captcha_font_settings_form() {
+ // Put it all in a fieldset.
+ $form = array(
+ '#type' => 'fieldset',
+ '#title' => t('Font settings'),
+ );
+
+ // First check if there is TrueType support.
+ $setup_status = _image_captcha_check_setup(FALSE);
+ if ($setup_status & IMAGE_CAPTCHA_ERROR_NO_TTF_SUPPORT) {
+ // Show a warning that there is no TrueType support
+ $form['no_ttf_support'] = array(
+ '#type' => 'item',
+ '#title' => t('No TrueType support'),
+ '#value' => t('The Image CAPTCHA module can not use TrueType fonts because your PHP setup does not support it. You can only use a PHP built-in bitmap font of fixed size.'),
+ );
+
+ }
+ else {
+
+ // Build a list of all available fonts.
+ $available_fonts = array();
+
+ // List of folders to search through for TrueType fonts.
+ $fonts = _image_captcha_get_available_fonts_from_directories();
+ // Cache the list of previewable fonts. All the previews are done
+ // in separate requests, and we don't want to rescan the filesystem
+ // every time, so we cache the result.
+ variable_set('image_captcha_fonts_preview_map_cache', $fonts);
+ // Put these fonts with preview image in the list
+ foreach ($fonts as $token => $font) {
+ $img_src = check_url(url('admin/user/captcha/image_captcha/font_preview/'. $token));
+ $title = t('Font preview of @font (@file)', array('@font' => $font->name, '@file' => $font->filename));
+ $available_fonts[$font->filename] = '';
+ }
+
+ // We only show the name of fonts from the files directory
+ // and do not provide a preview for security reasons:
+ // files in files directory can be uploaded by normal or even anonymous
+ // users and should not be trusted.
+ $fonts = _image_captcha_get_available_fonts_from_directories(array(file_directory_path()));
+ foreach ($fonts as $font) {
+ $available_fonts[$font->name] = $font->name ." ($font->filename)";
+ }
+
+ // Append the PHP built-in font at the end.
+ $img_src = check_url(url('admin/user/captcha/image_captcha/font_preview/BUILTIN'));
+ $title = t('Preview of built-in font');
+ $available_fonts['BUILTIN'] = t('!font_preview (PHP built-in font)',
+ array('!font_preview' => '
')
+ );
- if ($errno & IMAGE_CAPTCHA_ERROR_NO_TTF_SUPPORT) {
- drupal_set_message(
- t('The Image CAPTCHA module can not use TrueType fonts because your PHP setup does not support it. You can only use a low quality built-in bitmap font.'),
- 'warning'
+ $default_fonts = _image_captcha_get_enabled_fonts();
+ $form['image_captcha_fonts'] = array(
+ '#type' => 'checkboxes',
+ '#title' => t('Fonts'),
+ '#default_value' => $default_fonts,
+ '#description' => t('Select the fonts to use for the text in the image CAPTCHA. Apart from the provided defaults, you can also use your own TrueType fonts (filename extension .ttf) by putting them in %fonts_library_general or %fonts_library_specific. You can also upload them to your site, e.g. with the "Upload" module, (into the "files" directory %filesdir), but those fonts will not get a preview because of security reasons.',
+ array(
+ '%fonts_library_general' => 'sites/all/libraries/fonts',
+ '%fonts_library_specific' => conf_path() .'/libraries/fonts',
+ '%filesdir' => file_directory_path(),
+ )
+ ),
+ '#options' => $available_fonts,
+ '#attributes' => array('class' => 'image_captcha_admin_fonts_selection'),
+ '#process' => array('expand_checkboxes', 'image_captcha_columnify_font_selection'),
);
+
+
+ // Font size.
+ $form['image_captcha_font_size'] = array(
+ '#type' => 'select',
+ '#title' => t('Font size'),
+ '#options' => array(
+ 9 => '9 pt - ' . t('tiny'),
+ 12 => '12 pt - ' . t('small'),
+ 18 => '18 pt',
+ 24 => '24 pt - ' . t('normal'),
+ 30 => '30 pt',
+ 36 => '36 pt - ' . t('large'),
+ 48 => '48 pt',
+ 64 => '64 pt - ' . t('extra large'),
+ ),
+ '#default_value' => (int) variable_get('image_captcha_font_size', 30),
+ '#description' => t('The font size influences the size of the image. Note that larger values make the image generation more CPU intensive.'),
+ );
+
}
+
+ // Character spacing (available for both the TrueType fonts and the builtin font.
+ $form['image_captcha_font_settings']['image_captcha_character_spacing'] = array(
+ '#type' => 'select',
+ '#title' => t('Character spacing'),
+ '#description' => t('Define the average spacing between characters. Note that larger values make the image generation more CPU intensive.'),
+ '#default_value' => variable_get('image_captcha_character_spacing', '1.2'),
+ '#options' => array(
+ '0.75' => t('tight'),
+ '1' => t('normal'),
+ '1.2' => t('wide'),
+ '1.5' => t('extra wide'),
+ ),
+ );
+
return $form;
}
/**
+ * Helper function to get fonts from the given directories.
+ *
+ * @param $directories (optional) an array of directories
+ * to recursively search through, if not given, the default
+ * directories will be used.
+ *
+ * @return an array of fonts file objects (with fields 'name',
+ * 'basename' and 'filename'), keyed on the md5 hash of the font
+ * path (to have an easy token that can be used in an url
+ * without en/decoding issues).
+ */
+function _image_captcha_get_available_fonts_from_directories($directories=NULL) {
+ // If no fonts directories are given: use the default.
+ if ($directories === NULL) {
+ $directories = array(
+ drupal_get_path('module', 'image_captcha') .'/fonts',
+ 'sites/all/libraries/fonts',
+ conf_path() .'/libraries/fonts',
+ );
+ }
+ // Collect the font information.
+ $fonts = array();
+ foreach ($directories as $directory) {
+ foreach (file_scan_directory($directory, '\.[tT][tT][fF]$') as $filename => $font) {
+ $fonts[md5($filename)] = $font;
+ }
+ }
+
+ return $fonts;
+}
+
+
+/**
+ * Additional processing (after Drupal core's expand_checkboxes)
+ * to put the font previews in a multi-column layout.
+ */
+function image_captcha_columnify_font_selection($element) {
+ // Get the fonts that get a preview.
+ $fonts = variable_get('image_captcha_fonts_preview_map_cache', array());
+ // And add some markup so we can put them in column layout.
+ foreach ($fonts as $font) {
+ $element[$font->filename]['#prefix'] = '