mediagoblin/user_pages/views.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import logging
  18 import datetime
  19
  20 from mediagoblin import messages, mg_globals
  21 from mediagoblin.db.models import (MediaEntry, MediaTag, Collection,
  22                                    CollectionItem, User)
  23 from mediagoblin.tools.response import render_to_response, render_404, redirect
  24 from mediagoblin.tools.translate import pass_to_ugettext as _
  25 from mediagoblin.tools.pagination import Pagination
  26 from mediagoblin.user_pages import forms as user_forms
  27 from mediagoblin.user_pages.lib import send_comment_email
  28
  29 from mediagoblin.decorators import (uses_pagination, get_user_media_entry,
  30     get_media_entry_by_id,
  31     require_active_login, user_may_delete_media, user_may_alter_collection,
  32     get_user_collection, get_user_collection_item, active_user_from_url)
  33
  34 from werkzeug.contrib.atom import AtomFeed
  35
  36
  37 _log = logging.getLogger(__name__)
  38 _log.setLevel(logging.DEBUG)
  39
  40
  41 @uses_pagination
  42 def user_home(request, page):
  43     """'Homepage' of a User()"""
  44     # TODO: decide if we only want homepages for active users, we can
  45     # then use the @get_active_user decorator and also simplify the
  46     # template html.
  47     user = User.query.filter_by(username=request.matchdict['user']).first()
  48     if not user:
  49         return render_404(request)
  50     elif user.status != u'active':
  51         return render_to_response(
  52             request,
  53             'mediagoblin/user_pages/user.html',
  54             {'user': user})
  55
  56     cursor = MediaEntry.query.\
  57         filter_by(uploader = user.id,
  58                   state = u'processed').order_by(MediaEntry.created.desc())
  59
  60     pagination = Pagination(page, cursor)
  61     media_entries = pagination()
  62
  63     #if no data is available, return NotFound
  64     if media_entries == None:
  65         return render_404(request)
  66
  67     user_gallery_url = request.urlgen(
  68         'mediagoblin.user_pages.user_gallery',
  69         user=user.username)
  70
  71     return render_to_response(
  72         request,
  73         'mediagoblin/user_pages/user.html',
  74         {'user': user,
  75          'user_gallery_url': user_gallery_url,
  76          'media_entries': media_entries,
  77          'pagination': pagination})
  78
  79
  80 @active_user_from_url
  81 @uses_pagination
  82 def user_gallery(request, page, url_user=None):
  83     """'Gallery' of a User()"""
  84     tag = request.matchdict.get('tag', None)
  85     cursor = MediaEntry.query.filter_by(
  86         uploader=url_user.id,
  87         state=u'processed').order_by(MediaEntry.created.desc())
  88
  89     # Filter potentially by tag too:
  90     if tag:
  91         cursor = cursor.filter(
  92             MediaEntry.tags_helper.any(
  93                 MediaTag.name == request.matchdict['tag']))
  94
  95     # Paginate gallery
  96     pagination = Pagination(page, cursor)
  97     media_entries = pagination()
  98
  99     #if no data is available, return NotFound
 100     # TODO: Should we really also return 404 for empty galleries?
 101     if media_entries == None:
 102         return render_404(request)
 103
 104     return render_to_response(
 105         request,
 106         'mediagoblin/user_pages/gallery.html',
 107         {'user': url_user, 'tag': tag,
 108          'media_entries': media_entries,
 109          'pagination': pagination})
 110
 111 MEDIA_COMMENTS_PER_PAGE = 50
 112
 113
 114 @get_user_media_entry
 115 @uses_pagination
 116 def media_home(request, media, page, **kwargs):
 117     """
 118     'Homepage' of a MediaEntry()
 119     """
 120     comment_id = request.matchdict.get('comment', None)
 121     if comment_id:
 122         pagination = Pagination(
 123             page, media.get_comments(
 124                 mg_globals.app_config['comments_ascending']),
 125             MEDIA_COMMENTS_PER_PAGE,
 126             comment_id)
 127     else:
 128         pagination = Pagination(
 129             page, media.get_comments(
 130                 mg_globals.app_config['comments_ascending']),
 131             MEDIA_COMMENTS_PER_PAGE)
 132
 133     comments = pagination()
 134
 135     comment_form = user_forms.MediaCommentForm(request.form)
 136
 137     media_template_name = media.media_manager['display_template']
 138
 139     return render_to_response(
 140         request,
 141         media_template_name,
 142         {'media': media,
 143          'comments': comments,
 144          'pagination': pagination,
 145          'comment_form': comment_form,
 146          'app_config': mg_globals.app_config})
 147
 148
 149 @get_media_entry_by_id
 150 @require_active_login
 151 def media_post_comment(request, media):
 152     """
 153     recieves POST from a MediaEntry() comment form, saves the comment.
 154     """
 155     assert request.method == 'POST'
 156
 157     comment = request.db.MediaComment()
 158     comment.media_entry = media.id
 159     comment.author = request.user.id
 160     comment.content = unicode(request.form['comment_content'])
 161
 162     if not comment.content.strip():
 163         messages.add_message(
 164             request,
 165             messages.ERROR,
 166             _("Oops, your comment was empty."))
 167     else:
 168         comment.save()
 169
 170         messages.add_message(
 171             request, messages.SUCCESS,
 172             _('Your comment has been posted!'))
 173
 174         media_uploader = media.get_uploader
 175         #don't send email if you comment on your own post
 176         if (comment.author != media_uploader and
 177             media_uploader.wants_comment_notification):
 178             send_comment_email(media_uploader, comment, media, request)
 179
 180     return redirect(request, location=media.url_for_self(request.urlgen))
 181
 182
 183 @get_user_media_entry
 184 @require_active_login
 185 def media_collect(request, media):
 186     """Add media to collection submission"""
 187
 188     form = user_forms.MediaCollectForm(request.form)
 189     # A user's own collections:
 190     form.collection.query = Collection.query.filter_by(
 191         creator = request.user.id).order_by(Collection.title)
 192
 193     if request.method != 'POST' or not form.validate():
 194         # No POST submission, or invalid form
 195         if not form.validate():
 196             messages.add_message(request, messages.ERROR,
 197                 _('Please check your entries and try again.'))
 198
 199         return render_to_response(
 200             request,
 201             'mediagoblin/user_pages/media_collect.html',
 202             {'media': media,
 203              'form': form})
 204
 205     # If we are here, method=POST and the form is valid, submit things.
 206     # If the user is adding a new collection, use that:
 207     if request.form['collection_title']:
 208         # Make sure this user isn't duplicating an existing collection
 209         existing_collection = Collection.query.filter_by(
 210                                 creator=request.user.id,
 211                                 title=request.form['collection_title']).first()
 212         if existing_collection:
 213             messages.add_message(request, messages.ERROR,
 214                 _('You already have a collection called "%s"!'
 215                   % existing_collection.title))
 216             return redirect(request, "mediagoblin.user_pages.media_home",
 217                             user=request.user.username,
 218                             media=media.id)
 219
 220         collection = Collection()
 221         collection.title = request.form['collection_title']
 222         collection.description = request.form.get('collection_description')
 223         collection.creator = request.user.id
 224         collection.generate_slug()
 225         collection.save()
 226
 227     # Otherwise, use the collection selected from the drop-down
 228     else:
 229         collection = Collection.query.filter_by(
 230             id=request.form.get('collection')).first()
 231
 232     # Make sure the user actually selected a collection
 233     if not collection:
 234         messages.add_message(
 235             request, messages.ERROR,
 236             _('You have to select or add a collection'))
 237         return redirect(request, "mediagoblin.user_pages.media_collect",
 238                     user=media.get_uploader.username,
 239                     media=media.id)
 240
 241
 242     # Check whether media already exists in collection
 243     elif CollectionItem.query.filter_by(
 244         media_entry=media.id,
 245         collection=collection.id).first():
 246         messages.add_message(request, messages.ERROR,
 247             _('"%s" already in collection "%s"'
 248                 % (media.title, collection.title)))
 249     else: # Add item to collection
 250         collection_item = request.db.CollectionItem()
 251         collection_item.collection = collection.id
 252         collection_item.media_entry = media.id
 253         collection_item.author = request.user.id
 254         collection_item.note = request.form['note']
 255         collection_item.save()
 256
 257         collection.items = collection.items + 1
 258         collection.save()
 259
 260         media.collected = media.collected + 1
 261         media.save()
 262
 263         messages.add_message(request, messages.SUCCESS,
 264                              _('"%s" added to collection "%s"'
 265                                % (media.title, collection.title)))
 266
 267     return redirect(request, "mediagoblin.user_pages.media_home",
 268                     user=media.get_uploader.username,
 269                     media=media.id)
 270
 271
 272 #TODO: Why does @user_may_delete_media not implicate @require_active_login?
 273 @get_media_entry_by_id
 274 @require_active_login
 275 @user_may_delete_media
 276 def media_confirm_delete(request, media):
 277
 278     form = user_forms.ConfirmDeleteForm(request.form)
 279
 280     if request.method == 'POST' and form.validate():
 281         if form.confirm.data is True:
 282             username = media.get_uploader.username
 283             # Delete MediaEntry and all related files, comments etc.
 284             media.delete()
 285             messages.add_message(
 286                 request, messages.SUCCESS, _('You deleted the media.'))
 287
 288             return redirect(request, "mediagoblin.user_pages.user_home",
 289                 user=username)
 290         else:
 291             messages.add_message(
 292                 request, messages.ERROR,
 293                 _("The media was not deleted because you didn't check that you were sure."))
 294             return redirect(request,
 295                             location=media.url_for_self(request.urlgen))
 296
 297     if ((request.user.is_admin and
 298          request.user.id != media.uploader)):
 299         messages.add_message(
 300             request, messages.WARNING,
 301             _("You are about to delete another user's media. "
 302               "Proceed with caution."))
 303
 304     return render_to_response(
 305         request,
 306         'mediagoblin/user_pages/media_confirm_delete.html',
 307         {'media': media,
 308          'form': form})
 309
 310
 311 @active_user_from_url
 312 @uses_pagination
 313 def user_collection(request, page, url_user=None):
 314     """A User-defined Collection"""
 315     collection = Collection.query.filter_by(
 316         get_creator=url_user,
 317         slug=request.matchdict['collection']).first()
 318
 319     if not collection:
 320         return render_404(request)
 321
 322     cursor = collection.get_collection_items()
 323
 324     pagination = Pagination(page, cursor)
 325     collection_items = pagination()
 326
 327     # if no data is available, return NotFound
 328     # TODO: Should an empty collection really also return 404?
 329     if collection_items == None:
 330         return render_404(request)
 331
 332     return render_to_response(
 333         request,
 334         'mediagoblin/user_pages/collection.html',
 335         {'user': url_user,
 336          'collection': collection,
 337          'collection_items': collection_items,
 338          'pagination': pagination})
 339
 340
 341 @active_user_from_url
 342 def collection_list(request, url_user=None):
 343     """A User-defined Collection"""
 344     collections = Collection.query.filter_by(
 345         get_creator=url_user)
 346
 347     return render_to_response(
 348         request,
 349         'mediagoblin/user_pages/collection_list.html',
 350         {'user': url_user,
 351          'collections': collections})
 352
 353
 354 @get_user_collection_item
 355 @require_active_login
 356 @user_may_alter_collection
 357 def collection_item_confirm_remove(request, collection_item):
 358
 359     form = user_forms.ConfirmCollectionItemRemoveForm(request.form)
 360
 361     if request.method == 'POST' and form.validate():
 362         username = collection_item.in_collection.get_creator.username
 363         collection = collection_item.in_collection
 364
 365         if form.confirm.data is True:
 366             entry = collection_item.get_media_entry
 367             entry.collected = entry.collected - 1
 368             entry.save()
 369
 370             collection_item.delete()
 371             collection.items = collection.items - 1
 372             collection.save()
 373
 374             messages.add_message(
 375                 request, messages.SUCCESS, _('You deleted the item from the collection.'))
 376         else:
 377             messages.add_message(
 378                 request, messages.ERROR,
 379                 _("The item was not removed because you didn't check that you were sure."))
 380
 381         return redirect(request, "mediagoblin.user_pages.user_collection",
 382                         user=username,
 383                         collection=collection.slug)
 384
 385     if ((request.user.is_admin and
 386          request.user.id != collection_item.in_collection.creator)):
 387         messages.add_message(
 388             request, messages.WARNING,
 389             _("You are about to delete an item from another user's collection. "
 390               "Proceed with caution."))
 391
 392     return render_to_response(
 393         request,
 394         'mediagoblin/user_pages/collection_item_confirm_remove.html',
 395         {'collection_item': collection_item,
 396          'form': form})
 397
 398
 399 @get_user_collection
 400 @require_active_login
 401 @user_may_alter_collection
 402 def collection_confirm_delete(request, collection):
 403
 404     form = user_forms.ConfirmDeleteForm(request.form)
 405
 406     if request.method == 'POST' and form.validate():
 407
 408         username = collection.get_creator.username
 409
 410         if form.confirm.data is True:
 411             collection_title = collection.title
 412
 413             # Delete all the associated collection items
 414             for item in collection.get_collection_items():
 415                 entry = item.get_media_entry
 416                 entry.collected = entry.collected - 1
 417                 entry.save()
 418                 item.delete()
 419
 420             collection.delete()
 421             messages.add_message(
 422                 request, messages.SUCCESS, _('You deleted the collection "%s"' % collection_title))
 423
 424             return redirect(request, "mediagoblin.user_pages.user_home",
 425                 user=username)
 426         else:
 427             messages.add_message(
 428                 request, messages.ERROR,
 429                 _("The collection was not deleted because you didn't check that you were sure."))
 430
 431             return redirect(request, "mediagoblin.user_pages.user_collection",
 432                             user=username,
 433                             collection=collection.slug)
 434
 435     if ((request.user.is_admin and
 436          request.user.id != collection.creator)):
 437         messages.add_message(
 438             request, messages.WARNING,
 439             _("You are about to delete another user's collection. "
 440               "Proceed with caution."))
 441
 442     return render_to_response(
 443         request,
 444         'mediagoblin/user_pages/collection_confirm_delete.html',
 445         {'collection': collection,
 446          'form': form})
 447
 448
 449 ATOM_DEFAULT_NR_OF_UPDATED_ITEMS = 15
 450
 451
 452 def atom_feed(request):
 453     """
 454     generates the atom feed with the newest images
 455     """
 456     user = User.query.filter_by(
 457         username = request.matchdict['user'],
 458         status = u'active').first()
 459     if not user:
 460         return render_404(request)
 461
 462     cursor = MediaEntry.query.filter_by(
 463         uploader = user.id,
 464         state = u'processed').\
 465         order_by(MediaEntry.created.desc()).\
 466         limit(ATOM_DEFAULT_NR_OF_UPDATED_ITEMS)
 467
 468     """
 469     ATOM feed id is a tag URI (see http://en.wikipedia.org/wiki/Tag_URI)
 470     """
 471     atomlinks = [{
 472            'href': request.urlgen(
 473                'mediagoblin.user_pages.user_home',
 474                qualified=True, user=request.matchdict['user']),
 475            'rel': 'alternate',
 476            'type': 'text/html'
 477            }]
 478
 479     if mg_globals.app_config["push_urls"]:
 480         for push_url in mg_globals.app_config["push_urls"]:
 481             atomlinks.append({
 482                 'rel': 'hub',
 483                 'href': push_url})
 484
 485     feed = AtomFeed(
 486                "MediaGoblin: Feed for user '%s'" % request.matchdict['user'],
 487                feed_url=request.url,
 488                id='tag:{host},{year}:gallery.user-{user}'.format(
 489                    host=request.host,
 490                    year=datetime.datetime.today().strftime('%Y'),
 491                    user=request.matchdict['user']),
 492                links=atomlinks)
 493
 494     for entry in cursor:
 495         feed.add(entry.get('title'),
 496             entry.description_html,
 497             id=entry.url_for_self(request.urlgen, qualified=True),
 498             content_type='html',
 499             author={
 500                 'name': entry.get_uploader.username,
 501                 'uri': request.urlgen(
 502                     'mediagoblin.user_pages.user_home',
 503                     qualified=True, user=entry.get_uploader.username)},
 504             updated=entry.get('created'),
 505             links=[{
 506                 'href': entry.url_for_self(
 507                     request.urlgen,
 508                     qualified=True),
 509                 'rel': 'alternate',
 510                 'type': 'text/html'}])
 511
 512     return feed.get_response()
 513
 514
 515 def collection_atom_feed(request):
 516     """
 517     generates the atom feed with the newest images from a collection
 518     """
 519     user = User.query.filter_by(
 520         username = request.matchdict['user'],
 521         status = u'active').first()
 522     if not user:
 523         return render_404(request)
 524
 525     collection = Collection.query.filter_by(
 526                creator=user.id,
 527                slug=request.matchdict['collection']).first()
 528     if not collection:
 529         return render_404(request)
 530
 531     cursor = CollectionItem.query.filter_by(
 532                  collection=collection.id) \
 533                  .order_by(CollectionItem.added.desc()) \
 534                  .limit(ATOM_DEFAULT_NR_OF_UPDATED_ITEMS)
 535
 536     """
 537     ATOM feed id is a tag URI (see http://en.wikipedia.org/wiki/Tag_URI)
 538     """
 539     atomlinks = [{
 540            'href': request.urlgen(
 541                'mediagoblin.user_pages.user_collection',
 542                qualified=True, user=request.matchdict['user'], collection=collection.slug),
 543            'rel': 'alternate',
 544            'type': 'text/html'
 545            }]
 546
 547     if mg_globals.app_config["push_urls"]:
 548         for push_url in mg_globals.app_config["push_urls"]:
 549             atomlinks.append({
 550                 'rel': 'hub',
 551                 'href': push_url})
 552
 553     feed = AtomFeed(
 554                 "MediaGoblin: Feed for %s's collection %s" %
 555                 (request.matchdict['user'], collection.title),
 556                 feed_url=request.url,
 557                 id=u'tag:{host},{year}:gnu-mediagoblin.{user}.collection.{slug}'\
 558                     .format(
 559                     host=request.host,
 560                     year=collection.created.strftime('%Y'),
 561                     user=request.matchdict['user'],
 562                     slug=collection.slug),
 563                 links=atomlinks)
 564
 565     for item in cursor:
 566         entry = item.get_media_entry
 567         feed.add(entry.get('title'),
 568             item.note_html,
 569             id=entry.url_for_self(request.urlgen, qualified=True),
 570             content_type='html',
 571             author={
 572                 'name': entry.get_uploader.username,
 573                 'uri': request.urlgen(
 574                     'mediagoblin.user_pages.user_home',
 575                     qualified=True, user=entry.get_uploader.username)},
 576             updated=item.get('added'),
 577             links=[{
 578                 'href': entry.url_for_self(
 579                     request.urlgen,
 580                     qualified=True),
 581                 'rel': 'alternate',
 582                 'type': 'text/html'}])
 583
 584     return feed.get_response()
 585
 586
 587 @require_active_login
 588 def processing_panel(request):
 589     """
 590     Show to the user what media is still in conversion/processing...
 591     and what failed, and why!
 592     """
 593     user = User.query.filter_by(username=request.matchdict['user']).first()
 594     # TODO: XXX: Should this be a decorator?
 595     #
 596     # Make sure we have permission to access this user's panel.  Only
 597     # admins and this user herself should be able to do so.
 598     if not (user.id == request.user.id or request.user.is_admin):
 599         # No?  Simply redirect to this user's homepage.
 600         return redirect(
 601             request, 'mediagoblin.user_pages.user_home',
 602             user=user.username)
 603
 604     # Get media entries which are in-processing
 605     processing_entries = MediaEntry.query.\
 606         filter_by(uploader = user.id,
 607                   state = u'processing').\
 608         order_by(MediaEntry.created.desc())
 609
 610     # Get media entries which have failed to process
 611     failed_entries = MediaEntry.query.\
 612         filter_by(uploader = user.id,
 613                   state = u'failed').\
 614         order_by(MediaEntry.created.desc())
 615
 616     processed_entries = MediaEntry.query.\
 617         filter_by(uploader = user.id,
 618                   state = u'processed').\
 619         order_by(MediaEntry.created.desc()).\
 620         limit(10)
 621
 622     # Render to response
 623     return render_to_response(
 624         request,
 625         'mediagoblin/user_pages/processing_panel.html',
 626         {'user': user,
 627          'processing_entries': processing_entries,
 628          'failed_entries': failed_entries,
 629          'processed_entries': processed_entries})