Home | History | Annotate | Download | only in system 
      1 # Copyright (c) 2010 Google Inc. All rights reserved.
      2 #
      3 # Redistribution and use in source and binary forms, with or without
      4 # modification, are permitted provided that the following conditions are
      5 # met:
      6 #
      7 #     * Redistributions of source code must retain the above copyright
      8 # notice, this list of conditions and the following disclaimer.
      9 #     * Redistributions in binary form must reproduce the above
     10 # copyright notice, this list of conditions and the following disclaimer
     11 # in the documentation and/or other materials provided with the
     12 # distribution.
     13 #     * Neither the name of Google Inc. nor the names of its
     14 # contributors may be used to endorse or promote products derived from
     15 # this software without specific prior written permission.
     16 #
     17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28 
     29 # A home for file logic which should sit above FileSystem, but
     30 # below more complicated objects.
     31 
     32 import zipfile
     33 
     34 class Workspace(object):
     35     def __init__(self, filesystem, executive):
     36         self._filesystem = filesystem
     37         self._executive = executive  # FIXME: Remove if create_zip is moved to python.
     38 
     39     def find_unused_filename(self, directory, name, extension, search_limit=100):
     40         for count in range(search_limit):
     41             if count:
     42                 target_name = "%s-%s.%s" % (name, count, extension)
     43             else:
     44                 target_name = "%s.%s" % (name, extension)
     45             target_path = self._filesystem.join(directory, target_name)
     46             if not self._filesystem.exists(target_path):
     47                 return target_path
     48         # If we can't find an unused name in search_limit tries, just give up.
     49         return None
     50 
     51     def create_zip(self, zip_path, source_path, zip_class=zipfile.ZipFile):
     52         # It's possible to create zips with Python:
     53         # zip_file = ZipFile(zip_path, 'w')
     54         # for root, dirs, files in os.walk(source_path):
     55         #     for path in files:
     56         #         absolute_path = os.path.join(root, path)
     57         #         zip_file.write(os.path.relpath(path, source_path))
     58         # However, getting the paths, encoding and compression correct could be non-trivial.
     59         # So, for now we depend on the environment having "zip" installed (likely fails on Win32)
     60         self._executive.run_command(['zip', '-r', zip_path, source_path])
     61         return zip_class(zip_path)
     62