First changes to media gallery view
[mediagoblin.git] / mediagoblin / util.py
index 0f28dd793d49d386a543b78495808bc8e2824ec0..2865cf11504f39bec4271f88bca9fe0183fa3c00 100644 (file)
@@ -21,15 +21,14 @@ import smtplib
 import sys
 import re
 import jinja2
-import mongokit
+from mediagoblin.db.util import ObjectId
 import translitcodec
 
 from mediagoblin import globals as mgoblin_globals
 
 import urllib
-from pymongo import ASCENDING, DESCENDING
 from math import ceil
-
+import copy
 
 TESTS_ENABLED = False
 def _activate_testing():
@@ -87,7 +86,7 @@ def setup_user_in_request(request):
 
     user = None
     user = request.app.db.User.one(
-        {'_id': mongokit.ObjectId(request.session['user_id'])})
+        {'_id': ObjectId(request.session['user_id'])})
 
     if not user:
         # Something's wrong... this user doesn't exist?  Invalidate
@@ -296,57 +295,36 @@ def setup_gettext(locale):
         translations=this_gettext)
 
 
+PAGINATION_DEFAULT_PER_PAGE = 30
+
 class Pagination(object):
     """
-    Pagination class
+    Pagination class for mongodb queries.
+
+    Initialization through __init__(self, cursor, page=1, per_page=2),
+    get actual data slice through __call__().
     """
-    def __init__(self):
-        pass
 
-    def __call__(self, args):
+    def __init__(self, page, cursor, per_page=PAGINATION_DEFAULT_PER_PAGE):
         """
-        input values:
-        {'page': ...,       ---    requested page
-         'per_page': ...,   ---    objects per page
-          'request': ...,   ---    webob request object for url generation
-          'collection' ...  ---    db collection, thats to be queried
-          'query': {'user': xxx},  query restrictions, db.collection.find(query)
-          }
-
-        add:
-           option for sorting attribute
-           ascending, descending option
-           range based pagination
+        Initializes Pagination
+
+        Args:
+         - page: requested page
+         - per_page: number of objects per page
+         - cursor: db cursor 
         """
-        self.per_page = args['per_page']
-        self.request = args['request']
-
-        try:
-            self.page = abs(int(args['request'].str_GET['page']))
-        # set default page, if page value is not set    
-        except KeyError:
-            self.page = 1
-        # return None(404 Error) if page is set, but has no value or has an invalid value    
-        except ValueError:
-            return None
-
-        ######################################################
-        #
-        # db queries should be changed into range based pagination
-        # save count and current page in some user session data
-        #
-        ######################################################
-
-        collection =  getattr(self.request.db, args['collection'])
-
-        self.total_count = collection.find(args['query']).count()
-
-        #check if requested page is valid, not larger than available number of pages
-        if self.page > self.pages:
-             return None
-        
-        return collection.find(args['query']).sort('created',DESCENDING) \
-            .skip((self.page-1)*self.per_page).limit(self.per_page)
+        self.page = page    
+        self.per_page = per_page
+        self.cursor = cursor
+        self.total_count = self.cursor.count()
+
+    def __call__(self):
+        """
+        Returns slice of objects for the requested page
+        """
+        return self.cursor.skip(
+            (self.page - 1) * self.per_page).limit(self.per_page)
 
     @property
     def pages(self):
@@ -372,7 +350,21 @@ class Pagination(object):
                     yield None
                 yield num
                 last = num
-     
-    def url_generator(self, page):
-        return '%s?%s' % (self.request.path_info, \
-                          urllib.urlencode({'page':str(page)}))
+
+    def get_page_url_explicit(self, base_url, get_params, page_no):
+        """ 
+        Get a page url by adding a page= parameter to the base url
+        """ 
+        new_get_params = copy.copy(get_params or {})
+        new_get_params['page'] = page_no
+        return "%s?%s" % (
+            base_url, urllib.urlencode(new_get_params))
+
+    def get_page_url(self, request, page_no):
+        """ 
+        Get a new page url based of the request, and the new page number.
+
+        This is a nice wrapper around get_page_url_explicit()
+        """ 
+        return self.get_page_url_explicit(
+            request.path_info, request.GET, page_no)