<?php

/**

 * @file

 * Tests for file.module.

 */

/**

 * Provides methods specifically for testing File module's field handling.

 */

class FileFieldTestCase extends DrupalWebTestCase {

  protected $admin_user;

  function setUp() {

    // Since this is a base class for many test cases, support the same

    // flexibility that DrupalWebTestCase::setUp() has for the modules to be

    // passed in as either an array or a variable number of string arguments.

    $modules = func_get_args();

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

      $modules = $modules[0];

    }

    $modules[] = 'file';

    $modules[] = 'file_module_test';

    parent::setUp($modules);

    $this->admin_user = $this->drupalCreateUser(array('access content', 'access administration pages', 'administer site configuration', 'administer users', 'administer permissions', 'administer content types', 'administer nodes', 'bypass node access', 'administer fields'));

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

  }

  /**

   * Retrieves a sample file of the specified type.

   */

  function getTestFile($type_name, $size = NULL) {

    // Get a file to upload.

    $file = current($this->drupalGetTestFiles($type_name, $size));

    // Add a filesize property to files as would be read by file_load().

    $file->filesize = filesize($file->uri);

    return $file;

  }

  /**

   * Retrieves the fid of the last inserted file.

   */

  function getLastFileId() {

    return (int) db_query('SELECT MAX(fid) FROM {file_managed}')->fetchField();

  }

  /**

   * Creates a new file field.

   *

   * @param $name

   *   The name of the new field (all lowercase), exclude the "field_" prefix.

   * @param $type_name

   *   The node type that this field will be added to.

   * @param $field_settings

   *   A list of field settings that will be added to the defaults.

   * @param $instance_settings

   *   A list of instance settings that will be added to the instance defaults.

   * @param $widget_settings

   *   A list of widget settings that will be added to the widget defaults.

   */

  function createFileField($name, $type_name, $field_settings = array(), $instance_settings = array(), $widget_settings = array()) {

    $field = array(

      'field_name' => $name,

      'type' => 'file',

      'settings' => array(),

      'cardinality' => !empty($field_settings['cardinality']) ? $field_settings['cardinality'] : 1,

    );

    $field['settings'] = array_merge($field['settings'], $field_settings);

    field_create_field($field);

    $this->attachFileField($name, 'node', $type_name, $instance_settings, $widget_settings);

  }

  /**

   * Attaches a file field to an entity.

   *

   * @param $name

   *   The name of the new field (all lowercase), exclude the "field_" prefix.

   * @param $entity_type

   *   The entity type this field will be added to.

   * @param $bundle

   *   The bundle this field will be added to.

   * @param $field_settings

   *   A list of field settings that will be added to the defaults.

   * @param $instance_settings

   *   A list of instance settings that will be added to the instance defaults.

   * @param $widget_settings

   *   A list of widget settings that will be added to the widget defaults.

   */

  function attachFileField($name, $entity_type, $bundle, $instance_settings = array(), $widget_settings = array()) {

    $instance = array(

      'field_name' => $name,

      'label' => $name,

      'entity_type' => $entity_type,

      'bundle' => $bundle,

      'required' => !empty($instance_settings['required']),

      'settings' => array(),

      'widget' => array(

        'type' => 'file_generic',

        'settings' => array(),

      ),

    );

    $instance['settings'] = array_merge($instance['settings'], $instance_settings);

    $instance['widget']['settings'] = array_merge($instance['widget']['settings'], $widget_settings);

    field_create_instance($instance);

  }

  /**

   * Updates an existing file field with new settings.

   */

  function updateFileField($name, $type_name, $instance_settings = array(), $widget_settings = array()) {

    $instance = field_info_instance('node', $name, $type_name);

    $instance['settings'] = array_merge($instance['settings'], $instance_settings);

    $instance['widget']['settings'] = array_merge($instance['widget']['settings'], $widget_settings);

    field_update_instance($instance);

  }

  /**

   * Uploads a file to a node.

   */

  function uploadNodeFile($file, $field_name, $nid_or_type, $new_revision = TRUE, $extras = array()) {

    $langcode = LANGUAGE_NONE;

    $edit = array(

      "title" => $this->randomName(),

      'revision' => (string) (int) $new_revision,

    );

    if (is_numeric($nid_or_type)) {

      $nid = $nid_or_type;

    }

    else {

      // Add a new node.

      $extras['type'] = $nid_or_type;

      $node = $this->drupalCreateNode($extras);

      $nid = $node->nid;

      // Save at least one revision to better simulate a real site.

      $this->drupalCreateNode(get_object_vars($node));

      $node = node_load($nid, NULL, TRUE);

      $this->assertNotEqual($nid, $node->vid, 'Node revision exists.');

    }

    // Attach a file to the node.

    $edit['files[' . $field_name . '_' . $langcode . '_0]'] = drupal_realpath($file->uri);

    $this->drupalPost("node/$nid/edit", $edit, t('Save'));

    return $nid;

  }

  /**

   * Removes a file from a node.

   *

   * Note that if replacing a file, it must first be removed then added again.

   */

  function removeNodeFile($nid, $new_revision = TRUE) {

    $edit = array(

      'revision' => (string) (int) $new_revision,

    );

    $this->drupalPost('node/' . $nid . '/edit', array(), t('Remove'));

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

  }

  /**

   * Replaces a file within a node.

   */

  function replaceNodeFile($file, $field_name, $nid, $new_revision = TRUE) {

    $edit = array(

      'files[' . $field_name . '_' . LANGUAGE_NONE . '_0]' => drupal_realpath($file->uri),

      'revision' => (string) (int) $new_revision,

    );

    $this->drupalPost('node/' . $nid . '/edit', array(), t('Remove'));

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

  }

  /**

   * Asserts that a file exists physically on disk.

   */

  function assertFileExists($file, $message = NULL) {

    $message = isset($message) ? $message : format_string('File %file exists on the disk.', array('%file' => $file->uri));

    $this->assertTrue(is_file($file->uri), $message);

  }

  /**

   * Asserts that a file exists in the database.

   */

  function assertFileEntryExists($file, $message = NULL) {

    entity_get_controller('file')->resetCache();

    $db_file = file_load($file->fid);

    $message = isset($message) ? $message : format_string('File %file exists in database at the correct path.', array('%file' => $file->uri));

    $this->assertEqual($db_file->uri, $file->uri, $message);

  }

  /**

   * Asserts that a file does not exist on disk.

   */

  function assertFileNotExists($file, $message = NULL) {

    $message = isset($message) ? $message : format_string('File %file exists on the disk.', array('%file' => $file->uri));

    $this->assertFalse(is_file($file->uri), $message);

  }

  /**

   * Asserts that a file does not exist in the database.

   */

  function assertFileEntryNotExists($file, $message) {

    entity_get_controller('file')->resetCache();

    $message = isset($message) ? $message : format_string('File %file exists in database at the correct path.', array('%file' => $file->uri));

    $this->assertFalse(file_load($file->fid), $message);

  }

  /**

   * Asserts that a file's status is set to permanent in the database.

   */

  function assertFileIsPermanent($file, $message = NULL) {

    $message = isset($message) ? $message : format_string('File %file is permanent.', array('%file' => $file->uri));

    $this->assertTrue($file->status == FILE_STATUS_PERMANENT, $message);

  }

  /**

   * Creates a temporary file, for a specific user.

   *

   * @param string $data

   *   A string containing the contents of the file.

   * @param int $uid

   *   The user ID of the file owner.

   *

   * @return object

   *   A file object, or FALSE on error.

   */

  function createTemporaryFile($data, $uid = NULL) {

    $file = file_save_data($data, NULL, NULL);

    if ($file) {

      $file->uid = isset($uid) ? $uid : $this->admin_user->uid;

      // Change the file status to be temporary.

      $file->status = NULL;

      return file_save($file);

    }

    return $file;

  }

}

/**

 * Tests adding a file to a non-node entity.

 */

class FileTaxonomyTermTestCase extends DrupalWebTestCase {

  protected $admin_user;

  public static function getInfo() {

    return array(

      'name' => 'Taxonomy term file test',

      'description' => 'Tests adding a file to a non-node entity.',

      'group' => 'File',

    );

  }

  public function setUp() {

    $modules[] = 'file';

    $modules[] = 'taxonomy';

    parent::setUp($modules);

    $this->admin_user = $this->drupalCreateUser(array('access content', 'access administration pages', 'administer site configuration', 'administer taxonomy'));

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

  }

  /**

   * Creates a file field and attaches it to the "Tags" taxonomy vocabulary.

   *

   * @param $name

   *   The field name of the file field to create.

   * @param $uri_scheme

   *   The URI scheme to use for the file field (for example, "private" to

   *   create a field that stores private files or "public" to create a field

   *   that stores public files).

   */

  protected function createAttachFileField($name, $uri_scheme) {

    $field = array(

      'field_name' => $name,

      'type' => 'file',

      'settings' => array(

        'uri_scheme' => $uri_scheme,

      ),

      'cardinality' => 1,

    );

    field_create_field($field);

    // Attach an instance of it.

    $instance = array(

      'field_name' => $name,

      'label' => 'File',

      'entity_type' => 'taxonomy_term',

      'bundle' => 'tags',

      'required' => FALSE,

      'settings' => array(),

      'widget' => array(

        'type' => 'file_generic',

        'settings' => array(),

      ),

    );

    field_create_instance($instance);

  }

  /**

   * Tests that a public file can be attached to a taxonomy term.

   *

   * This is a regression test for https://www.drupal.org/node/2305017.

   */

  public function testTermFilePublic() {

    $this->_testTermFile('public');

  }

  /**

   * Tests that a private file can be attached to a taxonomy term.

   *

   * This is a regression test for https://www.drupal.org/node/2305017.

   */

  public function testTermFilePrivate() {

    $this->_testTermFile('private');

  }

  /**

   * Runs tests for attaching a file field to a taxonomy term.

   *

   * @param $uri_scheme

   *   The URI scheme to use for the file field, either "public" or "private".

   */

  protected function _testTermFile($uri_scheme) {

    $field_name = strtolower($this->randomName());

    $this->createAttachFileField($field_name, $uri_scheme);

    // Get a file to upload.

    $file = current($this->drupalGetTestFiles('text'));

    // Add a filesize property to files as would be read by file_load().

    $file->filesize = filesize($file->uri);

    $langcode = LANGUAGE_NONE;

    $edit = array(

      "name" => $this->randomName(),

    );

    // Attach a file to the term.

    $edit['files[' . $field_name . '_' . $langcode . '_0]'] = drupal_realpath($file->uri);

    $this->drupalPost("admin/structure/taxonomy/tags/add", $edit, t('Save'));

    // Find the term ID we just created.

    $tid = db_query_range('SELECT tid FROM {taxonomy_term_data} ORDER BY tid DESC', 0, 1)->fetchField();

    $terms = entity_load('taxonomy_term', array($tid));

    $term = $terms[$tid];

    $fid = $term->{$field_name}[LANGUAGE_NONE][0]['fid'];

    // Check that the uploaded file is present on the edit form.

    $this->drupalGet("taxonomy/term/$tid/edit");

    $file_input_name = $field_name . '[' . LANGUAGE_NONE . '][0][fid]';

    $this->assertFieldByXpath('//input[@type="hidden" and @name="' . $file_input_name . '"]', $fid, 'File is attached on edit form.');

    // Edit the term and change name without changing the file.

    $edit = array(

      "name" => $this->randomName(),

    );

    $this->drupalPost("taxonomy/term/$tid/edit", $edit, t('Save'));

    // Check that the uploaded file is still present on the edit form.

    $this->drupalGet("taxonomy/term/$tid/edit");

    $file_input_name = $field_name . '[' . LANGUAGE_NONE . '][0][fid]';

    $this->assertFieldByXpath('//input[@type="hidden" and @name="' . $file_input_name . '"]', $fid, 'File is attached on edit form.');

    // Load term while resetting the cache.

    $terms = entity_load('taxonomy_term', array($tid), array(), TRUE);

    $term = $terms[$tid];

    $this->assertTrue(!empty($term->{$field_name}[LANGUAGE_NONE]), 'Term has attached files.');

    $this->assertEqual($term->{$field_name}[LANGUAGE_NONE][0]['fid'], $fid, 'Same File ID is attached to the term.');

  }

}

/**

 * Tests the 'managed_file' element type.

 *

 * @todo Create a FileTestCase base class and move FileFieldTestCase methods

 *   that aren't related to fields into it.

 */

class FileManagedFileElementTestCase extends FileFieldTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Managed file element test',

      'description' => 'Tests the managed_file element type.',

      'group' => 'File',

    );

  }

  /**

   * Tests the managed_file element type.

   */

  function testManagedFile() {

    // Check that $element['#size'] is passed to the child upload element.

    $this->drupalGet('file/test');

    $this->assertFieldByXpath('//input[@name="files[nested_file]" and @size="13"]', NULL, 'The custom #size attribute is passed to the child upload element.');

    // Perform the tests with all permutations of $form['#tree'] and

    // $element['#extended'].

    foreach (array(0, 1) as $tree) {

      foreach (array(0, 1) as $extended) {

        $test_file = $this->getTestFile('text');

        $path = 'file/test/' . $tree . '/' . $extended;

        $input_base_name = $tree ? 'nested_file' : 'file';

        // Submit without a file.

        $this->drupalPost($path, array(), t('Save'));

        $this->assertRaw(t('The file id is %fid.', array('%fid' => 0)), 'Submitted without a file.');

        // Submit with a file, but with an invalid form token. Ensure the file

        // was not saved.

        $last_fid_prior = $this->getLastFileId();

        $edit = array(

          'files[' . $input_base_name . ']' => drupal_realpath($test_file->uri),

          'form_token' => 'invalid token',

        );

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

        $this->assertText('The form has become outdated. Copy any unsaved work in the form below');

        $last_fid = $this->getLastFileId();

        $this->assertEqual($last_fid_prior, $last_fid, 'File was not saved when uploaded with an invalid form token.');

        // Submit a new file, without using the Upload button.

        $last_fid_prior = $this->getLastFileId();

        $edit = array('files[' . $input_base_name . ']' => drupal_realpath($test_file->uri));

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

        $last_fid = $this->getLastFileId();

        $this->assertTrue($last_fid > $last_fid_prior, 'New file got saved.');

        $this->assertRaw(t('The file id is %fid.', array('%fid' => $last_fid)), 'Submit handler has correct file info.');

        // Submit no new input, but with a default file.

        $this->drupalPost($path . '/' . $last_fid, array(), t('Save'));

        $this->assertRaw(t('The file id is %fid.', array('%fid' => $last_fid)), 'Empty submission did not change an existing file.');

        // Now, test the Upload and Remove buttons, with and without Ajax.

        foreach (array(FALSE, TRUE) as $ajax) {

          // Upload, then Submit.

          $last_fid_prior = $this->getLastFileId();

          $this->drupalGet($path);

          $edit = array('files[' . $input_base_name . ']' => drupal_realpath($test_file->uri));

          if ($ajax) {

            $this->drupalPostAJAX(NULL, $edit, $input_base_name . '_upload_button');

          }

          else {

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

          }

          $last_fid = $this->getLastFileId();

          $this->assertTrue($last_fid > $last_fid_prior, 'New file got uploaded.');

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

          $this->assertRaw(t('The file id is %fid.', array('%fid' => $last_fid)), 'Submit handler has correct file info.');

          // Remove, then Submit.

          $this->drupalGet($path . '/' . $last_fid);

          if ($ajax) {

            $this->drupalPostAJAX(NULL, array(), $input_base_name . '_remove_button');

          }

          else {

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

          }

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

          $this->assertRaw(t('The file id is %fid.', array('%fid' => 0)), 'Submission after file removal was successful.');

          // Upload, then Remove, then Submit.

          $this->drupalGet($path);

          $edit = array('files[' . $input_base_name . ']' => drupal_realpath($test_file->uri));

          if ($ajax) {

            $this->drupalPostAJAX(NULL, $edit, $input_base_name . '_upload_button');

            $this->drupalPostAJAX(NULL, array(), $input_base_name . '_remove_button');

          }

          else {

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

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

          }

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

          $this->assertRaw(t('The file id is %fid.', array('%fid' => 0)), 'Submission after file upload and removal was successful.');

        }

      }

    }

  }

}

/**

 * Tests file field widget.

 */

class FileFieldWidgetTestCase extends FileFieldTestCase {

  public static function getInfo() {

    return array(

      'name' => 'File field widget test',

      'description' => 'Tests the file field widget, single and multi-valued, with and without AJAX, with public and private files.',

      'group' => 'File',

    );

  }

  /**

   * Tests upload and remove buttons for a single-valued File field.

   */

  function testSingleValuedWidget() {

    // Use 'page' instead of 'article', so that the 'article' image field does

    // not conflict with this test. If in the future the 'page' type gets its

    // own default file or image field, this test can be made more robust by

    // using a custom node type.

    $type_name = 'page';

    $field_name = strtolower($this->randomName());

    $this->createFileField($field_name, $type_name);

    $field = field_info_field($field_name);

    $instance = field_info_instance('node', $field_name, $type_name);

    $test_file = $this->getTestFile('text');

    foreach (array('nojs', 'js') as $type) {

      // Create a new node with the uploaded file and ensure it got uploaded

      // successfully.

      // @todo This only tests a 'nojs' submission, because drupalPostAJAX()

      //   does not yet support file uploads.

      $nid = $this->uploadNodeFile($test_file, $field_name, $type_name);

      $node = node_load($nid, NULL, TRUE);

      $node_file = (object) $node->{$field_name}[LANGUAGE_NONE][0];

      $this->assertFileExists($node_file, 'New file saved to disk on node creation.');

      // Test that running field_attach_update() leaves the file intact.

      $field = new stdClass();

      $field->type = $type_name;

      $field->nid = $nid;

      field_attach_update('node', $field);

      $node = node_load($nid);

      $node_file = (object) $node->{$field_name}[LANGUAGE_NONE][0];

      $this->assertFileExists($node_file, 'New file still saved to disk on field update.');

      // Ensure the file can be downloaded.

      $this->drupalGet(file_create_url($node_file->uri));

      $this->assertResponse(200, 'Confirmed that the generated URL is correct by downloading the shipped file.');

      // Ensure the edit page has a remove button instead of an upload button.

      $this->drupalGet("node/$nid/edit");

      $this->assertNoFieldByXPath('//input[@type="submit"]', t('Upload'), 'Node with file does not display the "Upload" button.');

      $this->assertFieldByXpath('//input[@type="submit"]', t('Remove'), 'Node with file displays the "Remove" button.');