epicyon/like.py

482 lines
17 KiB
Python

__filename__ = "like.py"
__author__ = "Bob Mottram"
__license__ = "AGPL3+"
__version__ = "1.2.0"
__maintainer__ = "Bob Mottram"
__email__ = "bob@libreserver.org"
__status__ = "Production"
__module_group__ = "ActivityPub"
import os
from pprint import pprint
from utils import has_object_string
from utils import has_object_string_object
from utils import has_object_stringType
from utils import remove_domain_port
from utils import has_object_dict
from utils import has_users_path
from utils import get_full_domain
from utils import remove_id_ending
from utils import url_permitted
from utils import get_nickname_from_actor
from utils import get_domain_from_actor
from utils import locate_post
from utils import undo_likes_collection_entry
from utils import has_group_type
from utils import local_actor_url
from utils import load_json
from utils import save_json
from utils import remove_post_from_cache
from utils import get_cached_post_filename
from posts import send_signed_json
from session import post_json
from webfinger import webfinger_handle
from auth import create_basic_auth_header
from posts import get_person_box
def no_of_likes(post_json_object: {}) -> int:
"""Returns the number of likes ona given post
"""
obj = post_json_object
if has_object_dict(post_json_object):
obj = post_json_object['object']
if not obj.get('likes'):
return 0
if not isinstance(obj['likes'], dict):
return 0
if not obj['likes'].get('items'):
obj['likes']['items'] = []
obj['likes']['totalItems'] = 0
return len(obj['likes']['items'])
def liked_by_person(post_json_object: {}, nickname: str, domain: str) -> bool:
"""Returns True if the given post is liked by the given person
"""
if no_of_likes(post_json_object) == 0:
return False
actorMatch = domain + '/users/' + nickname
obj = post_json_object
if has_object_dict(post_json_object):
obj = post_json_object['object']
for item in obj['likes']['items']:
if item['actor'].endswith(actorMatch):
return True
return False
def _create_like(recent_posts_cache: {},
session, base_dir: str, federation_list: [],
nickname: str, domain: str, port: int,
ccList: [], http_prefix: str,
objectUrl: str, actorLiked: str,
client_to_server: bool,
send_threads: [], postLog: [],
person_cache: {}, cached_webfingers: {},
debug: bool, project_version: str,
signing_priv_key_pem: str) -> {}:
"""Creates a like
actor is the person doing the liking
'to' might be a specific person (actor) whose post was liked
object is typically the url of the message which was liked
"""
if not url_permitted(objectUrl, federation_list):
return None
fullDomain = get_full_domain(domain, port)
newLikeJson = {
"@context": "https://www.w3.org/ns/activitystreams",
'type': 'Like',
'actor': local_actor_url(http_prefix, nickname, fullDomain),
'object': objectUrl
}
if ccList:
if len(ccList) > 0:
newLikeJson['cc'] = ccList
# Extract the domain and nickname from a statuses link
likedPostNickname = None
likedPostDomain = None
likedPostPort = None
group_account = False
if actorLiked:
likedPostNickname = get_nickname_from_actor(actorLiked)
likedPostDomain, likedPostPort = get_domain_from_actor(actorLiked)
group_account = has_group_type(base_dir, actorLiked, person_cache)
else:
if has_users_path(objectUrl):
likedPostNickname = get_nickname_from_actor(objectUrl)
likedPostDomain, likedPostPort = get_domain_from_actor(objectUrl)
if '/' + str(likedPostNickname) + '/' in objectUrl:
actorLiked = \
objectUrl.split('/' + likedPostNickname + '/')[0] + \
'/' + likedPostNickname
group_account = \
has_group_type(base_dir, actorLiked, person_cache)
if likedPostNickname:
post_filename = locate_post(base_dir, nickname, domain, objectUrl)
if not post_filename:
print('DEBUG: like base_dir: ' + base_dir)
print('DEBUG: like nickname: ' + nickname)
print('DEBUG: like domain: ' + domain)
print('DEBUG: like objectUrl: ' + objectUrl)
return None
update_likes_collection(recent_posts_cache,
base_dir, post_filename, objectUrl,
newLikeJson['actor'],
nickname, domain, debug, None)
send_signed_json(newLikeJson, session, base_dir,
nickname, domain, port,
likedPostNickname, likedPostDomain, likedPostPort,
'https://www.w3.org/ns/activitystreams#Public',
http_prefix, True, client_to_server, federation_list,
send_threads, postLog, cached_webfingers,
person_cache,
debug, project_version, None, group_account,
signing_priv_key_pem, 7367374)
return newLikeJson
def like_post(recent_posts_cache: {},
session, base_dir: str, federation_list: [],
nickname: str, domain: str, port: int, http_prefix: str,
likeNickname: str, likeDomain: str, likePort: int,
ccList: [],
likeStatusNumber: int, client_to_server: bool,
send_threads: [], postLog: [],
person_cache: {}, cached_webfingers: {},
debug: bool, project_version: str,
signing_priv_key_pem: str) -> {}:
"""Likes a given status post. This is only used by unit tests
"""
likeDomain = get_full_domain(likeDomain, likePort)
actorLiked = local_actor_url(http_prefix, likeNickname, likeDomain)
objectUrl = actorLiked + '/statuses/' + str(likeStatusNumber)
return _create_like(recent_posts_cache,
session, base_dir, federation_list,
nickname, domain, port,
ccList, http_prefix, objectUrl, actorLiked,
client_to_server,
send_threads, postLog, person_cache, cached_webfingers,
debug, project_version, signing_priv_key_pem)
def send_like_via_server(base_dir: str, session,
fromNickname: str, password: str,
fromDomain: str, fromPort: int,
http_prefix: str, likeUrl: str,
cached_webfingers: {}, person_cache: {},
debug: bool, project_version: str,
signing_priv_key_pem: str) -> {}:
"""Creates a like via c2s
"""
if not session:
print('WARN: No session for send_like_via_server')
return 6
fromDomainFull = get_full_domain(fromDomain, fromPort)
actor = local_actor_url(http_prefix, fromNickname, fromDomainFull)
newLikeJson = {
"@context": "https://www.w3.org/ns/activitystreams",
'type': 'Like',
'actor': actor,
'object': likeUrl
}
handle = http_prefix + '://' + fromDomainFull + '/@' + fromNickname
# lookup the inbox for the To handle
wfRequest = webfinger_handle(session, handle, http_prefix,
cached_webfingers,
fromDomain, project_version, debug, False,
signing_priv_key_pem)
if not wfRequest:
if debug:
print('DEBUG: like webfinger failed for ' + handle)
return 1
if not isinstance(wfRequest, dict):
print('WARN: like webfinger for ' + handle +
' did not return a dict. ' + str(wfRequest))
return 1
postToBox = 'outbox'
# get the actor inbox for the To handle
originDomain = fromDomain
(inboxUrl, pubKeyId, pubKey, fromPersonId, sharedInbox, avatarUrl,
displayName, _) = get_person_box(signing_priv_key_pem,
originDomain,
base_dir, session, wfRequest,
person_cache,
project_version, http_prefix,
fromNickname, fromDomain,
postToBox, 72873)
if not inboxUrl:
if debug:
print('DEBUG: like no ' + postToBox + ' was found for ' + handle)
return 3
if not fromPersonId:
if debug:
print('DEBUG: like no actor was found for ' + handle)
return 4
authHeader = create_basic_auth_header(fromNickname, password)
headers = {
'host': fromDomain,
'Content-type': 'application/json',
'Authorization': authHeader
}
postResult = post_json(http_prefix, fromDomainFull,
session, newLikeJson, [], inboxUrl,
headers, 3, True)
if not postResult:
if debug:
print('WARN: POST like failed for c2s to ' + inboxUrl)
return 5
if debug:
print('DEBUG: c2s POST like success')
return newLikeJson
def send_undo_like_via_server(base_dir: str, session,
fromNickname: str, password: str,
fromDomain: str, fromPort: int,
http_prefix: str, likeUrl: str,
cached_webfingers: {}, person_cache: {},
debug: bool, project_version: str,
signing_priv_key_pem: str) -> {}:
"""Undo a like via c2s
"""
if not session:
print('WARN: No session for send_undo_like_via_server')
return 6
fromDomainFull = get_full_domain(fromDomain, fromPort)
actor = local_actor_url(http_prefix, fromNickname, fromDomainFull)
newUndoLikeJson = {
"@context": "https://www.w3.org/ns/activitystreams",
'type': 'Undo',
'actor': actor,
'object': {
'type': 'Like',
'actor': actor,
'object': likeUrl
}
}
handle = http_prefix + '://' + fromDomainFull + '/@' + fromNickname
# lookup the inbox for the To handle
wfRequest = webfinger_handle(session, handle, http_prefix,
cached_webfingers,
fromDomain, project_version, debug, False,
signing_priv_key_pem)
if not wfRequest:
if debug:
print('DEBUG: unlike webfinger failed for ' + handle)
return 1
if not isinstance(wfRequest, dict):
if debug:
print('WARN: unlike webfinger for ' + handle +
' did not return a dict. ' + str(wfRequest))
return 1
postToBox = 'outbox'
# get the actor inbox for the To handle
originDomain = fromDomain
(inboxUrl, pubKeyId, pubKey, fromPersonId, sharedInbox, avatarUrl,
displayName, _) = get_person_box(signing_priv_key_pem,
originDomain,
base_dir, session, wfRequest,
person_cache, project_version,
http_prefix, fromNickname,
fromDomain, postToBox,
72625)
if not inboxUrl:
if debug:
print('DEBUG: unlike no ' + postToBox + ' was found for ' + handle)
return 3
if not fromPersonId:
if debug:
print('DEBUG: unlike no actor was found for ' + handle)
return 4
authHeader = create_basic_auth_header(fromNickname, password)
headers = {
'host': fromDomain,
'Content-type': 'application/json',
'Authorization': authHeader
}
postResult = post_json(http_prefix, fromDomainFull,
session, newUndoLikeJson, [], inboxUrl,
headers, 3, True)
if not postResult:
if debug:
print('WARN: POST unlike failed for c2s to ' + inboxUrl)
return 5
if debug:
print('DEBUG: c2s POST unlike success')
return newUndoLikeJson
def outbox_like(recent_posts_cache: {},
base_dir: str, http_prefix: str,
nickname: str, domain: str, port: int,
message_json: {}, debug: bool) -> None:
""" When a like request is received by the outbox from c2s
"""
if not message_json.get('type'):
if debug:
print('DEBUG: like - no type')
return
if not message_json['type'] == 'Like':
if debug:
print('DEBUG: not a like')
return
if not has_object_string(message_json, debug):
return
if debug:
print('DEBUG: c2s like request arrived in outbox')
messageId = remove_id_ending(message_json['object'])
domain = remove_domain_port(domain)
post_filename = locate_post(base_dir, nickname, domain, messageId)
if not post_filename:
if debug:
print('DEBUG: c2s like post not found in inbox or outbox')
print(messageId)
return True
update_likes_collection(recent_posts_cache,
base_dir, post_filename, messageId,
message_json['actor'],
nickname, domain, debug, None)
if debug:
print('DEBUG: post liked via c2s - ' + post_filename)
def outbox_undo_like(recent_posts_cache: {},
base_dir: str, http_prefix: str,
nickname: str, domain: str, port: int,
message_json: {}, debug: bool) -> None:
""" When an undo like request is received by the outbox from c2s
"""
if not message_json.get('type'):
return
if not message_json['type'] == 'Undo':
return
if not has_object_stringType(message_json, debug):
return
if not message_json['object']['type'] == 'Like':
if debug:
print('DEBUG: not a undo like')
return
if not has_object_string_object(message_json, debug):
return
if debug:
print('DEBUG: c2s undo like request arrived in outbox')
messageId = remove_id_ending(message_json['object']['object'])
domain = remove_domain_port(domain)
post_filename = locate_post(base_dir, nickname, domain, messageId)
if not post_filename:
if debug:
print('DEBUG: c2s undo like post not found in inbox or outbox')
print(messageId)
return True
undo_likes_collection_entry(recent_posts_cache, base_dir, post_filename,
messageId, message_json['actor'],
domain, debug, None)
if debug:
print('DEBUG: post undo liked via c2s - ' + post_filename)
def update_likes_collection(recent_posts_cache: {},
base_dir: str, post_filename: str,
objectUrl: str, actor: str,
nickname: str, domain: str, debug: bool,
post_json_object: {}) -> None:
"""Updates the likes collection within a post
"""
if not post_json_object:
post_json_object = load_json(post_filename)
if not post_json_object:
return
# remove any cached version of this post so that the
# like icon is changed
remove_post_from_cache(post_json_object, recent_posts_cache)
cachedPostFilename = \
get_cached_post_filename(base_dir, nickname,
domain, post_json_object)
if cachedPostFilename:
if os.path.isfile(cachedPostFilename):
try:
os.remove(cachedPostFilename)
except OSError:
print('EX: update_likes_collection unable to delete ' +
cachedPostFilename)
obj = post_json_object
if has_object_dict(post_json_object):
obj = post_json_object['object']
if not objectUrl.endswith('/likes'):
objectUrl = objectUrl + '/likes'
if not obj.get('likes'):
if debug:
print('DEBUG: Adding initial like to ' + objectUrl)
likesJson = {
"@context": "https://www.w3.org/ns/activitystreams",
'id': objectUrl,
'type': 'Collection',
"totalItems": 1,
'items': [{
'type': 'Like',
'actor': actor
}]
}
obj['likes'] = likesJson
else:
if not obj['likes'].get('items'):
obj['likes']['items'] = []
for likeItem in obj['likes']['items']:
if likeItem.get('actor'):
if likeItem['actor'] == actor:
# already liked
return
newLike = {
'type': 'Like',
'actor': actor
}
obj['likes']['items'].append(newLike)
itlen = len(obj['likes']['items'])
obj['likes']['totalItems'] = itlen
if debug:
print('DEBUG: saving post with likes added')
pprint(post_json_object)
save_json(post_json_object, post_filename)