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.api.sanitizing import sanitize_url
  16 from mygpo.users.models import HistoryEntry, DeviceDoesNotExist
  17 from mygpo.web.forms import SyncForm
  18 from mygpo.decorators import allowed_methods, repeat_on_conflict
  19 from mygpo.web.utils import get_podcast_link_target
  20 from mygpo.log import log
  21 from mygpo.db.couchdb.episode import episodes_for_podcast
  22 from mygpo.db.couchdb.podcast import podcast_for_slug, podcast_for_slug_id, \
  23          podcast_for_oldid, podcast_for_url
  24 from mygpo.db.couchdb.podcast_state import podcast_state_for_user_podcast
  25 from mygpo.db.couchdb.episode_state import get_podcasts_episode_states, \
  26          episode_listener_counts
  27 from mygpo.db.couchdb.directory import tags_for_user, tags_for_podcast
  28
  29
  30 MAX_TAGS_ON_PAGE=50
  31
  32
  33 @repeat_on_conflict(['state'])
  34 def update_podcast_settings(state, is_public):
  35     state.settings['public_subscription'] = is_public
  36     state.save()
  37
  38
  39 @vary_on_cookie
  40 @cache_control(private=True)
  41 @allowed_methods(['GET'])
  42 def show_slug(request, slug):
  43     podcast = podcast_for_slug(slug)
  44
  45     if slug != podcast.slug:
  46         target = reverse('podcast_slug', args=[podcast.slug])
  47         return HttpResponseRedirect(target)
  48
  49     return show(request, podcast.oldid)
  50
  51
  52 @vary_on_cookie
  53 @cache_control(private=True)
  54 @allowed_methods(['GET'])
  55 def show(request, podcast):
  56
  57     episodes = episode_list(podcast, request.user, limit=20)
  58
  59     max_listeners = max([e.listeners for e in episodes] + [0])
  60
  61     episode = None
  62
  63     if episodes:
  64         episode = episodes[0]
  65         episodes = episodes[1:]
  66
  67     if podcast.group:
  68         group = PodcastGroup.get(podcast.group)
  69         rel_podcasts = filter(lambda x: x != podcast, group.podcasts)
  70     else:
  71         rel_podcasts = []
  72
  73     tags = get_tags(podcast, request.user)
  74
  75     if request.user.is_authenticated():
  76
  77         request.user.sync_all()
  78
  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.settings.get('public_subscription', True)
  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     if request.user.is_authenticated():
 179
 180         request.user.sync_all()
 181
 182     return render(request, 'episodes.html', {
 183         'podcast': podcast,
 184         'episodes': episodes,
 185         'max_listeners': max_listeners,
 186     })
 187
 188
 189
 190 def _annotate_episode(listeners, episode_actions, episode):
 191     listener_count = listeners.pop(episode._id, None)
 192     action         = episode_actions.pop(episode._id, None)
 193     return proxy_object(episode, listeners=listener_count, action=action)
 194
 195
 196
 197 @never_cache
 198 @login_required
 199 def add_tag(request, podcast):
 200     podcast_state = podcast_state_for_user_podcast(request.user, podcast)
 201
 202     tag_str = request.GET.get('tag', '')
 203     if not tag_str:
 204         return HttpResponseBadRequest()
 205
 206     tags = tag_str.split(',')
 207
 208     @repeat_on_conflict(['state'])
 209     def update(state):
 210         state.add_tags(tags)
 211         state.save()
 212
 213     update(state=podcast_state)
 214
 215     if request.GET.get('next', '') == 'mytags':
 216         return HttpResponseRedirect('/tags/')
 217
 218     return HttpResponseRedirect(get_podcast_link_target(podcast))
 219
 220
 221 @never_cache
 222 @login_required
 223 def remove_tag(request, podcast):
 224     podcast_state = podcast_state_for_user_podcast(request.user, podcast)
 225
 226     tag_str = request.GET.get('tag', '')
 227     if not tag_str:
 228         return HttpResponseBadRequest()
 229
 230     @repeat_on_conflict(['state'])
 231     def update(state):
 232         tags = list(state.tags)
 233         if tag_str in tags:
 234             state.tags.remove(tag_str)
 235             state.save()
 236
 237     update(state=podcast_state)
 238
 239     if request.GET.get('next', '') == 'mytags':
 240         return HttpResponseRedirect('/tags/')
 241
 242     return HttpResponseRedirect(get_podcast_link_target(podcast))
 243
 244
 245 @never_cache
 246 @login_required
 247 @allowed_methods(['GET', 'POST'])
 248 def subscribe(request, podcast):
 249
 250     if request.method == 'POST':
 251
 252         device_uids = [k for (k,v) in request.POST.items() if k==v]
 253
 254         for uid in device_uids:
 255             try:
 256                 device = request.user.get_device_by_uid(uid)
 257                 podcast.subscribe(request.user, device)
 258
 259             except (SubscriptionException, DeviceDoesNotExist, ValueError) as e:
 260                 messages.error(request, str(e))
 261
 262         return HttpResponseRedirect(get_podcast_link_target(podcast))
 263
 264
 265     request.user.sync_all()
 266
 267     targets = podcast.subscribe_targets(request.user)
 268
 269     return render(request, 'subscribe.html', {
 270         'targets': targets,
 271         'podcast': podcast,
 272     })
 273
 274
 275 @never_cache
 276 @login_required
 277 def unsubscribe(request, podcast, device_uid):
 278
 279     return_to = request.GET.get('return_to', None)
 280
 281     if not return_to:
 282         raise Http404('Wrong URL')
 283
 284     try:
 285         device = request.user.get_device_by_uid(device_uid)
 286
 287     except DeviceDoesNotExist as e:
 288         messages.error(request, str(e))
 289
 290     try:
 291         podcast.unsubscribe(request.user, device)
 292     except SubscriptionException as e:
 293         log('Web: %(username)s: could not unsubscribe from podcast %(podcast_url)s on device %(device_id)s: %(exception)s' %
 294             {'username': request.user.username, 'podcast_url': podcast.url, 'device_id': device.id, 'exception': e})
 295
 296     return HttpResponseRedirect(return_to)
 297
 298
 299 @never_cache
 300 @login_required
 301 def subscribe_url(request):
 302     url = request.GET.get('url', None)
 303
 304     if not url:
 305         raise Http404('http://my.gpodder.org/subscribe?url=http://www.example.com/podcast.xml')
 306
 307     url = sanitize_url(url)
 308
 309     if url == '':
 310         raise Http404('Please specify a valid url')
 311
 312     podcast = podcast_for_url(url, create=True)
 313
 314     return HttpResponseRedirect(get_podcast_link_target(podcast, 'subscribe'))
 315
 316
 317 @never_cache
 318 @allowed_methods(['POST'])
 319 def set_public(request, podcast, public):
 320     state = podcast_state_for_user_podcast(request.user, podcast)
 321     update_podcast_settings(state=state, is_public=public)
 322     return HttpResponseRedirect(get_podcast_link_target(podcast))
 323
 324
 325 # To make all view accessible via either CouchDB-ID or Slugs
 326 # a decorator queries the podcast and passes the Id on to the
 327 # regular views
 328
 329 def slug_id_decorator(f):
 330     @wraps(f)
 331     def _decorator(request, slug_id, *args, **kwargs):
 332         podcast = podcast_for_slug_id(slug_id)
 333
 334         if podcast is None:
 335             raise Http404
 336
 337         return f(request, podcast, *args, **kwargs)
 338
 339     return _decorator
 340
 341
 342 def oldid_decorator(f):
 343     @wraps(f)
 344     def _decorator(request, pid, *args, **kwargs):
 345         try:
 346             pid = int(pid)
 347         except (TypeError, ValueError):
 348             raise Http404
 349
 350         podcast = podcast_for_oldid(pid)
 351
 352         if not podcast:
 353             raise Http404
 354
 355         return f(request, podcast, *args, **kwargs)
 356
 357     return _decorator
 358
 359
 360 show_slug_id        = slug_id_decorator(show)
 361 subscribe_slug_id   = slug_id_decorator(subscribe)
 362 unsubscribe_slug_id = slug_id_decorator(unsubscribe)
 363 add_tag_slug_id     = slug_id_decorator(add_tag)
 364 remove_tag_slug_id  = slug_id_decorator(remove_tag)
 365 set_public_slug_id  = slug_id_decorator(set_public)
 366 all_episodes_slug_id= slug_id_decorator(all_episodes)
 367
 368
 369 show_oldid          = oldid_decorator(show)
 370 subscribe_oldid     = oldid_decorator(subscribe)
 371 unsubscribe_oldid   = oldid_decorator(unsubscribe)
 372 add_tag_oldid       = oldid_decorator(add_tag)
 373 remove_tag_oldid    = oldid_decorator(remove_tag)
 374 set_public_oldid    = oldid_decorator(set_public)
 375 all_episodes_oldid  = oldid_decorator(all_episodes)