<?php

/**

 * @file

 * Tests for image.module.

 */

/**

 * TODO: Test the following functions.

 *

 * image.effects.inc:

 *   image_style_generate()

 *   image_style_create_derivative()

 *

 * image.module:

 *   image_style_load()

 *   image_style_save()

 *   image_style_delete()

 *   image_style_options()

 *   image_effect_definition_load()

 *   image_effect_load()

 *   image_effect_save()

 *   image_effect_delete()

 *   image_filter_keyword()

 */

/**

 * This class provides methods specifically for testing Image's field handling.

 */

class ImageFieldTestCase extends DrupalWebTestCase {

  protected $admin_user;

  function setUp() {

    parent::setUp('image');

    $this->admin_user = $this->drupalCreateUser(array('access content', 'access administration pages', 'administer site configuration', 'administer content types', 'administer nodes', 'create article content', 'edit any article content', 'delete any article content', 'administer image styles', 'administer fields'));

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

  }

  /**

   * Create a new image 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 createImageField($name, $type_name, $field_settings = array(), $instance_settings = array(), $widget_settings = array()) {

    $field = array(

      'field_name' => $name,

      'type' => 'image',

      'settings' => array(),

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

    );

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

    field_create_field($field);

    $instance = array(

      'field_name' => $field['field_name'],

      'entity_type' => 'node',

      'label' => $name,

      'bundle' => $type_name,

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

      'settings' => array(),

      'widget' => array(

        'type' => 'image_image',

        'settings' => array(),

      ),

    );

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

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

    return field_create_instance($instance);

  }

  /**

   * Create a random style.

   *

   * @return array

   *  A list containing the details of the generated image style.

   */

  function createRandomStyle() {

    $style_name = strtolower($this->randomName(10));

    $style_label = $this->randomString();

    image_style_save(array('name' => $style_name, 'label' => $style_label));

    $style_path = 'admin/config/media/image-styles/edit/' . $style_name;

    return array(

      'name' => $style_name,

      'label' => $style_label,

      'path' => $style_path,

    );

  }

  /**

   * Upload an image to a node.

   *

   * @param $image

   *   A file object representing the image to upload.

   * @param $field_name

   *   Name of the image field the image should be attached to.

   * @param $type

   *   The type of node to create.

   */

  function uploadNodeImage($image, $field_name, $type) {

    $edit = array(

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

    );

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

    $this->drupalPost('node/add/' . $type, $edit, t('Save'));

    // Retrieve ID of the newly created node from the current URL.

    $matches = array();

    preg_match('/node\/([0-9]+)/', $this->getUrl(), $matches);

    return isset($matches[1]) ? $matches[1] : FALSE;

  }

}

/**

 * Tests the functions for generating paths and URLs for image styles.

 */

class ImageStylesPathAndUrlTestCase extends DrupalWebTestCase {

  protected $style_name;

  protected $image_info;

  protected $image_filepath;

  public static function getInfo() {

    return array(

      'name' => 'Image styles path and URL functions',

      'description' => 'Tests functions for generating paths and URLs to image styles.',

      'group' => 'Image',

    );

  }

  function setUp() {

    parent::setUp('image_module_test');

    $this->style_name = 'style_foo';

    image_style_save(array('name' => $this->style_name, 'label' => $this->randomString()));

  }

  /**

   * Test image_style_path().

   */

  function testImageStylePath() {

    $scheme = 'public';

    $actual = image_style_path($this->style_name, "$scheme://foo/bar.gif");

    $expected = "$scheme://styles/" . $this->style_name . "/$scheme/foo/bar.gif";

    $this->assertEqual($actual, $expected, 'Got the path for a file URI.');

    $actual = image_style_path($this->style_name, 'foo/bar.gif');

    $expected = "$scheme://styles/" . $this->style_name . "/$scheme/foo/bar.gif";

    $this->assertEqual($actual, $expected, 'Got the path for a relative file path.');

  }

  /**

   * Test image_style_url() with a file using the "public://" scheme.

   */

  function testImageStyleUrlAndPathPublic() {

    $this->_testImageStyleUrlAndPath('public');

  }

  /**

   * Test image_style_url() with a file using the "private://" scheme.

   */

  function testImageStyleUrlAndPathPrivate() {

    $this->_testImageStyleUrlAndPath('private');

  }

  /**

   * Test image_style_url() with the "public://" scheme and unclean URLs.

   */

   function testImageStylUrlAndPathPublicUnclean() {

     $this->_testImageStyleUrlAndPath('public', FALSE);

   }

  /**

   * Test image_style_url() with the "private://" schema and unclean URLs.

   */

  function testImageStyleUrlAndPathPrivateUnclean() {

    $this->_testImageStyleUrlAndPath('private', FALSE);

  }

  /**

   * Test image_style_url() with a file URL that has an extra slash in it.

   */

  function testImageStyleUrlExtraSlash() {

    $this->_testImageStyleUrlAndPath('public', TRUE, TRUE);

  }

  /**

   * Test that an invalid source image returns a 404.

   */

  function testImageStyleUrlForMissingSourceImage() {

    $non_existent_uri = 'public://foo.png';

    $generated_url = image_style_url($this->style_name, $non_existent_uri);

    $this->drupalGet($generated_url);

    $this->assertResponse(404, 'Accessing an image style URL with a source image that does not exist provides a 404 error response.');

  }

  /**

   * Test that we do not pass an array to drupal_add_http_header.

   */

  function testImageContentTypeHeaders() {

    $files = $this->drupalGetTestFiles('image');

    $file = array_shift($files);

    // Copy the test file to private folder.

    $private_file = file_copy($file, 'private://', FILE_EXISTS_RENAME);

    // Tell image_module_test module to return the headers we want to test.

    variable_set('image_module_test_invalid_headers', $private_file->uri);

    // Invoke image_style_deliver so it will try to set headers.

    $generated_url = image_style_url($this->style_name, $private_file->uri);

    $this->drupalGet($generated_url);

    variable_del('image_module_test_invalid_headers');

  }

  /**

   * Test image_style_url().

   */

  function _testImageStyleUrlAndPath($scheme, $clean_url = TRUE, $extra_slash = FALSE) {

    // Make the default scheme neither "public" nor "private" to verify the

    // functions work for other than the default scheme.

    variable_set('file_default_scheme', 'temporary');

    variable_set('clean_url', $clean_url);

    // Create the directories for the styles.

    $directory = $scheme . '://styles/' . $this->style_name;

    $status = file_prepare_directory($directory, FILE_CREATE_DIRECTORY);

    $this->assertNotIdentical(FALSE, $status, 'Created the directory for the generated images for the test style.');

    // Create a working copy of the file.

    $files = $this->drupalGetTestFiles('image');

    $file = array_shift($files);

    $image_info = image_get_info($file->uri);

    $original_uri = file_unmanaged_copy($file->uri, $scheme . '://', FILE_EXISTS_RENAME);

    // Let the image_module_test module know about this file, so it can claim

    // ownership in hook_file_download().

    variable_set('image_module_test_file_download', $original_uri);

    $this->assertNotIdentical(FALSE, $original_uri, 'Created the generated image file.');

    // Get the URL of a file that has not been generated and try to create it.

    $generated_uri = image_style_path($this->style_name, $original_uri);

    $this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');

    $generate_url = image_style_url($this->style_name, $original_uri);

    // Ensure that the tests still pass when the file is generated by accessing

    // a poorly constructed (but still valid) file URL that has an extra slash

    // in it.

    if ($extra_slash) {

      $modified_uri = str_replace('://', ':///', $original_uri);

      $this->assertNotEqual($original_uri, $modified_uri, 'An extra slash was added to the generated file URI.');

      $generate_url = image_style_url($this->style_name, $modified_uri);

    }

    if (!$clean_url) {

      $this->assertTrue(strpos($generate_url, '?q=') !== FALSE, 'When using non-clean URLS, the system path contains the query string.');

    }

    // Add some extra chars to the token.

    $this->drupalGet(str_replace(IMAGE_DERIVATIVE_TOKEN . '=', IMAGE_DERIVATIVE_TOKEN . '=Zo', $generate_url));

    $this->assertResponse(403, 'Image was inaccessible at the URL with an invalid token.');

    // Change the parameter name so the token is missing.

    $this->drupalGet(str_replace(IMAGE_DERIVATIVE_TOKEN . '=', 'wrongparam=', $generate_url));

    $this->assertResponse(403, 'Image was inaccessible at the URL with a missing token.');

    // Check that the generated URL is the same when we pass in a relative path

    // rather than a URI. We need to temporarily switch the default scheme to

    // match the desired scheme before testing this, then switch it back to the

    // "temporary" scheme used throughout this test afterwards.

    variable_set('file_default_scheme', $scheme);

    $relative_path = file_uri_target($original_uri);

    $generate_url_from_relative_path = image_style_url($this->style_name, $relative_path);

    $this->assertEqual($generate_url, $generate_url_from_relative_path, 'Generated URL is the same regardless of whether it came from a relative path or a file URI.');

    variable_set('file_default_scheme', 'temporary');

    // Fetch the URL that generates the file.

    $this->drupalGet($generate_url);

    $this->assertResponse(200, 'Image was generated at the URL.');

    $this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');

    $this->assertRaw(file_get_contents($generated_uri), 'URL returns expected file.');

    $generated_image_info = image_get_info($generated_uri);

    $this->assertEqual($this->drupalGetHeader('Content-Type'), $generated_image_info['mime_type'], 'Expected Content-Type was reported.');

    $this->assertEqual($this->drupalGetHeader('Content-Length'), $generated_image_info['file_size'], 'Expected Content-Length was reported.');

    if ($scheme == 'private') {

      $this->assertEqual($this->drupalGetHeader('Expires'), 'Sun, 19 Nov 1978 05:00:00 GMT', 'Expires header was sent.');

      $this->assertEqual($this->drupalGetHeader('Cache-Control'), 'no-cache, must-revalidate', 'Cache-Control header was set to prevent caching.');

      $this->assertEqual($this->drupalGetHeader('X-Image-Owned-By'), 'image_module_test', 'Expected custom header has been added.');

      // Make sure that a second request to the already existing derivate works

      // too.

      $this->drupalGet($generate_url);

      $this->assertResponse(200, 'Image was generated at the URL.');

      // Make sure that access is denied for existing style files if we do not

      // have access.

      variable_del('image_module_test_file_download');

      $this->drupalGet($generate_url);

      $this->assertResponse(403, 'Confirmed that access is denied for the private image style.');

      // Repeat this with a different file that we do not have access to and

      // make sure that access is denied.

      $file_noaccess = array_shift($files);

      $original_uri_noaccess = file_unmanaged_copy($file_noaccess->uri, $scheme . '://', FILE_EXISTS_RENAME);

      $generated_uri_noaccess = $scheme . '://styles/' . $this->style_name . '/' . $scheme . '/'. drupal_basename($original_uri_noaccess);

      $this->assertFalse(file_exists($generated_uri_noaccess), 'Generated file does not exist.');

      $generate_url_noaccess = image_style_url($this->style_name, $original_uri_noaccess);

      $this->drupalGet($generate_url_noaccess);

      $this->assertResponse(403, 'Confirmed that access is denied for the private image style.');

      // Verify that images are not appended to the response. Currently this test only uses PNG images.

      if (strpos($generate_url, '.png') === FALSE ) {

        $this->fail('Confirming that private image styles are not appended require PNG file.');

      }

      else {

        // Check for PNG-Signature (cf. http://www.libpng.org/pub/png/book/chapter08.html#png.ch08.div.2) in the

        // response body.

        $this->assertNoRaw( chr(137) . chr(80) . chr(78) . chr(71) . chr(13) . chr(10) . chr(26) . chr(10), 'No PNG signature found in the response body.');

      }

    }

    elseif ($clean_url) {

      // Add some extra chars to the token.

      $this->drupalGet(str_replace(IMAGE_DERIVATIVE_TOKEN . '=', IMAGE_DERIVATIVE_TOKEN . '=Zo', $generate_url));

      $this->assertResponse(200, 'Existing image was accessible at the URL with an invalid token.');

    }

    // Allow insecure image derivatives to be created for the remainder of this

    // test.

    variable_set('image_allow_insecure_derivatives', TRUE);

    // Create another working copy of the file.

    $files = $this->drupalGetTestFiles('image');

    $file = array_shift($files);

    $image_info = image_get_info($file->uri);

    $original_uri = file_unmanaged_copy($file->uri, $scheme . '://', FILE_EXISTS_RENAME);

    // Let the image_module_test module know about this file, so it can claim

    // ownership in hook_file_download().

    variable_set('image_module_test_file_download', $original_uri);

    // Get the URL of a file that has not been generated and try to create it.

    $generated_uri = image_style_path($this->style_name, $original_uri);

    $this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');

    $generate_url = image_style_url($this->style_name, $original_uri);

    // Check that the image is accessible even without the security token.

    $this->drupalGet(str_replace(IMAGE_DERIVATIVE_TOKEN . '=', 'wrongparam=', $generate_url));

    $this->assertResponse(200, 'Image was accessible at the URL with a missing token.');

    // Check that a security token is still required when generating a second

    // image derivative using the first one as a source.

    $nested_uri = image_style_path($this->style_name, $generated_uri);

    $nested_url = image_style_url($this->style_name, $generated_uri);

    $nested_url_with_wrong_token = str_replace(IMAGE_DERIVATIVE_TOKEN . '=', 'wrongparam=', $nested_url);

    $this->drupalGet($nested_url_with_wrong_token);

    $this->assertResponse(403, 'Image generated from an earlier derivative was inaccessible at the URL with a missing token.');

    // Check that this restriction cannot be bypassed by adding extra slashes

    // to the URL.

    $this->drupalGet(substr_replace($nested_url_with_wrong_token, '//styles/', strrpos($nested_url_with_wrong_token, '/styles/'), strlen('/styles/')));

    $this->assertResponse(403, 'Image generated from an earlier derivative was inaccessible at the URL with a missing token, even with an extra forward slash in the URL.');

    $this->drupalGet(substr_replace($nested_url_with_wrong_token, '/\styles/', strrpos($nested_url_with_wrong_token, '/styles/'), strlen('/styles/')));

    $this->assertResponse(403, 'Image generated from an earlier derivative was inaccessible at the URL with a missing token, even with an extra backslash in the URL.');

    // Make sure the image can still be generated if a correct token is used.

    $this->drupalGet($nested_url);

    $this->assertResponse(200, 'Image was accessible when a correct token was provided in the URL.');

    // Suppress the security token in the URL, then get the URL of a file. Check

    // that the security token is not present in the URL but that the image is

    // still accessible.

    variable_set('image_suppress_itok_output', TRUE);

    $generate_url = image_style_url($this->style_name, $original_uri);

    $this->assertIdentical(strpos($generate_url, IMAGE_DERIVATIVE_TOKEN . '='), FALSE, 'The security token does not appear in the image style URL.');

    $this->drupalGet($generate_url);

    $this->assertResponse(200, 'Image was accessible at the URL with a missing token.');

    // Check that requesting a nonexistent image does not create any new

    // directories in the file system.

    $directory = $scheme . '://styles/' . $this->style_name . '/' . $scheme . '/' . $this->randomName();

    $this->drupalGet(file_create_url($directory . '/' . $this->randomName()));

    $this->assertFalse(file_exists($directory), 'New directory was not created in the filesystem when requesting an unauthorized image.');

  }

}

/**

 * Use the image_test.module's mock toolkit to ensure that the effects are

 * properly passing parameters to the image toolkit.

 */

class ImageEffectsUnitTest extends ImageToolkitTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Image effects',

      'description' => 'Test that the image effects pass parameters to the toolkit correctly.',

      'group' => 'Image',

    );

  }

  function setUp() {

    parent::setUp('image_module_test');

    module_load_include('inc', 'image', 'image.effects');

  }

  /**

   * Test the image_resize_effect() function.

   */

  function testResizeEffect() {

    $this->assertTrue(image_resize_effect($this->image, array('width' => 1, 'height' => 2)), 'Function returned the expected value.');

    $this->assertToolkitOperationsCalled(array('resize'));

    // Check the parameters.

    $calls = image_test_get_all_calls();

    $this->assertEqual($calls['resize'][0][1], 1, 'Width was passed correctly');

    $this->assertEqual($calls['resize'][0][2], 2, 'Height was passed correctly');

  }

  /**

   * Test the image_scale_effect() function.

   */

  function testScaleEffect() {

    // @todo: need to test upscaling.

    $this->assertTrue(image_scale_effect($this->image, array('width' => 10, 'height' => 10)), 'Function returned the expected value.');

    $this->assertToolkitOperationsCalled(array('resize'));

    // Check the parameters.

    $calls = image_test_get_all_calls();

    $this->assertEqual($calls['resize'][0][1], 10, 'Width was passed correctly');

    $this->assertEqual($calls['resize'][0][2], 5, 'Height was based off aspect ratio and passed correctly');

  }

  /**

   * Test the image_crop_effect() function.

   */

  function testCropEffect() {

    // @todo should test the keyword offsets.

    $this->assertTrue(image_crop_effect($this->image, array('anchor' => 'top-1', 'width' => 3, 'height' => 4)), 'Function returned the expected value.');

    $this->assertToolkitOperationsCalled(array('crop'));

    // Check the parameters.

    $calls = image_test_get_all_calls();

    $this->assertEqual($calls['crop'][0][1], 0, 'X was passed correctly');

    $this->assertEqual($calls['crop'][0][2], 1, 'Y was passed correctly');

    $this->assertEqual($calls['crop'][0][3], 3, 'Width was passed correctly');

    $this->assertEqual($calls['crop'][0][4], 4, 'Height was passed correctly');

  }

  /**

   * Test the image_scale_and_crop_effect() function.

   */

  function testScaleAndCropEffect() {

    $this->assertTrue(image_scale_and_crop_effect($this->image, array('width' => 5, 'height' => 10)), 'Function returned the expected value.');

    $this->assertToolkitOperationsCalled(array('resize', 'crop'));

    // Check the parameters.

    $calls = image_test_get_all_calls();

    $this->assertEqual($calls['crop'][0][1], 7.5, 'X was computed and passed correctly');

    $this->assertEqual($calls['crop'][0][2], 0, 'Y was computed and passed correctly');

    $this->assertEqual($calls['crop'][0][3], 5, 'Width was computed and passed correctly');

    $this->assertEqual($calls['crop'][0][4], 10, 'Height was computed and passed correctly');

  }

  /**

   * Test the image_desaturate_effect() function.

   */

  function testDesaturateEffect() {

    $this->assertTrue(image_desaturate_effect($this->image, array()), 'Function returned the expected value.');

    $this->assertToolkitOperationsCalled(array('desaturate'));

    // Check the parameters.

    $calls = image_test_get_all_calls();

    $this->assertEqual(count($calls['desaturate'][0]), 1, 'Only the image was passed.');

  }

  /**

   * Test the image_rotate_effect() function.

   */

  function testRotateEffect() {

    // @todo: need to test with 'random' => TRUE

    $this->assertTrue(image_rotate_effect($this->image, array('degrees' => 90, 'bgcolor' => '#fff')), 'Function returned the expected value.');

    $this->assertToolkitOperationsCalled(array('rotate'));

    // Check the parameters.

    $calls = image_test_get_all_calls();

    $this->assertEqual($calls['rotate'][0][1], 90, 'Degrees were passed correctly');

    $this->assertEqual($calls['rotate'][0][2], 0xffffff, 'Background color was passed correctly');

  }

  /**

   * Test image effect caching.

   */

  function testImageEffectsCaching() {

    $image_effect_definitions_called = &drupal_static('image_module_test_image_effect_info_alter');

    // First call should grab a fresh copy of the data.

    $effects = image_effect_definitions();

    $this->assertTrue($image_effect_definitions_called === 1, 'image_effect_definitions() generated data.');

    // Second call should come from cache.

    drupal_static_reset('image_effect_definitions');

    drupal_static_reset('image_module_test_image_effect_info_alter');

    $cached_effects = image_effect_definitions();

    $this->assertTrue(is_null($image_effect_definitions_called), 'image_effect_definitions() returned data from cache.');

    $this->assertTrue($effects == $cached_effects, 'Cached effects are the same as generated effects.');

  }

}

/**

 * Tests the administrative user interface.

 */

class ImageAdminUiTestCase extends ImageFieldTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Administrative user interface',

      'description' => 'Tests the forms used in the administrative user interface.',

      'group' => 'Image',

    );

  }

  function setUp() {

    parent::setUp(array('image'));

  }

  /**

   * Test if the help text is available on the add effect form.

   */

  function testAddEffectHelpText() {

    // Create a random image style.

    $style = $this->createRandomStyle();

    // Open the add effect form and check for the help text.