<?php

// $Id: comment.module,v 1.617.2.8 2009/07/01 20:51:55 goba Exp $

/**

 * @file

 * Enables users to comment on published content.

 *

 * When enabled, the Drupal comment module creates a discussion

 * board for each Drupal node. Users can post comments to discuss

 * a forum topic, weblog post, story, collaborative book page, etc.

 */

/**

 * Comment is published.

 */

define('COMMENT_PUBLISHED', 0);

/**

 * Comment is awaiting approval.

 */

define('COMMENT_NOT_PUBLISHED', 1);

/**

 * Comments are displayed in a flat list - collapsed.

 */

define('COMMENT_MODE_FLAT_COLLAPSED', 1);

/**

 * Comments are displayed in a flat list - expanded.

 */

define('COMMENT_MODE_FLAT_EXPANDED', 2);

/**

 * Comments are displayed as a threaded list - collapsed.

 */

define('COMMENT_MODE_THREADED_COLLAPSED', 3);

/**

 * Comments are displayed as a threaded list - expanded.

 */

define('COMMENT_MODE_THREADED_EXPANDED', 4);

/**

 * Comments are ordered by date - newest first.

 */

define('COMMENT_ORDER_NEWEST_FIRST', 1);

/**

 * Comments are ordered by date - oldest first.

 */

define('COMMENT_ORDER_OLDEST_FIRST', 2);

/**

 * Comment controls should be shown above the comment list.

 */

define('COMMENT_CONTROLS_ABOVE', 0);

/**

 * Comment controls should be shown below the comment list.

 */

define('COMMENT_CONTROLS_BELOW', 1);

/**

 * Comment controls should be shown both above and below the comment list.

 */

define('COMMENT_CONTROLS_ABOVE_BELOW', 2);

/**

 * Comment controls are hidden.

 */

define('COMMENT_CONTROLS_HIDDEN', 3);

/**

 * Anonymous posters may not enter their contact information.

 */

define('COMMENT_ANONYMOUS_MAYNOT_CONTACT', 0);

/**

 * Anonymous posters may leave their contact information.

 */

define('COMMENT_ANONYMOUS_MAY_CONTACT', 1);

/**

 * Anonymous posters must leave their contact information.

 */

define('COMMENT_ANONYMOUS_MUST_CONTACT', 2);

/**

 * Comment form should be displayed on a separate page.

 */

define('COMMENT_FORM_SEPARATE_PAGE', 0);

/**

 * Comment form should be shown below post or list of comments.

 */

define('COMMENT_FORM_BELOW', 1);

/**

 * Comments for this node are disabled.

 */

define('COMMENT_NODE_DISABLED', 0);

/**

 * Comments for this node are locked.

 */

define('COMMENT_NODE_READ_ONLY', 1);

/**

 * Comments are enabled on this node.

 */

define('COMMENT_NODE_READ_WRITE', 2);

/**

 * Comment preview is optional.

 */

define('COMMENT_PREVIEW_OPTIONAL', 0);

/**

 * Comment preview is required.

 */

define('COMMENT_PREVIEW_REQUIRED', 1);

/**

 * Implementation of hook_help().

 */

function comment_help($path, $arg) {

  switch ($path) {

    case 'admin/help#comment':

      $output = '<p>'. t('The comment module allows visitors to comment on your posts, creating ad hoc discussion boards. Any <a href="@content-type">content type</a> may have its <em>Default comment setting</em> set to <em>Read/Write</em> to allow comments, or <em>Disabled</em>, to prevent comments. Comment display settings and other controls may also be customized for each content type (some display settings are customizable by individual users).', array('@content-type' => url('admin/content/types'))) .'</p>';

      $output .= '<p>'. t('Comment permissions are assigned to user roles, and are used to determine whether anonymous users (or other roles) are allowed to comment on posts. If anonymous users are allowed to comment, their individual contact information may be retained in cookies stored on their local computer for use in later comment submissions. When a comment has no replies, it may be (optionally) edited by its author. The comment module uses the same input formats and HTML tags available when creating other forms of content.') .'</p>';

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

      return $output;

    case 'admin/content/comment':

      return '<p>'. t("Below is a list of the latest comments posted to your site. Click on a subject to see the comment, the author's name to edit the author's user information, 'edit' to modify the text, and 'delete' to remove their submission.") .'</p>';

    case 'admin/content/comment/approval':

      return '<p>'. t("Below is a list of the comments posted to your site that need approval. To approve a comment, click on 'edit' and then change its 'moderation status' to Approved. Click on a subject to see the comment, the author's name to edit the author's user information, 'edit' to modify the text, and 'delete' to remove their submission.") .'</p>';

  }

}

/**

 * Implementation of hook_theme().

 */

function comment_theme() {

  return array(

    'comment_block' => array(

      'arguments' => array(),

    ),

    'comment_admin_overview' => array(

      'arguments' => array('form' => NULL),

    ),

    'comment_preview' => array(

      'arguments' => array('comment' => NULL, 'node' => NULL, 'links' => array(), 'visible' => 1),

    ),

    'comment_view' => array(

      'arguments' => array('comment' => NULL, 'node' => NULL, 'links' => array(), 'visible' => 1),

    ),

    'comment_controls' => array(

      'arguments' => array('form' => NULL),

    ),

    'comment' => array(

      'template' => 'comment',

      'arguments' => array('comment' => NULL, 'node' => NULL, 'links' => array()),

    ),

    'comment_folded' => array(

      'template' => 'comment-folded',

      'arguments' => array('comment' => NULL),

    ),

    'comment_flat_collapsed' => array(

      'arguments' => array('comment' => NULL, 'node' => NULL),

    ),

    'comment_flat_expanded' => array(

      'arguments' => array('comment' => NULL, 'node' => NULL),

    ),

    'comment_thread_collapsed' => array(

      'arguments' => array('comment' => NULL, 'node' => NULL),

    ),

    'comment_thread_expanded' => array(

      'arguments' => array('comment' => NULL, 'node' => NULL),

    ),

    'comment_post_forbidden' => array(

      'arguments' => array('nid' => NULL),

    ),

    'comment_wrapper' => array(

      'template' => 'comment-wrapper',

      'arguments' => array('content' => NULL, 'node' => NULL),

    ),

    'comment_submitted' => array(

      'arguments' => array('comment' => NULL),

    ),

  );

}

/**

 * Implementation of hook_menu().

 */

function comment_menu() {

  $items['admin/content/comment'] = array(

    'title' => 'Comments',

    'description' => 'List and edit site comments and the comment moderation queue.',

    'page callback' => 'comment_admin',

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

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

  );

  // Tabs:

  $items['admin/content/comment/new'] = array(

    'title' => 'Published comments',

    'type' => MENU_DEFAULT_LOCAL_TASK,

    'weight' => -10,

  );

  $items['admin/content/comment/approval'] = array(

    'title' => 'Approval queue',

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

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

    'type' => MENU_LOCAL_TASK,

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

  );

  $items['comment/delete'] = array(

    'title' => 'Delete comment',

    'page callback' => 'comment_delete',

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

    'type' => MENU_CALLBACK,

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

  );

  $items['comment/edit'] = array(

    'title' => 'Edit comment',

    'page callback' => 'comment_edit',

    'access arguments' => array('post comments'),

    'type' => MENU_CALLBACK,

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

  );

  $items['comment/reply/%node'] = array(

    'title' => 'Reply to comment',

    'page callback' => 'comment_reply',

    'page arguments' => array(2),

    'access callback' => 'node_access',

    'access arguments' => array('view', 2),

    'type' => MENU_CALLBACK,

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

  );

  return $items;

}

/**

 * Implementation of hook_node_type().

 */

function comment_node_type($op, $info) {

  $settings = array(

    'comment',

    'comment_default_mode',

    'comment_default_order',

    'comment_default_per_page',

    'comment_controls',

    'comment_anonymous',

    'comment_subject_field',

    'comment_preview',

    'comment_form_location',

  );

  switch ($op) {

    case 'delete':

      foreach ($settings as $setting) {

        variable_del($setting .'_'. $info->type);

      }

      break;

  }

}

/**

 * Implementation of hook_perm().

 */

function comment_perm() {

  return array('access comments', 'post comments', 'administer comments', 'post comments without approval');

}

/**

 * Implementation of hook_block().

 *

 * Generates a block with the most recent comments.

 */

function comment_block($op = 'list', $delta = 0) {

  if ($op == 'list') {

    $blocks[0]['info'] = t('Recent comments');

    return $blocks;

  }

  else if ($op == 'view' && user_access('access comments')) {

    $block['subject'] = t('Recent comments');

    $block['content'] = theme('comment_block');

    return $block;

  }

}

/**

 * Find a number of recent comments. This is done in two steps.

 *   1. Find the n (specified by $number) nodes that have the most recent

 *      comments.  This is done by querying node_comment_statistics which has

 *      an index on last_comment_timestamp, and is thus a fast query.

 *   2. Loading the information from the comments table based on the nids found

 *      in step 1.

 *

 * @param $number

 *   (optional) The maximum number of comments to find.

 * @return

 *   An array of comment objects each containing a nid,

 *   subject, cid, and timestamp, or an empty array if there are no recent

 *   comments visible to the current user.

 */

function comment_get_recent($number = 10) {

  // Select the $number nodes (visible to the current user) with the most

  // recent comments. This is efficient due to the index on

  // last_comment_timestamp.

  $result = db_query_range(db_rewrite_sql("SELECT nc.nid FROM {node_comment_statistics} nc WHERE nc.comment_count > 0 ORDER BY nc.last_comment_timestamp DESC", 'nc'), 0, $number);

  $nids = array();

  while ($row = db_fetch_object($result)) {

    $nids[] = $row->nid;

  }

  $comments = array();

  if (!empty($nids)) {

    // From among the comments on the nodes selected in the first query,

    // find the $number most recent comments.

    $result = db_query_range('SELECT c.nid, c.subject, c.cid, c.timestamp FROM {comments} c INNER JOIN {node} n ON n.nid = c.nid WHERE c.nid IN ('. implode(',', $nids) .') AND n.status = 1 AND c.status = %d ORDER BY c.cid DESC', COMMENT_PUBLISHED, 0, $number);

    while ($comment = db_fetch_object($result)) {

      $comments[] = $comment;

    }

  }

  return $comments;

}

/**

 * Calculate page number for first new comment.

 *

 * @param $num_comments

 *   Number of comments.

 * @param $new_replies

 *   Number of new replies.

 * @param $node

 *   The first new comment node.

 * @return

 *   "page=X" if the page number is greater than zero; empty string otherwise.

 */

function comment_new_page_count($num_comments, $new_replies, $node) {

  $comments_per_page = _comment_get_display_setting('comments_per_page', $node);

  $mode = _comment_get_display_setting('mode', $node);

  $order = _comment_get_display_setting('sort', $node);

  $pagenum = NULL;

  $flat = in_array($mode, array(COMMENT_MODE_FLAT_COLLAPSED, COMMENT_MODE_FLAT_EXPANDED));

  if ($num_comments <= $comments_per_page || ($flat && $order == COMMENT_ORDER_NEWEST_FIRST)) {

    // Only one page of comments or flat forum and newest first.

    // First new comment will always be on first page.

    $pageno = 0;

  }

  else {

    if ($flat) {

      // Flat comments and oldest first.

      $count = $num_comments - $new_replies;

    }

    else {

      // Threaded comments. See the documentation for comment_render().

      if ($order == COMMENT_ORDER_NEWEST_FIRST) {

        // Newest first: find the last thread with new comment

        $result = db_query('(SELECT thread FROM {comments} WHERE nid = %d  AND status = 0 ORDER BY timestamp DESC LIMIT %d) ORDER BY thread DESC LIMIT 1', $node->nid, $new_replies);

        $thread = db_result($result);

        $result_count = db_query("SELECT COUNT(*) FROM {comments} WHERE nid = %d AND status = 0 AND thread > '". $thread ."'", $node->nid);

      }

      else {

        // Oldest first: find the first thread with new comment

        $result = db_query('(SELECT thread FROM {comments} WHERE nid = %d  AND status = 0 ORDER BY timestamp DESC LIMIT %d) ORDER BY SUBSTRING(thread, 1, (LENGTH(thread) - 1)) LIMIT 1', $node->nid, $new_replies);

        $thread = substr(db_result($result), 0, -1);

        $result_count = db_query("SELECT COUNT(*) FROM {comments} WHERE nid = %d AND status = 0 AND SUBSTRING(thread, 1, (LENGTH(thread) - 1)) < '". $thread ."'", $node->nid);

      }

      $count = db_result($result_count);

    }

    $pageno =  $count / $comments_per_page;

  }

  if ($pageno >= 1) {

    $pagenum = "page=". intval($pageno);

  }

  return $pagenum;

}

/**

 * Returns a formatted list of recent comments to be displayed in the comment block.

 *

 * @return

 *   The comment list HTML.

 * @ingroup themeable

 */

function theme_comment_block() {

  $items = array();

  foreach (comment_get_recent() as $comment) {

    $items[] = l($comment->subject, 'node/'. $comment->nid, array('fragment' => 'comment-'. $comment->cid)) .'<br />'. t('@time ago', array('@time' => format_interval(time() - $comment->timestamp)));

  }

  if ($items) {

    return theme('item_list', $items);

  }

}

/**

 * Implementation of hook_link().

 */

function comment_link($type, $node = NULL, $teaser = FALSE) {

  $links = array();

  if ($type == 'node' && $node->comment) {

    if ($teaser) {

      // Main page: display the number of comments that have been posted.

      if (user_access('access comments')) {

        $all = comment_num_all($node->nid);

        if ($all) {

          $links['comment_comments'] = array(

            'title' => format_plural($all, '1 comment', '@count comments'),

            'href' => "node/$node->nid",

            'attributes' => array('title' => t('Jump to the first comment of this posting.')),

            'fragment' => 'comments'

          );

          $new = comment_num_new($node->nid);

          if ($new) {

            $links['comment_new_comments'] = array(

              'title' => format_plural($new, '1 new comment', '@count new comments'),

              'href' => "node/$node->nid",

              'query' => comment_new_page_count($all, $new, $node),

              'attributes' => array('title' => t('Jump to the first new comment of this posting.')),

              'fragment' => 'new'

            );

          }

        }

        else {

          if ($node->comment == COMMENT_NODE_READ_WRITE) {

            if (user_access('post comments')) {

              $links['comment_add'] = array(

                'title' => t('Add new comment'),

                'href' => "comment/reply/$node->nid",

                'attributes' => array('title' => t('Add a new comment to this page.')),

                'fragment' => 'comment-form'

              );

            }

            else {

              $links['comment_forbidden']['title'] = theme('comment_post_forbidden', $node);

            }

          }

        }

      }

    }

    else {

      // Node page: add a "post comment" link if the user is allowed to

      // post comments, if this node is not read-only, and if the comment form isn't already shown

      if ($node->comment == COMMENT_NODE_READ_WRITE) {

        if (user_access('post comments')) {

          if (variable_get('comment_form_location_'. $node->type, COMMENT_FORM_SEPARATE_PAGE) == COMMENT_FORM_SEPARATE_PAGE) {

            $links['comment_add'] = array(

              'title' => t('Add new comment'),

              'href' => "comment/reply/$node->nid",

              'attributes' => array('title' => t('Share your thoughts and opinions related to this posting.')),

              'fragment' => 'comment-form'

            );

          }

        }

        else {

          $links['comment_forbidden']['title'] = theme('comment_post_forbidden', $node);

        }

      }

    }

  }

  if ($type == 'comment') {

    $links = comment_links($node, $teaser);

  }

  if (isset($links['comment_forbidden'])) {

    $links['comment_forbidden']['html'] = TRUE;

  }

  return $links;

}

/**

 * Implementation of hook_form_alter().

 */

function comment_form_alter(&$form, $form_state, $form_id) {

  if ($form_id == 'node_type_form' && isset($form['identity']['type'])) {

    $form['comment'] = array(

      '#type' => 'fieldset',

      '#title' => t('Comment settings'),

      '#collapsible' => TRUE,

      '#collapsed' => TRUE,

    );

    $form['comment']['comment'] = array(

      '#type' => 'radios',

      '#title' => t('Default comment setting'),

      '#default_value' => variable_get('comment_'. $form['#node_type']->type, COMMENT_NODE_READ_WRITE),

      '#options' => array(t('Disabled'), t('Read only'), t('Read/Write')),

      '#description' => t('Users with the <em>administer comments</em> permission will be able to override this setting.'),

    );

    $form['comment']['comment_default_mode'] = array(

      '#type' => 'radios',

      '#title' => t('Default display mode'),

      '#default_value' => variable_get('comment_default_mode_'. $form['#node_type']->type, COMMENT_MODE_THREADED_EXPANDED),

      '#options' => _comment_get_modes(),

      '#description' => t('The default view for comments. Expanded views display the body of the comment. Threaded views keep replies together.'),

    );

    $form['comment']['comment_default_order'] = array(

      '#type' => 'radios',

      '#title' => t('Default display order'),

      '#default_value' => variable_get('comment_default_order_'. $form['#node_type']->type, COMMENT_ORDER_NEWEST_FIRST),

      '#options' => _comment_get_orders(),

      '#description' => t('The default sorting for new users and anonymous users while viewing comments. These users may change their view using the comment control panel. For registered users, this change is remembered as a persistent user preference.'),

    );

    $form['comment']['comment_default_per_page'] = array(

      '#type' => 'select',

      '#title' => t('Default comments per page'),

      '#default_value' => variable_get('comment_default_per_page_'. $form['#node_type']->type, 50),

      '#options' => _comment_per_page(),

      '#description' => t('Default number of comments for each page: more comments are distributed in several pages.'),

    );

    $form['comment']['comment_controls'] = array(

      '#type' => 'radios',

      '#title' => t('Comment controls'),

      '#default_value' => variable_get('comment_controls_'. $form['#node_type']->type, COMMENT_CONTROLS_HIDDEN),

      '#options' => array(