docs: Document video resolution config.
[mediagoblin.git] / mediagoblin / user_pages / lib.py
index 2558b06692b5c1d5ec9e4b2f2c21d161cc18c6bb..b6741001bd9847f57b2ad5356d4b6dfc4b82369c 100644 (file)
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from mediagoblin import mg_globals
+from mediagoblin.db.base import Session
+from mediagoblin.db.models import CollectionItem, Report, TextComment, \
+                                  MediaEntry
 from mediagoblin.tools.mail import send_email
+from mediagoblin.tools.pluginapi import hook_runall
 from mediagoblin.tools.template import render_template
 from mediagoblin.tools.translate import pass_to_ugettext as _
-from mediagoblin import mg_globals
-from mediagoblin.db.base import Session
-from mediagoblin.db.models import (CollectionItem, MediaReport, CommentReport, 
-                                  MediaComment, MediaEntry)
-from mediagoblin.user_pages import forms as user_forms
 
 
 def send_comment_email(user, comment, media, request):
@@ -38,11 +38,11 @@ def send_comment_email(user, comment, media, request):
     comment_url = request.urlgen(
                     'mediagoblin.user_pages.media_home.view_comment',
                     comment=comment.id,
-                    user=media.get_uploader.username,
+                    user=media.get_actor.username,
                     media=media.slug_or_id,
                     qualified=True) + '#comment'
 
-    comment_author = comment.get_author.username
+    comment_author = comment.get_actor.username
 
     rendered_email = render_template(
         request, 'mediagoblin/user_pages/comment_email.txt',
@@ -64,53 +64,50 @@ def send_comment_email(user, comment, media, request):
 def add_media_to_collection(collection, media, note=None, commit=True):
     collection_item = CollectionItem()
     collection_item.collection = collection.id
-    collection_item.media_entry = media.id
+    collection_item.get_object = media
     if note:
         collection_item.note = note
     Session.add(collection_item)
 
-    collection.items = collection.items + 1
+    collection.num_items = collection.num_items + 1
     Session.add(collection)
-
-    media.collected = media.collected + 1
     Session.add(media)
 
+    hook_runall('collection_add_media', collection_item=collection_item)
+
     if commit:
         Session.commit()
 
-def build_report_form(form_dict):
-    """
-    This function is used to convert a form dictionary (from a User filing a 
-        report) into either a MediaReport or CommentReport object.
 
-    :param form_dict should be an ImmutableMultiDict object as is returned from
-        'request.form.' The Object should have valid keys matching the fields 
-        in either MediaReportForm or CommentReportForm
-
-    :returns either of MediaReport or a CommentReport object that has not been 
-        saved. In case of an improper form_dict, returns None
+def build_report_object(report_form, media_entry=None, comment=None):
     """
-    if 'comment_id' in form_dict.keys():
-        report_form = user_forms.CommentReportForm(form_dict)
-    elif 'media_entry_id' in form_dict.keys():
-        report_form = user_forms.MediaReportForm(form_dict)
-    else:
-        return None
-
-    if report_form.validate() and 'comment_id' in form_dict.keys():
-        report_model = CommentReport()
-        report_model.comment_id = report_form.comment_id.data
-        report_model.reported_user_id = MediaComment.query.get(
-            report_model.comment_id).get_author.id
-    elif report_form.validate() and 'media_entry_id' in form_dict.keys():
-        report_model = MediaReport()
-        report_model.media_entry_id = report_form.media_entry_id.data
-        report_model.reported_user_id = MediaEntry.query.get(
-            report_model.media_entry_id).get_uploader.id
+    This function is used to convert a form object (from a User filing a
+        report) into a Report.
+
+    :param report_form          A MediaReportForm or a CommentReportForm object
+                                  with valid information from a POST request.
+    :param media_entry          A MediaEntry object. The MediaEntry being repo-
+                                  -rted by a Report.
+    :param comment              A Comment object. The Comment being
+                                  reported by a Report.
+
+    :returns                A Report object if a valid MediaReportForm is
+                              passed as kwarg media_entry. This Report has
+                              not been saved.
+    :returns                None if the form_dict is invalid.
+    """
+    report_object = Report()
+    if report_form.validate() and comment is not None:
+        report_object.obj = comment.comment()
+        report_object.reported_user_id = TextComment.query.get(
+            comment.id).get_actor.id
+    elif report_form.validate() and media_entry is not None:
+        report_object.obj = media_entry
+        report_object.reported_user_id = MediaEntry.query.get(
+            media_entry.id).get_actor.id
     else:
         return None
 
-    report_model.report_content = report_form.report_reason.data or u''
-    report_model.reporter_id = report_form.reporter_id.data
-    return report_model
-
+    report_object.report_content = report_form.report_reason.data
+    report_object.reporter_id = report_form.reporter_id.data
+    return report_object