home | career | drupal | java | mac | mysql | perl | php | scala | uml | unix

Drupal example source code file (image.module)

This example Drupal source code file (image.module) is included in the DevDaily.com "Drupal Source Code Warehouse" project. The intent of this project is to help you "Learn Drupal by Example".

PHP - Drupal tags/keywords

array, directory, empty, file, foreach, function, if, image, images, key, node, php, return, size

The image.module Drupal example source code

<?php
// $Id: image.module,v 1.322.2.4 2010/08/18 16:40:06 joachim Exp $

define('IMAGE_ORIGINAL', '_original');
define('IMAGE_PREVIEW', 'preview');
define('IMAGE_THUMBNAIL', 'thumbnail');

define('IMAGE_LINK_HIDDEN', 0);
define('IMAGE_LINK_SHOWN', 1);
define('IMAGE_LINK_NEW', 2);

/**
 * Implementation of hook_help().
 */
function image_help($path, $arg) {
  switch ($path) {
    case 'admin/help#image':
      $output = '<p>' . t('The Image module is used to create and administer images for your site. Each image is stored as a post, with thumbnails of the original generated automatically. There are two default derivative image sizes, "thumbnail" and "preview". The "thumbnail" size is shown as preview image in posts and when browsing image galleries. The "preview" size is the default size when viewing an image node page.') . '</p>';
      $output .= '<p>' . t('The settings page for Image module allows the image directory and the image sizes to be configured.') . '</p>';
      $output .= '<p>' . t('Image module ships with contributed modules. Their settings can be accessed from the image settings page.') . '</p>';
      $output .= '<ul>';
      $output .= '<li>' . t('Image attach is used to add an existing or new image to a node. The selected image will show up in a predefined spot on the selected node.') . '</li>';
      $output .= '<li>' . t('Image gallery is used to organize and display images in galleries. The list tab allows users to edit existing image gallery names, descriptions, parents and relative position, known as a weight. The add galleries tab allows you to create a new image gallery defining name, description, parent and weight. If the <a href="@views-url">Views module</a> is installed, then the Image gallery module settings are mostly replaced by settings of the view.', array('@views-url' => 'http://drupal.org/project/views')) . '</li>';
      $output .= '<li>' . t('Image import is used to import batches of images. The administration page lets you define the folder from which images will be imported.') . '</li>';
      $output .= '<li>' . t('The separate <a href="@img-assist-url">Image assist module</a> can be installed to upload and insert images into posts.', array('@img-assist-url' => 'http://drupal.org/project/img_assist')) . '</li>';
      $output .= '</ul>';
      $output .= '<p>' . t('You can:') . '</p>';
      $output .= '<ul>';
      $output .= '<li>' . t('Configure image sizes and file directories at <a href="@image-settings-url">Administer » Site configuration » Image</a>.', array('@image-settings-url' => url('admin/settings/image'))) . '</li>';
      $output .= '</ul>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@image-url">Image module</a>.', array('@image-url' => 'http://drupal.org/handbook/modules/image')) . '</p>';
      return $output;
  }
}

/**
 * Implementation of hook_theme().
 */
function image_theme() {
  return array(
    'image_settings_sizes_form' => array(
      'arguments' => array('form' => NULL),
    ),
    'image_teaser' => array(
      'arguments' => array('node' => NULL, 'size' => IMAGE_THUMBNAIL),
    ),
    'image_body' => array(
      'arguments' => array('node' => NULL, 'size' => IMAGE_PREVIEW),
    ),
    'image_block_random' => array(
      'arguments' => array('images' => NULL, 'size' => IMAGE_THUMBNAIL),
    ),
    'image_block_latest' => array(
      'arguments' => array('images' => NULL, 'size' => IMAGE_THUMBNAIL),
    ),
    'image_display' => array(
      'arguments' => array(
        'node' => NULL,
        'label' => NULL,
        'url' => NULL,
        'attributes' => NULL,
      ),
    ),
  );
}

/**
 * Implementation of hook_node_info
 */
function image_node_info() {
  return array(
    'image' => array(
      'name' => t('Image'),
      'module' => 'image',
      'description' => t('An image (with thumbnail). This is ideal for publishing photographs or screenshots.'),
    ),
  );
}

/**
 * Implementation of hook_perm
 */
function image_perm() {
  return array('view original images', 'create images', 'edit own images', 'edit any images', 'delete own images', 'delete any images');
}

/**
 * Implementation of hook_access().
 */
function image_access($op, $node, $account) {
  switch ($op) {
    case 'create':
      if (user_access('create images', $account)) {
        return TRUE;
      }
      break;

    case 'update':
      if (user_access('edit any images', $account) || ($account->uid == $node->uid && user_access('edit own images', $account))) {
        return TRUE;
      }
      break;

    case 'delete':
      if (user_access('delete any images', $account) || ($account->uid == $node->uid && user_access('delete own images', $account))) {
        return TRUE;
      }
      break;
  }
}

/**
 * Implementation of hook_menu
 */
function image_menu() {
  $items = array();

  $items['image/view'] = array(
    'title' => 'image',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
    'page callback' => 'image_fetch',
  );
  $items['admin/settings/image'] = array(
    'title' => 'Images',
    'description' => 'Configure the location of image files and image sizes. Also, if enabled, configure image attachments and options for image galleries and image imports.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('image_admin_settings'),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_NORMAL_ITEM,
    'file' => 'image.admin.inc',
  );
  $items['admin/settings/image/nodes'] = array(
    'title' => 'Files and sizes',
    'description' => 'Configure the location of image files and image sizes.',
    'access arguments' => array('administer site configuration'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => '-10',
  );

  return $items;
}

/**
 * Implements hook_cron. (deletes old temp images)
 */
function image_cron() {
  $path = file_directory_path() . '/' . variable_get('image_default_path', 'images') . '/temp';
  $files = file_scan_directory(file_create_path($path), '.*');
  foreach ($files as $file => $info) {
    if (time() - filemtime($file) > 60 * 60 * 6) {
      file_delete($file);
    }
  }
}

/**
 * Implementation of hook_node_operations().
 */
function image_node_operations() {
  $operations = array(
    'rebuild_thumbs' => array(
      'label' => t('Rebuild derivative images'),
      'callback' => 'image_operations_rebuild',
    ),
  );
  return $operations;
}

function image_operations_rebuild($nids) {
  foreach ($nids as $nid) {
    if ($node = node_load($nid)) {
      if ($node->type == 'image') {
        $node->rebuild_images = TRUE;
        image_update($node);
      }
    }
  }
}

/**
 * Implementation of hook_file_download().
 *
 * Note that in Drupal 5, the upload.module's hook_file_download() checks its
 * permissions for all files in the {files} table. We store our file
 * information in {files} if private files transfers are selected and the
 * upload.module is enabled, users will the 'view uploaded files' permission to
 * view images.
 */
function image_file_download($filename) {
  $filepath = file_create_path($filename);
  $result = db_query("SELECT i.nid, f.filemime, f.filesize FROM {image} i INNER JOIN {files} f ON i.fid = f.fid WHERE f.filepath = '%s'", $filepath);
  if ($file = db_fetch_object($result)) {
    $node = node_load(array('type' => 'image', 'nid' => $file->nid));
    if (node_access('view', $node)) {
      // The user either needs to have 'view original images' permission or
      // the path must be listed for something other than the node's original
      // size. This will be the case when the orignal is smaller than a
      // derivative size.
      $images = (array) $node->images;
      unset($images[IMAGE_ORIGINAL]);
      if (user_access('view original images') || in_array($filepath, $images)) {
        return array(
          'Content-Type: ' . mime_header_encode($file->filemime),
          'Content-Length: ' . (int) $file->filesize,
        );
      }
    }
    return -1;
  }
}

/**
 * Implementation of hook_link.
 */
function image_link($type, $node, $main = 0) {
  $links = array();

  if ($type == 'node' && $node->type == 'image' && !$main) {
    $request = isset($_GET['size']) ? $_GET['size'] : IMAGE_PREVIEW;
    foreach (image_get_sizes() as $key => $size) {
      if ($size['link']) {
        // For smaller images some derivative images may not have been created.
        // The thumbnail and preview images will be equal to the original images
        // but other sizes will not be set.
        if (isset($node->images[$key]) && $node->images[$key] != $node->images[$request]) {
          if ($size['link'] == IMAGE_LINK_NEW) {
            $links['image_size_' . $key] = array(
              'title' => t($size['label']),
              'href' => "image/view/{$node->nid}/$key",
              'attributes' => array('target' => '_blank'),
            );
          }
          else {
            $links['image_size_' . $key] = array(
              'title' => t($size['label']),
              'href' => 'node/' . $node->nid,
              'query' => 'size=' . urlencode($key),
            );
          }
        }
      }
    }
    if (!user_access('view original images')) {
      unset($links['image_size_' . IMAGE_ORIGINAL]);
    }
  }

  return $links;
}

/**
 * Implementation of hook_block.
 *
 * Offers 2 blocks: latest image and random image
 */
function image_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
      $block[0]['info'] = t('Latest image');
      $block[1]['info'] = t('Random image');
      return $block;

    case 'configure':
      $form['number_images'] = array(
        '#type' => 'select',
        '#title' => t('Number of images to display'),
        '#options' => drupal_map_assoc(range(1, 99)),
        '#default_value' => variable_get("image_block_{$delta}_number_images", 1),
      );
      return $form;

    case 'view':
      if (user_access('access content')) {
        switch ($delta) {
          case 0:
            $images = image_get_latest(variable_get("image_block_{$delta}_number_images", 1));
            $block['subject'] = t('Latest image');
            $block['content'] = theme('image_block_latest', $images, IMAGE_THUMBNAIL);
            break;

          case 1:
            $images = image_get_random(variable_get("image_block_{$delta}_number_images", 1));
            $block['subject'] = t('Random image');
            $block['content'] = theme('image_block_random', $images, IMAGE_THUMBNAIL);
            break;
        }
      }
      return $block;

    case 'save':
      variable_set("image_block_{$delta}_number_images", $edit['number_images']);
      break;
  }
}

function image_form_add_thumbnail($form, &$form_state) {
  if ($form_state['values']['images'][IMAGE_THUMBNAIL]) {
    $node = (object)($form_state['values']);
    $form['#title'] = t('Thumbnail');
    $form['#value'] = image_display($node, IMAGE_THUMBNAIL);
  }
  return $form;
}

/**
 * Implementation of hook_form().
 */
function image_form(&$node, $form_state) {
  _image_check_settings();

  if (!$_POST && !empty($_SESSION['image_upload'])) {
    unset($_SESSION['image_upload']);
  }

  $type = node_get_types('type', $node);

  $form['#validate'][] = 'image_form_validate';
  $form['#submit'][] = 'image_form_submit';

  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => check_plain($type->title_label),
    '#size' => 60,
    '#maxlength' => 128,
    '#required' => TRUE,
    '#default_value' => $node->title,
  );

  $form['images']['#tree'] = TRUE;
  foreach (image_get_sizes() as $key => $size) {
    $form['images'][$key] = array(
      '#type' => 'value',
      '#value' => isset($node->images[$key]) ? $node->images[$key] : '',
    );
  }

  $form['new_file'] = array(
    '#type' => 'value',
    '#default_value' => isset($node->new_file) ? $node->new_file : FALSE,
  );

  $form['#attributes'] = array('enctype' => 'multipart/form-data');

  $form['image'] = array(
    '#prefix' => '<div class="image-field-wrapper">',
    '#suffix' => '</div>',
  );
  $form['image']['thumbnail'] = array(
    '#type' => 'item',
    '#after_build' => array('image_form_add_thumbnail'),
  );
  $form['image']['image'] = array(
    '#type' => 'file',
    '#title' => t('Image'),
    '#size' => 40,
    '#description' => t('Select an image to upload.'),
  );
  $form['image']['rebuild_images'] = array(
    '#type' => 'checkbox',
    '#title' => t('Rebuild derivative images'),
    '#default_value' => FALSE,
    '#description' => t('Check this to rebuild the derivative images for this node.'),
    '#access' => (!isset($node->nid) ? FALSE : TRUE),
  );

  if ($type->has_body) {
    $form['body_field'] = node_body_field($node, $type->body_label, $type->min_word_count);
  }

  return $form;
}

function image_form_validate($form, &$form_state) {
  // Avoid blocking node deletion with missing image.
  if ($form_state['values']['op'] == t('Delete')) {
    return;
  }

  // Validators for file_save_upload().
  $validators = array(
    'file_validate_is_image' => array(),
  );

  // New image uploads need to be saved in images/temp in order to be viewable
  // during node preview.
  $temporary_file_path = file_create_path(file_directory_path() . '/' . variable_get('image_default_path', 'images') . '/temp');

  if ($file = file_save_upload('image', $validators, $temporary_file_path)) {
    // Resize the original.
    $image_info = image_get_info($file->filepath);
    $aspect_ratio = $image_info['height'] / $image_info['width'];
    $original_size = image_get_sizes(IMAGE_ORIGINAL, $aspect_ratio);
    if (!empty($original_size['width']) && !empty($original_size['height'])) {
      $result = image_scale($file->filepath, $file->filepath, $original_size['width'], $original_size['height']);
      if ($result) {
        clearstatcache();
        $file->filesize = filesize($file->filepath);
        drupal_set_message(t('The original image was resized to fit within the maximum allowed resolution of %width x %height pixels.', array('%width' => $original_size['width'], '%height' => $original_size['height'])));
      }
    }

    // Check the file size limit.
    if ($file->filesize > variable_get('image_max_upload_size', 800) * 1024) {
      form_set_error('image', t('The image you uploaded was too big. You are only allowed upload files less than %max_size but your file was %file_size.', array('%max_size' => format_size(variable_get('image_max_upload_size', 800) * 1024), '%file_size' => format_size($file->filesize))));
      file_delete($file->filepath);
      return;
    }

    // We're good to go.
    $form_state['values']['images'][IMAGE_ORIGINAL] = $file->filepath;
    $form_state['values']['rebuild_images'] = FALSE;
    $form_state['values']['new_file'] = TRUE;

    // Call hook to allow other modules to modify the original image.
    module_invoke_all('image_alter', $form_state['values'], $form_state['values']['images'][IMAGE_ORIGINAL], IMAGE_ORIGINAL);
    $form_state['values']['images'] = _image_build_derivatives((object) $form_state['values'], TRUE);

    // Store the new file into the session.
    $_SESSION['image_upload'] = $form_state['values']['images'];
  }
  elseif (empty($form_state['values']['images'][IMAGE_ORIGINAL])) {
    if (empty($_SESSION['image_upload'])) {
      form_set_error('image', t('You must upload an image.'));
    }
  }
}

function image_form_submit($form, &$form_state) {
  if (!empty($_SESSION['image_upload'])) {
    $form_state['values']['images'] = $_SESSION['image_upload'];
    $form_state['values']['new_file'] = TRUE;
    unset($_SESSION['image_upload']);
  }
}

/**
 * Implementation of hook_view
 */
function image_view($node, $teaser = 0, $page = 0) {
  $sizes = image_get_sizes();
  $size = IMAGE_PREVIEW;
  if (isset($_GET['size'])) {
    // Invalid size specified.
    if (!isset($sizes[$_GET['size']])) {
      drupal_goto("node/$node->nid");
    }
    $size = $_GET['size'];
    // Not allowed to view the original.
    if ($size == IMAGE_ORIGINAL && !user_access('view original images')) {
      drupal_goto("node/$node->nid");
    }
  }

  $node = node_prepare($node, $teaser);
  $node->content['image'] = array(
    '#value' => theme($teaser ? 'image_teaser' : 'image_body', $node, $size),
    '#weight' => 0,
  );

  return $node;
}

/**
 * Implementation of hook_load().
 */
function image_load(&$node) {
  $result = db_query("SELECT i.image_size, f.filepath FROM {image} i INNER JOIN {files} f ON i.fid = f.fid WHERE i.nid = %d", $node->nid);
  $node->images = array();
  while ($file = db_fetch_object($result)) {
    $node->images[$file->image_size] = file_create_path($file->filepath);
  }

  $original_path = (isset($node->images[IMAGE_ORIGINAL]) ? $node->images[IMAGE_ORIGINAL] : NULL);
  if (empty($original_path)) {
    // There's no original image, we're in trouble...
    return;
  }

  if ((arg(0) != 'batch') && (strpos($_GET['q'], 'admin/content/node') === FALSE)) {
    _image_build_derivatives_if_needed($node);
  }
}

/**
 * Rebuild derivatives if needed. Helper function for image_load().
 */
function _image_build_derivatives_if_needed(&$node) {
  $node->rebuild_images = FALSE;

  // Figure out which sizes should have been generated.
  $all_sizes = image_get_sizes();
  unset($all_sizes[IMAGE_ORIGINAL]);
  $needed_sizes = array_keys(image_get_derivative_sizes($node->images[IMAGE_ORIGINAL]));
  $unneeded_sizes = array_diff(array_keys($all_sizes), $needed_sizes);

  // Derivative sizes that are larger than the original get set to the
  // original.
  foreach ($unneeded_sizes as $key) {
    if (empty($node->images[$key])) {
      $node->images[$key] = $node->images[IMAGE_ORIGINAL];
    }
    else {
      // Need to remove an extra derivative image in the database.
      $node->rebuild_images = TRUE;
    }
  }

  // Check that the derivative images are present and current.
  foreach ($needed_sizes as $key) {
    // If the file is missing or created after the last change to the sizes,
    // rebuild the derivatives.
    if (empty($node->images[$key]) || !file_exists($node->images[$key])) {
      $node->rebuild_images = TRUE;
    }
    // Derivative image had a timestamp that predates last changes to image
    // size settings, so it needs to be rebuilt.
    elseif (filemtime($node->images[$key]) < variable_get('image_updated', 0)) {
      $node->rebuild_images = TRUE;
    }
  }

  // Correct any problems with the derivative images.
  if ($node->rebuild_images) {
    // Possibly TODO: calling a hook implementation here isn't very elegant.
    // but the code there is tangled and it works, so maybe leave it ;)
    image_update($node);
    watchdog('image', 'Derivative images were regenerated for %title.', array('%title' => $node->title), WATCHDOG_INFO, l(t('view'), 'node/' . $node->nid));
  }
}

/**
 * Implementation of hook_insert().
 */
function image_insert($node) {
  // If a new image node contains no new file, but has a translation source,
  // insert all images from the source for this node.
  if (empty($node->new_file) && !empty($node->translation_source)) {
    db_query("INSERT INTO {image} (nid, fid, image_size) SELECT %d, fid, image_size FROM {image} WHERE nid = %d", $node->nid, $node->translation_source->nid);
    return;
  }

  // Derivative images that aren't needed are set to the original file. Make
  // note of the current path before calling _image_insert() because if it's
  // in the temp directory it'll be moved. We'll need it later to determine
  // which derivative images need to be saved with _image_insert().
  $original_path = $node->images[IMAGE_ORIGINAL];

  // Save the original first so that it if it's moved the derivatives are
  // placed in the correct directory.
  _image_insert($node, IMAGE_ORIGINAL, $original_path);

  $sizes = image_get_derivative_sizes($node->images[IMAGE_ORIGINAL]);
  foreach ($sizes as $key => $size_info) {
    if (!empty($node->images[$key]) && $node->images[$key] != $original_path) {
      _image_insert($node, $key, $node->images[$key]);
    }
  }
}

/**
 * Implementation of hook_update().
 *
 * Take $node by reference so we can use this to save the node after
 * rebuilding derivatives.
 */
function image_update(&$node) {
  if (!empty($node->new_file) || !empty($node->rebuild_images)) {
    // Derivative images that aren't needed are set to the original file. Make
    // note of the current path before calling _image_insert() because if it's
    // in the temp directory it'll be moved. We'll need it later to determine
    // which derivative images need to be saved with _image_insert().
    $original_path = $node->images[IMAGE_ORIGINAL];

    if (!empty($node->new_file)) {
      // The derivative images were built during image_prepare() or
      // image_create_node_from() so all we need to do is remove all the old,
      // existing images.

      // Remove all the existing images.
      $result = db_query("SELECT f.fid, f.filepath FROM {image} i INNER JOIN {files} f ON i.fid = f.fid WHERE i.nid = %d", $node->nid);
      while ($file = db_fetch_object($result)) {
        db_query("DELETE FROM {image} WHERE nid = %d AND fid = %d", $node->nid, $file->fid);
        _image_file_remove($file);
      }

      // Save the original first so that it if it's moved the derivatives are
      // placed in the correct directory.
      _image_insert($node, IMAGE_ORIGINAL, $original_path);
    }
    else if (!empty($node->rebuild_images)) {
      // Find the original image.
      $original_file = db_fetch_object(db_query("SELECT i.fid, f.filepath FROM {image} i INNER JOIN {files} f ON i.fid = f.fid WHERE i.nid = %d AND i.image_size = '%s'", $node->nid, IMAGE_ORIGINAL));

      // Delete all but the original image.
      $result = db_query("SELECT i.fid, f.filepath FROM {image} i INNER JOIN {files} f ON i.fid = f.fid WHERE i.nid = %d AND f.fid <> %d", $node->nid, $original_file->fid);
      while ($file = db_fetch_object($result)) {
        db_query("DELETE FROM {image} WHERE nid = %d AND fid = %d", $node->nid, $file->fid);
        // Beware of derivative images that have the same path as the original.
        if ($file->filepath != $original_file->filepath) {
          _image_file_remove($file);
        }
      }

      $node->images = _image_build_derivatives($node, FALSE);

      // Prevent multiple rebuilds.
      $node->rebuild_images = FALSE;
    }

    $sizes = image_get_derivative_sizes($node->images[IMAGE_ORIGINAL]);
    foreach ($sizes as $key => $size_info) {
      if (!empty($node->images[$key]) && $node->images[$key] != $original_path) {
        _image_insert($node, $key, $node->images[$key]);
      }
    }
  }
}

/**
 * Implementation of hook_delete().
 */
function image_delete($node) {
  $result = db_query('SELECT i.fid, f.filepath FROM {image} i INNER JOIN {files} f ON i.fid = f.fid WHERE i.nid = %d', $node->nid);
  while ($file = db_fetch_object($result)) {
    db_query("DELETE FROM {image} WHERE nid = %d AND fid = %d", $node->nid, $file->fid);
    _image_file_remove($file);
  }
}

/**
 * Create an <img> tag for an image.
 */
function image_display(&$node, $label = IMAGE_PREVIEW, $attributes = array()) {
  if (empty($node->images[$label])) {
    return;
  }

  $image_info = image_get_info(file_create_path($node->images[$label]));
  $attributes['class'] = "image image-$label " . (isset($attributes['class']) ? $attributes['class'] : "");
  // Only output width/height attributes if image_get_info() was able to detect
  // the image dimensions, since certain browsers interpret an empty attribute
  // value as zero.
  if (!empty($image_info['width'])) {
    $attributes['width'] = $image_info['width'];
  }
  if (!empty($image_info['height'])) {
    $attributes['height'] = $image_info['height'];
  }

  return theme('image_display', $node, $label, file_create_url($node->images[$label]), $attributes);
}

/**
 * Fetches an image file, allows "shorthand" image urls such of the form:
 * image/view/$nid/$label
 * (e.g. image/view/25/thumbnail or image/view/14)
 */
function image_fetch($nid = 0, $size = IMAGE_PREVIEW) {
  if ($size == IMAGE_ORIGINAL && !user_access('view original images')) {
    return drupal_access_denied();
  }

  if (isset($nid)) {
    $node = node_load(array('type' => 'image', 'nid' => $nid));
    if ($node) {
      if (!node_access('view', $node)) {
        return drupal_access_denied();
      }

      if (isset($node->images[$size])) {
        $file = $node->images[$size];
        $headers = module_invoke_all('file_download', $file);
        if ($headers == -1) {
          return drupal_access_denied();
        }
        file_transfer($file, $headers);
      }
    }
  }
  return drupal_not_found();
}

/**
 * Theme a teaser
 */
function theme_image_teaser($node, $size) {
  return l(image_display($node, IMAGE_THUMBNAIL), 'node/' . $node->nid, array('html' => TRUE));
}

/**
 * Theme a body
 */
function theme_image_body($node, $size) {
  return image_display($node, $size);
}

/**
 * Theme an img tag for displaying the image.
 */
function theme_image_display($node, $label, $url, $attributes) {
  $title = isset($attributes['title']) ? $attributes['title'] : $node->title;
  $alt = isset($attributes['alt']) ? $attributes['alt'] : $node->title;
  // Remove alt and title from $attributes, otherwise they get added to the img tag twice.
  unset($attributes['title']);
  unset($attributes['alt']);
  return theme('image', $url, $alt, $title, $attributes, FALSE);
}

/**
 * Theme a random block
 */
function theme_image_block_random($images, $size) {
  $output = '';
  foreach ($images as $image) {
    $output .= l(image_display($image, $size), 'node/' . $image->nid, array('html' => TRUE));
  }
  return $output;
}

/**
 * Theme a latest block
 */
function theme_image_block_latest($images, $size) {
  $output = '';
  foreach ($images as $image) {
    $output .= l(image_display($image, $size), 'node/' . $image->nid, array('html' => TRUE));
  }
  return $output;
}

/**
 * Fetch a random N image(s) - optionally from a given term.
 */
function image_get_random($count = 1, $tid = 0) {
  if ($tid != 0) {
    $result = db_query_range(db_rewrite_sql("SELECT DISTINCT(n.nid), RAND() AS rand FROM {term_node} tn LEFT JOIN {node} n ON n.nid = tn.nid WHERE n.type='image' AND n.status = 1 AND tn.tid = %d ORDER BY rand"), $tid, 0, $count);
  }
  else {
    $result = db_query_range(db_rewrite_sql("SELECT DISTINCT(n.nid), RAND() AS rand FROM {node} n WHERE n.type = 'image' AND n.status = 1 ORDER BY rand"), 0, $count);
  }
  $output = array();
  while ($nid = db_fetch_object($result)) {
    $output[] = node_load(array('nid' => $nid->nid));
  }
  return $output;
}

/**
 * Fetch the latest N image(s) - optionally from a given term.
 */
function image_get_latest($count = 1, $tid = 0) {
  if ($tid != 0) {
    $result = db_query_range(db_rewrite_sql("SELECT n.nid FROM {term_node} tn LEFT JOIN {node} n ON n.nid=tn.nid WHERE n.type='image' AND n.status=1 AND tn.tid=%d ORDER BY n.changed DESC"), $tid, 0, $count);
  }
  else {
    $result = db_query_range(db_rewrite_sql("SELECT n.nid FROM {node} n WHERE n.type = 'image' AND n.status = 1 ORDER BY n.changed DESC"), 0, $count);
  }
  $output = array();
  while ($nid = db_fetch_object($result)) {
    $output[] = node_load(array('nid' => $nid->nid));
  }
  return $output;
}

/**
 * Verify the image module and toolkit settings.
 */
function _image_check_settings() {
  // File paths
  $image_path = file_create_path(file_directory_path() . '/' . variable_get('image_default_path', 'images'));
  $temp_path = $image_path . '/temp';

  if (!file_check_directory($image_path, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS, 'image_default_path')) {
    return FALSE;
  }
  if (!file_check_directory($temp_path, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS, 'image_default_path')) {
    return FALSE;
  }

  // Sanity check : make sure we've got a working toolkit
  if (!image_get_toolkit()) {
    drupal_set_message(t('No image toolkit is currently enabled. Without one the image module will not be able to resize your images. You can select one from the <a href="@link">image toolkit settings page</a>.', array('@link' => url('admin/settings/image-toolkit'))), 'error');
    return FALSE;
  }
  return TRUE;
}

/**
 * Determine which sizes of derivative images need to be built for this image.
 *
 * @param $image_path
 *   String file path to the image.
 *
 * @return
 *   Returns a subset of image_get_sizes()'s results depending on what
 *   derivative images are needed.
 */
function image_get_derivative_sizes($image_path) {
  $sizes = array();

  // Can't do much if we can't read the image.
  if (!$image_info = image_get_info($image_path)) {
    return $sizes;
  }

  $all_sizes = image_get_sizes(NULL, $image_info['height'] / $image_info['width']);
  foreach ($all_sizes as $key => $size) {
    // We don't want to include the original.
    if ($key == IMAGE_ORIGINAL) {
      continue;
    }

    // If the original isn't bigger than the requested size then there's no
    // need to resize it.
    if ($image_info['width'] > $size['width'] || $image_info['height'] > $size['height']) {
      $sizes[$key] = $size;
    }
  }

  return $sizes;
}

/**
 * Generate image derivatives.
 *
 * @param $node
 *   The node.
 * @param $temp
 *   Boolean indicating if the derivatives should be saved to the temp
 *   directory.
 *
 * @return
 *   New array of images for the node.
 */
function _image_build_derivatives($node, $temp = FALSE) {
  $original_path = file_create_path($node->images[IMAGE_ORIGINAL]);

  // Figure out which sizes we need to generate.
  $all_sizes      = image_get_sizes();
  $needed_sizes   = image_get_derivative_sizes($original_path);
  $unneeded_sizes = array_diff(array_keys($all_sizes), array_keys($needed_sizes));

  // Images that don't need a derivative image get set to the original.
  $images[IMAGE_ORIGINAL] = $original_path;
  foreach ($unneeded_sizes as $key) {
    $images[$key] = $original_path;
  }

  // Resize for the necessary sizes.
  $image_info = image_get_info($original_path);
  foreach ($needed_sizes as $key => $size) {
    $destination = _image_filename($original_path, $key, $temp);

    $status = FALSE;
    switch ($size['operation']) {
      // Depending on the operation, the image will be scaled or resized & cropped
      case 'scale':
        $status = image_scale($original_path, $destination, $size['width'], $size['height']);
        break;

      case 'scale_crop':
        $status = image_scale_and_crop($original_path, $destination, $size['width'], $size['height']);
        break;
    }

    if (!$status) {
      drupal_set_message(t('Unable to create scaled %label image.', array('%label' => $size['label'])), 'error');
      return FALSE;
    }
    // Set standard file permissions for webserver-generated files
    @chmod($destination, 0664);

    $images[$key] = $destination;
    module_invoke_all('image_alter', $node, $destination, $key);
  }

  return $images;
}

/**
 * Creates an image filename.
 *
 * @param $filepath
 *   The full path and filename of the original image file,relative to Drupal
 *   root, eg 'sites/default/files/images/myimage.jpg'.
 *
 * @return
 *   A full path and filename with derivative image label inserted if required.
 */
function _image_filename($filepath, $label = IMAGE_ORIGINAL, $temp = FALSE) {
  // Get default path for a new file.
  $path = file_directory_path() . '/' . variable_get('image_default_path', 'images');
  if ($temp) {
    $path .= '/temp';
  }

  $original_path = dirname($filepath);
  $filename = basename($filepath);

  if ($label && ($label != IMAGE_ORIGINAL)) {
    // Keep resized images in the same path, where original is (does not
    // apply to temporary files, these still use the default path).
    if (!$temp && $original_path != '.') {
      $path = $original_path;
    }
    // Insert the resized name in non-original images.
    $pos = strrpos($filename, '.');
    if ($pos === FALSE) {
      // The file had no extension - which happens in really old image.module
      // versions, so figure out the extension.
      $image_info = image_get_info(file_create_path($path . '/' . $filename));
      $filename = $filename . '.' . $label . '.' . $image_info['extension'];
    }
    else {
      $filename = substr($filename, 0, $pos) . '.' . $label . substr($filename, $pos);
    }
  }

  return file_create_path($path . '/' . $filename);
}

/**
 * Helper function to return the defined sizes (or proper defaults).
 *
 * @param $size
 *   An optional string to return only the image size with the specified key.
 * @param $aspect_ratio
 *   Float value with the ratio of image height / width. If a size has only one
 *   dimension provided this will be used to compute the other.
 *
 * @return
 *   An associative array with width, height, and label fields for the size.
 *   If a $size parameter was specified and it cannot be found FALSE will be
 *   returned.
 */
function image_get_sizes($size = NULL, $aspect_ratio = NULL) {
  $defaults = array(
    IMAGE_ORIGINAL => array('width' => '', 'height' => '', 'label' => t('Original'), 'operation' => 'scale', 'link' => IMAGE_LINK_SHOWN),
    IMAGE_THUMBNAIL => array('width' => 100, 'height' => 100, 'label' => t('Thumbnail'), 'operation' => 'scale', 'link' => IMAGE_LINK_SHOWN),
    IMAGE_PREVIEW => array('width' => 640, 'height' => 640, 'label' => t('Preview'), 'operation' => 'scale', 'link' => IMAGE_LINK_SHOWN),
  );

  $sizes = array();
  foreach (variable_get('image_sizes', $defaults) as $key => $val) {
    // Only return sizes with a label.
    if (!empty($val['label'])) {
      // For a size with only one dimension specified, compute the other
      // dimension based on an aspect ratio.
      if ($aspect_ratio && (empty($val['width']) || empty($val['height']))) {
        if (empty($val['height']) && !empty($val['width'])) {
          $val['height'] = (int)round($val['width'] * $aspect_ratio);
        }
        elseif (empty($val['width']) && !empty($val['height'])) {
          $val['width'] = (int)round($val['height'] / $aspect_ratio);
        }
      }
      $sizes[$key] = $val;
    }
  }

  // If they requested a specific size return only that.
  if (isset($size)) {
    // Only return an array if it's available.
    return isset($sizes[$size]) ? $sizes[$size] : FALSE;
  }

  return $sizes;
}

/**
 * Helper function to preserve backwards compatibility. This has been
 * deprecated in favor of image_get_sizes().
 *
 * @TODO: Remove this in a future version.
 */
function _image_get_sizes($size = NULL, $aspect_ratio = NULL) {
  return image_get_sizes($size, $aspect_ratio);
}

/**
 * Is a given size a built-in, required size?
 *
 * @param $size
 *   One of the keys in the array returned by image_get_sizes().
 *
 * @return boolean
 */
function _image_is_required_size($size) {
  return in_array($size, array(IMAGE_THUMBNAIL, IMAGE_PREVIEW, IMAGE_ORIGINAL));
}

/**
 * Moves temporary (working) images to the final directory and stores
 * relevant information in the files table
 */
function _image_insert(&$node, $size, $image_path) {
  $original_path = $node->images[IMAGE_ORIGINAL];
  if (file_move($image_path, _image_filename($original_path, $size))) {
    // Update the node to reflect the actual filename, it may have been changed
    // if a file of the same name already existed.
    $node->images[$size] = $image_path;

    $image_info = image_get_info($image_path);
    $file = array(
      'uid' => $node->uid,
      'filename' => $size,
      'filepath' => $image_path,
      'filemime' => $image_info['mime_type'],
      'filesize' => $image_info['file_size'],
      'status' => FILE_STATUS_PERMANENT,
      'timestamp' => time(),
    );
    drupal_write_record('files', $file);
    $image = array(
      'fid' => $file['fid'],
      'nid' => $node->nid,
      'image_size' => $size,
    );
    drupal_write_record('image', $image);
  }
}

/**
 * Remove image file if no other node references it.
 *
 * @param $file
 *   An object representing a table row from {files}.
 */
function _image_file_remove($file) {
  if (!db_result(db_query("SELECT COUNT(*) FROM {image} WHERE fid = %d", $file->fid))) {
    file_delete(file_create_path($file->filepath));
    db_query('DELETE FROM {files} WHERE fid = %d', $file->fid);
  }
}

/**
 * Function to other modules to use to create image nodes.
 *
 * @param $filepath
 *   String filepath of an image file. Note that this file will be moved into
 *   the image module's images directory.
 * @param $title
 *   String to be used as the node's title. If this is ommitted the filename
 *   will be used.
 * @param $body
 *   String to be used as the node's body.
 * @param $taxonomy
 *   Taxonomy terms to assign to the node if the taxonomy.module is installed.
 * @param $keep_original
 *   Boolean to indicate whether the original file should be deleted
 *
 * @return
 *   A node object if the node is created successfully or FALSE on error.
 */
function image_create_node_from($filepath, $title = NULL, $body = '', $taxonomy = NULL, $keep_original = FALSE) {
  global $user;

  if (!user_access('create images')) {
    return FALSE;
  }

  // Ensure it's a valid image.
  if (!$image_info = image_get_info($filepath)) {
    return FALSE;
  }

  // Ensure the file is within our size bounds.
  if ($image_info['file_size'] > variable_get('image_max_upload_size', 800) * 1024) {
    form_set_error('', t('The image you uploaded was too big. You are only allowed upload files less than %max_size but your file was %file_size.', array('%max_size' => format_size(variable_get('image_max_upload_size', 800) * 1024), '%file_size' => format_size($image_info['file_size']))), 'warning');
    return FALSE;
  }

  // Make sure we can copy the file into our temp directory.
  $original_path = $filepath;
  if (!file_copy($filepath, _image_filename($filepath, IMAGE_ORIGINAL, TRUE))) {
    return FALSE;
  }

  // Resize the original image.
  $aspect_ratio = $image_info['height'] / $image_info['width'];
  $size = image_get_sizes(IMAGE_ORIGINAL, $aspect_ratio);
  if (!empty($size['width']) && !empty($size['height'])) {
    image_scale($filepath, $filepath, $size['width'], $size['height']);
  }

  // Build the node.
  $node = new stdClass();
  $node->type = 'image';
  $node->uid = $user->uid;
  $node->name = $user->name;
  $node->title = isset($title) ? $title : basename($filepath);
  $node->body = $body;

  // Set the node's defaults... (copied this from node and comment.module)
  $node_options = variable_get('node_options_'. $node->type, array('status', 'promote'));
  $node->status = in_array('status', $node_options);
  $node->promote = in_array('promote', $node_options);
  if (module_exists('comment')) {
    $node->comment = variable_get("comment_$node->type", COMMENT_NODE_READ_WRITE);
  }
  if (module_exists('taxonomy')) {
    $node->taxonomy = $taxonomy;
  }

  $node->new_file = TRUE;
  $node->images[IMAGE_ORIGINAL] = $filepath;

  // Save the node.
  $node = node_submit($node);
  node_save($node);

  // By default, remove the original image now that the import has completed.
  if ($keep_original !== TRUE) {
    file_delete($original_path);
  }

  return $node;
}

/**
 * Implementation of hook_views_api().
 */
function image_views_api() {
  return array(
    'api' => 2,
    'path' => drupal_get_path('module', 'image') . '/views',
  );
}

/**
 * Implementation of hook_content_extra_fields().
 *
 * Lets CCK expose the image weight in the node content.
 */
function image_content_extra_fields($type_name) {
  if ($type_name == 'image') {
    $extra['image'] = array(
      'label' => t('Image'),
      'description' => t('Image display.'),
      'weight' => 0,
    );
    return $extra;
  }
}

Other Drupal examples (source code examples)

Here is a short list of links related to this Drupal image.module source code file:

new blog posts

"Drupal" is a registered trademark of Dries Buytaert.

my drupal tutorials and examples  

Copyright 1998-2016 Alvin Alexander, alvinalexander.com
All Rights Reserved.

Beginning in 2016, a portion of the proceeds from pages under the '/drupal-code-examples/' URI will be donated to charity.