pandora/pandora/edit/views.py

559 lines
19 KiB
Python

# -*- coding: utf-8 -*-
import os
import re
import ox
from oxdjango.decorators import login_required_json
from oxdjango.shortcuts import render_to_json_response, get_object_or_404_json, json_response
from django.db import transaction
from django.db.models import Max
from oxdjango.http import HttpFileResponse
from oxdjango.api import actions
from django.conf import settings
from item import utils
from changelog.models import add_changelog
from . import models
def get_edit_or_404_json(id):
id = id.split(':')
username = id[0]
name = ":".join(id[1:])
return get_object_or_404_json(models.Edit, user__username=username, name=name)
@login_required_json
def addClips(request, data):
'''
Adds one or more clips to a static edit
takes {
edit: string, // edit id,
index: int, // position within edit (optional),
clips: [
{
item: string, // item id
in: float, // in point in seconds
out: float, // out point in seconds
},
{
annotation: string, // 'item_id/annotation_id'
}
... // more clips
]
}
returns {}
notes: Clips are either {item, in, out} (by value) or {annotation} (by
reference). If `index` is missing, clips will be inserted at the end of the
edit.
see: editClip, orderClips, removeClips, sortClips
'''
response = json_response()
edit = get_edit_or_404_json(data['edit'])
clips = []
if edit.editable(request.user):
clips = edit.add_clips(data['clips'], data.get('index'), request.user)
if not clips:
response = json_response(status=500, text='invalid or missing item/in/out')
return render_to_json_response(response)
add_changelog(request, data, edit.get_id())
response['data']['clips'] = clips
else:
response = json_response(status=403, text='permission denied')
return render_to_json_response(response)
actions.register(addClips, cache=False)
@login_required_json
def removeClips(request, data):
'''
Removes one or more clips from a static edit
takes {
edit: string, // edit id
ids: [string] // clip ids
}
returns {}
see: addClips, editClip, orderClips, sortClips
'''
response = json_response()
edit = get_edit_or_404_json(data['edit'])
if 'id' in data:
ids = [data['id']]
else:
ids = data['ids']
ids = map(ox.fromAZ, ids)
if edit.editable(request.user):
for clip in edit.clips.filter(id__in=ids):
clip.delete()
add_changelog(request, data, edit.get_id())
response['data'] = edit.json(user=request.user)
else:
response = json_response(status=403, text='permission denied')
return render_to_json_response(response)
actions.register(removeClips, cache=False)
@login_required_json
def editClip(request, data):
'''
Edits a clip within an edit
takes {
id: string, // clip id
in: float, // in point in seconds
out: float // out point in seconds
volume: float // per clip volume (0-1)
}
returns {}
see: addClips, orderClips, removeClips, sortClips
'''
response = json_response()
clip = get_object_or_404_json(models.Clip, pk=ox.fromAZ(data['id']))
valid = True
if clip.edit.editable(request.user):
for key in ('in', 'out'):
if key in data:
if clip.annotation:
clip.start = clip.annotation.start
clip.end = clip.annotation.end
clip.item = clip.annotation.item
clip.annotation = None
setattr(clip, {'in': 'start', 'out': 'end'}.get(key), float(data[key]))
if 'annotation' in data and not data['annotation']:
if clip.annotation:
clip.start = clip.annotation.start
clip.end = clip.annotation.end
clip.item = clip.annotation.item
clip.annotation = None
if 'volume' in data:
clip.volume = float(data['volume'])
if not clip.annotation:
duration = clip.item.sort.duration
if clip.start >= clip.end or clip.start >= duration or clip.end > duration:
response = json_response(status=500, text='invalid in/out')
valid = False
if valid:
clip.save()
response['data'] = clip.json(user=request.user)
add_changelog(request, data, clip.get_id())
else:
response = json_response(status=403, text='permission denied')
return render_to_json_response(response)
actions.register(editClip, cache=False)
@login_required_json
def orderClips(request, data):
'''
Sets the manual ordering of clips within a given edit
takes {
edit: string, // edit id
ids: [string] // clip ids in new order
}
returns {}
see: addClips, editClip, removeClip, sortClips
'''
edit = get_edit_or_404_json(data['edit'])
response = json_response()
ids = map(ox.fromAZ, data['ids'])
if edit.editable(request.user):
if edit.type == 'static':
index = 0
with transaction.atomic():
for i in ids:
models.Clip.objects.filter(edit=edit, id=i).update(index=index)
index += 1
add_changelog(request, data, edit.get_id())
else:
response = json_response(status=500, text='sorting smart lists not possible')
else:
response = json_response(status=403, text='permission denied')
return render_to_json_response(response)
actions.register(orderClips, cache=False)
def _order_clips(edit, sort):
qs = edit.get_clips()
order_by = []
if len(sort) == 1:
for s in settings.CONFIG['user']['ui']['editSort']:
if (edit.type == 'smart' and s['key'] == 'index') \
or s['key'] == sort[0]['key']:
continue
sort.append(s)
for e in sort:
operator = e['operator']
if operator != '-':
operator = ''
key = e['key']
# fixme, random should be clip random
if key not in ('index', 'in', 'out', 'position', 'hue', 'saturation', 'lightness', 'volume', 'duration', 'text'):
key = "item__sort__%s" % key
key = {
'position': 'start',
'in': 'start',
'out': 'end',
'text': 'sortvalue',
'volume': 'volume' if edit.type == 'smart' else 'sortvolume',
'item__sort__item': 'item__sort__public_id',
}.get(key, key)
order = '%s%s' % (operator, key)
order_by.append(order)
if order_by:
if edit.type == 'static':
qs = qs.order_by(*order_by)
else:
qs = qs.order_by(*order_by, nulls_last=True)
qs = qs.distinct()
return qs
def sortClips(request, data):
'''
Updates the sort order of clips within an edit
takes {
edit: string, // edit id
sort: object // sort
}
returns {}
notes: sort is [{key: string, operator: string}], operator can be '+' or '-'
see: addClips, editClip, orderClips, removeClips
'''
edit = get_edit_or_404_json(data['edit'])
response = json_response()
clips = _order_clips(edit, data['sort'])
response['data']['clips'] = [ox.toAZ(c['id']) for c in clips.values('id')]
return render_to_json_response(response)
actions.register(sortClips, cache=False)
def getEdit(request, data):
'''
Gets an edit by id
takes {
id: string, // edit id
keys: [string] // list of properties to return
}
returns {
id: string, // edit id
clips: [object] // list of clips in this edit
}
see: addEdit, editEdits, findEdits, removeEdit, sortEdits
'''
if 'id' in data:
response = json_response()
edit = get_edit_or_404_json(data['id'])
if edit.accessible(request.user):
response['data'] = edit.json(keys=data.get('keys'), user=request.user)
else:
response = json_response(status=404, text='not found')
else:
response = json_response(status=404, text='not found')
return render_to_json_response(response)
actions.register(getEdit)
@login_required_json
def addEdit(request, data):
'''
Adds a new edit
takes {
name: string, // name (optional)
type: string // 'static' or 'smart'
}
returns {
id: string // edit id
... // more edit properties
}
see: editEdit, findEdit, getEdit, removeEdit, sortEdits
'''
data['name'] = re.sub(' \[\d+\]$', '', data.get('name', 'Untitled')).strip()
name = data['name']
if not name:
name = "Untitled"
num = 1
created = False
while not created:
edit, created = models.Edit.objects.get_or_create(name=name, user=request.user)
num += 1
name = data['name'] + ' [%d]' % num
del data['name']
if data:
edit.edit(data, request.user)
else:
edit.save()
if 'clips' in data and edit.type == 'static':
clips = edit.add_clips(data['clips'], 0, request.user)
if not clips:
response = json_response(status=500, text='invalid or missing item/in/out')
return render_to_json_response(response)
if edit.status == 'featured':
pos, created = models.Position.objects.get_or_create(edit=edit,
user=request.user, section='featured')
qs = models.Position.objects.filter(section='featured')
else:
pos, created = models.Position.objects.get_or_create(edit=edit,
user=request.user, section='personal')
qs = models.Position.objects.filter(user=request.user, section='personal')
pos.position = qs.aggregate(Max('position'))['position__max'] + 1
pos.save()
response = json_response(status=200, text='created')
response['data'] = edit.json(user=request.user, keys=[
'description', 'editable', 'rightslevel',
'id', 'name', 'posterFrames', 'status',
'subscribed', 'user', 'type'
])
add_changelog(request, data, edit.get_id())
return render_to_json_response(response)
actions.register(addEdit, cache=False)
@login_required_json
def editEdit(request, data):
'''
Edits an edit (yes!)
takes {
id: string, // edit id
key: value, // property id and new value
... // more key/value pairs
}
returns {
id: string, // edit id
key: value, // property id and new value
... // more key/value pairs
}
see: addEdit, findEdit, getEdit, removeEdit, sortEdits
'''
edit = get_edit_or_404_json(data['id'])
response = json_response()
if edit.editable(request.user):
edit.edit(data, request.user)
response['data'] = edit.json(keys=[
'description', 'editable', 'rightslevel',
'id', 'name', 'posterFrames', 'status',
'subscribed', 'user', 'type'
], user=request.user)
add_changelog(request, data, edit.get_id())
else:
response = json_response(status=403, text='not allowed')
return render_to_json_response(response)
actions.register(editEdit, cache=False)
@login_required_json
def removeEdit(request, data):
'''
Removes an edit
takes {
id: string // edit id
}
returns {}
see: addEdit, editEdit, findEdit, getEdit, sortEdits
'''
edit = get_edit_or_404_json(data['id'])
response = json_response()
if edit.editable(request.user):
add_changelog(request, data, edit.get_id())
edit.delete()
else:
response = json_response(status=403, text='not allowed')
return render_to_json_response(response)
actions.register(removeEdit, cache=False)
def _order_query(qs, sort):
order_by = []
for e in sort:
operator = e['operator']
if operator != '-':
operator = ''
key = {
'subscribed': 'subscribed_users',
'items': 'numberofitems'
}.get(e['key'], e['key'])
order = '%s%s' % (operator, key)
order_by.append(order)
if key == 'subscribers':
qs = qs.annotate(subscribers=Sum('subscribed_users'))
if order_by:
qs = qs.order_by(*order_by)
qs = qs.distinct()
return qs
def parse_query(data, user):
query = {}
query['range'] = [0, 100]
query['sort'] = [{'key':'user', 'operator':'+'}, {'key':'name', 'operator':'+'}]
for key in ('keys', 'group', 'edit', 'range', 'position', 'positions', 'sort'):
if key in data:
query[key] = data[key]
query['qs'] = models.Edit.objects.find(data, user).exclude(name='')
return query
def findEdits(request, data):
'''
Finds edits for a given query
takes {
query: object, // query object, see `find`
sort: [], // list of sort objects, see `find`
range: [int, int], // range of results
keys: [string] // list of properties to return
}
returns {
items: [object] // list of edit objects
}
notes: Possible query keys are 'featured', 'name', 'subscribed' and 'user',
possible keys are 'featured', 'name', 'query', 'subscribed' and 'user'.
see: addEdit, editEdits, find, getEdit, removeEdit, sortEdits
'''
query = parse_query(data, request.user)
#order
is_section_request = query['sort'] == [{'operator': '+', 'key': 'position'}]
def is_featured_condition(x):
return x['key'] == 'status' and \
x['value'] == 'featured' and \
x['operator'] in ('=', '==')
is_featured = any(filter(is_featured_condition, data.get('query', {}).get('conditions', [])))
is_personal = request.user.is_authenticated and any(
(x['key'] == 'user' and x['value'] == request.user.username and x['operator'] == '==')
for x in data.get('query', {}).get('conditions', [])
)
if is_section_request:
qs = query['qs']
if not is_featured and not request.user.is_anonymous:
qs = qs.filter(position__in=models.Position.objects.filter(user=request.user))
qs = qs.order_by('position__position')
else:
qs = _order_query(query['qs'], query['sort'])
if is_personal and request.user.profile.ui.get('hidden', {}).get('edits'):
qs = qs.exclude(name__in=request.user.profile.ui['hidden']['edits'])
response = json_response()
if 'keys' in data:
qs = qs[query['range'][0]:query['range'][1]]
response['data']['items'] = [l.json(data['keys'], request.user) for l in qs]
elif 'position' in data:
#FIXME: actually implement position requests
response['data']['position'] = 0
elif 'positions' in data:
ids = [i.get_id() for i in qs]
response['data']['positions'] = utils.get_positions(ids, query['positions'])
else:
response['data']['items'] = qs.count()
return render_to_json_response(response)
actions.register(findEdits)
@login_required_json
def subscribeToEdit(request, data):
'''
Adds an edit to favorites
takes {
id: string, // edit id
user: string // username (admin-only)
}
returns {}
see: unsubscribeFromEdit
'''
edit = get_edit_or_404_json(data['id'])
user = request.user
if edit.status == 'public' and \
edit.subscribed_users.filter(username=user.username).count() == 0:
edit.subscribed_users.add(user)
pos, created = models.Position.objects.get_or_create(edit=edit, user=user, section='public')
if created:
qs = models.Position.objects.filter(user=user, section='public')
pos.position = qs.aggregate(Max('position'))['position__max'] + 1
pos.save()
add_changelog(request, data, edit.get_id())
response = json_response()
return render_to_json_response(response)
actions.register(subscribeToEdit, cache=False)
@login_required_json
def unsubscribeFromEdit(request, data):
'''
Removes an edit from favorites
takes {
id: string, // edit id
user: string // username (admin-only)
}
returns {}
see: subscribeToEdit
'''
edit = get_edit_or_404_json(data['id'])
user = request.user
edit.subscribed_users.remove(user)
models.Position.objects.filter(edit=edit, user=user, section='public').delete()
response = json_response()
add_changelog(request, data, edit.get_id())
return render_to_json_response(response)
actions.register(unsubscribeFromEdit, cache=False)
@login_required_json
def sortEdits(request, data):
'''
Sets the order of edits in a given section
takes {
section: string, // 'personal', 'favorite' or 'featured'
ids: [string] // ordered list of edit ids
}
returns {}
notes: Setting the order of featured edits requires the appropriate
capability.
see: addEdit, editEdits, findEdits, getEdit, removeEdit
'''
position = 0
section = data['section']
section = {
'favorite': 'public'
}.get(section,section)
#ids = list(set(data['ids']))
ids = data['ids']
if section == 'featured' and not request.user.profile.capability('canEditFeaturedEdits'):
response = json_response(status=403, text='not allowed')
else:
user = request.user
if section == 'featured':
for i in ids:
l = get_edit_or_404_json(i)
qs = models.Position.objects.filter(section=section, edit=l)
if qs.count() > 0:
pos = qs[0]
else:
pos = models.Position(edit=l, user=user, section=section)
if pos.position != position:
pos.position = position
pos.save()
position += 1
models.Position.objects.filter(section=section, edit=l).exclude(id=pos.id).delete()
else:
for i in ids:
l = get_edit_or_404_json(i)
pos, created = models.Position.objects.get_or_create(edit=l,
user=request.user, section=section)
if pos.position != position:
pos.position = position
pos.save()
position += 1
response = json_response()
return render_to_json_response(response)
actions.register(sortEdits, cache=False)
def icon(request, id, size=16):
if not size:
size = 16
id = id.split(':')
username = id[0]
name = ":".join(id[1:])
qs = models.Edit.objects.filter(user__username=username, name=name)
if qs.count() == 1 and qs[0].accessible(request.user):
edit = qs[0]
icon = edit.get_icon(int(size))
else:
icon = os.path.join(settings.STATIC_ROOT, 'jpg/list256.jpg')
return HttpFileResponse(icon, content_type='image/jpeg')