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
  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
  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
  60     episodes = episode_list(podcast, request.user, limit=20)
  61
  62     max_listeners = max([e.listeners for e in episodes] + [0])
  63
  64     episode = None
  65
  66     if episodes:
  67         episode = episodes[0]
  68         episodes = episodes[1:]
  69
  70     if podcast.group:
  71         group = PodcastGroup.get(podcast.group)
  72         rel_podcasts = filter(lambda x: x != podcast, group.podcasts)
  73     else:
  74         rel_podcasts = []
  75
  76     tags = get_tags(podcast, request.user)
  77
  78     if request.user.is_authenticated():
  79         state = podcast_state_for_user_podcast(request.user, podcast)
  80         subscribed_devices = state.get_subscribed_device_ids()
  81         subscribed_devices = [request.user.get_device(x) for x in subscribed_devices]
  82
  83         subscribe_targets = podcast.subscribe_targets(request.user)
  84
  85         history = list(state.actions)
  86         def _set_objects(h):
  87             dev = request.user.get_device(h.device)
  88             return proxy_object(h, device=dev)
  89         history = map(_set_objects, history)
  90
  91         is_public = state.get_wksetting(PUBLIC_SUB_PODCAST)
  92
  93         return render(request, 'podcast.html', {
  94             'tags': tags,
  95             'history': history,
  96             'podcast': podcast,
  97             'is_public': is_public,
  98             'devices': subscribed_devices,
  99             'related_podcasts': rel_podcasts,
 100             'can_subscribe': len(subscribe_targets) > 0,
 101             'subscribe_targets': subscribe_targets,
 102             'episode': episode,
 103             'episodes': episodes,
 104             'max_listeners': max_listeners,
 105         })
 106     else:
 107         current_site = RequestSite(request)
 108         return render(request, 'podcast.html', {
 109             'podcast': podcast,
 110             'related_podcasts': rel_podcasts,
 111             'tags': tags,
 112             'url': current_site,
 113             'episode': episode,
 114             'episodes': episodes,
 115             'max_listeners': max_listeners,
 116         })
 117
 118
 119 def get_tags(podcast, user):
 120     tags = {}
 121     for t in tags_for_podcast(podcast):
 122         tag_str = t.lower()
 123         tags[tag_str] = False
 124
 125     if not user.is_anonymous():
 126         users_tags = tags_for_user(user, podcast.get_id())
 127         for t in users_tags.get(podcast.get_id(), []):
 128             tag_str = t.lower()
 129             tags[tag_str] = True
 130
 131     tag_list = [{'tag': key, 'is_own': value} for key, value in tags.iteritems()]
 132     tag_list.sort(key=lambda x: x['tag'])
 133
 134     if len(tag_list) > MAX_TAGS_ON_PAGE:
 135         tag_list = filter(lambda x: x['is_own'], tag_list)
 136         tag_list.append({'tag': '...', 'is_own': False})
 137
 138     return tag_list
 139
 140
 141 def episode_list(podcast, user, limit=None):
 142     """
 143     Returns a list of episodes, with their action-attribute set to the latest
 144     action. The attribute is unsert if there is no episode-action for
 145     the episode.
 146     """
 147
 148     listeners = dict(episode_listener_counts(podcast))
 149     episodes = episodes_for_podcast(podcast, descending=True, limit=limit)
 150
 151     if user.is_authenticated():
 152
 153         # prepare pre-populated data for HistoryEntry.fetch_data
 154         podcasts_dict = dict( (p_id, podcast) for p_id in podcast.get_ids())
 155         episodes_dict = dict( (episode._id, episode) for episode in episodes)
 156
 157         actions = get_podcasts_episode_states(podcast, user._id)
 158         actions = map(HistoryEntry.from_action_dict, actions)
 159
 160         HistoryEntry.fetch_data(user, actions,
 161                 podcasts=podcasts_dict, episodes=episodes_dict)
 162
 163         episode_actions = dict( (action.episode_id, action) for action in actions)
 164     else:
 165         episode_actions = {}
 166
 167     annotate_episode = partial(_annotate_episode, listeners, episode_actions)
 168     return map(annotate_episode, episodes)
 169
 170
 171
 172 def all_episodes(request, podcast):
 173
 174     episodes = episode_list(podcast, request.user)
 175
 176     max_listeners = max([e.listeners for e in episodes] + [0])
 177
 178     return render(request, 'episodes.html', {
 179         'podcast': podcast,
 180         'episodes': episodes,
 181         'max_listeners': max_listeners,
 182     })
 183
 184
 185
 186 def _annotate_episode(listeners, episode_actions, episode):
 187     listener_count = listeners.pop(episode._id, None)
 188     action         = episode_actions.pop(episode._id, None)
 189     return proxy_object(episode, listeners=listener_count, action=action)
 190
 191
 192
 193 @never_cache
 194 @login_required
 195 def add_tag(request, podcast):
 196     podcast_state = podcast_state_for_user_podcast(request.user, podcast)
 197
 198     tag_str = request.GET.get('tag', '')
 199     if not tag_str:
 200         return HttpResponseBadRequest()
 201
 202     tags = tag_str.split(',')
 203
 204     @repeat_on_conflict(['state'])
 205     def update(state):
 206         state.add_tags(tags)
 207         state.save()
 208
 209     update(state=podcast_state)
 210
 211     if request.GET.get('next', '') == 'mytags':
 212         return HttpResponseRedirect('/tags/')
 213
 214     return HttpResponseRedirect(get_podcast_link_target(podcast))
 215
 216
 217 @never_cache
 218 @login_required
 219 def remove_tag(request, podcast):
 220     podcast_state = podcast_state_for_user_podcast(request.user, podcast)
 221
 222     tag_str = request.GET.get('tag', '')
 223     if not tag_str:
 224         return HttpResponseBadRequest()
 225
 226     @repeat_on_conflict(['state'])
 227     def update(state):
 228         tags = list(state.tags)
 229         if tag_str in tags:
 230             state.tags.remove(tag_str)
 231             state.save()
 232
 233     update(state=podcast_state)
 234
 235     if request.GET.get('next', '') == 'mytags':
 236         return HttpResponseRedirect('/tags/')
 237
 238     return HttpResponseRedirect(get_podcast_link_target(podcast))
 239
 240
 241 @never_cache
 242 @login_required
 243 @allowed_methods(['GET', 'POST'])
 244 def subscribe(request, podcast):
 245
 246     if request.method == 'POST':
 247
 248         # multiple UIDs from the /podcast/<slug>/subscribe
 249         device_uids = [k for (k,v) in request.POST.items() if k==v]
 250
 251         # single UID from /podcast/<slug>
 252         if 'targets' in request.POST:
 253             device_uids.append(request.POST.get('targets'))
 254
 255         for uid in device_uids:
 256             try:
 257                 device = request.user.get_device_by_uid(uid)
 258                 podcast.subscribe(request.user, device)
 259
 260             except (SubscriptionException, DeviceDoesNotExist, ValueError) as e:
 261                 messages.error(request, str(e))
 262
 263         return HttpResponseRedirect(get_podcast_link_target(podcast))
 264
 265     targets = podcast.subscribe_targets(request.user)
 266
 267     return render(request, 'subscribe.html', {
 268         'targets': targets,
 269         'podcast': podcast,
 270     })
 271
 272
 273 @never_cache
 274 @login_required
 275 def unsubscribe(request, podcast, device_uid):
 276
 277     return_to = request.GET.get('return_to', None)
 278
 279     if not return_to:
 280         raise Http404('Wrong URL')
 281
 282     try:
 283         device = request.user.get_device_by_uid(device_uid)
 284
 285     except DeviceDoesNotExist as e:
 286         messages.error(request, str(e))
 287
 288     try:
 289         podcast.unsubscribe(request.user, device)
 290     except SubscriptionException as e:
 291         log('Web: %(username)s: could not unsubscribe from podcast %(podcast_url)s on device %(device_id)s: %(exception)s' %
 292             {'username': request.user.username, 'podcast_url': podcast.url, 'device_id': device.id, 'exception': e})
 293
 294     return HttpResponseRedirect(return_to)
 295
 296
 297 @never_cache
 298 @login_required
 299 def subscribe_url(request):
 300     url = request.GET.get('url', None)
 301
 302     if not url:
 303         raise Http404('http://my.gpodder.org/subscribe?url=http://www.example.com/podcast.xml')
 304
 305     url = sanitize_url(url)
 306
 307     if url == '':
 308         raise Http404('Please specify a valid url')
 309
 310     podcast = podcast_for_url(url, create=True)
 311
 312     return HttpResponseRedirect(get_podcast_link_target(podcast, 'subscribe'))
 313
 314
 315 @never_cache
 316 @allowed_methods(['POST'])
 317 def set_public(request, podcast, public):
 318     state = podcast_state_for_user_podcast(request.user, podcast)
 319     update_podcast_settings(state=state, is_public=public)
 320     return HttpResponseRedirect(get_podcast_link_target(podcast))
 321
 322
 323 @never_cache
 324 @login_required
 325 def flattr_podcast(request, podcast):
 326     user = request.user
 327     site = RequestSite(request)
 328     task = flattr_thing.delay(user, podcast.get_id(), site.domain, 'Podcast')
 329     success, msg = task.get()
 330
 331     if success:
 332         action = SubscriptionAction()
 333         action.action = 'flattr'
 334         state = podcast_state_for_user_podcast(request.user, podcast)
 335         add_subscription_action(state, action)
 336         messages.success(request, _("Flattr\'d"))
 337
 338     else:
 339         messages.error(request, msg)
 340
 341     return HttpResponseRedirect(get_podcast_link_target(podcast))
 342
 343
 344 # To make all view accessible via either CouchDB-ID or Slugs
 345 # a decorator queries the podcast and passes the Id on to the
 346 # regular views
 347
 348 def slug_id_decorator(f):
 349     @wraps(f)
 350     def _decorator(request, slug_id, *args, **kwargs):
 351         podcast = podcast_for_slug_id(slug_id)
 352
 353         if podcast is None:
 354             raise Http404
 355
 356         return f(request, podcast, *args, **kwargs)
 357
 358     return _decorator
 359
 360
 361 def oldid_decorator(f):
 362     @wraps(f)
 363     def _decorator(request, pid, *args, **kwargs):
 364         try:
 365             pid = int(pid)
 366         except (TypeError, ValueError):
 367             raise Http404
 368
 369         podcast = podcast_for_oldid(pid)
 370
 371         if not podcast:
 372             raise Http404
 373
 374         return f(request, podcast, *args, **kwargs)
 375
 376     return _decorator
 377
 378
 379 show_slug_id        = slug_id_decorator(show)
 380 subscribe_slug_id   = slug_id_decorator(subscribe)
 381 unsubscribe_slug_id = slug_id_decorator(unsubscribe)
 382 add_tag_slug_id     = slug_id_decorator(add_tag)
 383 remove_tag_slug_id  = slug_id_decorator(remove_tag)
 384 set_public_slug_id  = slug_id_decorator(set_public)
 385 all_episodes_slug_id= slug_id_decorator(all_episodes)
 386 flattr_podcast_slug_id=slug_id_decorator(flattr_podcast)
 387
 388
 389 show_oldid          = oldid_decorator(show)
 390 subscribe_oldid     = oldid_decorator(subscribe)
 391 unsubscribe_oldid   = oldid_decorator(unsubscribe)
 392 add_tag_oldid       = oldid_decorator(add_tag)
 393 remove_tag_oldid    = oldid_decorator(remove_tag)
 394 set_public_oldid    = oldid_decorator(set_public)
 395 all_episodes_oldid  = oldid_decorator(all_episodes)
 396 flattr_podcast_oldid= oldid_decorator(flattr_podcast)