iCalendar RFC 2445第4.1节内容折叠

时间:2012-10-24 18:18:46

标签: c# string icalendar rfc5545 rfc2445

我正在使用C#创建一个简单的iCalendar,并发现RFC 2445第4.1节中的内容折叠非常令人头疼(对我而言: - )。

http://www.apps.ietf.org/rfc/rfc2445.html#sec-4.1

对于长行,你要逃避一些字符(反斜杠,分号,逗号和换行符,我相信)然后折叠它以便没有行超过75个八位字节。我在网上找到了几种直接的方法。最简单的方法是使用转义版本替换有问题的字符,然后在每第75个字符处插入CRLF。类似的东西:

// too simple, could break at an escape sequence boundary or multi-byte character may overflow 75 octets
txt = txt.Replace(@"\", "\\\\").Replace(";", "\\;").Replace(",", "\\,").Replace("\r\n", "\\n");
var regex = new System.Text.RegularExpressions.Regex( ".{75}");
var escape_and_folded = regex.Replace( txt, "$0\r\n ");

我看到两个问题。 CRLF可能会插入到转义序列中。例如,如果发生插入,使得转义的新行序列“\ n”变为“\ CRLF”(则“n”将在下一行)。第二个问题是存在多字节字符时。由于计算是按字符计算的,因此该行可能会超过75个八位字节。

一个简单的解决方案是逐个字符地走字符串并进行转义和折叠,但这似乎是相当暴力的。有人有更优雅的解决方案吗?

3 个答案:

答案 0 :(得分:2)

首先,请务必查看RFC5545。 RFC2445已过时。 你可以在这里找到我的PHP实现:

https://github.com/fruux/sabre-vobject/blob/master/lib/Property.php#L252

在php中我们有mb_strcut函数。我不确定是否有.NET等价物,但这至少会让事情变得更简单。到目前为止,折叠转义序列(\)到目前为止我没有任何问题。一个好的解析器将首先展开这些行,然后才处理unescaping。特别是因为必须转义哪些字符,取决于实际属性。 (有时,;会被转义,有时则不会转义。

答案 1 :(得分:1)

我尝试了你的解决方案 - 它的工作原理除了它还折叠了一些长度小于75个八位字节的线。因此,我传统上重写了代码(即不使用正则表达式 - 我确实想念它们),如下所示。

    public static string FoldLines(this string value, int max, string newline = "\r\n")
    {
        var lines = value.Split(new string[]{newline}, System.StringSplitOptions.RemoveEmptyEntries);
        using (var ms = new System.IO.MemoryStream(value.Length))
        {
            var crlf = Encoding.UTF8.GetBytes(newline); //CRLF
            var crlfs = Encoding.UTF8.GetBytes(string.Format("{0} ", newline)); //CRLF and SPACE
            foreach (var line in lines)
            {
                var bytes = Encoding.UTF8.GetBytes(line);
                var len = Encoding.UTF8.GetByteCount(line);
                if (len <= max)
                {
                    ms.Write(bytes, 0, len);
                    ms.Write(crlf, 0, crlf.Length); 
                }
                else
                {
                    var blen = len / max; //calculate block length
                    var rlen = len % max; //calculate remaining length
                    var b = 0;
                    while (b < blen)
                    {
                        ms.Write(bytes, (b++) * max, max);
                        ms.Write(crlfs, 0, crlfs.Length); 
                    }
                    if (rlen > 0)
                    {
                        ms.Write(bytes, blen * max, rlen);
                        ms.Write(crlf, 0, crlf.Length);
                    }
                }
            }

            return Encoding.UTF8.GetString(ms.ToArray());
        }
    }

备注

  1. 我尽可能地尝试优雅 - 即我没有按字符串解析字符串,而是以八位字节为单位(由 max 确定)。
  2. 最好在生成的VCALENDAR对象上调用该函数,以便检查所有内容行是否折叠并在必要时进行包装。
  3. 仅在与描述,摘要等相关的TEXT相关属性中执行特殊文字的转义。这些在以下扩展方法中实现:

    public static string Replace(this string value, IEnumerable<Tuple<string, string>> pairs)
    {
        foreach (var pair in pairs) value = value.Replace(pair.Item1, pair.Item2);
        return value;
    }
    
    public static string EscapeStrings(this string value)
    {
        return value.Replace(new List<Tuple<string, string>> 
        { 
            new Tuple<string, string>(@"\", "\\\\"),
            new Tuple<string, string>(";",  @"\;"),
            new Tuple<string, string>(",",  @"\,"),
            new Tuple<string, string>("\r\n",  @"\n"),
        });
    }
    

答案 2 :(得分:0)

reexmonkey的解决方案在中间折叠的行上写入76个字符,因为它不会减去添加了crlfs的额外空格字符

我重写了折叠功能以纠正这个问题:

public static string FoldLines(string value, int max, string newline = "\r\n")
{
    var lines = value.Split(new string[] { newline }, System.StringSplitOptions.RemoveEmptyEntries);
    using (var ms = new System.IO.MemoryStream(value.Length))
    {
        var crlf = Encoding.UTF8.GetBytes(newline); //CRLF
        var crlfs = Encoding.UTF8.GetBytes(string.Format("{0} ", newline)); //CRLF and SPACE
        foreach (var line in lines)
        {
            var bytes = Encoding.UTF8.GetBytes(line);
            var len = Encoding.UTF8.GetByteCount(line);
            if (len <= max)
            {
                ms.Write(bytes, 0, len);
                ms.Write(crlf, 0, crlf.Length);
            }
            else
            {
                var offset = 0; //current offset position
                var count = max; //characters to take
                while (offset + count < len)
                {
                    ms.Write(bytes, offset, count);
                    ms.Write(crlfs, 0, crlfs.Length);
                    offset += count;
                    count = max - 1;
                }
                count = len - offset; //remaining characters
                if (count > 0)
                {
                    ms.Write(bytes, offset, count);
                    ms.Write(crlf, 0, crlf.Length);
                }
            }
        }

        return Encoding.UTF8.GetString(ms.ToArray());
    }
}

我还在EscapeStrings函数中添加了一个额外的元组:

public static string ReplaceText(string value, IEnumerable<Tuple<string, string>> pairs)
{
    foreach (var pair in pairs) value = value.Replace(pair.Item1, pair.Item2);
    return value;
}
public static string EscapeStrings(string value)
{
    return ReplaceText(value, new List <Tuple<string, string>>
    {
        new Tuple<string, string>(@"\", "\\\\"),
        new Tuple<string, string>(";",  @"\;"),
        new Tuple<string, string>(",",  @"\,"),
        new Tuple<string, string>("\r\n",  @"\n"),
        new Tuple<string, string>("\n",  @"\n"),
    });
}