<?php

/**

 * @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 awaiting approval.

 */

define('COMMENT_NOT_PUBLISHED', 0);

/**

 * Comment is published.

 */

define('COMMENT_PUBLISHED', 1);

/**

 * Comments are displayed in a flat list - expanded.

 */

define('COMMENT_MODE_FLAT', 0);

/**

 * Comments are displayed as a threaded list - expanded.

 */

define('COMMENT_MODE_THREADED', 1);

/**

 * Anonymous posters cannot 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 are required to 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 hidden.

 */

define('COMMENT_NODE_HIDDEN', 0);

/**

 * Comments for this node are closed.

 */

define('COMMENT_NODE_CLOSED', 1);

/**

 * Comments for this node are open.

 */

define('COMMENT_NODE_OPEN', 2);

/**

 * Implements hook_help().

 */

function comment_help($path, $arg) {

  switch ($path) {

    case 'admin/help#comment':

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

      $output .= '<p>' . t('The Comment module allows users to comment on site content, set commenting defaults and permissions, and moderate comments. For more information, see the online handbook entry for <a href="@comment">Comment module</a>.', array('@comment' => 'http://drupal.org/documentation/modules/comment/')) . '</p>';

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

      $output .= '<dl>';

      $output .= '<dt>' . t('Default and custom settings') . '</dt>';

      $output .= '<dd>' . t("Each <a href='@content-type'>content type</a> can have its own default comment settings configured as: <em>Open</em> to allow new comments, <em>Hidden</em> to hide existing comments and prevent new comments, or <em>Closed</em> to view existing comments, but prevent new comments. These defaults will apply to all new content created (changes to the settings on existing content must be done manually). Other comment settings can also be customized per content type, and can be overridden for any given item of content. When a comment has no replies, it remains editable by its author, as long as the author has a user account and is logged in.", array('@content-type' => url('admin/structure/types'))) . '</dd>';

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

      $output .= '<dd>' . t("Comments from users who have the <em>Skip comment approval</em> permission are published immediately. All other comments are placed in the <a href='@comment-approval'>Unapproved comments</a> queue, until a user who has permission to <em>Administer comments</em> publishes or deletes them. Published comments can be bulk managed on the <a href='@admin-comment'>Published comments</a> administration page.", array('@comment-approval' => url('admin/content/comment/approval'), '@admin-comment' => url('admin/content/comment'))) . '</dd>';

      $output .= '</dl>';

      return $output;

  }

}

/**

 * Implements hook_entity_info().

 */

function comment_entity_info() {

  $return = array(

    'comment' => array(

      'label' => t('Comment'),

      'base table' => 'comment',

      'uri callback' => 'comment_uri',

      'fieldable' => TRUE,

      'controller class' => 'CommentController',

      'entity keys' => array(

        'id' => 'cid',

        'bundle' => 'node_type',

        'label' => 'subject',

        'language' => 'language',

      ),

      'bundles' => array(),

      'view modes' => array(

        'full' => array(

          'label' => t('Full comment'),

          'custom settings' => FALSE,

        ),

      ),

      'static cache' => FALSE,

    ),

  );

  foreach (node_type_get_names() as $type => $name) {

    $return['comment']['bundles']['comment_node_' . $type] = array(

      'label' => t('@node_type comment', array('@node_type' => $name)),

      // Provide the node type/bundle name for other modules, so it does not

      // have to be extracted manually from the bundle name.

      'node bundle' => $type,

      'admin' => array(

        // Place the Field UI paths for comments one level below the

        // corresponding paths for nodes, so that they appear in the same set

        // of local tasks. Note that the paths use a different placeholder name

        // and thus a different menu loader callback, so that Field UI page

        // callbacks get a comment bundle name from the node type in the URL.

        // See comment_node_type_load() and comment_menu_alter().

        'path' => 'admin/structure/types/manage/%comment_node_type/comment',

        'bundle argument' => 4,

        'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type) . '/comment',

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

      ),

    );

  }

  return $return;

}

/**

 * Menu loader callback for Field UI paths.

 *

 * Return a comment bundle name from a node type in the URL.

 */

function comment_node_type_load($name) {

  if ($type = node_type_get_type(strtr($name, array('-' => '_')))) {

    return 'comment_node_' . $type->type;

  }

}

/**

 * Implements callback_entity_info_uri().

 */

function comment_uri($comment) {

  return array(

    'path' => 'comment/' . $comment->cid,

    'options' => array('fragment' => 'comment-' . $comment->cid),

  );

}

/**

 * Implements hook_field_extra_fields().

 */

function comment_field_extra_fields() {

  $return = array();

  foreach (node_type_get_types() as $type) {

    if (variable_get('comment_subject_field_' . $type->type, 1) == 1) {

      $return['comment']['comment_node_' . $type->type] = array(

        'form' => array(

          'author' => array(

            'label' => t('Author'),

            'description' => t('Author textfield'),

            'weight' => -2,

          ),

          'subject' => array(

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

            'description' => t('Subject textfield'),

            'weight' => -1,

          ),

        ),

      );

    }

  }

  return $return;

}

/**

 * Implements hook_theme().

 */

function comment_theme() {

  return array(

    'comment_block' => array(

      'variables' => array(),

    ),

    'comment_preview' => array(

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

    ),

    'comment' => array(

      'template' => 'comment',

      'render element' => 'elements',

    ),

    'comment_post_forbidden' => array(

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

    ),

    'comment_wrapper' => array(

      'template' => 'comment-wrapper',

      'render element' => 'content',

    ),

  );

}

/**

 * Implements hook_menu().

 */

function comment_menu() {

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

    'title' => 'Comments',

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

    'page callback' => 'comment_admin',

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

    'type' => MENU_LOCAL_TASK | MENU_NORMAL_ITEM,

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

  );

  // Tabs begin here.

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

    'title' => 'Published comments',

    'type' => MENU_DEFAULT_LOCAL_TASK,

    'weight' => -10,

  );

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

    'title' => 'Unapproved comments',

    'title callback' => 'comment_count_unpublished',

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

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

    'type' => MENU_LOCAL_TASK,

  );

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

    'title' => 'Comment permalink',

    'page callback' => 'comment_permalink',

    'page arguments' => array(1),

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

  );

  $items['comment/%/view'] = array(

    'title' => 'View comment',

    'type' => MENU_DEFAULT_LOCAL_TASK,

    'weight' => -10,

  );

  // Every other comment path uses %, but this one loads the comment directly,

  // so we don't end up loading it twice (in the page and access callback).

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

    'title' => 'Edit',

    'page callback' => 'comment_edit_page',

    'page arguments' => array(1),

    'access callback' => 'comment_access',

    'access arguments' => array('edit', 1),

    'type' => MENU_LOCAL_TASK,

    'weight' => 0,

  );

  $items['comment/%/approve'] = array(

    'title' => 'Approve',

    'page callback' => 'comment_approve',

    'page arguments' => array(1),

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

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

    'weight' => 1,

  );

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

    'title' => 'Delete',

    'page callback' => 'comment_confirm_delete_page',

    'page arguments' => array(1),

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

    'type' => MENU_LOCAL_TASK,

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

    'weight' => 2,

  );

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

    'title' => 'Add new comment',

    'page callback' => 'comment_reply',

    'page arguments' => array(2),

    'access callback' => 'node_access',

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

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

  );

  return $items;

}

/**

 * Implements hook_menu_alter().

 */

function comment_menu_alter(&$items) {

  // Add comments to the description for admin/content.

  $items['admin/content']['description'] = 'Administer content and comments.';

  // Adjust the Field UI tabs on admin/structure/types/manage/[node-type].

  // See comment_entity_info().

  $items['admin/structure/types/manage/%comment_node_type/comment/fields']['title'] = 'Comment fields';

  $items['admin/structure/types/manage/%comment_node_type/comment/fields']['weight'] = 3;

  $items['admin/structure/types/manage/%comment_node_type/comment/display']['title'] = 'Comment display';

  $items['admin/structure/types/manage/%comment_node_type/comment/display']['weight'] = 4;

}

/**

 * Returns a menu title which includes the number of unapproved comments.

 */

function comment_count_unpublished() {

  $count = db_query('SELECT COUNT(cid) FROM {comment} WHERE status = :status', array(

    ':status' => COMMENT_NOT_PUBLISHED,

  ))->fetchField();

  return t('Unapproved comments (@count)', array('@count' => $count));

}

/**

 * Implements hook_node_type_insert().

 *

 * Creates a comment body field for a node type created while the comment module

 * is enabled. For node types created before the comment module is enabled,

 * hook_modules_enabled() serves to create the body fields.

 *

 * @see comment_modules_enabled()

 */

function comment_node_type_insert($info) {

  _comment_body_field_create($info);

}

/**

 * Implements hook_node_type_update().

 */

function comment_node_type_update($info) {

  if (!empty($info->old_type) && $info->type != $info->old_type) {

    field_attach_rename_bundle('comment', 'comment_node_' . $info->old_type, 'comment_node_' . $info->type);

  }

}

/**

 * Implements hook_node_type_delete().

 */

function comment_node_type_delete($info) {

  field_attach_delete_bundle('comment', 'comment_node_' . $info->type);

  $settings = array(

    'comment',

    'comment_default_mode',

    'comment_default_per_page',

    'comment_anonymous',

    'comment_subject_field',

    'comment_preview',

    'comment_form_location',

  );

  foreach ($settings as $setting) {

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

  }

}

 /**

 * Creates a comment_body field instance for a given node type.

 */

function _comment_body_field_create($info) {

  // Create the field if needed.

  if (!field_read_field('comment_body', array('include_inactive' => TRUE))) {

    $field = array(

      'field_name' => 'comment_body',

      'type' => 'text_long',

      'entity_types' => array('comment'),

    );

    field_create_field($field);

  }

  // Create the instance if needed.

  if (!field_read_instance('comment', 'comment_body', 'comment_node_' . $info->type, array('include_inactive' => TRUE))) {

    field_attach_create_bundle('comment', 'comment_node_' . $info->type);

    // Attaches the body field by default.

    $instance = array(

      'field_name' => 'comment_body',

      'label' => 'Comment',

      'entity_type' => 'comment',

      'bundle' => 'comment_node_' . $info->type,

      'settings' => array('text_processing' => 1),

      'required' => TRUE,

      'display' => array(

        'default' => array(

          'label' => 'hidden',

          'type' => 'text_default',

          'weight' => 0,

        ),

      ),

    );

    field_create_instance($instance);

  }

}

/**

 * Implements hook_permission().

 */

function comment_permission() {

  return array(

    'administer comments' => array(

      'title' => t('Administer comments and comment settings'),

    ),

    'access comments' => array(

      'title' => t('View comments'),

    ),

    'post comments' => array(

      'title' => t('Post comments'),

    ),

    'skip comment approval' => array(

      'title' => t('Skip comment approval'),

    ),

    'edit own comments' => array(

      'title' => t('Edit own comments'),

    ),

  );

}

/**

 * Implements hook_block_info().

 */

function comment_block_info() {

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

  $blocks['recent']['properties']['administrative'] = TRUE;

  return $blocks;

}

/**

 * Implements hook_block_configure().

 */

function comment_block_configure($delta = '') {

  $form['comment_block_count'] = array(

    '#type' => 'select',

    '#title' => t('Number of recent comments'),

    '#default_value' => variable_get('comment_block_count', 10),

    '#options' => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 25, 30)),

  );

  return $form;

}

/**

 * Implements hook_block_save().

 */

function comment_block_save($delta = '', $edit = array()) {

  variable_set('comment_block_count', (int) $edit['comment_block_count']);

}

/**

 * Implements hook_block_view().

 *

 * Generates a block with the most recent comments.

 */

function comment_block_view($delta = '') {

  if (user_access('access comments')) {

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

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

    return $block;

  }

}

/**

 * Redirects comment links to the correct page depending on comment settings.

 *

 * Since comments are paged there is no way to guarantee which page a comment

 * appears on. Comment paging and threading settings may be changed at any time.

 * With threaded comments, an individual comment may move between pages as

 * comments can be added either before or after it in the overall discussion.

 * Therefore we use a central routing function for comment links, which

 * calculates the page number based on current comment settings and returns

 * the full comment view with the pager set dynamically.

 *

 * @param $cid

 *   A comment identifier.

 * @return

 *   The comment listing set to the page on which the comment appears.

 */

function comment_permalink($cid) {

  if (($comment = comment_load($cid)) && ($node = node_load($comment->nid))) {

    // Find the current display page for this comment.

    $page = comment_get_display_page($comment->cid, $node->type);

    // Set $_GET['q'] and $_GET['page'] ourselves so that the node callback

    // behaves as it would when visiting the page directly.

    $_GET['q'] = 'node/' . $node->nid;

    $_GET['page'] = $page;

    // Return the node view, this will show the correct comment in context.

    return menu_execute_active_handler('node/' . $node->nid, FALSE);

  }

  return MENU_NOT_FOUND;

}

/**

 * Find the most recent comments that are available to the current user.

 *

 * @param integer $number

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

 *

 * @return

 *   An array of comment objects or an empty array if there are no recent

 *   comments visible to the current user.

 */

function comment_get_recent($number = 10) {

  $query = db_select('comment', 'c');

  $query->innerJoin('node', 'n', 'n.nid = c.nid');

  $query->addTag('node_access');

  $comments = $query

    ->fields('c')

    ->condition('c.status', COMMENT_PUBLISHED)

    ->condition('n.status', NODE_PUBLISHED)

    ->orderBy('c.created', 'DESC')

    // Additionally order by cid to ensure that comments with the same timestamp

    // are returned in the exact order posted.

    ->orderBy('c.cid', 'DESC')

    ->range(0, $number)

    ->execute()

    ->fetchAll();

  return $comments ? $comments : array();

}

/**

 * Calculate page number for first new comment.

 *

 * @param $num_comments

 *   Number of comments.