apps/filebrowser/functions.py

   1 # coding: utf-8
   2
   3 from django.utils.translation import ugettext as _
   4 from django.utils.safestring import mark_safe
   5 from time import gmtime, strftime, localtime, mktime, time
   6 from django.core.files import File
   7 from django.core.files.storage import default_storage
   8 import os, re, decimal
   9 from urlparse import urlparse
  10
  11 # filebrowser imports
  12 from filebrowser.fb_settings import *
  13
  14 # PIL import
  15 if STRICT_PIL:
  16     from PIL import Image
  17 else:
  18     try:
  19         from PIL import Image
  20     except ImportError:
  21         import Image
  22
  23
  24 def _url_to_path(value):
  25     """
  26     Change URL to PATH.
  27     Value has to be an URL relative to MEDIA URL or a full URL (including MEDIA_URL).
  28
  29     Returns a PATH relative to MEDIA_ROOT.
  30     """
  31     mediaurl_re = re.compile(r'^(%s)' % (MEDIA_URL))
  32     value = mediaurl_re.sub('', value)
  33     return value
  34
  35
  36 def _path_to_url(value):
  37     """
  38     Change PATH to URL.
  39     Value has to be a PATH relative to MEDIA_ROOT.
  40
  41     Return an URL relative to MEDIA_ROOT.
  42     """
  43     mediaroot_re = re.compile(r'^(%s)' % (MEDIA_ROOT))
  44     value = mediaroot_re.sub('', value)
  45     return _url_join(MEDIA_URL, value)
  46
  47
  48 def _dir_from_url(value):
  49     """
  50     Get the relative server directory from a URL.
  51     URL has to be an absolute URL including MEDIA_URL or
  52     an URL relative to MEDIA_URL.
  53     """
  54
  55     mediaurl_re = re.compile(r'^(%s)' % (MEDIA_URL))
  56     value = mediaurl_re.sub('', value)
  57     directory_re = re.compile(r'^(%s)' % (DIRECTORY))
  58     value = directory_re.sub('', value)
  59     return os.path.split(value)[0]
  60
  61
  62 def _get_version_path(value, version_prefix):
  63     """
  64     Construct the PATH to an Image version.
  65     Value has to be server-path, relative to MEDIA_ROOT.
  66
  67     version_filename = filename + version_prefix + ext
  68     Returns a path relative to MEDIA_ROOT.
  69     """
  70     if os.path.isfile(os.path.join(MEDIA_ROOT, value)):
  71         path, filename = os.path.split(value)
  72         filename, ext = os.path.splitext(filename)
  73         version_filename = filename + "_" + version_prefix + ext
  74         return os.path.join(VERSIONS_BASEDIR, path, version_filename)
  75     else:
  76         return None
  77
  78
  79 def _sort_by_attr(seq, attr):
  80     """
  81     Sort the sequence of objects by object's attribute
  82
  83     Arguments:
  84     seq  - the list or any sequence (including immutable one) of objects to sort.
  85     attr - the name of attribute to sort by
  86
  87     Returns:
  88     the sorted list of objects.
  89     """
  90     import operator
  91
  92     # Use the "Schwartzian transform"
  93     # Create the auxiliary list of tuples where every i-th tuple has form
  94     # (seq[i].attr, i, seq[i]) and sort it. The second item of tuple is needed not
  95     # only to provide stable sorting, but mainly to eliminate comparison of objects
  96     # (which can be expensive or prohibited) in case of equal attribute values.
  97     intermed = map(None, map(getattr, seq, (attr,)*len(seq)), xrange(len(seq)), seq)
  98     intermed.sort()
  99     return map(operator.getitem, intermed, (-1,) * len(intermed))
 100
 101
 102 def _url_join(*args):
 103     if args[0].startswith("http://"):
 104         url = "http://"
 105     else:
 106         url = "/"
 107     for arg in args:
 108         arg = str(arg).replace("\\", "/")
 109         arg_split = arg.split("/")
 110         for elem in arg_split:
 111             if elem != "" and elem != "http:":
 112                 url = url + elem + "/"
 113     # remove trailing slash for filenames
 114     if os.path.splitext(args[-1])[1]:
 115         url = url.rstrip("/")
 116     return url
 117
 118
 119 def _get_path(path):
 120     """
 121     Get Path.
 122     """
 123
 124     if os.path.isabs(path) or not os.path.isdir(os.path.join(MEDIA_ROOT, DIRECTORY, path)):
 125         return None
 126     return path
 127
 128
 129 def _get_file(path, filename):
 130     """
 131     Get File.
 132     """
 133
 134     if not os.path.isfile(os.path.join(MEDIA_ROOT, DIRECTORY, path, filename)) and not os.path.isdir(os.path.join(MEDIA_ROOT, DIRECTORY, path, filename)):
 135         return None
 136     return filename
 137
 138
 139 def _get_breadcrumbs(query, path, title):
 140     """
 141     Get breadcrumbs.
 142     """
 143
 144     breadcrumbs = []
 145     dir_query = ""
 146     if path:
 147         for item in path.split(os.sep):
 148             dir_query = os.path.join(dir_query,item)
 149             breadcrumbs.append([item,dir_query])
 150     if title:
 151         breadcrumbs.append([title,''])
 152     return breadcrumbs
 153
 154
 155 def _get_filterdate(filterDate, dateTime):
 156     """
 157     Get filterdate.
 158     """
 159
 160     returnvalue = ''
 161     dateYear = strftime("%Y", gmtime(dateTime))
 162     dateMonth = strftime("%m", gmtime(dateTime))
 163     dateDay = strftime("%d", gmtime(dateTime))
 164     if filterDate == 'today' and int(dateYear) == int(localtime()[0]) and int(dateMonth) == int(localtime()[1]) and int(dateDay) == int(localtime()[2]): returnvalue = 'true'
 165     elif filterDate == 'thismonth' and dateTime >= time()-2592000: returnvalue = 'true'
 166     elif filterDate == 'thisyear' and int(dateYear) == int(localtime()[0]): returnvalue = 'true'
 167     elif filterDate == 'past7days' and dateTime >= time()-604800: returnvalue = 'true'
 168     elif filterDate == '': returnvalue = 'true'
 169     return returnvalue
 170
 171
 172 def _get_settings_var():
 173     """
 174     Get settings variables used for FileBrowser listing.
 175     """
 176
 177     settings_var = {}
 178     # Main
 179     settings_var['DEBUG'] = DEBUG
 180     settings_var['MEDIA_ROOT'] = MEDIA_ROOT
 181     settings_var['MEDIA_URL'] = MEDIA_URL
 182     settings_var['DIRECTORY'] = DIRECTORY
 183     # FileBrowser
 184     settings_var['URL_FILEBROWSER_MEDIA'] = URL_FILEBROWSER_MEDIA
 185     settings_var['PATH_FILEBROWSER_MEDIA'] = PATH_FILEBROWSER_MEDIA
 186     # TinyMCE
 187     settings_var['URL_TINYMCE'] = URL_TINYMCE
 188     settings_var['PATH_TINYMCE'] = PATH_TINYMCE
 189     # Extensions/Formats (for FileBrowseField)
 190     settings_var['EXTENSIONS'] = EXTENSIONS
 191     settings_var['SELECT_FORMATS'] = SELECT_FORMATS
 192     # Versions
 193     settings_var['VERSIONS_BASEDIR'] = VERSIONS_BASEDIR
 194     settings_var['VERSIONS'] = VERSIONS
 195     settings_var['ADMIN_VERSIONS'] = ADMIN_VERSIONS
 196     settings_var['ADMIN_THUMBNAIL'] = ADMIN_THUMBNAIL
 197     # FileBrowser Options
 198     settings_var['MAX_UPLOAD_SIZE'] = MAX_UPLOAD_SIZE
 199     # Convert Filenames
 200     settings_var['CONVERT_FILENAME'] = CONVERT_FILENAME
 201     return settings_var
 202
 203
 204 def _handle_file_upload(path, file):
 205     """
 206     Handle File Upload.
 207     """
 208
 209     file_path = os.path.join(path, file.name)
 210     uploadedfile = default_storage.save(file_path, file)
 211     return uploadedfile
 212
 213
 214 def _get_file_type(filename):
 215     """
 216     Get file type as defined in EXTENSIONS.
 217     """
 218
 219     file_extension = os.path.splitext(filename)[1].lower()
 220     file_type = ''
 221     for k,v in EXTENSIONS.iteritems():
 222         for extension in v:
 223             if file_extension == extension.lower():
 224                 file_type = k
 225     return file_type
 226
 227
 228 def _is_selectable(filename, selecttype):
 229     """
 230     Get select type as defined in FORMATS.
 231     """
 232
 233     file_extension = os.path.splitext(filename)[1].lower()
 234     select_types = []
 235     for k,v in SELECT_FORMATS.iteritems():
 236         for extension in v:
 237             if file_extension == extension.lower():
 238                 select_types.append(k)
 239     return select_types
 240
 241
 242 def _version_generator(value, version_prefix, force=None):
 243     """
 244     Generate Version for an Image.
 245     value has to be a serverpath relative to MEDIA_ROOT.
 246     """
 247
 248     # PIL's Error "Suspension not allowed here" work around:
 249     # s. http://mail.python.org/pipermail/image-sig/1999-August/000816.html
 250     if STRICT_PIL:
 251         from PIL import ImageFile
 252     else:
 253         try:
 254             from PIL import ImageFile
 255         except ImportError:
 256             import ImageFile
 257     ImageFile.MAXBLOCK = IMAGE_MAXBLOCK # default is 64k
 258
 259     try:
 260         im = Image.open(os.path.join(MEDIA_ROOT, value))
 261         version_path = _get_version_path(value, version_prefix)
 262         absolute_version_path = os.path.join(MEDIA_ROOT, version_path)
 263         version_dir = os.path.split(absolute_version_path)[0]
 264         if not os.path.isdir(version_dir):
 265             os.makedirs(version_dir)
 266             os.chmod(version_dir, 0775)
 267         version = scale_and_crop(im, VERSIONS[version_prefix]['width'], VERSIONS[version_prefix]['height'], VERSIONS[version_prefix]['opts'])
 268         try:
 269             version.save(absolute_version_path, quality=90, optimize=1)
 270         except IOError:
 271             version.save(absolute_version_path, quality=90)
 272         return version_path
 273     except:
 274         return None
 275
 276
 277 def scale_and_crop(im, width, height, opts):
 278     x, y   = [float(v) for v in im.size]
 279     if width:
 280         xr = float(width)
 281     else:
 282         xr = float(x*height/y)
 283     if height:
 284         yr = float(height)
 285     else:
 286         yr = float(y*width/x)
 287
 288     if 'crop' in opts:
 289         r = max(xr/x, yr/y)
 290     else:
 291         r = min(xr/x, yr/y)
 292
 293     if r < 1.0 or (r > 1.0 and 'upscale' in opts):
 294         im = im.resize((int(x*r), int(y*r)), resample=Image.ANTIALIAS)
 295
 296     if 'crop' in opts:
 297         x, y   = [float(v) for v in im.size]
 298         ex, ey = (x-min(x, xr))/2, (y-min(y, yr))/2
 299         if ex or ey:
 300             im = im.crop((int(ex), int(ey), int(x-ex), int(y-ey)))
 301     return im
 302 scale_and_crop.valid_options = ('crop', 'upscale')
 303
 304
 305 def _convert_filename(value):
 306     if CONVERT_FILENAME:
 307         return value.replace(" ", "_").lower()
 308     else:
 309         return value
 310
 311
 312