在 Win32 Perl 中使用 XML::Twig 字符串损坏和不可打印字符

Question

这真是一个奇怪的问题。我几乎花了一整天的时间才将其缩减为一个完整演示问题的小型可执行脚本。

问题总结： 我在用着 XML::树枝 从 XML 文件中提取数据片段，然后将该数据片段粘贴到另一条数据的中间，我们将其称为父数据。当我开始时，父数据的开头有一个奇怪的不可打印字符。它是供应商提供的数据，所以我无法控制它。我的问题是，当我将数据片段粘贴到父数据的中间后，最终产品有一个 新的 除了最初开始的字符之外，其开头还包含不可打印的字符。这个新的不可打印字符既不在父数据中，也不在子数据片段中。我不知道它从哪里来，也不知道它是如何进入我的数据的。

我怀疑这是一个 XML::Twig 错误，因为在 while 循环中从文件句柄读取一行时发生字符串损坏，但是当我删除中的 XML::Twig 代码时，我未能成功地重现我的问题我的脚本，所以我不得不把它留在里面。

这是我第一次尝试处理字符串中的不可打印字符。我是否需要做一些特殊的事情，而不是将它们视为普通的字符串或其他东西？

我在 Windows XP 上使用 ActiveState Perl 5.10.1 和 XML::Twig 3.32（最新）以及 Eclipse 3.5.1 IDE。

这是一个演示该问题的脚本：

use strict; 
use warnings; 
use XML::Twig; 

my $FALSE = 0;
my $TRUE = 1;
my $name = 'KurtsProgram';
my $task = 'MainTask';
my $hidden_char = "\xBF";
my $data = $hidden_char . 
'(*********************************************
  Data-File-Header-Junk
**********************************************)

    PROGRAM MainProgram ()
    END_PROGRAM

    TASK SecondaryTask ()
    END_TASK

    TASK MainTask ()
        MainProgram;
    END_TASK
';
my $new_data = insertProgram( $name, $task, $data );

# test to see if results start out as expected
if ( $new_data =~ m/^\Q$hidden_char\E/ ) {
    print "SUCCESS\n";
}
else {
    print STDERR "ERROR: What happened?\n";
    print STDERR "ORIGINAL: \n$data\n";
    print STDERR "MODIFIED: \n$new_data\n";
}

sub insertProgram {
    my ( $local_name, $local_task, $local_data ) = @_;

    # get program section from XML template
    my $twig = new XML::Twig;
    $twig->parse( '<?xml version="1.0"?>
<TemplateSet>
    <PROGRAM>PROGRAM <Name>ProgramNameGoesHere</Name> ()
    END_PROGRAM</PROGRAM>
    <TASK>TASK <Name>TaskNameGoesHere</Name> ()
    END_TASK</TASK>
</TemplateSet>
' );   
    my $program = $twig->root->first_child('PROGRAM');

    # replace program name in XML template
    $program->first_child('Name')->set_text($local_name);
    my $insert = $program->text();

    # stick modified program into data
    if ( $local_data =~ s/(\s+PROGRAM\s+[^\s]+\s+\()/\n\n    $insert $1/ ) {
        # found it and inserted new program
    }
    else {
        # not found
        return;
    }

    # add program name to task list
    my $added_program_to_task = $FALSE;
    my $found_start = $FALSE;
    my $found_end = $FALSE;
    my $new_data = "";
    # open string as a filehandle for line by line processing
    my $filehandle;
    open( $filehandle, '<', \$local_data )
        or die("Can't open string as a filehandle: $!");
    while (defined (my $line = <$filehandle>)) {
        # look for start of our task
        if ( 
               ( !$found_start ) &&
               ( $line =~ m/\s+TASK\s+\Q$local_task\E\s+\(/ )
            ) {
            # found the task!
            $found_start = $TRUE;
        }

        # look for end of our task
        if (
                ( $found_start ) && ( !$found_end ) &&
                ( $line =~ m/\s+END_TASK/ )
            )
        {
            # found the end tag for the task section!
            $found_end = $TRUE;

            # add the program name to the bottom of the list
            $line = "        " . $local_name . ";\n" . $line;
            $added_program_to_task = $TRUE;
        }

        # compile new data from processed line or original line
        $new_data = $new_data . $line;
    }
    close($filehandle);

    if ($added_program_to_task) {
        # success
    }
    else {
        # unable to find task
        return;
    }

    return $new_data;
}

当我运行此脚本时，我得到以下输出：

ERROR: What happened?
ORIGINAL: 
¿(*********************************************
      Data-File-Header-Junk
    **********************************************)

        PROGRAM MainProgram ()
        END_PROGRAM

        TASK SecondaryTask ()
        END_TASK

        TASK MainTask ()
            MainProgram;
        END_TASK

MODIFIED: 
¿(*********************************************
      Data-File-Header-Junk
    **********************************************)

        PROGRAM KurtsProgram ()
        END_PROGRAM 

        PROGRAM MainProgram ()
        END_PROGRAM

        TASK SecondaryTask ()
        END_TASK

        TASK MainTask ()
            MainProgram;
            KurtsProgram;
        END_TASK

您可以在 MODIFIED 中的 M 下方看到添加到数据前面的额外字符。

Answer 1

它对字符进行了 ISO-8859-1 到 UTF-8 编码转换： \xBF -> \xC2\xBF.

XML::Twig 将其所有输入转换为 UTF-8 (看这里).

您可以告诉 Twig 使用以下命令保留输入编码 keep_encoding 选项（另请参阅 XML::Twig 常见问题解答： 我的 XML 文档/数据是由不支持 Unicode 的工具生成的，XML::Twig 能帮助我吗？).

但也许保留 UTF-8 会更好，或者默默地删除该字符，具体取决于您要如何处理它。

Answer 2

我无法真正理解你的代码，它仍然太复杂而无法快速调试，但也许问题与 BOM 有关（请参阅 Unicode BOM 常见问题解答）在 XML 文档的开头会被忽略，但如果将其复制到另一个文档的中间则不会？只是在这里猜测，因为 xBF 值是 UTF-8 文档的 BOM 的一部分。