summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--modules/comment/comment.admin.inc2
-rw-r--r--modules/comment/comment.module119
-rw-r--r--modules/comment/comment.test118
3 files changed, 223 insertions, 16 deletions
diff --git a/modules/comment/comment.admin.inc b/modules/comment/comment.admin.inc
index e41a0d63c..0806d7535 100644
--- a/modules/comment/comment.admin.inc
+++ b/modules/comment/comment.admin.inc
@@ -86,7 +86,7 @@ function comment_admin_overview($type = 'new', $arg) {
foreach ($result as $comment) {
$options[$comment->cid] = array(
- 'subject' => l($comment->subject, 'node/' . $comment->nid, array('attributes' => array('title' => truncate_utf8($comment->comment, 128)), 'fragment' => 'comment-' . $comment->cid)),
+ 'subject' => l($comment->subject, 'comment/' . $comment->cid, array('attributes' => array('title' => truncate_utf8($comment->comment, 128)), 'fragment' => 'comment-' . $comment->cid)),
'author' => theme('username', $comment),
'posted_in' => l($comment->node_title, 'node/' . $comment->nid),
'time' => format_date($comment->timestamp, 'small'),
diff --git a/modules/comment/comment.module b/modules/comment/comment.module
index 657e07254..60448295c 100644
--- a/modules/comment/comment.module
+++ b/modules/comment/comment.module
@@ -204,6 +204,13 @@ function comment_menu() {
'access arguments' => array('administer comments'),
'type' => MENU_CALLBACK,
);
+ $items['comment/%comment'] = array(
+ 'title' => 'Comment permalink',
+ 'page callback' => 'comment_permalink',
+ 'page arguments' => array(1),
+ 'access arguments' => array('access comments'),
+ 'type' => MENU_CALLBACK,
+ );
return $items;
}
@@ -301,6 +308,43 @@ function comment_block_view($delta = '') {
}
/**
+ * 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 $comment
+ * A comment object.
+ * @return
+ * The comment listing set to the page on which the comment appears.
+ */
+function comment_permalink($comment) {
+ $node = node_load($comment->nid);
+ if ($node && $comment) {
+
+ // 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;
+
+ // Set the node path as the canonical URL to prevent duplicate content.
+ drupal_add_link(array('rel' => 'canonical', 'href' => url('node/' . $node->nid)));
+
+ // Return the node view, this will show the correct comment in context.
+ return menu_execute_active_handler('node/' . $node->nid);
+ }
+ drupal_not_found();
+}
+
+/**
* Find the most recent comments that are available to the current user.
*
* This is done in two steps:
@@ -404,7 +448,7 @@ function theme_comment_block() {
$items = array();
$number = variable_get('comment_block_count', 10);
foreach (comment_get_recent($number) as $comment) {
- $items[] = l($comment->subject, 'node/' . $comment->nid, array('fragment' => 'comment-' . $comment->cid)) . '<br />' . t('@time ago', array('@time' => format_interval(REQUEST_TIME - $comment->timestamp)));
+ $items[] = l($comment->subject, 'comment/' . $comment->cid, array('fragment' => 'comment-' . $comment->cid)) . '<br />' . t('@time ago', array('@time' => format_interval(REQUEST_TIME - $comment->timestamp)));
}
if ($items) {
@@ -1178,7 +1222,7 @@ function comment_render($node, $cid = 0) {
$query->condition('c.status', COMMENT_PUBLISHED);
$count_query->condition('c.status', COMMENT_PUBLISHED);
}
- if ($mode == COMMENT_MODE_FLAT_COLLAPSED || $mode == COMMENT_MODE_FLAT_EXPANDED) {
+ if ($mode === COMMENT_MODE_FLAT_COLLAPSED || $mode === COMMENT_MODE_FLAT_EXPANDED) {
$query->orderBy('c.cid', 'ASC');
}
else {
@@ -1351,6 +1395,67 @@ function comment_num_new($nid, $timestamp = 0) {
}
/**
+ * Get the display ordinal for a comment, starting from 0.
+ *
+ * Count the number of comments which appear before the comment we want to
+ * display, taking into account display settings and threading.
+ *
+ * @param $cid
+ * The comment ID.
+ * @param $node_type
+ * The node type of the comment's parent.
+ * @return
+ * The display ordinal for the comment.
+ * @see comment_get_display_page()
+ */
+function comment_get_display_ordinal($cid, $node_type) {
+ // Count how many comments (c1) are before $cid (c2) in display order. This is
+ // the 0-based display ordinal.
+ $query = db_select('comment', 'c1');
+ $query->innerJoin('comment', 'c2', 'c2.nid = c1.nid');
+ $query->addExpression('COUNT(*)', 'count');
+ $query->condition('c2.cid', $cid);
+ if (!user_access('administer comments')) {
+ $query->condition('c1.status', COMMENT_PUBLISHED);
+ }
+ $mode = variable_get('comment_default_mode_' . $node_type, COMMENT_MODE_THREADED_EXPANDED);
+
+ if ($mode == COMMENT_MODE_FLAT_EXPANDED || $mode == COMMENT_MODE_FLAT_COLLAPSED) {
+ // For flat comments, cid is used for ordering comments due to
+ // unpredicatable behavior with timestamp, so we make the same assumption
+ // here.
+ $query->condition('c1.cid', 'c2.cid', '<');
+ }
+ else {
+ // For threaded comments, the c.thread column is used for ordering. We can
+ // use the vancode for comparison, but must remove the trailing slash.
+ // @see comment_render().
+ $query->where('SUBSTRING(c1.thread, 1, (LENGTH(c1.thread) -1)) < SUBSTRING(c2.thread, 1, (LENGTH(c2.thread) -1))');
+ }
+
+ return $query->execute()->fetchField();
+}
+
+/**
+ * Return the page number for a comment.
+ *
+ * Finds the correct page number for a comment taking into account display
+ * and paging settings.
+ *
+ * @param $cid
+ * The comment ID.
+ * @param $node_type
+ * The node type the comment is attached to.
+ * @return
+ * The page number.
+ */
+function comment_get_display_page($cid, $node_type) {
+ $ordinal = comment_get_display_ordinal($cid, $node_type);
+ $comments_per_page = variable_get('comment_default_per_page_' . $node_type, 50);
+ return floor($ordinal / $comments_per_page);
+}
+
+/**
* Validate comment data.
*
* @param $edit
@@ -1804,11 +1909,7 @@ function _comment_form_submit(&$comment_values) {
function comment_form_submit($form, &$form_state) {
_comment_form_submit($form_state['values']);
if ($cid = comment_save($form_state['values'])) {
- $node = node_load($form_state['values']['nid']);
- // Add 1 to existing $node->comment count to include new comment.
- $comment_count = $node->comment_count + 1;
- $page = comment_new_page_count($comment_count, 1, $node);
- $form_state['redirect'] = array('node/' . $node->nid, $page, "comment-$cid");
+ $form_state['redirect'] = array('comment/' . $cid, array(), "comment-$cid");
return;
}
}
@@ -1871,7 +1972,7 @@ function template_preprocess_comment(&$variables) {
$variables['picture'] = theme_get_setting('toggle_comment_user_picture') ? theme('user_picture', $comment) : '';
$variables['signature'] = $comment->signature;
$variables['submitted'] = theme('comment_submitted', $comment);
- $variables['title'] = l($comment->subject, $_GET['q'], array('fragment' => "comment-$comment->cid"));
+ $variables['title'] = l($comment->subject, 'comment/' . $comment->cid, array('fragment' => "comment-$comment->cid"));
$variables['template_files'][] = 'comment-' . $node->type;
// Set status to a string representation of comment->status.
if (isset($comment->preview)) {
@@ -1912,7 +2013,7 @@ function template_preprocess_comment_folded(&$variables) {
$variables['author'] = theme('username', $comment);
$variables['date'] = format_date($comment->timestamp);
$variables['new'] = $comment->new ? t('new') : '';
- $variables['title'] = l($comment->subject, comment_node_url() . '/' . $comment->cid, array('fragment' => "comment-$comment->cid"));
+ $variables['title'] = l($comment->subject, 'comment/' . $comment->cid, array('fragment' => "comment-$comment->cid"));
// Gather comment classes.
if ($comment->uid === 0) {
$variables['classes_array'][] = 'comment-by-anonymous';
diff --git a/modules/comment/comment.test b/modules/comment/comment.test
index db5788984..473f61acd 100644
--- a/modules/comment/comment.test
+++ b/modules/comment/comment.test
@@ -123,7 +123,7 @@ class CommentHelperCase extends DrupalWebTestCase {
* Form value.
*/
function setCommentForm($enabled) {
- $this->setCommentSettings('comment_form_location', ($enabled ? '1' : '3'), 'Comment controls ' . ($enabled ? 'enabled' : 'disabled') . '.');
+ $this->setCommentSettings('comment_form_location', ($enabled ? COMMENT_FORM_BELOW : COMMENT_FORM_SEPARATE_PAGE), 'Comment controls ' . ($enabled ? 'enabled' : 'disabled') . '.');
}
/**
@@ -143,7 +143,7 @@ class CommentHelperCase extends DrupalWebTestCase {
* Comments per page value.
*/
function setCommentsPerPage($number) {
- $this->setCommentSettings('comment_default_per_page_article', $number, 'Number of comments per page set to ' . $number . '.');
+ $this->setCommentSettings('comment_default_per_page', $number, 'Number of comments per page set to ' . $number . '.');
}
/**
@@ -244,7 +244,9 @@ class CommentInterfaceTest extends CommentHelperCase {
// Set comments to not have subject.
$this->drupalLogin($this->admin_user);
$this->setCommentPreview(TRUE);
+ $this->setCommentForm(TRUE);
$this->setCommentSubject(FALSE);
+ $this->setCommentSettings('comment_default_mode', COMMENT_MODE_THREADED_EXPANDED, t('Comment paging changed.'));
$this->drupalLogout();
// Post comment without subject.
@@ -300,11 +302,10 @@ class CommentInterfaceTest extends CommentHelperCase {
$this->drupalGet('node');
$this->assertRaw('3 comments', t('Link to the 3 comments exist.'));
- // Pager
+ // Confirm a new comment is posted to the correct page.
$this->setCommentsPerPage(2);
$comment_new_page = $this->postComment($this->node, $this->randomName(), $this->randomName());
- $this->drupalGet('node/' . $this->node->nid);
- $this->assertTrue($this->commentExists($comment) && $this->commentExists($comment_new_page), t('Page one exists. %s'));
+ $this->assertTrue($this->commentExists($comment_new_page), t('Page one exists. %s'));
$this->drupalGet('node/' . $this->node->nid, array('query' => 'page=1'));
$this->assertTrue($this->commentExists($reply, TRUE), t('Page two exists. %s'));
$this->setCommentsPerPage(50);
@@ -454,6 +455,93 @@ class CommentAnonymous extends CommentHelperCase {
}
}
+/**
+ * Verify pagination of comments.
+ */
+class CommentPagerTest extends CommentHelperCase {
+
+ public static function getInfo() {
+ return array(
+ 'name' => t('Comment paging settings'),
+ 'description' => t('Test paging of comments and their settings.'),
+ 'group' => t('Comment'),
+ );
+ }
+
+ /**
+ * Confirm comment paging works correctly with flat and threaded comments.
+ */
+ function testCommentPaging() {
+ $this->drupalLogin($this->admin_user);
+
+ // Set comment variables.
+ $this->setCommentForm(TRUE);
+ $this->setCommentSubject(TRUE);
+ $this->setCommentPreview(FALSE);
+
+ // Create a node and three comments.
+ $node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
+ $comments = array();
+ $comments[] = $this->postComment($node, $this->randomName(), $this->randomName(), FALSE, TRUE);
+ $comments[] = $this->postComment($node, $this->randomName(), $this->randomName(), FALSE, TRUE);
+ $comments[] = $this->postComment($node, $this->randomName(), $this->randomName(), FALSE, TRUE);
+
+ $this->setCommentSettings('comment_default_mode', COMMENT_MODE_FLAT_EXPANDED, t('Comment paging changed.'));
+
+ // Set comments to one per page so that we are able to test paging without
+ // needing to insert large numbers of comments.
+ $this->setCommentsPerPage(1);
+
+ // Check the first page of the node, and confirm the correct comments are
+ // shown.
+ $this->drupalGet('node/' . $node->nid);
+ $this->assertRaw(t('next'), t('Paging links found.'));
+ $this->assertTrue($this->commentExists($comments[0]), t('Comment 1 appears on page 1.'));
+ $this->assertFalse($this->commentExists($comments[1]), t('Comment 2 does not appear on page 1.'));
+ $this->assertFalse($this->commentExists($comments[2]), t('Comment 3 does not appear on page 1.'));
+
+ // Check the second page.
+ $this->drupalGet('node/' . $node->nid, array('query' => 'page=1'));
+ $this->assertTrue($this->commentExists($comments[1]), t('Comment 2 appears on page 2.'));
+ $this->assertFalse($this->commentExists($comments[0]), t('Comment 1 does not appear on page 2.'));
+ $this->assertFalse($this->commentExists($comments[2]), t('Comment 3 does not appear on page 2.'));
+
+ // Check the third page.
+ $this->drupalGet('node/' . $node->nid, array('query' => 'page=2'));
+ $this->assertTrue($this->commentExists($comments[2]), t('Comment 3 appears on page 3.'));
+ $this->assertFalse($this->commentExists($comments[0]), t('Comment 1 does not appear on page 3.'));
+ $this->assertFalse($this->commentExists($comments[1]), t('Comment 2 does not appear on page 3.'));
+
+ // Post a reply to the oldest comment and test again.
+ $replies = array();
+ $oldest_comment = reset($comments);
+ $this->drupalGet('comment/reply/' . $node->nid . '/' . $oldest_comment->id);
+ $reply = $this->postComment(NULL, $this->randomName(), $this->randomName(), FALSE, TRUE);
+
+ $this->setCommentsPerPage(2);
+ // We are still in flat view - the replies should not be on the first page,
+ // even though they are replies to the oldest comment.
+ $this->drupalGet('node/' . $node->nid, array('query' => 'page=0'));
+ $this->assertFalse($this->commentExists($reply, TRUE), t('In flat mode, reply does not appear on page 1.'));
+
+ // If we switch to threaded mode, the replies on the oldest comment
+ // should be bumped to the first page and comment 6 should be bumped
+ // to the second page.
+ $this->setCommentSettings('comment_default_mode', COMMENT_MODE_THREADED_EXPANDED, t('Switched to threaded mode.'));
+ $this->drupalGet('node/' . $node->nid, array('query' => 'page=0'));
+ $this->assertTrue($this->commentExists($reply, TRUE), t('In threaded mode, reply appears on page 1.'));
+ $this->assertFalse($this->commentExists($comments[1]), t('In threaded mode, comment 2 has been bumped off of page 1.'));
+
+ // If (# replies > # comments per page) in threaded expanded view,
+ // the overage should be bumped.
+ $reply2 = $this->postComment(NULL, $this->randomName(), $this->randomName(), FALSE, TRUE);
+ $this->drupalGet('node/' . $node->nid, array('query' => 'page=0'));
+ $this->assertFalse($this->commentExists($reply2, TRUE), t('In threaded mode where # replies > # comments per page, the newest reply does not appear on page 1.'));
+
+ $this->drupalLogout();
+ }
+}
+
class CommentApprovalTest extends CommentHelperCase {
public static function getInfo() {
return array(
@@ -595,10 +683,28 @@ class CommentBlockFunctionalTest extends CommentHelperCase {
$this->drupalPost('admin/build/block/configure/comment/recent', $block, t('Save block'));
$this->assertText(t('The block configuration has been saved.'), t('Block saved.'));
- // Test that all three comments are shown.
+ // Post an additional comment.
+ $comment4 = $this->postComment($this->node, $this->randomName(), $this->randomName());
+
+ // Test that all four comments are shown.
$this->assertText($comment1->subject, t('Comment found in block.'));
$this->assertText($comment2->subject, t('Comment found in block.'));
$this->assertText($comment3->comment, t('Comment found in block.'));
+ $this->assertText($comment4->subject, t('Comment found in block.'));
+
+ // Test that links to comments work when comments are across pages.
+ $this->setCommentsPerPage(1);
+ $this->drupalGet('');
+ $this->clickLink($comment1->subject);
+ $this->assertText($comment1->subject, t('Comment link goes to correct page.'));
+ $this->drupalGet('');
+ $this->clickLink($comment2->subject);
+ $this->assertText($comment2->subject, t('Comment link goes to correct page.'));
+ $this->clickLink($comment4->subject);
+ $this->assertText($comment4->subject, t('Comment link goes to correct page.'));
+ // Check that when viewing a comment page from a link to the comment, that
+ // rel="canonical" is added to the head of the document.
+ $this->assertRaw('<link rel="canonical"', t('Canonical URL was found in the HTML head'));
}
}
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-23 17:11:53 +0000