mediagoblin/storage.py

   1 # GNU Mediagoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011 Free Software Foundation, Inc
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 from werkzeug.utils import secure_filename
  19
  20
  21 class Error(Exception): pass
  22 class InvalidFilepath(Error): pass
  23
  24
  25 def clean_listy_filepath(listy_filepath):
  26     """
  27     Take a listy filepath (like ['dir1', 'dir2', 'filename.jpg']) and
  28     clean out any nastiness from it.
  29
  30     For example:
  31     >>> clean_listy_filepath([u'/dir1/', u'foo/../nasty', u'linooks.jpg'])
  32     [u'dir1', u'foo_.._nasty', u'linooks.jpg']
  33
  34     Args:
  35     - listy_filepath: a list of filepath components, mediagoblin
  36       storage API style.
  37
  38     Returns:
  39       A cleaned list of unicode objects.
  40     """
  41     cleaned_filepath = [
  42         unicode(secure_filename(filepath))
  43         for filepath in listy_filepath]
  44
  45     if u'' in cleaned_filepath:
  46         raise InvalidFilepath(
  47             "A filename component could not be resolved into a usable name.")
  48
  49     return cleaned_filepath
  50
  51