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