mygpo/web/views/podcast.py

   1 from functools import wraps, partial
   2
   3 from django.core.urlresolvers import reverse
   4 from django.http import HttpResponseBadRequest, HttpResponseRedirect, Http404
   5 from django.shortcuts import render
   6 from django.contrib.auth.decorators import login_required
   7 from django.contrib.sites.models import RequestSite
   8 from django.utils.translation import ugettext as _
   9 from django.contrib import messages
  10 from django.views.decorators.vary import vary_on_cookie
  11 from django.views.decorators.cache import never_cache, cache_control
  12
  13 from mygpo.core.models import PodcastGroup, SubscriptionException
  14 from mygpo.core.proxy import proxy_object
  15 from mygpo.core.tasks import flattr_thing
  16 from mygpo.api.sanitizing import sanitize_url
  17 from mygpo.users.settings import PUBLIC_SUB_PODCAST, FLATTR_TOKEN
  18 from mygpo.users.models import HistoryEntry, DeviceDoesNotExist, SubscriptionAction
  19 from mygpo.web.forms import SyncForm
  20 from mygpo.decorators import allowed_methods, repeat_on_conflict
  21 from mygpo.web.utils import get_podcast_link_target, get_page_list
  22 from mygpo.log import log
  23 from mygpo.db.couchdb.episode import episodes_for_podcast
  24 from mygpo.db.couchdb.podcast import podcast_for_slug, podcast_for_slug_id, \
  25          podcast_for_oldid, podcast_for_url
  26 from mygpo.db.couchdb.podcast_state import podcast_state_for_user_podcast, \
  27          add_subscription_action
  28 from mygpo.db.couchdb.episode_state import get_podcasts_episode_states, \
  29          episode_listener_counts
  30 from mygpo.db.couchdb.directory import tags_for_user, tags_for_podcast
  31
  32
  33 MAX_TAGS_ON_PAGE=50
  34
  35
  36 @repeat_on_conflict(['state'])
  37 def update_podcast_settings(state, is_public):
  38     state.settings[PUBLIC_SUB_PODCAST.name] = is_public
  39     state.save()
  40
  41
  42 @vary_on_cookie
  43 @cache_control(private=True)
  44 @allowed_methods(['GET'])
  45 def show_slug(request, slug):
  46     podcast = podcast_for_slug(slug)
  47
  48     if slug != podcast.slug:
  49         target = reverse('podcast_slug', args=[podcast.slug])
  50         return HttpResponseRedirect(target)
  51
  52     return show(request, podcast.oldid)
  53
  54
  55 @vary_on_cookie
  56 @cache_control(private=True)
  57 @allowed_methods(['GET'])
  58 def show(request, podcast):
  59     """ Shows a podcast detail page """
  60
  61     current_site = RequestSite(request)
  62     episodes = episode_list(podcast, request.user, limit=20)
  63     user = request.user
  64
  65     max_listeners = max([e.listeners for e in episodes] + [0])
  66
  67     episode = None
  68
  69     if episodes:
  70         episode = episodes[0]
  71         episodes = episodes[1:]
  72
  73     if podcast.group:
  74         group = PodcastGroup.get(podcast.group)
  75         rel_podcasts = filter(lambda x: x != podcast, group.podcasts)
  76     else:
  77         rel_podcasts = []
  78
  79     tags = get_tags(podcast, user)
  80
  81     if user.is_authenticated():
  82         state = podcast_state_for_user_podcast(user, podcast)
  83         subscribed_devices = state.get_subscribed_device_ids()
  84         subscribed_devices = [user.get_device(x) for x in subscribed_devices]
  85
  86         subscribe_targets = podcast.subscribe_targets(user)
  87
  88         history = list(state.actions)
  89         is_public = state.settings.get('public_subscription', True)
  90         can_flattr = request.user.get_wksetting(FLATTR_TOKEN) and podcast.flattr_url
  91
  92     else:
  93         history = []
  94         is_public = False
  95         subscribed_devices = []
  96         subscribe_targets = []
  97         can_flattr = False
  98
  99     def _set_objects(h):
 100         dev = user.get_device(h.device)
 101         return proxy_object(h, device=dev)
 102     history = map(_set_objects, history)
 103
 104     return render(request, 'podcast.html', {
 105         'tags': tags,
 106         'url': current_site,
 107         'history': history,
 108         'podcast': podcast,
 109         'is_public': is_public,
 110         'devices': subscribed_devices,
 111         'related_podcasts': rel_podcasts,
 112         'can_subscribe': len(subscribe_targets) > 0,
 113         'subscribe_targets': subscribe_targets,
 114         'episode': episode,
 115         'episodes': episodes,
 116         'max_listeners': max_listeners,
 117         'can_flattr': can_flattr,
 118     })
 119
 120
 121 def get_tags(podcast, user):
 122     tags = {}
 123     for t in tags_for_podcast(podcast):
 124         tag_str = t.lower()
 125         tags[tag_str] = False
 126
 127     if not user.is_anonymous():
 128         users_tags = tags_for_user(user, podcast.get_id())
 129         for t in users_tags.get(podcast.get_id(), []):
 130             tag_str = t.lower()
 131             tags[tag_str] = True
 132
 133     tag_list = [{'tag': key, 'is_own': value} for key, value in tags.iteritems()]
 134     tag_list.sort(key=lambda x: x['tag'])
 135
 136     if len(tag_list) > MAX_TAGS_ON_PAGE:
 137         tag_list = filter(lambda x: x['is_own'], tag_list)
 138         tag_list.append({'tag': '...', 'is_own': False})
 139
 140     return tag_list
 141
 142
 143 def episode_list(podcast, user, offset=0, limit=None):
 144     """
 145     Returns a list of episodes, with their action-attribute set to the latest
 146     action. The attribute is unsert if there is no episode-action for
 147     the episode.
 148     """
 149
 150     listeners = dict(episode_listener_counts(podcast))
 151     episodes = episodes_for_podcast(podcast, descending=True, skip=offset, limit=limit)
 152
 153     if user.is_authenticated():
 154
 155         # prepare pre-populated data for HistoryEntry.fetch_data
 156         podcasts_dict = dict( (p_id, podcast) for p_id in podcast.get_ids())
 157         episodes_dict = dict( (episode._id, episode) for episode in episodes)
 158
 159         actions = get_podcasts_episode_states(podcast, user._id)
 160         actions = map(HistoryEntry.from_action_dict, actions)
 161
 162         HistoryEntry.fetch_data(user, actions,
 163                 podcasts=podcasts_dict, episodes=episodes_dict)
 164
 165         episode_actions = dict( (action.episode_id, action) for action in actions)
 166     else:
 167         episode_actions = {}
 168
 169     annotate_episode = partial(_annotate_episode, listeners, episode_actions)
 170     return map(annotate_episode, episodes)
 171
 172
 173
 174 def all_episodes(request, podcast, page_size=20):
 175
 176     # Make sure page request is an int. If not, deliver first page.
 177     try:
 178         page = int(request.GET.get('page', '1'))
 179     except ValueError:
 180         page = 1
 181
 182     episodes = episode_list(podcast, request.user, (page-1) * page_size,
 183             page_size)
 184     episodes_total = podcast.episode_count or 0
 185     num_pages = episodes_total / page_size
 186     page_list = get_page_list(1, num_pages, page, 15)
 187
 188     max_listeners = max([e.listeners for e in episodes] + [0])
 189
 190     return render(request, 'episodes.html', {
 191         'podcast': podcast,
 192         'episodes': episodes,
 193         'max_listeners': max_listeners,
 194         'page_list': page_list,
 195         'current_page': page,
 196     })
 197
 198
 199
 200 def _annotate_episode(listeners, episode_actions, episode):
 201     listener_count = listeners.pop(episode._id, None)
 202     action         = episode_actions.pop(episode._id, None)
 203     return proxy_object(episode, listeners=listener_count, action=action)
 204
 205
 206
 207 @never_cache
 208 @login_required
 209 def add_tag(request, podcast):
 210     podcast_state = podcast_state_for_user_podcast(request.user, podcast)
 211
 212     tag_str = request.GET.get('tag', '')
 213     if not tag_str:
 214         return HttpResponseBadRequest()
 215
 216     tags = tag_str.split(',')
 217
 218     @repeat_on_conflict(['state'])
 219     def update(state):
 220         state.add_tags(tags)
 221         state.save()
 222
 223     update(state=podcast_state)
 224
 225     if request.GET.get('next', '') == 'mytags':
 226         return HttpResponseRedirect('/tags/')
 227
 228     return HttpResponseRedirect(get_podcast_link_target(podcast))
 229
 230
 231 @never_cache
 232 @login_required
 233 def remove_tag(request, podcast):
 234     podcast_state = podcast_state_for_user_podcast(request.user, podcast)
 235
 236     tag_str = request.GET.get('tag', '')
 237     if not tag_str:
 238         return HttpResponseBadRequest()
 239
 240     @repeat_on_conflict(['state'])
 241     def update(state):
 242         tags = list(state.tags)
 243         if tag_str in tags:
 244             state.tags.remove(tag_str)
 245             state.save()
 246
 247     update(state=podcast_state)
 248
 249     if request.GET.get('next', '') == 'mytags':
 250         return HttpResponseRedirect('/tags/')
 251
 252     return HttpResponseRedirect(get_podcast_link_target(podcast))
 253
 254
 255 @never_cache
 256 @login_required
 257 @allowed_methods(['GET', 'POST'])
 258 def subscribe(request, podcast):
 259
 260     if request.method == 'POST':
 261
 262         # multiple UIDs from the /podcast/<slug>/subscribe
 263         device_uids = [k for (k,v) in request.POST.items() if k==v]
 264
 265         # single UID from /podcast/<slug>
 266         if 'targets' in request.POST:
 267             device_uids.append(request.POST.get('targets'))
 268
 269         for uid in device_uids:
 270             try:
 271                 device = request.user.get_device_by_uid(uid)
 272                 podcast.subscribe(request.user, device)
 273
 274             except (SubscriptionException, DeviceDoesNotExist, ValueError) as e:
 275                 messages.error(request, str(e))
 276
 277         return HttpResponseRedirect(get_podcast_link_target(podcast))
 278
 279     targets = podcast.subscribe_targets(request.user)
 280
 281     return render(request, 'subscribe.html', {
 282         'targets': targets,
 283         'podcast': podcast,
 284     })
 285
 286
 287 @never_cache
 288 @login_required
 289 def unsubscribe(request, podcast, device_uid):
 290
 291     return_to = request.GET.get('return_to', None)
 292
 293     if not return_to:
 294         raise Http404('Wrong URL')
 295
 296     try:
 297         device = request.user.get_device_by_uid(device_uid)
 298
 299     except DeviceDoesNotExist as e:
 300         messages.error(request, str(e))
 301
 302     try:
 303         podcast.unsubscribe(request.user, device)
 304     except SubscriptionException as e:
 305         log('Web: %(username)s: could not unsubscribe from podcast %(podcast_url)s on device %(device_id)s: %(exception)s' %
 306             {'username': request.user.username, 'podcast_url': podcast.url, 'device_id': device.id, 'exception': e})
 307
 308     return HttpResponseRedirect(return_to)
 309
 310
 311 @never_cache
 312 @login_required
 313 def subscribe_url(request):
 314     url = request.GET.get('url', None)
 315
 316     if not url:
 317         raise Http404('http://my.gpodder.org/subscribe?url=http://www.example.com/podcast.xml')
 318
 319     url = sanitize_url(url)
 320
 321     if url == '':
 322         raise Http404('Please specify a valid url')
 323
 324     podcast = podcast_for_url(url, create=True)
 325
 326     return HttpResponseRedirect(get_podcast_link_target(podcast, 'subscribe'))
 327
 328
 329 @never_cache
 330 @allowed_methods(['POST'])
 331 def set_public(request, podcast, public):
 332     state = podcast_state_for_user_podcast(request.user, podcast)
 333     update_podcast_settings(state=state, is_public=public)
 334     return HttpResponseRedirect(get_podcast_link_target(podcast))
 335
 336
 337 @never_cache
 338 @login_required
 339 def flattr_podcast(request, podcast):
 340     """ Flattrs a podcast, records an event and redirects to the podcast """
 341
 342     user = request.user
 343     site = RequestSite(request)
 344
 345     # do flattring via the tasks queue, but wait for the result
 346     task = flattr_thing.delay(user, podcast.get_id(), site.domain,
 347             request.is_secure(), 'Podcast')
 348     success, msg = task.get()
 349
 350     if success:
 351         action = SubscriptionAction()
 352         action.action = 'flattr'
 353         state = podcast_state_for_user_podcast(request.user, podcast)
 354         add_subscription_action(state, action)
 355         messages.success(request, _("Flattr\'d"))
 356
 357     else:
 358         messages.error(request, msg)
 359
 360     return HttpResponseRedirect(get_podcast_link_target(podcast))
 361
 362
 363 # To make all view accessible via either CouchDB-ID or Slugs
 364 # a decorator queries the podcast and passes the Id on to the
 365 # regular views
 366
 367 def slug_id_decorator(f):
 368     @wraps(f)
 369     def _decorator(request, slug_id, *args, **kwargs):
 370         podcast = podcast_for_slug_id(slug_id)
 371
 372         if podcast is None:
 373             raise Http404
 374
 375         # redirect when Id or a merged (non-cannonical) slug is used
 376         if podcast.slug and slug_id != podcast.slug:
 377             return HttpResponseRedirect(get_podcast_link_target(podcast))
 378
 379         return f(request, podcast, *args, **kwargs)
 380
 381     return _decorator
 382
 383
 384 def oldid_decorator(f):
 385     @wraps(f)
 386     def _decorator(request, pid, *args, **kwargs):
 387         try:
 388             pid = int(pid)
 389         except (TypeError, ValueError):
 390             raise Http404
 391
 392         podcast = podcast_for_oldid(pid)
 393
 394         if not podcast:
 395             raise Http404
 396
 397         # redirect to Id or slug URL
 398         return HttpResponseRedirect(get_podcast_link_target(podcast))
 399
 400     return _decorator
 401
 402
 403 show_slug_id        = slug_id_decorator(show)
 404 subscribe_slug_id   = slug_id_decorator(subscribe)
 405 unsubscribe_slug_id = slug_id_decorator(unsubscribe)
 406 add_tag_slug_id     = slug_id_decorator(add_tag)
 407 remove_tag_slug_id  = slug_id_decorator(remove_tag)
 408 set_public_slug_id  = slug_id_decorator(set_public)
 409 all_episodes_slug_id= slug_id_decorator(all_episodes)
 410 flattr_podcast_slug_id=slug_id_decorator(flattr_podcast)
 411
 412
 413 show_oldid          = oldid_decorator(show)
 414 subscribe_oldid     = oldid_decorator(subscribe)
 415 unsubscribe_oldid   = oldid_decorator(unsubscribe)
 416 add_tag_oldid       = oldid_decorator(add_tag)
 417 remove_tag_oldid    = oldid_decorator(remove_tag)
 418 set_public_oldid    = oldid_decorator(set_public)
 419 all_episodes_oldid  = oldid_decorator(all_episodes)
 420 flattr_podcast_oldid= oldid_decorator(flattr_podcast)