PyPtt 2.1.7__tar.gz → 2.2.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 2.1.7
+Version: 2.2.0
 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.7 → pyptt-2.2.0}/PyPtt/PTT.py

@@ -436,7 +436,8 @@ class API:
         return _api_get_newest_index.get_newest_index(
             self, index_type, board, search_type, search_condition, search_list)
 
-    def post(self, board: str, title_index: int, title: str, content: str, sign_file: [str | int] = 0) -> None:
+    def post(self, board: str, title_index: int, title: str, content: str, sign_file: [str | int] = 0,
+             anonymous: bool = False, display_id: Optional[str] = None) -> None:
         """
         發文。
 
@@ -446,6 +447,12 @@ class API:
             title (str): 文章標題。
             content (str): 文章內容。
             sign_file  (str | int): 編號或隨機簽名檔 (x)，預設為 0 (不選)。
+            anonymous (bool): 是否匿名發文，預設為 False。僅在該看板本身具有匿名 (BRD_ANONYMOUS)
+                屬性時才會生效，一般看板無法透過此參數強制匿名；PyPtt 只能在該提示出現時回覆它。
+            display_id (str): 匿名發文時欲顯示的自訂名稱；預設為 None，代表使用 pttbbs 預設值
+                (預設匿名板為 "Anonymous."，否則為原 ID)。pttbbs 會在暱名 (含預設的 "Anonymous")
+                後方加上一個 "."（例如 display_id='Fox' 會顯示為 "Fox."），此為 pttbbs 固定行為，
+                無法調整。僅能在 anonymous=True 時使用。
 
         Returns:
             None
@@ -455,6 +462,7 @@ class API:
             RequireLogin: 需要登入。
             NoSuchBoard: 看板不存在。
             NoPermission: 沒有發佈權限。
+            ParameterError: display_id 於 anonymous=False 時提供。
 
         範例::
 
@@ -464,13 +472,19 @@ class API:
             try:
                 # .. login ..
                 ptt_bot.post(board='Test', title_index=1, title='PyPtt 程式貼文測試', content='測試內容', sign_file=0)
+                # 匿名發文 (需看板本身具有匿名屬性)
+                ptt_bot.post(board='AnonBoard', title_index=1, title='匿名貼文測試', content='測試內容',
+                             sign_file=0, anonymous=True)
+                # 匿名發文並自訂顯示名稱
+                ptt_bot.post(board='AnonBoard', title_index=1, title='匿名貼文測試', content='測試內容',
+                             sign_file=0, anonymous=True, display_id='Fox')
                 # .. do something ..
             finally:
                 ptt_bot.logout()
 
         """
 
-        _api_post.post(self, board, title, content, title_index, sign_file)
+        _api_post.post(self, board, title, content, title_index, sign_file, anonymous, display_id)
 
     def comment(self, board: str, comment_type: data_type.CommentType, content: str, aid: Optional[str] = None,
                 index: int = 0) -> None:

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

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

{pyptt-2.1.7 → pyptt-2.2.0}/PyPtt/_api_post.py

@@ -92,7 +92,49 @@ sign_file_list = [str(x) for x in range(0, 10)]
 sign_file_list.append('x')
 
 
-def post(api, board: str, title: str, content: str, title_index: int, sign_file: [str | int]) -> None:
+# --- post()'s `anonymous` / `display_id` params (issue #84) ---
+#
+# pttbbs only shows the "請輸入你想用的ID" / "確定[y/N]?" prompt pair when the
+# *board itself* carries BRD_ANONYMOUS server-side (mbbsd/edit.c write_header,
+# `if (currbrdattr & BRD_ANONYMOUS)`). On a normal board the two TargetUnits
+# below simply never match anything on screen -- there is no way for PyPtt to
+# force anonymity on a board that isn't flagged anonymous. See
+# scripts/mkboard.py / scripts/bootstrap_local_pttbbs.py's AnonTest board for
+# how to provision one locally.
+#
+# Response mapping, matching pttbbs' own rules for that prompt:
+#   anonymous=False              -> 'r' (real userid; safe default, and a
+#                                    no-op on non-anonymous boards)
+#   anonymous=True,  no display_id -> '' (Enter; "Anonymous." -- pttbbs
+#                                    appends the same trailing '.' as the
+#                                    display_id case below -- on a
+#                                    default-anonymous board, real userid
+#                                    otherwise -- pttbbs' own behavior)
+#   anonymous=True,  display_id  -> that string; pttbbs appends a trailing
+#                                    '.' to it (e.g. display_id='Fox' shows
+#                                    up as author 'Fox.') -- fixed pttbbs
+#                                    behavior, not adjustable by PyPtt.
+def _anonymous_response(anonymous: bool, display_id: [str | None]) -> str:
+    if display_id is not None:
+        check_value.check_type(display_id, str, 'display_id')
+        if not anonymous:
+            raise exceptions.ParameterError('display_id requires anonymous=True')
+        # pttbbs (mbbsd/edit.c) treats a leading '-' as "this is a deleted
+        # name" and re-shows the same prompt instead of accepting it, which
+        # would make PyPtt's TargetUnit answer it the same way forever.
+        if display_id.startswith('-'):
+            raise exceptions.ParameterError("display_id must not start with '-'")
+        for c in display_id:
+            if ord(c) < 0x20 or ord(c) == 0x7f:
+                raise exceptions.ParameterError(
+                    f'display_id must not contain control characters (found {c!r})')
+        return display_id
+
+    return '' if anonymous else 'r'
+
+
+def post(api, board: str, title: str, content: str, title_index: int, sign_file: [str | int],
+         anonymous: bool = False, display_id: [str | None] = None) -> None:
     _api_util.one_thread(api)
 
     if not api._is_login:
@@ -105,10 +147,13 @@ def post(api, board: str, title: str, content: str, title_index: int, sign_file:
     check_value.check_type(title_index, int, 'title_index')
     check_value.check_type(title, str, 'title')
     check_value.check_type(content, str, 'content')
+    check_value.check_type(anonymous, bool, 'anonymous')
 
     if str(sign_file).lower() not in sign_file_list:
         raise exceptions.ParameterError(f'wrong parameter sign_file: {sign_file}')
 
+    anonymous_response = _anonymous_response(anonymous, display_id)
+
     _api_util.check_board(api, board)
     _api_util.goto_board(api, board)
 
@@ -147,7 +192,17 @@ def post(api, board: str, title: str, content: str, title_index: int, sign_file:
 
     target_list = [
         connect_core.TargetUnit('任意鍵繼續', break_detect=True),
-        connect_core.TargetUnit('確定要儲存檔案嗎', response='s' + command.enter),
+        # max_match=1: pttbbs' "檔案處理" screen keeps every answered prompt's
+        # echoed text on screen as the flow proceeds through the next ones
+        # (confirmed live -- "確定要儲存檔案嗎？ s" stays visible through the
+        # anonymous-post prompts below). Without max_match=1 this target
+        # re-matches on every later screen in the same flow and re-sends
+        # 's' + Enter into whatever field currently has focus (e.g. the
+        # anonymous-ID or confirm prompt), corrupting the answer.
+        connect_core.TargetUnit('確定要儲存檔案嗎', response='s' + command.enter, max_match=1),
+        # Only shown on a BRD_ANONYMOUS board -- no-op on a normal board.
+        connect_core.TargetUnit('請輸入你想用的ID', response=anonymous_response + command.enter, max_match=1),
+        connect_core.TargetUnit('確定[y/N]', response='y' + command.enter, max_match=1),
         connect_core.TargetUnit('x=隨機', response=str(sign_file) + command.enter),
     ]
     api.connect_core.send(

pyptt-2.2.0/PyPtt/ssl_config.py

@@ -0,0 +1,24 @@
+key = """-----BEGIN EC PARAMETERS-----
+BggqhkjOPQMBBw==
+-----END EC PARAMETERS-----
+-----BEGIN EC PRIVATE KEY-----
+MHcCAQEEIK/vT3CLlx1CdJ6OlvrB70J+1+QzpKnb0DGYe9u1cWaboAoGCCqGSM49
+AwEHoUQDQgAEhzeNEtPu4xVRU7aGhl59oKVJZsZue2B/eEQkmme2gsMzzS6vGJKj
+6mzkEmDNZv/DLFxccYesWd0comFxe/xOyA==
+-----END EC PRIVATE KEY-----
+"""
+
+cert = """-----BEGIN CERTIFICATE-----
+MIIB5zCCAY8CFGe33bG5Ilg7iZcbrVQyTUOOD9uiMAoGCCqGSM49BAMCMHcxCzAJ
+BgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0eTEVMBMGA1UE
+CgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25hbCBVbml0MRQw
+EgYDVQQDDAtDb21tb24gTmFtZTAeFw0yNjA3MTkxMjI2NDVaFw0zNjA3MTYxMjI2
+NDVaMHcxCzAJBgNVBAYTAlRXMQ4wDAYDVQQIDAVTdGF0ZTENMAsGA1UEBwwEQ2l0
+eTEVMBMGA1UECgwMT3JnYW5pemF0aW9uMRwwGgYDVQQLDBNPcmdhbml6YXRpb25h
+bCBVbml0MRQwEgYDVQQDDAtDb21tb24gTmFtZTBZMBMGByqGSM49AgEGCCqGSM49
+AwEHA0IABIc3jRLT7uMVUVO2hoZefaClSWbGbntgf3hEJJpntoLDM80urxiSo+ps
+5BJgzWb/wyxcXHGHrFndHKJhcXv8TsgwCgYIKoZIzj0EAwIDRgAwQwIfcZoiJkfz
+rUDQbdsoh6/7UsBnxSB/01+u6KIfZgepvwIgPT5JXHcIMPgo/dt5ph75qYq78GAN
+zVh3EBftVZSO8po=
+-----END CERTIFICATE-----
+"""

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPtt
-Version: 2.1.7
+Version: 2.2.0
 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.7 → pyptt-2.2.0}/PyPtt.egg-info/SOURCES.txt

@@ -80,6 +80,7 @@ tests/test_mail_send_and_del.py
 tests/test_mark_post.py
 tests/test_parse_query_post.py
 tests/test_post.py
+tests/test_post_anonymous.py
 tests/test_pyte_parity.py
 tests/test_reply_post.py
 tests/test_search_user.py

pyptt-2.2.0/tests/test_post_anonymous.py

@@ -0,0 +1,96 @@
+"""Tests PyPtt issue #84 (匿名發文): post()'s anonymous/display_id params
+against a board that actually carries pttbbs' BRD_ANONYMOUS/BRD_DEFAULTANONYMOUS
+flags. Only pttbbs boards flagged this way ever show the anonymous prompt --
+PyPtt cannot force anonymity on a normal board (see PyPtt/_api_post.py). Only
+scripts/bootstrap_local_pttbbs.py's local container provisions such a board
+(AnonTest), so this file is LOCALHOST-only.
+"""
+import os
+import time
+import uuid
+
+import pytest
+
+import PyPtt
+from PyPtt import PostField, NewIndex
+
+if os.environ.get('PTT_HOST') != 'LOCALHOST':
+    pytest.skip(
+        'test_post_anonymous.py needs the AnonTest board, which only '
+        'scripts/bootstrap_local_pttbbs.py provisions. Set PTT_HOST=LOCALHOST to run.',
+        allow_module_level=True)
+
+ANON_BOARD = 'AnonTest'
+
+
+def _find_own_post(ptt_bot, title_marker):
+    """Scan back from the newest post on ANON_BOARD for the one whose title
+    contains title_marker, and return its parsed post dict."""
+    newest_index = ptt_bot.get_newest_index(index_type=NewIndex.BOARD, board=ANON_BOARD)
+    for i in range(10):
+        index = newest_index - i
+        if index <= 0:
+            break
+        post = ptt_bot.get_post(board=ANON_BOARD, index=index)
+        if title_marker in post[PostField.title]:
+            return post
+    raise AssertionError(f'could not find a post titled with marker {title_marker!r}')
+
+
+def test_post_anonymous(ptt_bots):
+    """anonymous=True, display_id=None -> pttbbs masks the author as
+    'Anonymous.' (AnonTest is bootstrapped BRD_DEFAULTANONYMOUS, so an empty
+    response to the anon prompt means 'Anonymous', not the real id; pttbbs
+    appends a trailing '.' the same way it does for a custom display_id)."""
+    ptt_bot = ptt_bots[0]
+    marker = uuid.uuid4().hex[:12]
+    title = f'PyPtt anon test {marker}'
+
+    ptt_bot.post(board=ANON_BOARD, title_index=1, title=title,
+                 content='PyPtt anonymous post test content.\n', sign_file=0,
+                 anonymous=True)
+
+    time.sleep(1)
+    post = _find_own_post(ptt_bot, marker)
+
+    author = post[PostField.author]
+    assert author.split(' ')[0] == 'Anonymous.', f'expected masked author "Anonymous.", got {author!r}'
+    assert ptt_bot.ptt_id not in author, f'real ptt_id leaked into author field: {author!r}'
+
+
+def test_post_anonymous_with_display_id(ptt_bots):
+    """anonymous=True, display_id='PyPttFox' -> pttbbs masks the author as
+    the custom name plus a trailing '.' (pttbbs behavior, not adjustable)."""
+    ptt_bot = ptt_bots[0]
+    marker = uuid.uuid4().hex[:12]
+    title = f'PyPtt anon custom id test {marker}'
+    display_id = 'PyPttFox'
+
+    ptt_bot.post(board=ANON_BOARD, title_index=1, title=title,
+                 content='PyPtt anonymous post (custom display id) test content.\n', sign_file=0,
+                 anonymous=True, display_id=display_id)
+
+    time.sleep(1)
+    post = _find_own_post(ptt_bot, marker)
+
+    author = post[PostField.author]
+    assert author.split(' ')[0] == f'{display_id}.', f'expected masked author "{display_id}.", got {author!r}'
+    assert ptt_bot.ptt_id not in author, f'real ptt_id leaked into author field: {author!r}'
+
+
+def test_post_not_anonymous_shows_real_id(ptt_bots):
+    """anonymous=False (default) -> even on an anonymous-capable board, the
+    real ptt_id is used (safe default, backward compatible with pre-#84
+    callers of post())."""
+    ptt_bot = ptt_bots[0]
+    marker = uuid.uuid4().hex[:12]
+    title = f'PyPtt non-anon test {marker}'
+
+    ptt_bot.post(board=ANON_BOARD, title_index=1, title=title,
+                 content='PyPtt non-anonymous post test content.\n', sign_file=0)
+
+    time.sleep(1)
+    post = _find_own_post(ptt_bot, marker)
+
+    author = post[PostField.author]
+    assert author.split(' ')[0] == ptt_bot.ptt_id, f'expected real author {ptt_bot.ptt_id!r}, got {author!r}'

pyptt-2.1.7/PyPtt/ssl_config.py

@@ -1,24 +0,0 @@
-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-----
-"""