PyPtt 2.1.5__tar.gz → 2.1.7__tar.gz

{pyptt-2.1.5 → pyptt-2.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 2.1.5
+Version: 2.1.7
 Summary: PyPtt github: https://github.com/PyPtt/PyPtt
 Author-email: CodingMan <pttcodingman@gmail.com>
 License: GNU Lesser General Public License v3 (LGPLv3)

{pyptt-2.1.5 → pyptt-2.1.7}/PyPtt/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.1.5'
+__version__ = '2.1.7'
 __author__ = 'CodingMan'
 __email__ = 'pttcodingman@gmail.com'
 

{pyptt-2.1.5 → pyptt-2.1.7}/PyPtt/_api_del_post.py

@@ -17,6 +17,45 @@ from . import screens
 # character), not in Python characters.
 _BAD_POST_REASON_MAX_BYTES = 50
 
+# --- del_post's `reason` field (annotates the title shown after a
+# moderator deletes another user's post) ---
+#
+# pttbbs pre-fills this prompt with "(已被<moderator id>刪除) <author id>"
+# (pttbbs mbbsd/bbs.c, del_post()'s SAFE_ARTICLE_DELETE branch) in a
+# `char reason[PROPER_TITLE_LEN]` buffer; PROPER_TITLE_LEN is 42
+# (pttbbs include/common.h), so the whole title -- prefix *and* PyPtt's
+# reason together -- is capped at 41 Big5 bytes, not python characters.
+# PyPtt answers the prompt with Ctrl-E (jump to the end of the prefilled
+# text) plus a leading space plus `reason`, so the byte budget actually
+# left for `reason` depends on how long the moderator's and the post
+# author's PTT IDs are -- there is no single safe constant independent of
+# who is deleting what, unlike bad_post_reason above.
+#
+# Verified live against a local pttbbs (bbsdocker/imageptt rebuilt with
+# SAFE_ARTICLE_DELETE enabled -- the stock image ships with that feature
+# #define'd out and never offers this prompt at all):
+#   - exactly at the budget: reason is accepted in full, title not
+#     truncated.
+#   - 1 byte over budget, ASCII-only overflow: pttbbs silently truncates
+#     to fit (title is just missing the last character).
+#   - 1 byte over budget, where the overflow splits a double-byte Big5
+#     glyph in half: pttbbs's line editor corrupts and del_post() hangs
+#     until connect_core's screen_timeout, returning neither success nor
+#     a clean failure -- this is the "刪文失敗" a caller with a too-long
+#     reason actually experiences.
+# PyPtt must reject before sending in both cases.
+_REASON_TITLE_BUFFER_BYTES = 41  # PROPER_TITLE_LEN(42) - 1 byte reserved for the NUL terminator
+_REASON_PREFIX_FIXED_BYTES = 13  # Big5 bytes of "(已被刪除) <>", the literal part of "(已被%s刪除) <%s>"
+# A rough, moderator/author-id-independent ceiling: the most bytes `reason`
+# could ever fit under, i.e. the budget if both PTT ids were the shortest
+# possible (1 byte each). Real ids can only be longer than that, which only
+# shrinks the true budget further -- so a reason within this ceiling is not
+# guaranteed to fit any *particular* id pair, but a reason over it can never
+# fit *any* id pair. That asymmetry is what makes it safe to use as an
+# early, id-independent guard: it will never reject a reason that might be
+# legal once we know the real ids (checked later by _check_reason_budget).
+_REASON_MAX_POSSIBLE_BYTES = _REASON_TITLE_BUFFER_BYTES - _REASON_PREFIX_FIXED_BYTES - 1 - 1 - 1
+
 
 def _check_no_control_chars(name: str, value: str) -> None:
     """Terminal command injection guard: none of PyPtt's del_post text
@@ -40,6 +79,55 @@ def _check_bad_post_reason(bad_post_reason: str) -> None:
             f'bad_post_reason must not exceed {_BAD_POST_REASON_MAX_BYTES} bytes')
 
 
+def _check_reason(reason: str) -> None:
+    """Early, post_info-independent guard for `reason`: control chars,
+    Big5-encodability, and a rough length ceiling that can never fit any
+    moderator/author id pair (_REASON_MAX_POSSIBLE_BYTES). This alone does
+    NOT guarantee `reason` fits the *actual* ids involved -- that exact,
+    id-dependent budget is enforced later by _check_reason_budget, once
+    post_info is available. Keeping this one id-independent lets del_post()
+    reject an obviously-broken reason (control chars, non-Big5, absurdly
+    long) the same way regardless of whether the target post still exists."""
+    _check_no_control_chars('reason', reason)
+    try:
+        encoded = reason.encode('big5uao')
+    except UnicodeEncodeError as e:
+        raise exceptions.ParameterError(
+            f'reason contains a character that cannot be encoded in Big5: {e}') from e
+    if len(encoded) > _REASON_MAX_POSSIBLE_BYTES:
+        raise exceptions.ParameterError(
+            f'reason must not exceed {_REASON_MAX_POSSIBLE_BYTES} bytes '
+            f'(pttbbs caps the deleted-post title at {_REASON_TITLE_BUFFER_BYTES} bytes total; '
+            f'{_REASON_MAX_POSSIBLE_BYTES} bytes is the most any reason could ever fit, for the '
+            f'shortest possible moderator/author PTT ids -- the actual limit for this delete may '
+            f'be smaller)')
+
+
+def _check_reason_budget(reason: str, moderator_id: str, author_id: str) -> None:
+    """Exact, post_info-dependent guard for `reason`: pttbbs pre-fills the
+    delete-title prompt with "(已被<moderator_id>刪除) <author_id>" inside the
+    fixed-size buffer described above, so the byte budget actually left for
+    `reason` depends on the two real PTT IDs involved in this delete --
+    unlike _check_bad_post_reason, this can't be a plain module-level
+    constant. Call this once post_info is available (see del_post());
+    _check_reason above already covers the id-independent checks (control
+    chars, Big5-encodability) so this only needs to re-derive the byte
+    count for the length comparison."""
+    try:
+        encoded = reason.encode('big5uao')
+    except UnicodeEncodeError as e:
+        raise exceptions.ParameterError(
+            f'reason contains a character that cannot be encoded in Big5: {e}') from e
+    prefix_bytes = _REASON_PREFIX_FIXED_BYTES + len(moderator_id) + len(author_id)
+    # -1 for the leading space PyPtt sends before reason (see del_post()).
+    max_reason_bytes = max(0, _REASON_TITLE_BUFFER_BYTES - prefix_bytes - 1)
+    if len(encoded) > max_reason_bytes:
+        raise exceptions.ParameterError(
+            f'reason must not exceed {max_reason_bytes} bytes for this moderator/author pair '
+            f'(pttbbs caps the deleted-post title at {_REASON_TITLE_BUFFER_BYTES} bytes total, '
+            f'and the prefix "(已被{moderator_id}刪除) <{author_id}>" already uses {prefix_bytes} of them)')
+
+
 def del_post(api, board: str, post_aid: Optional[str] = None, post_index: int = 0, reason: Optional[str] = None,
              bad_post_type: Optional[data_type.BadPostType] = None,
              bad_post_reason: Optional[str] = None) -> None:
@@ -74,9 +162,17 @@ def del_post(api, board: str, post_aid: Optional[str] = None, post_index: int =
     # --- Pure parameter validation (doesn't need post_info) happens here,
     # before the "already deleted" early-return below -- an invalid
     # combination of parameters must always fail the same way, regardless of
-    # whether the post happens to already be gone. ---
+    # whether the post happens to already be gone. `reason` is checked in
+    # two stages for this reason: _check_reason here covers everything that
+    # doesn't depend on state (control chars, Big5-encodability, and a
+    # rough ceiling no id pair could ever exceed), so those failures are
+    # always reported the same way; the *exact* budget depends on the
+    # moderator's and the post author's real PTT IDs, so that part
+    # (_check_reason_budget) has to wait until post_info is available below
+    # -- alongside the other post_info-dependent reason check ("reason is
+    # only valid when...") a few lines down. ---
     if reason is not None:
-        _check_no_control_chars('reason', reason)
+        _check_reason(reason)
 
     if bad_post_type == data_type.BadPostType.OTHER:
         if not bad_post_reason:
@@ -132,6 +228,15 @@ def del_post(api, board: str, post_aid: Optional[str] = None, post_index: int =
             log.logger.info(i18n.delete_post, '...', i18n.fail)
             raise exceptions.NoPermission(i18n.no_permission)
 
+    # Reaching here with reason still set means: not self-authored (checked
+    # above) and permitted (the check_author gate above didn't raise) --
+    # i.e. exactly the "moderator deleting someone else's post" case where
+    # PTT will actually offer the R加註理由 prompt. Validate reason's exact
+    # byte budget now, using the real moderator/author id pair, before any
+    # of the interactive delete flow below is sent.
+    if reason:
+        _check_reason_budget(reason, api.ptt_id, post_info[data_type.PostField.author])
+
     _api_util.goto_board(api, board)
 
     cmd_list = []

{pyptt-2.1.5 → pyptt-2.1.7}/PyPtt/_api_get_newest_index.py

@@ -65,6 +65,7 @@ def get_newest_index(api, index_type: data_type.NewIndex, board: Optional[str] =
         search_list = []
     else:
         check_value.check_type(search_list, list, 'search_list')
+        search_list = list(search_list)  # 別就地改到呼叫端傳進來的 list
 
     if (search_type, search_condition) != (None, None):
         search_list.insert(0, (search_type, search_condition))

{pyptt-2.1.5 → pyptt-2.1.7}/PyPtt/_api_get_post.py

@@ -39,6 +39,7 @@ def get_post(api, board: str, aid: Optional[str] = None, index: Optional[int] =
         search_list = []
     else:
         check_value.check_type(search_list, list, 'search_list')
+        search_list = list(search_list)  # 別就地改到呼叫端傳進來的 list
 
     if (search_type, search_condition) != (None, None):
         search_list.insert(0, (search_type, search_condition))

{pyptt-2.1.5 → pyptt-2.1.7}/PyPtt/_api_mail.py

@@ -146,6 +146,21 @@ def get_mail(api, index: int, search_type: Optional[data_type.SearchType] = None
     cmd_list.append(command.ctrl_z)
     cmd_list.append('m')
 
+    # search_type/search_condition 併入 search_list（比照 get_post），
+    # 否則單獨使用 search_type 搜尋會被忽略。
+    if search_list is None:
+        search_list = []
+    else:
+        check_value.check_type(search_list, list, 'search_list')
+        search_list = list(search_list)  # 別就地改到呼叫端傳進來的 list
+
+    if (search_type, search_condition) != (None, None):
+        search_list.insert(0, (search_type, search_condition))
+
+    for search_type, search_condition in search_list:
+        check_value.check_type(search_type, data_type.SearchType, 'search_type')
+        check_value.check_type(search_condition, str, 'search_condition')
+
     # 處理條件整理出指令
     _cmd_list = _api_util.get_search_condition_cmd(data_type.NewIndex.MAIL, search_list)
 

pyptt-2.1.7/PyPtt/ssl_config.py

@@ -0,0 +1,24 @@
+key = """-----BEGIN EC PARAMETERS-----
+BggqhkjOPQMBBw==
+-----END EC PARAMETERS-----
+-----BEGIN EC PRIVATE KEY-----
+MHcCAQEEIBl6n84gGhyoI6rh8jsDM6+MvbtX++1SctY8mkfAU/PqoAoGCCqGSM49
+AwEHoUQDQgAEKrKMWokWd4Y6dFHFFr4pg9h340NKkekdCrYbxv1l2SUBUDkXUx28
+fGqtXxYCuOsEQTeQrm0OmCq6U+aRXMvwaQ==
+-----END EC PRIVATE KEY-----
+"""
+
+cert = """-----BEGIN CERTIFICATE-----
+MIIB6DCCAY8CFEXMlgDToWo6s00YgTOitW0BgNCdMAoGCCqGSM49BAMCMHcxCzAJ
+BgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0eTEVMBMGA1UE
+CgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25hbCBVbml0MRQw
+EgYDVQQDDAtDb21tb24gTmFtZTAeFw0yNjA3MTgwNDE0NTZaFw0zNjA3MTUwNDE0
+NTZaMHcxCzAJBgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0
+eTEVMBMGA1UECgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25h
+bCBVbml0MRQwEgYDVQQDDAtDb21tb24gTmFtZTBZMBMGByqGSM49AgEGCCqGSM49
+AwEHA0IABCqyjFqJFneGOnRRxRa+KYPYd+NDSpHpHQq2G8b9ZdklAVA5F1MdvHxq
+rV8WArjrBEE3kK5tDpgqulPmkVzL8GkwCgYIKoZIzj0EAwIDRwAwRAIgcfQdHGfL
+m1j+zvm23ToVfbfGdlvcR4hXBQkWMQslAkICIEccC2jqieHYgaLRUgzoUVI/twm3
+5uAjX0ZWPxTPuNvA
+-----END CERTIFICATE-----
+"""

{pyptt-2.1.5 → pyptt-2.1.7}/PyPtt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 2.1.5
+Version: 2.1.7
 Summary: PyPtt github: https://github.com/PyPtt/PyPtt
 Author-email: CodingMan <pttcodingman@gmail.com>
 License: GNU Lesser General Public License v3 (LGPLv3)

{pyptt-2.1.5 → pyptt-2.1.7}/PyPtt.egg-info/SOURCES.txt

@@ -54,6 +54,7 @@ tests/test_bucket.py
 tests/test_change_pw.py
 tests/test_comment.py
 tests/test_del_post.py
+tests/test_del_post_unit.py
 tests/test_exceptions.py
 tests/test_fast_post.py
 tests/test_get_board_info.py

pyptt-2.1.7/tests/test_del_post_unit.py

@@ -0,0 +1,78 @@
+"""
+No-network unit tests for the pure validation helpers in _api_del_post.py.
+These call the module functions directly and don't need a live PTT session.
+"""
+import pytest
+
+import PyPtt
+from PyPtt import _api_del_post
+
+
+class TestCheckBadPostReason:
+    def test_within_limit_ok(self):
+        _api_del_post._check_bad_post_reason('測' * 25)  # 50 bytes, exactly at the limit
+
+    def test_over_limit_raises(self):
+        with pytest.raises(PyPtt.exceptions.ParameterError):
+            _api_del_post._check_bad_post_reason('測' * 25 + 'x')  # 51 bytes
+
+    def test_control_char_raises(self):
+        with pytest.raises(PyPtt.exceptions.ParameterError):
+            _api_del_post._check_bad_post_reason('bad\x07reason')
+
+
+class TestCheckReasonStatic:
+    """`_check_reason` is the early, post_info-independent guard: control
+    chars, Big5-encodability, and a rough ceiling (_REASON_MAX_POSSIBLE_BYTES
+    == 41 - 13 - 1 - 1 - 1 == 25 bytes) that assumes the shortest possible
+    (1-byte) moderator/author PTT ids -- the most bytes a reason could ever
+    fit under any real id pair. It therefore never rejects a reason that
+    might be legal once the real ids are known; that exact, smaller,
+    id-dependent budget is _check_reason_budget's job (see below)."""
+
+    def test_within_rough_ceiling_ok(self):
+        _api_del_post._check_reason('測' * 12 + 'x')  # 25 bytes, exactly the rough ceiling
+
+    def test_over_rough_ceiling_raises(self):
+        with pytest.raises(PyPtt.exceptions.ParameterError):
+            _api_del_post._check_reason('測' * 12 + 'xx')  # 26 bytes
+
+    def test_control_char_raises(self):
+        with pytest.raises(PyPtt.exceptions.ParameterError):
+            _api_del_post._check_reason('bad\x07reason')
+
+    def test_non_big5_raises(self):
+        with pytest.raises(PyPtt.exceptions.ParameterError):
+            _api_del_post._check_reason('emoji not in big5uao \U0001F600')
+
+
+class TestCheckReasonBudget:
+    """`_check_reason_budget` is the exact, post_info-dependent guard: reason
+    gets appended, after a leading space, to pttbbs's prefilled
+    "(已被<moderator_id>刪除) <author_id>" title inside a 41-Big5-byte buffer
+    (_REASON_TITLE_BUFFER_BYTES). Budget for a 9-char/9-char id pair (e.g.
+    pypttbot1 deleting pypttbot2's post, as used in the local imageptt
+    integration tests) is 41 - 13 - 9 - 9 - 1 == 9 bytes -- confirmed live
+    against a local pttbbs rebuilt with SAFE_ARTICLE_DELETE enabled."""
+
+    MOD_ID = 'pypttbot1'
+    AUTHOR_ID = 'pypttbot2'
+
+    def test_within_limit_ok(self):
+        _api_del_post._check_reason_budget('測測測測x', self.MOD_ID, self.AUTHOR_ID)  # 9 bytes, exactly at the limit
+
+    def test_over_limit_by_one_byte_raises(self):
+        with pytest.raises(PyPtt.exceptions.ParameterError):
+            _api_del_post._check_reason_budget('測測測測測', self.MOD_ID, self.AUTHOR_ID)  # 10 bytes
+
+    def test_over_limit_ascii_raises(self):
+        with pytest.raises(PyPtt.exceptions.ParameterError):
+            _api_del_post._check_reason_budget('x' * 10, self.MOD_ID, self.AUTHOR_ID)
+
+    def test_budget_shrinks_with_longer_ids(self):
+        """A 12-char/12-char id pair (PTT's real max, IDLEN==12) leaves only
+        3 bytes of budget -- a reason that fits the 9/9 pair above no
+        longer fits."""
+        with pytest.raises(PyPtt.exceptions.ParameterError):
+            _api_del_post._check_reason_budget('測測測測x', 'a' * 12, 'b' * 12)
+        _api_del_post._check_reason_budget('x', 'a' * 12, 'b' * 12)  # 1 byte still fits the 3-byte budget

{pyptt-2.1.5 → pyptt-2.1.7}/tests/test_get_mail.py

@@ -1,6 +1,8 @@
 import PyPtt
 import pytest
 
+from PyPtt import _api_mail, _api_util, data_type
+
 
 def _handle_empty_mailbox(ptt_bot):
     """On LOCALHOST, scripts/bootstrap_local_pttbbs.py always sends each bot a
@@ -14,6 +16,52 @@ def _handle_empty_mailbox(ptt_bot):
                     "so this indicates a real regression, not an environment quirk.")
 
 
+def test_get_mail_search_type_is_honored(monkeypatch):
+    """Regression: get_mail must merge search_type/search_condition into the
+    mail search command, the same way get_newest_index does. They were
+    previously ignored, so `get_mail(index, search_type=AUTHOR, ...)` returned
+    the unfiltered mail at that index instead of the author-filtered one.
+
+    Offline unit test: captures the search_list handed to the command builder
+    and stops before any PTT navigation. (log/i18n are initialised by the
+    autouse ptt_bots fixture, which constructs PyPtt.API before this runs.)"""
+
+    class _StopBeforeNetwork(Exception):
+        pass
+
+    captured = {}
+
+    def fake_cmd(index_type, search_list):
+        captured["search_list"] = search_list
+        raise _StopBeforeNetwork
+
+    monkeypatch.setattr(_api_util, "one_thread", lambda api: None)
+    monkeypatch.setattr(_api_util, "get_search_condition_cmd", fake_cmd)
+
+    class _FakeAPI:
+        _is_login = True
+        is_registered_user = True
+
+        def get_newest_index(self, *a, **k):
+            return 999
+
+    # search_type/search_condition alone (no search_list) must reach the builder.
+    # Both the enum and its string name are accepted (SearchType._MagicMeta lets
+    # isinstance('AUTHOR', SearchType) pass), matching get_post's validation loop.
+    for st in ("AUTHOR", data_type.SearchType.AUTHOR):
+        captured.clear()
+        with pytest.raises(_StopBeforeNetwork):
+            _api_mail.get_mail(_FakeAPI(), index=3, search_type=st,
+                               search_condition="someone")
+        assert captured["search_list"] == [(st, "someone")]
+
+    # no search -> no filter (unchanged behaviour)
+    captured.clear()
+    with pytest.raises(_StopBeforeNetwork):
+        _api_mail.get_mail(_FakeAPI(), index=1)
+    assert captured["search_list"] == []
+
+
 def test_get_newest_mail(ptt_bots):
     """Tests getting the newest mail from the mailbox."""
     verified = False

pyptt-2.1.5/PyPtt/ssl_config.py

@@ -1,24 +0,0 @@
-key = """-----BEGIN EC PARAMETERS-----
-BggqhkjOPQMBBw==
------END EC PARAMETERS-----
------BEGIN EC PRIVATE KEY-----
-MHcCAQEEIF0fyzVzlWVfbwf0IkWdOi1DD6g4dl2Wf2MSaPKS2pRtoAoGCCqGSM49
-AwEHoUQDQgAEvsTkmHxvh9EMh+1wFd+Z8bN0bLOWisGv3uNP0qeV0jy88cmPTWRl
-OzU8emmKTJZpuoOEGqi/Ow4vo+WTxMPynQ==
------END EC PRIVATE KEY-----
-"""
-
-cert = """-----BEGIN CERTIFICATE-----
-MIIB6TCCAY8CFGi0fucoS9ysCrt9pKAu9BgMAULWMAoGCCqGSM49BAMCMHcxCzAJ
-BgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0eTEVMBMGA1UE
-CgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25hbCBVbml0MRQw
-EgYDVQQDDAtDb21tb24gTmFtZTAeFw0yNjA3MTgwMTIwNTlaFw0zNjA3MTUwMTIw
-NTlaMHcxCzAJBgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0
-eTEVMBMGA1UECgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25h
-bCBVbml0MRQwEgYDVQQDDAtDb21tb24gTmFtZTBZMBMGByqGSM49AgEGCCqGSM49
-AwEHA0IABL7E5Jh8b4fRDIftcBXfmfGzdGyzlorBr97jT9KnldI8vPHJj01kZTs1
-PHppikyWabqDhBqovzsOL6Plk8TD8p0wCgYIKoZIzj0EAwIDSAAwRQIgYTfmCpJN
-abcPTvASZb/a7vanhO1vpafJ6Hlff6pAxh0CIQCl/Vvrx6DV21rUC3rkHBOFeqev
-I9Izuv9PxfLpnxoFcw==
------END CERTIFICATE-----
-"""