flake8 format

main
Bob Mottram 2020-04-04 12:27:51 +01:00
parent d652485f8a
commit b7fc2b948d
1 changed files with 291 additions and 257 deletions

236
shares.py
View File

@ -6,32 +6,36 @@ __maintainer__="Bob Mottram"
__email__ = "bob@freedombone.net" __email__ = "bob@freedombone.net"
__status__ = "Production" __status__ = "Production"
import json
import os import os
import time import time
from shutil import copyfile
from webfinger import webfingerHandle from webfinger import webfingerHandle
from auth import createBasicAuthHeader from auth import createBasicAuthHeader
from posts import getPersonBox from posts import getPersonBox
from session import postJson from session import postJson
from session import postImage
from utils import validNickname from utils import validNickname
from utils import getNicknameFromActor
from utils import getDomainFromActor
from utils import loadJson from utils import loadJson
from utils import saveJson from utils import saveJson
from media import removeMetaData from media import removeMetaData
def getValidSharedItemID(displayName: str) -> str: def getValidSharedItemID(displayName: str) -> str:
"""Removes any invalid characters from the display name to """Removes any invalid characters from the display name to
produce an item ID produce an item ID
""" """
return displayName.replace(' ','').replace('+','-').replace('/','-').replace('\\','-').replace('.','_').replace('?','-').replace('\n','').replace("","'").replace('&','-') displayName = displayName.replace(' ', '').replace('+', '-')
displayName = displayName.replace('/', '-').replace('\\', '-')
displayName = displayName.replace('.', '_').replace('?', '-')
displayName = displayName.replace('\n', '').replace("", "'")
return displayName.replace('&', '-')
def removeShare(baseDir: str,nickname: str,domain: str, \
def removeShare(baseDir: str, nickname: str, domain: str,
displayName: str) -> None: displayName: str) -> None:
"""Removes a share for a person """Removes a share for a person
""" """
sharesFilename=baseDir+'/accounts/'+nickname+'@'+domain+'/shares.json' sharesFilename = baseDir + '/accounts/' + \
nickname + '@' + domain + '/shares.json'
if not os.path.isfile(sharesFilename): if not os.path.isfile(sharesFilename):
print('ERROR: missing shares.json ' + sharesFilename) print('ERROR: missing shares.json ' + sharesFilename)
return return
@ -59,21 +63,19 @@ def removeShare(baseDir: str,nickname: str,domain: str, \
del sharesJson[itemID] del sharesJson[itemID]
saveJson(sharesJson, sharesFilename) saveJson(sharesJson, sharesFilename)
else: else:
print('ERROR: share index "'+itemID+'" does not exist in '+sharesFilename) print('ERROR: share index "' + itemID +
'" does not exist in ' + sharesFilename)
def addShare(baseDir: str, \
httpPrefix: str,nickname: str,domain: str,port: int, \ def addShare(baseDir: str,
displayName: str, \ httpPrefix: str, nickname: str, domain: str, port: int,
summary: str, \ displayName: str, summary: str, imageFilename: str,
imageFilename: str, \ itemType: str, itemCategory: str, location: str,
itemType: str, \ duration: str, debug: bool) -> None:
itemCategory: str, \
location: str, \
duration: str,
debug: bool) -> None:
"""Updates the likes collection within a post """Updates the likes collection within a post
""" """
sharesFilename=baseDir+'/accounts/'+nickname+'@'+domain+'/shares.json' sharesFilename = baseDir + '/accounts/' + \
nickname + '@' + domain + '/shares.json'
sharesJson = {} sharesJson = {}
if os.path.isfile(sharesFilename): if os.path.isfile(sharesFilename):
sharesJson = loadJson(sharesFilename) sharesJson = loadJson(sharesFilename)
@ -89,11 +91,14 @@ def addShare(baseDir: str, \
if 'day' in durationList[1]: if 'day' in durationList[1]:
durationSec = published + (int(durationList[0]) * 60 * 60 * 24) durationSec = published + (int(durationList[0]) * 60 * 60 * 24)
if 'week' in durationList[1]: if 'week' in durationList[1]:
durationSec=published+(int(durationList[0])*60*60*24*7) durationSec = \
published + (int(durationList[0]) * 60 * 60 * 24 * 7)
if 'month' in durationList[1]: if 'month' in durationList[1]:
durationSec=published+(int(durationList[0])*60*60*24*30) durationSec = \
published + (int(durationList[0]) * 60 * 60 * 24 * 30)
if 'year' in durationList[1]: if 'year' in durationList[1]:
durationSec=published+(int(durationList[0])*60*60*24*365) durationSec = \
published + (int(durationList[0]) * 60 * 60 * 24 * 365)
itemID = getValidSharedItemID(displayName) itemID = getValidSharedItemID(displayName)
@ -101,7 +106,8 @@ def addShare(baseDir: str, \
imageUrl = None imageUrl = None
moveImage = False moveImage = False
if not imageFilename: if not imageFilename:
sharesImageFilename=baseDir+'/accounts/'+nickname+'@'+domain+'/upload' sharesImageFilename = \
baseDir + '/accounts/' + nickname + '@' + domain + '/upload'
if os.path.isfile(sharesImageFilename + '.png'): if os.path.isfile(sharesImageFilename + '.png'):
imageFilename = sharesImageFilename + '.png' imageFilename = sharesImageFilename + '.png'
moveImage = True moveImage = True
@ -130,17 +136,23 @@ def addShare(baseDir: str, \
removeMetaData(imageFilename, itemIDfile + '.png') removeMetaData(imageFilename, itemIDfile + '.png')
if moveImage: if moveImage:
os.remove(imageFilename) os.remove(imageFilename)
imageUrl=httpPrefix+'://'+domainFull+'/sharefiles/'+nickname+'/'+itemID+'.png' imageUrl = \
httpPrefix + '://' + domainFull + \
'/sharefiles/' + nickname + '/' + itemID + '.png'
if imageFilename.endswith('.jpg'): if imageFilename.endswith('.jpg'):
removeMetaData(imageFilename, itemIDfile + '.jpg') removeMetaData(imageFilename, itemIDfile + '.jpg')
if moveImage: if moveImage:
os.remove(imageFilename) os.remove(imageFilename)
imageUrl=httpPrefix+'://'+domainFull+'/sharefiles/'+nickname+'/'+itemID+'.jpg' imageUrl = \
httpPrefix + '://' + domainFull + \
'/sharefiles/' + nickname + '/' + itemID + '.jpg'
if imageFilename.endswith('.gif'): if imageFilename.endswith('.gif'):
removeMetaData(imageFilename, itemIDfile + '.gif') removeMetaData(imageFilename, itemIDfile + '.gif')
if moveImage: if moveImage:
os.remove(imageFilename) os.remove(imageFilename)
imageUrl=httpPrefix+'://'+domainFull+'/sharefiles/'+nickname+'/'+itemID+'.gif' imageUrl = \
httpPrefix + '://' + domainFull + \
'/sharefiles/' + nickname + '/' + itemID + '.gif'
sharesJson[itemID] = { sharesJson[itemID] = {
"displayName": displayName, "displayName": displayName,
@ -165,10 +177,12 @@ def addShare(baseDir: str, \
nickname = handle.split('@')[0] nickname = handle.split('@')[0]
try: try:
with open(newShareFile, 'w') as fp: with open(newShareFile, 'w') as fp:
fp.write(httpPrefix+'://'+domainFull+'/users/'+nickname+'/tlshares') fp.write(httpPrefix + '://' + domainFull +
except: '/users/' + nickname + '/tlshares')
except BaseException:
pass pass
def expireShares(baseDir: str) -> None: def expireShares(baseDir: str) -> None:
"""Removes expired items from shares """Removes expired items from shares
""" """
@ -180,6 +194,7 @@ def expireShares(baseDir: str) -> None:
domain = account.split('@')[1] domain = account.split('@')[1]
expireSharesForAccount(baseDir, nickname, domain) expireSharesForAccount(baseDir, nickname, domain)
def expireSharesForAccount(baseDir: str, nickname: str, domain: str) -> None: def expireSharesForAccount(baseDir: str, nickname: str, domain: str) -> None:
"""Removes expired items from shares """Removes expired items from shares
""" """
@ -200,7 +215,8 @@ def expireSharesForAccount(baseDir: str,nickname: str,domain: str) -> None:
for itemID in deleteItemID: for itemID in deleteItemID:
del sharesJson[itemID] del sharesJson[itemID]
# remove any associated images # remove any associated images
itemIDfile=baseDir+'/sharefiles/'+nickname+'/'+itemID itemIDfile = \
baseDir + '/sharefiles/' + nickname + '/' + itemID
if os.path.isfile(itemIDfile + '.png'): if os.path.isfile(itemIDfile + '.png'):
os.remove(itemIDfile + '.png') os.remove(itemIDfile + '.png')
if os.path.isfile(itemIDfile + '.jpg'): if os.path.isfile(itemIDfile + '.jpg'):
@ -209,9 +225,10 @@ def expireSharesForAccount(baseDir: str,nickname: str,domain: str) -> None:
os.remove(itemIDfile + '.gif') os.remove(itemIDfile + '.gif')
saveJson(sharesJson, sharesFilename) saveJson(sharesJson, sharesFilename)
def getSharesFeedForPerson(baseDir: str, \
domain: str,port: int, \ def getSharesFeedForPerson(baseDir: str,
path: str,httpPrefix: str, \ domain: str, port: int,
path: str, httpPrefix: str,
sharesPerPage=12) -> {}: sharesPerPage=12) -> {}:
"""Returns the shares for an account from GET requests """Returns the shares for an account from GET requests
""" """
@ -227,7 +244,7 @@ def getSharesFeedForPerson(baseDir: str, \
else: else:
try: try:
pageNumber = int(pageNumber) pageNumber = int(pageNumber)
except: except BaseException:
pass pass
path = path.split('?page=')[0] path = path.split('?page=')[0]
headerOnly = False headerOnly = False
@ -261,10 +278,11 @@ def getSharesFeedForPerson(baseDir: str, \
sharesJson = loadJson(sharesFilename) sharesJson = loadJson(sharesFilename)
if sharesJson: if sharesJson:
noOfShares = len(sharesJson.items()) noOfShares = len(sharesJson.items())
idStr = httpPrefix + '://' + domain + '/users/' + nickname
shares = { shares = {
'@context': 'https://www.w3.org/ns/activitystreams', '@context': 'https://www.w3.org/ns/activitystreams',
'first': httpPrefix+'://'+domain+'/users/'+nickname+'/shares?page=1', 'first': idStr+'/shares?page=1',
'id': httpPrefix+'://'+domain+'/users/'+nickname+'/shares', 'id': idStr+'/shares',
'totalItems': str(noOfShares), 'totalItems': str(noOfShares),
'type': 'OrderedCollection' 'type': 'OrderedCollection'
} }
@ -274,11 +292,12 @@ def getSharesFeedForPerson(baseDir: str, \
pageNumber = 1 pageNumber = 1
nextPageNumber = int(pageNumber + 1) nextPageNumber = int(pageNumber + 1)
idStr = httpPrefix + '://' + domain + '/users/' + nickname
shares = { shares = {
'@context': 'https://www.w3.org/ns/activitystreams', '@context': 'https://www.w3.org/ns/activitystreams',
'id': httpPrefix+'://'+domain+'/users/'+nickname+'/shares?page='+str(pageNumber), 'id': idStr+'/shares?page='+str(pageNumber),
'orderedItems': [], 'orderedItems': [],
'partOf': httpPrefix+'://'+domain+'/users/'+nickname+'/shares', 'partOf': idStr+'/shares',
'totalItems': 0, 'totalItems': 0,
'type': 'OrderedCollectionPage' 'type': 'OrderedCollectionPage'
} }
@ -305,23 +324,21 @@ def getSharesFeedForPerson(baseDir: str, \
if lastPage < 1: if lastPage < 1:
lastPage = 1 lastPage = 1
if nextPageNumber > lastPage: if nextPageNumber > lastPage:
shares['next']=httpPrefix+'://'+domain+'/users/'+nickname+'/shares?page='+str(lastPage) shares['next'] = \
httpPrefix + '://' + domain + '/users/' + nickname + \
'/shares?page=' + str(lastPage)
return shares return shares
def sendShareViaServer(baseDir,session, \
fromNickname: str,password: str, \ def sendShareViaServer(baseDir, session,
fromDomain: str,fromPort: int, \ fromNickname: str, password: str,
httpPrefix: str, \ fromDomain: str, fromPort: int,
displayName: str, \ httpPrefix: str, displayName: str,
summary: str, \ summary: str, imageFilename: str,
imageFilename: str, \ itemType: str, itemCategory: str,
itemType: str, \ location: str, duration: str,
itemCategory: str, \ cachedWebfingers: {}, personCache: {},
location: str, \ debug: bool, projectVersion: str) -> {}:
duration: str, \
cachedWebfingers: {},personCache: {}, \
debug: bool, \
projectVersion: str) -> {}:
"""Creates an item share via c2s """Creates an item share via c2s
""" """
if not session: if not session:
@ -335,19 +352,21 @@ def sendShareViaServer(baseDir,session, \
fromDomainFull = fromDomain + ':' + str(fromPort) fromDomainFull = fromDomain + ':' + str(fromPort)
toUrl = 'https://www.w3.org/ns/activitystreams#Public' toUrl = 'https://www.w3.org/ns/activitystreams#Public'
ccUrl=httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname+'/followers' ccUrl = httpPrefix + '://' + fromDomainFull + \
'/users/' + fromNickname + '/followers'
actor = httpPrefix + '://' + fromDomainFull + '/users/' + fromNickname
newShareJson = { newShareJson = {
"@context": "https://www.w3.org/ns/activitystreams", "@context": "https://www.w3.org/ns/activitystreams",
'type': 'Add', 'type': 'Add',
'actor': httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname, 'actor': actor,
'target': httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname+'/shares', 'target': actor+'/shares',
'object': { 'object': {
"type": "Offer", "type": "Offer",
"displayName": displayName, "displayName": displayName,
"summary": summary, "summary": summary,
"itemType": itemType, "itemType": itemType,
"category": category, "category": itemCategory,
"location": location, "location": location,
"duration": duration, "duration": duration,
'to': [toUrl], 'to': [toUrl],
@ -360,7 +379,9 @@ def sendShareViaServer(baseDir,session, \
handle = httpPrefix + '://' + fromDomainFull + '/@' + fromNickname handle = httpPrefix + '://' + fromDomainFull + '/@' + fromNickname
# lookup the inbox for the To handle # lookup the inbox for the To handle
wfRequest=webfingerHandle(session,handle,httpPrefix,cachedWebfingers, \ wfRequest = \
webfingerHandle(session, handle, httpPrefix,
cachedWebfingers,
fromDomain, projectVersion) fromDomain, projectVersion)
if not wfRequest: if not wfRequest:
if debug: if debug:
@ -370,10 +391,13 @@ def sendShareViaServer(baseDir,session, \
postToBox = 'outbox' postToBox = 'outbox'
# get the actor inbox for the To handle # get the actor inbox for the To handle
inboxUrl,pubKeyId,pubKey,fromPersonId,sharedInbox,capabilityAcquisition,avatarUrl,displayName= \ (inboxUrl, pubKeyId, pubKey,
getPersonBox(baseDir,session,wfRequest,personCache, \ fromPersonId, sharedInbox,
projectVersion,httpPrefix, \ capabilityAcquisition,
fromNickname,fromDomain,postToBox) avatarUrl, displayName) = getPersonBox(baseDir, session, wfRequest,
personCache, projectVersion,
httpPrefix, fromNickname,
fromDomain, postToBox)
if not inboxUrl: if not inboxUrl:
if debug: if debug:
@ -388,22 +412,24 @@ def sendShareViaServer(baseDir,session, \
if imageFilename: if imageFilename:
headers = { headers = {
'host': fromDomain, \ 'host': fromDomain,
'Authorization': authHeader 'Authorization': authHeader
} }
postResult = \ postResult = \
postImage(session,imageFilename,[],inboxUrl.replace('/'+postToBox,'/shares'),headers,"inbox:write") postImage(session, imageFilename, [],
inboxUrl.replace('/' + postToBox, '/shares'),
headers, "inbox:write")
headers = { headers = {
'host': fromDomain, \ 'host': fromDomain,
'Content-type': 'application/json', \ 'Content-type': 'application/json',
'Authorization': authHeader 'Authorization': authHeader
} }
postResult = \ postResult = \
postJson(session, newShareJson, [], inboxUrl, headers, "inbox:write") postJson(session, newShareJson, [], inboxUrl, headers, "inbox:write")
#if not postResult: if not postResult:
# if debug: if debug:
# print('DEBUG: POST announce failed for c2s to '+inboxUrl) print('DEBUG: POST announce failed for c2s to ' + inboxUrl)
# return 5 # return 5
if debug: if debug:
@ -411,12 +437,12 @@ def sendShareViaServer(baseDir,session, \
return newShareJson return newShareJson
def sendUndoShareViaServer(baseDir: str,session, \
fromNickname: str,password: str, \ def sendUndoShareViaServer(baseDir: str, session,
fromDomain: str,fromPort: int, \ fromNickname: str, password: str,
httpPrefix: str, \ fromDomain: str, fromPort: int,
displayName: str, \ httpPrefix: str, displayName: str,
cachedWebfingers: {},personCache: {}, \ cachedWebfingers: {}, personCache: {},
debug: bool, projectVersion: str) -> {}: debug: bool, projectVersion: str) -> {}:
"""Undoes a share via c2s """Undoes a share via c2s
""" """
@ -431,13 +457,15 @@ def sendUndoShareViaServer(baseDir: str,session, \
fromDomainFull = fromDomain + ':' + str(fromPort) fromDomainFull = fromDomain + ':' + str(fromPort)
toUrl = 'https://www.w3.org/ns/activitystreams#Public' toUrl = 'https://www.w3.org/ns/activitystreams#Public'
ccUrl=httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname+'/followers' ccUrl = httpPrefix + '://' + fromDomainFull + \
'/users/' + fromNickname + '/followers'
actor = httpPrefix + '://' + fromDomainFull + '/users/' + fromNickname
undoShareJson = { undoShareJson = {
"@context": "https://www.w3.org/ns/activitystreams", "@context": "https://www.w3.org/ns/activitystreams",
'type': 'Remove', 'type': 'Remove',
'actor': httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname, 'actor': actor,
'target': httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname+'/shares', 'target': actor + '/shares',
'object': { 'object': {
"type": "Offer", "type": "Offer",
"displayName": displayName, "displayName": displayName,
@ -451,7 +479,8 @@ def sendUndoShareViaServer(baseDir: str,session, \
handle = httpPrefix + '://' + fromDomainFull + '/@' + fromNickname handle = httpPrefix + '://' + fromDomainFull + '/@' + fromNickname
# lookup the inbox for the To handle # lookup the inbox for the To handle
wfRequest=webfingerHandle(session,handle,httpPrefix,cachedWebfingers, \ wfRequest = \
webfingerHandle(session, handle, httpPrefix, cachedWebfingers,
fromDomain, projectVersion) fromDomain, projectVersion)
if not wfRequest: if not wfRequest:
if debug: if debug:
@ -461,10 +490,13 @@ def sendUndoShareViaServer(baseDir: str,session, \
postToBox = 'outbox' postToBox = 'outbox'
# get the actor inbox for the To handle # get the actor inbox for the To handle
inboxUrl,pubKeyId,pubKey,fromPersonId,sharedInbox,capabilityAcquisition,avatarUrl,displayName= \ (inboxUrl, pubKeyId, pubKey,
getPersonBox(baseDir,session,wfRequest,personCache, \ fromPersonId, sharedInbox,
projectVersion,httpPrefix, \ capabilityAcquisition,
fromNickname,fromDomain,postToBox) avatarUrl, displayName) = getPersonBox(baseDir, session, wfRequest,
personCache, projectVersion,
httpPrefix, fromNickname,
fromDomain, postToBox)
if not inboxUrl: if not inboxUrl:
if debug: if debug:
@ -478,15 +510,15 @@ def sendUndoShareViaServer(baseDir: str,session, \
authHeader = createBasicAuthHeader(fromNickname, password) authHeader = createBasicAuthHeader(fromNickname, password)
headers = { headers = {
'host': fromDomain, \ 'host': fromDomain,
'Content-type': 'application/json', \ 'Content-type': 'application/json',
'Authorization': authHeader 'Authorization': authHeader
} }
postResult = \ postResult = \
postJson(session, undoShareJson, [], inboxUrl, headers, "inbox:write") postJson(session, undoShareJson, [], inboxUrl, headers, "inbox:write")
#if not postResult: if not postResult:
# if debug: if debug:
# print('DEBUG: POST announce failed for c2s to '+inboxUrl) print('DEBUG: POST announce failed for c2s to ' + inboxUrl)
# return 5 # return 5
if debug: if debug:
@ -494,8 +526,9 @@ def sendUndoShareViaServer(baseDir: str,session, \
return undoShareJson return undoShareJson
def outboxShareUpload(baseDir: str,httpPrefix: str, \
nickname: str,domain: str,port: int, \ def outboxShareUpload(baseDir: str, httpPrefix: str,
nickname: str, domain: str, port: int,
messageJson: {}, debug: bool) -> None: messageJson: {}, debug: bool) -> None:
""" When a shared item is received by the outbox from c2s """ When a shared item is received by the outbox from c2s
""" """
@ -539,21 +572,22 @@ def outboxShareUpload(baseDir: str,httpPrefix: str, \
if debug: if debug:
print('DEBUG: duration missing from Offer') print('DEBUG: duration missing from Offer')
return return
addShare(baseDir, \ addShare(baseDir,
httpPrefix,nickname,domain,port, \ httpPrefix, nickname, domain, port,
messageJson['object']['displayName'], \ messageJson['object']['displayName'],
messageJson['object']['summary'], \ messageJson['object']['summary'],
messageJson['object']['imageFilename'], \ messageJson['object']['imageFilename'],
messageJson['object']['itemType'], \ messageJson['object']['itemType'],
messageJson['object']['itemCategory'], \ messageJson['object']['itemCategory'],
messageJson['object']['location'], \ messageJson['object']['location'],
messageJson['object']['duration'], \ messageJson['object']['duration'],
debug) debug)
if debug: if debug:
print('DEBUG: shared item received via c2s') print('DEBUG: shared item received via c2s')
def outboxUndoShareUpload(baseDir: str,httpPrefix: str, \
nickname: str,domain: str,port: int, \ def outboxUndoShareUpload(baseDir: str, httpPrefix: str,
nickname: str, domain: str, port: int,
messageJson: {}, debug: bool) -> None: messageJson: {}, debug: bool) -> None:
""" When a shared item is removed via c2s """ When a shared item is removed via c2s
""" """
@ -577,7 +611,7 @@ def outboxUndoShareUpload(baseDir: str,httpPrefix: str, \
if debug: if debug:
print('DEBUG: displayName missing from Offer') print('DEBUG: displayName missing from Offer')
return return
removeShare(baseDir,nickname,domain, \ removeShare(baseDir, nickname, domain,
messageJson['object']['displayName']) messageJson['object']['displayName'])
if debug: if debug:
print('DEBUG: shared item removed via c2s') print('DEBUG: shared item removed via c2s')