"""Convert ActivityStreams to microformats2 HTML and JSON.
Microformats2 specs: http://microformats.org/wiki/microformats2
ActivityStreams 1 specs: http://activitystrea.ms/specs/
"""
from collections import defaultdict
import copy
from datetime import timedelta
import html
import itertools
import logging
import urllib.parse
import string
import re
import xml.sax.saxutils
import dateutil.parser
import humanfriendly
import mf2util
from webutil import util
from webutil.util import (
dedupe_urls,
get_first,
get_list,
get_url,
get_urls,
uniquify,
)
from . import as1
from . import source
logger = logging.getLogger(__name__)
HENTRY = string.Template("""\
<article class="$types">
<span class="p-uid">$uid</span>
$summary
$published
$updated
$author
$linked_name
<div class="$content_classes">
$invitees
$content
</div>
$attachments
$sizes
$event_times
$location
$categories
$links
$children
$comments
</article>
""")
HCARD = string.Template("""\
<span class="$types">
$ids
$linked_name
$nicknames
$photos
</span>
""")
LINK = string.Template(' <a class="u-$cls" href="$url"></a>')
AS_TO_MF2_TYPE = {
'application': ['h-card'],
'event': ['h-event'],
'group': ['h-card'],
'organization': ['h-card'],
'person': ['h-card'],
'place': ['h-card', 'p-location'],
'service': ['h-card'],
}
# silly hack: i haven't found anywhere in AS1 or AS2 to indicate that
# something is being "quoted," like in a quote tweet, so i cheat and use
# extra knowledge here that quoted tweets are converted to note
# attachments, but URLs in the tweet text are converted to article tags.
AS_ATTACHMENT_TO_MF2_TYPE = {
'article': ['h-cite'],
'comment': ['u-quotation-of', 'h-cite'],
'note': ['u-quotation-of', 'h-cite'],
'service': ['h-app'], # eg a Bluesky custom feed
}
MF2_TO_AS_TYPE_VERB = {
'article': ('article', None),
'bookmark': ('activity', 'post'),
'event': ('event', None),
'follow': ('activity', 'follow'),
'invite': ('activity', 'invite'),
'like': ('activity', 'like'),
'location': ('place', None),
'note': ('note', None),
'org': ('organization', None),
'person': ('person', None),
'reply': ('comment', None),
'repost': ('activity', 'share'),
'rsvp': ('activity', None), # json_to_object() will generate verb from rsvp
'tag': ('activity', 'tag'),
}
# ISO 6709 location string. http://en.wikipedia.org/wiki/ISO_6709
ISO_6709_RE = re.compile(r'([-+][0-9.]+)([-+][0-9.]+).*/')
[docs]
def get_string_urls(objs):
"""Extracts string URLs from a list of either string URLs or mf2 dicts.
Many mf2 properties can contain either string URLs or full mf2 objects, eg
``h-cite``. ``in-reply-to`` is the most commonly used example:
http://indiewebcamp.com/in-reply-to#How_to_consume_in-reply-to
Args:
objs (sequence of str or dict): URLs or embedded mf2 objects
Returns:
list of str: URLs
"""
if not objs:
return []
urls = []
for item in objs:
if isinstance(item, str):
urls.append(item)
else:
itemtype = [x for x in item.get('type', []) if x.startswith('h-')]
if itemtype:
item = item.get('properties') or item
urls.extend(get_string_urls(item.get('url', [])))
return urls
[docs]
def get_html(val):
"""Returns a string value that may have HTML markup.
Args:
value (str or dict): mf2 property value, either str or
``{'html': '<p>str</p>', 'value': 'str'}``
Returns:
str or None:
"""
if val is None:
return None
elif isinstance(val, dict) and val.get('html'):
return val['html'].strip()
return html.escape(get_text(val), quote=False)
[docs]
def get_text(val):
"""Returns a plain text string value. See :func:`get_html`."""
if isinstance(val, dict):
val = val.get('value')
return val.strip() if val else ''
[docs]
def maybe_normalize_iso8601(val):
"""Tries to normalize a string datetime value to ISO-8601.
Args:
val (str)
Returns:
str: normalized ISO-8601 if val can be parsed, otherwise val unchanged
"""
if not val:
return val
val = get_text(val)
try:
return dateutil.parser.parse(val).isoformat()
except (OverflowError, ValueError) as e:
logger.debug(e)
return val
def _activity_or_object(activity):
"""Returns the base item we care about, ``activity`` or ``activity['object']``.
Used in :func:`activity_to_json()` and :func:`activities_to_html()`.
"""
if activity.get('object') and activity.get('verb') not in as1.VERBS_WITH_OBJECT:
return activity['object']
return activity
[docs]
def from_as1(obj, trim_nulls=True, entry_class='h-entry',
default_object_type=None, synthesize_content=True, multiple=False):
"""Converts an ActivityStreams object to microformats2 JSON.
Args:
obj (dict): a decoded JSON ActivityStreams object or activity
trim_nulls (bool): whether to remove elements with null or empty values
entry_class (str or sequence of str), the mf2 class(es) that entries should be
given, eg ``h-cite`` when parsing a reference to a foreign entry.
defaults to `h-entry``
default_object_type (str): the ActivityStreams ``objectType`` to use if one
is not present. defaults to None
synthesize_content (bool): whether to generate synthetic content if the object
doesn't have its own, eg ``likes this`` or ``shared this``
multiple (bool): unused, for compatibility with other from_as1 functions
Returns:
dict: decoded microformats2 JSON
"""
if not obj or not isinstance(obj, dict):
return {}
obj_type = as1.object_type(obj) or default_object_type
# if the activity type is a post, then it's really just a conduit
# for the object. for other verbs, the activity itself is the
# interesting thing
if obj_type == 'post':
primary = as1.get_object(obj, 'object')
obj_type = as1.object_type(primary) or default_object_type
else:
primary = obj
# TODO: extract snippet
name = primary.get('displayName', primary.get('title'))
summary = primary.get('summary')
note = primary.get('note')
author = obj.get('author', obj.get('actor', {}))
in_reply_tos = as1.get_objects(obj, 'inReplyTo')
if not in_reply_tos:
context = obj.get('context')
if context and isinstance(context, dict):
in_reply_tos = as1.get_objects(context, 'inReplyTo')
is_rsvp = obj_type in ('rsvp-yes', 'rsvp-no', 'rsvp-maybe')
if is_rsvp or obj_type == 'react':
in_reply_tos.extend(as1.get_objects(obj))
in_reply_tos = list(util.trim_nulls(itertools.chain.from_iterable(
[o.get('id'), o.get('url')] for o in in_reply_tos)))
# maps objectType to list of objects
attachments = defaultdict(list)
for prop in 'attachments', 'tags':
for elem in get_list(primary, prop):
attachments[elem.get('objectType')].append(elem)
# prefer duration and size from object's stream, then first video, then first
# audio
stream = {}
for candidate in [obj] + attachments['video'] + attachments['audio']:
for stream in get_list(candidate, 'stream'):
if stream:
break
duration = stream.get('duration')
if duration is not None:
if util.is_int(duration):
duration = util.to_iso8601_duration(timedelta(seconds=int(duration)))
elif util.parse_iso8601_duration(duration):
pass
else:
logger.warning('Ignoring duration %r; expected int or ISO 8601, got %s',
duration, duration.__class__)
duration = None
size = stream.get('size')
sizes = [str(size)] if size else []
# attachments to children
children = []
for att_type, atts in attachments.items():
if mf2_types := AS_ATTACHMENT_TO_MF2_TYPE.get(att_type):
for att in atts:
if 'startIndex' not in att:
child = object_to_json(att, trim_nulls=False, entry_class=mf2_types)
if att_type == 'note' and (id := att.get('id')):
child['properties']['url'] = [id]
children.append(child)
# construct mf2!
ret = {
'type': (AS_TO_MF2_TYPE.get(obj_type) or
[entry_class] if isinstance(entry_class, str)
else list(entry_class)),
'properties': {
'uid': [obj.get('id') or ''],
'numeric-id': [obj.get('numeric_id') or ''],
'name': [name],
'org': [name] if obj_type == 'organization' else None,
'nickname': [obj.get('username') or ''],
('note' if obj_type in as1.ACTOR_TYPES else 'summary'): [summary],
'url': (list(as1.object_urls(obj) or as1.object_urls(primary)) +
obj.get('upstreamDuplicates', [])),
# photo is special cased below, to handle alt
'video': dedupe_urls(get_urls(attachments, 'video', 'stream') +
get_urls(primary, 'stream')),
'audio': get_urls(attachments, 'audio', 'stream'),
'duration': [duration],
'size': sizes,
'published': [maybe_normalize_iso8601(
obj.get('published') or primary.get('published'))],
'updated': [maybe_normalize_iso8601(
obj.get('updated') or primary.get('updated'))],
'in-reply-to': in_reply_tos,
'author': [object_to_json(
author, trim_nulls=False, default_object_type='person')],
'location': [object_to_json(as1.get_object(primary, 'location'),
trim_nulls=False, default_object_type='place')],
'comment': [object_to_json(c, trim_nulls=False, entry_class='h-cite')
for c in as1.get_object(obj, 'replies').get('items', [])],
'start': [primary.get('startTime')],
'end': [primary.get('endTime')],
},
'children': children,
}
# content. emulate e- vs p- microformats2 parsing: e- if there are HTML tags,
# otherwise p-.
# https://indiewebcamp.com/note#Indieweb_whitespace_thinking
text = html.unescape(primary.get('content') or '')
rendered = render_content(primary, include_location=False,
synthesize_content=synthesize_content)
if '<' in rendered:
ret['properties']['content'] = [{'value': text, 'html': rendered}]
else:
ret['properties']['content'] = [text]
# photos, including alt text
photo_urls = set()
ret['properties']['photo'] = []
for img in as1.get_objects(attachments, 'image') + as1.get_objects(primary, 'image'):
if img.get('image'):
img = as1.get_object(img, 'image')
url = get_url(img) or img.get('id')
if url and url not in photo_urls:
photo_urls.add(url)
name = img.get('displayName')
ret['properties']['photo'].append({'value': url, 'alt': name} if name else url)
# hashtags and person tags
if obj_type == 'tag':
ret['properties']['tag-of'] = util.get_urls(obj, 'target')
inner_obj = as1.get_object(obj)
tags = obj.get('tags', []) or inner_obj.get('tags', [])
if not tags and obj_type == 'tag':
tags = util.get_list(obj, 'object')
ret['properties']['category'] = []
for tag in tags:
if tag.get('objectType') in as1.ACTOR_TYPES:
ret['properties']['category'].append(
object_to_json(tag, entry_class='u-category h-card'))
elif tag.get('objectType') == 'hashtag' or obj_type == 'tag':
name = tag.get('displayName')
if name:
ret['properties']['category'].append(name)
# rsvp
if is_rsvp:
ret['properties']['rsvp'] = [obj_type[len('rsvp-'):]]
elif obj_type == 'invite':
invitee = object_to_json(inner_obj, trim_nulls=False,
default_object_type='person')
ret['properties']['invitee'] = [invitee]
# like and repost mentions
for type, prop in (
('favorite', 'like'),
('follow', 'follow'),
('like', 'like'),
('share', 'repost'),
):
if obj_type == type:
# The ActivityStreams spec says the object property should always be a
# single object, but it's useful to let it be a list, eg when a like has
# multiple targets, eg a like of a post with original post URLs in it,
# which brid.gy does.
objs = as1.get_objects(obj)
ret['properties'][prop + '-of'] = [
# flatten contexts that are just a url
(o.get('url') or o.get('id')) if o.keys() <= set(['id', 'url', 'objectType'])
else object_to_json(o, trim_nulls=False, entry_class='h-cite')
for o in objs]
# remove properties that aren't appropriate for this type and may confuse
# mf2 consumers
# https://github.com/snarfed/bridgy-fed/issues/941
ret['properties']['in-reply-to'] = None
else:
# received likes and reposts
ret['properties'][prop] = [
object_to_json(t, trim_nulls=False, entry_class='h-cite')
for t in tags if as1.object_type(t) == type]
# bookmarks
if obj_type == 'bookmark':
ret['properties']['bookmark-of'] = [primary.get('targetUrl')]
# latitude & longitude
lat = long = None
position = ISO_6709_RE.fullmatch(primary.get('position') or '')
if position:
lat, long = position.groups()
if not lat:
lat = primary.get('latitude')
if not long:
long = primary.get('longitude')
if lat:
ret['properties']['latitude'] = [str(lat)]
if long:
ret['properties']['longitude'] = [str(long)]
if trim_nulls:
ret = util.trim_nulls(ret)
return ret
object_to_json = from_as1
"""Deprecated! Use :meth:`from_as1` instead."""
[docs]
def activity_to_json(activity, **kwargs):
"""Converts an ActivityStreams activity to microformats2 JSON.
Deprecated! Use :func:`from_as1` instead.
Args:
activity (dict): a decoded JSON ActivityStreams activity
kwargs: passed to :func:`object_to_json`
Returns:
dict: decoded microformats2 JSON
"""
return object_to_json(_activity_or_object(activity), **kwargs)
[docs]
def to_as1(mf2, actor=None, fetch_mf2=False, rel_urls=None):
"""Converts a single microformats2 JSON item to an ActivityStreams object.
Supports ``h-entry``, ``h-event``, ``h-card``, and other single item times.
Does *not* yet support ``h-feed``.
If ``rel_urls`` is provided, the returned ``url`` and ``urls`` fields will be
objects that may include ``displayName`` fields with the text or ``title``
from the original HTML links.
Args:
mf2 (dict): decoded JSON microformats2 object
actor (dict): optional author AS actor object. usually comes from a
``rel="author"`` link. if ``mf2`` has its own author, that overrides this
fetch_mf2 (bool): whether to fetch additional pages via HTTP if necessary,
eg to determine authorship: https://indieweb.org/authorship
rel_urls (dict): optional `rel-urls` field from parsed mf2
Returns:
dict: ActivityStreams object
"""
if not mf2 or not isinstance(mf2, dict):
return {}
mf2 = copy.copy(mf2)
props = mf2.setdefault('properties', {})
prop = first_props(props)
# convert author
mf2_author = prop.get('author')
if mf2_author and isinstance(mf2_author, dict):
author = json_to_object(mf2_author)
else:
# the author h-card may be on another page. run full authorship algorithm:
# https://indieweb.org/authorship
author = find_author({'items': [mf2]}, hentry=mf2,
fetch_mf2_func=util.fetch_mf2 if fetch_mf2 else None)
if not author:
author = actor
mf2_types = mf2.get('type') or []
if 'h-geo' in mf2_types or 'p-location' in mf2_types:
mf2_type = 'location'
elif 'tag-of' in props:
# TODO: remove once this is in mf2util
# https://github.com/kylewm/mf2util/issues/18
mf2_type = 'tag'
elif 'follow-of' in props: # ditto
mf2_type = 'follow'
elif 'bookmark-of' in props: # ditto
mf2_type = 'bookmark'
else:
# mf2 'photo' type is a note or article *with* a photo, but AS 'photo' type
# *is* a photo. so, special case photo type to fall through to underlying
# mf2 type without photo.
# https://github.com/snarfed/bridgy/issues/702
without_photo = copy.deepcopy(mf2)
without_photo.get('properties', {}).pop('photo', None)
mf2_type = mf2util.post_type_discovery(without_photo)
as_type, as_verb = MF2_TO_AS_TYPE_VERB.get(mf2_type, (None, None))
rsvp = get_text(prop.get('rsvp'))
if rsvp:
as_verb = f'rsvp-{rsvp}'
# special case GitHub issues that are in-reply-to the repo or its issues URL
in_reply_tos = get_string_urls(props.get('in-reply-to', []))
for url in in_reply_tos:
if re.fullmatch(r'https?://github.com/[^/]+/[^/]+(/issues)?/?', url):
as_type = 'issue'
def is_absolute(url):
"""Filter out relative and invalid URLs (mf2py gives absolute urls)."""
return urllib.parse.urlparse(url).netloc
# urls, with displayName if available in rel_urls
urls = []
for u in get_string_urls(props.get('url')):
if not util.is_url(u):
logger.debug(f'ignoring bad u-url {u}')
continue
rel = rel_urls.get(u, {}) if rel_urls else {}
urls.append({
'value': u,
'displayName': (rel.get('text') or rel.get('title') or '').strip(),
})
# quotations: https://indieweb.org/quotation#How_to_markup
# u-quotation-of items must have objectType 'note' so that as2.from_as1
# recognizes them as quote posts (not article attachments).
attachments = []
for quote in mf2.get('children', []) + props.get('quotation-of', []):
if isinstance(quote, dict) and 'h-cite' in set(quote.get('type', [])):
attachments.append({
**json_to_object(quote),
'objectType': 'note',
})
# audio and video
#
# the duration mf2 property is still emerging. examples in the wild use both
# int seconds and ISO 8601 durations.
# https://indieweb.org/duration
# https://en.wikipedia.org/wiki/ISO_8601#Durations
duration = prop.get('duration') or prop.get('length')
if duration:
if util.is_int(duration):
duration = int(duration)
else:
parsed = util.parse_iso8601_duration(duration)
if parsed:
duration = int(parsed.total_seconds())
else:
logger.debug(f'Unknown format for length or duration {duration!r}')
duration = None
stream = None
bytes = size_to_bytes(prop.get('size'))
for type in 'audio', 'video':
atts = [{
'objectType': type,
'stream': {
'url': url,
# int seconds: http://activitystrea.ms/specs/json/1.0/#media-link
'duration': duration,
# file size in bytes. nonstandard, not in AS1 or AS2
'size': bytes,
},
} for url in get_string_urls(props.get(type, []))]
attachments.extend(atts)
if atts:
stream = atts[0]['stream']
obj = {
'id': prop.get('uid'),
'objectType': as_type,
'verb': as_verb,
'published': maybe_normalize_iso8601(prop.get('published')),
'updated': maybe_normalize_iso8601(prop.get('updated')),
'startTime': prop.get('start'),
'endTime': prop.get('end'),
'displayName': get_text(prop.get('name')),
'username': prop.get('nickname'),
'summary': get_text(prop.get('summary') or prop.get('note')),
'content': get_html(prop.get('content')),
'url': urls[0]['value'] if urls else None,
'urls': urls if len(urls) > 1 or rel_urls else None,
# image is special cased below, to handle alt
'stream': [stream],
'location': json_to_object(prop.get('location')),
'replies': {'items': [json_to_object(c) for c in props.get('comment', [])]},
'tags': [{'objectType': 'hashtag', 'displayName': cat.removeprefix('#')}
if isinstance(cat, str)
else json_to_object(cat)
for cat in props.get('category', [])],
'attachments': attachments,
}
# images, including alt text
photo_urls = set()
featured = props.get('featured', [])
obj['image'] = []
for photo in props.get('photo', []) + featured:
url = photo
alt = None
if isinstance(photo, dict):
photo = photo.get('properties') or photo
url = get_first(photo, 'value') or get_first(photo, 'url')
alt = get_first(photo, 'alt')
if url and url not in photo_urls and is_absolute(url):
photo_urls.add(url)
obj['image'].append({
'url': url,
'displayName': alt,
'objectType': 'featured' if photo in featured else None,
})
# mf2util uses the indieweb/mf2 location algorithm to collect locations
interpreted = None
try:
interpreted = mf2util.interpret({'items': [mf2]}, None)
except (AttributeError, ValueError) as e:
logger.warning('mf2util.interpret failed')
if interpreted:
loc = interpreted.get('location')
if loc:
obj['location']['objectType'] = 'place'
lat, lng = loc.get('latitude'), loc.get('longitude')
if lat and lng:
try:
obj['location'].update({
'latitude': float(lat),
'longitude': float(lng),
})
except ValueError:
logger.debug(
'Could not convert latitude/longitude (%s, %s) to decimal', lat, lng)
objects = []
if as_type == 'activity':
objects = []
field = ('invitee' if mf2_type == 'invite'
else 'in-reply-to' if mf2_type == 'rsvp'
else f'{mf2_type}-of' if mf2_type in ('bookmark', 'follow', 'like',
'repost', 'tag')
else None)
for target in util.get_list(props, field):
t = json_to_object(target)
if t.keys() <= set(['objectType']):
t = get_text(target)
if rsvp:
if isinstance(t, str):
t = {'id': t}
elif not t.get('id'):
t['id'] = t.get('url')
t['objectType'] = 'event'
elif mf2_type == 'bookmark':
t = {'objectType': 'bookmark', 'targetUrl': get_text(target)}
# eliminate duplicates from redundant backcompat properties
if t not in objects:
objects.append(t)
obj.update({
'object': objects[0] if len(objects) == 1 else objects,
'actor': author,
})
# tags need target field
# https://activitystrea.ms/specs/json/schema/activity-schema.html#context
# https://activitystrea.ms/specs/json/1.0/#introduction
if as_verb == 'tag':
obj.update({
'target': {'url': util.get_first(obj, 'object')},
'object': obj.pop('tags'),
})
else:
# this is an object, not an activity
obj.update({
'inReplyTo': in_reply_tos,
'author': author,
})
as1.add_tags_for_html_content_links(obj)
return source.Source.postprocess_object(obj)
json_to_object = to_as1
"""Deprecated! Use :meth:`to_as1` instead."""
[docs]
def html_hfeed_to_as1(html, url=None, actor=None, id=None):
"""Converts a microformats2 HTML ``h-feed`` to ActivityStreams activities.
Args:
html (str): HTML or :class:`requests.Response`
url (str): optional URL that HTML came from
actor (dict): optional author AS actor object for all activities. usually comes
from a ``rel="author"`` link.
id (str): optional id of specific element to extract and parse. defaults
to the whole page.
Returns:
list of dict: ActivityStreams activities
"""
return hfeed_to_as1(util.parse_mf2(html, url=url, id=id), actor=actor)
html_to_activities = html_hfeed_to_as1
"""Deprecated! Use :func:`html_hfeed_to_as1` instead."""
[docs]
def hfeed_to_as1(parsed, actor=None):
"""Converts a parsed microformats2 JSON ``h-feed`` to ActivityStreams activities.
Args:
parsed (dict): parsed JSON microformats2 document
actor (dict): optional author AS actor object for all activities. usually
comes from a ``rel="author"`` link.
Returns:
list of dict: ActivityStreams activities
"""
hfeed = mf2util.find_first_entry(parsed, ['h-feed'])
items = hfeed.get('children', []) if hfeed else parsed.get('items', [])
activities = []
for item in items:
types = item.get('type', [])
if 'h-entry' in types or 'h-event' in types or 'h-cite' in types:
obj = json_to_object(item, actor=actor)
obj['content_is_html'] = True
if obj.get('verb') or obj.get('objectType') == 'activity':
activities.append(obj)
else:
activities.append({
'objectType': 'activity',
'verb': 'post',
'object': obj,
})
return activities
json_to_activities = hfeed_to_as1
"""Deprecated! Use :func:`hfeed_to_as1` instead."""
[docs]
def activities_to_html(activities, extra='', body_class=''):
"""Converts ActivityStreams activities to a microformats2 HTML ``h-feed``.
Args:
obj (dict): a decoded JSON ActivityStreams object
extra (str): extra HTML to be included inside the body tag, at the top
body_class (str): included as the body tag's class attribute
Returns:
str: the content field in ``obj`` with the tags in the ``tags`` field
converted to links if they have ``startIndex`` and ``length``, otherwise
added to the end.
"""
html = '\n'.join(object_to_html(_activity_or_object(a)) for a in activities)
return f"""\
<!DOCTYPE html>
<html>
<head><meta charset="utf-8"></head>
<body class="{body_class}">
{extra}
{html}
</body>
</html>
"""
[docs]
def object_to_html(obj, parent_props=None, synthesize_content=True):
"""Converts an ActivityStreams object to microformats2 HTML.
Features:
* linkifies embedded tags and adds links for other tags
* linkifies embedded URLs
* adds links, summaries, and thumbnails for attachments and checkins
* adds a "via SOURCE" postscript
Args:
obj (dict): a decoded JSON ActivityStreams object
parent_props (list of str): the properties of the parent object where
this object is embedded, eg ``['u-repost-of']``
synthesize_content (bool): whether to generate synthetic content if the object
doesn't have its own, eg ``likes this`` or ``shared this``
Returns:
str: the content field in ``obj`` with tags in the ``tags`` field converted
to links if they have ``startIndex`` and ``length``, otherwise added to the
end.
"""
return json_to_html(object_to_json(obj, synthesize_content=synthesize_content),
parent_props=parent_props)
[docs]
def json_to_html(obj, parent_props=None):
"""Converts a microformats2 JSON object to microformats2 HTML.
See :func:`object_to_html` for details.
Args:
obj (dict): a decoded microformats2 JSON object
parent_props (list): of str, the properties of the parent object where
this object is embedded, eg ``u-repost-of``
Returns:
str: HTML
"""
if not obj:
return ''
if not parent_props:
parent_props = []
types = obj.get('type', [])
if 'h-card' in types:
return hcard_to_html(obj, parent_props)
props = copy.copy(obj.get('properties', {}))
links = []
for prop in 'in-reply-to', 'tag-of':
links.extend(LINK.substitute(cls=prop, url=url)
for url in sorted(get_string_urls(props.get(prop, []))))
prop = first_props(props)
prop.setdefault('uid', '')
author = prop.get('author')
# if this post is an rsvp, populate its data element. if it's an invite, give
# it a default name.
# do this *before* content since it sets props['name'] if necessary.
rsvp = prop.get('rsvp')
if rsvp:
if not props.get('name'):
props['name'] = [{'yes': 'is attending.',
'no': 'is not attending.',
'maybe': 'might attend.'}.get(rsvp)]
props['name'][0] = {
'html': f"<data class=\"p-rsvp\" value=\"{rsvp}\">{props['name'][0]}</data>",
}
elif props.get('invitee') and not props.get('name'):
props['name'] = ['invited']
children = []
# if this post is itself a follow, like, or repost, link to its target(s).
for mftype in ['follow', 'like', 'repost']:
for target in props.get(mftype + '-of', []):
if isinstance(target, str):
children.append(f'<a class="u-{mftype}-of" href="{target}"></a>')
else:
children.append(json_to_html(target, ['u-' + mftype + '-of']))
# set up content and name
content_html = get_html(prop.get('content', {}))
content_classes = []
if content_html:
content_classes.append('e-content')
if not props.get('name'):
content_classes.append('p-name')
else:
# if content is empty, set explicit blank name to prevent bad (old)
# microformats2 implied p-name handling.
# https://github.com/snarfed/granary/issues/131
if not props.get('name'):
props['name'] = ['']
summary = (f"<div class=\"p-summary\">{prop.get('summary')}</div>"
if prop.get('summary') else '')
# attachments
# TODO: use photo alt property as alt text once mf2py handles that.
# https://github.com/tommorris/mf2py/issues/83
attachments = []
for name, fn in ('photo', img), ('video', vid), ('audio', aud):
attachments.extend(fn(val) for val in props.get(name, []))
# size(s)
# https://github.com/snarfed/granary/issues/169#issuecomment-547918405
sizes = []
for size in props.get('size', []):
bytes = size_to_bytes(size)
if size:
sizes.append(f'<data class="p-size" value="{bytes}">{humanfriendly.format_size(bytes)}</data>')
# categories
cats = props.get('category', [])
people = [
hcard_to_html(cat, ['u-category', 'h-card']) for cat in cats
if isinstance(cat, dict) and 'h-card' in cat.get('type')
and not cat.get('startIndex')] # mentions are already linkified in content
tags = [f'<span class="u-category">{cat}</span>'
for cat in cats if isinstance(cat, str)]
# comments
# http://indiewebcamp.com/comment-presentation#How_to_markup
# http://indiewebcamp.com/h-cite
comments_html = '\n'.join(json_to_html(c, ['p-comment'])
for c in props.get('comment', []))
# embedded likes and reposts of this post
# http://indiewebcamp.com/like, http://indiewebcamp.com/repost
for verb in 'like', 'repost':
# including u-like and u-repost for backcompat means that we must ignore
# these properties when converting a post that is itself a like or repost
if verb + '-of' not in props:
vals = props.get(verb, [])
if vals and isinstance(vals[0], dict):
children += [json_to_html(v, ['u-' + verb]) for v in vals]
# embedded children of this post
children += [json_to_html(c) for c in obj.get('children', [])]
# location; make sure it's an object
location = prop.get('location')
if isinstance(location, str):
location = {'properties': {'name': [location]}}
# event times
event_times = []
start = props.get('start', [])
end = props.get('end', [])
event_times += [f' <time class="dt-start">{time}</time>' for time in start]
if start and end:
event_times.append(' to')
event_times += [f' <time class="dt-end">{time}</time>' for time in end]
return HENTRY.substitute(
prop,
published=maybe_datetime(prop.get('published'), 'dt-published'),
updated=maybe_datetime(prop.get('updated'), 'dt-updated'),
types=' '.join(parent_props + types),
author=hcard_to_html(author, ['p-author']),
location=hcard_to_html(location, ['p-location']),
categories='\n'.join(people + tags),
attachments='\n'.join(attachments),
sizes='\n'.join(sizes),
links='\n'.join(links),
invitees='\n'.join([hcard_to_html(i, ['p-invitee'])
for i in props.get('invitee', [])]),
content=content_html,
content_classes=' '.join(content_classes),
comments=comments_html,
children='\n'.join(children),
linked_name=maybe_linked_name(props),
summary=summary,
event_times='\n'.join(event_times))
[docs]
def hcard_to_html(hcard, parent_props=None):
"""Renders an h-card as HTML.
Args:
hcard (dict): decoded JSON ``h-card``
parent_props (list): of str, the properties of the parent object where
this object is embedded, eg ``['p-author']``
Returns:
str, rendered HTML
"""
if not hcard:
return ''
if not parent_props:
parent_props = []
# extract first value from multiply valued properties
props = hcard.get('properties', {})
if props.keys() == set(['uid']):
props['url'] = props.get('uid')
prop = first_props(props)
if not prop:
return ''
return HCARD.substitute(
types=' '.join(uniquify(parent_props + hcard.get('type', []))),
ids='\n'.join([f'<data class="p-uid" value="{uid}"></data>'
for uid in props.get('uid', []) if uid] +
[f'<data class="p-numeric-id" value="{nid}"></data>'
for nid in props.get('numeric-id', []) if nid]),
linked_name=maybe_linked_name(props),
nicknames='\n'.join(f'<span class="p-nickname">{nick}</span>'
for nick in props.get('nickname', []) if nick),
photos='\n'.join(img(photo) for photo in props.get('photo', []) if photo),
)
[docs]
def render_content(obj, include_location=True, synthesize_content=True,
render_attachments=False, render_image=False,
white_space_pre=True):
"""Renders the content of an ActivityStreams object as HTML.
Includes tags, mentions, and non-note/article attachments. (Note/article
attachments are converted to mf2 children in object_to_json and then rendered
in :func:`json_to_html`.)
Args:
obj (dict): decoded JSON ActivityStreams object
include_location (bool): whether to render location, if provided
synthesize_content (bool): whether to generate synthetic content if the
object doesn't have its own, eg ``likes this`` or ``shared this``
render_attachments (bool): whether to render attachments, eg links,
images, audio, and video
render_image (bool): whether to render the object's image(s)
white_space_pre (bool): whether to wrap in CSS ``white-space: pre``. If False,
newlines will be converted to ``<br>`` tags instead. Background:
https://indiewebcamp.com/note#Indieweb_whitespace_thinking
Returns:
str: rendered HTML
"""
obj_type = as1.object_type(obj)
content = obj.get('content') or ''
# extract tags. preserve order but de-dupe, ie don't include a tag more than
# once.
seen_ids = set()
mentions = []
tags = {} # maps string objectType to list of tag objects
for t in obj.get('tags', []):
id = t.get('id')
if id and id in seen_ids:
continue
seen_ids.add(id)
if 'startIndex' in t and 'length' in t and 'url' in t:
mentions.append(t)
else:
tags.setdefault(as1.object_type(t), []).append(t)
# linkify embedded mention tags inside content.
# TODO: duplicated in :func:`as2.link_tags`. unify?
if mentions:
mentions.sort(key=lambda t: t['startIndex'])
last_end = 0
orig = content
content = ''
for tag in mentions:
start = tag['startIndex']
end = start + tag['length']
content = f"{content}{orig[last_end:start]}<a href=\"{tag['url']}\">{orig[start:end]}</a>"
last_end = end
content += orig[last_end:]
# is whitespace in this content meaningful? standard heuristic: if there are
# no HTML tags in it, and it has a newline, then assume yes.
# https://indiewebcamp.com/note#Indieweb_whitespace_thinking
# https://github.com/snarfed/granary/issues/80
if content and not obj.get('content_is_html') and '\n' in content:
if white_space_pre:
content = f'<div style="white-space: pre">{content}</div>'
else:
content = content.replace('\n', '<br />\n')
# linkify embedded links. ignore the "mention" tags that we added ourselves.
# TODO: fix the bug in test_linkify_broken() in webutil/tests/test_util.py, then
# uncomment this.
# if content:
# content = util.linkify(content)
# the image field. may be multiply valued.
rendered_urls = set()
if render_image:
urls = get_urls(obj, 'image')
content += _render_attachments([{
'objectType': 'image',
'image': {'url': url},
} for url in urls], obj)
rendered_urls = set(urls)
# bookmarked URL
targetUrl = obj.get('targetUrl')
if obj_type == 'bookmark' and targetUrl:
content += f"\nBookmark: {util.pretty_link(targetUrl, attrs={'class': 'u-bookmark-of'})}"
# attachments, eg links (aka articles)
# TODO: use oEmbed? http://oembed.com/ , http://code.google.com/p/python-oembed/
if render_attachments:
atts = [a for a in obj.get('attachments', [])
if a.get('objectType') not in ('note', 'article', 'comment')
and get_url(a, 'image') not in rendered_urls]
content += _render_attachments(atts + tags.pop('article', []), obj)
# generate share/like contexts if the activity does not have content
# of its own
for as_type, verb in (
('favorite', 'Favorites'), ('like', 'Likes'), ('share', 'Shared')):
if (not synthesize_content or obj_type != as_type or 'object' not in obj or
'content' in obj):
continue
for target in as1.get_objects(obj):
target_url = target.get('url') or target.get('id') or '#'
# sometimes likes don't have enough content to render anything
# interesting
if target.keys() <= set(['id', 'url', 'objectType']):
content += f"<a href=\"{target_url}\">{verb.lower()} this.</a>"
else:
author = (as1.get_object(target, 'author')
or as1.get_object(target, 'actor'))
# special case for twitter RT's
if obj_type == 'share' and 'url' in obj and re.search(
r'^https?://(?:www\.|mobile\.)?twitter\.com/', obj.get('url')):
content += f"RT <a href=\"{target_url}\">@{author.get('username')}</a> "
else:
# image looks bad in the simplified rendering
author = {k: v for k, v in author.items() if k != 'image'}
content += f"{verb} <a href=\"{target_url}\">{target.get('displayName', target.get('title', 'a post'))}</a> by {hcard_to_html(object_to_json(author, default_object_type='person'))}"
content += render_content(target, include_location=include_location,
synthesize_content=synthesize_content,
white_space_pre=white_space_pre)
# only include the first context in the content (if there are
# others, they'll be included as separate properties)
break
break
if render_attachments and obj.get('verb') == 'share':
atts = [att for att in itertools.chain.from_iterable(
o.get('attachments', []) for o in as1.get_objects(obj))
if att.get('objectType') not in ('note', 'article', 'comment')]
content += _render_attachments(atts, obj)
# location
loc = obj.get('location')
if include_location and loc:
content += f"\n<p>{hcard_to_html(object_to_json(loc, default_object_type='place'), parent_props=['p-location'])}</p>"
# these are rendered manually in json_to_html()
for type in set(('like', 'share', 'react')) | as1.ACTOR_TYPES:
tags.pop(type, None)
# render the rest
content += tags_to_html(tags.pop('hashtag', []), 'p-category')
content += tags_to_html(tags.pop('mention', []), 'u-mention', visible=False)
content += tags_to_html(sum(tags.values(), []), 'tag')
return content
def _render_attachments(attachments, obj):
"""Renders ActivityStreams attachments (or tags etc) as HTML.
Args:
attachments (sequence of dict): decoded JSON ActivityStreams objects
obj (dict): top-level decoded JSON ActivityStreams object
Returns:
str: rendered HTML
"""
content = ''
for att in attachments:
name = att.get('displayName') or ''
stream_obj = as1.get_object(att, 'stream')
stream = stream_obj.get('id') or stream_obj.get('url') or ''
image_obj = as1.get_object(att, 'image')
image = image_obj.get('id') or image_obj.get('url') or ''
open_a_tag = False
content += '\n<p>'
type = att.get('objectType')
if type == 'video':
if stream:
content += vid(stream, poster=image)
elif type == 'audio':
if stream:
content += aud(stream)
else:
url = att.get('url') or obj.get('url')
if url:
content += f'\n<a class="link" href="{url}">'
open_a_tag = True
if image:
content += '\n' + img(image, name)
if name and type != 'image':
content += f'\n<span class="name">{name}</span>'
if open_a_tag:
content += '\n</a>'
summary = att.get('summary')
if summary and summary != name:
content += f'\n<span class="summary">{summary}</span>'
content += '\n</p>'
return content
[docs]
def find_author(parsed, **kwargs):
"""Returns the author of a page as a ActivityStreams actor.
Args:
parsed (dict): parsed mf2 object (ie return value from :func:`mf2py.parse`)
kwargs: passed through to :func:`mf2util.find_author`
Returns:
dict: ActivityStreams actor
"""
author = mf2util.find_author(parsed, **kwargs)
if author:
# sadly can't use json_to_object here because mf2util.find_author returns
# its own data format
photo = author.get('photo')
alt = photo.get('alt') if isinstance(photo, dict) else None
return util.trim_nulls({
'objectType': 'person',
'url': author.get('url'),
'displayName': author.get('name'),
'image': [{
'url': get_text(photo),
'displayName': alt,
}],
})
[docs]
def get_title(mf2):
"""Returns an mf2 object's title, ie its ``name``.
Args:
mf2 (dict): parsed mf2 object (ie return value from :func:`mf2py.parse`)
Returns:
str: title, possibly ellipsized
"""
lines = get_text(mf2util.interpret_feed(mf2, '').get('name')).splitlines()
if lines:
return util.ellipsize(lines[0])
return ''
[docs]
def first_props(props):
"""Converts a multiply-valued dict to singly valued.
Args:
props (dict): properties, where each value is a sequence
Returns:
dict: corresponding dict with just the first value of each sequence, or
``''`` if the sequence is empty
"""
return {k: get_first(props, k, '') for k in props} if props else {}
[docs]
def author_display_name(hcard):
"""Returns a human-readable string display name for an ``h-card`` object."""
name = None
if hcard:
prop = first_props(hcard.get('properties'))
name = prop.get('name') or prop.get('uid')
return name if name else 'Unknown'
[docs]
def maybe_linked_name(props):
"""Returns the HTML for a ``p-name`` with an optional ``u-url`` inside.
Args:
props (dict): multiply-valued properties
Returns:
str: HTML
"""
prop = first_props(props)
name = get_html(prop.get('name'))
url = prop.get('url')
if name is not None:
html = maybe_linked(name, url, linked_classname='p-name u-url',
unlinked_classname='p-name')
elif url:
html = util.pretty_link(url, attrs={'class': 'u-url'})
else:
html = ''
extra_urls = props.get('url', [])[1:]
if extra_urls:
html += '\n' + '\n'.join(maybe_linked('', url, linked_classname='u-url')
for url in extra_urls)
return html
[docs]
def img(src, alt=''):
"""Returns an ``<img>`` str with the given ``src``, ``class``, and ``alt``.
Args:
src (str): URL or dict with value and (optionally) ``alt``
alt (str): ``alt`` attribute value, or None
Returns:
str:
"""
if isinstance(src, dict):
assert not alt
alt = src.get('alt') or ''
src = src.get('value')
return f"<img class=\"u-photo\" src=\"{src}\" alt={xml.sax.saxutils.quoteattr(alt or '')} />"
[docs]
def vid(src, poster=''):
"""Returns an ``<video>`` str with the given ``src`` and ``poster``.
Args:
src (str): URL of the video
poster (str): optional URL of the poster or preview image
Returns:
str:
"""
poster_img = f'<img src="{poster}" />' if poster else ''
# include ="controls" value since this HTML is also used in the Atom
# template, which has to validate as XML.
return f'<video class="u-video" src="{src}" controls="controls" poster="{poster}">Your browser does not support the video tag. <a href="{src}">Click here to view directly. {poster_img}</a></video>'
[docs]
def aud(src):
"""Returns an ``<audio>`` str with the given ``src``.
Args:
src (str): URL of the audio
Returns:
str:
"""
return f'<audio class="u-audio" src="{src}" controls="controls">Your browser does not support the audio tag. <a href="{src}">Click here to listen directly.</a></audio>'
[docs]
def maybe_linked(text, url=None, linked_classname=None, unlinked_classname=None):
"""Wraps text in an ``<a href=...>`` iff a non-empty url is provided.
Args:
text (str)
url (str): optional
linked_classname (str): optional ``class`` attribute to use if ``url``
unlinked_classname (str): optional ``class`` attribute to use if not ``url``
Returns:
str:
"""
if url:
classname = f' class="{linked_classname}"' if linked_classname else ''
return f'<a{classname} href="{url}">{text}</a>'
if unlinked_classname:
return f'<span class="{unlinked_classname}">{text}</span>'
return text
[docs]
def maybe_datetime(dt, classname):
"""Returns a ``<time datetime=...>`` elem if ``dt`` is non-empty.
Args:
dt (str): RFC339 datetime or None
classname (str): class name
Returns:
str:
"""
if dt:
return f'<time class="{classname}" datetime="{dt}">{dt}</time>'
else:
return ''
[docs]
def size_to_bytes(size):
"""Converts a string file size to an integer number of bytes.
Args:
size (str): may be either int bytes or human-readable approximation,
eg ``7MB`` or ``1.23 kb``
Returns:
int, bytes or None if size can't be parsed
"""
if util.is_int(size):
return int(size)
if not size:
return None
try:
return humanfriendly.parse_size(size)
except humanfriendly.InvalidSize:
logger.debug(f"Couldn't parse size {size!r}")