<?php

/**

 * @file

 * Exposes global functionality for creating image styles.

 */

/**

 * Image style constant for user presets in the database.

 */

define('IMAGE_STORAGE_NORMAL', 1);

/**

 * Image style constant for user presets that override module-defined presets.

 */

define('IMAGE_STORAGE_OVERRIDE', 2);

/**

 * Image style constant for module-defined presets in code.

 */

define('IMAGE_STORAGE_DEFAULT', 4);

/**

 * Image style constant to represent an editable preset.

 */

define('IMAGE_STORAGE_EDITABLE', IMAGE_STORAGE_NORMAL | IMAGE_STORAGE_OVERRIDE);

/**

 * Image style constant to represent any module-based preset.

 */

define('IMAGE_STORAGE_MODULE', IMAGE_STORAGE_OVERRIDE | IMAGE_STORAGE_DEFAULT);

/**

 * The name of the query parameter for image derivative tokens.

 */

define('IMAGE_DERIVATIVE_TOKEN', 'itok');

// Load all Field module hooks for Image.

require_once DRUPAL_ROOT . '/modules/image/image.field.inc';

/**

 * Implements hook_help().

 */

function image_help($path, $arg) {

  switch ($path) {

    case 'admin/help#image':

      $output = '';

      $output .= '<h3>' . t('About') . '</h3>';

      $output .= '<p>' . t('The Image module allows you to manipulate images on your website. It exposes a setting for using the <em>Image toolkit</em>, allows you to configure <em>Image styles</em> that can be used for resizing or adjusting images on display, and provides an <em>Image</em> field for attaching images to content. For more information, see the online handbook entry for <a href="@image">Image module</a>.', array('@image' => 'http://drupal.org/documentation/modules/image')) . '</p>';

      $output .= '<h3>' . t('Uses') . '</h3>';

      $output .= '<dl>';

      $output .= '<dt>' . t('Manipulating images') . '</dt>';

      $output .= '<dd>' . t('With the Image module you can scale, crop, resize, rotate and desaturate images without affecting the original image using <a href="@image">image styles</a>. When you change an image style, the module automatically refreshes all created images. Every image style must have a name, which will be used in the URL of the generated images. There are two common approaches to naming image styles (which you use will depend on how the image style is being applied):',array('@image' => url('admin/config/media/image-styles')));

      $output .= '<ul><li>' . t('Based on where it will be used: eg. <em>profile-picture</em>') . '</li>';

      $output .= '<li>' . t('Describing its appearance: eg. <em>square-85x85</em>') . '</li></ul>';

      $output .=  t('After you create an image style, you can add effects: crop, scale, resize, rotate, and desaturate (other contributed modules provide additional effects). For example, by combining effects as crop, scale, and desaturate, you can create square, grayscale thumbnails.') . '<dd>';

      $output .= '<dt>' . t('Attaching images to content as fields') . '</dt>';

      $output .= '<dd>' . t("Image module also allows you to attach images to content as fields. To add an image field to a <a href='@content-type'>content type</a>, go to the content type's <em>manage fields</em> page, and add a new field of type <em>Image</em>. Attaching images to content this way allows image styles to be applied and maintained, and also allows you more flexibility when theming.", array('@content-type' => url('admin/structure/types'))) . '</dd>';

      $output .= '</dl>';

      return $output;

    case 'admin/config/media/image-styles':

      return '<p>' . t('Image styles commonly provide thumbnail sizes by scaling and cropping images, but can also add various effects before an image is displayed. When an image is displayed with a style, a new file is created and the original image is left unchanged.') . '</p>';

    case 'admin/config/media/image-styles/edit/%/add/%':

      $effect = image_effect_definition_load($arg[7]);

      return isset($effect['help']) ? ('<p>' . $effect['help'] . '</p>') : NULL;

    case 'admin/config/media/image-styles/edit/%/effects/%':

      $effect = ($arg[5] == 'add') ? image_effect_definition_load($arg[6]) : image_effect_load($arg[7], $arg[5]);

      return isset($effect['help']) ? ('<p>' . $effect['help'] . '</p>') : NULL;

  }

}

/**

 * Implements hook_menu().

 */

function image_menu() {

  $items = array();

  // Generate image derivatives of publicly available files.

  // If clean URLs are disabled, image derivatives will always be served

  // through the menu system.

  // If clean URLs are enabled and the image derivative already exists,

  // PHP will be bypassed.

  $directory_path = file_stream_wrapper_get_instance_by_scheme('public')->getDirectoryPath();

  $items[$directory_path . '/styles/%image_style'] = array(

    'title' => 'Generate image style',

    'page callback' => 'image_style_deliver',

    'page arguments' => array(count(explode('/', $directory_path)) + 1),

    'access callback' => TRUE,

    'type' => MENU_CALLBACK,

  );

  // Generate and deliver image derivatives of private files.

  // These image derivatives are always delivered through the menu system.

  $items['system/files/styles/%image_style'] = array(

    'title' => 'Generate image style',

    'page callback' => 'image_style_deliver',

    'page arguments' => array(3),

    'access callback' => TRUE,

    'type' => MENU_CALLBACK,

  );

  $items['admin/config/media/image-styles'] = array(

    'title' => 'Image styles',

    'description' => 'Configure styles that can be used for resizing or adjusting images on display.',

    'page callback' => 'image_style_list',

    'access arguments' => array('administer image styles'),

    'file' => 'image.admin.inc',

  );

  $items['admin/config/media/image-styles/list'] = array(

    'title' => 'List',

    'description' => 'List the current image styles on the site.',

    'page callback' => 'image_style_list',

    'access arguments' => array('administer image styles'),

    'type' => MENU_DEFAULT_LOCAL_TASK,

    'weight' => 1,

    'file' => 'image.admin.inc',

  );

  $items['admin/config/media/image-styles/add'] = array(

    'title' => 'Add style',

    'description' => 'Add a new image style.',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('image_style_add_form'),

    'access arguments' => array('administer image styles'),

    'type' => MENU_LOCAL_ACTION,

    'weight' => 2,

    'file' => 'image.admin.inc',

  );

  $items['admin/config/media/image-styles/edit/%image_style'] = array(

    'title' => 'Edit style',

    'description' => 'Configure an image style.',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('image_style_form', 5),

    'access arguments' => array('administer image styles'),

    'file' => 'image.admin.inc',

  );

  $items['admin/config/media/image-styles/delete/%image_style'] = array(

    'title' => 'Delete style',

    'description' => 'Delete an image style.',

    'load arguments' => array(NULL, (string) IMAGE_STORAGE_NORMAL),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('image_style_delete_form', 5),

    'access arguments' => array('administer image styles'),

    'file' => 'image.admin.inc',

  );

  $items['admin/config/media/image-styles/revert/%image_style'] = array(

    'title' => 'Revert style',

    'description' => 'Revert an image style.',

    'load arguments' => array(NULL, (string) IMAGE_STORAGE_OVERRIDE),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('image_style_revert_form', 5),

    'access arguments' => array('administer image styles'),

    'file' => 'image.admin.inc',

  );

  $items['admin/config/media/image-styles/edit/%image_style/effects/%image_effect'] = array(

    'title' => 'Edit image effect',

    'description' => 'Edit an existing effect within a style.',

    'load arguments' => array(5, (string) IMAGE_STORAGE_EDITABLE),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('image_effect_form', 5, 7),

    'access arguments' => array('administer image styles'),

    'file' => 'image.admin.inc',

  );

  $items['admin/config/media/image-styles/edit/%image_style/effects/%image_effect/delete'] = array(

    'title' => 'Delete image effect',

    'description' => 'Delete an existing effect from a style.',

    'load arguments' => array(5, (string) IMAGE_STORAGE_EDITABLE),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('image_effect_delete_form', 5, 7),

    'access arguments' => array('administer image styles'),

    'file' => 'image.admin.inc',

  );

  $items['admin/config/media/image-styles/edit/%image_style/add/%image_effect_definition'] = array(

    'title' => 'Add image effect',

    'description' => 'Add a new effect to a style.',

    'load arguments' => array(5),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('image_effect_form', 5, 7),

    'access arguments' => array('administer image styles'),

    'file' => 'image.admin.inc',

  );

  return $items;

}

/**

 * Implements hook_theme().

 */

function image_theme() {

  return array(

    // Theme functions in image.module.

    'image_style' => array(

      'variables' => array(

        'style_name' => NULL,

        'path' => NULL,

        'width' => NULL,

        'height' => NULL,

        'alt' => '',

        'title' => NULL,

        'attributes' => array(),

      ),

    ),

    // Theme functions in image.admin.inc.

    'image_style_list' => array(

      'variables' => array('styles' => NULL),

    ),

    'image_style_effects' => array(

      'render element' => 'form',

    ),

    'image_style_preview' => array(

      'variables' => array('style' => NULL),

    ),

    'image_anchor' => array(

      'render element' => 'element',

    ),

    'image_resize_summary' => array(

      'variables' => array('data' => NULL),

    ),

    'image_scale_summary' => array(

      'variables' => array('data' => NULL),

    ),

    'image_crop_summary' => array(

      'variables' => array('data' => NULL),

    ),

    'image_rotate_summary' => array(

      'variables' => array('data' => NULL),

    ),

    // Theme functions in image.field.inc.

    'image_widget' => array(

      'render element' => 'element',

    ),

    'image_formatter' => array(

      'variables' => array('item' => NULL, 'path' => NULL, 'image_style' => NULL),

    ),

  );

}

/**

 * Implements hook_permission().

 */

function image_permission() {

  return array(

    'administer image styles' => array(

      'title' => t('Administer image styles'),

      'description' => t('Create and modify styles for generating image modifications such as thumbnails.'),

    ),

  );

}

/**

 * Implements hook_form_FORM_ID_alter().

 */

function image_form_system_file_system_settings_alter(&$form, &$form_state) {

  $form['#submit'][] = 'image_system_file_system_settings_submit';

}

/**

 * Form submission handler for system_file_system_settings().

 *

 * Adds a menu rebuild after the public file path has been changed, so that the

 * menu router item depending on that file path will be regenerated.

 */

function image_system_file_system_settings_submit($form, &$form_state) {

  if ($form['file_public_path']['#default_value'] !== $form_state['values']['file_public_path']) {

    variable_set('menu_rebuild_needed', TRUE);

  }

}

/**

 * Implements hook_flush_caches().

 */

function image_flush_caches() {

  return array('cache_image');

}

/**

 * Implements hook_file_download().

 *

 * Control the access to files underneath the styles directory.

 */

function image_file_download($uri) {

  $path = file_uri_target($uri);

  // Private file access for image style derivatives.

  if (strpos($path, 'styles/') === 0) {

    $args = explode('/', $path);

    // Discard the first part of the path (styles).

    array_shift($args);

    // Get the style name from the second part.

    $style_name = array_shift($args);

    // Remove the scheme from the path.

    array_shift($args);

    // Then the remaining parts are the path to the image.

    $original_uri = file_uri_scheme($uri) . '://' . implode('/', $args);

    // Check that the file exists and is an image.

    if ($info = image_get_info($uri)) {

      // Check the permissions of the original to grant access to this image.

      $headers = module_invoke_all('file_download', $original_uri);

      // Confirm there's at least one module granting access and none denying access.

      if (!empty($headers) && !in_array(-1, $headers)) {

        return array(

          // Send headers describing the image's size, and MIME-type...

          'Content-Type' => $info['mime_type'],

          'Content-Length' => $info['file_size'],

          // By not explicitly setting them here, this uses normal Drupal

          // Expires, Cache-Control and ETag headers to prevent proxy or

          // browser caching of private images.

        );

      }

    }

    return -1;

  }

  // Private file access for the original files. Note that we only check access

  // for non-temporary images, since file.module will grant access for all

  // temporary files.

  $files = file_load_multiple(array(), array('uri' => $uri));

  if (count($files)) {

    $file = reset($files);

    if ($file->status) {

      return file_file_download($uri, 'image');

    }

  }

}

/**

 * Implements hook_file_move().

 */

function image_file_move($file, $source) {

  // Delete any image derivatives at the original image path.

  image_path_flush($source->uri);

}

/**

 * Implements hook_file_delete().

 */

function image_file_delete($file) {

  // Delete any image derivatives of this image.

  image_path_flush($file->uri);

}

/**

 * Implements hook_image_default_styles().

 */

function image_image_default_styles() {

  $styles = array();

  $styles['thumbnail'] = array(

    'label' => 'Thumbnail (100x100)',

    'effects' => array(

      array(

        'name' => 'image_scale',

        'data' => array('width' => 100, 'height' => 100, 'upscale' => 1),

        'weight' => 0,

      ),

    )

  );

  $styles['medium'] = array(

    'label' => 'Medium (220x220)',

    'effects' => array(

      array(

        'name' => 'image_scale',

        'data' => array('width' => 220, 'height' => 220, 'upscale' => 1),

        'weight' => 0,

      ),

    )

  );

  $styles['large'] = array(

    'label' => 'Large (480x480)',

    'effects' => array(

      array(

        'name' => 'image_scale',

        'data' => array('width' => 480, 'height' => 480, 'upscale' => 0),

        'weight' => 0,

      ),

    )

  );

  return $styles;

}

/**

 * Implements hook_image_style_save().

 */

function image_image_style_save($style) {

  if (isset($style['old_name']) && $style['old_name'] != $style['name']) {

    $instances = field_read_instances();

    // Loop through all fields searching for image fields.

    foreach ($instances as $instance) {

      if ($instance['widget']['module'] == 'image') {

        $instance_changed = FALSE;

        foreach ($instance['display'] as $view_mode => $display) {

          // Check if the formatter involves an image style.

          if ($display['type'] == 'image' && $display['settings']['image_style'] == $style['old_name']) {

            // Update display information for any instance using the image

            // style that was just deleted.

            $instance['display'][$view_mode]['settings']['image_style'] = $style['name'];

            $instance_changed = TRUE;

          }

        }

        if ($instance['widget']['settings']['preview_image_style'] == $style['old_name']) {

          $instance['widget']['settings']['preview_image_style'] = $style['name'];

          $instance_changed = TRUE;

        }

        if ($instance_changed) {

          field_update_instance($instance);

        }

      }

    }

  }

}

/**

 * Implements hook_image_style_delete().

 */

function image_image_style_delete($style) {

  image_image_style_save($style);

}

/**

 * Implements hook_field_delete_field().

 */

function image_field_delete_field($field) {

  if ($field['type'] != 'image') {

    return;

  }

  // The value of a managed_file element can be an array if #extended == TRUE.

  $fid = (is_array($field['settings']['default_image']) ? $field['settings']['default_image']['fid'] : $field['settings']['default_image']);

  if ($fid && ($file = file_load($fid))) {

    file_usage_delete($file, 'image', 'default_image', $field['id']);

  }

}

/**

 * Implements hook_field_update_field().

 */

function image_field_update_field($field, $prior_field, $has_data) {

  if ($field['type'] != 'image') {

    return;

  }

  // The value of a managed_file element can be an array if #extended == TRUE.

  $fid_new = (is_array($field['settings']['default_image']) ? $field['settings']['default_image']['fid'] : $field['settings']['default_image']);

  $fid_old = (is_array($prior_field['settings']['default_image']) ? $prior_field['settings']['default_image']['fid'] : $prior_field['settings']['default_image']);

  $file_new = $fid_new ? file_load($fid_new) : FALSE;

  if ($fid_new != $fid_old) {

    // Is there a new file?

    if ($file_new) {

      $file_new->status = FILE_STATUS_PERMANENT;

      file_save($file_new);

      file_usage_add($file_new, 'image', 'default_image', $field['id']);

    }

    // Is there an old file?

    if ($fid_old && ($file_old = file_load($fid_old))) {

      file_usage_delete($file_old, 'image', 'default_image', $field['id']);

    }

  }

  // If the upload destination changed, then move the file.

  if ($file_new && (file_uri_scheme($file_new->uri) != $field['settings']['uri_scheme'])) {

    $directory = $field['settings']['uri_scheme'] . '://default_images/';

    file_prepare_directory($directory, FILE_CREATE_DIRECTORY);

    file_move($file_new, $directory . $file_new->filename);

  }

}

/**

 * Implements hook_field_delete_instance().

 */

function image_field_delete_instance($instance) {

  // Only act on image fields.

  $field = field_read_field($instance['field_name']);

  if ($field['type'] != 'image') {

    return;

  }

  // The value of a managed_file element can be an array if the #extended

  // property is set to TRUE.

  $fid = $instance['settings']['default_image'];

  if (is_array($fid)) {

    $fid = $fid['fid'];

  }

  // Remove the default image when the instance is deleted.

  if ($fid && ($file = file_load($fid))) {

    file_usage_delete($file, 'image', 'default_image', $instance['id']);

  }

}

/**

 * Implements hook_field_update_instance().

 */

function image_field_update_instance($instance, $prior_instance) {

  // Only act on image fields.

  $field = field_read_field($instance['field_name']);

  if ($field['type'] != 'image') {

    return;

  }

  // The value of a managed_file element can be an array if the #extended

  // property is set to TRUE.

  $fid_new = $instance['settings']['default_image'];

  if (is_array($fid_new)) {

    $fid_new = $fid_new['fid'];

  }

  $fid_old = $prior_instance['settings']['default_image'];

  if (is_array($fid_old)) {

    $fid_old = $fid_old['fid'];

  }

  // If the old and new files do not match, update the default accordingly.

  $file_new = $fid_new ? file_load($fid_new) : FALSE;

  if ($fid_new != $fid_old) {

    // Save the new file, if present.

    if ($file_new) {

      $file_new->status = FILE_STATUS_PERMANENT;

      file_save($file_new);

      file_usage_add($file_new, 'image', 'default_image', $instance['id']);

    }

    // Delete the old file, if present.

    if ($fid_old && ($file_old = file_load($fid_old))) {