如何让Mason2 UTF-8干净?

时间:2011-05-02 14:47:07

标签: perl utf-8 moose mason plack

重新提出问题,因为

评论:这个问题已经获得了“流行的问题徽章”,所以可能我不是唯一没有希望的人。 :)

不幸的是,演示完整的问题堆栈导致了一个非常长的问题,而且非常Mason具体。

首先,只有意见的部分:)

我正在使用HTML :: Mason多年,现在尝试使用Mason2。 PoetMason 是CPAN中最先进的框架。 没有发现任何比较,开箱即用的东西允许写得如此干净/但非常黑客:)/ web-apps, 包括许多电池(记录,缓存,配置管理,基于原生PGSI等...)

不幸的是,作者并不关心其余部分, 例如默认情况下,它只是基于ascii, 没有任何手册,常见问题解答或建议:如何将其与unicode一起使用

现在的事实。演示。创建一个诗人应用程序:

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:5000/xls/hello.xlsx,您将获得:

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

点击download hello.xlsx,您将在下载中获得hello.xlsx

以上阐述了第一个问题, 例如组件的来源不在use utf8;的“下方”, 所以lc不理解字符。

第二个问题如下,试试吧 [http://0:5000/xls/hélló.xlsx],或 http://0:5000/xls/h%C3%A9ll%C3%B3.xlsx 你会看到:

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

当然,输入(path_info)没有被解码,脚本使用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代码中的 读取:不在边界)会导致spagethy代码。

编码/解码应该在某处处清楚地完成 Poet / Mason边界 - 当然,Plack在字节级别上运行。


部分解决方案。

幸运的是,Poet巧妙地允许修改它(和梅森的)部分,所以, 在$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年的原始问题)仍然不知道:(如何正确使用Mason2应用程序中的unicode,但仍然没有存在任何关于它的文档或帮助。:(

主要问题是: - 其中(Moose方法修饰符应修改哪些方法)以及如何正确解码输入和输出位置(在Poet / Mason应用程序中)

  • 但只有文字的,例如text/plaintext/html等......
  • a做上述“惊喜免费” - 例如什么会简单的工作。 ;)

有人可以请求真正的代码 - 我应该在上面修改什么?

3 个答案:

答案 0 :(得分:4)

Mason2手册介绍了component inheritance的工作方式,所以我认为将这个通用代码放在 Base.mp组件中(其他所有继承)可能会解决您的问题

Mason::Manual::Plugins

中描述了创建插件

因此,您可以构建自己的修改Mason::Request的插件,并通过覆盖request_args(),您可以返回UTF-8解码参数。

编辑:

关于UTF-8输出,您可以添加Apache directive以确保text / plain和text / HTML输出始终被解释为UTF-8:

AddDefaultCharset utf-8

答案 1 :(得分:1)

在mason-users邮件列表中有一个关于为

处理UTF-8的问题
  1. 使用UTF-8输出的组件
  2. 处理UTF-8 GET / POST参数
  3. 这是Jon的回答:

      

    我希望Mason能够智能地处理编码,但是因为我没有   定期与utf8合作,你和其他人将不得不帮助我   设计。

         

    这应该是一个插件,例如梅森::插件:: 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核心中需要的东西可以使这更容易。

    恕我直言,还需要添加以下内容,添加“use utf8;”进入每个组成部分。

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

答案 2 :(得分:1)

好的,我已经用Firefox测试了这个。 HTML正确显示UTF-8并单独保留zip,因此应该可以在任何地方使用。

如果您从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;