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