Как сделать Mason2 UTF-8 чистым?

Реформирование вопроса, потому что

Комментарий: Этот вопрос уже получил "популярный значок вопроса", поэтому, возможно, я не единственный безнадежный человек.:)

К сожалению, демонстрация полного стека проблем приводит к очень длинному вопросу, и это очень важно Mason.

Во-первых, только мнений:)

Я использую HTML:: Mason в возрасте, а теперь пытаюсь использовать Mason2. Poet и Mason являются самыми передовыми системами в CPAN. Не нашел ничего сравнимого, что из коробки позволяет писать так чисто, но очень взломать:)/web-apps, с множеством включенных батарей (ведение журнала, кеширование, управление конфигурацией, собственный PGSI и т.д.)

К сожалению, автор не заботится обо всем остальном, например по умолчанию он основан только на ascii, без любого руководства, faq или советов о: как использовать его с unicode

Теперь факты. Demo. Создайте приложение для поэта:

poet new my #the "my" directory is the $poet_root
mkdir -p my/comps/xls
cd my/comps/xls

и добавьте в dhandler.mc следующее (что будет демонстрировать две основные проблемы)

<%class>
    has 'dwl';
    use Excel::Writer::XLSX;
</%class>
<%init>
    my $file = $m->path_info;

    $file =~ s/[^\w\.]//g;
    my $cell = lc join ' ', "ÅNGSTRÖM", "in the", $file;

    if( $.dwl ) {
        #create xlsx in the memory
        my $excel;
        open my $fh, '>', \$excel or die "Failed open scalar: $!";
        my $workbook  = Excel::Writer::XLSX->new( $excel );
        my $worksheet = $workbook->add_worksheet();
        $worksheet->write(0, 0, $cell);
        $workbook->close();

        #poet/mason output
        $m->clear_buffer;
        $m->res->content_type("application/vnd.ms-excel");
        $m->print($excel);
        $m->abort();
    }
</%init>
<table border=1>
<tr><td><% $cell %></td></tr>
</table>
<a href="?dwl=yes">download <% $file %></a>

и запустите приложение

../bin/run.pl

перейдите в http://0:5000https://stackoverflow.com/xls/hello.xlsx, и вы получите:

+----------------------------+
| ÅngstrÖm in the hello.xlsx |
+----------------------------+
download hello.xlsx

Нажав загрузить hello.xlsx, вы получите hello.xlsx в загрузках.

Вышеупомянутая демонстрация первой проблемы, например источник источника компонента "под" use utf8;, поэтому lc не понимает символы.

Вторая проблема заключается в следующем: попробуйте [http://0: 5000/xls/hélló.xlsx] или http://0:5000https://stackoverflow.com/xls/h%C3%A9ll%C3%B3.xlsx и вы увидите:

+--------------------------+
| ÅngstrÖm in the hll.xlsx |
+--------------------------+
download hll.xlsx
#note the wrong filename

Конечно, вход (path_info) не декодируется, script работает с октетами, закодированными utf8, а не с perl-символами.

Итак, указав perl - "источник в utf8", добавив use utf8; в <%class%>, результаты

+--------------------------+
| �ngstr�m in the hll.xlsx |
+--------------------------+
download hll.xlsx

добавление use feature 'unicode_strings' (или use 5.014;) еще хуже:

+----------------------------+
| �ngstr�m in the h�ll�.xlsx |
+----------------------------+
download h�ll�.xlsx

Конечно,, теперь источник содержит широкие символы, ему нужно Encode::encode_utf8 на выходе.

Можно попробовать использовать такой фильтр:

<%filter uencode><% Encode::encode_utf8($yield->()) %></%filter>

и фильтровать весь вывод:

% $.uencode {{
<table border=1>
<tr><td><% $cell %></td></tr>
</table>
<a href="?dwl=yes">download <% $file %></a>
% }}

но это помогает лишь частично, потому что нужно заботиться о кодировании в блоках <%init%> или <%perl%>. Кодирование/декодирование внутри кода perl во многих местах (чтение: не на границах) приводит к спагетному коду.

Кодирование/декодирование должно быть четко выполнено где-то на Poet/Mason границы - из Конечно, Plack работает на уровне байтов.

Частичное решение.

С удовольствием Poet умело позволяет модифицировать его (и Mason's) части, в $poet_root/lib/My/Mason вы можете изменить Compilation.pm на:

override 'output_class_header' => sub {
    return join("\n",
        super(), qq(
        use 5.014;
        use utf8;
        use Encode;
        )
    );
};

что будет вставлять желаемую преамбулу в компонент каждый Mason. (Не забудьте коснуться каждого компонента или просто удалить скомпилированные объекты из $poet_root/data/obj).

Также вы можете попробовать обработать запрос/ответы на границах, отредактировав $poet_root/lib/My/Mason/Request.pm до:

#found this code somewhere on the net
use Encode;
override 'run' => sub {
    my($self, $path, $args) = @_;

    #decode values - but still missing the "keys" decode
    foreach my $k (keys %$args) {
        $args->set($k, decode_utf8($args->get($k)));
    }

    my $result = super();

    #encode the output - BUT THIS BREAKS the inline XLS
    $result->output( encode_utf8($result->output()) );
    return $result;
};

Кодировать все - неправильная стратегия, она ломается, например. XLS.

Итак, через 4 года (я задал оригинальный вопрос в 2011 году) до сих пор не знаю:( как правильно использовать unicode в Mason2 и по-прежнему не существует никакой документации или помощников об этом.: (

Основные вопросы: - где (какие методы должны быть модифицированы модификаторами метода Moose) и как правильно декодировать входы и где выход (в приложении Poet/Mason.)

  • но только текстовые, например. text/plain или text/html и такие...
  • a сделать выше "неожиданно бесплатно" - например, что будет просто работать.;)

Может ли кто-нибудь помочь с реальным кодом - что я должен изменить в приведенном выше?

Ответы

Ответ 1

Хорошо, я тестировал это с помощью Firefox. HTML отображает UTF-8 правильно и оставляет только почтовый индекс, поэтому он должен работать везде.

Если вы начинаете с poet new My для применения патча, вам нужно patch -p1 -i...path/to/thisfile.diff.

diff -ruN orig/my/comps/Base.mc new/my/comps/Base.mc
--- orig/my/comps/Base.mc   2015-05-20 21:48:34.515625000 -0700
+++ new/my/comps/Base.mc    2015-05-20 21:57:34.703125000 -0700
@@ -2,9 +2,10 @@
 has 'title' => (default => 'My site');
 </%class>

-<%augment wrap>
-  <html>
+<%augment wrap><!DOCTYPE html>
+  <html lang="en-US">
     <head>
+      <meta charset="utf-8">
       <link rel="stylesheet" href="/static/css/style.css">
 % $.Defer {{
       <title><% $.title %></title>
diff -ruN orig/my/comps/xls/dhandler.mc new/my/comps/xls/dhandler.mc
--- orig/my/comps/xls/dhandler.mc   1969-12-31 16:00:00.000000000 -0800
+++ new/my/comps/xls/dhandler.mc    2015-05-20 21:53:42.796875000 -0700
@@ -0,0 +1,30 @@
+<%class>
+    has 'dwl';
+    use Excel::Writer::XLSX;
+</%class>
+<%init>
+    my $file = $m->path_info;
+    $file = decode_utf8( $file );
+    $file =~ s/[^\w\.]//g;
+    my $cell = lc join ' ', "ÅNGSTRÖM", "in the", $file ;
+    if( $.dwl ) {
+        #create xlsx in the memory
+        my $excel;
+        open my $fh, '>', \$excel or die "Failed open scalar: $!";
+        my $workbook  = Excel::Writer::XLSX->new( $fh );
+        my $worksheet = $workbook->add_worksheet();
+        $worksheet->write(0, 0, $cell);
+        $workbook->close();
+
+        #poet/mason output
+        $m->clear_buffer;
+        $m->res->content_type("application/vnd.ms-excel");
+        $m->print($excel);
+        $m->abort();
+    }
+</%init>
+<table border=1>
+<tr><td><% $cell %></td></tr>
+</table>
+<p> <a href="%c3%85%4e%47%53%54%52%c3%96%4d%20%68%c3%a9%6c%6c%c3%b3">ÅNGSTRÖM hélló</a>
+<p> <a href="?dwl=yes">download <% $file %></a>
diff -ruN orig/my/lib/My/Mason/Compilation.pm new/my/lib/My/Mason/Compilation.pm
--- orig/my/lib/My/Mason/Compilation.pm 2015-05-20 21:48:34.937500000 -0700
+++ new/my/lib/My/Mason/Compilation.pm  2015-05-20 21:49:54.515625000 -0700
@@ -5,11 +5,13 @@
 extends 'Mason::Compilation';

 # Add customizations to Mason::Compilation here.
-#
-# e.g. Add Perl code to the top of every compiled component
-#
-# override 'output_class_header' => sub {
-#      return join("\n", super(), 'use Foo;', 'use Bar qw(baz);');
-# };
-
+override 'output_class_header' => sub {
+    return join("\n",
+        super(), qq(
+        use 5.014;
+        use utf8;
+        use Encode;
+        )
+    );
+};
 1;
\ No newline at end of file
diff -ruN orig/my/lib/My/Mason/Request.pm new/my/lib/My/Mason/Request.pm
--- orig/my/lib/My/Mason/Request.pm 2015-05-20 21:48:34.968750000 -0700
+++ new/my/lib/My/Mason/Request.pm  2015-05-20 21:55:03.093750000 -0700
@@ -4,20 +4,27 @@

 extends 'Mason::Request';

-# Add customizations to Mason::Request here.
-#
-# e.g. Perform tasks before and after each Mason request
-#
-# override 'run' => sub {
-#     my $self = shift;
-#
-#     do_tasks_before_request();
-#
-#     my $result = super();
-#
-#     do_tasks_after_request();
-#
-#     return $result;
-# };
+use Encode qw/ encode_utf8 decode_utf8 /;

-1;
\ No newline at end of file
+override 'run' => sub {
+    my($self, $path, $args) = @_;
+    foreach my $k (keys %$args) {
+        my $v = $args->get($k);
+        $v=decode_utf8($v);
+        $args->set($k, $v);
+    }
+    my $result = super();
+    my( $ctype, $charset ) = $self->res->headers->content_type_charset;
+    if( ! $ctype ){
+        $ctype = 'text/html';
+        $charset = 'UTF-8';
+        $self->res->content_type( "$ctype; $charset");
+        $result->output( encode_utf8(''.( $result->output())) );
+    } elsif( ! $charset and $ctype =~ m{text/(?:plain|html)} ){
+        $charset = 'UTF-8';
+        $self->res->content_type( "$ctype; $charset");
+        $result->output( encode_utf8(''.( $result->output())) );
+    }
+    return $result;
+};
+1;

Ответ 2

В руководстве Mason2 представлен способ наследование компонентов, поэтому я считаю, что этот общий код в вашем основном Компонент Base.mp(из которого все остальные наследует) может решить вашу проблему.

Создание плагинов описано в Mason:: Manual:: Plugins.

Итак, вы можете создать свой собственный плагин, который изменяет Mason:: Request и, переопределяя request_args(), вы можете вернуть UTF-8 декодированные параметры.

Edit:

Что касается вывода UTF-8, вы можете добавить директиву Apache, чтобы гарантировать, что выходы text/plain и text/HTML всегда интерпретируются как UTF-8:

AddDefaultCharset utf-8

Ответ 3

В списке рассылки mason-users возник вопрос о работе с UTF-8 для

  • с выходом UTF-8
  • обработка аргументов GET/POST UTF-8

Вот ответ Джона:

Я бы хотел, чтобы Мейсон грамотно обрабатывал кодировку, но поскольку я не регулярно работать с utf8, вам и другим придется помогать мне с дизайн.

Это, вероятно, должно быть в плагине, например. Mason:: Plugin:: UTF8.

Итак, для вещей, которые вы особенно упоминаете, что-то вроде этого могло бы работа:

package Mason::Plugin::UTF8;
use Moose;
with 'Mason::Plugin';
1;

package Mason::Plugin::UTF8::Request;
use Mason::PluginRole;
use Encode;

# Encode all output in utf8 - ** only works with Mason 2.13 and beyond **
#
after 'process_output' => sub {
    my ($self, $outref) = @_;
    $$outref = encode_utf8( $$outref );
};

# Decode all parameters as utf8
#
around 'run' => sub {
    my $orig = shift;
    my $self = shift;

    my %params = @_;
    while (my ($key, $value) = each(%params)) {
        $value = decode_utf8($value);
    }
    $self->$orig(%params);
}

1;

Вероятно, было бы лучше, если бы вы или кто-то еще знал об этом Утилиты utf8 создали этот плагин, а не я. Но дайте мне знать, если в ядре Mason есть вещи, необходимые для облегчения этого процесса.

IMHO, необходимо добавить также следующее: для добавления "use utf8;" в каждую компоненту.

package Mason::Plugin::UTF8::Compilation;
use Mason::PluginRole;
override 'output_class_header' => sub {
    return(super() . 'use utf8;');
};

1;