PyPtt 2.3.3__tar.gz → 2.3.5__tar.gz

{pyptt-2.3.3 → pyptt-2.3.5}/PKG-INFO

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

{pyptt-2.3.3 → pyptt-2.3.5}/PyPtt/__init__.py

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

{pyptt-2.3.3 → pyptt-2.3.5}/PyPtt/_api_del_post.py

@@ -15,7 +15,12 @@ from . import screens
 
 # pttbbs input fields cap length in bytes (Big5: 2 bytes per Chinese
 # character), not in Python characters.
-_BAD_POST_REASON_MAX_BYTES = 50
+# mbbsd/assess.c:71 getdata(..., reason, 50, DOECHO) -> len=50 -> vtuikit.c's
+# getdata() only accepts len-1 bytes, and vkey_purge() (vtuikit.c:1409-1415)
+# clears the whole input queue if the last accepted byte lands at iend ==
+# len-2 with a Big5 lead byte (>0x80) still queued right after it -- so the
+# safe cap is len-2, not len-1.
+_BAD_POST_REASON_MAX_BYTES = 48
 
 # --- del_post's `reason` field (annotates the title shown after a
 # moderator deletes another user's post) ---
@@ -24,7 +29,8 @@ _BAD_POST_REASON_MAX_BYTES = 50
 # (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.
+# reason together -- is capped at 40 Big5 bytes, not python characters
+# (len-2, see the vkey_purge() mechanism below).
 # 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
@@ -34,8 +40,11 @@ _BAD_POST_REASON_MAX_BYTES = 50
 # 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.
+#   - within the safe budget: reason is accepted in full, title not
+#     truncated. (One prior run that landed exactly on the old,
+#     off-by-one budget only happened not to trip the bug below because
+#     the overflow byte's low bit was < 0x80 -- that was luck, not a
+#     safe boundary; see the mechanism below for why.)
 #   - 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
@@ -44,7 +53,14 @@ _BAD_POST_REASON_MAX_BYTES = 50
 #     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
+#
+# mbbsd/bbs.c:3311,3387 getdata(..., reason, PROPER_TITLE_LEN, ...);
+# include/common.h:193 PROPER_TITLE_LEN 42 -> len=42 -> vtuikit.c's
+# getdata() only accepts len-1 bytes, and vkey_purge() (vtuikit.c:1409-1415)
+# clears the whole input queue if the last accepted byte lands at
+# iend == len-2 with a Big5 lead byte still queued right after it -- so the
+# safe cap is len-2, not len-1.
+_REASON_TITLE_BUFFER_BYTES = 40  # PROPER_TITLE_LEN(42) - 2, see vkey_purge() note above
 _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

{pyptt-2.3.3 → pyptt-2.3.5}/PyPtt/_api_mail.py

@@ -33,6 +33,17 @@ def mail(api,
 
     check_value.check_type(ptt_id, str, 'ptt_id')
     check_value.check_type(title, str, 'title')
+    # mbbsd/mail.c:774-775 char tmp_title[STRLEN-20]; include/pttstruct.h:313
+    # STRLEN 80 -> len=60 -> vtuikit.c's getdata() only accepts len-1 bytes,
+    # and vkey_purge() clears the whole input queue if the overflow byte
+    # lands right after a Big5 lead byte -- so the safe cap is len-2 = 58.
+    try:
+        encoded_title = title.encode('big5uao')
+    except UnicodeEncodeError as e:
+        raise exceptions.ParameterError(
+            f'title contains a character that cannot be encoded in Big5: {e}') from e
+    if len(encoded_title) > 58:
+        raise exceptions.ParameterError('title must not exceed 58 bytes')
     check_value.check_type(content, str, 'content')
     # 沒擋型別的話，backup='False' 這種字串是 truthy，會靜靜地存底稿。
     check_value.check_type(backup, bool, 'backup')
@@ -117,7 +128,6 @@ def mail(api,
 # ※ 發信站: 批踢踢實業坊(ptt.cc)
 # ◆ From: 220.142.14.95
 content_start = '───────────────────────────────────────'
-content_end = '--\n※ 發信站: 批踢踢實業坊(ptt.cc)'
 content_ip_old = '◆ From: '
 
 mail_author_pattern = re.compile(r'作者  (.+)')
@@ -234,7 +244,7 @@ def get_mail(api, index: int, search_type: Optional[data_type.SearchType] = None
 
     # 紅包偵測
     red_envelope = False
-    if content_end not in origin_mail and 'Ptt幣的大紅包喔' in origin_mail:
+    if not any(EC in origin_mail for EC in screens.Target.content_end_list) and 'Ptt幣的大紅包喔' in origin_mail:
         mail_content = mail_content.strip()
         red_envelope = True
 
@@ -248,7 +258,8 @@ def get_mail(api, index: int, search_type: Optional[data_type.SearchType] = None
         # 非紅包開始解析 ip 與 地區
 
         ip_line_list = origin_mail.split('\n')
-        ip_line = [x for x in ip_line_list if x.startswith(content_end[3:])]
+        ip_line = [x for x in ip_line_list
+                   if any(x.startswith(EC[3:]) for EC in screens.Target.content_end_list)]
 
         if len(ip_line) == 0:
             # 沒 ip 就沒地區

{pyptt-2.3.3 → pyptt-2.3.5}/PyPtt/_api_post.py

@@ -149,6 +149,18 @@ def post(api, board: str, title: str, content: str, title_index: int, sign_file:
     check_value.check_type(content, str, 'content')
     check_value.check_type(anonymous, bool, 'anonymous')
 
+    # mbbsd/bbs.c:1360-1365 caps the title field at DISP_TTLEN=46 cells on an
+    # 80-col screen; mbbsd/vtuikit.c:1409-1415's vkey_purge() clears the whole
+    # input queue one byte earlier than that, eating PyPtt's batched Enter and
+    # follow-up commands -- so the safe limit is 46-2=44 Big5 bytes, not 45.
+    try:
+        encoded_title = title.encode('big5uao')
+    except UnicodeEncodeError as e:
+        raise exceptions.ParameterError(
+            f'title contains a character that cannot be encoded in Big5: {e}') from e
+    if len(encoded_title) > 44:
+        raise exceptions.ParameterError('title must not exceed 44 bytes')
+
     if str(sign_file).lower() not in sign_file_list:
         raise exceptions.ParameterError(f'wrong parameter sign_file: {sign_file}')
 
@@ -205,9 +217,12 @@ def post(api, board: str, title: str, content: str, title_index: int, sign_file:
         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(
+    index = api.connect_core.send(
         cmd,
         target_list,
         screen_timeout=api.config.screen_post_timeout)
+    if index < 0:
+        ori_screen = api.connect_core.get_screen_queue()[-1]
+        raise exceptions.UnknownError(ori_screen)
 
     log.logger.info(i18n.post, '...', i18n.success)

{pyptt-2.3.3 → pyptt-2.3.5}/PyPtt/_api_reply_post.py

@@ -16,6 +16,9 @@ def reply_post(api, reply_to: data_type.ReplyTo, board: str, content: str, sign_
     if not api._is_login:
         raise exceptions.RequireLogin(i18n.require_login)
 
+    if not api.is_registered_user:
+        raise exceptions.UnregisteredUser(lib_util.get_current_func_name())
+
     if not isinstance(reply_to, data_type.ReplyTo):
         raise TypeError('ReplyTo must be data_type.ReplyTo')
 
@@ -79,6 +82,12 @@ def reply_post(api, reply_to: data_type.ReplyTo, board: str, content: str, sign_
         connect_core.TargetUnit('任意鍵繼續', break_detect=True),
         connect_core.TargetUnit('◆ 很抱歉, 此文章已結案並標記, 不得回應', log_level=log.INFO,
                                 exceptions_=exceptions.CantResponse()),
+        # mbbsd/bbs.c:1736 "此篇文章已結案, 是否真的要回應?(y/N)" -- closed but not
+        # marked, distinct from the CantResponse case above; answering 'y'
+        # lets the reply continue normally.
+        connect_core.TargetUnit('是否真的要回應', log_level=log.INFO, response='y' + command.enter),
+        # mbbsd/bbs.c:1742-1745 BRD_NOREPLY board: "...本板不開放回覆文章...".
+        connect_core.TargetUnit('不開放回覆文章', log_level=log.INFO, exceptions_=exceptions.CantResponse()),
         connect_core.TargetUnit('(E)繼續編輯 (W)強制寫入', log_level=log.INFO, response='W' + command.enter),
         # max_match=1 是防禦性上限，理由同 _api_mail.py。三種 reply_to（BOARD / MAIL /
         # BOARD_MAIL）都對真 PTT 實測過，這個 target 一次都沒命中，目前執行不到。
@@ -93,9 +102,12 @@ def reply_post(api, reply_to: data_type.ReplyTo, board: str, content: str, sign_
                                 response=('Y' if backup else 'N') + command.enter),
     ]
 
-    api.connect_core.send(
+    index = api.connect_core.send(
         cmd,
         target_list,
         screen_timeout=api.config.screen_long_timeout)
+    if index < 0:
+        ori_screen = api.connect_core.get_screen_queue()[-1]
+        raise exceptions.UnknownError(ori_screen)
 
     log.logger.info(reply_msg, '...', i18n.success)

pyptt-2.3.5/PyPtt/_api_set_board_title.py

@@ -0,0 +1,75 @@
+from . import _api_util
+from . import check_value
+from . import command
+from . import connect_core
+from . import exceptions
+from . import i18n
+from . import lib_util
+
+
+def set_board_title(api, board: str, new_title: str) -> None:
+    # 第一支板主專用 api
+    _api_util.one_thread(api)
+
+    _api_util.goto_board(api, board)
+
+    if not api._is_login:
+        raise exceptions.RequireLogin(i18n.require_login)
+
+    if not api.is_registered_user:
+        raise exceptions.UnregisteredUser(lib_util.get_current_func_name())
+
+    check_value.check_type(board, str, 'board')
+    check_value.check_type(new_title, str, 'new_title')
+
+    # mbbsd/board.c:641 vgetstr(genbuf, BTLEN-16, ...) with BTLEN=48 gives
+    # len=32; vtuikit.c:1409-1415's vkey_purge() clears the input queue one
+    # byte early, so the safe limit is 32-2=30 Big5 bytes, not 31.
+    try:
+        encoded_new_title = new_title.encode('big5uao')
+    except UnicodeEncodeError as e:
+        raise exceptions.ParameterError(
+            f'new_title contains a character that cannot be encoded in Big5: {e}') from e
+    if len(encoded_new_title) > 30:
+        raise exceptions.ParameterError('new_title must not exceed 30 bytes')
+
+    _api_util.check_board(
+        api,
+        board,
+        check_moderator=True)
+
+    # check_board() above calls get_board_info(get_post_kind=False) (to look
+    # up the moderator list) whenever the board isn't already cached, and
+    # that helper reads the board's "《board》看板設定" info screen but never
+    # dismisses its trailing "[按任意鍵繼續]" prompt. Left alone, the 'I'
+    # below lands on that prompt instead of the board's article-list screen:
+    # it gets consumed as the "any key" dismissal, so the following ctrl_p
+    # is read as the article-list's own "[Ctrl-P]發表文章" shortcut and the
+    # whole command ends up composing a new post instead of opening board
+    # settings. Verified live against a moderated board: without this
+    # re-navigation the send always lands in the article editor; with it,
+    # the confirmation targets below match every time (8/8 in local testing).
+    _api_util.goto_board(api, board)
+
+    cmd_list = []
+    cmd_list.append('I')
+    cmd_list.append(command.ctrl_p)
+    cmd_list.append('b')
+    cmd_list.append(command.enter)
+    cmd_list.append(command.backspace * 31)
+    cmd_list.append(new_title)
+    cmd_list.append(command.enter * 2)
+    cmd = ''.join(cmd_list)
+
+    target_list = [
+        connect_core.TargetUnit('◆ 已儲存新設定', break_detect=True),
+        connect_core.TargetUnit('◆ 未改變任何設定', break_detect=True),
+    ]
+
+    index = api.connect_core.send(
+        cmd,
+        target_list,
+        screen_timeout=api.config.screen_long_timeout)
+    if index < 0:
+        ori_screen = api.connect_core.get_screen_queue()[-1]
+        raise exceptions.UnknownError(ori_screen)

{pyptt-2.3.3 → pyptt-2.3.5}/PyPtt/connect_core.py

@@ -22,16 +22,16 @@ from . import log
 from . import screens
 from . import ssl_config
 
+# ponytail: pass the UA per-connect instead of mutating websockets' module global.
+# The global is baked into connect()'s default arg the moment websockets lazily
+# imports asyncio.client, so mutating it only works if you get there first —
+# order-dependent action at a distance. (websockets.http also went away in 15.)
 try:
-    import websockets.http
+    from websockets.http11 import USER_AGENT as _WS_USER_AGENT
+except ImportError:  # websockets < 13
+    from websockets.http import USER_AGENT as _WS_USER_AGENT
 
-    websockets.http.USER_AGENT += f' PyPtt/{PyPtt.__version__}'
-    use_http11 = False
-except AttributeError:
-    import websockets.http11
-
-    websockets.http11.USER_AGENT += f' PyPtt/{PyPtt.__version__}'
-    use_http11 = True
+USER_AGENT = f'{_WS_USER_AGENT} PyPtt/{PyPtt.__version__}'
 
 def ssl_init(verify_ssl: bool = True) -> ssl.SSLContext:
     # Verify the PTT server certificate against the system CA bundle.
@@ -216,11 +216,11 @@ class API(object):
 
         for _ in range(2):
             try:
-                log.logger.debug('USER_AGENT',
-                                 websockets.http11.USER_AGENT if use_http11 else websockets.http.USER_AGENT)
+                log.logger.debug('USER_AGENT', USER_AGENT)
                 # ponytail: ws:// (local docker target) can't take an ssl context —
                 # websockets errors out if you pass one on a non-wss URI
-                connect_kwargs = {'origin': websocket_origin}
+                connect_kwargs = {'origin': websocket_origin,
+                                  'user_agent_header': USER_AGENT}
                 if websocket_host.startswith('wss://'):
                     connect_kwargs['ssl'] = self._ssl_context
                 self._core = loop.run_until_complete(
@@ -525,11 +525,10 @@ class API(object):
 
     def close(self):
         if self.config.connect_mode == data_type.ConnectMode.WEBSOCKETS:
-            try:
-                is_open = not self._core.closed
-            except AttributeError:
-                is_open = getattr(self._core, 'open', False)
-            if self._core and is_open:
+            # close_code is None until a close frame lands — true on both the legacy
+            # WebSocketClientProtocol and the websockets>=14 ClientConnection (which
+            # dropped .closed/.open entirely).
+            if self._core and self._core.close_code is None:
                 loop = self._get_event_loop()
                 try:
                     loop.run_until_complete(asyncio.wait_for(self._core.close(), timeout=2.0))

{pyptt-2.3.3 → pyptt-2.3.5}/PyPtt.egg-info/PKG-INFO

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

{pyptt-2.3.3 → pyptt-2.3.5}/tests/test_del_post_unit.py

@@ -10,11 +10,11 @@ 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
+        _api_del_post._check_bad_post_reason('測' * 24)  # 48 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
+            _api_del_post._check_bad_post_reason('測' * 24 + 'x')  # 49 bytes, 1 over the limit
 
     def test_control_char_raises(self):
         with pytest.raises(PyPtt.exceptions.ParameterError):
@@ -24,18 +24,18 @@ class TestCheckBadPostReason:
 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
+    == 40 - 13 - 1 - 1 - 1 == 24 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
+        _api_del_post._check_reason('測' * 12)  # 24 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
+            _api_del_post._check_reason('測' * 12 + 'x')  # 25 bytes, 1 over the ceiling
 
     def test_control_char_raises(self):
         with pytest.raises(PyPtt.exceptions.ParameterError):
@@ -49,21 +49,21 @@ class TestCheckReasonStatic:
 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
+    "(已被<moderator_id>刪除) <author_id>" title inside a 40-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
+    integration tests) is 40 - 13 - 9 - 9 - 1 == 8 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
+        _api_del_post._check_reason_budget('測測測測', self.MOD_ID, self.AUTHOR_ID)  # 8 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
+            _api_del_post._check_reason_budget('測測測測x', self.MOD_ID, self.AUTHOR_ID)  # 9 bytes, 1 over the limit
 
     def test_over_limit_ascii_raises(self):
         with pytest.raises(PyPtt.exceptions.ParameterError):
@@ -71,8 +71,8 @@ class TestCheckReasonBudget:
 
     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
+        2 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
+        _api_del_post._check_reason_budget('x', 'a' * 12, 'b' * 12)  # 1 byte still fits the 2-byte budget

pyptt-2.3.3/PyPtt/_api_set_board_title.py

@@ -1,48 +0,0 @@
-from . import _api_util
-from . import check_value
-from . import command
-from . import connect_core
-from . import exceptions
-from . import i18n
-from . import lib_util
-
-
-def set_board_title(api, board: str, new_title: str) -> None:
-    # 第一支板主專用 api
-    _api_util.one_thread(api)
-
-    _api_util.goto_board(api, board)
-
-    if not api._is_login:
-        raise exceptions.RequireLogin(i18n.require_login)
-
-    if not api.is_registered_user:
-        raise exceptions.UnregisteredUser(lib_util.get_current_func_name())
-
-    check_value.check_type(board, str, 'board')
-    check_value.check_type(new_title, str, 'new_title')
-
-    _api_util.check_board(
-        api,
-        board,
-        check_moderator=True)
-
-    cmd_list = []
-    cmd_list.append('I')
-    cmd_list.append(command.ctrl_p)
-    cmd_list.append('b')
-    cmd_list.append(command.enter)
-    cmd_list.append(command.backspace * 31)
-    cmd_list.append(new_title)
-    cmd_list.append(command.enter * 2)
-    cmd = ''.join(cmd_list)
-
-    target_list = [
-        connect_core.TargetUnit('◆ 已儲存新設定', break_detect=True),
-        connect_core.TargetUnit('◆ 未改變任何設定', break_detect=True),
-    ]
-
-    api.connect_core.send(
-        cmd,
-        target_list,
-        screen_timeout=api.config.screen_long_timeout)