Toot-Mastodon-CLI-TUI-clien.../toot/api.py

397 lines
11 KiB
Python
Raw Normal View History

import re
import uuid
2017-04-16 14:14:33 +02:00
2018-06-12 10:40:36 +02:00
from urllib.parse import urlparse, urlencode, quote
2017-04-16 14:14:33 +02:00
2017-12-30 14:15:51 +01:00
from toot import http, CLIENT_NAME, CLIENT_WEBSITE
from toot.exceptions import AuthenticationError
2019-01-24 11:18:28 +01:00
from toot.utils import str_bool
2017-04-16 14:14:33 +02:00
SCOPES = 'read write follow'
2017-04-26 11:49:21 +02:00
def _account_action(app, user, account, action):
2023-01-02 10:12:42 +01:00
url = f"/api/v1/accounts/{account}/{action}"
2017-12-30 14:15:51 +01:00
return http.post(app, user, url).json()
2017-04-26 11:49:21 +02:00
def _status_action(app, user, status_id, action, data=None):
2023-01-02 10:12:42 +01:00
url = f"/api/v1/statuses/{status_id}/{action}"
return http.post(app, user, url, data=data).json()
def _tag_action(app, user, tag_name, action):
2023-01-02 10:12:42 +01:00
url = f"/api/v1/tags/{tag_name}/{action}"
return http.post(app, user, url).json()
2018-12-25 02:20:30 +01:00
def create_app(domain, scheme='https'):
2023-01-02 10:12:42 +01:00
url = f"{scheme}://{domain}/api/v1/apps"
2017-04-16 14:14:33 +02:00
json = {
2017-04-16 14:14:33 +02:00
'client_name': CLIENT_NAME,
'redirect_uris': 'urn:ietf:wg:oauth:2.0:oob',
'scopes': SCOPES,
'website': CLIENT_WEBSITE,
}
2017-04-16 14:14:33 +02:00
return http.anon_post(url, json=json).json()
2017-04-16 14:14:33 +02:00
2023-01-02 10:11:19 +01:00
def get_muted_accounts(app, user):
return http.get(app, user, "/api/v1/mutes").json()
def get_blocked_accounts(app, user):
return http.get(app, user, "/api/v1/blocks").json()
def register_account(app, username, email, password, locale="en", agreement=True):
"""
Register an account
https://docs.joinmastodon.org/methods/accounts/#create
"""
token = fetch_app_token(app)["access_token"]
url = f"{app.base_url}/api/v1/accounts"
headers = {"Authorization": f"Bearer {token}"}
json = {
"username": username,
"email": email,
"password": password,
"agreement": agreement,
"locale": locale
}
return http.anon_post(url, json=json, headers=headers).json()
def fetch_app_token(app):
json = {
"client_id": app.client_id,
"client_secret": app.client_secret,
"grant_type": "client_credentials",
"redirect_uri": "urn:ietf:wg:oauth:2.0:oob",
"scope": "read write"
}
return http.anon_post(f"{app.base_url}/oauth/token", json=json).json()
2017-04-16 14:14:33 +02:00
def login(app, username, password):
url = app.base_url + '/oauth/token'
data = {
2017-04-16 14:14:33 +02:00
'grant_type': 'password',
'client_id': app.client_id,
'client_secret': app.client_secret,
'username': username,
'password': password,
'scope': SCOPES,
}
response = http.anon_post(url, data=data, allow_redirects=False)
2017-04-16 14:14:33 +02:00
# If auth fails, it redirects to the login page
if response.is_redirect:
raise AuthenticationError()
2017-04-16 14:14:33 +02:00
return response.json()
2017-04-16 14:14:33 +02:00
def get_browser_login_url(app):
"""Returns the URL for manual log in via browser"""
return "{}/oauth/authorize/?{}".format(app.base_url, urlencode({
"response_type": "code",
"redirect_uri": "urn:ietf:wg:oauth:2.0:oob",
2018-03-05 16:10:34 +01:00
"scope": SCOPES,
"client_id": app.client_id,
}))
def request_access_token(app, authorization_code):
url = app.base_url + '/oauth/token'
data = {
'grant_type': 'authorization_code',
'client_id': app.client_id,
'client_secret': app.client_secret,
'code': authorization_code,
'redirect_uri': 'urn:ietf:wg:oauth:2.0:oob',
}
return http.anon_post(url, data=data, allow_redirects=False).json()
2018-06-13 12:43:31 +02:00
def post_status(
app,
user,
status,
visibility='public',
media_ids=None,
sensitive=False,
spoiler_text=None,
in_reply_to_id=None,
language=None,
2021-01-17 12:42:08 +01:00
scheduled_at=None,
2021-08-28 21:08:44 +02:00
content_type=None,
2018-06-13 12:43:31 +02:00
):
"""
Publish a new status.
https://docs.joinmastodon.org/methods/statuses/#create
2018-06-13 12:43:31 +02:00
"""
# Idempotency key assures the same status is not posted multiple times
# if the request is retried.
headers = {"Idempotency-Key": uuid.uuid4().hex}
json = {
2017-04-16 14:14:33 +02:00
'status': status,
'media_ids': media_ids,
2017-04-16 14:14:33 +02:00
'visibility': visibility,
'sensitive': sensitive,
2018-06-13 12:43:31 +02:00
'in_reply_to_id': in_reply_to_id,
'language': language,
'scheduled_at': scheduled_at,
'content_type': content_type,
'spoiler_text': spoiler_text
2021-08-28 21:08:44 +02:00
}
# Strip keys for which value is None
# Sending null values doesn't bother Mastodon, but it breaks Pleroma
json = {k: v for k, v in json.items() if v is not None}
2021-08-28 21:08:44 +02:00
return http.post(app, user, '/api/v1/statuses', json=json, headers=headers).json()
2017-04-16 14:14:33 +02:00
def fetch_status(app, user, id):
"""
Fetch a single status
https://docs.joinmastodon.org/methods/statuses/#get
"""
return http.get(app, user, f"/api/v1/statuses/{id}").json()
2022-12-01 08:35:55 +01:00
def scheduled_statuses(app, user):
"""
List scheduled statuses
https://docs.joinmastodon.org/methods/scheduled_statuses/#get
"""
return http.get(app, user, "/api/v1/scheduled_statuses").json()
2018-06-14 10:40:16 +02:00
def delete_status(app, user, status_id):
"""
Deletes a status with given ID.
https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#deleting-a-status
"""
2023-01-02 10:12:42 +01:00
return http.delete(app, user, f"/api/v1/statuses/{status_id}")
2018-06-14 10:40:16 +02:00
def favourite(app, user, status_id):
return _status_action(app, user, status_id, 'favourite')
def unfavourite(app, user, status_id):
return _status_action(app, user, status_id, 'unfavourite')
def reblog(app, user, status_id, visibility="public"):
return _status_action(app, user, status_id, 'reblog', data={"visibility": visibility})
def unreblog(app, user, status_id):
return _status_action(app, user, status_id, 'unreblog')
def pin(app, user, status_id):
return _status_action(app, user, status_id, 'pin')
def unpin(app, user, status_id):
return _status_action(app, user, status_id, 'unpin')
2022-11-17 06:28:41 +01:00
def bookmark(app, user, status_id):
return _status_action(app, user, status_id, 'bookmark')
def unbookmark(app, user, status_id):
return _status_action(app, user, status_id, 'unbookmark')
def translate(app, user, status_id):
return _status_action(app, user, status_id, 'translate')
def context(app, user, status_id):
2023-01-02 10:12:42 +01:00
url = f"/api/v1/statuses/{status_id}/context"
2019-01-24 09:36:25 +01:00
return http.get(app, user, url).json()
def reblogged_by(app, user, status_id):
2023-01-02 10:12:42 +01:00
url = f"/api/v1/statuses/{status_id}/reblogged_by"
return http.get(app, user, url).json()
2019-02-13 14:19:27 +01:00
def _get_next_path(headers):
2018-01-06 11:25:05 +01:00
"""Given timeline response headers, returns the path to the next batch"""
links = headers.get('Link', '')
matches = re.match('<([^>]+)>; rel="next"', links)
if matches:
parsed = urlparse(matches.group(1))
return "?".join([parsed.path, parsed.query])
def _timeline_generator(app, user, path, params=None):
while path:
response = http.get(app, user, path, params)
yield response.json()
2019-02-13 14:19:27 +01:00
path = _get_next_path(response.headers)
2017-04-16 14:14:33 +02:00
2018-01-06 11:25:05 +01:00
def home_timeline_generator(app, user, limit=20):
2023-01-02 10:12:42 +01:00
path = f"/api/v1/timelines/home?limit={limit}"
2018-01-06 11:25:05 +01:00
return _timeline_generator(app, user, path)
def public_timeline_generator(app, user, local=False, limit=20):
path = '/api/v1/timelines/public'
2019-01-24 11:18:28 +01:00
params = {'local': str_bool(local), 'limit': limit}
return _timeline_generator(app, user, path, params)
def tag_timeline_generator(app, user, hashtag, local=False, limit=20):
2023-01-02 10:12:42 +01:00
path = f"/api/v1/timelines/tag/{quote(hashtag)}"
2019-01-24 11:18:28 +01:00
params = {'local': str_bool(local), 'limit': limit}
return _timeline_generator(app, user, path, params)
2018-01-06 11:25:05 +01:00
def bookmark_timeline_generator(app, user, limit=20):
path = '/api/v1/bookmarks'
params = {'limit': limit}
return _timeline_generator(app, user, path, params)
def timeline_list_generator(app, user, list_id, limit=20):
2023-01-02 10:12:42 +01:00
path = f"/api/v1/timelines/list/{list_id}"
return _timeline_generator(app, user, path, {'limit': limit})
def _anon_timeline_generator(instance, path, params=None):
while path:
2023-01-02 10:12:42 +01:00
url = f"https://{instance}{path}"
response = http.anon_get(url, params)
yield response.json()
path = _get_next_path(response.headers)
def anon_public_timeline_generator(instance, local=False, limit=20):
path = '/api/v1/timelines/public'
params = {'local': str_bool(local), 'limit': limit}
return _anon_timeline_generator(instance, path, params)
def anon_tag_timeline_generator(instance, hashtag, local=False, limit=20):
2023-01-02 10:12:42 +01:00
path = f"/api/v1/timelines/tag/{quote(hashtag)}"
params = {'local': str_bool(local), 'limit': limit}
return _anon_timeline_generator(instance, path, params)
2021-08-26 17:54:31 +02:00
def upload_media(app, user, file, description=None):
return http.post(app, user, '/api/v1/media',
data={'description': description},
files={'file': file}
).json()
2017-04-16 15:07:27 +02:00
2022-11-27 09:56:58 +01:00
def search(app, user, query, resolve=False, type=None):
"""
Perform a search.
https://docs.joinmastodon.org/methods/search/#v2
"""
return http.get(app, user, "/api/v2/search", {
"q": query,
"resolve": resolve,
"type": type
}).json()
2017-04-16 17:15:05 +02:00
def follow(app, user, account):
2017-04-26 11:49:21 +02:00
return _account_action(app, user, account, 'follow')
2017-04-16 17:15:05 +02:00
def unfollow(app, user, account):
2017-04-26 11:49:21 +02:00
return _account_action(app, user, account, 'unfollow')
2017-04-16 17:15:05 +02:00
2022-11-22 21:27:21 +01:00
def follow_tag(app, user, tag_name):
return _tag_action(app, user, tag_name, 'follow')
def unfollow_tag(app, user, tag_name):
return _tag_action(app, user, tag_name, 'unfollow')
def _get_response_list(app, user, path):
items = []
while path:
response = http.get(app, user, path)
items += response.json()
path = _get_next_path(response.headers)
return items
2022-11-22 21:27:21 +01:00
def following(app, user, account):
2023-01-02 10:12:42 +01:00
path = f"/api/v1/accounts/{account}/following"
return _get_response_list(app, user, path)
2022-11-22 21:27:21 +01:00
def followers(app, user, account):
2023-01-02 10:12:42 +01:00
path = f"/api/v1/accounts/{account}/followers"
return _get_response_list(app, user, path)
def followed_tags(app, user):
path = '/api/v1/followed_tags'
return _get_response_list(app, user, path)
2017-04-26 11:49:21 +02:00
def mute(app, user, account):
return _account_action(app, user, account, 'mute')
def unmute(app, user, account):
return _account_action(app, user, account, 'unmute')
def block(app, user, account):
return _account_action(app, user, account, 'block')
def unblock(app, user, account):
return _account_action(app, user, account, 'unblock')
2017-04-16 17:52:54 +02:00
def verify_credentials(app, user):
2017-12-30 14:15:51 +01:00
return http.get(app, user, '/api/v1/accounts/verify_credentials').json()
def single_status(app, user, status_id):
2023-01-02 10:12:42 +01:00
url = f"/api/v1/statuses/{status_id}"
return http.get(app, user, url).json()
def get_notifications(app, user, exclude_types=[], limit=20):
2022-11-22 21:27:21 +01:00
params = {"exclude_types[]": exclude_types, "limit": limit}
return http.get(app, user, '/api/v1/notifications', params).json()
2017-12-29 14:26:40 +01:00
def clear_notifications(app, user):
http.post(app, user, '/api/v1/notifications/clear')
def get_instance(domain, scheme="https"):
2023-01-02 10:12:42 +01:00
url = f"{scheme}://{domain}/api/v1/instance"
return http.anon_get(url).json()