NodeAccessLanguageAwareCombinationTest.php

<?php

/**
 * @file
 * Contains \Drupal\node\Tests\NodeAccessLanguageAwareCombinationTest.
 */
namespace Drupal\node\Tests;

use Drupal\Core\Language\Language;

/**
 * Tests node access with multiple languages and access control modules.
 */
class NodeAccessLanguageAwareCombinationTest extends NodeTestBase {

  /**
   * Enable language and two node access modules.
   *
   * @var array
   */
  public static $modules = array(
    'language',
    'node_access_test_language',
    'node_access_test',
  );

  /**
   * A set of nodes to use in testing.
   *
   * @var array
   */
  protected $nodes = array();

  /**
   * A normal authenticated user.
   *
   * @var \Drupal\user\Plugin\Core\Entity\User.
   */
  protected $web_user;
  public static function getInfo() {
    return array(
      'name' => 'Node access language-aware combination',
      'description' => 'Tests node access functionality with multiple languages and two node access modules.',
      'group' => 'Node',
    );
  }
  public function setUp() {
    parent::setUp();

    // After enabling a node access module, the access table has to be rebuild.
    node_access_rebuild();

    // Add Hungarian and Catalan.
    $language = new Language(array(
      'langcode' => 'hu',
    ));
    language_save($language);
    $language = new Language(array(
      'langcode' => 'ca',
    ));
    language_save($language);

    // Create a normal authenticated user.
    $this->web_user = $this
      ->drupalCreateUser(array(
      'access content',
    ));

    // Load the user 1 user for later use as an admin user with permission to
    // see everything.
    $this->admin_user = user_load(1);

    // The node_access_test_language module allows individual translations of a
    // node to be marked private (not viewable by normal users), and the
    // node_access_test module allows whole nodes to be marked private. (In a
    // real-world implementation, hook_node_access_records_alter() might be
    // implemented by one or both modules to enforce that private nodes or
    // translations are always private, but we want to test the default,
    // additive behavior of node access).
    // Create six Hungarian nodes with Catalan translations:
    // 1. One public with neither language marked as private.
    // 2. One private with neither language marked as private.
    // 3. One public with only the Hungarian translation private.
    // 4. One public with only the Catalan translation private.
    // 5. One public with both the Hungarian and Catalan translations private.
    // 6. One private with both the Hungarian and Catalan translations private.
    $this->nodes['public_both_public'] = $node = $this
      ->drupalCreateNode(array(
      'body' => array(
        array(),
      ),
      'langcode' => 'hu',
      'field_private' => array(
        array(
          'value' => 0,
        ),
      ),
      'private' => FALSE,
    ));
    $translation = $node
      ->getTranslation('ca');
    $translation->field_private[0]->value = 0;
    $node
      ->save();
    $this->nodes['private_both_public'] = $node = $this
      ->drupalCreateNode(array(
      'body' => array(
        array(),
      ),
      'langcode' => 'hu',
      'field_private' => array(
        array(
          'value' => 0,
        ),
      ),
      'private' => TRUE,
    ));
    $translation = $node
      ->getTranslation('ca');
    $translation->field_private[0]->value = 0;
    $node
      ->save();
    $this->nodes['public_hu_private'] = $node = $this
      ->drupalCreateNode(array(
      'body' => array(
        array(),
      ),
      'langcode' => 'hu',
      'field_private' => array(
        array(
          'value' => 1,
        ),
      ),
      'private' => FALSE,
    ));
    $translation = $node
      ->getTranslation('ca');
    $translation->field_private[0]->value = 0;
    $node
      ->save();
    $this->nodes['public_ca_private'] = $node = $this
      ->drupalCreateNode(array(
      'body' => array(
        array(),
      ),
      'langcode' => 'hu',
      'field_private' => array(
        array(
          'value' => 0,
        ),
      ),
      'private' => FALSE,
    ));
    $translation = $node
      ->getTranslation('ca');
    $translation->field_private[0]->value = 1;
    $node
      ->save();
    $this->nodes['public_both_private'] = $node = $this
      ->drupalCreateNode(array(
      'body' => array(
        array(),
      ),
      'langcode' => 'hu',
      'field_private' => array(
        array(
          'value' => 1,
        ),
      ),
      'private' => FALSE,
    ));
    $translation = $node
      ->getTranslation('ca');
    $translation->field_private[0]->value = 1;
    $node
      ->save();
    $this->nodes['private_both_private'] = $node = $this
      ->drupalCreateNode(array(
      'body' => array(
        array(),
      ),
      'langcode' => 'hu',
      'field_private' => array(
        array(
          'value' => 1,
        ),
      ),
      'private' => TRUE,
    ));
    $translation = $node
      ->getTranslation('ca');
    $translation->field_private[0]->value = 1;
    $node
      ->save();
    $this->nodes['public_no_language_private'] = $this
      ->drupalCreateNode(array(
      'field_private' => array(
        array(
          'value' => 1,
        ),
      ),
      'private' => FALSE,
    ));
    $this->nodes['public_no_language_public'] = $this
      ->drupalCreateNode(array(
      'field_private' => array(
        array(
          'value' => 0,
        ),
      ),
      'private' => FALSE,
    ));
    $this->nodes['private_no_language_private'] = $this
      ->drupalCreateNode(array(
      'field_private' => array(
        array(
          'value' => 1,
        ),
      ),
      'private' => TRUE,
    ));
    $this->nodes['private_no_language_public'] = $this
      ->drupalCreateNode(array(
      'field_private' => array(
        array(
          'value' => 1,
        ),
      ),
      'private' => TRUE,
    ));
  }

  /**
   * Tests node_access() and node access queries with multiple node languages.
   */
  function testNodeAccessLanguageAwareCombination() {
    $expected_node_access = array(
      'view' => TRUE,
      'update' => FALSE,
      'delete' => FALSE,
    );
    $expected_node_access_no_access = array(
      'view' => FALSE,
      'update' => FALSE,
      'delete' => FALSE,
    );

    // When the node and both translations are public, access should only be
    // denied when a translation that does not exist is requested.
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['public_both_public'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['public_both_public'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['public_both_public'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_both_public'], $this->web_user, 'en');

    // If the node is marked private but both existing translations are not,
    // access should still be granted, because the grants are additive.
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['private_both_public'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['private_both_public'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['private_both_public'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_both_public'], $this->web_user, 'en');

    // If the node is marked private, but a existing translation is public,
    // access should only be granted for the public translation. For a
    // translation that does not exist yet (English translation), the access is
    // denied. With the Hungarian translation marked as private, but the Catalan
    // translation public, the access is granted.
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_hu_private'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_hu_private'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['public_hu_private'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_hu_private'], $this->web_user, 'en');

    // With the Catalan translation marked as private, but the node public,
    // access is granted for the existing Hungarian translation, but not for the
    // Catalan nor the English ones.
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['public_ca_private'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['public_ca_private'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_ca_private'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_ca_private'], $this->web_user, 'en');

    // With both translations marked as private, but the node public, access
    // should be denied in all cases.
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_both_private'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_both_private'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_both_private'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_both_private'], $this->web_user, 'en');

    // If the node and both its existing translations are private, access should
    // be denied in all cases.
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_both_private'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_both_private'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_both_private'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_both_private'], $this->web_user, 'en');

    // No access for all languages as the language aware node access module
    // denies access.
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_no_language_private'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_no_language_private'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_no_language_private'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_no_language_private'], $this->web_user, 'en');

    // Access only for request with no language defined.
    $this
      ->assertNodeAccess($expected_node_access, $this->nodes['public_no_language_public'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_no_language_public'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_no_language_public'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['public_no_language_public'], $this->web_user, 'en');

    // No access for all languages as both node access modules deny access.
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_no_language_private'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_no_language_private'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_no_language_private'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_no_language_private'], $this->web_user, 'en');

    // No access for all languages as the non language aware node access module
    // denies access.
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_no_language_public'], $this->web_user);
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_no_language_public'], $this->web_user, 'hu');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_no_language_public'], $this->web_user, 'ca');
    $this
      ->assertNodeAccess($expected_node_access_no_access, $this->nodes['private_no_language_public'], $this->web_user, 'en');

    // Query the node table with the node access tag in several languages.
    // Query with no language specified. The fallback (hu or und) will be used.
    $select = db_select('node', 'n')
      ->fields('n', array(
      'nid',
    ))
      ->addMetaData('account', $this->web_user)
      ->addTag('node_access');
    $nids = $select
      ->execute()
      ->fetchAllAssoc('nid');

    // Four nodes should be returned with public Hungarian translations or the
    // no language public node.
    $this
      ->assertEqual(count($nids), 4, 'db_select() returns 4 nodes when no langcode is specified.');
    $this
      ->assertTrue(array_key_exists($this->nodes['public_both_public']->nid, $nids), 'Returned node ID is full public node.');
    $this
      ->assertTrue(array_key_exists($this->nodes['public_ca_private']->nid, $nids), 'Returned node ID is Hungarian public only node.');
    $this
      ->assertTrue(array_key_exists($this->nodes['private_both_public']->nid, $nids), 'Returned node ID is both public non-language-aware private only node.');
    $this
      ->assertTrue(array_key_exists($this->nodes['public_no_language_public']->nid, $nids), 'Returned node ID is no language public node.');

    // Query with Hungarian (hu) specified.
    $select = db_select('node', 'n')
      ->fields('n', array(
      'nid',
    ))
      ->addMetaData('account', $this->web_user)
      ->addMetaData('langcode', 'hu')
      ->addTag('node_access');
    $nids = $select
      ->execute()
      ->fetchAllAssoc('nid');

    // Three nodes should be returned (with public Hungarian translations).
    $this
      ->assertEqual(count($nids), 3, 'db_select() returns 3 nodes.');
    $this
      ->assertTrue(array_key_exists($this->nodes['public_both_public']->nid, $nids), 'Returned node ID is both public node.');
    $this
      ->assertTrue(array_key_exists($this->nodes['public_ca_private']->nid, $nids), 'Returned node ID is Hungarian public only node.');
    $this
      ->assertTrue(array_key_exists($this->nodes['private_both_public']->nid, $nids), 'Returned node ID is both public non-language-aware private only node.');

    // Query with Catalan (ca) specified.
    $select = db_select('node', 'n')
      ->fields('n', array(
      'nid',
    ))
      ->addMetaData('account', $this->web_user)
      ->addMetaData('langcode', 'ca')
      ->addTag('node_access');
    $nids = $select
      ->execute()
      ->fetchAllAssoc('nid');

    // Three nodes should be returned (with public Catalan translations).
    $this
      ->assertEqual(count($nids), 3, 'db_select() returns 3 nodes.');
    $this
      ->assertTrue(array_key_exists($this->nodes['public_both_public']->nid, $nids), 'Returned node ID is both public node.');
    $this
      ->assertTrue(array_key_exists($this->nodes['public_hu_private']->nid, $nids), 'Returned node ID is Catalan public only node.');
    $this
      ->assertTrue(array_key_exists($this->nodes['private_both_public']->nid, $nids), 'Returned node ID is both public non-language-aware private only node.');

    // Query with German (de) specified.
    $select = db_select('node', 'n')
      ->fields('n', array(
      'nid',
    ))
      ->addMetaData('account', $this->web_user)
      ->addMetaData('langcode', 'de')
      ->addTag('node_access');
    $nids = $select
      ->execute()
      ->fetchAllAssoc('nid');

    // There are no nodes with German translations, so no results are returned.
    $this
      ->assertTrue(empty($nids), 'db_select() returns an empty result.');

    // Query the nodes table as admin user (full access) with the node access
    // tag and no specific langcode.
    $select = db_select('node', 'n')
      ->fields('n', array(
      'nid',
    ))
      ->addMetaData('account', $this->admin_user)
      ->addTag('node_access');
    $nids = $select
      ->execute()
      ->fetchAllAssoc('nid');

    // All nodes are returned.
    $this
      ->assertEqual(count($nids), 10, 'db_select() returns all nodes.');

    // Query the nodes table as admin user (full access) with the node access
    // tag and langcode de.
    $select = db_select('node', 'n')
      ->fields('n', array(
      'nid',
    ))
      ->addMetaData('account', $this->admin_user)
      ->addMetaData('langcode', 'de')
      ->addTag('node_access');
    $nids = $select
      ->execute()
      ->fetchAllAssoc('nid');

    // Even though there is no German translation, all nodes are returned
    // because node access filtering does not occur when the user is user 1.
    $this
      ->assertEqual(count($nids), 10, 'db_select() returns all nodes.');
  }

}