modules/webcomic/webcomic.module

<?php
// $Id: webcomic.module,v 1.10 2006/04/20 07:23:48 chx Exp $

/**
 * @file
 * Provides content types and tools for managing a webcomic.
 */

include_once(drupal_get_path('module', 'webcomic') .'/webcomic_theme.inc');
if (module_exists('views')) {
  include_once(drupal_get_path('module', 'webcomic') .'/webcomic_views.inc');
}

/**
 * Implementation of hook_help().
 */
function webcomic_help($section) {
  switch ($section) {
    case 'admin/help#webcomic':
      return '<p>'. t('Provides content types and tools for managing a webcomic.') .'</p>';
  }
}

/**
 * Implementation of hook_node_info().
 */
function webcomic_node_info() {
  return array(
    'webcomic_strip' => array(
      'name' => t('Strip'),
      'module' => 'webcomic',
      'description' => t('A single comic strip image.'),
    ),
    'webcomic_character' => array(
      'name' => t('Character bio'),
      'module' => 'webcomic',
      'description' => t('A biography for a comic character.'),
    ),
    'webcomic_episode' => array(
      'name' => t('Episode'),
      'module' => 'webcomic',
      'description' => t('A comic episode containing multiple strips (for example, an issue of a graphic novel).'),
    ),
    'webcomic_storyline' => array(
      'name' => t('Storyline'),
      'module' => 'webcomic',
      'description' => t('A comic storyline containing one or more episodes.'),
    ),
  );
}

/**
 * Implementation of hook_perm().
 */
function webcomic_perm() {
  return array('administer webcomic');
}

/**
 * Implementation of hook_access().
 */
function webcomic_access($op, $node) {
  global $user;
  if (user_access('administer webcomic')) {
    return TRUE;
  }
}

/**
 * Implementation of hook_menu().
 */
function webcomic_menu($may_cache) {
  $items = array();
  if ($may_cache) {
		$items[] = array(
	    'path' => 'admin/settings/webcomic',
  	  'title' => t('Webcomic'),
	    'description' => t('Webcomic settings.'),
	    'callback' => 'drupal_get_form',
  	  'callback arguments' => array('webcomic_admin_settings'),
	    'access' => user_access('administer site configuration') || user_access('administer webcomic'),
	    'type' => MENU_NORMAL_ITEM,
	  );
  }
  
  return $items;
}

/**
 * Menu callback; Webcomic administration page
 */
function webcomic_admin_settings() {
  $form['webcomic_discussions'] = array(
    '#type' => 'radios',
    '#title' => t('Discussions'),
    '#default_value' => variable_get('webcomic_discussions', 'normal'),
    '#options' => array(
      'normal' => t('Default commenting on each strip, episode, and storyline'),
      'storyline' => t('Provide a forum for each storyline'),
      'episode' => t('Provide a forum for each episode'),
      'strip' => t('Provide a forum for each strip'),
    ),
    '#description' => t('Allows you to direct users to your site\'s discussion forums rather than commenting on each strip or episode. Requires forum.module.'),
  );

  $form['browsing'] = array(
    '#type' => 'fieldset',
    '#title' => t('Browsing settings')
  );
  $form['browsing']['webcomic_browsing_style'] = array(
    '#type' => 'radios',
    '#title' => t('Browsing style'),
    '#default_value' => variable_get('webcomic_browsing_style', 'all_images'),
    '#options' => array(
      'like_kinds' => t('Next/Prev links show only the current type'),
      'all_images' => t('Next/Prev links show storylines, episode, and comic strips'),
      'episode_index' => t('Next/Prev links return to the index after each episode'),
      'story_index' => t('Next/Prev links return to the index after each storyline'),
    ),
    '#description' => t('Allows to change what content is shown when browsing webcomics.'),
  );
  $form['browsing']['webcomic_browsing_order'] = array(
    '#type' => 'radios',
    '#title' => t('Sort order'),
    '#default_value' => variable_get('webcomic_browsing_order', 'publish_timestamp'),
    '#options' => array(
      'publish_timestamp' => t('Order by publish date'),
      'storyline_timestampe' => t('Order by storyline date'),
      'weight' => t('Order by sequence number'),
    ),
    '#description' => t('Allows to change the order in which webcomic content is browsed and displayed.'),
  );

  $form['archive'] = array(
    '#type' => 'fieldset',
    '#title' => t('Archive settings')
  );
  $form['archive']['webcomic_archive_mode'] = array(
    '#type' => 'radios',
    '#title' => t('Archive organization'),
    '#default_value' => variable_get('webcomic_archive_mode', 'strips_month'),
    '#options' => array(
      'strips' => t('A list of strips'),
      'strips_month' => t('A list of strips, grouped by month'),
      'strips_year' => t('A list of strips, grouped by year'),
      'strips_episode' => t('A list of strips, grouped by episode'),
      'episodes' => t('A list of episodes'),
      'episodes_year' => t('A list of episodes, grouped by year'),
      'episodes_storyline' => t('A list of episodes, grouped by storyline'),
      'storylines' => t('A list of storylines'),
    ),
    '#description' => t('How should your webcomic\'s archive be organized?'),
  );
  $form['archive']['webcomic_archive_view'] = array(
    '#type' => 'radios',
    '#title' => t('Archive presentation'),
    '#default_value' => variable_get('webcomic_archive_view', 'list'),
    '#options' => array(
      'list' => t('List view (titles for each listed item)'),
      'summary' => t('Summary view (teasers for each listed item)'),
      'gallery' => t('Gallery view (a grid of thumbnails with titles)'),
    ),
    '#description' => t('How should each item in your archive be displayed?'),
  );
  
  return system_settings_form($form);
}

function _webcomic_character_form($node) {
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Name'),
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
  );

  $form['body_filter']['body'] = array(
    '#type' => 'textarea',
    '#title' => t('Character bio'),
    '#default_value' => $node->body,
    '#rows' => 10,
    '#required' => TRUE,
  );
    
  $form['body_filter']['format'] = filter_form($node->format);

  return $form;
}

function _webcomic_content_form($node) {
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
  );
  
  $form['#attributes'] = array("enctype" => "multipart/form-data");
  $form['images']['#tree'] = TRUE;
  $form['images']['_original'] = array(
    '#type' => 'hidden', 
    '#value' => $form['images']['_original']
  ); 
  $sizes = _image_get_sizes();
  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'][] = array('webcomic_form_add_thumbnail');
  $form['image'] = array(
    '#type' => 'file',
    '#title' => t('Image'),
    '#description' => t('Click "Browse..." to select an image to upload.'),
    '#weight' => 1,
  );

  // For strips and episodes, include a parent-selector.
  if ($node->type == 'webcomic_strip' || $node->type == 'webcomic_episode') {
    switch ($node->type) {
      case 'webcomic_strip':
        $parent_list = _webcomic_list_type('webcomic_episode');
        $parent_title = t('Episode');
        break;
      case 'webcomic_episode':
        $parent_list = _webcomic_list_type('webcomic_storyline');
        $parent_title = t('Storyline');
        break;
    }
    if (count($parent_list) > 1) {
      $form['parent_nid'] = array(
        '#type' => 'select',
        '#title' => $parent_title,
        '#default_value' => $node->parent_nid,
        '#options' => $parent_list,
        '#weight' => 2,
      );
    }
  }

  $form['publish_date'] = array(
    '#type' => 'textfield',
    '#title' => t('Publish date'),
    '#maxlength' => 25,
    '#weight' => 6,
    '#default_value' => $node->publish_date,
    '#description' => t('Used to delay publishing of content. Leave blank for normal behavior. Format: !time. ', array('!time' => $node->date)),
  );

  $form['storyline_date'] = array(
    '#type' => 'textfield',
    '#title' => t('Plot date'),
    '#maxlength' => 25,
    '#weight' => 7,
    '#default_value' => $node->storyline_date,
    '#description' => t('Used to organize webcomic content that follows a custom timeline, or when strips are posted out of order. Format: !time. ', array('!time' => $node->date)),
  );
  
  switch ($node->type) {
    case 'webcomic_storyline':
      $weight_title = t('Storyline number');
      break;
    case 'webcomic_episode':
      $weight_title = t('Episode number');
      break;
    case 'webcomic_strip':
      $weight_title = t('Strip number');
      break;
  }

  $form['weight'] = array(
    '#type' => 'textfield',
    '#title' => $weight_title,
    '#maxlength' => 25,
    '#weight' => 8,
    '#default_value' => $node->weight,
    '#description' => t('This number doesn\'t have to be unique, but it probably should be. It\'s used to sort strips, episodes, and storylines.'),
  );

  if ($node->type == 'webcomic_strip') {
    $chars = _webcomic_list_characters();
    if (count($chars) > 0) {
      $form['characters'] = array(
        '#type' => 'select',
        '#title' => t('Characters'),
        '#default_value' => $node->characters,
        '#options' => $chars,
        '#multiple' => TRUE,
        '#description' => t('Links to all characters that appear in this particular strip.'),
        '#weight' => 9,
      );
    }
  }

  $form['body_filter']['body'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => $node->body,
    '#rows' => 10,
    '#required' => FALSE,
  );
  
  $form['body_filter']['format'] = filter_form($node->format);

  return $form;
}

/**
 * Implementation of hook_form().
 */
function webcomic_form($node) {
  if ($node->type == 'webcomic_character') {
    return _webcomic_character_form($node);
  }
  
  return _webcomic_content_form($node);
}

/**
* Moved this over directly from image so I could change the weight.
*/
//function webcomic_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_load().
 */
function webcomic_load(&$node) {
  if ($node->type == 'webcomic_storyline' || $node->type == 'webcomic_episode' || $node->type == 'webcomic_strip') {
    // basic webcomic data
    $content = db_fetch_object(db_query('SELECT * FROM {webcomic_content} WHERE nid = %d', $node->nid));
    if ($content->publish_timestamp != 0) {
      $content->publish_date = format_date($content->publish_timestamp, 'custom', 'Y-m-d H:i:s O');
    }
    if ($content->storyline_timestamp != 0) {
      $content->storyline_date = format_date($content->storyline_timestamp, 'custom', 'Y-m-d H:i:s O');
    }

    // image loading
    image_load($node);

    // parent relationships
    $parent = db_fetch_object(db_query('SELECT * FROM {webcomic_parent} WHERE child_nid = %d', $node->nid));
    $content->parent_nid = $parent->parent_nid;

    // character associations
    if ($node->type == 'webcomic_strip') {
      $result = db_query('SELECT * FROM {webcomic_strip_character} WHERE strip_nid = %d', $node->nid);
      while ($strip_char = db_fetch_object($result)) {
        $content->characters[] = $strip_char->character_nid;
      }
    }
  }

  return $content;
}

/**
 * Implementation of hook_insert().
 */
function webcomic_insert($node) {
  if ($node->type == 'webcomic_storyline' || $node->type == 'webcomic_episode' || $node->type == 'webcomic_strip') {
    db_query("INSERT INTO {webcomic_content} (nid, publish_timestamp, storyline_timestamp, weight, sequence) VALUES (%d, %d, %d, %d, '%s')", $node->nid, $node->publish_timestamp, $node->storyline_timestamp, $node->weight, $node->sequence);
    if (isset($node->parent_nid)) {
      db_query("INSERT INTO {webcomic_parent} (child_nid, parent_nid) VALUES (%d, %d)", $node->nid, $node->parent_nid);
    }
    if (function_exists('image_prepare') && function_exists('image_insert')) {
      image_prepare($node, 'image');
      if($node->images['_original'] != '') {
        image_insert($node);
      }
    }
    if ($node->type == 'webcomic_strip' && is_array($node->characters)) {
      foreach($node->characters as $char_nid) {
        db_query("INSERT INTO {webcomic_strip_character} (strip_nid, character_nid) VALUES (%d, %d)", $node->nid, $char_nid);
      }
    }
  }
}

/**
 * Implementation of hook_update().
 */
function webcomic_update($node) {
  if ($node->type == 'webcomic_storyline' || $node->type == 'webcomic_episode' || $node->type == 'webcomic_strip') {
    db_query("UPDATE {webcomic_content} SET publish_timestamp = %d,  storyline_timestamp = %d, weight = %d, sequence = '%s' WHERE nid = %d", $node->publish_timestamp, $node->storyline_timestamp, $node->weight, $node->sequence, $node->nid);
    db_query("DELETE FROM {webcomic_parent} WHERE child_nid = %d", $node->nid);
    db_query("DELETE FROM {webcomic_strip_character} WHERE strip_nid = %d", $node->nid);

    if (isset($node->parent_nid)) {
      db_query("INSERT INTO {webcomic_parent} (child_nid, parent_nid) VALUES (%d, %d)", $node->nid, $node->parent_nid);
    }
    
    if ($node->type == 'webcomic_strip' && is_array($node->characters)) {
      foreach($node->characters as $char_nid) {
        db_query("INSERT INTO {webcomic_strip_character} (strip_nid, character_nid) VALUES (%d, %d)", $node->nid, $char_nid);
      }
    }

    if (function_exists('image_prepare') && function_exists('image_update')) {
      image_prepare($node, 'image');
      //print_r($node, FALSE);
      if($node->images[_original] != '') {
        image_update($node);
      }
    }
  }
}

/**
 * Implementation of hook_delete().
 */
function webcomic_delete(&$node) {
  if ($node->type == 'webcomic_character') {
  	db_query('DELETE FROM {webcomic_strip_character} WHERE character_nid = %d', $node->nid);
  } else {
    db_query('DELETE FROM {webcomic_content} WHERE nid = %d', $node->nid);
    db_query('DELETE FROM {webcomic_parent} WHERE child_nid = %d OR parent_nid = %d', $node->nid, $node->nid);
    db_query('DELETE FROM {webcomic_strip_character} WHERE strip_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);
    }
  }
}

/**
 * Implementation of hook_submit().
 */
function webcomic_submit(&$node) {
  if ($node->type == 'webcomic_storyline' || $node->type == 'webcomic_episode' || $node->type == 'webcomic_strip') {
    // If a publish date has been set, and is in the future, override the publish flag
    // otherwise, set the publish date to the created date
    if ($node->publish_date != '') {
      $node->publish_timestamp = strtotime($node->publish_date);
      if ($node->publish_timestamp > time()) {
        // Unpublish the node. It shouldn't be visible!
        $node->status = 0;
      }
    }
    else {
      $node->publish_timestamp = $node->created;
    }
    
    if ($node->storyline_date != '') {
      $node->storyline_timestamp = strtotime($node->storyline_timestamp);
    }
  
    $node->sequence = _webcomic_generate_sequence($node);
  }
}

function _webcomic_list_type($type = NULL) {
  $items = array();
  $items[0] = '-- No parent --';

  $sql  = "SELECT n.nid, n.title, n.created, n.status, n.type, wcc.publish_timestamp, wcc.storyline_timestamp, wcc.weight ";
  $sql .= "FROM {node} n INNER JOIN {webcomic_content} wcc ON n.nid = wcc.nid WHERE n.type = '%s'";
  $sql .= ' ORDER BY wcc.sequence ASC';

  $result = db_query($sql, $type);
  while ($item = db_fetch_object($result)) {
    $key = $item->nid;
    $value = $item->title;
    if (!$item->status) {
      $value .= ' (not published)';
    }
    $items[$key] = $value;
  }
  
  return $items;
}

function _webcomic_list_characters() {
  $chars = array();
  $sql  = "SELECT n.nid, n.title, n.status FROM {node} n WHERE n.type = 'webcomic_character' ORDER BY n.title ASC, n.status DESC";

  $result = db_query($sql);
  while ($char = db_fetch_object($result)) {
    $key = $char->nid;
    $value = $char->title;
    if (!$char->status) {
      $value .= ' (not published)';
    }
    $chars[$key] = $value;
  }
  
  return $chars;
}

function _webcomic_generate_sequence($node) {
  $seq = _webcomic_get_sequence($node);
  
  switch ($node->type) {
    case 'webcomic_strip':
      $seq = str_pad($seq, 33, '0', STR_PAD_LEFT);
      break;
    case 'webcomic_episode':
      $seq = str_pad($seq, 22, '0', STR_PAD_LEFT);
      $seq = str_pad($seq, 33, '0', STR_PAD_RIGHT);
      break;
    case 'webcomic_storyline':
      $seq = str_pad($seq, 33, '0', STR_PAD_RIGHT);
      break;
  }

  return $seq;
}

function _webcomic_get_sequence($node) {
  $seq = _webcomic_get_sequence_chunk($node);
  if ($node->parent_nid) {
    $seq = _webcomic_get_sequence(node_load($node->parent_nid)) . $seq;
  }
  
  return $seq;
}

function _webcomic_get_sequence_chunk($node) {
  switch (variable_get('webcomic_browsing_order', 'publish_timestamp')) {
    case 'publish_timestamp':
      $tmp = $node->publish_timestamp;
      break;
    case 'storyline_timestamp':
      $tmp = $node->storyline_timestamp;
      break;
    case 'weight':
      $tmp = $node->weight;
      break;
  }

  return str_pad($tmp, 11, '0', STR_PAD_LEFT);
}

/**
 * Implementation of hook_cron(). 
 * 
 * Auto-publishes content.
 */
function webcomic_cron() {
  $result = db_query('SELECT wcc.nid FROM {webcomic_content} wcc INNER JOIN {node} n ON wcc.nid = n.nid WHERE n.status = 0 AND wcc.publish_timestamp <= %d', time());
  while ($tmp = db_fetch_object($result)) {
    $node = node_load($tmp->nid);
    $node->status = 1;
    node_save($node);
    
    watchdog('webcomic', $node->title .' published.');
  }
}

/**
 * Implementation of hook_view().
 */
function webcomic_view(&$node, $teaser = FALSE, $page = FALSE) {
  drupal_add_css(drupal_get_path('module', 'webcomic') .'/webcomic.css');
  if ($page && $node->parent_nid) {
    $episode = node_load($node->parent_nid);
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'node/'. $episode->nid, 'title' => $episode->title);
    if ($episode->parent_nid) {
      $storyline = node_load($episode->parent_nid);
      $breadcrumb[] = array('path' => 'node/'. $storyline->nid, 'title' => $storyline->title);
    }
    
    menu_set_location($breadcrumb);
  }

  $node = node_prepare($node, $teaser);
  
  $nav = theme('webcomic_navigation', $node);
  
  $node->content['teaser']['#value'] = theme('webcomic_teaser', $node);
  $node->content['body']['#value'] = $nav;
  $node->content['body']['#value'] .= theme('webcomic_body', $node, 'preview');
  $node->content['body']['#value'] .= $nav;
  
  return $node;
}

function webcomic_update_sequences() {
  $result = db_query('SELECT nid FROM {webcomic_content}');
  while ($nid = db_fetch_object($result)) {
    $node = node_load($nid->nid);
    $node->sequence = _webcomic_generate_sequence($node);
    
    node_save($node);
  }
}

function webcomic_first($node) {
  switch (variable_get('webcomic_browsing_style', 'all_images')) {
    case 'like_kinds':
      $where = " AND n.type = '". $node->type ."'";
      break;
    case 'all_images':
      break;
    case 'episode_index':
     $where = " AND n.type = '". $node->type ."'";
     break;
    case 'story_index':
      $where = " AND n.type = '". $node->type ."'";
      break;
  }
  
  $sql =  "SELECT n.nid, n.title, wcc.sequence FROM {node} n";
  $sql .= " INNER JOIN {webcomic_content} wcc ON n.nid = wcc.nid";
  $sql .= " WHERE  n.status = 1 AND n.moderate = 0 ". $where;
  $sql .= " ORDER BY wcc.sequence ASC, n.title ASC LIMIT 1";

  $result = db_query($sql, $node->nid);
  $first = db_fetch_object($result);
  
  if ($first->nid != $node->nid) {
    return $first;
  }
}

function webcomic_prev($node) {
  switch (variable_get('webcomic_browsing_style', 'all_images')) {
    case 'like_kinds':
      $where = " AND n.type = '". $node->type ."'";
      break;
    case 'all_images':
      break;
    case 'episode_index':
      $where = " AND n.type = '". $node->type ."'";
      break;
    case 'story_index':
      $where = " AND n.type = '". $node->type ."'";
      break;
  }
  
  $sql =  "SELECT n.nid, n.title, wcc.sequence FROM {node} n";
  $sql .= " INNER JOIN {webcomic_content} wcc ON n.nid = wcc.nid";
  $sql .= " WHERE  n.status = 1 AND n.moderate = 0 ". $where;
  $sql .= " AND (wcc.sequence < '%s' OR (wcc.sequence = '%s' AND n.title < '%s')) ";
  $sql .= " ORDER BY wcc.sequence DESC, n.title DESC LIMIT 1";
  
  $result = db_query($sql, $node->sequence, $node->sequence, $node->title);
  $prev = db_fetch_object($result);
  
  return $prev;
}

function webcomic_next($node) {
  switch (variable_get('webcomic_browsing_style', 'all_images')) {
    case 'like_kinds':
      $where = " AND n.type = '". $node->type ."'";
      break;
    case 'all_images':
      break;
    case 'episode_index':
      $where = " AND n.type = '". $node->type ."'";
      break;
    case 'story_index':
      $where = " AND n.type = '". $node->type ."'";
      break;
  }

  $sql =  "SELECT n.nid, n.title, wcc.sequence FROM {node} n";
  $sql .= " INNER JOIN {webcomic_content} wcc ON n.nid = wcc.nid";
  $sql .= " WHERE  n.status = 1 AND n.moderate = 0 ". $where;
  $sql .= " AND (wcc.sequence > '%s' OR (wcc.sequence = '%s' AND n.title > '%s'))";
  $sql .= " ORDER BY wcc.sequence ASC, n.title ASC LIMIT 1";

  $result = db_query($sql, $node->sequence, $node->sequence, $node->title);
  $next = db_fetch_object($result);
  
  return $next;
}

function webcomic_last($node) {
  switch (variable_get('webcomic_browsing_style', 'all_images')) {
    case 'like_kinds':
      $where = " AND n.type = '". $node->type ."'";
      break;
    case 'all_images':
      break;
    case 'episode_index':
     $where = " AND n.type = '". $node->type ."'";
     break;
    case 'story_index':
      $where = " AND n.type = '". $node->type ."'";
      break;
  }

  $sql =  "SELECT n.nid, n.title, wcc.sequence FROM {node} n";
  $sql .= " INNER JOIN {webcomic_content} wcc ON n.nid = wcc.nid";
  $sql .= " WHERE  n.status = 1 AND n.moderate = 0 ". $where;
  $sql .= " ORDER BY wcc.sequence DESC, n.title DESC LIMIT 1";

  $result = db_query($sql, $node->nid);
  $last = db_fetch_object($result);
  
  if ($last->nid != $node->nid) {
    return $last;
  }
}

// This should be modified to return the proper URL for the current
function webcomic_index() {
  switch (variable_get('webcomic_archive_mode', 'strips_month')) {
    case 'strips':
    case 'strips_month':
    case 'strips_year':
    case 'strips_episode':
      return 'strips';
      break;
    
    case 'episodes':
    case 'episodes_year':
    case 'episodes_storyline':
      return 'episodes';
      break;

    case 'storylines':
      return 'storylines';
      break;
  }
}