class LocaleImportFunctionalTest

class LocaleImportFunctionalTest extends DrupalWebTestCase {
  public static function getInfo() {
    return array(
      'name' => 'Translation import',
      'description' => 'Tests the import of locale files.',
      'group' => 'Locale',
    );
  }

  /**
   * A user able to create languages and import translations.
   */
  protected $admin_user = NULL;
  function setUp() {
    parent::setUp('locale', 'locale_test');
    $this->admin_user = $this
      ->drupalCreateUser(array(
      'administer languages',
      'translate interface',
      'access administration pages',
    ));
    $this
      ->drupalLogin($this->admin_user);
  }

  /**
   * Test import of standalone .po files.
   */
  function testStandalonePoFile() {

    // Try importing a .po file.
    $this
      ->importPoFile($this
      ->getPoFile(), array(
      'langcode' => 'fr',
    ));

    // The import should automatically create the corresponding language.
    $this
      ->assertRaw(t('The language %language has been created.', array(
      '%language' => 'French',
    )), 'The language has been automatically created.');

    // The import should have created 7 strings.
    $this
      ->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array(
      '%number' => 9,
      '%update' => 0,
      '%delete' => 0,
    )), 'The translation file was successfully imported.');

    // This import should have saved plural forms to have 2 variants.
    $this
      ->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")
      ->fetchField() == 2, 'Plural number initialized.');

    // Ensure we were redirected correctly.
    $this
      ->assertEqual($this
      ->getUrl(), url('admin/config/regional/translate', array(
      'absolute' => TRUE,
    )), 'Correct page redirection.');

    // Try importing a .po file with invalid tags in the default text group.
    $this
      ->importPoFile($this
      ->getBadPoFile(), array(
      'langcode' => 'fr',
    ));

    // The import should have created 1 string and rejected 2.
    $this
      ->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array(
      '%number' => 1,
      '%update' => 0,
      '%delete' => 0,
    )), 'The translation file was successfully imported.');
    $skip_message = format_plural(2, 'One translation string was skipped because it contains disallowed HTML.', '@count translation strings were skipped because they contain disallowed HTML.');
    $this
      ->assertRaw($skip_message, 'Unsafe strings were skipped.');

    // Try importing a .po file with invalid tags in a non default text group.
    $this
      ->importPoFile($this
      ->getBadPoFile(), array(
      'langcode' => 'fr',
      'group' => 'custom',
    ));

    // The import should have created 3 strings.
    $this
      ->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array(
      '%number' => 3,
      '%update' => 0,
      '%delete' => 0,
    )), 'The translation file was successfully imported.');

    // Try importing a .po file which doesn't exist.
    $name = $this
      ->randomName(16);
    $this
      ->drupalPost('admin/config/regional/translate/import', array(
      'langcode' => 'fr',
      'files[file]' => $name,
      'group' => 'custom',
    ), t('Import'));
    $this
      ->assertEqual($this
      ->getUrl(), url('admin/config/regional/translate/import', array(
      'absolute' => TRUE,
    )), 'Correct page redirection.');
    $this
      ->assertText(t('File to import not found.'), 'File to import not found message.');

    // Try importing a .po file with overriding strings, and ensure existing
    // strings are kept.
    $this
      ->importPoFile($this
      ->getOverwritePoFile(), array(
      'langcode' => 'fr',
      'mode' => 1,
    ));

    // The import should have created 1 string.
    $this
      ->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array(
      '%number' => 1,
      '%update' => 0,
      '%delete' => 0,
    )), 'The translation file was successfully imported.');

    // Ensure string wasn't overwritten.
    $search = array(
      'string' => 'Montag',
      'language' => 'fr',
      'translation' => 'translated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertText(t('No strings available.'), 'String not overwritten by imported string.');

    // This import should not have changed number of plural forms.
    $this
      ->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")
      ->fetchField() == 2, 'Plural numbers untouched.');
    $this
      ->importPoFile($this
      ->getPoFileWithBrokenPlural(), array(
      'langcode' => 'fr',
      'mode' => 1,
    ));

    // Attempt to import broken .po file as well to prove that this
    // will not overwrite the proper plural formula imported above.
    $this
      ->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")
      ->fetchField() == 2, 'Broken plurals: plural numbers untouched.');
    $this
      ->importPoFile($this
      ->getPoFileWithMissingPlural(), array(
      'langcode' => 'fr',
      'mode' => 1,
    ));

    // Attempt to import .po file which has no plurals and prove that this
    // will not overwrite the proper plural formula imported above.
    $this
      ->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")
      ->fetchField() == 2, 'No plurals: plural numbers untouched.');

    // Try importing a .po file with overriding strings, and ensure existing
    // strings are overwritten.
    $this
      ->importPoFile($this
      ->getOverwritePoFile(), array(
      'langcode' => 'fr',
      'mode' => 0,
    ));

    // The import should have updated 2 strings.
    $this
      ->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array(
      '%number' => 0,
      '%update' => 2,
      '%delete' => 0,
    )), 'The translation file was successfully imported.');

    // Ensure string was overwritten.
    $search = array(
      'string' => 'Montag',
      'language' => 'fr',
      'translation' => 'translated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertNoText(t('No strings available.'), 'String overwritten by imported string.');

    // This import should have changed number of plural forms.
    $this
      ->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")
      ->fetchField() == 3, 'Plural numbers changed.');
  }

  /**
   * Test automatic import of a module's translation files when a language is
   * enabled.
   */
  function testAutomaticModuleTranslationImportLanguageEnable() {

    // Code for the language - manually set to match the test translation file.
    $langcode = 'xx';

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

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

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

    // Create a 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'));

    // Ensure the translation file was automatically imported when language was
    // added.
    $this
      ->assertText(t('One translation file imported for the enabled modules.'), 'Language file automatically imported.');

    // Ensure strings were successfully imported.
    $search = array(
      'string' => 'lundi',
      'language' => $langcode,
      'translation' => 'translated',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
    $this
      ->assertNoText(t('No strings available.'), 'String successfully imported.');
  }

  /**
   * Test msgctxt context support.
   */
  function testLanguageContext() {

    // Try importing a .po file.
    $this
      ->importPoFile($this
      ->getPoFileWithContext(), array(
      'langcode' => 'hr',
    ));
    $this
      ->assertIdentical(t('May', array(), array(
      'langcode' => 'hr',
      'context' => 'Long month name',
    )), 'Svibanj', 'Long month name context is working.');
    $this
      ->assertIdentical(t('May', array(), array(
      'langcode' => 'hr',
    )), 'Svi.', 'Default context is working.');
  }

  /**
   * Test empty msgstr at end of .po file see #611786.
   */
  function testEmptyMsgstr() {
    $langcode = 'hu';

    // Try importing a .po file.
    $this
      ->importPoFile($this
      ->getPoFileWithMsgstr(), array(
      'langcode' => $langcode,
    ));
    $this
      ->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array(
      '%number' => 1,
      '%update' => 0,
      '%delete' => 0,
    )), 'The translation file was successfully imported.');
    $this
      ->assertIdentical(t('Operations', array(), array(
      'langcode' => $langcode,
    )), 'Műveletek', 'String imported and translated.');

    // Try importing a .po file.
    $this
      ->importPoFile($this
      ->getPoFileWithEmptyMsgstr(), array(
      'langcode' => $langcode,
      'mode' => 0,
    ));
    $this
      ->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array(
      '%number' => 0,
      '%update' => 0,
      '%delete' => 1,
    )), 'The translation file was successfully imported.');

    // 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> ";
    $str = "Operations";
    $search = array(
      'string' => $str,
      'language' => 'all',
      'translation' => 'all',
      'group' => 'all',
    );
    $this
      ->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));

    // assertText() seems to remove the input field where $str always could be
    // found, so this is not a false assert.
    $this
      ->assertText($str, 'Search found the string.');
    $this
      ->assertRaw($language_indicator, 'String is untranslated again.');
  }

  /**
   * Helper function: import a standalone .po file in a given language.
   *
   * @param $contents
   *   Contents of the .po file to import.
   * @param $options
   *   Additional options to pass to the translation import form.
   */
  function importPoFile($contents, array $options = array()) {
    $name = drupal_tempnam('temporary://', "po_") . '.po';
    file_put_contents($name, $contents);
    $options['files[file]'] = $name;
    $this
      ->drupalPost('admin/config/regional/translate/import', $options, t('Import'));
    drupal_unlink($name);
  }

  /**
   * Helper function that returns a proper .po file.
   */
  function getPoFile() {
    return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\\n"

msgid "One sheep"
msgid_plural "@count sheep"
msgstr[0] "un mouton"
msgstr[1] "@count moutons"

msgid "Monday"
msgstr "lundi"

msgid "Tuesday"
msgstr "mardi"

msgid "Wednesday"
msgstr "mercredi"

msgid "Thursday"
msgstr "jeudi"

msgid "Friday"
msgstr "vendredi"

msgid "Saturday"
msgstr "samedi"

msgid "Sunday"
msgstr "dimanche"
EOF;
  }

  /**
   * Helper function that returns a bad .po file.
   */
  function getBadPoFile() {
    return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\\n"

msgid "Save configuration"
msgstr "Enregistrer la configuration"

msgid "edit"
msgstr "modifier<img SRC="javascript:alert(\\'xss\\');">"

msgid "delete"
msgstr "supprimer<script>alert('xss');</script>"

EOF;
  }

  /**
   * Helper function that returns a proper .po file, for testing overwriting
   * existing translations.
   */
  function getOverwritePoFile() {
    return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\\n"

msgid "Monday"
msgstr "Montag"

msgid "Day"
msgstr "Jour"
EOF;
  }

  /**
   * Helper function that returns a .po file with context.
   */
  function getPoFileWithContext() {

    // Croatian (code hr) is one of the languages that have a different
    // form for the full name and the abbreviated name for the month May.
    return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\\n"

msgctxt "Long month name"
msgid "May"
msgstr "Svibanj"

msgid "May"
msgstr "Svi."
EOF;
  }

  /**
   * Helper function that returns a .po file with an empty last item.
   */
  function getPoFileWithEmptyMsgstr() {
    return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\\n"

msgid "Operations"
msgstr ""

EOF;
  }

  /**
   * Helper function that returns a .po file with an empty last item.
   */
  function getPoFileWithMsgstr() {
    return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\\n"

msgid "Operations"
msgstr "Műveletek"

msgid "Will not appear in Drupal core, so we can ensure the test passes"
msgstr ""

EOF;
  }

  /**
   * Returns a .po file with a missing plural formula.
   */
  function getPoFileWithMissingPlural() {
    return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"

msgid "Monday"
msgstr "Ponedjeljak"
EOF;
  }

  /**
   * Returns a .po file with a broken plural formula.
   */
  function getPoFileWithBrokenPlural() {
    return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: broken, will not parse\\n"

msgid "Monday"
msgstr "lundi"
EOF;
  }

}