modules/photobar/photobar.module

<?php
// $Id: photobar.module,v 1.1.2.9 2006/09/03 21:19:16 jakin Exp $

/*
Photobar for Drupal
Copyright (C) 2006 Jason Kivlighn <jkivlighn@gmail.com>

Documentation available at http://students.washington.edu/jkivligh/drupal_photobar/docs/

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
*/

/**
 * @file
 * Enables automatically importing directories as galleries of images on a per-date basic.
 * For each gallery, a photobar preview of the gallery is created.
 */

/**
 * Implementation of hook_help().
 */
function photobar_help($section) {
  switch ($section) {
    case 'admin/help#photobar':
      $output = '<p>'. t('The photobar module is used to manage automatated uploads of image galleries and display a preview (the \'photobar\') of the gallery.  This module automatically creates an image node of every photo in a given directory, creates a gallery, and associates the images with the gallery.  The photobar manages this gallery and image nodes, so when the photobar is deleted, so are all the nodes it created') .'</p>';
      $output .= '<p>'. t('<em>Folders must be in the form YYYY-MM-DD</em>, meaning this module provides a per-date gallery.') .'</p>';
      $output .= '<p>'. t('This module will automatically create photobars for every folder in files/photos when cron is run.  It will add new images to an existing photobar if new images are added to a folder after the photobar has already been created.') .'</p>';
      $output .= t('<p>You can</p>
<ul>
<li>post a photobar at <a href="%node-add-photobar">create content &gt;&gt; photobar</a>.</li>
<li>configure photobar settings at <a href="%admin-settings-photobar">administer &gt;&gt; settings &gt;&gt; photobar</a>.</li>
<li>configure photobar at <a href="%admin-settings-content-types-photobar">administer &gt;&gt; settings &gt;&gt; content types &gt;&gt; configure photobar</a>.</li>
</ul>
', array('%node-add-photobar' => url('node/add/photobar'), '%admin-settings-content-types-photobar' => url('admin/settings/content-types/photobar'), '%admin-settings-photobar' => url('admin/settings/photobar')));
      return $output;
    case 'admin/modules#description':
      if (module_exist('photobar') && (!module_exist('image_gallery')||!module_exist('image')) ) {
          drupal_set_message(t("The %image_gallery and %image module must be enabled for photobar to work.  Please download it from the drupal modules site and enable it below.", array('%image_gallery'=>'image_gallery','%image'=>'image')), 'error');
      }
      return t('Allows automatically displaying photos');
    case 'node/add#photobar':
      return t('A photobar allows displaying a preview of a photo gallery on the front page.  All photos in a directory chosen are added to a gallery and managed by this photobar node.');
  }
}

/**
 * Get the associated gallery term id.
 *
 * This is based on the creation date of the given node.
 */
function _photobar_get_gallery( &$bar_node ) {
  $result = taxonomy_get_term_by_name($bar_node->title);
  if ( count($result) == 0 ) {
    return false;
  }
  return $result[0];
}

/**
 * @param $folder_name The name of the folder
 * @return the timestamp that a folder with this name will be shown as authored on
 */
function _photobar_get_timestamp( $folder_name ) {
  return strtotime($folder_name)+(3600*24-1);
}

/**
 * Theme a photobar.
 *
 * @param $images An array of paths to the images to create a photobar of
 * @param $term The term of the image gallery that this photobar links to.  $term->tid must be set to the term id.
 *
 * @return HTML of a themed photobar.
 */
function theme_photobar( $images, $gallery_path, $height ) {
  $max_disp = count($images);

  $content .= '<table cellpadding="0" cellspacing="0" border="0" width="100%"><tr>';
  $x = true;
  foreach ( $images as $path ) {
    if ($x) {
      $content .= '<td align="center" class="first" width="'.floor(100/$max_disp).'%">';
      $x=false;
    } else {
      $content .= '<td align="center" width="'.floor(100/$max_disp).'%">';
    }
    $content .= "<img src=\"$path\" height=\"$height\" />";
    //$content .= $path;
    $content .= '</td>';
  }
  unset($x);
  $content .= '</tr></table>';

  $content = l($content, $gallery_path, array(), NULL, NULL, TRUE, TRUE);

  return '<div class="photobar">
 <div class="hd"><div class="c"></div></div>
 <div class="bd">
  <div class="c">
   <div class="s">
'.$content.'
   </div>
  </div>
 </div>
 <div class="ft"><div class="c"></div></div>
</div>';
}

/**
 * @param bar_node photobar node to create HTML for
 * @return photobar HTML code.  Photos for the bar are chosen at even intervals to include
 *         photos from the beginning, middle, and end of the event.
 */
function _photobar_create( &$bar_node ) {
  $max_disp = variable_get('photobar_maxdisp', 3);
  if ( $max_disp == 0 ){ return; }
  $image_label = variable_get('photobar_img_label', 'thumbnail');

  $term = _photobar_get_gallery($bar_node);
  if ( $term === false ){ return; }

  $count = db_result(db_query("SELECT COUNT(1) FROM {node} n INNER JOIN {term_node} t ON n.nid=t.nid WHERE type='image' AND t.tid='%d'",$term->tid));
  if ( $count == 0 ) { return; }

  $max_disp = ($max_disp<$count)?$max_disp:$count;
  $interval = 1.0*($count)/$max_disp;
  for ( $i = 0; round($i) < $count; $i+=$interval ) {
    $queryResult = db_query_range("SELECT n.nid FROM {node} n INNER JOIN {term_node} t ON n.nid=t.nid WHERE type='image' AND t.tid='%d' ORDER BY n.created", $term->tid, round($i), 1);
    while ($photo = db_fetch_object($queryResult)) {
      $node = node_load(array('nid' => $photo->nid));
      //$images[] = image_display($node,$image_label);
      $images[] = file_create_url(file_directory_path() ."/".$node->images[$image_label]);
    }
  }

  $sizes = _image_get_sizes();
  foreach ($sizes as $size) {
    if ( $size['label'] == $image_label ) {
      $height = $size['height'];
      break;
    }
  }

  return theme( 'photobar', $images, image_gallery_term_path($term), $height );
}

/**
 * @param nid Photobar node id
 * @return photobar HTML code.  Photos for the bar are chosen at even intervals to include
 *         photos from the beginning, middle, and end of the event.
 */
function photobar_create( $nid = 0 ) {
  if ( $nid ) {
    return _photobar_create(node_load(array('nid' => $nid)));
  }
}

function _photobar_convert_to_dec($value) {
  $result = "";
  
  if (isset($value)) {
    eval ("\$result = 1.0*$value;");
  }
  return $result;
}

/**
 * Creates an image node used with a photobar.
 *
 * If enabled in the settings, this function will automatically orient photos
 * based on exif information.  The original photos are unaltered.
 *
 * @param file File path to the photo to create
 * @param folder_time Timestamp for this photo.  This photo will be added to the correct gallery based on this value.
 * @param uid Create image nodes owned by this user.
 */
function photobar_create_image( $file, $folder_time, $uid ) {
  if ( ini_get('safe_mode') != "1" )
    set_time_limit(30);

  $basename = basename($file);

  $node = new stdClass();
  $node->type = "image";
  $node->title = basename($file);
  if ( !variable_get('photobar_keep_ext', true) ) {
    $ext = strrchr($node->title, '.');
    $node->title = basename( $node->title, $ext );
  }

  $node->uid = $uid;
  $node->promote = 0;
  $node->created = $folder_time;

  //requires php with exif enabled
  $exif = exif_read_data($file);

  $enable_locations = variable_get('location_image', 0);

  if ($exif && $enable_locations && isset($exif['GPSLatitude'])) {
    $deg = _photobar_convert_to_dec($exif['GPSLatitude'][0]);
    $min = _photobar_convert_to_dec($exif['GPSLatitude'][1]);
    $sec = _photobar_convert_to_dec($exif['GPSLatitude'][2]);

    $latitude = ($min * 60.0 + $sec)/60.0;
    $latitude = ($deg*60.0 + $latitude)/60.0;
  }
  else {
    $latitude = -1;
  }
  
  if ($exif && $enable_locations && isset($exif['GPSLongitude'])) {
    $deg = _photobar_convert_to_dec($exif['GPSLongitude'][0]);
    $min = _photobar_convert_to_dec($exif['GPSLongitude'][1]);
    $sec = _photobar_convert_to_dec($exif['GPSLongitude'][2]);

    $longitude = ($min * 60.0 + $sec)/60.0;
    $longitude = ($deg*60.0 + $longitude)/60.0;
  }
  else {
    $longitude = -1;
  }
  
  if ($latitude != -1 && $longitude != -1) {
    $node->location['latitude'] = $latitude;
    $node->location['longitude'] = $longitude;
    $node->location['lat'] = $latitude;
    $node->location['lon'] = $longitude;
  }
  
  if ( $exif && isset($exif['DateTime']) ) {
    $exif_datetime = $exif['DateTime'];
    $node->created = strtotime($exif_datetime);

    if ( $node->created == 0 ) {
      list($date, $time) = split(" ", $exif_datetime);
      list($year, $month, $day) = split(":",$date);
      list($hour, $minute, $second) = split(":",$time);
      $node->created = mktime($hour,$minute,$second,$month,$day,$year);
    }
  }
  $node->format = 1;
  $node->status = 1;

  $path = variable_get('image_default_path', 'images');
  $src = $file;
  $dest = file_directory_path() . "/$path/temp/$basename";

  if ( $exif && variable_get('photobar_auto_orient', false) ) {
    switch ( $exif['Orientation'] ) {
      case 3: image_rotate($src, $dest, 180); break;
      case 8: image_rotate($src, $dest, 90); break;
      case 6: image_rotate($src, $dest, 270); break;
      default: file_copy( $src, $dest );
    }
  }
  else {
    file_copy( $src, $dest );
  }

  $node->images['_original'] = $dest;
  _image_build_derivatives($node, true);
  node_save($node);
  return $node->nid;
}

function _photobar_is_image_valid($file)
{
  if ( variable_get('photobar_validate_images', true) ) {
    $info = @image_get_info($file);
    if ( $info === false ) {
      return false;
    } else {
      switch ($info['mime_type']) {
        case 'image/jpeg': return (@imagecreatefromjpeg($file) !== false);
        case 'image/gif' : return (@imagecreatefromgif($file)  !== false);
        case 'image/png' : return (@imagecreatefrompng($file)  !== false);
        default: return true; //assume valid?
      }
    }
  } else {
    $ext = strtoupper(strrchr($file, '.'));
    if ( $ext == ".JPG" || $ext == ".JPEG" || $ext == ".PNG" || $ext == ".GIF" )
      return true;
    else
      return false;
  }
}

/**
 * Creates a image nodes that will be a part of the photobar associated with the given date.
 *
 * A gallery is created and each image is added to that gallery.
 *
 * @param date_str Folder name in the form "YYYY-MM-DD"
 * @param uid Create image nodes owned by this user.
 */
function photobar_create_images( $date_str, $uid )
{
  $folder_time = _photobar_get_timestamp($date_str);

  $term['name'] = $date_str;
  //$term['description'] = "Day ".floor(($folder_time-strtotime("2006-06-23"))/60/60/24+1);
  $term['vid'] = variable_get('image_gallery_nav_vocabulary', '');
  taxonomy_save_term($term);
  $gallery_term['tid'] = $term['tid'];

  $path = variable_get('photobar_img_dir', 'photos') . "/" . $date_str;
  $files = file_scan_directory(file_create_path($path), '.*');
  foreach ($files as $file => $info) {
    if ( !_photobar_is_image_valid($file) ) {
      watchdog('photobar', t('%file: Not a valid image, skipping', array('%file' => $file)));
    } else if ( strpos(basename($file),'.') != 0 ) { //ignore hidden files
      $nid = photobar_create_image( $file, $folder_time, $uid );
      taxonomy_node_save($nid, $gallery_term);
    }
  }
}

/**
 * Implementation of hook_cron().
 *
 * Check a particular path for new photo directories or updated photo directories.
 * All new photos will be either added to a new photobar or added to an existing photobar
 * if a photobar of the given date already exists.
 */
function photobar_cron() {
  $uid = variable_get('photobar_default_user', 1);

  $dir =  file_create_path(variable_get('photobar_img_dir', 'photos'));
  $dir_hdl = opendir($dir);
  while($entry_name = readdir($dir_hdl))
  {
    if ( is_dir("$dir/$entry_name") &&
        $entry_name != "." && $entry_name != ".." &&
        ($folder_time = strtotime($entry_name)) > 0 ) {
      $folder_time = _photobar_get_timestamp($entry_name);
      $queryResult = db_query("SELECT created,title FROM {node} WHERE type='photobar' AND created='%d'", $folder_time);
      if ( db_num_rows($queryResult) == 0 ) { //create new
        $node = new stdClass();
        $node->type = "photobar";
        $node->title = $entry_name;
        $node->uid = $uid;
        $node->promote = 1;
        $node->created = $folder_time;
        $node->format = 1;
        $node->status = 1;
        node_save($node);
        watchdog('photobar', t('Created and populated new photobar for %date', array('%date' => $entry_name)));
      } else { //update existing
        while ($node = db_fetch_object($queryResult)) {
          $gallery_term = _photobar_get_gallery($node);
          if ( $gallery_term === false ) { continue; }

          $queryResult = db_query("SELECT n.title FROM {node} n INNER JOIN {term_node} t ON n.nid=t.nid WHERE type='image' AND t.tid='%d'", $gallery_term->tid);
          while ($photo = db_fetch_object($queryResult)) {
            $photos[] = $photo->title;
          }

          $path = variable_get('photobar_img_dir', 'photos') . "/" . $entry_name;
          $files = file_scan_directory(file_create_path($path), '.*');
          foreach ($files as $file => $info) {
            $basename = basename($file);

            if ( !_photobar_is_image_valid($file) ) {
              watchdog('photobar', t('%file: Not a valid image, skipping', array('%file' => $file)));
              continue;
            } else if ( strpos($basename,'.') == 0 ) { continue; } //skip hidden

            $ext = strrchr($basename, '.');
            if ( !in_array(basename($basename,$ext),$photos) && !in_array($basename,$photos) ) {
              $nid = photobar_create_image($file,$folder_time,$uid);
              taxonomy_node_save($nid, array($gallery_term));

              $new_photos[] = $file;
            }
          }

          if ( isset($new_photos) ) {
            //generate a log message
            watchdog('photobar', t('Added the following %count new photo(s) to the existing photobar, %photobar: %photo_list',
              array('%count' => count($new_photos),
                  '%photobar' => $entry_name,
                  '%photo_list' => implode(', ',$new_photos)))
            );
          }

          unset($photos);
          unset($new_photos);
        }
      }
    }
  }

  // close directory
  closedir($dir_hdl);

/*
  $image_label = variable_get('photobar_img_label', 'thumbnail');
  $queryResult = db_query("SELECT nid FROM {node} WHERE type='image'");
  while ($id = db_fetch_object($queryResult)) {
    if ( ini_get('safe_mode') != "1" )
      set_time_limit(30);
    $node = node_load($id->nid);
    image_display($node,$image_label); //rebuilds images if label changed, doesn't display it
  }
*/
}

/**
 * Implementation of hook_view
 *
 * Set the body and teaser to the HTML code of the photobar
 */
function photobar_view(&$node, $teaser = 0, $page = 0) {
  $node->teaser = _photobar_create($node);
  $node->body = $node->teaser;
}

/**
 * Implementation of hook_insert.
 *
 * Photobars created via 'Create Content' have the folder name as the title, so use that
 * and create a new photobar of the photos in that directory.
 */
function photobar_insert($node) {
  photobar_create_images($node->title, $node->uid);
}

/**
 * Implementation of hook_delete.
 *
 * Delete the associated gallery and image nodes in that gallery.
 */
function photobar_delete($node) {
  $gallery_term = _photobar_get_gallery($node);

  $queryResult = db_query("SELECT n.nid FROM {node} n INNER JOIN {term_node} t ON n.nid=t.nid WHERE type='image' AND t.tid='%d'", $gallery_term->tid);
  while ($photo = db_fetch_object($queryResult)) {
    node_delete($photo->nid);
  }

  taxonomy_del_term($gallery_term->tid);
}

/**
 * Implementation of hook_node_info().
 */
function photobar_node_info() {
  return array('photobar' => array('name' => t('photobar'), 'base' => 'photobar'));
}

/**
 * Implementation of hook_perm().
 */
function photobar_perm() {
  return array('create photobar', 'edit own photobar', 'photobar superuser');
}

/**
 * Implementation of hook_access().
 */
function photobar_access($op, $node) {
  global $user;

  if ($op == 'create') {
    return user_access('create photobar');
  }

  if ($op == 'update' || $op == 'delete') {
    if (user_access('edit own photobar') && ($user->uid == $node->uid)) {
      return TRUE;
    }
  }
}

/**
 * Implementation of hook_menu().
 */
function photobar_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array('path' => 'node/add/photobar', 'title' => t('photobar'),
      'access' => user_access('create photobar'));
  }

  return $items;
}

/**
 * Implementation of hook_form().
 *
 * Make the folder name the title.
 */
function photobar_form(&$node) {
    $form['title'] = array('#type' => 'textfield',
        '#title' => t('Folder (in the form: YYYY-MM-DD)'),
        '#required' => TRUE,
        '#default_value' => "",
        '#weight' => -5);

    return $form;
}

/**
 * Implementation of hook_validate
 *
 * Three validations:
 *   1) The folder is in the required format, YYYY-MM-DD
 *   2) The folder exists
 *   3) A photobar of this date doesn't already exist
 */
function photobar_validate(&$node) {
  $created = _photobar_get_timestamp($node->title);

  if ( $created === false || $created == -1 ) {
    form_set_error('title',t('Folder "%folder" is not in the required format, YYYY-MM-DD', array('%folder' => $node->title)));
  }

  $path = variable_get('photobar_img_dir', 'photos') . "/" . $node->title;
  if ( !is_dir(file_create_path($path)) ) {
    form_set_error('title',t('Folder "%folder" does not exist in %photo_dir', 
      array('%folder' => $node->title,
            '%photo_dir' => file_directory_path()."/".variable_get('photobar_img_dir', 'photos')))
    );
  }

  $count = db_result(db_query("SELECT COUNT(1) FROM {node} WHERE type='photobar' AND created='%d'", $created));
  if ( $count > 0 ) {
    form_set_error('title',
      t('A photobar from the date "%folder" already exists.  Either run cron to update this photobar with new images, or delete the photobar node and re-submit.',
       array('%folder' => $node->title))
    );
  }
}

/**
 * Implementation of hook_submit
 *
 * Override the creation time based on the folder name
 */
function photobar_submit(&$node) {
  $node->created = _photobar_get_timestamp($node->title);
}

/**
 * Implementation of hook_settings
 */
function photobar_settings() {
  $form['photobar_img_dir'] = array('#type' => 'textfield',
    '#title' => t('Photo search path'),
    '#default_value' => variable_get('photobar_img_dir', 'photos'),
    '#description' => t("Directory to look in for finding new photos."));

  $form['photobar_maxdisp'] = array('#type' => 'textfield',
    '#title' => t('Maximum number of photos to display in the bar'),
    '#default_value' => variable_get('photobar_maxdisp', 3),
    '#description' => t("The maximum number	of photos to display in the bar."),
    '#maxlength' => '2', '#size' => '2');

  $form['photobar_img_label'] = array('#type' => 'textfield',
    '#title' => t('Image label'),
    '#default_value' => variable_get('photobar_img_label', 'thumbnail'),
    '#description' => t("Image label (from Image module settings).  'preview' and 'thumbnail' are available by default.<br /><br />NOTE: Labels must already exist at the time the photos were added.  If you input photos, then create a new label and set it here, photos won't appear for this label."));

  $form['photobar_keep_ext'] = array('#type' => 'checkbox',
    '#title' => t('Image extension in title'),
    '#default_value' => variable_get('photobar_keep_ext', true),
    '#description' => t("For created 'image' nodes, whether or not to keep image extensions in the node title."));

  $form['photobar_validate_images'] = array('#type' => 'checkbox',
    '#title' => t('Validate images'),
    '#default_value' => variable_get('photobar_validate_images', true),
    '#description' => t("Check that each image is valid before adding it.  This slows down the update process quite a bit, but it isn't pretty when invalid images are added.  If not enabled, it only does an extension-based validation."));

  $form['photobar_auto_orient'] = array('#type' => 'checkbox',
    '#title' => t('Auto-orient'),
    '#default_value' => variable_get('photobar_auto_orient', false),
    '#description' => t("Automatically orient photos based on exif information (Requires php configured with --enable-exif)."));

  $form['photobar_default_user'] = array('#type' => 'textfield',
    '#title' => t('Default user id'),
    '#default_value' => variable_get('photobar_default_user', 1),
    '#maxlength' => '2', '#size' => '2',
    '#description' => t("User to own nodes created by automatic cron jobs."));

  return $form;
}