nopeapi_image code

I’ve recently been working on a nodeapi-based image upload module for 4.7 and introduced it to the dev list. Walkah and Moshe suggested posting the code, so I am putting it here for review.

The image_nodeapi module currently has the following functionality:

- Settings page to determine which nodes should enable image uploads.
- Uses the image functions image_prepare, image_insert and image_update to do all the heavy lifting.
- Allows users to set a caption for the image.
- Default layout of a floated right image with the caption displayed underneath the image on pages.
- Passes the node object to the theme, allowing site admins to over-write presentation of images to fit site specific needs.
- Along these lines, admins could use a case statement in their theme file that would display a different layout for different node types, etc.

nodeapi_image.mysql

-- 
-- Table structure for table `nodeapi_image`
-- 

CREATE TABLE nodeapi_image (
  nid int(10) unsigned NOT NULL default '0',
  caption text,
  PRIMARY KEY  (nid)
) TYPE=MyISAM
/*!40100 DEFAULT CHARACTER SET utf8 */;

nodeapi_image.module

<?php
// $Id: $

/**
 * @file nodeapi_image.module
 */


/**
 * implementation of hook menu
 * 
 * This just adds the css file.
 */
function nodeapi_image_menu($may_cache){
  if (!$may_cache) {
    theme_add_style(drupal_get_path('module', 'nodeapi_image') .'/nodeapi_image.css');
  }
}	

/**
 * Implementation of hook_help().
 */
function nodeapi_image_help($section) {
  switch ($section) {
    case 'admin/modules#description':
      // This description is shown in the listing at admin/modules.
      return t('Add a structured image to stories');
  }
}

/**
 * implementation of hook_form_alter()
 */
function nodeapi_image_form_alter($form_id, &$form) {
  if (!isset($form['type'])) {
    return;
  }
  // Make a copy of the type to shorten up the code
  $type =  $form['type']['#value'];
  $enabled = variable_get('nodeapi_image_'. $type, 0);
  switch ($form_id) {
  	
    // checkbox in the node's content type configuration page. 
    case $type .'_node_settings':
      if(function_exists('_image_check_settings')){
      	_image_check_settings();
        $form['workflow']['nodeapi_image_'. $type] = array(
          '#type' => 'radios',
          '#title' => t('Allow Images'),
          '#default_value' => $enabled,
          '#options' => array(0 => t('Disabled'), 1 => t('Enabled')),
          '#description' => t('Should this node allows users to upload an image?'),
        );
      } else {
        drupal_set_message(t('The image module is not installed. The nodeapi_image module will not function without it.'), 'error');
      }
      break;
    
    // if enabled adjust the form
    case $type .'_node_form':
      if ($enabled == 1 &&  function_exists('_image_check_settings')) {
        _image_check_settings();
        $node = $form['#node'];
        $form['#attributes'] = array("enctype" => "multipart/form-data");
  
        $sizes = _image_get_sizes();
        $form['images']['#tree'] = TRUE;
        $form['images']['_original'] = array('#type' => 'hidden', '#value' => $form['images']['_original']);
        foreach ($sizes as $size) {
          if ($node->new_file) {
            $form['images'][$size['label']] = array('#type' => 'hidden', '#value' => $node->images[$size['label']]);
          }
          else {
            $form['images'][$size['label']] = array('#type' => 'hidden', '#default_value' => $node->images[$size['label']]);
          }
        }

        $form['thumbnail']['#after_build'] = 'nodeapi_image_form_add_thumbnail';
        $form['image'] = array('#type' => 'file', '#title' => t('Image'), '#description' => t('Click "Browse..." to select an image to upload.'), '#weight' => 2.1);
        $form['nodeapi_image_caption'] = array('#type'=> 'textarea', '#title' => t('Caption'), '#default_value' =>  $node->nodeapi_image_caption, '#required' => FALSE, '#cols' => 60, '#rows' => 7, '#weight' => 2.2); 
      }
      break;
  }
}

/**
 * Moved this over directly from image so I could change the weight.
 */
function nodeapi_image_form_add_thumbnail($form_id, $edit) {
  if ($edit['images']['thumbnail']) {
    $node = (object)($edit);
    $form = array('#type' => 'item', '#title' => t('Thumbnail'), '#value' => image_display($node, 'thumbnail'), '#weight' => 2);
  }
  return $form;
}

/**
 * Implementation of hook_nodeapi().
 */
function nodeapi_image_nodeapi(&$node, $op, $teaser, $page) {
  if(variable_get('nodeapi_image_'. $node->type, 0) == 0){
  	return;
  }
  switch ($op) {
  	// Make sure the caption is under 2000 characters
  	// TODO: Consider another approach for limiting the caption?
    case 'validate':
      if (isset($node->nodeapi_image_caption)) {
        $caption_count = strlen(trim($node->nodeapi_image_caption));
        if ($caption_count > 2000) {
          form_set_error('nodeapi_image_caption', t('The caption field must be under 2000 characters long. The current description is %length characters.', array('%length' => $caption_count)));
	    }
      }
      break;
      
    // Insert the caption then prepare the images and insert
    case 'insert':
      db_query("INSERT INTO {nodeapi_image} (nid, nodeapi_image_caption) VALUES (%d, '%s')", $node->nid, $node->nodeapi_image_caption);
      if(function_exists('image_prepare') && function_exists('image_insert')){
          image_prepare($node, 'image');
          if($node->images['_original'] != ''){
            image_insert($node);
          }
      }
      
      break;
      
    // Delete any old captions and insert the new one.
    // Prepare the image, then update
    case 'update':
      db_query('DELETE FROM {nodeapi_image} WHERE nid = %d', $node->nid); 
      db_query("INSERT INTO {nodeapi_image} (nid, nodeapi_image_caption) VALUES (%d, '%s')", $node->nid, $node->nodeapi_image_caption);
      if(function_exists('image_prepare') && function_exists('image_update')){
        image_prepare($node, 'image');
      	//print_r($node, FALSE);
      	if($node->images[_original] != ''){
          image_update($node);
      	}
      }
      
      break; 
    
    // Remove the captions, file definitions and the files for this node
    case 'delete':
      db_query('DELETE FROM {nodeapi_image} WHERE nid = %d', $node->nid);
      foreach ($node->images as $label => $image) {
        file_delete(file_create_path($image));
        db_query("DELETE FROM {files} WHERE filename='%s' AND nid=%d", $label, $node->nid);
      }
      break;
      
    // Get the images and pack them directly in the node reference
    // then get the caption and return that into the node object
    case 'load':
      $result = db_query("SELECT filename, filepath FROM {files} WHERE nid=%d", $node->nid);
      image_load($node);
      $object = db_fetch_object(db_query('SELECT nodeapi_image_caption FROM {nodeapi_image} WHERE nid = %d', $node->nid));
      return array('nodeapi_image_caption' => $object->nodeapi_image_caption);
      
    // Pass the body and teaser objects to the theme again to add the images
    case 'view':
      if(function_exists('image_display')){
        $node->body = theme('nodeapi_image_body', $node);
        if($teaser){
          $node->teaser = theme('nodeapi_image_teaser', $node);
        }
      }
  }
}

/**
 * Theme the teaser.
 * 
 * Override this in template.php to include a case statement if you want different node types to appear differently.
 * If you have additional image sizes you defined in image.module, you can use them by theming this function as well.
 */
function theme_nodeapi_image_teaser($node){
  $request = ($_GET['size']) ? $_GET['size'] : 'thumbnail';
  $request = check_plain($request);
  $info = image_get_info(file_create_path($node->images[$request]));
  $output = '';
  $output .= '<div style="width: '. $info['width'] .'px" class="nodeapi_image_teaser">';
  $output .= l(image_display($node, $request), "node/$node->nid", array(), NULL, NULL, FALSE, TRUE);
  $output .= '</div>'."\n";
  $output .= $node->teaser;
  return $output;
}

/**
 * Theme the body
 * 
 * Override this in template.php to include a case statement if you want different node types to appear differently.
 * If you have additional image sizes you defined in image.module, you can use them by theming this function as well.
 */
function theme_nodeapi_image_body($node){
  $request = ($_GET['size']) ? $_GET['size'] : 'thumbnail';
  $request = check_plain($request);
  $info = image_get_info(file_create_path($node->images[$request]));
  $output = '';
  if($request == 'thumbnail'){
    $output .= '<div style="width: '. $info['width'] .'px" class="nodeapi_image">'. l(image_display($node, $request), "node/$node->nid", NULL, 'size='. urlencode('preview'), NULL, FALSE, TRUE)."\n";
    if($node->nodeapi_image_caption){
      $output .= '  <div style="width: '. ($info['width']-10) .'px" class="nodeapi_image_caption">'. check_markup($node->nodeapi_image_caption, $node->format) .'</div>'."\n";
    }
    $output .= '</div>'."\n";
    $output .= $node->body;
  } else {
    $output .= '<div class="nodeapi_image_backtonode">'. l(t('Back to %l', array('%l' => $node->title)), "node/$node->nid") .'</div>'."\n";
    $output .= '<div class="nodeapi_image_preview">'. image_display($node, $request) .'</div>'."\n";
    $output .= '<div class="nodeapi_image_caption_preview">'. check_markup($node->nodeapi_image_caption, $node->format) .'</div>'."\n";
  }
  return $output;
}


?>

nodeapi_image.css

.nodeapi_image {
  float: right;
  margin-left: 1em;
}
.nodeapi_image_teaser {
  float: right;
  margin-left: 1em;
}
.nodeapi_image_preview {
  margin-bottom: 1em;
}
.nodeapi_image_caption {
  margin-left: 5px;
}
.node {
  clear: both;
}

Enjoy.