imagecrop.admin.inc in Image javascript crop 7

Administration tools for the imagecrop module.

@date Oct 7, 2010

File

includes/imagecrop.admin.inc

<?php

/**
 * @file
 * Administration tools for the imagecrop module.
 *
 * @date
 * Oct 7, 2010
 */

/**
 * General settings form from the imagecrop module.
 */
function imagecrop_settings_form() {
  $all_popups = array(
    'basic' => t('Basic popup window'),
  );
  foreach (module_implements('imagecrop_popups') as $module_name) {
    $function = $module_name . '_imagecrop_popups';
    $popups = $function();
    if (is_array($popups)) {
      $all_popups += $popups;
    }
  }
  $form['imagecrop_popup'] = array(
    '#type' => 'radios',
    '#title' => t('Popup window type'),
    '#default_value' => variable_get('imagecrop_popup', 'imagecrop_jquery_dialog'),
    '#options' => $all_popups,
  );
  $options_modules = array(
    'profile_picture' => t('Profile pictures'),
    'media' => t('Media edit form (not media fields)'),
  );
  $form['imagecrop_theme'] = array(
    '#type' => 'radios',
    '#title' => t('Theme for imagecrop popups'),
    '#default_value' => variable_get('imagecrop_theme', 'admin_theme'),
    '#options' => array(
      'admin_theme' => t('Admin theme'),
      'theme_default' => t('Frontend theme'),
    ),
  );
  $form['imagecrop_modules'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Trigger imagecrop also for'),
    '#default_value' => variable_get('imagecrop_modules', array()),
    '#options' => $options_modules,
  );
  $form['imagecrop_popup_width'] = array(
    '#type' => 'textfield',
    '#title' => t('Popup window width'),
    '#default_value' => variable_get('imagecrop_popup_width', 700),
    '#size' => 4,
    '#field_suffix' => 'pixels',
  );
  $form['imagecrop_popup_height'] = array(
    '#type' => 'textfield',
    '#title' => t('Popup window height'),
    '#default_value' => variable_get('imagecrop_popup_height', 600),
    '#size' => 4,
    '#field_suffix' => 'pixels',
  );
  $form['imagecrop_show_cancel_button'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show cancel button'),
    '#default_value' => variable_get('imagecrop_show_cancel_button', FALSE),
    '#description' => t('Show a cancel button in the popup.'),
  );
  $form['imagecrop_skip_preview'] = array(
    '#type' => 'checkbox',
    '#title' => t('Skip image previews'),
    '#default_value' => variable_get('imagecrop_skip_preview', FALSE),
    '#description' => t('Popup opens crop page, instead of preview first.'),
  );
  $form['imagecrop_ui_controls'] = array(
    '#type' => 'checkbox',
    '#title' => t('Advanced UI controls'),
    '#default_value' => variable_get('imagecrop_ui_controls', FALSE),
    '#description' => t('Show a sidebar with live cropping info and the possibility to insert width / height'),
  );
  $form['imagecrop_scale_step'] = array(
    '#type' => 'textfield',
    '#title' => t('Step size for scale dropdown'),
    '#default_value' => variable_get('imagecrop_scale_step', 50),
    '#size' => 4,
    '#field_suffix' => 'pixels',
  );
  $form['imagecrop_scale_default'] = array(
    '#type' => 'checkbox',
    '#title' => t('Autoscale the initial crop to fit the popup.'),
    '#default_value' => variable_get('imagecrop_scale_default', FALSE),
  );
  $form['imagecrop_rotation'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow rotation from image'),
    '#default_value' => variable_get('imagecrop_rotation', FALSE),
    '#description' => t('When enabled, editors will be aible to rotate the image'),
  );

  // drupal message if no action is found with javascript_crop
  if (count(get_imagecrop_styles()) == 0) {
    drupal_set_message(t('No image style is found with the javascript_crop action so far. If you want to take advantage of this module, you will need to create at least one image style with that action.'));
  }
  return system_settings_form($form);
}

/**
 * Show an overview from the enabled image styles for this file.
 * Show an example from the first (or selected) image.
 *
 * @param $fid fid from file to be viewed
 * @param $style_name Style name that default needs to be shown
 * @param $entity_type entity type from the field that triggered the imagecrop overview
 * @param $bundle bundle from the field that triggered the imagecrop overview
 * @param $field_name Field name that triggered the imagecrop overview.
 */
function imagecrop_image_styles_overview($fid, $style_name, $entity_type = NULL, $bundle = NULL, $field_name = NULL) {
  $imagecrop = new ImageCrop();
  try {
    $styles = imagecrop_get_enabled_styles_for_crop($entity_type, $bundle, $field_name);
    if ($style_name) {
      if (!isset($styles[$style_name])) {
        drupal_set_message(t('The image style to crop was not found.'), 'error');
        throw new Exception(t('The image style to crop was not found.'));
      }
    }
    else {
      $style_name = key($styles);
    }
    $imagecrop
      ->loadFile($fid);
    global $user;
    if (!$imagecrop
      ->hasUserAccess($user)) {
      drupal_set_message(t("You don't have permissions to crop this image."), 'error');
      throw new Exception(t('Access denied for user @name on fid @fid', array(
        '@name' => $user->name,
        '@fid' => $imagecrop
          ->getFile()->fid,
      )));
    }
    $imagecrop
      ->setImageStyle($style_name);
    if ($entity_type) {
      $imagecrop
        ->setEntityType($entity_type);
    }
    if ($bundle) {
      $imagecrop
        ->setBundle($bundle);
    }
    if ($field_name) {
      $imagecrop
        ->setfieldName($field_name);
    }
    $imagecrop
      ->addImagecropUi(TRUE);
    $image_url = image_style_url($style_name, $imagecrop
      ->getFile()->uri);
    $clean_url = variable_get('clean_url', 0);
    $image_url .= !$clean_url || strpos($image_url, '?') !== FALSE ? '&' : '?';
    $image_url .= 'time=' . $_SERVER['REQUEST_TIME'];
    return theme('imagecrop_overview', array(
      'style_selection' => drupal_get_form('imagecrop_style_selection_form', $styles, $imagecrop),
      'viewed_style' => theme('image', array(
        'path' => $image_url,
      )),
      'edit_url' => 'imagecrop/crop/' . $imagecrop
        ->getFile()->fid . '/' . $style_name . '/' . $imagecrop
        ->getEntityType() . '/' . $imagecrop
        ->getBundle() . '/' . $imagecrop
        ->getFieldName(),
    ));
  } catch (Exception $e) {
    $imagecrop
      ->addImagecropUi(TRUE);
    watchdog_exception('imagecrop', $e);
    return '';
  }
}

/**
 * Show the cropping page for the selected image style.
 *
 * @param $fid fid from file to be cropped
 * @param $style_name Style that is being changed
 * @param $entity_type entity type from the field that triggered the imagecrop overview
 * @param $bundle bundle from the field that triggered the imagecrop overview
 * @param $field_name Field name that triggered the imagecrop overview.
 */
function imagecrop_cropping_page($fid, $style_name, $entity_type = NULL, $bundle = NULL, $field_name = NULL) {
  try {
    $styles = imagecrop_get_enabled_styles_for_crop($entity_type, $bundle, $field_name);
    global $user;
    $imagecrop = new ImageCrop();
    $imagecrop
      ->loadFile($fid);
    $imagecrop
      ->setImageStyle($style_name);
    $imagecrop
      ->setEntityType($entity_type);
    $imagecrop
      ->setBundle($bundle);
    $imagecrop
      ->setFieldName($field_name);
    $imagecrop
      ->setInCroppingMode(TRUE);
    $imagecrop
      ->setCropDestinations();
    global $user;
    if (!$imagecrop
      ->hasUserAccess($user)) {
      watchdog('imagecrop', 'Access denied for user @name on fid @fid', array(
        '@name' => $user->name,
        '@fid' => $imagecrop
          ->getFile()->fid,
      ));
      throw new Exception(t("You don't have permissions to crop this image."));
    }
    $imagecrop
      ->loadCropSettings();
    $imagecrop
      ->writeCropreadyImage();
    $imagecrop
      ->addImagecropUi(TRUE);
    $params = array(
      'style_selection' => drupal_get_form('imagecrop_style_selection_form', $styles, $imagecrop),
      'settings_form' => drupal_get_form('imagecrop_crop_settings_form', $imagecrop),
      'scale_form' => drupal_get_form('imagecrop_scale_settings_form', $imagecrop),
      'imagecrop' => $imagecrop,
    );
    if (variable_get('imagecrop_rotation')) {
      $params['rotation_form'] = drupal_get_form('imagecrop_rotation_settings_form', $imagecrop);
    }
    return theme($imagecrop->extraControls ? 'imagecrop_crop_ui_advanced' : 'imagecrop_crop_ui', $params);
  } catch (Exception $e) {
    drupal_set_message(check_plain($e
      ->getMessage()), 'error');
    return '';
  }
}

/**
 * Show a selection form to switch styles preview.
 */
function imagecrop_style_selection_form($form, $form_state, $styles, $imagecrop) {
  $image_style = $imagecrop
    ->getImageStyle();
  if ($imagecrop->skipPreview) {
    $path_action = 'crop';
    $select_title = t('Select style to crop');
  }
  else {
    $path_action = 'overview';
    $select_title = $imagecrop
      ->getInCroppingMode() ? t('Select other style to preview') : t('Select style to preview');
  }
  $form = array();
  $form['styles'] = array(
    '#type' => 'select',
    '#title' => $select_title,
    '#options' => $styles,
    '#default_value' => $image_style['name'],
  );
  $path = $imagecrop
    ->getFile()->fid . '/style_name/' . $imagecrop
    ->getEntityType() . '/' . $imagecrop
    ->getBundle() . '/' . $imagecrop
    ->getFieldName();
  $form['imagecrop-url'] = array(
    '#type' => 'hidden',
    '#value' => url('imagecrop/' . $path_action . '/' . $path, array(
      'absolute' => TRUE,
    )),
  );
  return $form;
}

/**
 * Settings form from the current crop.
 */
function imagecrop_crop_settings_form($form, $form_state, $imagecrop) {
  $type = $imagecrop->extraControls ? 'textfield' : 'hidden';
  $form['image-crop-x'] = array(
    '#type' => $type,
    '#title' => t('X position'),
    '#default_value' => $imagecrop
      ->getXOffset(),
  );
  $form['image-crop-y'] = array(
    '#type' => $type,
    '#title' => t('Y position'),
    '#default_value' => $imagecrop
      ->getYOffset(),
  );
  $form['image-crop-width'] = array(
    '#type' => $imagecrop
      ->isResizable() ? $type : 'hidden',
    '#title' => t('Width'),
    '#default_value' => $imagecrop
      ->getWidth(),
  );
  $form['image-crop-height'] = array(
    '#type' => $imagecrop
      ->isResizable() ? $type : 'hidden',
    '#title' => t('Height'),
    '#default_value' => $imagecrop
      ->getHeight(),
  );
  $form['image-crop-scale'] = array(
    '#type' => 'hidden',
    '#default_value' => $imagecrop
      ->getScale(),
  );
  $form['image-crop-rotation'] = array(
    '#type' => 'hidden',
    '#default_value' => $imagecrop
      ->getRotation(),
  );
  $form['fid'] = array(
    '#type' => 'hidden',
    '#value' => $imagecrop
      ->getFile()->fid,
  );
  $form['field'] = array(
    '#type' => 'hidden',
    '#value' => serialize(array(
      $imagecrop
        ->getEntityType(),
      $imagecrop
        ->getBundle(),
      $imagecrop
        ->getFieldName(),
    )),
  );
  $image_style = $imagecrop
    ->getImageStyle();
  $form['style'] = array(
    '#type' => 'hidden',
    '#value' => $image_style['name'],
  );
  $form['style-destination'] = array(
    '#type' => 'hidden',
    '#value' => $imagecrop
      ->getStyleDestination(),
  );
  $form['temp-style-destination'] = array(
    '#type' => 'hidden',
    '#value' => $imagecrop
      ->getCropDestination(TRUE, FALSE),
  );
  $form['temp-style-uri'] = array(
    '#type' => 'hidden',
    '#value' => $imagecrop
      ->getCropDestination(FALSE, FALSE),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save selection'),
  );
  return $form;
}

/**
 * Submit the settings form. Save all cropping settings.
 */
function imagecrop_crop_settings_form_submit($form, &$form_state) {
  db_delete('image_crop_settings')
    ->condition('fid', $form_state['values']['fid'])
    ->condition('style_name', $form_state['values']['style'])
    ->execute();
  $record = new stdClass();
  $record->fid = $form_state['values']['fid'];
  $record->style_name = $form_state['values']['style'];
  $record->xoffset = max($form_state['values']['image-crop-x'], 0);
  $record->yoffset = max($form_state['values']['image-crop-y'], 0);
  $record->width = $form_state['values']['image-crop-width'];
  $record->height = $form_state['values']['image-crop-height'];
  $record->scale = $form_state['values']['image-crop-scale'];
  $record->rotation = $form_state['values']['image-crop-rotation'];
  drupal_write_record('image_crop_settings', $record);
  $field_info = unserialize($form_state['values']['field']);
  $file = file_load($form_state['values']['fid']);

  // delete old imagestyles, so newest file is generated.
  image_path_flush($file->uri);
  if ($form_state['values']['style-destination'] != $form_state['values']['temp-style-destination']) {
    file_unmanaged_delete($form_state['values']['temp-style-uri']);
  }
  $record->style_destination = $form_state['values']['style-destination'];
  $record->temp_style_destination = $form_state['values']['temp-style-destination'];
  module_invoke_all('imagecrop_settings_update', $record);
  $action = variable_get('imagecrop_skip_preview', FALSE) ? 'crop' : 'overview';
  drupal_goto('imagecrop/' . $action . '/' . $record->fid . '/' . $record->style_name . '/' . $field_info[0] . '/' . $field_info[1] . '/' . $field_info[2], array(
    'query' => array(
      'cropping' => 'done',
    ),
  ));
}

/**
 * Show the scale form for the current imagecrop.
 */
function imagecrop_scale_settings_form($form, $form_state, $imagecrop) {
  $step = variable_get('imagecrop_scale_step', 50);
  $image_width = $scale_width = $imagecrop
    ->getOriginalImageWidth();
  $image_height = $imagecrop
    ->getOriginalImageHeight();
  $aspect = $image_width / $image_height;
  $crop_width = $imagecrop
    ->getWidth();
  $crop_height = $imagecrop
    ->getHeight();
  $form = array();
  $options = array();
  if ($step > 0) {
    $options[$image_width . 'x' . $image_height] = $image_width . ' x ' . $image_height . 'px (Original)';
    $scale_width -= $step;
    while ($scale_width > $crop_width && $scale_width / $aspect > $crop_height) {
      $scaled_height = intval($scale_width / $aspect);
      $options[$scale_width . 'x' . $scaled_height] = $scale_width . ' x ' . $scaled_height . 'px (' . round($scale_width / $image_width * 100, 2) . '%)';
      $scale_width -= $step;
    }
  }

  // Set the smallest scaling option to match the width of the crop (if it fits).
  $cropped_height = intval($crop_width / $aspect);
  $crop_width_with_border = $crop_width + 2;
  if ($crop_width != $scale_width + $step && $cropped_height >= $crop_height) {
    $options[$crop_width_with_border . 'x' . $cropped_height] = $crop_width_with_border . ' x ' . $cropped_height . 'px (' . round($scale_width / $image_width * 100, 2) . '%)';
  }

  // only show when there are multiple scaling options available
  if (count($options) > 1) {
    $current_width = $imagecrop
      ->getScale();
    $form['scaling'] = array(
      '#type' => 'select',
      '#options' => $options,
      '#default_value' => $current_width . 'x' . floor($current_width / $aspect),
      '#title' => t('Scale image'),
    );
  }
  return $form;
}

/**
 * Show the rotation form for the current imagecrop.
 */
function imagecrop_rotation_settings_form($form, $form_state, $imagecrop) {
  $options = array();
  $i = 0;
  while ($i <= 180) {
    $options[$i] = $i . '°';
    $i += 10;
  }
  $current_rotation = $imagecrop
    ->getRotation();
  $form['rotation'] = array(
    '#type' => 'select',
    '#options' => $options,
    '#default_value' => $current_rotation,
    '#title' => t('Rotate image'),
  );
  return $form;
}

/**
 * Form for controlling live cropping data.
 */
function imagecrop_controls_form($imagecrop) {
  $form = array();
  $form['crop-width'] = array(
    '#type' => 'textfield',
    '#title' => t('Width'),
    '#default_value' => $imagecrop
      ->getWidth(),
  );
  $form['crop-height'] = array(
    '#type' => 'textfield',
    '#title' => t('Height'),
    '#default_value' => $imagecrop
      ->getHeight(),
  );
  $form['x'] = array(
    '#type' => 'textfield',
    '#title' => t('X position'),
    '#default_value' => $imagecrop
      ->getWidth(),
  );
  $form['y'] = array(
    '#type' => 'textfield',
    '#title' => t('Y position'),
  );
  return $form;
}

/**
 * Generate a new scaled version from the image to crop.
 */
function imagecrop_generate_cropready_image() {
  $result = new stdClass();
  $result->success = FALSE;
  try {
    if (!isset($_POST['fid']) && !isset($_POST['style']) && !isset($_POST['scale'])) {
      throw new Exception(t('Required fields are empty'));
    }
    $imagecrop = new ImageCrop();
    $imagecrop
      ->loadFile($_POST['fid']);
    $imagecrop
      ->setImageStyle($_POST['style']);
    $imagecrop
      ->setCropDestinations();
    $imagecrop
      ->setScale($_POST['scale']);
    if (isset($_POST['rotation'])) {
      $imagecrop
        ->setRotation($_POST['rotation']);
    }
    $imagecrop
      ->writeCropreadyImage();
    $result->success = TRUE;
    drupal_json_output($result);
  } catch (Exception $e) {
    watchdog_exception('imagecrop', $e);
    $result->message = $e
      ->getMessage();
    drupal_json_output($result);
  }
}

/**
 * Get all the enabled styles for the current crop url.
 */
function imagecrop_get_enabled_styles_for_crop($entity_type, $bundle, $field_name) {
  $enabled_styles = array();
  if ($entity_type && $bundle && $field_name) {
    $enabled_styles = imagecrop_get_fields_enabled_styles($entity_type, $field_name, $bundle);
  }
  $styles = get_imagecrop_styles($enabled_styles);
  if (count($styles) == 0) {
    drupal_set_message(t('No javascript crop image styles are enabled for the current field.'), 'error');
    throw new Exception('No preset is found with the javascript_crop action so far. If you want to take advantage of this module, you will need to create at least one preset with that action.');
  }
  return $styles;
}

Functions

Name	Description
imagecrop_controls_form	Form for controlling live cropping data.
imagecrop_cropping_page	Show the cropping page for the selected image style.
imagecrop_crop_settings_form	Settings form from the current crop.
imagecrop_crop_settings_form_submit	Submit the settings form. Save all cropping settings.
imagecrop_generate_cropready_image	Generate a new scaled version from the image to crop.
imagecrop_get_enabled_styles_for_crop	Get all the enabled styles for the current crop url.
imagecrop_image_styles_overview	Show an overview from the enabled image styles for this file. Show an example from the first (or selected) image.
imagecrop_rotation_settings_form	Show the rotation form for the current imagecrop.
imagecrop_scale_settings_form	Show the scale form for the current imagecrop.
imagecrop_settings_form	General settings form from the imagecrop module.
imagecrop_style_selection_form	Show a selection form to switch styles preview.