Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactorise le code lié à Mastodon #104

Merged
merged 2 commits into from
Jun 30, 2023
Merged

Refactorise le code lié à Mastodon #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c65e496
Move code related to mastodon into specific module
Guts Jun 30, 2023
8843c1a
Improve log
Guts Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
223 changes: 1 addition & 222 deletions geotribu_cli/comments/comments_broadcast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,17 @@

# standard library
import argparse
import json
import logging
import sys
from os import getenv
from textwrap import shorten
from urllib import request
from urllib.error import HTTPError

# 3rd party
from rich import print

# package
from geotribu_cli.__about__ import __title_clean__, __version__
from geotribu_cli.comments.comments_latest import get_latest_comments
from geotribu_cli.comments.mdl_comment import Comment
from geotribu_cli.constants import GeotribuDefaults
from geotribu_cli.utils.file_downloader import BetterHTTPErrorProcessor
from geotribu_cli.social.mastodon_client import broadcast_to_mastodon
from geotribu_cli.utils.start_uri import open_uri
from geotribu_cli.utils.str2bool import str2bool

Expand All @@ -47,221 +41,6 @@
# ################################


def comment_to_media(in_comment: Comment, media: str) -> str:
"""Format comment to fit media size and publication rules.

Args:
in_comment: comment to format
media: name of the targetted media

Returns:
formatted comment
"""
if media == "mastodon":
logger.info(f"Formatting comment {in_comment.id} for {media}")
# 500 caractères - longueur du template = 370
max_text_length = (
370 - len(in_comment.author) - len(str(in_comment.id)) - 4
) # 4 = placeholder final

return status_mastodon_tmpl.format(
author=in_comment.author,
url_to_comment=in_comment.url_to_comment,
text=shorten(in_comment.markdownified_text, width=max_text_length),
id=in_comment.id,
)


def comment_already_broadcasted(comment_id: int, media: str = "mastodon") -> dict:
"""Check if comment has already been broadcasted on the media.

Args:
comment_id: id of the comment to check
media: name of the targetted media

Returns:
post on media if it has been already published
"""
if media == "mastodon":
if getenv("GEOTRIBU_MASTODON_API_ACCESS_TOKEN") is None:
logger.error(
"Le jeton d'accès à l'API Mastodon n'a pas été trouvé en variable "
"d'environnement GEOTRIBU_MASTODON_API_ACCESS_TOKEN. "
"Le récupérer depuis : https://mapstodon.space/settings/applications/7909"
)
return None

# prepare search request
request_data = {
"all": ["commentaire"],
"limit": 40,
"local": True,
"since_id": "110549835686856734",
}

json_data = json.dumps(request_data)
json_data_bytes = json_data.encode("utf-8") # needs to be bytes

headers = {
"User-Agent": f"{__title_clean__}/{__version__}",
"Content-Length": len(json_data_bytes),
"Content-Type": "application/json; charset=utf-8",
}
req = request.Request(
f"{defaults_settings.mastodon_base_url}api/v1/timelines/tag/geotribot",
method="GET",
headers=headers,
)

r = request.urlopen(url=req, data=json_data_bytes)
content = json.loads(r.read().decode("utf-8"))

for status in content:
if f"comment-{comment_id}</p>" in status.get("content"):
logger.info(
f"Le commentaire {comment_id} a déjà été publié sur {media} : "
f"{status.get('url')}"
)
return status
if status.get("replies_count", 0) < 1:
logger.debug(
f"Le statut {status.get('id')} n'a aucune réponse. Au suivant !"
)
continue
else:
logger.info(
f"Le statut {status.get('id')} a {status.get('replies_count')} "
"réponse(s). Cherchons parmi les réponses si le commentaire "
f"{comment_id} n'y est pas..."
)
req = request.Request(
f"{defaults_settings.mastodon_base_url}api/v1/statuses/"
f"{status.get('id')}/context",
method="GET",
headers=headers,
)
r = request.urlopen(url=req, data=json_data_bytes)
content = json.loads(r.read().decode("utf-8"))
for reply_status in content.get("descendants", []):
if f"comment-{comment_id}</p>" in reply_status.get("content"):
print(
f"Le commentaire {comment_id} a déjà été publié sur {media} : "
f"{reply_status.get('url')}, en réponse à {status.get('id')}"
)
return reply_status

logger.info(
f"Le commentaire {comment_id} n'a pas été trouvé. "
"Il est donc considéré comme nouveau."
)
return None


def broadcast_to_mastodon(in_comment: Comment, public: bool = True) -> dict:
"""Post the latest comment to Mastodon.

Args:
in_comment: comment to broadcast
public: if not, the comment is sent as direct message, so it's not public.

Returns:
URL to posted status
"""
if getenv("GEOTRIBU_MASTODON_API_ACCESS_TOKEN") is None:
logger.error(
"Le jeton d'accès à l'API Mastodon n'a pas été trouvé en variable "
"d'environnement GEOTRIBU_MASTODON_API_ACCESS_TOKEN. "
"Le récupérer depuis : https://mapstodon.space/settings/applications/7909"
)
return None

# check if comment has not been already published
already_broadcasted = comment_already_broadcasted(
comment_id=in_comment.id, media="mastodon"
)
if isinstance(already_broadcasted, dict):
already_broadcasted["cli_newly_posted"] = False
return already_broadcasted

# prepare status
request_data = {
"status": comment_to_media(in_comment=in_comment, media="mastodon"),
"language": "fr",
}

# check if parent comment has been posted
if in_comment.parent is not None:
comment_parent_broadcasted = comment_already_broadcasted(
comment_id=in_comment.parent, media="mastodon"
)
if (
isinstance(comment_parent_broadcasted, dict)
and "id" in comment_parent_broadcasted
):
print(
f"Le commentaire parent {in_comment.parent}a été posté précédemment sur "
f"Mastodon : {comment_parent_broadcasted.get('url')}. Le commentaire "
"actuel sera posté en réponse."
)
request_data["in_reply_to_id"] = comment_parent_broadcasted.get("id")
else:
print(
f"Le commentaire parent {in_comment.parent} n'a été posté précédemment "
"sur Mastodon. Le commentaire actuel sera donc posté comme nouveau fil "
"de discussion."
)

# unlisted or direct
if not public:
logger.debug("Comment will be posted as DIRECT message.")
request_data["visibility"] = "direct"
else:
logger.debug("Comment will be posted as UNLISTED message.")
request_data["visibility"] = getenv(
"GEOTRIBU_MASTODON_DEFAULT_VISIBILITY", "unlisted"
)

json_data = json.dumps(request_data)
json_data_bytes = json_data.encode("utf-8") # needs to be bytes

headers = {
"User-Agent": f"{__title_clean__}/{__version__}",
"Content-Length": len(json_data_bytes),
"Content-Type": "application/json; charset=utf-8",
"Authorization": f"Bearer {getenv('GEOTRIBU_MASTODON_API_ACCESS_TOKEN')}",
}

req = request.Request(
f"{defaults_settings.mastodon_base_url}api/v1/statuses",
method="POST",
headers=headers,
)

# install custom processor to handle 401 responses
opener = request.build_opener(BetterHTTPErrorProcessor)
request.install_opener(opener)
with request.urlopen(url=req, data=json_data_bytes) as response:
try:
content = json.loads(response.read().decode("utf-8"))
except Exception as err:
logger.warning(f"L'objet réponse ne semble pas être un JSON valide : {err}")
content = response.read().decode("utf-8")

if isinstance(content, dict) and "error" in content:
raise HTTPError(
url=req.full_url,
code="401",
msg=content,
hdrs=headers,
fp=None,
)

# set comment as newly posted
content["cli_newly_posted"] = True

return content


# ############################################################################
# ########## CLI #################
# ################################
Expand Down
Empty file added geotribu_cli/social/__init__.py
View file
Open in desktop
Empty file.
Loading