class LocaleUILanguageNegotiationTest

class LocaleUILanguageNegotiationTest extends DrupalWebTestCase {
    public static function getInfo() {
        return array(
            'name' => 'UI language negotiation',
            'description' => 'Test UI language switching by URL path prefix and domain.',
            'group' => 'Locale',
        );
    }
    function setUp() {
        parent::setUp('locale', 'locale_test');
        require_once DRUPAL_ROOT . '/includes/language.inc';
        drupal_load('module', 'locale');
        $admin_user = $this->drupalCreateUser(array(
            'administer languages',
            'translate interface',
            'access administration pages',
            'administer blocks',
        ));
        $this->drupalLogin($admin_user);
    }
    
    /**
     * Tests for language switching by URL path.
     */
    function testUILanguageNegotiation() {
        // A few languages to switch to.
        // This one is unknown, should get the default lang version.
        $language_unknown = 'blah-blah';
        // For testing browser lang preference.
        $language_browser_fallback = 'vi';
        // For testing path prefix.
        $language = 'zh-hans';
        // For setting browser language preference to 'vi'.
        $http_header_browser_fallback = array(
            "Accept-Language: {$language_browser_fallback};q=1",
        );
        // For setting browser language preference to some unknown.
        $http_header_blah = array(
            "Accept-Language: blah;q=1",
        );
        // This domain should switch the UI to Chinese.
        $language_domain = 'example.cn';
        // Setup the site languages by installing two languages.
        require_once DRUPAL_ROOT . '/includes/locale.inc';
        locale_add_language($language_browser_fallback);
        locale_add_language($language);
        // We will look for this string in the admin/config screen to see if the
        // corresponding translated string is shown.
        $default_string = 'Configure languages for content and the user interface';
        // Set the default language in order for the translated string to be registered
        // into database when seen by t(). Without doing this, our target string
        // is for some reason not found when doing translate search. This might
        // be some bug.
        drupal_static_reset('language_list');
        $languages = language_list('enabled');
        variable_set('language_default', $languages[1]['vi']);
        // First visit this page to make sure our target string is searchable.
        $this->drupalGet('admin/config');
        // Now the t()'ed string is in db so switch the language back to default.
        variable_del('language_default');
        // Translate the string.
        $language_browser_fallback_string = "In {$language_browser_fallback} In {$language_browser_fallback} In {$language_browser_fallback}";
        $language_string = "In {$language} In {$language} In {$language}";
        // Do a translate search of our target string.
        $edit = array(
            'string' => $default_string,
        );
        $this->drupalPost('admin/config/regional/translate/translate', $edit, t('Filter'));
        // Should find the string and now click edit to post translated string.
        $this->clickLink('edit');
        $edit = array(
            "translations[{$language_browser_fallback}]" => $language_browser_fallback_string,
            "translations[{$language}]" => $language_string,
        );
        $this->drupalPost(NULL, $edit, t('Save translations'));
        // Configure URL language rewrite.
        variable_set('locale_language_negotiation_url_type', LANGUAGE_TYPE_INTERFACE);
        $tests = array(
            // Default, browser preference should have no influence.
array(
                'language_negotiation' => array(
                    LOCALE_LANGUAGE_NEGOTIATION_URL,
                    LANGUAGE_NEGOTIATION_DEFAULT,
                ),
                'path' => 'admin/config',
                'expect' => $default_string,
                'expected_provider' => LANGUAGE_NEGOTIATION_DEFAULT,
                'http_header' => $http_header_browser_fallback,
                'message' => 'URL (PATH) > DEFAULT: no language prefix, UI language is default and the browser language preference setting is not used.',
            ),
            // Language prefix.
array(
                'language_negotiation' => array(
                    LOCALE_LANGUAGE_NEGOTIATION_URL,
                    LANGUAGE_NEGOTIATION_DEFAULT,
                ),
                'path' => "{$language}/admin/config",
                'expect' => $language_string,
                'expected_provider' => LOCALE_LANGUAGE_NEGOTIATION_URL,
                'http_header' => $http_header_browser_fallback,
                'message' => 'URL (PATH) > DEFAULT: with language prefix, UI language is switched based on path prefix',
            ),
            // Default, go by browser preference.
array(
                'language_negotiation' => array(
                    LOCALE_LANGUAGE_NEGOTIATION_URL,
                    LOCALE_LANGUAGE_NEGOTIATION_BROWSER,
                ),
                'path' => 'admin/config',
                'expect' => $language_browser_fallback_string,
                'expected_provider' => LOCALE_LANGUAGE_NEGOTIATION_BROWSER,
                'http_header' => $http_header_browser_fallback,
                'message' => 'URL (PATH) > BROWSER: no language prefix, UI language is determined by browser language preference',
            ),
            // Prefix, switch to the language.
array(
                'language_negotiation' => array(
                    LOCALE_LANGUAGE_NEGOTIATION_URL,
                    LOCALE_LANGUAGE_NEGOTIATION_BROWSER,
                ),
                'path' => "{$language}/admin/config",
                'expect' => $language_string,
                'expected_provider' => LOCALE_LANGUAGE_NEGOTIATION_URL,
                'http_header' => $http_header_browser_fallback,
                'message' => 'URL (PATH) > BROWSER: with langage prefix, UI language is based on path prefix',
            ),
            // Default, browser language preference is not one of site's lang.
array(
                'language_negotiation' => array(
                    LOCALE_LANGUAGE_NEGOTIATION_URL,
                    LOCALE_LANGUAGE_NEGOTIATION_BROWSER,
                    LANGUAGE_NEGOTIATION_DEFAULT,
                ),
                'path' => 'admin/config',
                'expect' => $default_string,
                'expected_provider' => LANGUAGE_NEGOTIATION_DEFAULT,
                'http_header' => $http_header_blah,
                'message' => 'URL (PATH) > BROWSER > DEFAULT: no language prefix and browser language preference set to unknown language should use default language',
            ),
        );
        foreach ($tests as $test) {
            $this->runTest($test);
        }
        // Unknown language prefix should return 404.
        variable_set('language_negotiation_' . LANGUAGE_TYPE_INTERFACE, locale_language_negotiation_info());
        $this->drupalGet("{$language_unknown}/admin/config", array(), $http_header_browser_fallback);
        $this->assertResponse(404, "Unknown language path prefix should return 404");
        // Setup for domain negotiation, first configure the language to have domain
        // URL. We use HTTPS and a port to make sure that only the domain name is used.
        $edit = array(
            'prefix' => '',
            'domain' => "https://{$language_domain}:99",
        );
        $this->drupalPost("admin/config/regional/language/edit/{$language}", $edit, t('Save language'));
        // Set the site to use domain language negotiation.
        $tests = array(
            // Default domain, browser preference should have no influence.
array(
                'language_negotiation' => array(
                    LOCALE_LANGUAGE_NEGOTIATION_URL,
                    LANGUAGE_NEGOTIATION_DEFAULT,
                ),
                'locale_language_negotiation_url_part' => LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN,
                'path' => 'admin/config',
                'expect' => $default_string,
                'expected_provider' => LANGUAGE_NEGOTIATION_DEFAULT,
                'http_header' => $http_header_browser_fallback,
                'message' => 'URL (DOMAIN) > DEFAULT: default domain should get default language',
            ),
            // Language domain specific URL, we set the $_SERVER['HTTP_HOST'] in
            // locale_test.module hook_boot() to simulate this.
array(
                'language_negotiation' => array(
                    LOCALE_LANGUAGE_NEGOTIATION_URL,
                    LANGUAGE_NEGOTIATION_DEFAULT,
                ),
                'locale_language_negotiation_url_part' => LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN,
                'locale_test_domain' => $language_domain . ':88',
                'path' => 'admin/config',
                'expect' => $language_string,
                'expected_provider' => LOCALE_LANGUAGE_NEGOTIATION_URL,
                'http_header' => $http_header_browser_fallback,
                'message' => 'URL (DOMAIN) > DEFAULT: domain example.cn should switch to Chinese',
            ),
        );
        foreach ($tests as $test) {
            $this->runTest($test);
        }
    }
    private function runTest($test) {
        if (!empty($test['language_negotiation'])) {
            $negotiation = array_flip($test['language_negotiation']);
            language_negotiation_set(LANGUAGE_TYPE_INTERFACE, $negotiation);
        }
        if (!empty($test['locale_language_negotiation_url_part'])) {
            variable_set('locale_language_negotiation_url_part', $test['locale_language_negotiation_url_part']);
        }
        if (!empty($test['locale_test_domain'])) {
            variable_set('locale_test_domain', $test['locale_test_domain']);
        }
        $this->drupalGet($test['path'], array(), $test['http_header']);
        $this->assertText($test['expect'], $test['message']);
        $this->assertText(t('Language negotiation provider: @name', array(
            '@name' => $test['expected_provider'],
        )));
    }
    
    /**
     * Test URL language detection when the requested URL has no language.
     */
    function testUrlLanguageFallback() {
        // Add the Italian language.
        $language_browser_fallback = 'it';
        locale_add_language($language_browser_fallback);
        $languages = language_list();
        // Enable the path prefix for the default language: this way any unprefixed
        // URL must have a valid fallback value.
        $edit = array(
            'prefix' => 'en',
        );
        $this->drupalPost('admin/config/regional/language/edit/en', $edit, t('Save language'));
        // Enable browser and URL language detection.
        $edit = array(
            'language[enabled][locale-browser]' => TRUE,
            'language[enabled][locale-url]' => TRUE,
            'language[weight][locale-browser]' => -8,
            'language[weight][locale-url]' => -10,
        );
        $this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
        $this->drupalGet('admin/config/regional/language/configure');
        // Enable the language switcher block.
        $edit = array(
            'blocks[locale_language][region]' => 'sidebar_first',
        );
        $this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
        // Access the front page without specifying any valid URL language prefix
        // and having as browser language preference a non-default language.
        $http_header = array(
            "Accept-Language: {$language_browser_fallback};q=1",
        );
        $this->drupalGet('', array(), $http_header);
        // Check that the language switcher active link matches the given browser
        // language.
        $args = array(
            ':url' => base_path() . (!empty($GLOBALS['conf']['clean_url']) ? $language_browser_fallback : "?q={$language_browser_fallback}"),
        );
        $fields = $this->xpath('//div[@id="block-locale-language"]//a[@class="language-link active" and @href=:url]', $args);
        $this->assertTrue($fields[0] == $languages[$language_browser_fallback]->native, 'The browser language is the URL active language');
        // Check that URLs are rewritten using the given browser language.
        $fields = $this->xpath('//div[@id="site-name"]//a[@rel="home" and @href=:url]//span', $args);
        $this->assertTrue($fields[0] == 'Drupal', 'URLs are rewritten using the browser language.');
    }
    
    /**
     * Tests url() when separate domains are used for multiple languages.
     */
    function testLanguageDomain() {
        // Add the Italian language, without protocol.
        $langcode = 'it';
        locale_add_language($langcode, 'Italian', 'Italian', LANGUAGE_LTR, 'it.example.com', '', TRUE, FALSE);
        // Add the French language, with protocol.
        $langcode = 'fr';
        locale_add_language($langcode, 'French', 'French', LANGUAGE_LTR, 'http://fr.example.com', '', TRUE, FALSE);
        // Enable language URL detection.
        $negotiation = array_flip(array(
            LOCALE_LANGUAGE_NEGOTIATION_URL,
            LANGUAGE_NEGOTIATION_DEFAULT,
        ));
        language_negotiation_set(LANGUAGE_TYPE_INTERFACE, $negotiation);
        variable_set('locale_language_negotiation_url_part', 1);
        global $is_https;
        $languages = language_list();
        foreach (array(
            'it',
            'fr',
        ) as $langcode) {
            // Build the link we're going to test based on the clean URL setting.
            $link = !empty($GLOBALS['conf']['clean_url']) ? $langcode . '.example.com/admin' : $langcode . '.example.com/?q=admin';
            // Test URL in another language.
            // Base path gives problems on the testbot, so $correct_link is hard-coded.
            // @see UrlAlterFunctionalTest::assertUrlOutboundAlter (path.test).
            $url = url('admin', array(
                'language' => $languages[$langcode],
            ));
            $url_scheme = $is_https ? 'https://' : 'http://';
            $correct_link = $url_scheme . $link;
            $this->assertTrue($url == $correct_link, format_string('The url() function returns the right url (@url) in accordance with the chosen language', array(
                '@url' => $url . " == " . $correct_link,
            )));
            // Test HTTPS via options.
            variable_set('https', TRUE);
            $url = url('admin', array(
                'https' => TRUE,
                'language' => $languages[$langcode],
            ));
            $correct_link = 'https://' . $link;
            $this->assertTrue($url == $correct_link, format_string('The url() function returns the right https url (via options) (@url) in accordance with the chosen language', array(
                '@url' => $url . " == " . $correct_link,
            )));
            variable_set('https', FALSE);
            // Test HTTPS via current URL scheme.
            $temp_https = $is_https;
            $is_https = TRUE;
            $url = url('admin', array(
                'language' => $languages[$langcode],
            ));
            $correct_link = 'https://' . $link;
            $this->assertTrue($url == $correct_link, format_string('The url() function returns the right url (via current url scheme) (@url) in accordance with the chosen language', array(
                '@url' => $url . " == " . $correct_link,
            )));
            $is_https = $temp_https;
        }
    }

}