class LocaleTranslationFunctionalTest

class LocaleTranslationFunctionalTest extends DrupalWebTestCase {
  public static function getInfo() {
    return array(
      'name' => 'String translate, search and validate',
      'description' => 'Adds a new locale and translates its name. Checks the validation of translation strings and search results.',
      'group' => 'Locale',
    );
  }
  function setUp() {
    parent::setUp('locale');
  }

  /**
   * Adds a language and tests string translation by users with the appropriate permissions.
   */
  function testStringTranslation() {
    global $base_url;

    // User to add and remove language.
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer languages',
      'access administration pages',
    ));

    // User to translate and delete string.
    $translate_user = $this
      ->drupalCreateUser(array(
      'translate interface',
      'access administration pages',
    ));

    // Code for the language.
    $langcode = 'xx';

    // The English name for the language. This will be translated.
    $name = $this
      ->randomName(16);

    // The native name for the language.
    $native = $this
      ->randomName(16);

    // The domain prefix.
    $prefix = $langcode;

    // This is the language indicator on the translation search screen for
    // untranslated strings. Copied straight from locale.inc.
    $language_indicator = "<em class=\"locale-untranslated\">{$langcode}</em> ";

    // This will be the translation of $name.
    $translation = $this
      ->randomName(16);

    // Add custom language.
    $this
      ->drupalLogin($admin_user);
    $edit = array(
      'langcode' => $langcode,
      'name' => $name,
      'native' => $native,
      'prefix' => $prefix,
      'direction' => '0',
    );
    $this
      ->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));

    // Add string.
    t($name, array(), array(
      'langcode' => $langcode,
    ));

    // Reset locale cache.
    locale_reset();
    $this
      ->assertText($langcode, 'Language code found.');
    $this
      ->assertText($name, 'Name found.');
    $this
      ->assertText($native, 'Native found.');

    // No t() here, we do not want to add this string to the database and it's
    // surely not translated yet.
    $this
      ->assertText($native, 'Test language added.');
    $this
      ->drupalLogout();

    // Search for the name and translate it.
    $this
      ->drupalLogin($translate_user);
    $search = array(
      'string' => $name,
      'language' => 'all',
      'translation' => 'all',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));

    // assertText() seems to remove the input field where $name always could be
    // found, so this is not a false assert. See how assertNoText succeeds
    // later.
    $this
      ->assertText($name, 'Search found the name.');
    $this
      ->assertRaw($language_indicator, 'Name is untranslated.');

    // Assume this is the only result, given the random name.
    $this
      ->clickLink(t('edit'));

    // We save the lid from the path.
    $matches = array();
    preg_match('!admin/config/regional/translate/edit/(\\d+)!', $this
      ->getUrl(), $matches);
    $lid = $matches[1];

    // No t() here, it's surely not translated yet.
    $this
      ->assertText($name, 'name found on edit screen.');
    $edit = array(
      "translations[{$langcode}]" => $translation,
    );
    $this
      ->drupalPost(NULL, $edit, t('Save translations'));
    $this
      ->assertText(t('The string has been saved.'), 'The string has been saved.');
    $this
      ->assertEqual($this
      ->getUrl(), url('admin/config/regional/translate/translate', array(
      'absolute' => TRUE,
    )), 'Correct page redirection.');
    $this
      ->assertTrue($name != $translation && t($name, array(), array(
      'langcode' => $langcode,
    )) == $translation, 't() works.');
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));

    // The indicator should not be here.
    $this
      ->assertNoRaw($language_indicator, 'String is translated.');

    // Verify that a translation set which has an empty target string can be
    // updated without any database error.
    db_update('locales_target')
      ->fields(array(
      'translation' => '',
    ))
      ->condition('language', $langcode, '=')
      ->condition('lid', $lid, '=')
      ->execute();
    $this
      ->drupalPost('admin/config/regional/translate/edit/' . $lid, $edit, t('Save translations'));
    $this
      ->assertText(t('The string has been saved.'), 'The string has been saved.');

    // Try to edit a non-existent string and ensure we're redirected correctly.
    // Assuming we don't have 999,999 strings already.
    $random_lid = 999999;
    $this
      ->drupalGet('admin/config/regional/translate/edit/' . $random_lid);
    $this
      ->assertText(t('String not found'), 'String not found.');
    $this
      ->assertEqual($this
      ->getUrl(), url('admin/config/regional/translate/translate', array(
      'absolute' => TRUE,
    )), 'Correct page redirection.');
    $this
      ->drupalLogout();

    // Delete the language.
    $this
      ->drupalLogin($admin_user);
    $path = 'admin/config/regional/language/delete/' . $langcode;

    // This a confirm form, we do not need any fields changed.
    $this
      ->drupalPost($path, array(), t('Delete'));

    // We need raw here because %locale will add HTML.
    $this
      ->assertRaw(t('The language %locale has been removed.', array(
      '%locale' => $name,
    )), 'The test language has been removed.');

    // Reload to remove $name.
    $this
      ->drupalGet($path);

    // Verify that language is no longer found.
    $this
      ->assertResponse(404, 'Language no longer found.');
    $this
      ->drupalLogout();

    // Delete the string.
    $this
      ->drupalLogin($translate_user);
    $search = array(
      'string' => $name,
      'language' => 'all',
      'translation' => 'all',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));

    // Assume this is the only result, given the random name.
    $this
      ->clickLink(t('delete'));
    $this
      ->assertText(t('Are you sure you want to delete the string'), '"delete" link is correct.');

    // Delete the string.
    $path = 'admin/config/regional/translate/delete/' . $lid;
    $this
      ->drupalGet($path);

    // First test the 'cancel' link.
    $this
      ->clickLink(t('Cancel'));
    $this
      ->assertEqual($this
      ->getUrl(), url('admin/config/regional/translate/translate', array(
      'absolute' => TRUE,
    )), 'Correct page redirection.');
    $this
      ->assertRaw($name, 'The string was not deleted.');

    // Delete the name string.
    $this
      ->drupalPost('admin/config/regional/translate/delete/' . $lid, array(), t('Delete'));
    $this
      ->assertText(t('The string has been removed.'), 'The string has been removed message.');
    $this
      ->assertEqual($this
      ->getUrl(), url('admin/config/regional/translate/translate', array(
      'absolute' => TRUE,
    )), 'Correct page redirection.');
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertNoText($name, 'Search now can not find the name.');
  }

  /*
   * Adds a language and checks that the JavaScript translation files are
   * properly created and rebuilt on deletion.
   */
  function testJavaScriptTranslation() {
    $user = $this
      ->drupalCreateUser(array(
      'translate interface',
      'administer languages',
      'access administration pages',
    ));
    $this
      ->drupalLogin($user);
    $langcode = 'xx';

    // The English name for the language. This will be translated.
    $name = $this
      ->randomName(16);

    // The native name for the language.
    $native = $this
      ->randomName(16);

    // The domain prefix.
    $prefix = $langcode;

    // Add custom language.
    $edit = array(
      'langcode' => $langcode,
      'name' => $name,
      'native' => $native,
      'prefix' => $prefix,
      'direction' => '0',
    );
    $this
      ->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));
    drupal_static_reset('language_list');

    // Build the JavaScript translation file.
    $this
      ->drupalGet('admin/config/regional/translate/translate');

    // Retrieve the id of the first string available in the {locales_source}
    // table and translate it.
    $query = db_select('locales_source', 'l');
    $query
      ->addExpression('min(l.lid)', 'lid');
    $result = $query
      ->condition('l.location', '%.js%', 'LIKE')
      ->condition('l.textgroup', 'default')
      ->execute();
    $url = 'admin/config/regional/translate/edit/' . $result
      ->fetchObject()->lid;
    $edit = array(
      'translations[' . $langcode . ']' => $this
        ->randomName(),
    );
    $this
      ->drupalPost($url, $edit, t('Save translations'));

    // Trigger JavaScript translation parsing and building.
    require_once DRUPAL_ROOT . '/includes/locale.inc';
    _locale_rebuild_js($langcode);

    // Retrieve the JavaScript translation hash code for the custom language to
    // check that the translation file has been properly built.
    $file = db_select('languages', 'l')
      ->fields('l', array(
      'javascript',
    ))
      ->condition('language', $langcode)
      ->execute()
      ->fetchObject();
    $js_file = 'public://' . variable_get('locale_js_directory', 'languages') . '/' . $langcode . '_' . $file->javascript . '.js';
    $this
      ->assertTrue($result = file_exists($js_file), format_string('JavaScript file created: %file', array(
      '%file' => $result ? $js_file : 'not found',
    )));

    // Test JavaScript translation rebuilding.
    file_unmanaged_delete($js_file);
    $this
      ->assertTrue($result = !file_exists($js_file), format_string('JavaScript file deleted: %file', array(
      '%file' => $result ? $js_file : 'found',
    )));
    cache_clear_all();
    _locale_rebuild_js($langcode);
    $this
      ->assertTrue($result = file_exists($js_file), format_string('JavaScript file rebuilt: %file', array(
      '%file' => $result ? $js_file : 'not found',
    )));
  }

  /**
   * Tests the validation of the translation input.
   */
  function testStringValidation() {
    global $base_url;

    // User to add language and strings.
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer languages',
      'access administration pages',
      'translate interface',
    ));
    $this
      ->drupalLogin($admin_user);
    $langcode = 'xx';

    // The English name for the language. This will be translated.
    $name = $this
      ->randomName(16);

    // The native name for the language.
    $native = $this
      ->randomName(16);

    // The domain prefix.
    $prefix = $langcode;

    // This is the language indicator on the translation search screen for
    // untranslated strings. Copied straight from locale.inc.
    $language_indicator = "<em class=\"locale-untranslated\">{$langcode}</em> ";

    // These will be the invalid translations of $name.
    $key = $this
      ->randomName(16);
    $bad_translations[$key] = "<script>alert('xss');</script>" . $key;
    $key = $this
      ->randomName(16);
    $bad_translations[$key] = '<img SRC="javascript:alert(\'xss\');">' . $key;
    $key = $this
      ->randomName(16);
    $bad_translations[$key] = '<<SCRIPT>alert("xss");//<</SCRIPT>' . $key;
    $key = $this
      ->randomName(16);
    $bad_translations[$key] = "<BODY ONLOAD=alert('xss')>" . $key;

    // Add custom language.
    $edit = array(
      'langcode' => $langcode,
      'name' => $name,
      'native' => $native,
      'prefix' => $prefix,
      'direction' => '0',
    );
    $this
      ->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));

    // Add string.
    t($name, array(), array(
      'langcode' => $langcode,
    ));

    // Reset locale cache.
    $search = array(
      'string' => $name,
      'language' => 'all',
      'translation' => 'all',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));

    // Find the edit path.
    $content = $this
      ->drupalGetContent();
    $this
      ->assertTrue(preg_match('@(admin/config/regional/translate/edit/[0-9]+)@', $content, $matches), 'Found the edit path.');
    $path = $matches[0];
    foreach ($bad_translations as $key => $translation) {
      $edit = array(
        "translations[{$langcode}]" => $translation,
      );
      $this
        ->drupalPost($path, $edit, t('Save translations'));

      // Check for a form error on the textarea.
      $form_class = $this
        ->xpath('//form[@id="locale-translate-edit-form"]//textarea/@class');
      $this
        ->assertNotIdentical(FALSE, strpos($form_class[0], 'error'), 'The string was rejected as unsafe.');
      $this
        ->assertNoText(t('The string has been saved.'), 'The string was not saved.');
    }
  }

  /**
   * Tests translation search form.
   */
  function testStringSearch() {
    global $base_url;

    // User to add and remove language.
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer languages',
      'access administration pages',
    ));

    // User to translate and delete string.
    $translate_user = $this
      ->drupalCreateUser(array(
      'translate interface',
      'access administration pages',
    ));

    // Code for the language.
    $langcode = 'xx';

    // The English name for the language. This will be translated.
    $name = $this
      ->randomName(16);

    // The native name for the language.
    $native = $this
      ->randomName(16);

    // The domain prefix.
    $prefix = $langcode;

    // This is the language indicator on the translation search screen for
    // untranslated strings. Copied straight from locale.inc.
    $language_indicator = "<em class=\"locale-untranslated\">{$langcode}</em> ";

    // This will be the translation of $name.
    $translation = $this
      ->randomName(16);

    // Add custom language.
    $this
      ->drupalLogin($admin_user);
    $edit = array(
      'langcode' => $langcode,
      'name' => $name,
      'native' => $native,
      'prefix' => $prefix,
      'direction' => '0',
    );
    $this
      ->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));

    // Add string.
    t($name, array(), array(
      'langcode' => $langcode,
    ));

    // Reset locale cache.
    locale_reset();
    $this
      ->drupalLogout();

    // Search for the name.
    $this
      ->drupalLogin($translate_user);
    $search = array(
      'string' => $name,
      'language' => 'all',
      'translation' => 'all',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));

    // assertText() seems to remove the input field where $name always could be
    // found, so this is not a false assert. See how assertNoText succeeds
    // later.
    $this
      ->assertText($name, 'Search found the string.');

    // Ensure untranslated string doesn't appear if searching on 'only
    // translated strings'.
    $search = array(
      'string' => $name,
      'language' => 'all',
      'translation' => 'translated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertText(t('No strings available.'), "Search didn't find the string.");

    // Ensure untranslated string appears if searching on 'only untranslated
    // strings' in "all" (hasn't been translated to any language).
    $search = array(
      'string' => $name,
      'language' => 'all',
      'translation' => 'untranslated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertNoText(t('No strings available.'), 'Search found the string.');

    // Ensure untranslated string appears if searching on 'only untranslated
    // strings' in the custom language (hasn't been translated to that specific language).
    $search = array(
      'string' => $name,
      'language' => $langcode,
      'translation' => 'untranslated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertNoText(t('No strings available.'), 'Search found the string.');

    // Add translation.
    // Assume this is the only result, given the random name.
    $this
      ->clickLink(t('edit'));

    // We save the lid from the path.
    $matches = array();
    preg_match('!admin/config/regional/translate/edit/(\\d)+!', $this
      ->getUrl(), $matches);
    $lid = $matches[1];
    $edit = array(
      "translations[{$langcode}]" => $translation,
    );
    $this
      ->drupalPost(NULL, $edit, t('Save translations'));

    // Ensure translated string does appear if searching on 'only
    // translated strings'.
    $search = array(
      'string' => $translation,
      'language' => 'all',
      'translation' => 'translated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertNoText(t('No strings available.'), 'Search found the translation.');

    // Ensure translated source string doesn't appear if searching on 'only
    // untranslated strings'.
    $search = array(
      'string' => $name,
      'language' => 'all',
      'translation' => 'untranslated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertText(t('No strings available.'), "Search didn't find the source string.");

    // Ensure translated string doesn't appear if searching on 'only
    // untranslated strings'.
    $search = array(
      'string' => $translation,
      'language' => 'all',
      'translation' => 'untranslated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertText(t('No strings available.'), "Search didn't find the translation.");

    // Ensure translated string does appear if searching on the custom language.
    $search = array(
      'string' => $translation,
      'language' => $langcode,
      'translation' => 'all',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertNoText(t('No strings available.'), 'Search found the translation.');

    // Ensure translated string doesn't appear if searching on English.
    $search = array(
      'string' => $translation,
      'language' => 'en',
      'translation' => 'all',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertText(t('No strings available.'), "Search didn't find the translation.");

    // Search for a string that isn't in the system.
    $unavailable_string = $this
      ->randomName(16);
    $search = array(
      'string' => $unavailable_string,
      'language' => 'all',
      'translation' => 'all',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertText(t('No strings available.'), "Search didn't find the invalid string.");
  }

}