Merge pull request #850 from niccokunzmann/issue-836

Remove quotes from safe characters

Author: niccokunzmann

CHANGES.rst

@@ -7,42 +7,42 @@ We use `Semantic Versioning <https://semver.org>`_.
 - New features increase the **minor** version number.
 - Minor changes and bug fixes increase the **patch** version number.
 
-6.3.0 (2025-05-15)
+6.3.1 (unreleased)
 ------------------
 
 Minor changes:
 
-- Deprecate ``icalendar.UIDGenerator``. See `Issue 816 <https://github.com/collective/icalendar/issues/816>`_.
+- ...
+
+Breaking changes:
+
+- ...
 
 New features:
 
-- Add the ``uid`` property to ``Alarm``, ``Event``, ``Calendar``, ``Todo``, and ``Journal`` components. See `Issue 740 <https://github.com/collective/icalendar/issues/740>`_.
+- ...
 
 Bug fixes:
 
-- Fix component equality where timezones differ for the datetimes but the times are actually equal. See `Issue 828 <https://github.com/collective/icalendar/issues/828>`_.
-- Test that we can add an RRULE as a string. See `Issue 301 <https://github.com/collective/icalendar/issues/301>`_.
-- Test that we support dateutil timezones as outlined in `Issue 336 <https://github.com/collective/icalendar/issues/336>`_.
-- Build documentation on Read the Docs with the version identifier. See `Issue 826 <https://github.com/collective/icalendar/issues/826>`_.
+- Remove forced quoting from parameters with space and single quote. See `Issue 836 <https://github.com/collective/icalendar/issues/836>`_.
 
-6.3.1 (unreleased)
+6.3.0 (2025-05-15)
 ------------------
 
 Minor changes:
 
-- ...
-
-Breaking changes:
-
-- ...
+- Deprecate ``icalendar.UIDGenerator``. See `Issue 816 <https://github.com/collective/icalendar/issues/816>`_.
 
 New features:
 
-- ...
+- Add the ``uid`` property to ``Alarm``, ``Event``, ``Calendar``, ``Todo``, and ``Journal`` components. See `Issue 740 <https://github.com/collective/icalendar/issues/740>`_.
 
 Bug fixes:
 
-- ...
+- Fix component equality where timezones differ for the datetimes but the times are actually equal. See `Issue 828 <https://github.com/collective/icalendar/issues/828>`_.
+- Test that we can add an RRULE as a string. See `Issue 301 <https://github.com/collective/icalendar/issues/301>`_.
+- Test that we support dateutil timezones as outlined in `Issue 336 <https://github.com/collective/icalendar/issues/336>`_.
+- Build documentation on Read the Docs with the version identifier. See `Issue 826 <https://github.com/collective/icalendar/issues/826>`_.
 
 6.2.0 (2025-05-07)
 ------------------

src/icalendar/parser.py

@@ -129,7 +129,7 @@ def validate_param_value(value, quoted=True):
 
 # chars presence of which in parameter value will be cause the value
 # to be enclosed in double-quotes
-QUOTABLE = re.compile("[,;: ’']")
+QUOTABLE = re.compile("[,;:’]")
 
 
 def dquote(val, always_quote=False):
@@ -184,7 +184,15 @@ class Parameters(CaselessDict):
         "DIR",
         "MEMBER",
         "SENT-BY",
+        # Part of X-APPLE-STRUCTURED-LOCATION
+        "X-ADDRESS",
+        "X-TITLE",
     )
+    # this is quoted should one of the values be present
+    quote_also = {
+        # This is escaped in the RFC
+        "CN" : " '",
+    }
 
     def params(self):
         """In RFC 5545 keys are called parameters, so this is to be consitent
@@ -219,7 +227,14 @@ def to_ical(self, sorted=True):
 
         for key, value in items:
             upper_key = key.upper()
-            quoted_value = param_value(value, always_quote=upper_key in self.always_quoted)
+            check_quoteable_characters = self.quote_also.get(key.upper())
+            always_quote = (
+                upper_key in self.always_quoted or (
+                    check_quoteable_characters and
+                    any(c in value for c in check_quoteable_characters)
+                )
+            )
+            quoted_value = param_value(value, always_quote=always_quote)
             if isinstance(quoted_value, str):
                 quoted_value = quoted_value.encode(DEFAULT_ENCODING)
             # CaselessDict keys are always unicode

src/icalendar/tests/calendars/issue_836_do_not_quote_tzid.ics

@@ -0,0 +1,27 @@
+BEGIN:VCALENDAR
+METHOD:PUBLISH
+PRODID:Microsoft Exchange Server 2010
+VERSION:2.0
+BEGIN:VTIMEZONE
+TZID:Eastern Standard Time
+BEGIN:STANDARD
+DTSTART:16010101T020000
+TZOFFSETFROM:-0400
+TZOFFSETTO:-0500
+RRULE:FREQ=YEARLY;INTERVAL=1;BYDAY=1SU;BYMONTH=11
+END:STANDARD
+BEGIN:DAYLIGHT
+DTSTART:16010101T020000
+TZOFFSETFROM:-0500
+TZOFFSETTO:-0400
+RRULE:FREQ=YEARLY;INTERVAL=1;BYDAY=2SU;BYMONTH=3
+END:DAYLIGHT
+END:VTIMEZONE
+BEGIN:VEVENT
+UID:[email protected]
+SUMMARY:Anonymous Test Event for TZID
+DTSTART;TZID=Eastern Standard Time:20241028T170000
+DTEND;TZID=Eastern Standard Time:20241028T180000
+DTSTAMP:20250514T023916Z
+END:VEVENT
+END:VCALENDAR

src/icalendar/tests/test_issue_836_do_not_quote_tzid.py

@@ -0,0 +1,80 @@
+"""Quoting the TZID parameter creates compatibility problems.
+
+See https://github.com/collective/icalendar/issues/836
+
+:rfc:`5545`:
+
+.. code-block:: text
+
+    param-value   = paramtext / quoted-string
+    paramtext     = *SAFE-CHAR
+    quoted-string = DQUOTE *QSAFE-CHAR DQUOTE
+    SAFE-CHAR     = WSP / %x21 / %x23-2B / %x2D-39 / %x3C-7E
+                   / NON-US-ASCII
+     ; Any character except CONTROL, DQUOTE, ";", ":", ","
+     NON-US-ASCII  = UTF8-2 / UTF8-3 / UTF8-4
+     ; UTF8-2, UTF8-3, and UTF8-4 are defined in [RFC3629]
+
+"""
+from datetime import datetime, time
+from icalendar import Event, Parameters, vDDDTypes, vDatetime, vPeriod, vTime
+import pytest
+
+from icalendar.prop import vDDDLists
+
+# All the controls except HTAB
+CONTROL = {
+    i for i in range(256) if 0x00 <= i <= 0x08 or 0x0A <= i <= 0x1F or i == 0x7F
+}
+
+# Any character except CONTROL, DQUOTE, ";", ":", ","
+SAFE_CHAR = set(range(256)) - CONTROL - set(b'";:,')
+
+param_tzid = pytest.mark.parametrize(
+    "tzid",
+    [
+        "Europe/London",
+        "Eastern Standard Time",
+    ]
+)
+
+@param_tzid
+@pytest.mark.parametrize(
+    "vdt",
+    [
+        vDatetime(datetime(2024, 10, 11, 12, 0)),
+        vTime(time(23, 59, 59)),
+        vDDDTypes(datetime(2024, 10, 11, 12, 0)),
+        vPeriod((datetime(2024, 10, 11, 12, 0), datetime(2024, 10, 11, 13, 0))),
+        vDDDLists([datetime(2024, 10, 11, 12, 0)]),
+    ]
+)
+def test_parameter_is_not_quoted_when_not_needed(tzid, vdt):
+    """Check that serializing the value works without quoting."""
+    e = Event()
+    vdt.params["TZID"] = tzid
+    e["DTSTART"] = vdt
+    ics = e.to_ical().decode()
+    print(ics)
+    assert tzid in ics
+    assert f'"{tzid}' not in ics
+    assert f'{tzid}"' not in ics
+
+
+@pytest.mark.parametrize(
+    "safe_char",
+    list(map(chr, sorted(SAFE_CHAR)))
+)
+def test_safe_char_is_not_escaped(safe_char):
+    """Check that paramerter serialization is without quotes for safe chars."""
+    params = Parameters(tzid=safe_char)
+    result = params.to_ical().decode()
+    assert '"'  not in result
+
+
+def test_get_calendar_and_serialize_it_wihtout_quotes(calendars):
+    """The example calendar should not contain the timezone with quotes."""
+    ics = calendars.issue_836_do_not_quote_tzid.to_ical().decode()
+    assert '"Eastern Standard' not in ics
+    assert 'Standard Time"' not in ics
+    assert "Eastern Standard Time" in ics