diff --git modules/image/image.admin.css modules/image/image.admin.css new file mode 100644 index 0000000..b009540 --- /dev/null +++ modules/image/image.admin.css @@ -0,0 +1,59 @@ +/* $Id$ */ + +/** + * Image style configuration pages + */ +div.image-style-new, +div.image-style-new div { + display: inline; +} +div.image-style-preview { +} +div.image-style-preview div.preview-image-wrapper { + float: left; + padding-bottom: 2em; + text-align: center; + top: 50%; + width: 48%; +} +div.image-style-preview div.preview-image { + margin: auto; + position: relative; +} +div.image-style-preview div.preview-image div.width { + border: 1px solid #666; + border-top: none; + height: 2px; + left: -1px; + bottom: -6px; + position: absolute; +} +div.image-style-preview div.preview-image div.width span { + position: relative; + top: 4px; +} +div.image-style-preview div.preview-image div.height { + border: 1px solid #666; + border-left: none; + position: absolute; + right: -6px; + top: -1px; + width: 2px; +} +div.image-style-preview div.preview-image div.height span { + height: 2em; + left: 10px; + margin-top: -1em; + position: absolute; + top: 50%; +} +table.image-anchor { + width: auto; +} +table.image-anchor tr.even, +table.image-anchor tr.odd { + background: none; +} +table.image-anchor td { + border: 1px solid #CCC; +} diff --git modules/image/image.admin.inc modules/image/image.admin.inc new file mode 100644 index 0000000..2e008d7 --- /dev/null +++ modules/image/image.admin.inc @@ -0,0 +1,803 @@ + 'image_style_list', + '#styles' => image_styles(), + '#attached_css' => array(drupal_get_path('module', 'image') . '/image.admin.css' => array('preprocess' => FALSE)), + ); + + return $page; + +} + +/** + * Menu title callback; Title for editing, deleting, and flushing styles. + */ +function image_style_title($string, $style) { + return t($string, array('!name' => $style['name'])); +} + +/** + * Form builder; Edit a style name and effect order. + * + * @param $form_state + * An associative array containing the current state of the form. + * @param $style + * An image style array. + * @ingroup forms + * @see image_style_form_submit() + * @see image_style_name_validate() + */ +function image_style_form(&$form_state, $style) { + $form_state['image_style'] = $style; + $form = array( + '#tree' => TRUE, + '#attached_css' => array(drupal_get_path('module', 'image') . '/image.admin.css' => array('preprocess' => FALSE)), + ); + + $form['name'] = array( + '#type' => 'textfield', + '#size' => '64', + '#title' => t('Image style name'), + '#default_value' => $style['name'], + '#description' => t('The name is used in URLs for generated images. Use only lowercase alphanumeric characters, underscores (_), and hyphens (-).'), + '#element_validate' => array('image_style_name_validate'), + ); + + $form['effects'] = array( + '#theme' => 'image_style_effects', + ); + + foreach ($style['effects'] as $ieid => $effect) { + $form['effects'][$ieid]['#weight'] = isset($form_state['input']['effects']) ? $form_state['input']['effects'][$ieid]['weight'] : NULL; + $form['effects'][$ieid]['name'] = array( + '#markup' => $effect['name'], + ); + $form['effects'][$ieid]['summary'] = array( + '#markup' => isset($effect['summary']) ? theme($effect['summary'], $effect['data']) : '', + ); + $form['effects'][$ieid]['weight'] = array( + '#type' => 'weight', + '#default_value' => $effect['weight'], + ); + $form['effects'][$ieid]['configure'] = array( + '#markup' => isset($effect['form']) ? l(t('Configure'), 'admin/settings/image-styles/edit/'. $style['name'] .'/effects/'. $effect['ieid'] ) : '', + ); + $form['effects'][$ieid]['remove'] = array( + '#markup' => l(t('Delete'), 'admin/settings/image-styles/edit/'. $style['name'] .'/effects/'. $effect['ieid'] .'/delete'), + ); + } + + $new_effect_options = array('' => t('Select a new effect')); + foreach (image_effect_definitions() as $effect => $definition) { + $new_effect_options[$effect] = check_plain($definition['name']); + } + $form['effects']['new'] = array( + '#tree' => FALSE, + '#weight' => isset($form_state['input']['weight']) ? $form_state['input']['weight'] : NULL, + ); + $form['effects']['new']['new'] = array( + '#type' => 'select', + '#options' => $new_effect_options, + ); + $form['effects']['new']['weight'] = array( + '#type' => 'weight', + '#default_value' => count($form['effects']) - 1, + ); + $form['effects']['new']['add'] = array( + '#type' => 'submit', + '#value' => t('Add'), + '#validate' => array('image_style_form_add_validate'), + '#submit' => array('image_style_form_submit', 'image_style_form_add_submit'), + ); + + $form['preview'] = array( + '#type' => 'item', + '#title' => t('Preview'), + '#markup' => theme('image_style_preview', $style), + '#description' => t('Preview images are scaled. Actual image sizes may be viewed by clicking on the preview.'), + ); + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Update style'), + ); + + return $form; +} + +/** + * Validate handler for adding a new effect to a style. + */ +function image_style_form_add_validate($form, &$form_state) { + if (!$form_state['values']['new']) { + form_error($form['effects']['new']['new'], t('Select an effect to add.')); + $form_state['rebuild'] = TRUE; + } +} + +/** + * Submit handler for adding a new effect to a style. + */ +function image_style_form_add_submit($form, &$form_state) { + $style = $form_state['image_style']; + // Check if this field has any configuration options. + $effect = image_effect_definition_load($form_state['values']['new']); + + // Load the configuration form for this option. + if (isset($effect['form'])) { + $path = 'admin/settings/image-styles/edit/' . $form_state['image_style']['name'] . '/add/' . $form_state['values']['new']; + $form_state['redirect'] = array($path, array('weight' => $form_state['values']['weight'])); + } + // If there's no form, immediately add the effect. + else { + $effect['isid'] = $style['isid']; + $effect['weight'] = $form_state['values']['weight']; + image_effect_save($effect); + drupal_set_message(t('The effect was successfully applied.')); + } +} + +/** + * Submit handler for saving an image style. + */ +function image_style_form_submit($form, &$form_state) { + // Update the style name if it has changed. + $style = $form_state['image_style']; + if ($style['name'] != $form_state['values']['name']) { + $style['name'] = $form_state['values']['name']; + } + + // Update effect weights. + if (!empty($form_state['values']['effects'])) { + foreach ($form_state['values']['effects'] as $ieid => $effect_data) { + if (isset($style['effects'][$ieid])) { + $effect = $style['effects'][$ieid]; + $effect['weight'] = $effect_data['weight']; + image_effect_save($effect); + } + } + } + + image_style_save($style); + if ($form_state['values']['op'] == t('Update style')) { + drupal_set_message('Changes to the style have been saved.'); + } + $form_state['redirect'] = 'admin/settings/image-styles/edit/' . $style['name']; +} + +/** + * Form builder; Form for adding a new style. + * + * @ingroup forms + * @see image_style_add_form_submit() + * @see image_style_name_validate() + */ +function image_style_add_form(&$form_state) { + $form = array(); + + $form['name'] = array( + '#type' => 'textfield', + '#size' => '64', + '#title' => t('Style name'), + '#default_value' => '', + '#description' => t('The name is used in URLs for generated images. Use only lowercase alphanumeric characters, underscores (_), and hyphens (-).'), + '#element_validate' => array('image_style_name_validate'), + ); + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Create new style'), + ); + + return $form; +} + +/** + * Submit handler for adding a new style. + */ +function image_style_add_form_submit($form, &$form_state) { + $style = array('name' => $form_state['values']['name']); + $style = image_style_save($style); + drupal_set_message(t('Style %name was created.', array('%name' => $style['name']))); + $form_state['redirect'] = 'admin/settings/image-styles/edit/'. $style['name']; +} + +/** + * Element validate function to ensure unique, URL safe style names. + */ +function image_style_name_validate($element, $form_state) { + // Check for duplicates. + $styles = image_styles(); + if (isset($styles[$element['#value']]) && (!isset($form_state['image_style']['isid']) || $styles[$element['#value']]['isid'] != $form_state['image_style']['isid'])) { + form_set_error($element['#name'], t('The image style name %name is already in use.', array('%name' => $element['#value']))); + } + + // Check for illegal characters in style names. + if (preg_match('/[^0-9a-z_\-]/', $element['#value'])) { + form_set_error($element['#name'], t('Please only use lowercase alphanumeric characters, underscores (_), and hyphens (-) for style names.')); + } +} + +/** + * Form builder; Form for deleting an image style. + * + * @param $style + * An image style array. + * + * @ingroup forms + * @see image_style_delete_form_submit() + */ +function image_style_delete_form($form_state, $style) { + $form_state['image_style'] = $style; + + $form = array(); + + $replacement_styles = array_diff_key(image_style_options(), array($style['name'] => '')); + $replacement_styles[''] = t('No replacement, just delete'); + $form['replacement'] = array( + '#title' => t('Replacement style'), + '#type' => 'select', + '#options' => $replacement_styles, + ); + + return confirm_form( + $form, + t('Optionally select a style before deleting %style', array('%style' => $style['name'])), + 'admin/settings/image-styles', + t('If this style is in use on the site, you may select another style to replace it. All images that have been generated for this style will be permanently deleted.'), + t('Delete'), t('Cancel') + ); +} + +/** + * Submit handler to delete an image style. + */ +function image_style_delete_form_submit($form, &$form_state) { + $style = $form_state['image_style']; + + image_style_delete($style, $form_state['values']['replacement']); + cache_clear_all(); + drupal_set_message(t('Style %name was deleted.', array('%name' => $style['name']))); + $form_state['redirect'] = 'admin/settings/image-styles'; +} + +/** + * Form builder; Confirm flushing a style's cached images. + * + * @param $style + * An image style array. + * @ingroup forms + * @see image_style_flush_form_submit() + */ +function image_style_flush_form(&$form_state, $style) { + $form_state['image_style'] = $style; + + $form = array(); + return confirm_form( + $form, + t('Are you sure you want to flush the %style style?', array('%style' => $style['name'])), + 'admin/settings/image-styles', + t('This will delete all the generated images for the %style style. Regenerating the images may cause a temporary increase in your server\'s load.', array('%style' => $style['name'])), + t('Flush'), t('Cancel') + ); +} + +/** + * Submit handler for flushing an image style's cached files. + */ +function image_style_flush_form_submit($form, &$form_state) { + $style = $form_state['image_style']; + image_style_flush($style); + drupal_set_message(t('Style %name was flushed.', array('%name' => $style['name']))); + $form_state['redirect'] = 'admin/settings/image-styles'; +} + +/** + * Menu title callback; Title for editing, deleting, and adding image effects. + * + * @param $effect + * An image effect array. + */ +function image_effect_title($string, $effect) { + return t($string, array('!name' => $effect['name'])); +} + +/** + * Form builder; Form for adding and editing image effects. + * + * This form is used universally for editing all effects. Each effect adds its + * own custom section to the form by calling the form function specified in + * hook_image_effects(). + * + * @param $form_state + * An associative array containing the current state of the form. + * @param $style + * An image style array. + * @param $effect + * An image effect array. + * + * @ingroup forms + * @see hook_image_effects() + * @see image_effects() + * @see image_resize_form() + * @see image_scale_form() + * @see image_rotate_form() + * @see image_crop_form() + * @see image_effect_form_submit() + */ +function image_effect_form(&$form_state, $style, $effect) { + $form_state['image_style'] = $style; + $form_state['image_effect'] = $effect; + + // If there's no configuration for this effect redirect to the effect list. + if (!isset($effect['form'])) { + drupal_goto('admin/settings/image-styles/edit/' . $style['name']); + } + + $form = array( + '#tree' => TRUE, + '#attached_css' => array(drupal_get_path('module', 'image') . '/image.admin.css' => array('preprocess' => FALSE)), + ); + if (drupal_function_exists($effect['form'])) { + $form['data'] = call_user_func($effect['form'], $effect['data']); + } + + // Check if the URL provides a weight, then the effect, otherwise use default. + $form['weight'] = array( + '#type' => 'hidden', + '#value' => isset($_GET['weight']) ? intval($_GET['weight']) : (isset($effect['weight']) ? $effect['weight'] : count($style['effects'])), + ); + + $form['buttons'] = array('#tree' => FALSE); + $form['buttons']['submit'] = array( + '#type' => 'submit', + '#value' => isset($effect['ieid']) ? t('Update effect') : t('Add effect'), + ); + $form['buttons']['cancel'] = array( + '#markup' => l(t('Cancel'), 'admin/settings/image-styles/edit/' . $style['name']), + ); + + return $form; +} + +/** + * Submit handler for updating an image effect. + */ +function image_effect_form_submit($form, &$form_state) { + $style = $form_state['image_style']; + $effect = array_merge($form_state['image_effect'], $form_state['values']); + $effect['isid'] = $style['isid']; + image_effect_save($effect); + drupal_set_message(t('The effect was successfully applied.')); + $form_state['redirect'] = 'admin/settings/image-styles/edit/'. $style['name']; +} + +/** + * Form builder; Form for deleting an image effect. + * + * @param $style + * Name of the style to remove the effect from. + * @param $effect + * Name of the effect to remove. + * @ingroup forms + * @see image_effect_delete_form_submit() + */ +function image_effect_delete_form(&$form_state, $style, $effect) { + $form_state['image_style'] = $style; + $form_state['image_effect'] = $effect; + + $form = array(); + $question = t('Are you sure you want to delete the @effect effect from the %style style?', array('%style' => $style['name'], '@effect' => $effect['name'])); + $description = t('Deleting this effect will regenerate all images for the %style style.', array('%style' => $style['name'])); + return confirm_form($form, $question, 'admin/settings/image-styles/edit/' . $style['name'], $description, t('Delete')); +} + +/** + * Submit handler to delete an image effect. + */ +function image_effect_delete_form_submit($form, &$form_state) { + $style = $form_state['image_style']; + $effect = $form_state['image_effect']; + + image_effect_delete($effect); + drupal_set_message(t('The image effect %name has been deleted.', array('%name' => $effect['name']))); + $form_state['redirect'] = 'admin/settings/image-styles/edit/'. $style['name']; +} + +/** + * Element validate handler to ensure an integer pixel value. + * + * The property #allow_negative = TRUE may be set to allow negative integers. + */ +function image_effect_integer_validate($element, &$form_state) { + $value = empty($element['#allow_negative']) ? $element['#value'] : preg_replace('/^-/', '', $element['#value']); + if ($element['#value'] != '' && !ctype_digit($value)) { + if (empty($element['#allow_negative'])) { + form_error($element, t('!name must be an integer.', array('!name' => $element['#title']))); + } + else { + form_error($element, t('!name must be a positive integer.', array('!name' => $element['#title']))); + } + } +} + +/** + * Element validate handler to ensure a hexadecimal color value. + */ +function image_effect_color_validate($element, &$form_state) { + if ($element['#value'] != '') { + $hex_value = preg_replace('/^#/', '', $element['#value']); + if (!preg_match('/^#/', $element['#value']) || strlen($hex_value) != 6 && strlen($hex_value) != 3 || !ctype_xdigit($hex_value)) { + form_error($element, t('!name must be a hexadecimal color value.', array('!name' => $element['#title']))); + } + } +} + +/** + * Form structure for the image resize form. + * + * Note that this is not a complete form, it only contains the portion of the + * form for configuring the resize options. Therefor it does not not need to + * include metadata about the effect, nor a submit button. + * + * @param $data + * The current configuration for this resize effect. + */ +function image_resize_form($data) { + $form['width'] = array( + '#type' => 'textfield', + '#title' => t('Width'), + '#default_value' => isset($data['width']) ? $data['width'] : '', + '#field_suffix' => ' ' . t('pixels'), + '#required' => TRUE, + '#size' => 10, + '#element_validate' => array('image_effect_integer_validate'), + '#allow_negative' => FALSE, + ); + $form['height'] = array( + '#type' => 'textfield', + '#title' => t('Height'), + '#default_value' => isset($data['height']) ? $data['height'] : '', + '#field_suffix' => ' ' . t('pixels'), + '#required' => TRUE, + '#size' => 10, + '#element_validate' => array('image_effect_integer_validate'), + '#allow_negative' => FALSE, + ); + return $form; +} + +/** + * Form structure for the image scale form. + * + * Note that this is not a complete form, it only contains the portion of the + * form for configuring the scale options. Therefor it does not not need to + * include metadata about the effect, nor a submit button. + * + * @param $data + * The current configuration for this scale effect. + */ +function image_scale_form($data) { + $form = image_resize_form($data); + $form['width']['#required'] = FALSE; + $form['height']['#required'] = FALSE; + $form['upscale'] = array( + '#type' => 'checkbox', + '#default_value' => (isset($data['upscale'])) ? $data['upscale'] : 0, + '#title' => t('Allow Upscaling'), + '#description' => t('Let scale make images larger than their original size'), + ); + return $form; +} + +/** + * Form structure for the image crop form. + * + * Note that this is not a complete form, it only contains the portion of the + * form for configuring the crop options. Therefor it does not not need to + * include metadata about the effect, nor a submit button. + * + * @param $data + * The current configuration for this crop effect. + */ +function image_crop_form($data) { + $data += array( + 'width' => '', + 'height' => '', + 'anchor' => 'center-center', + ); + + $form = image_resize_form($data); + $form['anchor'] = array( + '#type' => 'radios', + '#title' => t('Anchor'), + '#options' => array( + 'left-top' => t('Top') . ' ' . t('Left'), + 'center-top' => t('Top') . ' ' . t('Center'), + 'right-top' => t('Top') . ' ' . t('Right'), + 'left-center' => t('Center') . ' ' . t('Left'), + 'center-center' => t('Center'), + 'right-center' => t('Center') . ' ' . t('Right'), + 'left-bottom' => t('Bottom') . ' ' . t('Left'), + 'center-bottom' => t('Bottom') . ' ' . t('Center'), + 'right-bottom' => t('Bottom') . ' ' . t('Right'), + ), + '#theme' => 'image_anchor', + '#default_value' => $data['anchor'], + '#description' => t('The part of the image that will be retained during the crop.'), + ); + + return $form; +} + +/** + * Form structure for the image rotate form. + * + * Note that this is not a complete form, it only contains the portion of the + * form for configuring the rotate options. Therefor it does not not need to + * include metadata about the effect, nor a submit button. + * + * @param $data + * The current configuration for this rotate effect. + */ +function image_rotate_form($data) { + $form['degrees'] = array( + '#type' => 'textfield', + '#default_value' => (isset($data['degrees'])) ? $data['degrees'] : 0, + '#title' => t('Rotation angle'), + '#description' => t('The number of degrees the image should be rotated. Positive numbers are clockwise, negative are counter-clockwise.'), + '#field_suffix' => '°', + '#required' => TRUE, + '#size' => 6, + '#maxlength' => 4, + '#element_validate' => array('image_effect_integer_validate'), + '#allow_negative' => TRUE, + ); + $form['bgcolor'] = array( + '#type' => 'textfield', + '#default_value' => (isset($data['bgcolor'])) ? $data['bgcolor'] : '#FFFFFF', + '#title' => t('Background color'), + '#description' => t('The background color to use for exposed areas of the image. Use web-style hex colors (#FFFFFF for white, #000000 for black). Leave blank for transparency on image types that support it.'), + '#size' => 7, + '#maxlength' => 7, + '#element_validate' => array('image_effect_color_validate'), + ); + $form['random'] = array( + '#type' => 'checkbox', + '#default_value' => (isset($data['random'])) ? $data['random'] : 0, + '#title' => t('Randomize'), + '#description' => t('Randomize the rotation angle for each image. The angle specified above is used as a maximum.'), + ); + return $form; +} + +/** + * Display the page containing the list of image styles. + * + * @param $styles + * An array of all the image styles returned by image_get_styles(). + * @see image_get_styles() + * @ingroup themeable + */ +function theme_image_style_list($styles) { + $header = array(t('Style name'), array('data' => t('Operations'), 'colspan' => 3)); + $rows = array(); + foreach ($styles as $style) { + $row = array(); + $row[] = l($style['name'], 'admin/settings/image-styles/edit/' . $style['name']); + $link_attributes = array( + 'attributes' => array( + 'class' => 'image-style-link', + ), + ); + $row[] = l(t('Edit'), 'admin/settings/image-styles/edit/' . $style['name'], $link_attributes); + $row[] = l(t('Flush'), 'admin/settings/image-styles/flush/' . $style['name'], $link_attributes); + $row[] = l(t('Delete'), 'admin/settings/image-styles/delete/' . $style['name'], $link_attributes); + $rows[] = $row; + } + + if (empty($rows)) { + $rows[] = array(array( + 'colspan' => 4, + 'data' => t('There are currently no styles. Add a new one.', array('!url' => url('admin/settings/image-styles/add'))), + )); + } + + return theme('table', $header, $rows); +} + +/** + * Theme callback for listing the effects within a specific image style. + * + * @param $form + * An associative array containing the structure of the effects group. + * @ingroup themeable + */ +function theme_image_style_effects($form) { + $rows = array(); + + foreach (element_children($form) as $key) { + if (is_numeric($key)) { + $form[$key]['weight']['#attributes']['class'] = 'image-effect-order-weight'; + $summary = drupal_render($form[$key]['summary']); + $row = array(); + $row[] = drupal_render($form[$key]['name']) . (empty($summary) ? '' : ' ' . $summary); + $row[] = drupal_render($form[$key]['weight']); + $row[] = drupal_render($form[$key]['configure']); + $row[] = drupal_render($form[$key]['remove']); + } + else { + // Add the row for adding a new effect. + $form['new']['weight']['#attributes']['class'] = 'image-effect-order-weight'; + $row = array(); + $row[] = '