<?php

/**

 * @file

 * Tests for comment.module.

 */

class CommentHelperCase extends DrupalWebTestCase {

  protected $admin_user;

  protected $web_user;

  protected $node;

  function setUp() {

    $modules = func_get_args();

    if (isset($modules[0]) && is_array($modules[0])) {

      $modules = $modules[0];

    }

    $modules[] = 'comment';

    parent::setUp($modules);

    // Create users and test node.

    $this->admin_user = $this->drupalCreateUser(array('administer content types', 'administer comments', 'administer blocks', 'administer actions', 'administer fields'));

    $this->web_user = $this->drupalCreateUser(array('access comments', 'post comments', 'create article content', 'edit own comments'));

    $this->node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1, 'uid' => $this->web_user->uid));

  }

  /**

   * Post comment.

   *

   * @param $node

   *   Node to post comment on.

   * @param $comment

   *   Comment body.

   * @param $subject

   *   Comment subject.

   * @param $contact

   *   Set to NULL for no contact info, TRUE to ignore success checking, and

   *   array of values to set contact info.

   */

  function postComment($node, $comment, $subject = '', $contact = NULL) {

    $langcode = LANGUAGE_NONE;

    $edit = array();

    $edit['comment_body[' . $langcode . '][0][value]'] = $comment;

    $preview_mode = variable_get('comment_preview_article', DRUPAL_OPTIONAL);

    $subject_mode = variable_get('comment_subject_field_article', 1);

    // Must get the page before we test for fields.

    if ($node !== NULL) {

      $this->drupalGet('comment/reply/' . $node->nid);

    }

    if ($subject_mode == TRUE) {

      $edit['subject'] = $subject;

    }

    else {

      $this->assertNoFieldByName('subject', '', 'Subject field not found.');

    }

    if ($contact !== NULL && is_array($contact)) {

      $edit += $contact;

    }

    switch ($preview_mode) {

      case DRUPAL_REQUIRED:

        // Preview required so no save button should be found.

        $this->assertNoFieldByName('op', t('Save'), 'Save button not found.');

        $this->drupalPost(NULL, $edit, t('Preview'));

        // Don't break here so that we can test post-preview field presence and

        // function below.

      case DRUPAL_OPTIONAL:

        $this->assertFieldByName('op', t('Preview'), 'Preview button found.');

        $this->assertFieldByName('op', t('Save'), 'Save button found.');

        $this->drupalPost(NULL, $edit, t('Save'));

        break;

      case DRUPAL_DISABLED:

        $this->assertNoFieldByName('op', t('Preview'), 'Preview button not found.');

        $this->assertFieldByName('op', t('Save'), 'Save button found.');

        $this->drupalPost(NULL, $edit, t('Save'));

        break;

    }

    $match = array();

    // Get comment ID

    preg_match('/#comment-([0-9]+)/', $this->getURL(), $match);

    // Get comment.

    if ($contact !== TRUE) { // If true then attempting to find error message.

      if ($subject) {

        $this->assertText($subject, 'Comment subject posted.');

      }

      $this->assertText($comment, 'Comment body posted.');

      $this->assertTrue((!empty($match) && !empty($match[1])), 'Comment id found.');

    }

    if (isset($match[1])) {

      return (object) array('id' => $match[1], 'subject' => $subject, 'comment' => $comment);

    }

  }

  /**

   * Checks current page for specified comment.

   *

   * @param object $comment Comment object.

   * @param boolean $reply The comment is a reply to another comment.

   * @return boolean Comment found.

   */

  function commentExists($comment, $reply = FALSE) {

    if ($comment && is_object($comment)) {

      $regex = '/' . ($reply ? '<div class="indented">(.*?)' : '');

      $regex .= '<a id="comment-' . $comment->id . '"(.*?)'; // Comment anchor.

      $regex .= '<div(.*?)'; // Begin in comment div.

      $regex .= $comment->subject . '(.*?)'; // Match subject.

      $regex .= $comment->comment . '(.*?)'; // Match comment.

      $regex .= '/s';

      return (boolean)preg_match($regex, $this->drupalGetContent());

    }

    else {

      return FALSE;

    }

  }

  /**

   * Delete comment.

   *

   * @param object $comment

   *   Comment to delete.

   */

  function deleteComment($comment) {

    $this->drupalPost('comment/' . $comment->id . '/delete', array(), t('Delete'));

    $this->assertText(t('The comment and all its replies have been deleted.'), 'Comment deleted.');

  }

  /**

   * Set comment subject setting.

   *

   * @param boolean $enabled

   *   Subject value.

   */

  function setCommentSubject($enabled) {

    $this->setCommentSettings('comment_subject_field', ($enabled ? '1' : '0'), 'Comment subject ' . ($enabled ? 'enabled' : 'disabled') . '.');

  }

  /**

   * Set comment preview setting.

   *

   * @param int $mode

   *   Preview value.

   */

  function setCommentPreview($mode) {

    switch ($mode) {

      case DRUPAL_DISABLED:

        $mode_text = 'disabled';

        break;

      case DRUPAL_OPTIONAL:

        $mode_text = 'optional';

        break;

      case DRUPAL_REQUIRED:

        $mode_text = 'required';

        break;

    }

    $this->setCommentSettings('comment_preview', $mode, format_string('Comment preview @mode_text.', array('@mode_text' => $mode_text)));

  }

  /**

   * Set comment form location setting.

   *

   * @param boolean $enabled

   *   Form value.

   */

  function setCommentForm($enabled) {

    $this->setCommentSettings('comment_form_location', ($enabled ? COMMENT_FORM_BELOW : COMMENT_FORM_SEPARATE_PAGE), 'Comment controls ' . ($enabled ? 'enabled' : 'disabled') . '.');

  }

  /**

   * Set comment anonymous level setting.

   *

   * @param integer $level

   *   Anonymous level.

   */

  function setCommentAnonymous($level) {

    $this->setCommentSettings('comment_anonymous', $level, format_string('Anonymous commenting set to level @level.', array('@level' => $level)));

  }

  /**

   * Set the default number of comments per page.

   *

   * @param integer $comments

   *   Comments per page value.

   */

  function setCommentsPerPage($number) {

    $this->setCommentSettings('comment_default_per_page', $number, format_string('Number of comments per page set to @number.', array('@number' => $number)));

  }

  /**

   * Set comment setting for article content type.

   *

   * @param string $name

   *   Name of variable.

   * @param string $value

   *   Value of variable.

   * @param string $message

   *   Status message to display.

   */

  function setCommentSettings($name, $value, $message) {

    variable_set($name . '_article', $value);

    // Display status message.

    $this->pass($message);

  }

  /**

   * Check for contact info.

   *

   * @return boolean Contact info is available.

   */

  function commentContactInfoAvailable() {

    return preg_match('/(input).*?(name="name").*?(input).*?(name="mail").*?(input).*?(name="homepage")/s', $this->drupalGetContent());

  }

  /**

   * Perform the specified operation on the specified comment.

   *

   * @param object $comment

   *   Comment to perform operation on.

   * @param string $operation

   *   Operation to perform.

   * @param boolean $aproval

   *   Operation is found on approval page.

   */

  function performCommentOperation($comment, $operation, $approval = FALSE) {

    $edit = array();

    $edit['operation'] = $operation;

    $edit['comments[' . $comment->id . ']'] = TRUE;

    $this->drupalPost('admin/content/comment' . ($approval ? '/approval' : ''), $edit, t('Update'));

    if ($operation == 'delete') {

      $this->drupalPost(NULL, array(), t('Delete comments'));

      $this->assertRaw(format_plural(1, 'Deleted 1 comment.', 'Deleted @count comments.'), format_string('Operation @operation was performed on comment.', array('@operation' => $operation)));

    }

    else {

      $this->assertText(t('The update has been performed.'), format_string('Operation @operation was performed on comment.', array('@operation' => $operation)));

    }

  }

  /**

   * Get the comment ID for an unapproved comment.

   *

   * @param string $subject

   *   Comment subject to find.

   * @return integer

   *   Comment id.

   */

  function getUnapprovedComment($subject) {

    $this->drupalGet('admin/content/comment/approval');

    preg_match('/href="(.*?)#comment-([^"]+)"(.*?)>(' . $subject . ')/', $this->drupalGetContent(), $match);

    return $match[2];

  }

}

class CommentInterfaceTest extends CommentHelperCase {

  public static function getInfo() {

    return array(

      'name' => 'Comment interface',

      'description' => 'Test comment user interfaces.',

      'group' => 'Comment',

    );

  }

  /**

   * Test comment interface.

   */

  function testCommentInterface() {

    $langcode = LANGUAGE_NONE;

    // Set comments to have subject and preview disabled.

    $this->drupalLogin($this->admin_user);

    $this->setCommentPreview(DRUPAL_DISABLED);

    $this->setCommentForm(TRUE);

    $this->setCommentSubject(FALSE);

    $this->setCommentSettings('comment_default_mode', COMMENT_MODE_THREADED, 'Comment paging changed.');

    $this->drupalLogout();

    // Post comment #1 without subject or preview.

    $this->drupalLogin($this->web_user);

    $comment_text = $this->randomName();

    $comment = $this->postComment($this->node, $comment_text);

    $comment_loaded = comment_load($comment->id);

    $this->assertTrue($this->commentExists($comment), 'Comment found.');

    // Set comments to have subject and preview to required.

    $this->drupalLogout();

    $this->drupalLogin($this->admin_user);

    $this->setCommentSubject(TRUE);

    $this->setCommentPreview(DRUPAL_REQUIRED);

    $this->drupalLogout();

    // Create comment #2 that allows subject and requires preview.

    $this->drupalLogin($this->web_user);

    $subject_text = $this->randomName();

    $comment_text = $this->randomName();

    $comment = $this->postComment($this->node, $comment_text, $subject_text, TRUE);

    $comment_loaded = comment_load($comment->id);

    $this->assertTrue($this->commentExists($comment), 'Comment found.');

    // Check comment display.

    $this->drupalGet('node/' . $this->node->nid . '/' . $comment->id);

    $this->assertText($subject_text, 'Individual comment subject found.');

    $this->assertText($comment_text, 'Individual comment body found.');

    // Set comments to have subject and preview to optional.

    $this->drupalLogout();

    $this->drupalLogin($this->admin_user);

    $this->setCommentSubject(TRUE);

    $this->setCommentPreview(DRUPAL_OPTIONAL);

    // Test changing the comment author to "Anonymous".

    $this->drupalGet('comment/' . $comment->id . '/edit');

    $comment = $this->postComment(NULL, $comment->comment, $comment->subject, array('name' => ''));

    $comment_loaded = comment_load($comment->id);

    $this->assertTrue(empty($comment_loaded->name) && $comment_loaded->uid == 0, 'Comment author successfully changed to anonymous.');

    // Test changing the comment author to an unverified user.

    $random_name = $this->randomName();

    $this->drupalGet('comment/' . $comment->id . '/edit');

    $comment = $this->postComment(NULL, $comment->comment, $comment->subject, array('name' => $random_name));

    $this->drupalGet('node/' . $this->node->nid);

    $this->assertText($random_name . ' (' . t('not verified') . ')', 'Comment author successfully changed to an unverified user.');

    // Test changing the comment author to a verified user.

    $this->drupalGet('comment/' . $comment->id . '/edit');

    $comment = $this->postComment(NULL, $comment->comment, $comment->subject, array('name' => $this->web_user->name));

    $comment_loaded = comment_load($comment->id);

    $this->assertTrue($comment_loaded->name == $this->web_user->name && $comment_loaded->uid == $this->web_user->uid, 'Comment author successfully changed to a registered user.');

    $this->drupalLogout();

    // Reply to comment #2 creating comment #3 with optional preview and no

    // subject though field enabled.

    $this->drupalLogin($this->web_user);

    $this->drupalGet('comment/reply/' . $this->node->nid . '/' . $comment->id);

    $this->assertText($subject_text, 'Individual comment-reply subject found.');

    $this->assertText($comment_text, 'Individual comment-reply body found.');

    $reply = $this->postComment(NULL, $this->randomName(), '', TRUE);

    $reply_loaded = comment_load($reply->id);

    $this->assertTrue($this->commentExists($reply, TRUE), 'Reply found.');

    $this->assertEqual($comment->id, $reply_loaded->pid, 'Pid of a reply to a comment is set correctly.');

    $this->assertEqual(rtrim($comment_loaded->thread, '/') . '.00/', $reply_loaded->thread, 'Thread of reply grows correctly.');

    // Second reply to comment #3 creating comment #4.

    $this->drupalGet('comment/reply/' . $this->node->nid . '/' . $comment->id);

    $this->assertText($subject_text, 'Individual comment-reply subject found.');

    $this->assertText($comment_text, 'Individual comment-reply body found.');

    $reply = $this->postComment(NULL, $this->randomName(), $this->randomName(), TRUE);

    $reply_loaded = comment_load($reply->id);

    $this->assertTrue($this->commentExists($reply, TRUE), 'Second reply found.');

    $this->assertEqual(rtrim($comment_loaded->thread, '/') . '.01/', $reply_loaded->thread, 'Thread of second reply grows correctly.');

    // Edit reply.

    $this->drupalGet('comment/' . $reply->id . '/edit');

    $reply = $this->postComment(NULL, $this->randomName(), $this->randomName(), TRUE);

    $this->assertTrue($this->commentExists($reply, TRUE), 'Modified reply found.');

    // Correct link count

    $this->drupalGet('node');

    $this->assertRaw('4 comments', 'Link to the 4 comments exist.');

    // Confirm a new comment is posted to the correct page.

    $this->setCommentsPerPage(2);

    $comment_new_page = $this->postComment($this->node, $this->randomName(), $this->randomName(), TRUE);

    $this->assertTrue($this->commentExists($comment_new_page), 'Page one exists. %s');

    $this->drupalGet('node/' . $this->node->nid, array('query' => array('page' => 1)));

    $this->assertTrue($this->commentExists($reply, TRUE), 'Page two exists. %s');

    $this->setCommentsPerPage(50);

    // Attempt to post to node with comments disabled.

    $this->node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1, 'comment' => COMMENT_NODE_HIDDEN));

    $this->assertTrue($this->node, 'Article node created.');

    $this->drupalGet('comment/reply/' . $this->node->nid);

    $this->assertText('This discussion is closed', 'Posting to node with comments disabled');

    $this->assertNoField('edit-comment', 'Comment body field found.');

    // Attempt to post to node with read-only comments.

    $this->node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1, 'comment' => COMMENT_NODE_CLOSED));

    $this->assertTrue($this->node, 'Article node created.');

    $this->drupalGet('comment/reply/' . $this->node->nid);

    $this->assertText('This discussion is closed', 'Posting to node with comments read-only');

    $this->assertNoField('edit-comment', 'Comment body field found.');

    // Attempt to post to node with comments enabled (check field names etc).

    $this->node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1, 'comment' => COMMENT_NODE_OPEN));

    $this->assertTrue($this->node, 'Article node created.');

    $this->drupalGet('comment/reply/' . $this->node->nid);

    $this->assertNoText('This discussion is closed', 'Posting to node with comments enabled');

    $this->assertField('edit-comment-body-' . $langcode . '-0-value', 'Comment body field found.');

    // Delete comment and make sure that reply is also removed.

    $this->drupalLogout();

    $this->drupalLogin($this->admin_user);

    $this->deleteComment($comment);

    $this->deleteComment($comment_new_page);

    $this->drupalGet('node/' . $this->node->nid);

    $this->assertFalse($this->commentExists($comment), 'Comment not found.');

    $this->assertFalse($this->commentExists($reply, TRUE), 'Reply not found.');

    // Enabled comment form on node page.

    $this->drupalLogin($this->admin_user);

    $this->setCommentForm(TRUE);

    $this->drupalLogout();

    // Submit comment through node form.

    $this->drupalLogin($this->web_user);

    $this->drupalGet('node/' . $this->node->nid);

    $form_comment = $this->postComment(NULL, $this->randomName(), $this->randomName(), TRUE);

    $this->assertTrue($this->commentExists($form_comment), 'Form comment found.');

    // Disable comment form on node page.

    $this->drupalLogout();

    $this->drupalLogin($this->admin_user);

    $this->setCommentForm(FALSE);

  }

  /**

   * Tests new comment marker.

   */

  public function testCommentNewCommentsIndicator() {

    // Test if the right links are displayed when no comment is present for the

    // node.

    $this->drupalLogin($this->admin_user);

    $this->node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1, 'comment' => COMMENT_NODE_OPEN));

    $this->drupalGet('node');

    $this->assertNoLink(t('@count comments', array('@count' => 0)));

    $this->assertNoLink(t('@count new comments', array('@count' => 0)));

    $this->assertLink(t('Read more'));

    $count = $this->xpath('//div[@id=:id]/div[@class=:class]/ul/li', array(':id' => 'node-' . $this->node->nid, ':class' => 'link-wrapper'));

    $this->assertTrue(count($count) == 1, 'One child found');

    // Create a new comment. This helper function may be run with different

    // comment settings so use comment_save() to avoid complex setup.

    $comment = (object) array(

      'cid' => NULL,

      'nid' => $this->node->nid,

      'node_type' => $this->node->type,

      'pid' => 0,

      'uid' => $this->loggedInUser->uid,

      'status' => COMMENT_PUBLISHED,

      'subject' => $this->randomName(),

      'hostname' => ip_address(),

      'language' => LANGUAGE_NONE,

      'comment_body' => array(LANGUAGE_NONE => array($this->randomName())),

    );

    comment_save($comment);

    $this->drupalLogout();

    // Log in with 'web user' and check comment links.

    $this->drupalLogin($this->web_user);

    $this->drupalGet('node');

    $this->assertLink(t('1 new comment'));

    $this->clickLink(t('1 new comment'));

    $this->assertRaw('<a id="new"></a>', 'Found "new" marker.');

    $this->assertTrue($this->xpath('//a[@id=:new]/following-sibling::a[1][@id=:comment_id]', array(':new' => 'new', ':comment_id' => 'comment-1')), 'The "new" anchor is positioned at the right comment.');

    // Test if "new comment" link is correctly removed.

    $this->drupalGet('node');

    $this->assertLink(t('1 comment'));

    $this->assertLink(t('Read more'));

    $this->assertNoLink(t('1 new comment'));

    $this->assertNoLink(t('@count new comments', array('@count' => 0)));

    $count = $this->xpath('//div[@id=:id]/div[@class=:class]/ul/li', array(':id' => 'node-' . $this->node->nid, ':class' => 'link-wrapper'));

    $this->assertTrue(count($count) == 2, print_r($count, TRUE));

  }

  /**

   * Tests CSS classes on comments.

   */

  function testCommentClasses() {

    // Create all permutations for comments, users, and nodes.

    $parameters = array(

      'node_uid' => array(0, $this->web_user->uid),

      'comment_uid' => array(0, $this->web_user->uid, $this->admin_user->uid),

      'comment_status' => array(COMMENT_PUBLISHED, COMMENT_NOT_PUBLISHED),

      'user' => array('anonymous', 'authenticated', 'admin'),

    );

    $permutations = $this->generatePermutations($parameters);

    foreach ($permutations as $case) {

      // Create a new node.

      $node = $this->drupalCreateNode(array('type' => 'article', 'uid' => $case['node_uid']));

      // Add a comment.

      $comment = (object) array(

        'cid' => NULL,

        'nid' => $node->nid,

        'pid' => 0,

        'uid' => $case['comment_uid'],

        'status' => $case['comment_status'],

        'subject' => $this->randomName(),

        'language' => LANGUAGE_NONE,

        'comment_body' => array(LANGUAGE_NONE => array($this->randomName())),

      );

      comment_save($comment);

      // Adjust the current/viewing user.

      switch ($case['user']) {

        case 'anonymous':

          $this->drupalLogout();

          $case['user_uid'] = 0;

          break;

        case 'authenticated':

          $this->drupalLogin($this->web_user);

          $case['user_uid'] = $this->web_user->uid;

          break;

        case 'admin':

          $this->drupalLogin($this->admin_user);

          $case['user_uid'] = $this->admin_user->uid;

          break;

      }

      // Request the node with the comment.

      $this->drupalGet('node/' . $node->nid);

      // Verify classes if the comment is visible for the current user.

      if ($case['comment_status'] == COMMENT_PUBLISHED || $case['user'] == 'admin') {

        // Verify the comment-by-anonymous class.

        $comments = $this->xpath('//*[contains(@class, "comment-by-anonymous")]');

        if ($case['comment_uid'] == 0) {