Improve charset detection by prioritizing charset according to user languag...

Aleksander Machniak

2013-01-06 a5b8ef99d4e26bdb00e9b74221f107767a084a6e

Improve charset detection by prioritizing charset according to user language (#1485669)

 CHANGELOG

@@ -1,6 +1,7 @@
CHANGELOG Roundcube Webmail
===========================

- Improve charset detection by prioritizing charset according to user language (#1485669)
- Fix handling of escaped separator in vCard file (#1488896)
- Fix #countcontrols issue in IE<=8 when text is very long (#1488890)
- Add option to use envelope From address for MDN responses (#1488880)

 program/lib/Roundcube/rcube.php

@@ -1258,6 +1258,22 @@
            return $this->decrypt($_SESSION['password']);
        }
    }


    /**
     * Getter for logged user language code.
     *
     * @return string User language code
     */
    public function get_user_language()
    {
        if (is_object($this->user)) {
            return $this->user->language;
        }
        else if (isset($_SESSION['language'])) {
            return $_SESSION['language'];
        }
    }
}



 program/lib/Roundcube/rcube_charset.php

@@ -646,12 +646,13 @@
    /**
     * A method to guess character set of a string.
     *
     * @param string $string    String.
     * @param string $failover     Default result for failover.
     * @param string $string   String
     * @param string $failover Default result for failover
     * @param string $language User language
     *
     * @return string Charset name
     */
    public static function detect($string, $failover='')
    public static function detect($string, $failover = null, $language = null)
    {
        if (substr($string, 0, 4) == "\0\0\xFE\xFF") return 'UTF-32BE';  // Big Endian
        if (substr($string, 0, 4) == "\xFF\xFE\0\0") return 'UTF-32LE';  // Little Endian
@@ -666,38 +667,62 @@
        if ($string[0] != "\0" && $string[1] == "\0" && $string[2] != "\0" && $string[3] == "\0") return 'UTF-16LE';

        if (function_exists('mb_detect_encoding')) {
            // FIXME: the order is important, because sometimes
            // iso string is detected as euc-jp and etc.
            $enc = array(
                'UTF-8', 'SJIS', 'GB2312',
                'ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
                'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8', 'ISO-8859-9',
                'ISO-8859-10', 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'ISO-8859-16',
                'WINDOWS-1252', 'WINDOWS-1251', 'EUC-JP', 'EUC-TW', 'KOI8-R', 'BIG5',
                'ISO-2022-KR', 'ISO-2022-JP',
            );

            $result = mb_detect_encoding($string, join(',', $enc));
        }
        else {
            // No match, check for UTF-8
            // from http://w3.org/International/questions/qa-forms-utf-8.html
            if (preg_match('/\A(
                [\x09\x0A\x0D\x20-\x7E]
                | [\xC2-\xDF][\x80-\xBF]
                | \xE0[\xA0-\xBF][\x80-\xBF]
                | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}
                | \xED[\x80-\x9F][\x80-\xBF]
                | \xF0[\x90-\xBF][\x80-\xBF]{2}
                | [\xF1-\xF3][\x80-\xBF]{3}
                | \xF4[\x80-\x8F][\x80-\xBF]{2}
                )*\z/xs', substr($string, 0, 2048))
            ) {
            return 'UTF-8';
            if (empty($language)) {
                $rcube    = rcube::get_instance();
                $language = $rcube->get_user_language();
            }

            // Prioritize charsets according to current language (#1485669)
            switch ($language) {
            case 'ja_JP': // for Japanese
                $prio = array('ISO-2022-JP', 'JIS', 'UTF-8', 'EUC-JP', 'eucJP-win', 'SJIS', 'SJIS-win');
                break;

            case 'zh_CN': // for Chinese (Simplified)
            case 'zh_TW': // for Chinese (Traditional)
                $prio = array('UTF-8', 'BIG-5', 'GB2312', 'EUC-TW');
                break;

            case 'ko_KR': // for Korean
                $prio = array('UTF-8', 'EUC-KR', 'ISO-2022-KR');
                break;

            case 'ru_RU': // for Russian
                $prio = array('UTF-8', 'WINDOWS-1251', 'KOI8-R');
                break;

            default:
                $prio = array('UTF-8', 'SJIS', 'GB2312',
                    'ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
                    'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8', 'ISO-8859-9',
                    'ISO-8859-10', 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'ISO-8859-16',
                    'WINDOWS-1252', 'WINDOWS-1251', 'EUC-JP', 'EUC-TW', 'KOI8-R', 'BIG-5',
                    'ISO-2022-KR', 'ISO-2022-JP',
                );
            }

            $encodings = array_unique(array_merge($prio, mb_list_encodings()));

            return mb_detect_encoding($string, $encodings);
        }

        return $result ? $result : $failover;
        // No match, check for UTF-8
        // from http://w3.org/International/questions/qa-forms-utf-8.html
        if (preg_match('/\A(
            [\x09\x0A\x0D\x20-\x7E]
            | [\xC2-\xDF][\x80-\xBF]
            | \xE0[\xA0-\xBF][\x80-\xBF]
            | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}
            | \xED[\x80-\x9F][\x80-\xBF]
            | \xF0[\x90-\xBF][\x80-\xBF]{2}
            | [\xF1-\xF3][\x80-\xBF]{3}
            | \xF4[\x80-\x8F][\x80-\xBF]{2}
            )*\z/xs', substr($string, 0, 2048))
        ) {
            return 'UTF-8';
        }

        return $failover;
    }



 tests/Framework/Charset.php

@@ -159,4 +159,22 @@
        $this->assertEquals($output, rcube_charset::detect($input, $fallback));
    }

    /**
     * Data for test_detect()
     */
    function data_detect_with_lang()
    {
        return array(
            array('Åã¥Ü¦WºÙ,¥D­n', 'zh_TW', 'BIG-5'),
        );
    }

    /**
     * @dataProvider data_detect_with_lang
     */
    function test_detect_with_lang($input, $lang, $output)
    {
        $this->assertEquals($output, rcube_charset::detect($input, $output, $lang));
    }

}