First changes to media gallery view
[mediagoblin.git] / mediagoblin / util.py
index 8695180a0c0b73519807b1bcc79266b0c258861b..2865cf11504f39bec4271f88bca9fe0183fa3c00 100644 (file)
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from email.MIMEText import MIMEText
+import gettext
+import pkg_resources
 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 math import ceil
+import copy
 
 TESTS_ENABLED = False
 def _activate_testing():
@@ -33,22 +39,40 @@ def _activate_testing():
     TESTS_ENABLED = True
 
 
-def get_jinja_env(user_template_path=None):
+def get_jinja_loader(user_template_path=None):
     """
-    Set up the Jinja environment, possibly allowing for user
+    Set up the Jinja template loaders, possibly allowing for user
     overridden templates.
 
     (In the future we may have another system for providing theming;
     for now this is good enough.)
     """
     if user_template_path:
-        loader = jinja2.ChoiceLoader(
+        return jinja2.ChoiceLoader(
             [jinja2.FileSystemLoader(user_template_path),
              jinja2.PackageLoader('mediagoblin', 'templates')])
     else:
-        loader = jinja2.PackageLoader('mediagoblin', 'templates')
+        return jinja2.PackageLoader('mediagoblin', 'templates')
+
+
+def get_jinja_env(template_loader, locale):
+    """
+    Set up the Jinja environment, 
+
+    (In the future we may have another system for providing theming;
+    for now this is good enough.)
+    """
+    setup_gettext(locale)
+
+    template_env = jinja2.Environment(
+        loader=template_loader, autoescape=True,
+        extensions=['jinja2.ext.i18n'])
 
-    return jinja2.Environment(loader=loader, autoescape=True)
+    template_env.install_gettext_callables(
+        mgoblin_globals.translations.gettext,
+        mgoblin_globals.translations.ngettext)
+
+    return template_env
 
 
 def setup_user_in_request(request):
@@ -62,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
@@ -87,6 +111,18 @@ def import_component(import_string):
     func = getattr(module, func_name)
     return func
 
+_punct_re = re.compile(r'[\t !"#$%&\'()*\-/<=>?@\[\\\]^_`{|},.]+')
+
+def slugify(text, delim=u'-'):
+    """
+    Generates an ASCII-only slug. Taken from http://flask.pocoo.org/snippets/5/
+    """
+    result = []
+    for word in _punct_re.split(text.lower()):
+        word = word.encode('translit/long')
+        if word:
+            result.append(word)
+    return unicode(delim.join(result))
 
 ### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ### Special email test stuff begins HERE
@@ -170,7 +206,7 @@ def send_email(from_addr, to_addrs, subject, message_body):
     if TESTS_ENABLED:
         EMAIL_TEST_INBOX.append(message)
 
-    elif mgoblin_globals.email_debug_mode:
+    if getattr(mgoblin_globals, 'email_debug_mode', False):
         print u"===== Email ====="
         print u"From address: %s" % message['From']
         print u"To addresses: %s" % message['To']
@@ -178,5 +214,157 @@ def send_email(from_addr, to_addrs, subject, message_body):
         print u"-- Body: --"
         print message.get_payload(decode=True)
 
+    return mhost.sendmail(from_addr, to_addrs, message.as_string())
+
+
+###################
+# Translation tools
+###################
+
+
+TRANSLATIONS_PATH = pkg_resources.resource_filename(
+    'mediagoblin', 'translations')
+
+
+def locale_to_lower_upper(locale):
+    """
+    Take a locale, regardless of style, and format it like "en-us"
+    """
+    if '-' in locale:
+        lang, country = locale.split('-', 1)
+        return '%s_%s' % (lang.lower(), country.upper())
+    elif '_' in locale:
+        lang, country = locale.split('_', 1)
+        return '%s_%s' % (lang.lower(), country.upper())
     else:
-        return mhost.sendmail(from_addr, to_addrs, message.as_string())
+        return locale.lower()
+
+
+def locale_to_lower_lower(locale):
+    """
+    Take a locale, regardless of style, and format it like "en_US"
+    """
+    if '_' in locale:
+        lang, country = locale.split('_', 1)
+        return '%s-%s' % (lang.lower(), country.lower())
+    else:
+        return locale.lower()
+
+
+def get_locale_from_request(request):
+    """
+    Figure out what target language is most appropriate based on the
+    request
+    """
+    request_form = request.GET or request.POST
+
+    if request_form.has_key('lang'):
+        return locale_to_lower_upper(request_form['lang'])
+
+    accept_lang_matches = request.accept_language.best_matches()
+
+    # Your routing can explicitly specify a target language
+    if request.matchdict.has_key('locale'):
+        target_lang = request.matchdict['locale']
+    elif request.session.has_key('target_lang'):
+        target_lang = request.session['target_lang']
+    # Pull the first acceptable language
+    elif accept_lang_matches:
+        target_lang = accept_lang_matches[0]
+    # Fall back to English
+    else:
+        target_lang = 'en'
+
+    return locale_to_lower_upper(target_lang)
+
+
+def setup_gettext(locale):
+    """
+    Setup the gettext instance based on this locale
+    """
+    # Later on when we have plugins we may want to enable the
+    # multi-translations system they have so we can handle plugin
+    # translations too
+
+    # TODO: fallback nicely on translations from pt_PT to pt if not
+    # available, etc.
+    this_gettext = gettext.translation(
+        'mediagoblin', TRANSLATIONS_PATH, [locale], fallback=True)
+
+    mgoblin_globals.setup_globals(
+        translations=this_gettext)
+
+
+PAGINATION_DEFAULT_PER_PAGE = 30
+
+class Pagination(object):
+    """
+    Pagination class for mongodb queries.
+
+    Initialization through __init__(self, cursor, page=1, per_page=2),
+    get actual data slice through __call__().
+    """
+
+    def __init__(self, page, cursor, per_page=PAGINATION_DEFAULT_PER_PAGE):
+        """
+        Initializes Pagination
+
+        Args:
+         - page: requested page
+         - per_page: number of objects per page
+         - cursor: db cursor 
+        """
+        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):
+        return int(ceil(self.total_count / float(self.per_page)))
+
+    @property
+    def has_prev(self):
+        return self.page > 1
+
+    @property
+    def has_next(self):
+        return self.page < self.pages
+
+    def iter_pages(self, left_edge=2, left_current=2,
+                   right_current=5, right_edge=2):
+        last = 0
+        for num in xrange(1, self.pages + 1):
+            if num <= left_edge or \
+               (num > self.page - left_current - 1 and \
+                num < self.page + right_current) or \
+               num > self.pages - right_edge:
+                if last + 1 != num:
+                    yield None
+                yield num
+                last = num
+
+    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)