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