forked from snarfed/bridgy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mastodon.py
208 lines (172 loc) · 6.71 KB
/
mastodon.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
"""Mastodon source and datastore model classes."""
import logging
from flask import flash, render_template, request
from granary import mastodon as gr_mastodon
from granary import source as gr_source
import oauth_dropins.mastodon
from oauth_dropins.webutil.util import json_dumps, json_loads
import requests
from flask_app import app
import models
import util
from util import redirect
# https://docs.joinmastodon.org/api/oauth-scopes/
LISTEN_SCOPES = (
'read:accounts',
'read:blocks',
'read:notifications',
'read:search',
'read:statuses',
)
PUBLISH_SCOPES = LISTEN_SCOPES + (
'write:statuses',
'write:favourites',
'write:media',
)
SCOPE_SEPARATOR = oauth_dropins.mastodon.Start.SCOPE_SEPARATOR
class StartBase(oauth_dropins.mastodon.Start):
"""Abstract base OAuth starter class with our redirect URLs."""
DEFAULT_SCOPE = ''
REDIRECT_PATHS = (
'/mastodon/callback',
'/publish/mastodon/finish',
'/mastodon/delete/finish',
'/delete/finish',
)
def app_name(self):
return 'Bridgy'
def app_url(self):
return util.host_url()
class Mastodon(models.Source):
"""A Mastodon account.
The key name is the fully qualified address, eg '@[email protected]'.
"""
GR_CLASS = gr_mastodon.Mastodon
OAUTH_START = StartBase
SHORT_NAME = 'mastodon'
CAN_PUBLISH = True
HAS_BLOCKS = True
TYPE_LABELS = {
'post': 'toot',
'comment': 'reply',
'repost': 'boost',
'like': 'favorite',
}
DISABLE_HTTP_CODES = ('401', '403', '404')
@property
def URL_CANONICALIZER(self):
"""Generate URL_CANONICALIZER dynamically to use the instance's domain."""
return util.UrlCanonicalizer(
domain=self.gr_source.DOMAIN,
headers=util.REQUEST_HEADERS)
@staticmethod
def new(auth_entity=None, **kwargs):
"""Creates and returns a :class:`Mastodon` entity.
Args:
auth_entity: :class:`oauth_dropins.mastodon.MastodonAuth`
kwargs: property values
"""
user = json_loads(auth_entity.user_json)
return Mastodon(id=auth_entity.key_id(),
auth_entity=auth_entity.key,
url=user.get('url'),
name=user.get('display_name') or user.get('username'),
picture=user.get('avatar'),
**kwargs)
def username(self):
"""Returns the Mastodon username, e.g. alice."""
return self._split_address()[0]
def instance(self):
"""Returns the Mastodon instance URL, e.g. https://foo.com/."""
return self._split_address()[1]
def _split_address(self):
split = self.key_id().split('@')
assert len(split) == 3 and split[0] == '', self.key_id()
return split[1], split[2]
def user_tag_id(self):
"""Returns the tag URI for this source, e.g. 'tag:foo.com:alice'."""
return self.gr_source.tag_uri(self.username())
def silo_url(self):
"""Returns the Mastodon profile URL, e.g. https://foo.com/@bar."""
return json_loads(self.auth_entity.get().user_json).get('url')
def label_name(self):
"""Returns the username."""
return self.key_id()
@classmethod
def button_html(cls, feature, **kwargs):
"""Override oauth-dropins's button_html() to not show the instance text box."""
source = kwargs.get('source')
instance = source.instance() if source else ''
scopes = SCOPE_SEPARATOR.join(
PUBLISH_SCOPES if 'publish' in feature else LISTEN_SCOPES)
return """\
<form method="%s" action="/mastodon/start">
<input type="image" class="mastodon-button shadow" alt="Sign in with Mastodon"
src="/oauth_dropins_static/mastodon_large.png" />
<input name="feature" type="hidden" value="%s" />
<input name="instance" type="hidden" value="%s" />
<input name="scope" type="hidden" value="%s" />
</form>
""" % ('post' if instance else 'get', feature, instance, scopes)
def is_private(self):
"""Returns True if this Mastodon account is protected.
https://docs.joinmastodon.org/user/preferences/#misc
https://docs.joinmastodon.org/entities/account/
"""
return json_loads(self.auth_entity.get().user_json).get('locked')
def search_for_links(self):
"""Searches for activities with links to any of this source's web sites.
Returns:
sequence of ActivityStreams activity dicts
"""
if not self.domains:
return []
query = ' OR '.join(self.domains)
return self.get_activities(
search_query=query, group_id=gr_source.SEARCH, fetch_replies=False,
fetch_likes=False, fetch_shares=False)
def load_blocklist(self):
try:
return super().load_blocklist()
except requests.HTTPError as e:
if e.response.status_code == 403:
# this user signed up before we started asking for the 'follow' OAuth
# scope, which the block list API endpoint requires. just skip them.
# https://console.cloud.google.com/errors/CMfA_KfIld6Q2AE
logging.info("Couldn't fetch block list due to missing OAuth scope")
self.blocked_ids = []
self.put()
else:
raise
@app.route('/mastodon/start', methods=['GET'])
def enter_your_instance():
"""Serves the "Enter your instance" form page."""
return render_template('mastodon_instance.html')
class Start(StartBase):
def redirect_url(self, *args, **kwargs):
features = (request.form.get('feature') or '').split(',')
starter = util.oauth_starter(StartBase)('/mastodon/callback',
scopes=PUBLISH_SCOPES if 'publish' in features else LISTEN_SCOPES)
try:
return starter.redirect_url(*args, instance=request.form['instance'], **kwargs)
except ValueError as e:
logging.warning('Bad Mastodon instance', exc_info=True)
flash(util.linkify(str(e), pretty=True))
redirect(request.path)
class Callback(oauth_dropins.mastodon.Callback):
def finish(self, auth_entity, state=None):
source = util.maybe_add_or_delete_source(Mastodon, auth_entity, state)
features = util.decode_oauth_state(state).get('feature', '').split(',')
if set(features) != set(source.features):
# override features with whatever we requested scopes for just now, since
# scopes are per access token. background:
# https://github.com/snarfed/bridgy/issues/1015
source.features = features
source.put()
app.add_url_rule('/mastodon/start',
view_func=Start.as_view('mastodon_start', '/mastodon/callback'), methods=['POST'])
app.add_url_rule('/mastodon/callback', view_func=Callback.as_view('mastodon_callback', 'unused'))
app.add_url_rule('/mastodon/delete/finish',
view_func=oauth_dropins.mastodon.Callback.as_view('mastodon_delete_finish', '/delete/finish'))
app.add_url_rule('/mastodon/publish/start',
view_func=StartBase.as_view('mastodon_publish_finish', '/publish/mastodon/finish', scopes=PUBLISH_SCOPES), methods=['POST'])