modules/epublish/epublish.module

<?php
// $Id$

/**
 * @file
 * This module helps organize a group of nodes into a publication, such as
 * a newspaper, magazine or newsletter. Each publication can have multiple
 * editions. Within each edition, the epublish module also makes it
 * possible to organize content by topic, similar to the way news websites
 * such as the New York Times categorize their content using topics such
 * as "international," "national," "sports," etc.
 *
 * @note
 * See the module help for usage and administration information.
 */

/**
 * Implementation of hook_init().
 * Special thanks to Stefan Engstrom.
 */
function epublish_init() {
  $path = drupal_get_path('module', 'epublish');
  if (variable_get('epublish_css', 1)) {
    drupal_add_css($path .'/epublish.css');
  }
  drupal_add_js($path .'/epublish.js');
}

/**
 * Implementation of hook_theme().
 */
function epublish_theme() {
  $filename = array();
  $dyn_arr = array();
  $files = file_scan_directory(drupal_get_path('module', 'epublish'), '^epublish_layout_.*\.inc$');
  foreach ($files as $fname) {
    $dyn_arr[$fname->name] = array(
      'file' => $fname->basename,
      'arguments' => array('topics' => NULL, 'params' => NULL),
    );  
  }
    $static_arr = array(
    'epublish_edition_reference' => array(
      'arguments' => array('edition' => 0),
    ),
    'epublish_abstract' => array(
      'arguments' => array('abstract' => NULL),
    ),
    'epublish_topics' => array(
     'arguments' => array('topics' => 0, 'sid' => NULL, 'edition' => 0, 'context' => NULL),
    ),
    'epublish_volume_reference' => array(
      'arguments' => array('pid' => NULL, 'volume' => NULL),
    ),
    'epublish_pub_page' => array(
      'arguments' => array('output' => 0, 'publication' => 0, 'edition' => 0, 'volume' => NULL),
    ),
    'epublish_format_volume' => array(
      'arguments' => array('volume' => NULL, 'pid' => NULL, 'edition_blocks' => array()),
    ),
    'epublish_format_edition' => array(
      'arguments' => array('edition' => 0),
    ),
    'epublish_format_pub' => array(
      'arguments' => array(),
    ),
    'epublish_form_section' => array(
      'arguments' => array('form' => NULL),
    ),
    'epublish_form_edition' => array(
      'arguments' => array('form' => NULL),
    ),
    'epublish_admin_node' => array(
      'arguments' => array('form' => NULL),
    ),
    'epublish_navigation' => array(
      'arguments' => array('node' => NULL, 'eid' => NULL),
    ),
  );
  return (array_merge($static_arr, $dyn_arr));
}

/**
 * Implementation of hook_help().
 */
function epublish_help($path, $arg) {
  switch ($path) {
    case 'admin/modules#description':
      $output = t('<p>Enables users to organize the contents of their site into publications with multiple editions, like a magazine or newspaper.</p>');
    break;
    case 'admin/settings/epublish':
      $output = t('<p>Settings for periodically-issued publications.</p>');
    break;
    case 'admin/node/configure/defaults':
      $output = t('<p>If you want users to be able to enter brief abstracts of postings for displays on headlines and publication pages, check the <em>has abstract</em> box.</p>');
    break;
    case 'admin/help#epublish':
    $output = t("<p>This module helps organize a publication or group of publications, each with multiple editions.</p>".
      "<h3>Configuration</h3><p>To use this module, you have to take a few steps:</p>".
      "<ul><li>Install and enable the module.</li>".
      "<li>Enable the taxonomy module in !modules.<br />If the taxonomy module is not enabled, you can not use this module.</li>".
      "<li>Create a taxonomy vocabulary in !taxonomy.</li>".
      "<li>Create in !taxcreate at least one term in your new taxonomy. Each posting can be associated with a taxonomy term and grouped by topic within a headlines \"section\" (see below).</li>".
      "<li>Set the appropriate access right in !access<br />The access right is <b>administer publications</b>.</li></ul>",
      array('!modules' => l(t("administer &raquo; modules"), "admin/modules", array(), NULL, NULL, FALSE, TRUE),
      '!taxonomy' => l(t("administer &raquo; topics &raquo; add vocabulary"), "admin/taxonomy/add/vocabulary", array(), NULL, NULL, FALSE, TRUE),
      '!taxcreate' => l(t("administer &raquo; topics"), "admin/taxonomy", array(), NULL, NULL, FALSE, TRUE),
      '!access' => l(t("administer &raquo; access"), "admin/access", array(), NULL, NULL, FALSE, TRUE))) .
      t("<h3>Creating and administering publications</h3>".
      "<p>The epublish module deals with three objects, which can be created or edited using !admin:</p>".
      "<ul><li>A \"<b>publication</b>\" could be a newsletter or magazine -- something that appears in multiple editions, either on a regular or sporadic basis, according to a publication schedule that you specify.</li>".
      "<li>Each publication can have multiple \"<b>editions</b>,\" typically labeled with a dateline, volume and number. A monthly magazine, for example, might be labeled \"November 2004, volume 3, no. 11.\"".
      "(The volume and number fields are optional.) Each publication can have a designated \"current\" edition. The current edition will display in all places where a publication is specified but no specific edition number has otherwise been indicated.</li>".
      "<li>Within each edition, content can be organized using a headlines \"<b>section</b>.\" Headlines sections organize postings by topic using taxonomy terms, similar to the way that news websites such as the New York Times categorize their content using ".
      "topics such as \"international,\" \"national,\" \"sports,\" etc. In addition to topics based on taxonomy terms, two special, non-taxonomy-based topic groupings exist: \"top stories\" , \"advertisement\" and \"miscellaneous.\"</li></ul>\n".
      "<p>You can add or organize headlines to a specific edition of a publication by using !admin to specify the edition that you want to edit. You can also use weighting to control the order in which headlines appear.</p>\n".
      "<h3>Viewing publications</h3>".
      "<p>A list of publications can be viewed at path !epublish. Each publication has a numeric publication ID (pid). An individual publication can be viewed using the path \"epublish/{pid}\" where ".
      "{pid} is the publication's ID number, or \"epublish\{name}\" where {name} is the publication name. An individual edition can be viewed using the path \"epublish/{pid}/{eid}\" or \"epublish/{name}/{eid}\" ".
      "where {eid} is the edition ID number. As an alternative to {eid}, the path can also specify editions by their volume and number using the syntax \"v{volume}n{number}\". For example, the path ".
      "\"epublish/Monthly%20News/v3n14\" would show volume 3, number 14 of the publication named \"Monthly News.\" Or, the path \"epublish/4/v3\" would show all editions of volume 3 of the publication ".
      "with {pid} 4. The path \"epublish/{pid}/current\" specifies a publication's current edition.</p>\n",
      array('!admin' => l(t("administer &raquo; epublish"), "admin/epublish", array(), NULL, NULL, FALSE, TRUE),
      '!epublish' => l(t('epublish'), "epublish"),
      '!nodes' => l(t("administer &raquo; epublish &raquo; edition contents"), "admin/epublish/", array(), NULL, NULL, FALSE, TRUE))) .
      t("<h3>URL Aliases for publication edition</h3>".
      "<p>The Publication edition can have custom URL aliases. To enable the URL aliases, one must enable the 'path' module from the !modules.</p>",
      array('!modules' => l(t("module list"), "admin/build/modules", array(), NULL, NULL, FALSE, TRUE))) .
      t("<h3>Viewing latest headlines</h3>".
      "<p>In addition to displaying postings that have been collected into specific editions of a publication, you can also view a list of the most recent postings in each topic section ".
      "at \"epublish/headlines/{sid}\" where {sid} is a numeric section ID. \"Topics\" use taxonomy terms to organize content according to the following rules:</p>\n".
      "<li>When editing the topics in each section, you can set an \"automatically-included headlines limit\" specifying the maximum number of headlines that should be included for that topic and also set a time frame that limits the search. For example, a time ".
      "frame of \"30 days\" means that postings older than that will be ignored. You can also specify which node types are eligible for inclusion.</li>\n".
      "<li>Most topics refer to a taxonomy term and all of its descendants. For example, a taxonomy might include the term \"music,\" with child terms \"rock,\" \"classical,\" \"jazz.\" Only nodes that have been tagged with one or more of these terms would be included in the topic \"music.\"</li>\n".
      "<li>In addition, there are three special topics, named \"top stories\" \"advertisement\" and \"miscellaneous,\" which do not filter for taxonomy terms at all. \"Top stories\" are taken from stories that have been marked as \"sticky at top of lists\. ".
      "The \"miscellaneous\" topic appears at the bottom of each section. (If, however, you set its \"automatically-included headlines limit\" to zero, no miscellanous headlines will be displayed.)</li>\n") .
      t("<h3>Publications and headlines blocks</h3>".
      "<p>The epublish module creates a sidebar block for each section, as well as an \"epublish\" block that lists all publications. To make blocks visible on your pages, use !blocks.</p>",
      array('!blocks' => l(t("administer &raquo; blocks"), "admin/block", array(), NULL, NULL, FALSE, TRUE))) .
      t("<h3>Customizing layouts</h3>\n".
      "<p>The epublish module comes with several standard \"layouts\" that make it possible to customize the layout of publication pages. The \"node views,\" \"one- and two-column\" and \"regular\" layouts are different ".
      "page layouts for displaying nodes from a single edition. The \"simple list of headlines only\" layout is used on pages that list multiple editions of a publication.</p>\n".
      "<p>You can use !settings to select a headlines <b>layout</b> and <b>section</b> that apply to all publications and their editions. If you check the \"custom layouts\" or \"custom sections\" boxes, ".
      "individual publications and editions can also be assigned their own separate layouts and sections that override the global settings, according to the following order of precedence:</p>\n".
      "<h4>Section selection</h4>".
      "<ul><li>If the <i>edition</i> specifies a custom section, it takes precedence.</li>\n".
      "<li>Otherwise, if the <i>publication</i> specifies a custom section, it takes precedence.</li>\n".
      "<li>Otherwise, the globally-specified section is used.</li></ul>\n".
      "<h4>Layout selection</h4>".
      "<ul><li>If the <i>section</i> specifies a custom layout, it takes precedence.</li>\n".
      "<li>Otherwise, if the <i>edition</i> specifies a custom layout, it takes precedence.</li>\n".
      "<li>Otherwise, if the <i>publication</i> specifies a custom layout, it takes precedence.</li>\n".
      "<li>Otherwise, the globally-specified layout is used.</li></ul>\n".
      "<p>The ability to customize layouts and sections provides considerable flexibility for design purposes, but it can can also make administration of publications more complicated. Most users will probably ".
      "want to leave the \"custom layouts\" option turned off.</p>\n" .
      "<p>Layouts are also themeable, and additional layouts can be can be added as needed. For an explanation of how to do this, see the README.txt TImes of India
times desc
Volume 54
TImes of India
times desc
Volume 54

    *
      1 edition, Volume 54, No. 534TImes of India
times desc
Volume 54

    *
      1 edition, Volume 54, No. 534
      435TImes of India
times desc
Volume 54

    *
      1 edition, Volume 54, No. 534
      435

Volume 22

    *
      2nd edition, Volume 22, No. 22
      22

Volume 22

    *
      2nd edition, Volume 22, No. 22
      22
      435

Volume 22

    *
      2nd edition, Volume 22, No. 22
      22
    *
      1 edition, Volume 54, No. 534
      435

Volume 22

    *
      2nd edition, Volume 22, No. 22
      22file that comes included with this module.</p>",
      array('!settings' => l(t("epublish settings"), "admin/settings/epublish")));
      break;
      }
    return $output;
}

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

/**
 * Implementation of hook_menu().
 */
function epublish_menu() {
  $items['epublish'] = array(
    'title' => 'Publications',
    'page callback' => 'epublish_pub_page',
    'access callback' => 'user_access',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
  );
  $items['headlines'] = array(
    'title' => 'Headlines',
    'page callback' => 'epublish_headlines_page',
    'access callback' => 'user_access',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish'] = array(
    'title' => 'Epublish',
    'page callback' => 'epublish_pub_list',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
  );
  $items['admin/epublish/list'] = array(
    'title' => 'List publications',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10
  );
  $items['admin/epublish/add/publication'] = array(
    'title' => 'Add publication',
    'page callback' => 'epublish_admin_publication_edit',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_LOCAL_TASK
  );
  $items['admin/epublish/edit/publication'] = array(
    'title' => 'Edit publication',
    'page callback' => 'epublish_admin_publication_edit',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish/add/edition'] = array(
    'title' => 'Add edition',
    'page callback' => 'epublish_admin_edition_add',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish/edit/edition'] = array(
    'title' => 'Edit edition',
    'page callback' => 'epublish_admin_edition_edit',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish/sections'] = array(
    'title' => 'Sections and Topics',
    'page callback' => 'epublish_sections_table',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_LOCAL_TASK
  );
  $items['admin/epublish/add/section'] = array(
    'title' => 'Add section',
    'page callback' => 'epublish_admin_section_edit',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish/edit/section'] = array(
    'title' => 'Edit section',
    'page callback' => 'epublish_admin_section_edit',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish/add/topic'] = array(
    'title' => 'Add topic',
    'page callback' => 'epublish_admin_topic_add',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish/edit/topic'] = array(
    'title' => 'Edit topic',
    'page callback' => 'epublish_admin_topic_edit',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish/headlines'] = array(
    'title' => 'Add headlines',
    'page callback' => 'epublish_admin_node_head',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/epublish/edit/volume'] = array( 
    'title' => 'Edit volume name',
    'page callback' => 'epublish_admin_volume_edit',
    'access callback' => 'user_access',
    'access arguments' => array('administer publications'),
    'type' => MENU_CALLBACK
  );
  $items['admin/settings/epublish'] = array(
    'title' => 'Epublish',
    'description' => 'Describes what the settings generally do.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('epublish_admin_settings'),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'type' => MENU_NORMAL_ITEM,
  );
  $path = drupal_get_path('module', 'epublish');
  if (variable_get('epublish_css', 1)) {
    drupal_add_css($path .'/epublish.css');
  }
  drupal_add_js($path .'/epublish.js');
  return $items;
}

/**
 * Implementation of hook_settings().
 */
function epublish_admin_settings() {
    $form['display'] = array(
    '#type' => 'fieldset',
    '#title' => t('Display'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $order = array('ASC' => 'ascending', 'DESC' => 'descending');
  $form['display']['epublish_edition_order'] = array(
    '#type' => 'select',
    '#title' => t("Display order for listing editions"),
    '#default_value' => variable_get('epublish_edition_order', 'DESC'),
    '#options' => $order,
    '#description' => t("Descending order means that the most recent editions will appear at the top of the list."),
  );
  $form['display']['epublish_top_stories'] = array(
    '#type' => 'textfield',
    '#title' => t('Top stories'),
    '#default_value' => variable_get('epublish_top_stories', t('top stories')),
    '#size' => 50,
    '#maxlength' => 128,
    '#description' => t('The subtitle used for top stories in a headlines section.'),
  );
  $form['display']['epublish_miscellaneous'] = array(
    '#type' => 'textfield',
    '#title' => t('Miscellaneous stories'),
    '#default_value' => variable_get('epublish_miscellaneous', t('miscellaneous')),
    '#size' => 50,
    '#maxlength' => 128,
    '#description' => t('The subtitle used for miscellaneous stories in a headlines section.'),
  );
  $form['display']['epublish_advertisement'] = array(
    '#type' => 'textfield',
    '#title' => t('Advertisement stories'),
    '#default_value' => variable_get('epublish_advertisement', t('advertisement')),
    '#size' => 50,
    '#maxlength' => 128,
    '#description' => t('The subtitle used for advertisement stories in a headlines section.'),
  );
  $form['display']['epublish_css'] = array(
    '#type' => 'select',
    '#title' => t("Include ePublish CSS file"),
    '#default_value' => variable_get('epublish_css', 1),
    '#options' => array(1 => t('enabled'), 0 => t('disabled')),
    '#description' => t("You may want disable the ePublish CSS file and add all necessary styles to your theme."),
  );
  // layouts
  $layouts = epublish_layouts('page');
  $form['layouts'] = array(
    '#type' => 'fieldset',
    '#title' => t('Layouts'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['layouts']['epublish_global_layout_page'] = array(
    '#type' => 'select',
    '#title' => t("Page layout"),
    '#default_value' => variable_get('epublish_global_layout_page', 'regular'),
    '#options' => $layouts,
    '#description' => t("Select a page layout."),
  );
  $layouts = epublish_layouts('list');
  $form['layouts']['epublish_global_layout_list'] = array(
    '#type' => 'select',
    '#title' => t("Listing layout"),
    '#default_value' => variable_get('epublish_global_layout_list', 'list'),
    '#options' => $layouts,
    '#description' => t("Select a layout to control the display of headline listings."),
  );
  $form['layouts']['epublish_custom_layouts'] = array(
    '#type' => 'checkbox',
    '#title' => t('Custom layouts?'),
    '#return_value' => 1,
    '#default_value' => variable_get('epublish_custom_layouts', '0'),
    '#description' => t('If this option is checked, publications, sections and editions can each have their own own layouts that override the global layouts selected above.'),
  );
  // sections
  $sids = epublish_sections();
  $array_keys = array_keys($sids);
  $form['sections'] = array(
    '#type' => 'fieldset',
    '#title' => t('Sections'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['sections']['epublish_global_sid'] = array(
    '#type' => 'select',
    '#title' => t("Headlines section"),
    '#default_value' => variable_get('epublish_global_sid', array_shift($array_keys)),
    '#options' => $sids,
    '#description' => t("Select a section to control which topics are headlined in each publication."),
  );
  $form['sections']['epublish_custom_sections'] = array(
    '#type' => 'checkbox',
    '#title' => t('Custom sections?'),
    '#return_value' => 1,
    '#default_value' => variable_get('epublish_custom_sections', '0'),
    '#description' => t('If checked, each publication and edition can have its own section that overrides the global section selected above.'),
  );
  return system_settings_form($form);
}

/**
 * Implementation of hook_form_alter().
 */
function epublish_form_alter(&$form, $form_state, $form_id) {
  if ($form_id == 'node_type_form') {
      $form['submission']['epublish_abstract'] = array(
      '#type' => 'checkbox',
      '#title' => t('Has abstract'),
      '#return_value' => 1,
      '#default_value' => variable_get('epublish_abstract_'. $form['#node_type']->type, TRUE),
      '#description' => t('Users can enter a brief abstract summarizing the content of each node.'),
    );
  }
  else if (isset($form['type']) && $form['type']['#value'] .'_node_form' == $form_id) {
    if (variable_get('epublish_abstract_'. $form['type']['#value'], TRUE)) {
      $node = $form['#node'];
      $form['epublish_abstract'] = array(
        '#type' => 'textarea',
        '#title' => t('Abstract'),
        '#default_value' => $node->epublish_abstract,
        '#cols' => 70,
        '#rows' => 4,
        '#description' => t('A brief summary of this item.'),
      );
    }
  }
}

/**
 * Implementation of hook_nodeapi().
 */
function epublish_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
  switch ($op) {
    case 'insert':
      if (variable_get('epublish_abstract_'. $node->type, TRUE)) {
        db_query("INSERT INTO {epublish_abstract} (nid, epublish_abstract) VALUES ('%d', '%s')", $node->nid, $node->epublish_abstract);
      }
    break;
    case 'update':
      if (variable_get('epublish_abstract_'. $node->type, TRUE)) {
        db_query("DELETE FROM {epublish_abstract} WHERE nid = '%d'", $node->nid);
        if ($node->epublish_abstract) {
          db_query("INSERT INTO {epublish_abstract} (nid, epublish_abstract) VALUES ('%d', '%s')", $node->nid, $node->epublish_abstract);
        }
      }
    break;
    case 'delete':
    db_query("DELETE FROM {epublish_edition_node} WHERE nid = '%d'", $node->nid);
    if (variable_get('epublish_abstract_'. $node->type, TRUE)) {
      db_query("DELETE FROM {epublish_abstract} WHERE nid = '%d'", $node->nid);
    }
    break;
    case 'load':
      if (variable_get('epublish_abstract_'. $node->type, TRUE)) {
        $object = db_fetch_object(db_query("SELECT epublish_abstract FROM {epublish_abstract} WHERE nid = '%d'", $node->nid));
        return array('epublish_abstract' => $object->epublish_abstract);
      }
    break;
    case 'view':
      // append epublish navigation to all nodes that belong to an edition
      if (!$a3) {
        $eid = db_result(db_query('SELECT eid FROM {epublish_edition_node} een WHERE nid = %d', $node->nid));
        if ($eid) {
          $node = theme('epublish_navigation', $node, $eid);
        }
      }
    break;
  }
}

/**
 * Implementation of hook_block().
 */
function epublish_block($op = 'list', $delta = 0) {
  if ($op == 'list') {
    $blocks = array();
    $blocks[0]['info'] = t('E-Publish');
    foreach (epublish_sections() as $sid => $title) {
      $blocks[$sid]['info'] = t('E-publish section: ') . t($title);
    }
    $publications = db_query("SELECT * FROM {epublish_publication}");
    while ($publication = db_fetch_object($publications)) {
      $blocks['pub_'. $publication->pid]['info'] = t($publication->name);
      $blocks['cur_edition_'. $publication->pid]['info'] = t("Current edition of @pub", array('@pub' => $publication->name));
    }
    return $blocks;
  }
  else if ($op == 'view') {
    // publication blocks
    if (substr($delta, 0, 12) == 'cur_edition_') {
      $pid = substr($delta, 12);
      $publication = epublish_get_pub($pid);
      $data['subject'] = t($publication->name);
      $eid = epublish_current_edition($pid);
      $edition = epublish_get_edition($eid);
      $sid = epublish_assign_section($edition);
      $topics = epublish_section_topics($sid, $edition->eid);
      $items = array();
      foreach ($topics as $topic) { 
        foreach ($topic->nodes as $nid) {
          $node = node_load($nid);
          $items[] = l($node->title, "node/$nid");
        }
      }
      $data['content'] = theme('item_list', $items);
      return $data;
    }
    else if (substr($delta, 0, 4) == 'pub_') {
      $pid = substr($delta, 4);
      $publication = epublish_get_pub($pid);
      $data['subject'] = t($publication->name);
      $items = array();
      $order = variable_get('epublish_edition_order', 'DESC');
      $result = db_query("SELECT * FROM {epublish_edition} WHERE published=1 AND pid='%d' ORDER BY volume $order, number $order, pubdate $order, eid $order LIMIT 10", $publication->pid);
      while (($edition = db_fetch_object($result)) && $i++ < 10) {
        $items[] = l(theme('epublish_edition_reference', $edition), "epublish/$publication->pid/$edition->eid");
      }
      $data['content'] = theme('item_list', $items);
      if ($i == 10) {
        $data['content'] .= '<div class="more-link">'. l(t('more'), "epublish/$publication->pid", array('title' => t('More editions.'))) .'</div>';
      }
      return $data;
      // section blocks
    }
    else if ($delta) {
      $section = epublish_get_section($delta);
      $topics = epublish_topic_selection_list($delta);
      $data['subject'] = l(t($section->title), "headlines/$delta");
      $items = array();
      foreach ($topics as $tid => $name) {
        if ($tid > 0) {
          $items[] = l(t($name), "taxonomy/term/$tid");
        }
      }
      $data['content'] = theme('item_list', $items);
      return $data;
      }
      else {
        $data['subject'] = t('Publications');
        $result = db_query("SELECT * from {epublish_publication}");
        $items = array();
        while ($publication = db_fetch_object($result)) {
          $items[] = l($publication->name, "epublish/$publication->pid");
        }
        $data['content'] .= theme('item_list', $items);
        return $data;
      }
  }
}

/*******************************************
 *	 LISTINGS
 ******************************************/

/**
 * epublish_sections: lists all publication sections.
 *
 * @param $include_default
 *	 A Boolean value indicating whether a "default" option should be included
 *
 * @return
 *	 An array of sections and their titles, suitable for use as the $options in a form_select call, e.g.,
 *			form_select($title, $name, $value, epublish_sections(), $description)
 */
function epublish_sections($include_default = FALSE) {
  $result = db_query("SELECT COUNT(*) FROM {epublish_section}");
  $sections = array();
  // if no sections exist, create a default section
  if (!db_result($result)) {
    $nodetype = array();
    foreach (node_get_types() as $type => $name) {
      $nodetypes[$type] = $name;
    }
    $array_keys = array_keys(module_invoke('taxonomy', 'get_vocabularies'));
    $vid = array_pop($array_keys);
    $form_state = array(
      'title' => t('default'),
      'vid' => $vid,
      'node_types' => $nodetypes,
      'timeframe' => '',
      'layout_list' => '',
      'layout_page' => ''
    );
    epublish_form_section_submit(NULL, $form_state);
    $result = db_query("SELECT * FROM {epublish_section}");
  }
  if ($include_default) {
    $sections[0] = t('<default>');
  }
  $result = db_query("SELECT * FROM {epublish_section}"); 
  while ($section = db_fetch_object($result)) {
    $sections[$section->sid] = $section->title;
  }
  return $sections;
}

/**
 * epublish_layouts: Loads and lists all installed publication layouts.
 *
 * Layouts are loaded from files in the epublish directory. Each layout file should have the filename
 *		layout_{name}.inc
 * Its content should set the variable $description = a short description of the layout (for display in a form_select pulldown menu)
 * It should also include a function with the filename and parameters
 *		theme_epublish_layout_{name}($section, $params=NULL)
 *
 * @param $context_selection
 *	 A text string indicating the context in which the layout should appear. Possible contexts include:
 *		--> 'list'	=> a listing (for example, a list of headlines within an edition)
 *		--> 'page'	=> the entire contents of a page
 *		--> 'email' => the text of an email (currently not used)
 *		--> 'rss'	 => an RSS feed (currently not used)
 *
 * @return
 *	 An array of layouts and their descriptions, suitable for use as the $options in a form_select call, e.g.,
 *			form_select($title, $name, $value, epublish_layouts(), $description)
 */
function epublish_layouts($context_selection=NULL, $include_default=FALSE) {
  static $layouts, $contexts;
  if (!isset($layouts)) {
    $layouts = array();
    $files = file_scan_directory(drupal_get_path('module', 'epublish'), '^epublish_layout_.*\.inc$');
    foreach ($files as $filename => $file) {
      include_once($filename);
      $layouts[drupal_substr($file->name, 16)] = $description;
      if ($context) {
        $contexts[$context][drupal_substr($file->name, 16)] = $description;
      }
    }
  }
  if ($context_selection) {
    if ($include_default) {
      return array_merge(array(0 => t('<default>')), $contexts[$context_selection]);
    }
    else {
      return $contexts[$context_selection];
    }
  }
  else {
    if ($include_default) {
      return array_merge(array(0 => t('<default>')), $layouts);
    }
    else {
      return $layouts;
    }
  }
}

// Load all layouts.
epublish_layouts();


/*******************************************
 *	 DISPLAY FUNCTIONS
 ******************************************/


/**
 * theme_epublish_abstract: A themeable function to display the abstract for an article.
 */
function theme_epublish_abstract($abstract) {
  return '<div class="epublish_abstract">'. $abstract .'</div>';
}

/**
 * theme_epublish_topics: A themeable function to display the headlines from an array of topics.
 *
 * @param $topics
 *	 An array of topics
 * @param $sid
 *	 A headlines section ID number
 * @param $eid
 *	 An edition ID number
 * @param $context
 *	 The context in which the headlines will appear. Possibilities include:
 *			--> 'list'	=> a list of items (i.e., "<li>item1</li><li>item2</li>..."
 *			--> 'page'	=> the result will be the main content of a page
 *
 * @return
 *	 An HTML-formatted list of headlines.
 */
function theme_epublish_topics(&$topics, $sid, &$edition, $context='page') {
  $params = array();
  if ($edition->description) {
    $params['description'] = $edition->description;
  }
  $layout = epublish_assign_layout($sid, $edition, $context);
  $function = "theme_epublish_layout_$layout";
  if (function_exists($function)) {
    return theme("epublish_layout_$layout", $topics, $params);
  }
}

/**
 * theme_epublish_volume_reference: Themeable function that returns the reference string for an edition of a publication.
 *
 * @param $pid
 *	 A publication ID.
 * @param $volume
 *	 A volume number
 *
 * @return
 *	 A text string describing the volume.
 */
function theme_epublish_volume_reference($pid, $volume) {
  $dateline = db_result(db_query("SELECT dateline FROM {epublish_volume} WHERE pid='%d' AND volume='%d'", $pid, $volume));
  if ($dateline) {
    return $dateline;
  }
  if ($volume) {
    return t('Volume') ." $volume";
  }
  return t('<none>');
}

/**
 * theme_epublish_edition_reference: Themeable function that returns the reference string for an edition of a publication.
 *
 * @param $edition
 *	 An edition object.
 *
 * @return
 *	 A text string describing the edition.
 */
function theme_epublish_edition_reference(&$edition) {
  $reference = array();
  if ($edition->dateline) {
    $reference[] = t($edition->dateline);
  }
  if ($edition->volume) {
    $reference[] = t('Volume') ." $edition->volume";
  }
  if ($edition->number) {
    $reference[] = t('No.') ." $edition->number";
  }
  return implode(', ', $reference);
}

/**
 * epublish_pub_page: Display the publication(s).
 */
function epublish_pub_page() {
  $pub = arg(1);
  $ed = arg(2); //) ? arg(2) : 'current';
  if (is_numeric($pub)) {
    $publication = epublish_get_pub($pub);
  }
  else if ($pub) {
    $publication = epublish_get_pub_by_name($pub);
  }
  if ($publication) {
    if ($ed == t('current')) {
      $ed = epublish_current_edition($publication->pid);
    }
  }
  else {
    return theme('epublish_format_pub');
  }
  if (is_numeric($ed)) {
    $edition = epublish_get_edition($ed);
    $sid = epublish_assign_section($edition);
    $topics = epublish_section_topics($sid, $edition->eid);
    $output = theme('epublish_topics', $topics, $sid, $edition, 'page');
  }
  else {
    $order = variable_get('epublish_edition_order', 'DESC');
    preg_match('/(v([0-9]+))?(n([0-9]+))?/i', $ed, $match);
    $volume = $match[2] ? (" AND volume=" . $match[2]) : '';
    $number = $match[4] ? (" AND number=" . $match[4]) : '';
    //$num_editions = db_result(db_query("SELECT COUNT(*) FROM {epublish_edition} WHERE published=1 AND pid='%d'$volume$number", $publication->pid));
    $num_editions = db_result(db_query("SELECT COUNT(*) FROM {epublish_edition} WHERE published=1 AND pid='%d'$volume$number ORDER BY volume $order, number $order, pubdate $order, eid $order", $publication->pid));
    $editions = db_query("SELECT * FROM {epublish_edition} WHERE published=1 AND pid='%d'$volume$number ORDER BY volume $order, number $order, pubdate $order, eid $order", $publication->pid);
    if ($num_editions == 1) {
      $edition = db_fetch_object($editions);
      $sid = epublish_assign_section($edition);
      $topics = epublish_section_topics($sid, $edition->eid);
      $output = theme('epublish_topics', $topics, $sid, $edition, 'page');
    }
    else {
      $edition = NULL;
      if (!$ed) {
        $output .= '<div class="content">'. $publication->description .'</div>';
      }
      $editions = db_query("SELECT * FROM {epublish_edition} WHERE published=1 AND pid='%d'$volume$number ORDER BY volume $order, number $order, pubdate $order, eid $order", $publication->pid);
      while ($ed = db_fetch_object($editions)) {
        if ($previous_volume && ($ed->volume != $previous_volume)) {
          $output .= theme('epublish_format_volume', $previous_volume, $publication->pid, $edition_blocks);
          $edition_blocks = array();
        }
        $edition_blocks[] = theme('epublish_format_edition', $ed);
        $previous_volume = $ed->volume;
      }
      if ($edition_blocks) {
        $output .= theme('epublish_format_volume', $previous_volume, $publication->pid, $edition_blocks);
      }
      $output = '<div class="node"><div class="epublish">'. $output .'</div></div>';
    }
  }
  return theme('epublish_pub_page', $output, $publication, $edition, $match[2]);
}

/**
 * theme_epublish_pub_page: Display the page.
 *
 * @param $output
 *	 A publication ID.
 * @param $publication
 *	 A publication object
 * @param $edition
 *	 An edition object
 * @param $volume
 *	 A volume number (used only if a single edition is not specified)
 */
function theme_epublish_pub_page(&$output, &$publication, &$edition, $volume=NULL) {
  if ($publication) {
    $breadcrumb[] = l(t('Home'), NULL);
    $breadcrumb[] = l(t($publication->name), "epublish/$publication->pid"); 
    $title = $publication->name;
  }
  if ($edition->volume) {
    $breadcrumb[] = l(theme('epublish_volume_reference', $edition->pid, $edition->volume), "epublish/$edition->pid/v$edition->volume");
    $title = "$publication->name, " . theme('epublish_volume_reference', $edition->pid, $edition->volume);
  }
  else if ($volume) {
    $breadcrumb[] = l(t(theme('epublish_volume_reference', $publication->pid, $volume)), "epublish/$publication->pid/v$volume");
    $title = "$publication->name, " . theme('epublish_volume_reference', $publication->pid, $volume);
  }
  if ($edition) {
    $title = "$publication->name, " . theme('epublish_edition_reference', $edition);
  }
  if ($output) {
        drupal_set_breadcrumb($breadcrumb);
  }
  drupal_set_title(check_plain($title));
  return $output;
}


/**
 * epublish_headlines_page: Display the headlines.
 */
function epublish_headlines_page() {
  $sid = arg(1);
  $sids = epublish_sections();
  if (!$sid) {
    $array_keys = array_keys($sids);
    $sid = variable_get('epublish_global_sid', array_shift($array_keys));
  }
  $section = epublish_get_section($sid);
  if ($section->timeframe) {
    $timeframe = " AND (n.created >= '". strtotime('-'. $section->timeframe) ."' OR n.sticky=1)";
  }
  $result = db_query("SELECT et.tid, et.count, et.node_types, td.name FROM {epublish_topic} et LEFT JOIN {term_data} td USING (tid) WHERE et.sid='%d' ORDER BY et.weight", $sid);
  $all_nodes = array();
  $topics = array();
  while ($topic = db_fetch_object($result)) {
    $included_node_types = _epublish_build_node_inclusions(array_unique(array_merge(explode(',', $section->node_types), explode(',', $topic->node_types))));
    $exclusions = _epublish_build_node_exclusions($all_nodes);
  // Condition to handle another default section
    if ($topic->tid == -2) {
      $topic->name = variable_get('epublish_advertisement', t('advertisement'));
      $result2 = db_query("SELECT DISTINCT(n.nid) FROM {node} n WHERE ($exclusions) AND ($included_node_types) AND n.promote = 1 AND n.status = 1$timeframe AND n.sticky = 1 ORDER by n.created DESC LIMIT $topic->count");
    }
    else if ($topic->tid == -1) {
      $topic->name = variable_get('epublish_top_stories', t('top stories'));
      $result2 = db_query("SELECT DISTINCT(n.nid) FROM {node} n WHERE ($exclusions) AND ($included_node_types) AND n.promote = 1 AND n.status = 1$timeframe AND n.sticky = 1 ORDER by n.created DESC LIMIT $topic->count");
    }
    else if ($topic->tid == 0) {
      $topic->name = variable_get('epublish_miscellaneous', t('miscellaneous'));
      $result2 = db_query("SELECT DISTINCT(n.nid) FROM {node} n WHERE ($exclusions) AND ($included_node_types) AND n.promote = 1 AND n.status = 1$timeframe ORDER by n.sticky DESC, n.created DESC LIMIT $topic->count");
    }
    else {
      $included_terms = _epublish_topic_term_inclusions($topic->tid, $sid);
      $result2 = db_query("SELECT DISTINCT(n.nid) FROM {node} n INNER JOIN {term_node} tn ON n.nid=tn.nid WHERE ($exclusions) AND ($included_node_types) AND ($included_terms) AND n.promote = 1 AND n.status = 1$timeframe ORDER by n.sticky DESC, n.created DESC LIMIT $topic->count");
    }
    $topic->nodes = array();
    while ($node = db_fetch_object($result2)) {
      $topic->nodes[] = $node->nid;
      $all_nodes[] = $node->nid;
    }
    if (count($topic->nodes)) {
      $topics[] = $topic;
    }
  }
  drupal_set_title(check_plain($section->title));
  $edition = NULL;
  return theme('epublish_topics', $topics, $sid, $edition, 'page');
}

/**
 * theme_epublish_format_volume: A themeable function that lists the issues
 * of a single volume of a publication.
 *
 * @param $volume
 *	 A volume number.
 * @param $pid
 *	 A publication ID number
 * @param $edition_blocks
 *	 A list of blocks of HTML text, one for each edition of a volume.
 *
 * @return
 *	 An HTML-formatted display showing the reference name of the volume and a list of its editions.
 */
function theme_epublish_format_volume($volume, $pid, $edition_blocks = array()) {
  if ($volume) {
    $output = '<h3>'. l(theme('epublish_volume_reference', $pid, $volume), "epublish/$pid/v$volume") ."</h3>\n";
  }
  $output .= '<ul>'. implode('', $edition_blocks) ."</ul>\n";
  return '<div class="volume">'."$output</div>\n";
}

/**
 * theme_epublish_format_edition: A themeable layout that lists the nodes in a single edition of a publication.
 *
 * @param $edition
 *	 An edition object.
 *
 * @return
 *	 An HTML-formatted display showing the reference name of the edition and a list of its headlines.
 */
function theme_epublish_format_edition(&$edition) {
  $sid = epublish_assign_section($edition);
  $topics = epublish_section_topics($sid, $edition->eid);
  if (is_numeric($edition->volume) && is_numeric($edition->number) && $edition->volume > 0 && $edition->number > 0) {
    $output = "<li><div class=\"reference\">". l(theme('epublish_edition_reference', $edition), "epublish/$edition->pid/v$edition->volume" ."n$edition->number") ."</div></li>\n";
  }
  else {
    $output = "<li><div class=\"reference\">". l(theme('epublish_edition_reference', $edition), "epublish/$edition->pid/$edition->eid") ."</div></li>\n";
  }
  $output .= theme('epublish_topics', $topics, $sid, $edition, 'list');
  return '<div class="edition">'."$output</div>\n";
}

/**
 * theme_epublish_format_pub: A themeable function that lists all of the publications on the site.
 *
 * @return
 *	 An HTML-formatted display showing the name of each publication and its description.
 */
function theme_epublish_format_pub() {
  $result = db_query("SELECT * from {epublish_publication}");
  $output = '<dl>';
  while ($publication = db_fetch_object($result)) {
    $output .= '<dt>'. l($publication->name, "epublish/$publication->pid") ."</dt>\n";
    if ($publication->description) {
      $output .= "<dd>$publication->description</dd>\n";
    }
  }
  $output .= "</dl>\n";
  drupal_set_title(t('publications'));
  return "<div class=\"epublish\">$output</div>";
}

/*******************************************
 *	 SELECTORS
 ******************************************/

/**
 * epublish_assign_layout: chooses the right layout to use in displaying an array of topics.
 *	 If the "custom layouts" option is turned on, this function looks for a layout in the following
 *	 order and chooses the first one it finds:
 *		 --> section
 *		 --> edition
 *		 --> publication
 *		 --> global settings
 *
 * @param $sid
 *	 A headlines section ID number
 * @param $eid
 *	 An edition ID number
 * @param $context
 *	 The context in which the layout is designed to appear. Possibilities include:
 *			--> 'list'	=> a list of items (i.e., "<li>item1</li><li>item2</li>..."
 *			--> 'page'	=> the result will be the main content of a page
 *
 * @return
 *	 the name of the layout to use
 */
function epublish_assign_layout($sid, &$edition, $context) {
  $layout = "layout_$context";
  if (variable_get('epublish_custom_layouts', '0')) {
    $section = epublish_get_section($sid);
    if ($section->$layout) {
      return $section->$layout;
    }
    if ($edition->$layout) {
      return $edition->$layout;
    }
    $publication = epublish_get_pub($edition->pid);
    if ($publication->$layout) {
      return $publication->$layout;
    }
  }
  if ($context == 'page') {
    return variable_get('epublish_global_layout_page', 'regular');
  }
  else {
    return variable_get('epublish_global_layout_list', 'list');
  }
}

/**
 * epublish_assign_section: chooses the right headlines section to use for organizing
 *	 topics and their headlines. If the "custom sections" option is turned on, this
 *	 function looks for a layout in the following order and chooses the first one it finds:
 *		 --> edition
 *		 --> publication
 *		 --> global settings
 *
 * @param $edition
 *	 An edition object
 *
 * @return
 *	 the headlines section ID number
 */
function epublish_assign_section(&$edition) {
  $sids = epublish_sections();
  if (variable_get('epublish_custom_sections', FALSE)) {
    if ($sids[$edition->sid]) {
      return $edition->sid;
    }
    $publication = epublish_get_pub($edition->pid);
    if ($sids[$publication->sid]) {
      return $publication->sid;
    }
  }
  $array_keys = array_keys($sids);
  $auto_sid = array_shift($array_keys);
  $sid = variable_get('epublish_global_sid', $auto_sid);
  if ($sids[$sid]) {
    return $sid;
  }
  else {
    return $auto_sid;
  }
}

/**
 * epublish_topic_selection_list: returns the topics associated with a specific section ID
 *
 * @param $sid
 *	 A section ID.
 *
 * @return
 *	 An associative array of topic IDs and their reference names, for use as the $options parameter in form_select function calls
 */