<?php

/**

 * @file

 * Implement an image field, based on the file module's file field.

 */

/**

 * Implements hook_field_info().

 */

function image_field_info() {

  return array(

    'image' => array(

      'label' => t('Image'),

      'description' => t('This field stores the ID of an image file as an integer value.'),

      'settings' => array(

        'uri_scheme' => variable_get('file_default_scheme', 'public'),

        'default_image' => 0,

      ),

      'instance_settings' => array(

        'file_extensions' => 'png gif jpg jpeg',

        'file_directory' => '',

        'max_filesize' => '',

        'alt_field' => 0,

        'title_field' => 0,

        'max_resolution' => '',

        'min_resolution' => '',

        'default_image' => 0,

      ),

      'default_widget' => 'image_image',

      'default_formatter' => 'image',

    ),

  );

}

/**

 * Implements hook_field_settings_form().

 */

function image_field_settings_form($field, $instance) {

  $defaults = field_info_field_settings($field['type']);

  $settings = array_merge($defaults, $field['settings']);

  $scheme_options = array();

  foreach (file_get_stream_wrappers(STREAM_WRAPPERS_WRITE_VISIBLE) as $scheme => $stream_wrapper) {

    $scheme_options[$scheme] = $stream_wrapper['name'];

  }

  $form['uri_scheme'] = array(

    '#type' => 'radios',

    '#title' => t('Upload destination'),

    '#options' => $scheme_options,

    '#default_value' => $settings['uri_scheme'],

    '#description' => t('Select where the final files should be stored. Private file storage has significantly more overhead than public files, but allows restricted access to files within this field.'),

  );

  // When the user sets the scheme on the UI, even for the first time, it's

  // updating a field because fields are created on the "Manage fields"

  // page. So image_field_update_field() can handle this change.

  $form['default_image'] = array(

    '#title' => t('Default image'),

    '#type' => 'managed_file',

    '#description' => t('If no image is uploaded, this image will be shown on display.'),

    '#default_value' => $field['settings']['default_image'],

    '#upload_location' => $settings['uri_scheme'] . '://default_images/',

  );

  return $form;

}

/**

 * Implements hook_field_instance_settings_form().

 */

function image_field_instance_settings_form($field, $instance) {

  $settings = $instance['settings'];

  // Use the file field instance settings form as a basis.

  $form = file_field_instance_settings_form($field, $instance);

  // Add maximum and minimum resolution settings.

  $max_resolution = explode('x', $settings['max_resolution']) + array('', '');

  $form['max_resolution'] = array(

    '#type' => 'item',

    '#title' => t('Maximum image resolution'),

    '#element_validate' => array('_image_field_resolution_validate'),

    '#weight' => 4.1,

    '#field_prefix' => '<div class="container-inline">',

    '#field_suffix' => '</div>',

    '#description' => t('The maximum allowed image size expressed as WIDTHxHEIGHT (e.g. 640x480). Leave blank for no restriction. If a larger image is uploaded, it will be resized to reflect the given width and height. Resizing images on upload will cause the loss of <a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format">EXIF data</a> in the image.'),

  );

  $form['max_resolution']['x'] = array(

    '#type' => 'textfield',

    '#title' => t('Maximum width'),

    '#title_display' => 'invisible',

    '#default_value' => $max_resolution[0],

    '#size' => 5,

    '#maxlength' => 5,

    '#field_suffix' => ' x ',

  );

  $form['max_resolution']['y'] = array(

    '#type' => 'textfield',

    '#title' => t('Maximum height'),

    '#title_display' => 'invisible',

    '#default_value' => $max_resolution[1],

    '#size' => 5,

    '#maxlength' => 5,

    '#field_suffix' => ' ' . t('pixels'),

  );

  $min_resolution = explode('x', $settings['min_resolution']) + array('', '');

  $form['min_resolution'] = array(

    '#type' => 'item',

    '#title' => t('Minimum image resolution'),

    '#element_validate' => array('_image_field_resolution_validate'),

    '#weight' => 4.2,

    '#field_prefix' => '<div class="container-inline">',

    '#field_suffix' => '</div>',

    '#description' => t('The minimum allowed image size expressed as WIDTHxHEIGHT (e.g. 640x480). Leave blank for no restriction. If a smaller image is uploaded, it will be rejected.'),

  );

  $form['min_resolution']['x'] = array(

    '#type' => 'textfield',

    '#title' => t('Minimum width'),

    '#title_display' => 'invisible',

    '#default_value' => $min_resolution[0],

    '#size' => 5,

    '#maxlength' => 5,

    '#field_suffix' => ' x ',

  );

  $form['min_resolution']['y'] = array(

    '#type' => 'textfield',

    '#title' => t('Minimum height'),

    '#title_display' => 'invisible',

    '#default_value' => $min_resolution[1],

    '#size' => 5,

    '#maxlength' => 5,

    '#field_suffix' => ' ' . t('pixels'),

  );

  // Remove the description option.

  unset($form['description_field']);

  // Add title and alt configuration options.

  $form['alt_field'] = array(

    '#type' => 'checkbox',

    '#title' => t('Enable <em>Alt</em> field'),

    '#default_value' => $settings['alt_field'],

    '#description' => t('The alt attribute may be used by search engines, screen readers, and when the image cannot be loaded.'),

    '#weight' => 10,

  );

  $form['title_field'] = array(

    '#type' => 'checkbox',

    '#title' => t('Enable <em>Title</em> field'),

    '#default_value' => $settings['title_field'],

    '#description' => t('The title attribute is used as a tooltip when the mouse hovers over the image.'),

    '#weight' => 11,

  );

  // Add the default image to the instance.

  $form['default_image'] = array(

    '#title' => t('Default image'),

    '#type' => 'managed_file',

    '#description' => t("If no image is uploaded, this image will be shown on display and will override the field's default image."),

    '#default_value' => $settings['default_image'],

    '#upload_location' => $field['settings']['uri_scheme'] . '://default_images/',

  );

  return $form;

}

/**

 * Element validate function for resolution fields.

 */

function _image_field_resolution_validate($element, &$form_state) {

  if (!empty($element['x']['#value']) || !empty($element['y']['#value'])) {

    foreach (array('x', 'y') as $dimension) {

      $value = $element[$dimension]['#value'];

      if (!is_numeric($value)) {

        form_error($element[$dimension], t('Height and width values must be numeric.'));

        return;

      }

      if (intval($value) == 0) {

        form_error($element[$dimension], t('Both a height and width value must be specified in the !name field.', array('!name' => $element['#title'])));

        return;

      }

    }

    form_set_value($element, intval($element['x']['#value']) . 'x' . intval($element['y']['#value']), $form_state);

  }

  else {

    form_set_value($element, '', $form_state);

  }

}

/**

 * Implements hook_field_load().

 */

function image_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {

  file_field_load($entity_type, $entities, $field, $instances, $langcode, $items, $age);

}

/**

 * Implements hook_field_prepare_view().

 */

function image_field_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items) {

  // If there are no files specified at all, use the default.

  foreach ($entities as $id => $entity) {

    if (empty($items[$id])) {

      $fid = 0;

      // Use the default for the instance if one is available.

      if (!empty($instances[$id]['settings']['default_image'])) {

        $fid = $instances[$id]['settings']['default_image'];

      }

      // Otherwise, use the default for the field.

      elseif (!empty($field['settings']['default_image'])) {

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

      }

      // Add the default image if one is found.

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

        $items[$id][0] = (array) $file + array(

          'is_default' => TRUE,

          'alt' => '',

          'title' => '',

        );

      }

    }

  }

}

/**

 * Implements hook_field_presave().

 */

function image_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {

  file_field_presave($entity_type, $entity, $field, $instance, $langcode, $items);

  // Determine the dimensions if necessary.

  foreach ($items as &$item) {

    if (!isset($item['width']) || !isset($item['height'])) {

      $info = image_get_info(file_load($item['fid'])->uri);

      if (is_array($info)) {

        $item['width'] = $info['width'];

        $item['height'] = $info['height'];

      }

    }

  }

}

/**

 * Implements hook_field_insert().

 */

function image_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {

  file_field_insert($entity_type, $entity, $field, $instance, $langcode, $items);

}

/**

 * Implements hook_field_update().

 */

function image_field_update($entity_type, $entity, $field, $instance, $langcode, &$items) {

  file_field_update($entity_type, $entity, $field, $instance, $langcode, $items);

}

/**

 * Implements hook_field_delete().

 */

function image_field_delete($entity_type, $entity, $field, $instance, $langcode, &$items) {

  file_field_delete($entity_type, $entity, $field, $instance, $langcode, $items);

}

/**

 * Implements hook_field_delete_revision().

 */

function image_field_delete_revision($entity_type, $entity, $field, $instance, $langcode, &$items) {

  file_field_delete_revision($entity_type, $entity, $field, $instance, $langcode, $items);

}

/**

 * Implements hook_field_is_empty().

 */

function image_field_is_empty($item, $field) {

  return file_field_is_empty($item, $field);

}

/**

 * Implements hook_field_widget_info().

 */

function image_field_widget_info() {

  return array(

    'image_image' => array(

      'label' => t('Image'),

      'field types' => array('image'),

      'settings' => array(

        'progress_indicator' => 'throbber',

        'preview_image_style' => 'thumbnail',

      ),

      'behaviors' => array(

        'multiple values' => FIELD_BEHAVIOR_CUSTOM,

        'default value' => FIELD_BEHAVIOR_NONE,

      ),

    ),

  );

}

/**

 * Implements hook_field_widget_settings_form().

 */

function image_field_widget_settings_form($field, $instance) {

  $widget = $instance['widget'];

  $settings = $widget['settings'];

  // Use the file widget settings form.

  $form = file_field_widget_settings_form($field, $instance);

  $form['preview_image_style'] = array(

    '#title' => t('Preview image style'),

    '#type' => 'select',

    '#options' => image_style_options(FALSE, PASS_THROUGH),

    '#empty_option' => '<' . t('no preview') . '>',

    '#default_value' => $settings['preview_image_style'],

    '#description' => t('The preview image will be shown while editing the content.'),

    '#weight' => 15,

  );

  return $form;

}

/**

 * Implements hook_field_widget_form().

 */

function image_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {

  // Add display_field setting to field because file_field_widget_form() assumes it is set.

  $field['settings']['display_field'] = 0;

  $elements = file_field_widget_form($form, $form_state, $field, $instance, $langcode, $items, $delta, $element);

  $settings = $instance['settings'];

  foreach (element_children($elements) as $delta) {

    // Add upload resolution validation.

    if ($settings['max_resolution'] || $settings['min_resolution']) {

      $elements[$delta]['#upload_validators']['file_validate_image_resolution'] = array($settings['max_resolution'], $settings['min_resolution']);

    }

    // If not using custom extension validation, ensure this is an image.

    $supported_extensions = array('png', 'gif', 'jpg', 'jpeg');

    $extensions = isset($elements[$delta]['#upload_validators']['file_validate_extensions'][0]) ? $elements[$delta]['#upload_validators']['file_validate_extensions'][0] : implode(' ', $supported_extensions);

    $extensions = array_intersect(explode(' ', $extensions), $supported_extensions);

    $elements[$delta]['#upload_validators']['file_validate_extensions'][0] = implode(' ', $extensions);

    // Add all extra functionality provided by the image widget.

    $elements[$delta]['#process'][] = 'image_field_widget_process';

  }

  if ($field['cardinality'] == 1) {

    // If there's only one field, return it as delta 0.

    if (empty($elements[0]['#default_value']['fid'])) {

      $elements[0]['#description'] = theme('file_upload_help', array('description' => field_filter_xss($instance['description']), 'upload_validators' => $elements[0]['#upload_validators']));

    }

  }

  else {

    $elements['#file_upload_description'] = theme('file_upload_help', array('upload_validators' => $elements[0]['#upload_validators']));

  }

  return $elements;

}

/**

 * An element #process callback for the image_image field type.

 *

 * Expands the image_image type to include the alt and title fields.

 */

function image_field_widget_process($element, &$form_state, $form) {

  $item = $element['#value'];

  $item['fid'] = $element['fid']['#value'];

  $instance = field_widget_instance($element, $form_state);

  $settings = $instance['settings'];

  $widget_settings = $instance['widget']['settings'];

  $element['#theme'] = 'image_widget';

  $element['#attached']['css'][] = drupal_get_path('module', 'image') . '/image.css';

  // Add the image preview.

  if ($element['#file'] && $widget_settings['preview_image_style']) {

    $variables = array(

      'style_name' => $widget_settings['preview_image_style'],

      'path' => $element['#file']->uri,

    );

    // Determine image dimensions.

    if (isset($element['#value']['width']) && isset($element['#value']['height'])) {

      $variables['width'] = $element['#value']['width'];

      $variables['height'] = $element['#value']['height'];

    }

    else {

      $info = image_get_info($element['#file']->uri);

      if (is_array($info)) {

        $variables['width'] = $info['width'];

        $variables['height'] = $info['height'];

      }

      else {

        $variables['width'] = $variables['height'] = NULL;

      }

    }