hfr-api 0.0.2__py3-none-any.whl

hfr/__init__.py

@@ -0,0 +1,5 @@
+"""hfr_api: A Python library to interface with forum.hardware.fr"""
+
+from . import bb
+from .message import Message
+from .topic import Topic

hfr/bb.py

@@ -0,0 +1,118 @@
+"""BB code handling"""
+
+from bs4 import BeautifulSoup, NavigableString
+
+
+def convert_inline_tags(html: str, context: dict = {}) -> str:
+    soup = BeautifulSoup(html, "html.parser")
+
+    for element in soup.find_all(True, recursive=False):
+        if element.name == "strong":
+            element.replace_with(
+                NavigableString(
+                    f"[b]{convert_inline_tags(element.decode_contents(), context)}[/b]"
+                )
+            )
+        elif element.name == "span" and "u" in element.get("class", []):
+            element.replace_with(
+                NavigableString(
+                    f"[u]{convert_inline_tags(element.decode_contents(), context)}[/u]"
+                )
+            )
+        elif element.name == "span" and element.get("style"):
+            style = element.get("style")
+            if len(style) > 7 and style[:7] == "color:#":
+                color = style[-6:]
+                element.replace_with(
+                    NavigableString(
+                        f"[#{color}]{convert_inline_tags(element.decode_contents(), context)}[/#{color}]"
+                    )
+                )
+        elif element.name == "em":
+            element.replace_with(
+                NavigableString(
+                    f"[i]{convert_inline_tags(element.decode_contents(), context)}[/i]"
+                )
+            )
+        elif element.name == "strike":
+            element.replace_with(
+                NavigableString(
+                    f"[strike]{convert_inline_tags(element.decode_contents(), context)}[/strike]"
+                )
+            )
+        elif element.name in ("ul", "ol"):
+            context["not_first_line"] = False
+            element.replace_with(
+                NavigableString(
+                    f"{convert_inline_tags(element.decode_contents(), context)}"
+                )
+            )
+            context["not_first_line"] = True
+        elif element.name == "li":
+            table_class = context.get("table_class", "")
+            bullet_style = "" if table_class == "code" else "[*]"
+            new_line = "\n" if context.get("not_first_line", False) else ""
+            context["not_first_line"] = True
+            element.replace_with(
+                NavigableString(
+                    f"{new_line}{bullet_style}{convert_inline_tags(element.decode_contents(), context)}"
+                )
+            )
+        elif element.name == "a":
+            href = element.get("href", "")
+            if len(href) > 6 and href[:7] == "mailto:":
+                element.replace_with(NavigableString(f"[email]{href[7:]}[/email]"))
+            else:
+                element.replace_with(
+                    NavigableString(
+                        f"[url={href}]{convert_inline_tags(element.decode_contents(), context)}[/url]"
+                    )
+                )
+        elif element.name == "img":
+            src = element.get("src", "")
+            alt = element.get("alt", "")
+            if alt[0] in ("[", ":"):
+                # For smileys, just use the alt text
+                element.replace_with(NavigableString(alt))
+            else:
+                # For regular images, convert to BB code format
+                element.replace_with(NavigableString(f"[img]{src}[/img]"))
+        elif element.name == "table":
+            table_class = element.get("class")[0] if element.get("class") else ""
+            new_context = {"table_class": table_class}
+            if "citation" in table_class:
+                bb_tag = "quotemsg"
+                href = element.find("a").get("href")
+                bb_details = f"={href.split('#t')[1]},0,0"  # TODO create reference =msgid,?,userid
+            else:
+                bb_tag = table_class
+                bb_details = ""
+            content = element.find(["p", "ol"])
+            if content:
+                converted_content = convert_inline_tags(
+                    content.decode_contents(), new_context
+                )
+                if len(converted_content) and converted_content[-1] == "\n":
+                    converted_content = converted_content[
+                        :-1
+                    ]  # remove stupid trailing "\n"
+                element.replace_with(
+                    NavigableString(
+                        f"[{bb_tag}{bb_details}]{converted_content}[/{bb_tag}]"
+                    )
+                )
+        else:
+            if not isinstance(element, NavigableString):
+                element.replace_with(
+                    NavigableString(
+                        convert_inline_tags(element.decode_contents(), context)
+                    )
+                )
+
+    return soup.get_text()
+
+
+def html_to_bb(html: str) -> str:
+    return convert_inline_tags(
+        html.replace("&nbsp;", "").replace("\n", "").replace("<br />", "\n")
+    ).strip()

hfr/message.py

@@ -0,0 +1,67 @@
+"""An HFR message"""
+
+from datetime import datetime
+from typing import TYPE_CHECKING
+
+from bs4 import NavigableString
+
+from . import bb
+
+if TYPE_CHECKING:
+    from .topic import Topic
+
+
+class Message:
+    def __init__(
+        self, topic, id: int, posted_at: datetime, author: str, text: str
+    ) -> None:
+        self.topic = topic
+        self.id = id
+        self.posted_at = posted_at
+        self.author = author
+        self.text = text
+
+    @classmethod
+    def from_html(cls, topic: "Topic", html: NavigableString):
+        case1 = html.find("td", class_="messCase1")
+
+        author = case1.find("b", class_="s2").string.replace("\u200b", "")
+        if author == "Publicité":
+            return None
+
+        id = case1.find("a", rel="nofollow").attrs["href"][2:]
+
+        case2 = html.find("td", class_="messCase2")
+        posted_at_str = (
+            case2.find("div", class_="toolbar").find("div", class_="left").string
+        )
+        posted_at = Message.parse_timestamp(posted_at_str)
+
+        text_tag = case2.find("div", id=f"para{id}")
+        text = bb.html_to_bb(text_tag.decode_contents())
+
+        return cls(topic, id, posted_at, author, text)
+
+    @staticmethod
+    def parse_timestamp(timestamp_str: str) -> datetime:
+        d = timestamp_str[9:19]
+        t = timestamp_str[22:30]
+        return datetime.strptime(f"{d} {t}", "%d-%m-%Y %H:%M:%S")
+
+    def to_dict(self) -> dict:
+        return {
+            "id": self.id,
+            "author": self.author,
+            "posted_at": str(self.posted_at),
+            "text": self.text,
+        }
+
+    @classmethod
+    def from_dict(cls, topic, data: dict):
+        return cls(
+            topic,
+            data["id"],
+            datetime.fromtimestamp(int(data["posted_at"])),
+            data["author"],
+            data["text"],
+        )

hfr/topic.py

@@ -0,0 +1,147 @@
+"""An HFR Topic"""
+
+import logging
+import time
+from datetime import date, datetime
+
+import requests
+from bs4 import BeautifulSoup
+from sortedcontainers import SortedDict
+
+from .message import Message
+
+logger = logging.getLogger()
+
+
+def date_to_str(some_date: str | date | datetime) -> str:
+    if isinstance(some_date, datetime):
+        return str(some_date.date())
+    elif isinstance(some_date, date):
+        return str(some_date)
+    elif isinstance(some_date, str):
+        return some_date
+    return None
+
+
+class Topic:
+    def __init__(
+        self,
+        cat: int,
+        subcat: int,
+        post: int,
+        title: str = "",
+        max_page: int = 0,
+        max_date: str = "1970-01-01",
+    ) -> None:
+        self.cat = cat
+        self.subcat = subcat
+        self.post = post
+        self.title = title
+        self.max_page = max_page
+        self.max_date = max_date
+        self.messages = dict()
+
+    @property
+    def id(self) -> str:
+        return f"{self.cat}#{self.subcat}#{self.post}"
+
+    def parse_page_html(self, html: str) -> dict:
+        soup = BeautifulSoup(html, "html.parser")
+        self.title = soup.find("h3").text
+
+        # Find highest page number
+        pages_block = soup.find("tr", class_="fondForum2PagesHaut")
+        page_links = pages_block.find_all("a", class_="cHeader")
+
+        if self.max_page == 0:
+            max_page = 1
+            for page in page_links:
+                href = page.attrs["href"]
+                for param in href.split("&"):
+                    kv = param.split("=")
+                    if kv[0] == "page":
+                        if int(kv[1]) > max_page:
+                            max_page = int(kv[1])
+                        break
+            self.max_page = max_page
+
+        ts_min = 0
+        ts_max = 0
+
+        # Find all messages in the page
+        messages_soup = soup.find_all("table", class_="messagetable")
+        for message_block in messages_soup:
+            message = Message.from_html(self, message_block)
+            if message:
+                self.add_message(message)
+                if ts_min == 0 or ts_min > message.posted_at:
+                    ts_min = message.posted_at
+                if ts_max == 0 or ts_max < message.posted_at:
+                    ts_max = message.posted_at
+
+        return {"ts_min": ts_min, "ts_max": ts_max}
+
+    def add_message(self, message) -> None:
+        msg_date = date_to_str(message.posted_at)
+
+        if msg_date in self.messages:
+            messages_for_date = self.messages[msg_date]
+        else:
+            if msg_date > self.max_date:
+                self.max_date = msg_date
+            logger.debug(f"Got a message at date {msg_date}")
+            messages_for_date = SortedDict()
+            self.messages[msg_date] = messages_for_date
+        messages_for_date[message.id] = message
+
+    def load_page(self, page: int) -> dict:
+        time.sleep(1)
+
+        url = f"https://forum.hardware.fr/forum2.php?config=hfr.inc&cat={self.cat}&subcat={self.subcat}&post={self.post}&print=1&page={page}"
+
+        r = requests.get(
+            url,
+            headers={
+                "Accept": "text/html",
+                "Accept-Encoding": "gzip, deflate, br, zstd",
+                "User-Agent": "HFRTopicSummarizer",
+            },
+        )
+        html = r.text
+
+        return self.parse_page_html(html)
+
+    def has_date(self, msg_date: str | date | datetime) -> bool:
+        return date_to_str(msg_date) in self.messages.keys()
+
+    def messages_on_date(self, msg_date: str):
+        date_str = str(msg_date)
+        if date_str in self.messages:
+            return self.messages[date_str].values()
+        else:
+            return ()
+
+    def to_dict(self) -> dict:
+        return {
+            "topic_id": f"{self.cat}#{self.subcat}#{self.post}",
+            "title": self.title,
+            "max_page": self.max_page,
+            "max_date": self.max_date,
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict):
+        if "topic_id" in data:
+            (cat, subcat, post) = str.split(data["topic_id"], "#")
+            return cls(
+                cat, subcat, post, data["title"], data["max_page"], data["max_date"]
+            )
+        else:
+            return cls(
+                data["cat"],
+                data["subcat"],
+                data["post"],
+                data["title"],
+                data["max_page"],
+                data["max_date"],
+            )

hfr_api-0.0.2.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 dotvav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hfr_api-0.0.2.dist-info/METADATA

@@ -0,0 +1,27 @@
+Metadata-Version: 2.2
+Name: hfr_api
+Version: 0.0.2
+Summary: A Python library to interface with forum.hardware.fr
+Home-page: https://gitea.ruk.info/roukine/hfr
+Author: MycRub
+Author-email: mycrub@mycrub.net
+License: MIT
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests==2.32.3
+Requires-Dist: beautifulsoup4==4.12.3
+Requires-Dist: sortedcontainers==2.4.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# HFR
+
+A python library to interface with forum.hardware.fr

hfr_api-0.0.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+hfr/__init__.py,sha256=Kk1VeTGXy4DU_lJEaz4NNMBt5gO1CEAxAY7kOoASFc8,140
+hfr/bb.py,sha256=PuqE2KCb9nHgI0-PzFjuY_h-c6QlgxsCupUjaFez7T8,4837
+hfr/message.py,sha256=QIdHHuGK1ljAjoZjGUzfwGhcHWAwrdlYcli1hGiJ-jQ,1827
+hfr/topic.py,sha256=wQBTI2R8R_-ecSGcwPA4BC2ffOrjlhJOv40OBJQSapo,4455
+hfr_api-0.0.2.dist-info/LICENSE,sha256=1wY3Wrq41PjRKJSzboA3D605lj0ITsv93o_eO5VCLDU,1063
+hfr_api-0.0.2.dist-info/METADATA,sha256=rrzASPQJOYoeU-sxmwa_GF-TF76WylrfD-HpTMwpxGs,669
+hfr_api-0.0.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+hfr_api-0.0.2.dist-info/top_level.txt,sha256=eHitRZNgYeO7SZcy3qaS6fhWw6jH0EPLIfdBiBfoNXg,4
+hfr_api-0.0.2.dist-info/RECORD,,

hfr_api-0.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

hfr_api-0.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+hfr