summaryrefslogtreecommitdiff
path: root/rt/lib/RT/I18N.pm
diff options
context:
space:
mode:
Diffstat (limited to 'rt/lib/RT/I18N.pm')
-rw-r--r--rt/lib/RT/I18N.pm519
1 files changed, 0 insertions, 519 deletions
diff --git a/rt/lib/RT/I18N.pm b/rt/lib/RT/I18N.pm
deleted file mode 100644
index 7f56886cc..000000000
--- a/rt/lib/RT/I18N.pm
+++ /dev/null
@@ -1,519 +0,0 @@
-# BEGIN BPS TAGGED BLOCK {{{
-#
-# COPYRIGHT:
-#
-# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
-# <jesse@bestpractical.com>
-#
-# (Except where explicitly superseded by other copyright notices)
-#
-#
-# LICENSE:
-#
-# This work is made available to you under the terms of Version 2 of
-# the GNU General Public License. A copy of that license should have
-# been provided with this software, but in any event can be snarfed
-# from www.gnu.org.
-#
-# This work is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-# 02110-1301 or visit their web page on the internet at
-# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
-#
-#
-# CONTRIBUTION SUBMISSION POLICY:
-#
-# (The following paragraph is not intended to limit the rights granted
-# to you to modify and distribute this software under the terms of
-# the GNU General Public License and is only of importance to you if
-# you choose to contribute your changes and enhancements to the
-# community by submitting them to Best Practical Solutions, LLC.)
-#
-# By intentionally submitting any modifications, corrections or
-# derivatives to this work, or any other work intended for use with
-# Request Tracker, to Best Practical Solutions, LLC, you confirm that
-# you are the copyright holder for those contributions and you grant
-# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
-# royalty-free, perpetual, license to use, copy, create derivative
-# works based on those contributions, and sublicense and distribute
-# those contributions and any derivatives thereof.
-#
-# END BPS TAGGED BLOCK }}}
-
-=head1 NAME
-
-RT::I18N - a base class for localization of RT
-
-=cut
-
-package RT::I18N;
-
-use strict;
-use warnings;
-
-use Locale::Maketext 1.04;
-use Locale::Maketext::Lexicon 0.25;
-use base ('Locale::Maketext::Fuzzy');
-
-use Encode;
-use MIME::Entity;
-use MIME::Head;
-
-# I decree that this project's first language is English.
-
-our %Lexicon = (
- 'TEST_STRING' => 'Concrete Mixer',
-
- '__Content-Type' => 'text/plain; charset=utf-8',
-
- '_AUTO' => 1,
- # That means that lookup failures can't happen -- if we get as far
- # as looking for something in this lexicon, and we don't find it,
- # then automagically set $Lexicon{$key} = $key, before possibly
- # compiling it.
-
- # The exception is keys that start with "_" -- they aren't auto-makeable.
-
-);
-# End of lexicon.
-
-=head2 Init
-
-Initializes the lexicons used for localization.
-
-
-=cut
-
-sub Init {
- require File::Glob;
-
- my @lang = RT->Config->Get('LexiconLanguages');
- @lang = ('*') unless @lang;
-
- # load default functions
- require substr(__FILE__, 0, -3) . '/i_default.pm';
-
- # Load language-specific functions
- foreach my $file ( File::Glob::bsd_glob(substr(__FILE__, 0, -3) . "/*.pm") ) {
- unless ( $file =~ /^([-\w\s\.\/\\~:]+)$/ ) {
- warn("$file is tainted. not loading");
- next;
- }
- $file = $1;
-
- my ($lang) = ($file =~ /([^\\\/]+?)\.pm$/);
- next unless grep $_ eq '*' || $_ eq $lang, @lang;
- require $file;
- }
-
- my %import;
- foreach my $l ( @lang ) {
- $import{$l} = [
- Gettext => (substr(__FILE__, 0, -3) . "/$l.po"),
- Gettext => "$RT::LocalLexiconPath/*/$l.po",
- Gettext => "$RT::LocalLexiconPath/$l.po",
- ];
- push @{ $import{$l} }, map {(Gettext => "$_/$l.po")} RT->PluginDirs('po');
- }
-
- # Acquire all .po files and iterate them into lexicons
- Locale::Maketext::Lexicon->import({ _decode => 1, %import });
-
- return 1;
-}
-
-sub LoadLexicons {
-
- no strict 'refs';
- foreach my $k (keys %{RT::I18N::} ) {
- next if $k eq 'main::';
- next unless index($k, '::', -2) >= 0;
- next unless exists ${ 'RT::I18N::'. $k }{'Lexicon'};
-
- my $lex = *{ ${'RT::I18N::'. $k }{'Lexicon'} }{HASH};
- # run fetch to force load
- my $tmp = $lex->{'foo'};
- # XXX: untie may fail with "untie attempted
- # while 1 inner references still exist"
- # TODO: untie that has to lower fetch impact
- # untie %$lex if tied %$lex;
- }
-}
-
-=head2 encoding
-
-Returns the encoding of the current lexicon, as yanked out of __ContentType's "charset" field.
-If it can't find anything, it returns 'ISO-8859-1'
-
-
-
-=cut
-
-
-sub encoding { 'utf-8' }
-
-# {{{ SetMIMEEntityToUTF8
-
-=head2 SetMIMEEntityToUTF8 $entity
-
-An utility function which will try to convert entity body into utf8.
-It's now a wrap-up of SetMIMEEntityToEncoding($entity, 'utf-8').
-
-=cut
-
-sub SetMIMEEntityToUTF8 {
- RT::I18N::SetMIMEEntityToEncoding(shift, 'utf-8');
-}
-
-# }}}
-
-# {{{ IsTextualContentType
-
-=head2 IsTextualContentType $type
-
-An utility function that determines whether $type is I<textual>, meaning
-that it can sensibly be converted to Unicode text.
-
-Currently, it returns true iff $type matches this regular expression
-(case-insensitively):
-
- ^(?:text/(?:plain|html)|message/rfc822)\b
-
-# }}}
-
-=cut
-
-sub IsTextualContentType {
- my $type = shift;
- ($type =~ m{^(?:text/(?:plain|html)|message/rfc822)\b}i) ? 1 : 0;
-}
-
-# {{{ SetMIMEEntityToEncoding
-
-=head2 SetMIMEEntityToEncoding $entity, $encoding
-
-An utility function which will try to convert entity body into specified
-charset encoding (encoded as octets, *not* unicode-strings). It will
-iterate all the entities in $entity, and try to convert each one into
-specified charset if whose Content-Type is 'text/plain'.
-
-This function doesn't return anything meaningful.
-
-=cut
-
-sub SetMIMEEntityToEncoding {
- my ( $entity, $enc, $preserve_words ) = ( shift, shift, shift );
-
- # do the same for parts first of all
- SetMIMEEntityToEncoding( $_, $enc, $preserve_words ) foreach $entity->parts;
-
- my $charset = _FindOrGuessCharset($entity) or return;
- # one and only normalization
- $charset = 'utf-8' if $charset =~ /^utf-?8$/i;
- $enc = 'utf-8' if $enc =~ /^utf-?8$/i;
-
- SetMIMEHeadToEncoding(
- $entity->head,
- _FindOrGuessCharset($entity, 1) => $enc,
- $preserve_words
- );
-
- my $head = $entity->head;
-
- # convert at least MIME word encoded attachment filename
- foreach my $attr (qw(content-type.name content-disposition.filename)) {
- if ( my $name = $head->mime_attr($attr) and !$preserve_words ) {
- $head->mime_attr( $attr => DecodeMIMEWordsToUTF8($name) );
- }
- }
-
- # If this is a textual entity, we'd need to preserve its original encoding
- $head->replace( "X-RT-Original-Encoding" => $charset )
- if $head->mime_attr('content-type.charset') or IsTextualContentType($head->mime_type);
-
- return unless IsTextualContentType($head->mime_type);
-
- my $body = $entity->bodyhandle;
-
- if ( $enc ne $charset && $body ) {
- my $string = $body->as_string or return;
-
- # {{{ Convert the body
- eval {
- $RT::Logger->debug( "Converting '$charset' to '$enc' for " . $head->mime_type . " - " . ( $head->get('subject') || 'Subjectless message' ) );
-
- # NOTE:: see the comments at the end of the sub.
- Encode::_utf8_off( $string);
- Encode::from_to( $string, $charset => $enc );
- };
-
- if ($@) {
- $RT::Logger->error( "Encoding error: " . $@ . " defaulting to ISO-8859-1 -> UTF-8" );
- eval { Encode::from_to( $string, 'iso-8859-1' => $enc ) };
- if ($@) {
- $RT::Logger->crit( "Totally failed to convert to utf-8: " . $@ . " I give up" );
- }
- }
-
- # }}}
-
- my $new_body = MIME::Body::InCore->new( $string);
-
- # set up the new entity
- $head->mime_attr( "content-type" => 'text/plain' )
- unless ( $head->mime_attr("content-type") );
- $head->mime_attr( "content-type.charset" => $enc );
- $entity->bodyhandle($new_body);
- }
-}
-
-# NOTES: Why Encode::_utf8_off before Encode::from_to
-#
-# All the strings in RT are utf-8 now. Quotes from Encode POD:
-#
-# [$length =] from_to($octets, FROM_ENC, TO_ENC [, CHECK])
-# ... The data in $octets must be encoded as octets and not as
-# characters in Perl's internal format. ...
-#
-# Not turning off the UTF-8 flag in the string will prevent the string
-# from conversion.
-
-# }}}
-
-# {{{ DecodeMIMEWordsToUTF8
-
-=head2 DecodeMIMEWordsToUTF8 $raw
-
-An utility method which mimics MIME::Words::decode_mimewords, but only
-limited functionality. This function returns an utf-8 string.
-
-It returns the decoded string, or the original string if it's not
-encoded. Since the subroutine converts specified string into utf-8
-charset, it should not alter a subject written in English.
-
-Why not use MIME::Words directly? Because it fails in RT when I
-tried. Maybe it's ok now.
-
-=cut
-
-sub DecodeMIMEWordsToUTF8 {
- my $str = shift;
- DecodeMIMEWordsToEncoding($str, 'utf-8');
-}
-
-sub DecodeMIMEWordsToEncoding {
- my $str = shift;
- my $enc = shift;
-
- @_ = $str =~ m/(.*?)=\?([^?]+)\?([QqBb])\?([^?]+)\?=([^=]*)/gcs;
- return ($str) unless (@_);
-
- # add everything that hasn't matched to the end of the latest
- # string in array this happen when we have 'key="=?encoded?="; key="plain"'
- $_[-1] .= substr($str, pos $str);
-
- $str = "";
- while (@_) {
- my ($prefix, $charset, $encoding, $enc_str, $trailing) =
- (shift, shift, lc shift, shift, shift);
-
- $trailing =~ s/\s?\t?$//; # Observed from Outlook Express
-
- if ( $encoding eq 'q' ) {
- use MIME::QuotedPrint;
- $enc_str =~ tr/_/ /; # Observed from Outlook Express
- $enc_str = decode_qp($enc_str);
- } elsif ( $encoding eq 'b' ) {
- use MIME::Base64;
- $enc_str = decode_base64($enc_str);
- } else {
- $RT::Logger->warning("Incorrect encoding '$encoding' in '$str', "
- ."only Q(uoted-printable) and B(ase64) are supported");
- }
-
- # now we have got a decoded subject, try to convert into the encoding
- unless ($charset eq $enc) {
- eval { Encode::from_to($enc_str, $charset, $enc) };
- if ($@) {
- $charset = _GuessCharset( $enc_str );
- Encode::from_to($enc_str, $charset, $enc);
- }
- }
-
- # XXX TODO: RT doesn't currently do the right thing with mime-encoded headers
- # We _should_ be preserving them encoded until after parsing is completed and
- # THEN undo the mime-encoding.
- #
- # This routine should be translating the existing mimeencoding to utf8 but leaving
- # things encoded.
- #
- # It's legal for headers to contain mime-encoded commas and semicolons which
- # should not be treated as address separators. (Encoding == quoting here)
- #
- # until this is fixed, we must escape any string containing a comma or semicolon
- # this is only a bandaid
-
- # Some _other_ MUAs encode quotes _already_, and double quotes
- # confuse us a lot, so only quote it if it isn't quoted
- # already.
- $enc_str = qq{"$enc_str"} if $enc_str =~ /[,;]/ and $enc_str !~ /^".*"$/;
-
- $str .= $prefix . $enc_str . $trailing;
- }
-
- # We might have \n without trailing whitespace, which will result in
- # invalid headers.
- $str =~ s/\n//g;
-
- return ($str)
-}
-
-# }}}
-
-# {{{ _FindOrGuessCharset
-
-=head2 _FindOrGuessCharset MIME::Entity, $head_only
-
-When handed a MIME::Entity will first attempt to read what charset the message is encoded in. Failing that, will use Encode::Guess to try to figure it out
-
-If $head_only is true, only guesses charset for head parts. This is because header's encoding (e.g. filename="...") may be different from that of body's.
-
-=cut
-
-sub _FindOrGuessCharset {
- my $entity = shift;
- my $head_only = shift;
- my $head = $entity->head;
-
- if ( my $charset = $head->mime_attr("content-type.charset") ) {
- return $charset;
- }
-
- if ( !$head_only and $head->mime_type =~ m{^text/}) {
- my $body = $entity->bodyhandle or return;
- return _GuessCharset( $body->as_string );
- }
- else {
- # potentially binary data -- don't guess the body
- return _GuessCharset( $head->as_string );
- }
-}
-
-# }}}
-
-# {{{ _GuessCharset
-
-=head2 _GuessCharset STRING
-
-use Encode::Guess to try to figure it out the string's encoding.
-
-=cut
-
-sub _GuessCharset {
- my $fallback = 'iso-8859-1';
-
- # if $_[0] is null/empty, we don't guess its encoding
- return $fallback unless defined $_[0] && length $_[0];
-
- my $charset;
- my @encodings = RT->Config->Get('EmailInputEncodings');
- if ( @encodings and eval { require Encode::Guess; 1 } ) {
- Encode::Guess->set_suspects( @encodings );
- my $decoder = Encode::Guess->guess( $_[0] );
-
- if ( defined($decoder) ) {
- if ( ref $decoder ) {
- $charset = $decoder->name;
- $RT::Logger->debug("Guessed encoding: $charset");
- return $charset;
- }
- elsif ($decoder =~ /(\S+ or .+)/) {
- my %matched = map { $_ => 1 } split(/ or /, $1);
- return 'utf-8' if $matched{'utf8'}; # one and only normalization
-
- foreach my $suspect (RT->Config->Get('EmailInputEncodings')) {
- next unless $matched{$suspect};
- $RT::Logger->debug("Encode::Guess ambiguous ($decoder); using $suspect");
- $charset = $suspect;
- last;
- }
- }
- else {
- $RT::Logger->warning("Encode::Guess failed: $decoder; fallback to $fallback");
- }
- }
- else {
- $RT::Logger->warning("Encode::Guess failed: decoder is undefined; fallback to $fallback");
- }
- }
- elsif ( @encodings && $@ ) {
- $RT::Logger->error("You have set EmailInputEncodings, but we couldn't load Encode::Guess: $@");
- } else {
- $RT::Logger->warning("No EmailInputEncodings set, fallback to $fallback");
- }
-
- return ($charset || $fallback);
-}
-
-# }}}
-
-# {{{ SetMIMEHeadToEncoding
-
-=head2 SetMIMEHeadToEncoding HEAD OLD_CHARSET NEW_CHARSET
-
-Converts a MIME Head from one encoding to another. This totally violates the RFC.
-We should never need this. But, Surprise!, MUAs are badly broken and do this kind of stuff
-all the time
-
-
-=cut
-
-sub SetMIMEHeadToEncoding {
- my ( $head, $charset, $enc, $preserve_words ) = ( shift, shift, shift, shift );
-
- $charset = 'utf-8' if $charset eq 'utf8';
- $enc = 'utf-8' if $enc eq 'utf8';
-
- return if $charset eq $enc and $preserve_words;
-
- foreach my $tag ( $head->tags ) {
- next unless $tag; # seen in wild: headers with no name
- my @values = $head->get_all($tag);
- $head->delete($tag);
- foreach my $value (@values) {
- if ( $charset ne $enc ) {
-
- eval {
- Encode::_utf8_off($value);
- Encode::from_to( $value, $charset => $enc );
- };
- if ($@) {
- $RT::Logger->error( "Encoding error: " . $@
- . " defaulting to ISO-8859-1 -> UTF-8" );
- eval { Encode::from_to( $value, 'iso-8859-1' => $enc ) };
- if ($@) {
- $RT::Logger->crit( "Totally failed to convert to utf-8: " . $@ . " I give up" );
- }
- }
- }
- $value = DecodeMIMEWordsToEncoding( $value, $enc ) unless $preserve_words;
- $head->add( $tag, $value );
- }
- }
-
-}
-# }}}
-
-eval "require RT::I18N_Vendor";
-die $@ if ($@ && $@ !~ qr{^Can't locate RT/I18N_Vendor.pm});
-eval "require RT::I18N_Local";
-die $@ if ($@ && $@ !~ qr{^Can't locate RT/I18N_Local.pm});
-
-1; # End of module.
-
generated by cgit v1.2.1 (git 2.18.0) at 2025-06-13 12:02:21 +0000