modules/img_assist/img_assist.module

<?php
// $Id: img_assist.module,v 1.106 2009/08/03 21:47:25 sun Exp $

/**
 * @file
 * Image Assist module
 *
 * Implements a javascript-driven user interface to upload images to a Drupal
 * site and select a previously uploaded image for displaying inline in a
 * content.
 */

/**
 * Implementation of hook_help().
 */
function img_assist_help($path, $arg) {
  switch ($path) {
    case 'admin/settings/img_assist':
      return t('If this site was moved or is planned to move to another domain or sub-directory, it might be needed to <a href="!empty-cache">empty the filter cache</a> to correct image paths that are pointing to the old address.  Note that this will only work for images that have been inserted using filter tags.', array('!empty-cache' => url('img_assist/cache/clear')));
    
    case 'img_assist/template':
      return '<div class="%image-class"><a href="%link">%image</a><div class="caption">%caption</div></div>';
  }
}

/**
 * Implementation of hook_theme().
 */
function img_assist_theme() {
  return array(
    'img_assist_inline' => array(
      'arguments' => array('node' => NULL, 'size' => NULL, 'attributes' => NULL),
    ),
    'img_assist_filter' => array(
      'arguments' => array('text' => NULL),
    ),
    'img_assist_popup' => array(
      'arguments' => array('content' => NULL, 'attributes' => NULL),
    ),
    'img_assist_page' => array(
      'arguments' => array('content' => NULL, 'attributes' => NULL),
    ),
    'img_assist_legacy' => array(),
  );
}

/**
 * Implementation of hook_menu().
 */
function img_assist_menu() {
  $items['img_assist/cache/clear'] = array(
    'title' => 'Empty cache',
    'page callback' => 'img_assist_cache_clear',
    'access arguments' => array('administer site configuration'),
    'type' => MENU_CALLBACK,
    'file' => 'img_assist.admin.inc',
  );
  $items['img_assist/load'] = array(
    'title' => 'Image assist',
    'page callback' => 'img_assist_loader',
    'access arguments' => array('access img_assist'),
    'type' => MENU_CALLBACK,
  );
  // Page callbacks called internally by img_assist/load.
  $items['img_assist/header'] = array(
    'title' => 'Image assist header',
    'page callback' => 'img_assist_header',
    'page arguments' => array(2),
    'access arguments' => array('access img_assist'),
    'type' => MENU_CALLBACK,
  );
  $items['img_assist/thumbs'] = array(
    'title' => 'Image assist thumbnails',
    'page callback' => 'img_assist_thumbs',
    'access arguments' => array('access img_assist'),
    'type' => MENU_CALLBACK,
  );
  $items['img_assist/upload'] = array(
    'title' => 'Image assist upload',
    'page callback' => 'img_assist_upload',
    'access arguments' => array('access img_assist'),
    'type' => MENU_CALLBACK,
  );
  $items['img_assist/properties'] = array(
    'title' => 'Image assist properties',
    'page callback' => 'img_assist_properties',
    'access arguments' => array('access img_assist'),
    'type' => MENU_CALLBACK,
  );
  // Popup images page.
  $items['img_assist/popup'] = array(
    'title' => 'Popup image',
    'page callback' => 'img_assist_popup',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
  );
  // Insert callback (only for inserting HTML, not filter tag).
  $items['img_assist/insert_html'] = array(
    'title' => 'Insert callback',
    'page callback' => 'img_assist_insert_html',
    'access arguments' => array('access img_assist'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/settings/img_assist'] = array(
    'title' => 'Image assist',
    'description' => 'Change settings for the Image assist module.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('img_assist_admin_settings'),
    'access arguments' => array('administer site configuration'),
    'file' => 'img_assist.admin.inc',
  );
  return $items;
}

/**
 * Implementation of hook_init().
 */
function img_assist_init() {
  $path = drupal_get_path('module', 'img_assist');
  if (arg(0) == 'img_assist') {
    // Suppress Administration menu.
    module_invoke('admin_menu', 'suppress');

    drupal_add_css($path .'/img_assist_popup.css', 'module', 'all', FALSE);
  }
  else {
    drupal_add_js($path .'/img_assist.js');
    if (variable_get('img_assist_page_styling', 'yes') == 'yes') {
      drupal_add_css($path .'/img_assist.css');
    }
  }
}

/**
 * Implementation of hook_perm().
 */
function img_assist_perm() {
  return array('access img_assist', 'access all images', 'access advanced options', 'use original size');
}

/**
 * Implementation of hook_elements().
 */
function img_assist_elements() {
  $type['textarea'] = array(
    '#process' => 'img_assist_textarea'
  );
  return $type;
}

/**
 * Add JavaScript settings for generating the image link underneath textareas.
 */
function img_assist_textarea($element) {
  static $initialized = FALSE;

  if (!user_access('access img_assist')) {
    return $element;
  }
  $link = variable_get('img_assist_link', 'icon');
  if ($link == 'icon' || $link == 'text') {
    if (_img_assist_textarea_match($element['#id']) && _img_assist_page_match() && !strstr($_GET['q'], 'img_assist')) {
      if (!$initialized) {
        // Add settings.
        $settings['link'] = $link;
        if ($link == 'icon') {
          $settings['icon'] = drupal_get_path('module', 'img_assist') .'/add-image.jpg';
        }
        drupal_add_js(array('img_assist' => $settings), 'setting');
        $initialized = TRUE;
      }

      // Attach behavior.
      // @todo Some browsers do not support underscores in CSS classes.
      if (!isset($element['#attributes']['class'])) {
        $element['#attributes']['class'] = 'img_assist';
      }
      else {
        $element['#attributes']['class'] .= ' img_assist';
      }
    }
  }
  return $element;
}

/**
 * Implementation of hook_block().
 *
 * Generates a block that references the other places the current image is used.
 * The block is only visible when looking at the full view of an image.
 */
function img_assist_block($op = 'list', $delta = 0) {
  if ($op == 'list') {
    $blocks[0]['info'] = t('Image reference');
    return $blocks;
  }
  else if ($op == 'view') {
    switch ($delta) {
      case 0:
        // Since blocks aren't passed node objects (which makes sense) we need
        // to determine if we are viewing a node and grab its nid.
        if (arg(0) == 'node' && is_numeric(arg(1))) {
          $block['subject'] = t('This image appears in...');
          $block['content'] = img_assist_get_references(arg(1));
          return $block;
        }
        break;
    }
  }
}

/**
 * Implementation of hook_filter().
 */
function img_assist_filter($op, $delta = 0, $format = -1, $text = '') {
  switch ($op) {
    case 'list':
      return array(0 => t('Inline images'));
    
    case 'description':
      return t('Add images to your posts with Image assist.');

//    case 'no cache':
//      return TRUE;

    case 'process':
      $processed = FALSE;
      foreach (img_assist_get_macros($text) as $unexpanded_macro => $macro) {
        $expanded_macro = img_assist_render_image($macro);
        $text           = str_replace($unexpanded_macro, $expanded_macro, $text);
        $processed      = TRUE;
      }
      return $processed ? theme('img_assist_filter', $text) : $text;
    
    default:
      return $text;
  }
}

/**
 * Implementation of hook_filter_tips().
 */
function img_assist_filter_tips($delta, $format, $long = FALSE) {
  return t('Images can be added to this post.');
}

/**
 * Implementation of hook_nodeapi().
 *
 * - Clear input filter cache.
 * - Keep track of where images are used.
 * - Catch nids of recently uploaded images.
 */
function img_assist_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
  switch ($op) {
    case 'update':
      if ($node->type == 'image') {
        // Clear the input filter cache to force all node content to be rebuilt.
        // This is to make sure all image paths are up to date.
        cache_clear_all(NULL, 'cache_filter');
      }
      // break is intentionally left out.
    case 'insert':
      // Update the image map.
      img_assist_map_save($node);
      break;
    
    case 'delete':
      img_assist_map_delete($node);
      break;
  }
}

/**
 * @defgroup img_assist_pages Image Assist Pages
 * @{
 * All but img_assist_loader() are in frames.
 */

/**
 * Output main img_assist interface HTML.
 * 
 * @todo Remove hard-coded TinyMCE integration.
 */
function img_assist_loader() {
  $path = drupal_get_path('module', 'img_assist');
  $caller = arg(2) ? arg(2) : 'textarea';

  drupal_add_js($path . '/img_assist_popup.js');
  if (module_exists('wysiwyg') && ($editor = wysiwyg_get_editor($caller))) {
    if ($editor['name'] == 'tinymce') {
      drupal_add_js($editor['library path'] . '/tiny_mce_popup.js');
    }
  }
  else {
    $caller = 'textarea';
  }
  drupal_add_js($path . '/img_assist_' . $caller . '.js');

  $output  = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN">'."\n";
  $output .= "<html>\n";
  $output .= "<head>\n";
  $output .= '<title>'. t('Add image') ."</title>\n";
  $output .= drupal_get_js();
  $output .= "</head>\n\n";
  
  $output .= '<frameset rows="38, *" onload="initLoader()" frameborder="0" border="0" framespacing="0">' . "\n";
  $output .= '<frame name="img_assist_header" src="" class="img_assist_header" noresize="noresize" />' . "\n";
  $output .= '<frame name="img_assist_main" src="" class="img_assist_main" noresize="noresize" />' . "\n";
  $output .= "</frameset>\n";
  
  $output .= "</html>\n";
  echo $output;
  exit;
}

/**
 * Fetch the number of nodes for terms of given vocabulary ids.
 *
 * Note that this does not count nodes of subterms, as opposed to 
 * taxonomy_term_count_nodes().
 *
 * @param $vids
 *   An array of taxonomy vocabulary ids.
 *
 * @return
 *   An array keyed by term ids with the count of nodes for each term.
 */
function _img_assist_term_count_nodes($vids) {
  $count = array();
  $result = db_query(db_rewrite_sql('SELECT t.tid, COUNT(n.nid) AS count FROM {term_node} t INNER JOIN {node} n ON t.vid = n.vid INNER JOIN {term_data} td ON td.tid = t.tid WHERE n.status = 1 AND td.vid IN (' . db_placeholders($vids) . ') GROUP BY t.tid'), implode(',', $vids));
  while ($term = db_fetch_object($result)) {
    $count[$term->tid] = $term->count;
  }
  return $count;
}

function img_assist_header($mode) {
  // Mode may be 'uploading', 'properties' or 'browse'.
  $output = drupal_get_form('img_assist_header_form', $mode);
  echo theme('img_assist_page', $output, array('id' => 'img_assist_header', 'onload' => 'parent.initHeader();', 'class' => 'img_assist'));
  exit;
}

function img_assist_header_form(&$form_state, $mode) {
  global $user;
  
  // Upload image.
  if ($mode == 'uploading') {
    $form[] = array('#value' => '<div id="header-uploading">');
    $form[] = array('#value' => '<strong>'. t('Upload: ') .'</strong>'. t('Fill in the form below to upload a new image.'));
    $form[] = array('#value' => '</div><div id="header-startover">');
    $form['startover'] = array(
      '#type' => 'button',
      '#value' => t('Start Over'),
      '#button_type' => 'button',
      '#attributes' => array('onclick' => 'parent.onClickStartOver();'),
    );
    $form[] = array('#value' => '</div>');
  }
  elseif ($mode == 'properties') {
    $form[] = array('#value' => '<div id="header-properties">');
    $form[] = array('#value' => '<strong>'. t('Properties: ') .'</strong>'. t('Change how the image is displayed.'));
    $form[] = array('#value' => '</div><div id="header-startover">');
    $form['startover'] = array(
      '#type' => 'button',
      '#value' => t('Start Over'),
      '#button_type' => 'button',
      '#attributes' => array('onclick' => 'parent.onClickStartOver()'),
    );
    $form[] = array('#value' => '</div>');
  }
  // Browse images.
  else {
    $form[] = array('#value' => '<div id="header-browse">');
    $form[] = array('#value' => '<strong>'. t('Browse Images: ') .'</strong>');
    
    $views = variable_get('img_assist_views', drupal_map_assoc(array('img_assist_browser')));
    foreach ($views as $view_name => $view_title) {
      if ($view_name == 'img_assist_browser') {
        // @todo execute() performs a full query, we just need the count here.
        // Get my images and count.
        $myimages = views_get_view('img_assist_browser');
        $myimages->set_arguments(array($user->uid));
        $myimages->get_total_rows = TRUE; // Required for overridden default view.
        $myimages->execute();
        $options['img_assist_browser/' . $user->uid] = t('My Images') ." ($myimages->total_rows)";

        // Get all images and count.
        if (user_access('access all images')) {
          $allimages = views_get_view('img_assist_browser');
          $allimages->set_arguments(array('all'));
          $allimages->get_total_rows = TRUE; // Required for overridden default view.
          $allimages->execute();
          $options['img_assist_browser/all'] = t('All Images') ." ($allimages->total_rows)";
        }
        // Get category list.
        if (module_exists('taxonomy') && $vocabs = variable_get('img_assist_vocabs', array())) {
          $term_counts = _img_assist_term_count_nodes($vocabs);
          // Get all images or only user's images depending on permissions.
          $user_arg = (user_access('access all images')) ? 'all' : $user->uid;
          foreach ($vocabs as $vid) {
            $vocab = taxonomy_vocabulary_load($vid);
            $terms = taxonomy_get_tree($vid);
            if ($terms) {
              foreach ($terms as $key => $value) {
                $tid = $value->tid;
                $name = $value->name;
                $count = (isset($term_counts[$tid]) ? $term_counts[$tid] : 0);
                $options[$vocab->name]["img_assist_browser/$user_arg/" . $tid] = "$name ($count)";
              }
            }
          }
        }
      }
      else {
        $view = views_get_view($view_name);
        $view->execute();
        $view_title = ($view->get_title() == '') ? $view_name : $view->get_title();
        $options[$view_name] = "$view_title ($view->total_rows)";
      }
    }
    $form['browse'] = array(
      '#type' => 'select',
      '#default_value' => 'img_assist_browser/' . $user->uid,
      '#options' => $options,
      '#attributes' => array('onchange' => 'parent.onChangeBrowseBy(this)'),
    );
    if (user_access('create images')) {
      $form['upload'] = array(
        '#type' => 'button',
        '#prefix' => ' '. t('or') .' ',
        '#value' => t('Upload'),
        '#suffix' => ' '. t('a new image'),
        '#button_type' => 'button',
        '#attributes' => array('onclick' => 'parent.onClickUpload()'),
      );
    }
    $form[] = array('#value' => '</div><div id="header-cancel">');
    $form['cancel'] = array(
      '#type' => 'button',
      '#value' => t('Cancel'),
      '#button_type' => 'button',
      '#attributes' => array('onclick' => 'parent.cancelAction()'),
    );
    $form[] = array('#value' => '</div>');
  }
  return $form;
}

/**
 * Interface for adding images. Uses the regular image node form.
 */
function img_assist_upload() {
  global $user;
  module_load_include('inc', 'node', 'node.pages');

  if (module_exists('image') && user_access('create images')) {
    // On other img_assist_pages I've added the javascript using the body onload
    // attribute, but for this page will also need the collapse functions and
    // setting the body onload interferes with this. To solve this, I'm forced
    // use the $(document).ready call. I should probably switch all the pages to
    // this format to be more Drupal friendly, but at the same time I don't know
    // if it really matters. If a user doesn't have Javascript, she can't use
    // img_assist at all.
    $output  = "<script type=\"text/javascript\"><!-- \n";
    $output .= "  if (Drupal.jsEnabled) { \n";
    $output .= "    $(document).ready(parent.initUpload);\n";
    $output .= "  } \n";
    $output .= "--></script>\n";
    
    // Define an empty node and fetch an image node form
    $node = array('uid' => $user->uid, 'name' => $user->name, 'type' => 'image');
    $output .= drupal_get_form('image_node_form', $node);
  }
  else {
    if (!module_exists('image')) {
      $output = t('The image module must be enabled to use Image assist.');
    }
    else {
      $output = t('Your account does not have image uploading privileges.');
    }
  }
  echo theme('img_assist_page', $output, array('id' => 'img_assist_upload', 'class' => 'img_assist'));
  exit;
}

/**
 * Implementation of hook_form_alter().
 * 
 * Reroute submit button callback to our own handler to be able to redirect
 * the user after saving the node.
 *
 * @see img_assist_node_form_submit()
 */
function img_assist_form_alter(&$form, &$form_state, $form_id) {
  if ($form_id == 'image_node_form' && arg(0) == 'img_assist') {
    $form['buttons']['submit']['#submit'] = array('img_assist_node_form_submit');
  }
  // If a view uses exposed filters in the image browser, we need to modify #action.
  elseif ($form_id == 'views_exposed_form' && arg(0) == 'img_assist') {
    $form['#action'] = url($_GET['q']);
  }
}

/**
 * Submit callback for image_node_form.
 */
function img_assist_node_form_submit($form, &$form_state) {
  // Execute regular node submit handler.
  node_form_submit($form, $form_state);

  if ($form_state['nid']) {
    // Send to different url.
    $form_state['redirect'] = 'img_assist/properties/'. $form_state['nid'];
  }
}

/**
 * Load the thumbnail display pane.
 *
 * Loads a View displaying the thumbnails. The view name is picked from the 
 * third path argument and any remaining arguments are used as arguments to the
 * view.
 * Module developers may add options to img_assist_header_form using 
 * hook_form_alter() if they wish to use custom views and/or arguments.
 */
function img_assist_thumbs() {
  global $user;
  
  if (module_exists('image') && module_exists('views')) {
    $view_name = ((arg(2) != '') ? arg(2) : 'img_assist_browser');
    
    // Get view arguments from path.
    $args = explode('/', $_GET['q']);
    $args = array_slice($args, 3);
    
    // Check sanity and permissions for the 'img_assist_browser' view.
    if ($view_name == 'img_assist_browser') {
      if (empty($args[0]) || !user_access('access all images')) {
        $args[0] = $user->uid;
      }
      if (isset($args[1])) {
        $args[1] = (int) $args[1];
      }
    }
    
    $view = views_get_view($view_name);
    if ($view) {
      $view_output = $view->execute_display(NULL, $args);
      if (empty($view_output)) {
        $output = t('No images were found. Please upload a new image or browse images by a different category.');
      }
      else {
        $output = $view_output;
      }
    }
    else {
      $output = t('Error: The specified view was not found.');
    }
  }
  else {
    $output = t('The Image and Views modules must be enabled to use Image assist.');
  }
  echo theme('img_assist_page', $output, array('id' => 'img_assist_thumbs', 'onload' => 'parent.initThumbs();', 'class' => 'img_assist'));
  exit;
}

/**
 * Load the image properties pane.
 */
function img_assist_properties() {
  $nid = arg(2);
  // Update is put into a hidden field so the javascript can see it.
  $update = (arg(3)) ? 1 : 0;
  
  if (is_numeric($nid) && ($node = node_load($nid)) && $node->type == 'image' && node_access('view', $node)) {
    $output = drupal_get_form('img_assist_properties_form', $node, $update);
  }
  else {
    $output = t('Image ID not found');
  }
  
  echo theme('img_assist_page', $output, array('id' => 'img_assist_properties', 'onload' => 'parent.initProperties();', 'class' => 'img_assist'));
  exit;
}

/**
 * Convert a node field value to text for usage in a textfield.
 */
function img_assist_sanitize($text) {
  return check_plain(trim(preg_replace("/[\r\n]+/", ' ', strip_tags($text))));
}

/**
 * Construct the image properties form.
 */
function img_assist_properties_form($form_state, $node, $update) {
  require_once drupal_get_path('module', 'img_assist') .'/includes/img_assist.token.inc';

  $image_info = image_get_info(file_create_path($node->images[IMAGE_ORIGINAL]));
  $image_info['aspect_ratio'] = $image_info['height'] / $image_info['width'];

  // Select (or generate) a preview image.
  $img_assist_create_derivatives = variable_get('img_assist_create_derivatives', array());
  if (!empty($img_assist_create_derivatives['properties'])) {
    $properties_size['label'] = t('Properties');
    $properties_size['key'] = 'img_assist_properties';
    $properties_size['width'] = 200;
    $properties_size['height'] = 200;
  }
  else {
    $properties_size['key'] = IMAGE_THUMBNAIL;
  }
  $properties_image = img_assist_display($node, $properties_size);
  // Get actual image size.
  $properties_size = image_get_info(file_create_path($node->images[$properties_size['key']]));
  
  // Create an array of image derivative choices
  //
  // The name for each option is actually the size in pixels, not the derivative
  // name. This is necessary so that
  // - the Javascript that process this page and inserts code to your textarea
  //   or editor will know the size to make the image placeholder (in a WYSIWYG
  //   editor)
  // - the code that processes the img_assist filter tags can work with standard
  //   sizes and custom sizes in the same way.
  // The WYSIWYG placeholder, however, is the most important reason to keep the
  // img_assist tags this way. This way users can even resize images in the
  // editor, and if they aren't allow to create custom sizes the filter will
  // pick the existing derivative that is closest to the size of the WYSIWYG
  // placeholder. For users not familiar with pixel sizes or names like
  // 'thumbnail' and 'preview', this is a nice visual way to size images.
  // The size selection dropdown could even be hidden using the stylesheet,
  // making the insertion of images even more of a visual process. And for
  // administrators and those with the proper permissions, images don't have to
  // snap to the nearest standard size. You can create any arbitrary size you
  // choose.
  $max_size = explode('x', variable_get('img_assist_max_size', '640x640'));
  
  foreach (image_get_sizes(NULL, $image_info['aspect_ratio']) as $key => $size) {
    // Sizes are strings, may contain '' for 0; convert to integers.
    settype($size['width'], 'int');
    settype($size['height'], 'int');

    $added_to_derivatives = FALSE;
    if ($key == IMAGE_ORIGINAL) {
      if (user_access('use original size') && $image_info['width'] <= $max_size[0] && $image_info['height'] <= $max_size[1]) {
        $derivatives[$image_info['width'] .'x'. $image_info['height']] = $size['label'];
        $added_to_derivatives = TRUE;
      }
    }
    elseif ($size['width'] <= $max_size[0] && $size['height'] <= $max_size[1]) {
      $derivatives[$size['width'] .'x'. $size['height']] = $size['label'];
      $added_to_derivatives = TRUE;
    }
    
    if (!$added_to_derivatives) {
      // The thumbnail option will be shown even if it is larger than the
      // maximum size.
      if ($key == IMAGE_THUMBNAIL) {
        $derivatives[$size['width'] .'x'. $size['height']] = $size['label'];
      }
    }
  }
  
  // Add a choice for 'other' if the user has the proper permission to create
  // custom sizes.
  if (!empty($img_assist_create_derivatives['custom_advanced']) && user_access('access advanced options')) {
    $derivatives['other'] = t('Other');
  }
  
  // Use 'preview' size by default.
  $default_size   = image_get_info(file_create_path($node->images[IMAGE_PREVIEW]));
  $default_width  = $default_size['width'];
  $default_height = $default_size['height'];
  
  // Calculate the aspect ratio to keep in a hidden field
  //
  // When 'other' is chosen, the custom size will always follow the aspect ratio.
  // It doesn't really matter what this value is here because the actual custom
  // image will be created when the  filter tag is processed. The size, of course,
  // is a bounding box. If it a user stretches an image placeholder out of
  // proportion in the WYSIWYG editor, the image will never be out of proportion
  // on the processed page.
  $aspect_ratio = ($default_height > 0 ? round($default_width / $default_height, 6) : 1);
  
  // Create the form.
  $form[] = array('#value' => '<div id="properties">');
  $form[] = array('#value' => '<table width="100%" border="0" cellspacing="0" cellpadding="0">');
  $form[] = array('#value' => '<tr><td valign="top" rowspan="3" id="preview">');
  $form[] = array('#value' => $properties_image);
  $form[] = array('#value' => '<span id="caption" style="width: '. $properties_size['width'] .'px;">'. check_plain($node->title) .'</span>');

  // Image node properties fieldset.
  $form['properties'] = array('#type' => 'fieldset', '#title' => t('Image properties'));
  $form['properties'][] = array('#value' => '<div class="field field-type-text"><div class="field-label">'. t('Size') .': </div><div class="field-items"><div class="field-item">'. strtr('@widthx@height px', array('@width' => $image_info['width'], '@height' => $image_info['height'])) .'</div></div></div>');
  $rendered = node_build_content($node);
  foreach (array_filter(variable_get('img_assist_display_properties', array())) as $field) {
    if (isset($node->content[$field])) {
      $form['properties'][] = array('#value' => drupal_render($node->content[$field]));
    }
  }

  $form[] = array('#value' => '</td><td width="100%" colspan="2">');
  
  $token_installed = module_exists('token');
  if (variable_get('img_assist_load_title', 1)) {
    $title = img_assist_sanitize($token_installed ? token_replace(variable_get('img_assist_title_pattern', '[title]'), 'node', $node) : $node->title);
  }
  if (variable_get('img_assist_load_description', 1)) {
    $description = img_assist_sanitize($token_installed ? token_replace(variable_get('img_assist_description_pattern', '[body]'), 'node', $node) : $node->body);
  }
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title (optional)'),
    '#default_value' => isset($title) ? $title : '',
    '#size' => 50,
    '#maxlength' => 255,
    '#description' => NULL,
    '#attributes' => array('onblur' => 'parent.updateCaption()'),
  );
  $form['desc'] = array(
    '#type' => 'textfield',
    '#title' => t('Description (optional)'),
    '#default_value' => isset($description) ? $description : '',
    '#size' => 50,
    '#maxlength' => 255,
    '#description' => NULL,
    '#attributes' => array('onblur' => 'parent.updateCaption()'),
  );
  
  // Size.
  $form[] = array('#value' => '</td></tr><tr><td width="90%">');
  $form[] = array('#value' => '<div class="form-item" id="edit-size">');
  $form[] = array('#value' => '<label for="edit-size-label">' . t('Size: (max @maxsize)', array('@maxsize' => variable_get('img_assist_max_size', '640x640'))) .'</label>');
  $form['size_label'] = array(
    '#type' => 'select',
    '#default_value' => variable_get('img_assist_default_label', '100x100'),
    '#options' => $derivatives,
    '#attributes' => array('onchange' => 'parent.onChangeSizeLabel()'),
  );
  $form[] = array('#value' => '<div class="form-item" id="size-other">');
  $form['width'] = array(
    '#type' => 'textfield',
    '#default_value' => $default_width,
    '#size' => 4,
    '#maxlength' => 4,
    '#attributes' => array('onblur' => 'parent.onChangeWidth()'),
  );
  $form[] = array('#value' => ' x ');
  $form['height'] = array(
    '#type' => 'textfield',
    '#default_value' => $default_height,
    '#size' => 4,
    '#maxlength' => 4,
    '#attributes' => array('onblur' => 'parent.onChangeHeight()'),
  );
  $form[] = array('#value' => '</div></div>');
  $form[] = array('#value' => '</td><td>');
  
  // Alignment.
  $form['align'] = array(
    '#type' => 'select',
    '#title' => t('Alignment'),
    '#default_value' => variable_get('img_assist_default_alignment', 'left'),
    '#options' => array('left' => t('left'), 'right' => t('right'), 'none' => t('none'), 'center' => t('center')),
    '#prefix' => '<div id="alignment">',
    '#suffix' => '</div>',
  );
  $form[] = array('#value' => '</td></tr><tr><td colspan="2">');
  
  // Link.
  if (user_access('access advanced options')) {
    $form[] = array('#value' => '<div class="form-item" id="link-group">');
    $form['link'] = array(
      '#type' => 'select',
      '#title' => t('Link'),
      '#default_value' => variable_get('img_assist_default_link_behavior', 'none'),
      '#options' => array('none' => t('Not a link'), 'node' => t('Link to image page'), 'popup' => t('Open in popup window'), 'url' => t('Go to URL')),
      '#attributes' => array('onchange' => 'parent.onChangeLink()'),
    );
    $form['url'] = array(
      '#type' => 'textfield',
      '#default_value' => variable_get('img_assist_default_link_url', 'http://'),
      '#size' => 25,
      '#maxlength' => 255,
      '#description' => NULL,
    );
    $form['link_options_visible'] = array(
      '#type' => 'hidden',
      '#value' => 1,
    );
    $form[] = array('#value' => '</div>');
  }
  else {
    $form['link'] = array(
      '#type' => 'hidden',
      '#value' => variable_get('img_assist_default_link_behavior', 'none'),
    );
    $form['url'] = array(
      '#type' => 'hidden',
      '#value' => variable_get('img_assist_default_link_url', 'http://'),
    );
    $form['link_options_visible'] = array(
      '#type' => 'hidden',
      '#value' => 0,
    );
  }
  // Default link url is needed for JS to indicate if an url has been entered.
  $form['default_url'] = array(
    '#type' => 'hidden',
    '#value' => variable_get('img_assist_default_link_url', 'http://'),
  );
  
  // Insert Mode (HTML or Filter Tag).
  if (user_access('access advanced options')) {
    $form[] = array('#value' => '<div id="insertmode">');
    $form['insertmode'] = array(
      '#type' => 'select',
      '#title' => t('Insert mode'),
      '#default_value' => variable_get('img_assist_default_insert_mode', 'filtertag'),
      '#options' => array('filtertag' => t('Filter Tag'), 'html' => t('HTML Code')),
    );
    $form[] = array('#value' => '</div>');
  }
  else {
    $form['insertmode'] = array(
      '#type' => 'hidden',
      '#value' => variable_get('img_assist_default_insert_mode', 'filtertag'),
    );
  }
  
  // Hidden Fields.
  $form['nid'] = array(
    '#type' => 'hidden',
    '#value' => $node->nid,
  );
  $form['update'] = array(
    '#type' => 'hidden',
    '#value' => $update,
  );
  $form['aspect'] = array(
    '#type' => 'hidden',
    '#value' => $aspect_ratio,
  );
  
  // Buttons.
  $form['buttons'] = array(
    '#prefix' => '<div id="buttons">',
    '#suffix' => '</div>',
  );
  $form['#attributes']['onsubmit'] = 'return parent.insertImage();';
  $form['buttons']['insert'] = array(
    '#type' => 'submit',
    '#value' => ($update) ? t('Update') : t('Insert'),
    '#attributes' => array('style' => 'float: left;'),
  );
  $form['buttons']['cancel'] = array(
    '#type' => 'button',
    '#value' => t('Cancel'),
    '#button_type' => 'button',
    '#attributes' => array('onclick' => 'return parent.cancelAction();', 'style' => 'float: right;'),
  );
  
  $form[] = array('#value' => '</td></tr></table></div>');
  
  $form['#attributes']['name'] = 'img_assist';
  return $form;
}

function img_assist_properties_form_validate($form, &$form_state) {
  $html = img_assist_render_image($form_state['values']);
  img_assist_set_htmlcode($html);
  drupal_goto('img_assist/insert_html');
}

/**
 * Store image tag or HTML in session.
 *
 * Used for saving HTML code so it can be inserted instead of the filter tags.
 *
 * @param string $htmlcode
 *   A filter tag or HTML code. If omitted, session variable is emptied.
 *
 * @return string
 *   A previously stored value in the user session.
 */
function img_assist_set_htmlcode($htmlcode = NULL) {
  if (isset($htmlcode)) {
    $_SESSION['htmlcode'] = urlencode($htmlcode);
  }
  else {
    $html = urldecode($_SESSION['htmlcode']);
    $_SESSION['htmlcode'] = '';
    return $html;
  }
}

function img_assist_insert_html() {
  $output = drupal_get_form('img_assist_insert_html_form');
  echo theme('img_assist_page', $output, array('id' => 'img_assist_insert_html', 'onload' => 'parent.insertImage();', 'class' => 'img_assist'));
}

function img_assist_insert_html_form() {
  $htmlcode = img_assist_set_htmlcode();
  $form[] = array(
    '#id' => 'finalhtmlcode',
    '#type' => 'hidden',
    '#value' => $htmlcode,
  );
  
  $form['insertmode'] = array(
    '#type' => 'hidden',
    '#value' => 'html2',
  );
  
  return $form;
}

/**
 * @} End of "defgroup img_assist_pages".
 */

/**
 * @defgroup img_assist_image Image Assist Image Generation
 * @{
 * Functions used in image.module vs. img_assist.module (simplified):
 *
 * image.module:
 * - image_display()
 *   - is called for galleries, image nodes, image blocks, etc
 *     (everytime in image is shown)
 *   - returns <span ...><img ...></span>
 *   - can be passed a specific standard size only
 *   - may call _image_build_derivatives()
 *   - calls theme_image() to create the <img> tag
 * _image_build_derivatives()
 *   - rebuilds all standard image sizes for a particular node
 *
 * img_assist.module: (more complicated, but more flexible)
 * - image_display()
 *   - is called for thumbnails browsing, inline images, etc (everytime in image is shown)
 *   - returns <span ...><img ...></span>
 *   - can be passed EITHER a specific standard size only OR a custom size
 *   - may call _image_build_derivatives()
 *   - calls theme_image() to create the <img> tag
 * _image_build_derivatives()
 *   - rebuilds only a specfic image size (standard or custom size)
 */

/**
 * Create an IMG tag for an image.
 * 
 * This is nearly identical to image_display, but
 * - it uses a more efficient regenerate images routine
 * - the size attribute can be a custom size OR a standard size
 */
function img_assist_display(&$node, $size = NULL, $attributes = array()) {
  // Custom size should include values for label, width, and height.
  if (is_array($size) && !empty($size['key']) && !empty($size['width']) && !empty($size['height'])) {
    $label = $size['key'];
  }
  // Standard size.
  elseif ($size) {
    // Size can be an array without the width and/or height.
    if (is_array($size)) {
      // Size is no longer an array.
      $size = $size['key'];
    }
    $label = $size;
  }
  // Assign preview size if no size specified.
  else {
    $label = IMAGE_THUMBNAIL;
  }
  
  // Regenerate images if necessary.
  $regen = FALSE;
  if (!isset($node->images[$label])) {
    $regen = TRUE;
  }
  elseif (!is_file(file_create_path($node->images[$label]))) {
    $regen = TRUE;
  }
  elseif (filemtime(file_create_path($node->images[$label])) < variable_get('image_updated', 0)) {
    $regen = TRUE;
  }
  else {
    // If $size is not an array, try to find the corresponding predefined size.
    // _image_build_derivatives() blindly assigns the *original* image file to
    // all derivative image sizes that are smaller than the original image size.
    // Without re-assigning the actual derivative size definition, img_assist
    // would assume that this derivative size does not exist, delete the
    // *original* file and subsequently fail to generate derivative images.
    // Also, when one predefined size has changed, the derivative sizes need to
    // be updated.
    if (!is_array($size)) {
      foreach (image_get_sizes() as $std_size) {
        if (isset($std_size['key']) && $std_size['key'] == $label) {
          $size = $std_size;
          break;
        }
      }
    }
    if (is_array($size)) {
      $info = image_get_info(file_create_path($node->images[$label]));
      if (($info['width'] != $size['width']) && ($info['height'] != $size['height'])) {
        $regen = TRUE;
      }
    }
  }
  
  if ($regen) {
    _img_assist_build_derivatives($node, $size);
  }
  
  return image_display($node, $label);
}

/**
 * Generate a image derivative
 *
 * @see _image_build_derivatives() in image.module
 * 
 * @param $node
 * @param $size
 *   An array containing the keys 'label', 'width', 'height'.
 */
function _img_assist_build_derivatives(&$node, $size = NULL) {
  // Verify the image module and toolkit settings.
  if (!_image_check_settings()) {
    return FALSE;
  }
  $info = image_get_info(file_create_path($node->images[IMAGE_ORIGINAL]));
  
  // Custom size.
  if (is_array($size) && !empty($size['key']) && !empty($size['width']) && !empty($size['height'])) {
    $sizes = array($size['key'] => $size);
  }
  // Standard size.
  elseif ($size) {
    // Size can be an array without the width and/or height.
    if (is_array($size)) {
      $size = $size['key'];
    }
    $sizes = image_get_sizes();
    $sizes = array($size => $sizes[$size]);
  }
  // No size given: rebuild derivatives for all standard sizes.
  else {
    $sizes = image_get_sizes();
  }
  
  foreach ($sizes as $key => $size) {
    $size['key'] = $key;
    _img_assist_remove($node, $size);
    
    if (is_array($size) && ($size['label']) && ($size['width']) && ($size['height'])) {
      if ($info['width'] > $size['width'] || $info['height'] > $size['height']) {
        $source = file_create_path($node->images[IMAGE_ORIGINAL]);
        $destination = _image_filename(basename($source), $key, FALSE);
        $destination_path = file_create_path($destination);
        if (!image_scale($source, $destination_path, $size['width'], $size['height'])) {
          drupal_set_message(t('Unable to create %label image', array('%label' => $size['label'])), 'error');
        }
        else {
          // Set default file permissions for webserver-generated files.
          @chmod($destination_path, 0664);
          $node->images[$key] = $destination;
          _image_insert($node, $key, $destination_path);
        }
      }
      else {
        $node->images[$key] = $node->images[IMAGE_ORIGINAL];
      }
    }
  }
}

function _img_assist_remove($node, $size) {
  $result = db_query("SELECT * FROM {files} f INNER JOIN {image} i ON f.fid = i.fid WHERE i.nid = %d AND f.filename = '%s'", $node->nid, $size['key']);
  while ($file = db_fetch_object($result)) {
    // Never delete original image.
    if ($file->filepath != $node->images[IMAGE_ORIGINAL]) {
      // Delete image file.
      file_delete(file_create_path($file->filepath));
      // Delete file reference in database.
      db_query("DELETE FROM {files} WHERE fid = %d AND filename = '%s'", $file->fid, $size['key']);
      db_query("DELETE FROM {image} WHERE nid = %d AND fid = '%d'", $node->nid, $file->fid);
    }
  }
}

/**
 * Return image HTML.
 */
function img_assist_render_image($attributes = array()) {
  global $user;
  
  if ($attributes['nid']) {
    $node = node_load($attributes['nid']);

    // Get image size.
    $width  = (int) $attributes['width'];
    $height = (int) $attributes['height'];
    $default_sizes = image_get_sizes();
    if ($width || $height) {
      // Check to ensure that the dimensions don't exceed the max set in the