CommentAttributesTest.php

<?php

/**
 * @file
 * Contains Drupal\rdf\Tests\CommentAttributesTest.
 */
namespace Drupal\rdf\Tests;

use Drupal\comment\Tests\CommentTestBase;

/**
 * Tests the RDFa markup of comments.
 */
class CommentAttributesTest extends CommentTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'views',
    'node',
    'comment',
    'rdf',
  );
  public static function getInfo() {
    return array(
      'name' => 'RDFa markup for comments',
      'description' => 'Tests the RDFa markup of comments.',
      'group' => 'RDF',
    );
  }
  public function setUp() {
    parent::setUp();

    // Enables anonymous user comments.
    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
      'access comments' => TRUE,
      'post comments' => TRUE,
      'skip comment approval' => TRUE,
    ));

    // Allows anonymous to leave their contact information.
    $this
      ->setCommentAnonymous(COMMENT_ANONYMOUS_MAY_CONTACT);
    $this
      ->setCommentPreview(DRUPAL_OPTIONAL);
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentSettings('comment_default_mode', COMMENT_MODE_THREADED, 'Comment paging changed.');

    // Prepares commonly used URIs.
    $this->base_uri = url('<front>', array(
      'absolute' => TRUE,
    ));
    $this->node_uri = url('node/' . $this->node->nid, array(
      'absolute' => TRUE,
    ));
  }

  /**
   * Tests the presence of the RDFa markup for the number of comments.
   */
  public function testNumberOfCommentsRdfaMarkup() {

    // Posts 2 comments on behalf of registered user.
    $this
      ->saveComment($this->node->nid, $this->web_user->uid);
    $this
      ->saveComment($this->node->nid, $this->web_user->uid);

    // Tests number of comments in teaser view.
    $this
      ->drupalLogin($this->web_user);
    $parser = new \EasyRdf_Parser_Rdfa();
    $graph = new \EasyRdf_Graph();
    $parser
      ->parse($graph, $this
      ->drupalGet('node'), 'rdfa', $this->base_uri);

    // Number of comments.
    $expected_value = array(
      'type' => 'literal',
      'value' => 2,
      'datatype' => 'http://www.w3.org/2001/XMLSchema#integer',
    );
    $this
      ->assertTrue($graph
      ->hasProperty($this->node_uri, 'http://rdfs.org/sioc/ns#num_replies', $expected_value), 'Number of comments found in RDF output of teaser view (sioc:num_replies).');

    // Makes sure we don't generate the wrong statement for number of comments.
    $node_comments_uri = url('node/' . $this->node->nid, array(
      'fragment' => 'comments',
      'absolute' => TRUE,
    ));
    $this
      ->assertFalse($graph
      ->hasProperty($node_comments_uri, 'http://rdfs.org/sioc/ns#num_replies', $expected_value), 'Number of comments found in RDF output of teaser view mode (sioc:num_replies).');

    // Tests number of comments in full node view, expected value is the same.
    $parser = new \EasyRdf_Parser_Rdfa();
    $graph = new \EasyRdf_Graph();
    $parser
      ->parse($graph, $this
      ->drupalGet('node/' . $this->node->nid), 'rdfa', $this->base_uri);
    $this
      ->assertTrue($graph
      ->hasProperty($this->node_uri, 'http://rdfs.org/sioc/ns#num_replies', $expected_value), 'Number of comments found in RDF output of full node view mode (sioc:num_replies).');
  }

  /**
   * Tests if RDFa markup for meta information is present in comments.
   *
   * Tests presence of RDFa markup for the title, date and author and homepage
   * on comments from registered and anonymous users.
   */
  public function testCommentRdfaMarkup() {

    // Posts comment #1 on behalf of registered user.
    $comment1 = $this
      ->saveComment($this->node->nid, $this->web_user->uid);

    // Tests comment #1 with access to the user profile.
    $this
      ->drupalLogin($this->web_user);
    $parser = new \EasyRdf_Parser_Rdfa();
    $graph = new \EasyRdf_Graph();
    $parser
      ->parse($graph, $this
      ->drupalGet('node/' . $this->node->nid), 'rdfa', $this->base_uri);
    $this
      ->_testBasicCommentRdfaMarkup($graph, $comment1);

    // Tests comment #1 with no access to the user profile (as anonymous user).
    $this
      ->drupalLogout();
    $parser = new \EasyRdf_Parser_Rdfa();
    $graph = new \EasyRdf_Graph();
    $parser
      ->parse($graph, $this
      ->drupalGet('node/' . $this->node->nid), 'rdfa', $this->base_uri);
    $this
      ->_testBasicCommentRdfaMarkup($graph, $comment1);

    // Posts comment #2 as anonymous user.
    $anonymous_user = array();
    $anonymous_user['name'] = $this
      ->randomName();
    $anonymous_user['mail'] = 'tester@simpletest.org';
    $anonymous_user['homepage'] = 'http://example.org/';
    $comment2 = $this
      ->saveComment($this->node->nid, NULL, $anonymous_user);

    // Tests comment #2 as anonymous user.
    $parser = new \EasyRdf_Parser_Rdfa();
    $graph = new \EasyRdf_Graph();
    $parser
      ->parse($graph, $this
      ->drupalGet('node/' . $this->node->nid), 'rdfa', $this->base_uri);
    $this
      ->_testBasicCommentRdfaMarkup($graph, $comment2, $anonymous_user);

    // Tests comment #2 as logged in user.
    $this
      ->drupalLogin($this->web_user);
    $parser = new \EasyRdf_Parser_Rdfa();
    $graph = new \EasyRdf_Graph();
    $parser
      ->parse($graph, $this
      ->drupalGet('node/' . $this->node->nid), 'rdfa', $this->base_uri);
    $this
      ->_testBasicCommentRdfaMarkup($graph, $comment2, $anonymous_user);
  }

  /**
   * Tests RDF comment replies.
   */
  public function testCommentReplyOfRdfaMarkup() {

    // Posts comment #1 on behalf of registered user.
    $this
      ->drupalLogin($this->web_user);
    $comment_1 = $this
      ->saveComment($this->node->nid, $this->web_user->uid);
    $comment_1_uri = url('comment/' . $comment_1
      ->id(), array(
      'absolute' => TRUE,
    ));

    // Posts a reply to the first comment.
    $comment_2 = $this
      ->saveComment($this->node->nid, $this->web_user->uid, NULL, $comment_1
      ->id());
    $comment_2_uri = url('comment/' . $comment_2
      ->id(), array(
      'absolute' => TRUE,
    ));
    $parser = new \EasyRdf_Parser_Rdfa();
    $graph = new \EasyRdf_Graph();
    $parser
      ->parse($graph, $this
      ->drupalGet('node/' . $this->node->nid), 'rdfa', $this->base_uri);

    // Tests the reply_of relationship of a first level comment.
    $expected_value = array(
      'type' => 'uri',
      'value' => $this->node_uri,
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_1_uri, 'http://rdfs.org/sioc/ns#reply_of', $expected_value), 'Comment relation to its node found in RDF output (sioc:reply_of).');

    // Tests the reply_of relationship of a second level comment.
    $expected_value = array(
      'type' => 'uri',
      'value' => $this->node_uri,
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_2_uri, 'http://rdfs.org/sioc/ns#reply_of', $expected_value), 'Comment relation to its node found in RDF output (sioc:reply_of).');
    $expected_value = array(
      'type' => 'uri',
      'value' => $comment_1_uri,
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_2_uri, 'http://rdfs.org/sioc/ns#reply_of', $expected_value), 'Comment relation to its parent comment found in RDF output (sioc:reply_of).');
  }

  /**
   * Helper function for testCommentRdfaMarkup().
   *
   * Tests the current page for basic comment RDFa markup.
   *
   * @param $comment
   *   Comment object.
   * @param $account
   *   An array containing information about an anonymous user.
   */
  function _testBasicCommentRdfaMarkup($graph, $comment, $account = array()) {
    $uri = $comment
      ->uri();
    $comment_uri = url($uri['path'], $uri['options'] + array(
      'absolute' => TRUE,
    ));

    // Comment type.
    $expected_value = array(
      'type' => 'uri',
      'value' => 'http://rdfs.org/sioc/types#Comment',
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_uri, 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type', $expected_value), 'Comment type found in RDF output (sioct:Comment).');

    // Comment type.
    $expected_value = array(
      'type' => 'uri',
      'value' => 'http://rdfs.org/sioc/ns#Post',
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_uri, 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type', $expected_value), 'Comment type found in RDF output (sioc:Post).');

    // Comment title.
    $expected_value = array(
      'type' => 'literal',
      'value' => $comment->subject->value,
      'lang' => 'en',
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_uri, 'http://purl.org/dc/terms/title', $expected_value), 'Comment title found in RDF output (dc:title).');

    // Comment date.
    $expected_value = array(
      'type' => 'literal',
      'value' => date('c', $comment->created->value),
      'datatype' => 'http://www.w3.org/2001/XMLSchema#dateTime',
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_uri, 'http://purl.org/dc/terms/date', $expected_value), 'Comment date found in RDF output (dc:date).');

    // Comment date.
    $expected_value = array(
      'type' => 'literal',
      'value' => date('c', $comment->created->value),
      'datatype' => 'http://www.w3.org/2001/XMLSchema#dateTime',
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_uri, 'http://purl.org/dc/terms/created', $expected_value), 'Comment date found in RDF output (dc:created).');

    // Comment body.
    $expected_value = array(
      'type' => 'literal',
      'value' => $comment->comment_body->value . "\n",
      'lang' => 'en',
    );
    $this
      ->assertTrue($graph
      ->hasProperty($comment_uri, 'http://purl.org/rss/1.0/modules/content/encoded', $expected_value), 'Comment body found in RDF output (content:encoded).');

    // The comment author can be a registered user or an anonymous user.
    if ($comment->uid->value > 0) {
      $author_uri = url('user/' . $comment->uid->value, array(
        'absolute' => TRUE,
      ));

      // Comment relation to author.
      $expected_value = array(
        'type' => 'uri',
        'value' => $author_uri,
      );
      $this
        ->assertTrue($graph
        ->hasProperty($comment_uri, 'http://rdfs.org/sioc/ns#has_creator', $expected_value), 'Comment relation to author found in RDF output (sioc:has_creator).');
    }
    else {

      // The author is expected to be a blank node.
      $author_uri = $graph
        ->get($comment_uri, '<http://rdfs.org/sioc/ns#has_creator>');
      if ($author_uri instanceof \EasyRdf_Resource) {
        $this
          ->assertTrue($author_uri
          ->isBnode(), 'Comment relation to author found in RDF output (sioc:has_creator) and author is blank node.');
      }
      else {
        $this
          ->fail('Comment relation to author found in RDF output (sioc:has_creator).');
      }
    }

    // Author name.
    $name = empty($account["name"]) ? $this->web_user->name : $account["name"] . " (not verified)";
    $expected_value = array(
      'type' => 'literal',
      'value' => $name,
    );
    $this
      ->assertTrue($graph
      ->hasProperty($author_uri, 'http://xmlns.com/foaf/0.1/name', $expected_value), 'Comment author name found in RDF output (foaf:name).');

    // Comment author homepage (only for anonymous authors).
    if ($comment->uid->value == 0) {
      $expected_value = array(
        'type' => 'uri',
        'value' => 'http://example.org/',
      );
      $this
        ->assertTrue($graph
        ->hasProperty($author_uri, 'http://xmlns.com/foaf/0.1/page', $expected_value), 'Comment author link found in RDF output (foaf:page).');
    }
  }

  /**
   * Creates a comment entity.
   *
   * @param $nid
   *   Node id which will hold the comment.
   * @param $uid
   *   User id of the author of the comment. Can be NULL if $contact provided.
   * @param $contact
   *   Set to NULL for no contact info, TRUE to ignore success checking, and
   *   array of values to set contact info.
   * @param $pid
   *   Comment id of the parent comment in a thread.
   */
  function saveComment($nid, $uid, $contact = NULL, $pid = 0) {
    $values = array(
      'nid' => $nid,
      'uid' => $uid,
      'pid' => $pid,
      'node_type' => 'comment_node_article',
      'subject' => $this
        ->randomName(),
      'comment_body' => $this
        ->randomName(),
      'status' => 1,
    );
    if ($contact) {
      $values += $contact;
    }
    $comment = entity_create('comment', $values);
    $comment
      ->save();
    return $comment;
  }

}