<?php

/**

 * @file

 * Provides discussion forums.

 */

/**

 * Implements hook_help().

 */

function forum_help($path, $arg) {

  switch ($path) {

    case 'admin/help#forum':

      $output = '';

      $output .= '<h3>' . t('About') . '</h3>';

      $output .= '<p>' . t('The Forum module lets you create threaded discussion forums with functionality similar to other message board systems. Forums are useful because they allow community members to discuss topics with one another while ensuring those conversations are archived for later reference. In a forum, users post topics and threads in nested hierarchies, allowing discussions to be categorized and grouped. The forum hierarchy consists of:') . '</p>';

      $output .= '<ul>';

      $output .= '<li>' . t('Optional containers (for example, <em>Support</em>), which can hold:') . '</li>';

      $output .= '<ul><li>' . t('Forums (for example, <em>Installing Drupal</em>), which can hold:') . '</li>';

      $output .= '<ul><li>' . t('Forum topics submitted by users (for example, <em>How to start a Drupal 6 Multisite</em>), which start discussions and are starting points for:') . '</li>';

      $output .= '<ul><li>' . t('Threaded comments submitted by users (for example, <em>You have these options...</em>).') . '</li>';

      $output .= '</ul>';

      $output .= '</ul>';

      $output .= '</ul>';

      $output .= '</ul>';

      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@forum">Forum module</a>.', array('@forum' => 'http://drupal.org/documentation/modules/forum')) . '</p>';

      $output .= '<h3>' . t('Uses') . '</h3>';

      $output .= '<dl>';

      $output .= '<dt>' . t('Setting up forum structure') . '</dt>';

      $output .= '<dd>' . t('Visit the <a href="@forums">Forums page</a> to set up containers and forums to hold your discussion topics.', array('@forums' => url('admin/structure/forum'))) . '</dd>';

      $output .= '<dt>' . t('Starting a discussion') . '</dt>';

      $output .= '<dd>' . t('The <a href="@create-topic">Forum topic</a> link on the <a href="@content-add">Add new content</a> page creates the first post of a new threaded discussion, or thread.', array('@create-topic' => url('node/add/forum'), '@content-add' => url('node/add'))) . '</dd>';

      $output .= '<dt>' . t('Navigation') . '</dt>';

      $output .= '<dd>' . t('Enabling the Forum module provides a default <em>Forums</em> menu item in the navigation menu that links to the <a href="@forums">Forums page</a>.', array('@forums' => url('forum'))) . '</dd>';

      $output .= '<dt>' . t('Moving forum topics') . '</dt>';

      $output .= '<dd>' . t('A forum topic (and all of its comments) may be moved between forums by selecting a different forum while editing a forum topic. When moving a forum topic between forums, the <em>Leave shadow copy</em> option creates a link in the original forum pointing to the new location.') . '</dd>';

      $output .= '<dt>' . t('Locking and disabling comments') . '</dt>';

      $output .= '<dd>' . t('Selecting <em>Closed</em> under <em>Comment settings</em> while editing a forum topic will lock (prevent new comments on) the thread. Selecting <em>Hidden</em> under <em>Comment settings</em> while editing a forum topic will hide all existing comments on the thread, and prevent new ones.') . '</dd>';

      $output .= '</dl>';

      return $output;

    case 'admin/structure/forum':

      $output = '<p>' . t('Forums contain forum topics. Use containers to group related forums.') . '</p>';

      $output .= theme('more_help_link', array('url' => 'admin/help/forum'));

      return $output;

    case 'admin/structure/forum/add/container':

      return '<p>' . t('Use containers to group related forums.') . '</p>';

    case 'admin/structure/forum/add/forum':

      return '<p>' . t('A forum holds related forum topics.') . '</p>';

    case 'admin/structure/forum/settings':

      return '<p>' . t('Adjust the display of your forum topics. Organize the forums on the <a href="@forum-structure">forum structure page</a>.', array('@forum-structure' => url('admin/structure/forum'))) . '</p>';

  }

}

/**

 * Implements hook_theme().

 */

function forum_theme() {

  return array(

    'forums' => array(

      'template' => 'forums',

      'variables' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),

    ),

    'forum_list' => array(

      'template' => 'forum-list',

      'variables' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),

    ),

    'forum_topic_list' => array(

      'template' => 'forum-topic-list',

      'variables' => array('tid' => NULL, 'topics' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),

    ),

    'forum_icon' => array(

      'template' => 'forum-icon',

      'variables' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0, 'first_new' => FALSE),

    ),

    'forum_submitted' => array(

      'template' => 'forum-submitted',

      'variables' => array('topic' => NULL),

    ),

    'forum_form' => array(

      'render element' => 'form',

      'file' => 'forum.admin.inc',

    ),

  );

}

/**

 * Implements hook_menu().

 */

function forum_menu() {

  $items['forum'] = array(

    'title' => 'Forums',

    'page callback' => 'forum_page',

    'access arguments' => array('access content'),

    'file' => 'forum.pages.inc',

  );

  $items['forum/%forum_forum'] = array(

    'title' => 'Forums',

    'page callback' => 'forum_page',

    'page arguments' => array(1),

    'access arguments' => array('access content'),

    'file' => 'forum.pages.inc',

  );

  $items['admin/structure/forum'] = array(

    'title' => 'Forums',

    'description' => 'Control forum hierarchy settings.',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('forum_overview'),

    'access arguments' => array('administer forums'),

    'file' => 'forum.admin.inc',

  );

  $items['admin/structure/forum/list'] = array(

    'title' => 'List',

    'type' => MENU_DEFAULT_LOCAL_TASK,

    'weight' => -10,

  );

  $items['admin/structure/forum/add/container'] = array(

    'title' => 'Add container',

    'page callback' => 'forum_form_main',

    'page arguments' => array('container'),

    'access arguments' => array('administer forums'),

    'type' => MENU_LOCAL_ACTION,

    'parent' => 'admin/structure/forum',

    'file' => 'forum.admin.inc',

  );

  $items['admin/structure/forum/add/forum'] = array(

    'title' => 'Add forum',

    'page callback' => 'forum_form_main',

    'page arguments' => array('forum'),

    'access arguments' => array('administer forums'),

    'type' => MENU_LOCAL_ACTION,

    'parent' => 'admin/structure/forum',

    'file' => 'forum.admin.inc',

  );

  $items['admin/structure/forum/settings'] = array(

    'title' => 'Settings',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('forum_admin_settings'),

    'access arguments' => array('administer forums'),

    'weight' => 5,

    'type' => MENU_LOCAL_TASK,

    'parent' => 'admin/structure/forum',

    'file' => 'forum.admin.inc',

  );

  $items['admin/structure/forum/edit/container/%taxonomy_term'] = array(

    'title' => 'Edit container',

    'page callback' => 'forum_form_main',

    'page arguments' => array('container', 5),

    'access arguments' => array('administer forums'),

    'file' => 'forum.admin.inc',

  );

  $items['admin/structure/forum/edit/forum/%taxonomy_term'] = array(

    'title' => 'Edit forum',

    'page callback' => 'forum_form_main',

    'page arguments' => array('forum', 5),

    'access arguments' => array('administer forums'),

    'file' => 'forum.admin.inc',

  );

  return $items;

}

/**

 * Implements hook_menu_local_tasks_alter().

 */

function forum_menu_local_tasks_alter(&$data, $router_item, $root_path) {

  global $user;

  // Add action link to 'node/add/forum' on 'forum' sub-pages.

  if ($root_path == 'forum' || $root_path == 'forum/%') {

    $tid = (isset($router_item['page_arguments'][0]) ? $router_item['page_arguments'][0]->tid : 0);

    $forum_term = forum_forum_load($tid);

    if ($forum_term) {

      $links = array();

      // Loop through all bundles for forum taxonomy vocabulary field.

      $field = field_info_field('taxonomy_forums');

      foreach ($field['bundles']['node'] as $type) {

        if (node_access('create', $type)) {

          $links[$type] = array(

            '#theme' => 'menu_local_action',

            '#link' => array(

              'title' => t('Add new @node_type', array('@node_type' => node_type_get_name($type))),

              'href' => 'node/add/' . str_replace('_', '-', $type) . '/' . $forum_term->tid,

            ),

          );

        }

      }

      if (empty($links)) {

        // Authenticated user does not have access to create new topics.

        if ($user->uid) {

          $links['disallowed'] = array(

            '#theme' => 'menu_local_action',

            '#link' => array(

              'title' => t('You are not allowed to post new content in the forum.'),

            ),

          );

        }

        // Anonymous user does not have access to create new topics.

        else {

          $links['login'] = array(

            '#theme' => 'menu_local_action',

            '#link' => array(

              'title' => t('<a href="@login">Log in</a> to post new content in the forum.', array(

                '@login' => url('user/login', array('query' => drupal_get_destination())),

              )),

              'localized_options' => array('html' => TRUE),

            ),

          );

        }

      }

      $data['actions']['output'] = array_merge($data['actions']['output'], $links);

    }

  }

}

/**

 * Implements hook_entity_info_alter().

 */

function forum_entity_info_alter(&$info) {

  // Take over URI construction for taxonomy terms that are forums.

  if ($vid = variable_get('forum_nav_vocabulary', 0)) {

    // Within hook_entity_info(), we can't invoke entity_load() as that would

    // cause infinite recursion, so we call taxonomy_vocabulary_get_names()

    // instead of taxonomy_vocabulary_load(). All we need is the machine name

    // of $vid, so retrieving and iterating all the vocabulary names is somewhat

    // inefficient, but entity info is cached across page requests, and an

    // iteration of all vocabularies once per cache clearing isn't a big deal,

    // and is done as part of taxonomy_entity_info() anyway.

    foreach (taxonomy_vocabulary_get_names() as $machine_name => $vocabulary) {

      if ($vid == $vocabulary->vid) {

        $info['taxonomy_term']['bundles'][$machine_name]['uri callback'] = 'forum_uri';

      }

    }

  }

}

/**

 * Implements callback_entity_info_uri().

 *

 * Entity URI callback used in forum_entity_info_alter().

 */

function forum_uri($forum) {

  return array(

    'path' => 'forum/' . $forum->tid,

  );

}

/**

 * Checks whether a node can be used in a forum, based on its content type.

 *

 * @param $node

 *   A node object.

 *

 * @return

 *   Boolean indicating if the node can be assigned to a forum.

 */

function _forum_node_check_node_type($node) {

  // Fetch information about the forum field.

  $field = field_info_instance('node', 'taxonomy_forums', $node->type);

  return is_array($field);

}

/**

 * Implements hook_node_view().

 */

function forum_node_view($node, $view_mode) {

  if (_forum_node_check_node_type($node)) {

    if ($view_mode == 'full' && node_is_page($node)) {

      $vid = variable_get('forum_nav_vocabulary', 0);

      $vocabulary = taxonomy_vocabulary_load($vid);

      // Breadcrumb navigation

      $breadcrumb[] = l(t('Home'), NULL);

      $breadcrumb[] = l($vocabulary->name, 'forum');

      if ($parents = taxonomy_get_parents_all($node->forum_tid)) {

        $parents = array_reverse($parents);

        foreach ($parents as $parent) {

          $breadcrumb[] = l($parent->name, 'forum/' . $parent->tid);

        }

      }

      drupal_set_breadcrumb($breadcrumb);

    }

  }

}

/**

 * Implements hook_node_validate().

 *

 * Checks in particular that the node is assigned only a "leaf" term in the

 * forum taxonomy.

 */

function forum_node_validate($node, $form) {

  if (_forum_node_check_node_type($node)) {

    $langcode = $form['taxonomy_forums']['#language'];

    // vocabulary is selected, not a "container" term.

    if (!empty($node->taxonomy_forums[$langcode])) {

      // Extract the node's proper topic ID.

      $containers = variable_get('forum_containers', array());

      foreach ($node->taxonomy_forums[$langcode] as $delta => $item) {

        // If no term was selected (e.g. when no terms exist yet), remove the

        // item.

        if (empty($item['tid'])) {

          unset($node->taxonomy_forums[$langcode][$delta]);

          continue;

        }

        $term = taxonomy_term_load($item['tid']);

        if (!$term) {

          form_set_error('taxonomy_forums', t('Select a forum.'));

          continue;

        }

        $used = db_query_range('SELECT 1 FROM {taxonomy_term_data} WHERE tid = :tid AND vid = :vid',0 , 1, array(

          ':tid' => $term->tid,

          ':vid' => $term->vid,

        ))->fetchField();

        if ($used && in_array($term->tid, $containers)) {

          form_set_error('taxonomy_forums', t('The item %forum is a forum container, not a forum. Select one of the forums below instead.', array('%forum' => $term->name)));

        }

      }

    }

  }

}

/**

 * Implements hook_node_presave().

 *

 * Assigns the forum taxonomy when adding a topic from within a forum.

 */

function forum_node_presave($node) {

  if (_forum_node_check_node_type($node)) {

    // Make sure all fields are set properly:

    $node->icon = !empty($node->icon) ? $node->icon : '';

    reset($node->taxonomy_forums);

    $langcode = key($node->taxonomy_forums);

    if (!empty($node->taxonomy_forums[$langcode])) {

      $node->forum_tid = $node->taxonomy_forums[$langcode][0]['tid'];

      if (isset($node->nid)) {

        $old_tid = db_query_range("SELECT f.tid FROM {forum} f INNER JOIN {node} n ON f.vid = n.vid WHERE n.nid = :nid ORDER BY f.vid DESC", 0, 1, array(':nid' => $node->nid))->fetchField();

        if ($old_tid && isset($node->forum_tid) && ($node->forum_tid != $old_tid) && !empty($node->shadow)) {

          // A shadow copy needs to be created. Retain new term and add old term.

          $node->taxonomy_forums[$langcode][] = array('tid' => $old_tid);

        }

      }

    }

  }

}

/**

 * Implements hook_node_update().

 */

function forum_node_update($node) {

  if (_forum_node_check_node_type($node)) {

    if (empty($node->revision) && db_query('SELECT tid FROM {forum} WHERE nid=:nid', array(':nid' => $node->nid))->fetchField()) {

      if (!empty($node->forum_tid)) {

        db_update('forum')

          ->fields(array('tid' => $node->forum_tid))

          ->condition('vid', $node->vid)

          ->execute();

      }

      // The node is removed from the forum.

      else {

        db_delete('forum')

          ->condition('nid', $node->nid)

          ->execute();

      }

    }

    else {

      if (!empty($node->forum_tid)) {

        db_insert('forum')

          ->fields(array(

            'tid' => $node->forum_tid,

            'vid' => $node->vid,

            'nid' => $node->nid,

          ))

          ->execute();

      }

    }

    // If the node has a shadow forum topic, update the record for this

    // revision.

    if (!empty($node->shadow)) {

      db_delete('forum')

        ->condition('nid', $node->nid)

        ->condition('vid', $node->vid)

        ->execute();

      db_insert('forum')

        ->fields(array(

          'nid' => $node->nid,

          'vid' => $node->vid,

          'tid' => $node->forum_tid,

        ))

        ->execute();

     }

  }

}

/**

 * Implements hook_node_insert().

 */

function forum_node_insert($node) {

  if (_forum_node_check_node_type($node)) {

    if (!empty($node->forum_tid)) {

      $nid = db_insert('forum')

        ->fields(array(

          'tid' => $node->forum_tid,

          'vid' => $node->vid,

          'nid' => $node->nid,

        ))

        ->execute();

    }

  }

}

/**

 * Implements hook_node_delete().

 */

function forum_node_delete($node) {

  if (_forum_node_check_node_type($node)) {

    db_delete('forum')

      ->condition('nid', $node->nid)

      ->execute();

    db_delete('forum_index')

      ->condition('nid', $node->nid)

      ->execute();

  }

}

/**

 * Implements hook_node_load().

 */

function forum_node_load($nodes) {

  $node_vids = array();

  foreach ($nodes as $node) {

    if (_forum_node_check_node_type($node)) {

      $node_vids[] = $node->vid;

    }

  }

  if (!empty($node_vids)) {

    $query = db_select('forum', 'f');

    $query

      ->fields('f', array('nid', 'tid'))

      ->condition('f.vid', $node_vids);

    $result = $query->execute();

    foreach ($result as $record) {

      $nodes[$record->nid]->forum_tid = $record->tid;

    }

  }

}

/**

 * Implements hook_node_info().

 */

function forum_node_info() {

  return array(

    'forum' => array(

      'name' => t('Forum topic'),

      'base' => 'forum',

      'description' => t('A <em>forum topic</em> starts a new discussion thread within a forum.'),

      'title_label' => t('Subject'),

    )

  );

}

/**

 * Implements hook_permission().

 */

function forum_permission() {

  $perms = array(

    'administer forums' => array(

      'title' => t('Administer forums'),

    ),

  );

  return $perms;

}

/**

 * Implements hook_taxonomy_term_delete().

 */

function forum_taxonomy_term_delete($term) {

  // For containers, remove the tid from the forum_containers variable.

  $containers = variable_get('forum_containers', array());

  $key = array_search($term->tid, $containers);

  if ($key !== FALSE) {

    unset($containers[$key]);

  }

  variable_set('forum_containers', $containers);

}

/**

 * Implements hook_comment_publish().

 *

 * This actually handles the insertion and update of published nodes since

 * comment_save() calls hook_comment_publish() for all published comments.

 */

function forum_comment_publish($comment) {

  _forum_update_forum_index($comment->nid);

}

/**

 * Implements hook_comment_update().

 *

 * The Comment module doesn't call hook_comment_unpublish() when saving

 * individual comments, so we need to check for those here.

 */

function forum_comment_update($comment) {

  // comment_save() calls hook_comment_publish() for all published comments,

  // so we need to handle all other values here.

  if (!$comment->status) {

    _forum_update_forum_index($comment->nid);

  }

}

/**

 * Implements hook_comment_unpublish().

 */

function forum_comment_unpublish($comment) {

  _forum_update_forum_index($comment->nid);

}

/**

 * Implements hook_comment_delete().

 */

function forum_comment_delete($comment) {

  _forum_update_forum_index($comment->nid);

}

/**

 * Implements hook_field_storage_pre_insert().

 */

function forum_field_storage_pre_insert($entity_type, $entity, &$skip_fields) {

  if ($entity_type == 'node' && $entity->status && _forum_node_check_node_type($entity)) {

    $query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));