MapProxy 3.0.1__tar.gz → 3.1.0__tar.gz

{MapProxy-3.0.1 → MapProxy-3.1.0}/CHANGES.txt

@@ -1,3 +1,20 @@
+3.1.0 2024-10-22
+~~~~~~~~~~~~~~~~
+
+Improvements:
+
+  - Add new config parameters `file_permissions` and `directory_permissions` to set file and directory
+    permissions on newly created cache files and directories.
+
+Maintenance:
+
+  - Dependency updates
+
+Fixes:
+
+  - Fix transparency in TMS demo page.
+
+
 3.0.1 2024-08-27
 ~~~~~~~~~~~~~~~~
 

{MapProxy-3.0.1 → MapProxy-3.1.0}/MapProxy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MapProxy
-Version: 3.0.1
+Version: 3.1.0
 Summary: An accelerating proxy for tile and web map services
 Home-page: https://mapproxy.org
 Author: Oliver Tonnhofer
@@ -34,6 +34,23 @@ The documentation is available at: http://mapproxy.github.io/mapproxy/latest/
 
 Changes
 -------
+3.1.0 2024-10-22
+~~~~~~~~~~~~~~~~
+
+Improvements:
+
+  - Add new config parameters `file_permissions` and `directory_permissions` to set file and directory
+    permissions on newly created cache files and directories.
+
+Maintenance:
+
+  - Dependency updates
+
+Fixes:
+
+  - Fix transparency in TMS demo page.
+
+
 3.0.1 2024-08-27
 ~~~~~~~~~~~~~~~~
 
@@ -132,20 +149,6 @@ Fixes:
 
 - Revert PR "Fix mixed image format for file, S3 and azureblob caches"
 
-2.0.1 2024-01-05
-~~~~~~~~~~~~~~~~~
-Improvements:
-
-- Alpine based docker images have been added
-- Added parameter to change background map source in layer preview
-- Dependency updates
-
-Fixes:
-
-- Rendering issue: Check for existing tile coordinates before using them
-- Fix mixed image format for file, S3 and azureblob caches
-
-
 
 Older changes
 -------------

{MapProxy-3.0.1 → MapProxy-3.1.0}/MapProxy.egg-info/SOURCES.txt

@@ -436,6 +436,7 @@ mapproxy/test/unit/test_cache_azureblob.py
 mapproxy/test/unit/test_cache_compact.py
 mapproxy/test/unit/test_cache_couchdb.py
 mapproxy/test/unit/test_cache_geopackage.py
+mapproxy/test/unit/test_cache_mbtile.py
 mapproxy/test/unit/test_cache_redis.py
 mapproxy/test/unit/test_cache_riak.py
 mapproxy/test/unit/test_cache_s3.py
@@ -452,6 +453,7 @@ mapproxy/test/unit/test_decorate_img.py
 mapproxy/test/unit/test_exceptions.py
 mapproxy/test/unit/test_featureinfo.py
 mapproxy/test/unit/test_file_lock_load.py
+mapproxy/test/unit/test_fs.py
 mapproxy/test/unit/test_geom.py
 mapproxy/test/unit/test_grid.py
 mapproxy/test/unit/test_image.py

{MapProxy-3.0.1 → MapProxy-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MapProxy
-Version: 3.0.1
+Version: 3.1.0
 Summary: An accelerating proxy for tile and web map services
 Home-page: https://mapproxy.org
 Author: Oliver Tonnhofer
@@ -34,6 +34,23 @@ The documentation is available at: http://mapproxy.github.io/mapproxy/latest/
 
 Changes
 -------
+3.1.0 2024-10-22
+~~~~~~~~~~~~~~~~
+
+Improvements:
+
+  - Add new config parameters `file_permissions` and `directory_permissions` to set file and directory
+    permissions on newly created cache files and directories.
+
+Maintenance:
+
+  - Dependency updates
+
+Fixes:
+
+  - Fix transparency in TMS demo page.
+
+
 3.0.1 2024-08-27
 ~~~~~~~~~~~~~~~~
 
@@ -132,20 +149,6 @@ Fixes:
 
 - Revert PR "Fix mixed image format for file, S3 and azureblob caches"
 
-2.0.1 2024-01-05
-~~~~~~~~~~~~~~~~~
-Improvements:
-
-- Alpine based docker images have been added
-- Added parameter to change background map source in layer preview
-- Dependency updates
-
-Fixes:
-
-- Rendering issue: Check for existing tile coordinates before using them
-- Fix mixed image format for file, S3 and azureblob caches
-
-
 
 Older changes
 -------------

{MapProxy-3.0.1 → MapProxy-3.1.0}/doc/caches.rst

@@ -89,6 +89,11 @@ This is the default cache type and it uses a single file for each tile. Availabl
 
   .. versionadded:: 2.0.0
 
+``directory_permissions``, ``file_permissions``:
+  Permissions that MapProxy will set when creating files and directories. Must be given as string containing the octal representation of permissions. I.e. ``rwxrw-r--`` is ``'764'``. This will not work on windows OS.
+
+  .. versionadded:: 3.1.0
+
 .. _cache_mbtiles:
 
 ``mbtiles``
@@ -126,6 +131,11 @@ You can set the ``sources`` to an empty list, if you use an existing MBTiles fil
 
 The note about ``bulk_meta_tiles`` for SQLite below applies to MBtiles as well.
 
+``directory_permissions``, ``file_permissions``:
+  Permissions that MapProxy will set when creating files and directories. Must be given as string containing the octal representation of permissions. I.e. ``rwxrw-r--`` is ``'764'``. This will not work on windows OS.
+
+  .. versionadded:: 3.1.0
+
 .. _cache_sqlite:
 
 ``sqlite``
@@ -176,6 +186,11 @@ Available options:
           type: sqlite
           directory: /path/to/cache
 
+``directory_permissions``, ``file_permissions``:
+  Permissions that MapProxy will set when creating files and directories. Must be given as string containing the octal representation of permissions. I.e. ``rwxrw-r--`` is ``'764'``. This will not work on windows OS.
+
+  .. versionadded:: 3.1.0
+
 .. _cache_couchdb:
 
 ``couchdb``
@@ -273,7 +288,7 @@ MapProxy will place the JSON document for tile z=3, x=1, y=2 at ``http://localho
 
 
 .. code-block:: json
-  
+
 
   {
       "_attachments": {
@@ -651,6 +666,11 @@ Available options:
 ``version``:
   The version of the ArcGIS compact cache format. This option is required. Either ``1`` or ``2``.
 
+``directory_permissions``, ``file_permissions``:
+  Permissions that MapProxy will set when creating files and directories. Must be given as string containing the octal representation of permissions. I.e. ``rwxrw-r--`` is ``'764'``. This will not work on windows OS.
+
+  .. versionadded:: 3.1.0
+
 
 You can set the ``sources`` to an empty list, if you use an existing compact cache files and do not have a source.
 

{MapProxy-3.0.1 → MapProxy-3.1.0}/doc/configuration.rst

@@ -1055,6 +1055,11 @@ The following options define how tiles are created and stored. Most options can
 ``max_tile_limit``
   Maximum number of tiles MapProxy will merge together for a WMS request. This limit is for each layer and defaults to 500 tiles.
 
+``directory_permissions``, ``file_permissions``:
+  Permissions that MapProxy will set when creating files and directories. Must be given as string containing the octal representation of permissions. I.e. ``rwxrw-r--`` is ``'764'``. This will not work on windows OS.
+
+  .. versionadded:: 3.1.0
+
 
 ``srs``
 """""""

{MapProxy-3.0.1 → MapProxy-3.1.0}/mapproxy/cache/base.py

@@ -98,10 +98,11 @@ if sys.platform == 'win32':
 
 
 class TileLocker(object):
-    def __init__(self, lock_dir, lock_timeout, lock_cache_id):
+    def __init__(self, lock_dir, lock_timeout, lock_cache_id, directory_permissions=None):
         self.lock_dir = lock_dir
         self.lock_timeout = lock_timeout
         self.lock_cache_id = lock_cache_id
+        self.directory_permissions = directory_permissions
 
     def lock_filename(self, tile):
         return os.path.join(self.lock_dir, self.lock_cache_id + '-' +
@@ -117,4 +118,4 @@ class TileLocker(object):
         cleanup_lockdir(self.lock_dir, max_lock_time=self.lock_timeout + 10,
                         force=False)
         return FileLock(lock_filename, timeout=self.lock_timeout,
-                        remove_on_unlock=REMOVE_ON_UNLOCK)
+                        remove_on_unlock=REMOVE_ON_UNLOCK, directory_permissions=self.directory_permissions)

{MapProxy-3.0.1 → MapProxy-3.1.0}/mapproxy/cache/compact.py

@@ -34,11 +34,14 @@ class CompactCacheBase(TileCacheBase):
     supports_timestamp = False
     bundle_class = None
 
-    def __init__(self, cache_dir, coverage=None):
+    def __init__(self, cache_dir, coverage=None,
+                 directory_permissions=None, file_permissions=None):
         super(CompactCacheBase, self).__init__(coverage)
         md5 = hashlib.new('md5', cache_dir.encode('utf-8'), usedforsecurity=False)
         self.lock_cache_id = 'compactcache-' + md5.hexdigest()
         self.cache_dir = cache_dir
+        self.directory_permissions = directory_permissions
+        self.file_permissions = file_permissions
 
     def _get_bundle_fname_and_offset(self, tile_coord):
         x, y, z = tile_coord
@@ -53,7 +56,8 @@ class CompactCacheBase(TileCacheBase):
 
     def _get_bundle(self, tile_coord):
         bundle_fname, offset = self._get_bundle_fname_and_offset(tile_coord)
-        return self.bundle_class(bundle_fname, offset=offset)
+        return self.bundle_class(bundle_fname, offset=offset, file_permissions=self.file_permissions,
+                                 directory_permissions=self.directory_permissions)
 
     def is_cached(self, tile, dimensions=None):
         if tile.coord is None:
@@ -138,10 +142,12 @@ BUNDLEX_V1_EXT = '.bundlx'
 
 
 class BundleV1(object):
-    def __init__(self, base_filename, offset):
+    def __init__(self, base_filename, offset, file_permissions=None, directory_permissions=None):
         self.base_filename = base_filename
         self.lock_filename = base_filename + '.lck'
         self.offset = offset
+        self.file_permissions = file_permissions
+        self.directory_permissions = directory_permissions
 
     def _rel_tile_coord(self, tile_coord):
         return (
@@ -150,10 +156,11 @@ class BundleV1(object):
         )
 
     def data(self):
-        return BundleDataV1(self.base_filename + BUNDLE_EXT, self.offset)
+        return BundleDataV1(self.base_filename + BUNDLE_EXT, self.offset,
+                            self.directory_permissions, self.file_permissions)
 
     def index(self):
-        return BundleIndexV1(self.base_filename + BUNDLEX_V1_EXT)
+        return BundleIndexV1(self.base_filename + BUNDLEX_V1_EXT, self.directory_permissions, self.file_permissions)
 
     def is_cached(self, tile, dimensions=None):
         if tile.source or tile.coord is None:
@@ -185,7 +192,7 @@ class BundleV1(object):
                 data = buf.read()
             tiles_data.append((t.coord, data))
 
-        with FileLock(self.lock_filename):
+        with FileLock(self.lock_filename, directory_permissions=self.directory_permissions, remove_on_unlock=True):
             with self.data().readwrite() as bundle:
                 with self.index().readwrite() as idx:
                     for tile_coord, data in tiles_data:
@@ -229,7 +236,7 @@ class BundleV1(object):
         if tile.coord is None:
             return True
 
-        with FileLock(self.lock_filename):
+        with FileLock(self.lock_filename, directory_permissions=self.directory_permissions, remove_on_unlock=True):
             with self.index().readwrite() as idx:
                 x, y = self._rel_tile_coord(tile.coord)
                 idx.remove_tile_offset(x, y)
@@ -269,9 +276,11 @@ INT64LE = struct.Struct('<Q')
 
 
 class BundleIndexV1(object):
-    def __init__(self, filename):
+    def __init__(self, filename, directory_permissions=None, file_permissions=None):
         self.filename = filename
         self._fh = None
+        self.directory_permissions = directory_permissions
+        self.file_permissions = file_permissions
         # defer initialization to update/remove calls to avoid
         # index creation on is_cached (prevents new files in read-only caches)
         self._initialized = False
@@ -280,7 +289,7 @@ class BundleIndexV1(object):
         self._initialized = True
         if os.path.exists(self.filename):
             return
-        ensure_directory(self.filename)
+        ensure_directory(self.filename, self.directory_permissions)
         buf = BytesIO()
         buf.write(BUNDLEX_V1_HEADER)
 
@@ -288,6 +297,10 @@ class BundleIndexV1(object):
             buf.write(INT64LE.pack((i*4)+BUNDLE_V1_HEADER_SIZE)[:5])
         buf.write(BUNDLEX_V1_FOOTER)
         write_atomic(self.filename, buf.getvalue())
+        if self.file_permissions:
+            permission = int(self.file_permissions, base=8)
+            log.info("setting file permissions on compact cache file: " + self.file_permissions)
+            os.chmod(self.filename, permission)
 
     def _tile_index_offset(self, x, y):
         return BUNDLEX_V1_HEADER_SIZE + (x * BUNDLEX_V1_GRID_HEIGHT + y) * 5
@@ -333,6 +346,10 @@ class BundleIndexV1(object):
     def readwrite(self):
         self._init_index()
         with open(self.filename, 'r+b') as fh:
+            if self.file_permissions:
+                permission = int(self.file_permissions, base=8)
+                log.info("setting file permissions on compact cache file: " + self.file_permissions)
+                os.chmod(self.filename, permission)
             b = BundleIndexV1(self.filename)
             b._fh = fh
             yield b
@@ -361,15 +378,17 @@ BUNDLE_V1_HEADER_STRUCT_FORMAT = '<4I3Q5I'
 
 
 class BundleDataV1(object):
-    def __init__(self, filename, tile_offsets):
+    def __init__(self, filename, tile_offsets, directory_permissions=None, file_permissions=None):
         self.filename = filename
         self.tile_offsets = tile_offsets
         self._fh = None
+        self.directory_permissions = directory_permissions
+        self.file_permissions = file_permissions
         if not os.path.exists(self.filename):
             self._init_bundle()
 
     def _init_bundle(self):
-        ensure_directory(self.filename)
+        ensure_directory(self.filename, self.directory_permissions)
         header = list(BUNDLE_V1_HEADER)
         header[10], header[8] = self.tile_offsets
         header[11], header[9] = header[10]+127, header[8]+127
@@ -377,18 +396,22 @@ class BundleDataV1(object):
                      struct.pack(BUNDLE_V1_HEADER_STRUCT_FORMAT, *header) +
                      # zero-size entry for each tile
                      (b'\x00' * (BUNDLEX_V1_GRID_HEIGHT * BUNDLEX_V1_GRID_WIDTH * 4)))
+        if self.file_permissions:
+            permission = int(self.file_permissions, base=8)
+            log.info("setting file permissions on compact cache file: " + self.file_permissions)
+            os.chmod(self.filename, permission)
 
     @contextlib.contextmanager
     def readonly(self):
         with open(self.filename, 'rb') as fh:
-            b = BundleDataV1(self.filename, self.tile_offsets)
+            b = BundleDataV1(self.filename, self.tile_offsets, self.directory_permissions, self.file_permissions)
             b._fh = fh
             yield b
 
     @contextlib.contextmanager
     def readwrite(self):
         with open(self.filename, 'r+b') as fh:
-            b = BundleDataV1(self.filename, self.tile_offsets)
+            b = BundleDataV1(self.filename, self.tile_offsets, self.directory_permissions, self.file_permissions)
             b._fh = fh
             yield b
 
@@ -464,10 +487,12 @@ BUNDLE_V2_HEADER_SIZE = 64
 
 
 class BundleV2(object):
-    def __init__(self, base_filename, offset=None):
+    def __init__(self, base_filename, offset=None, file_permissions=None, directory_permissions=None):
         # offset not used by V2
         self.filename = base_filename + '.bundle'
         self.lock_filename = base_filename + '.lck'
+        self.file_permissions = file_permissions
+        self.directory_permissions = directory_permissions
 
         # defer initialization to update/remove calls to avoid
         # index creation on is_cached (prevents new files in read-only caches)
@@ -477,12 +502,16 @@ class BundleV2(object):
         self._initialized = True
         if os.path.exists(self.filename):
             return
-        ensure_directory(self.filename)
+        ensure_directory(self.filename, self.directory_permissions)
         buf = BytesIO()
         buf.write(struct.pack(BUNDLE_V2_HEADER_STRUCT_FORMAT, *BUNDLE_V2_HEADER))
         # Empty index (ArcGIS stores an offset of 4 and size of 0 for missing tiles)
         buf.write(struct.pack('<%dQ' % BUNDLE_V2_TILES, *(4, ) * BUNDLE_V2_TILES))
         write_atomic(self.filename, buf.getvalue())
+        if self.file_permissions:
+            permission = int(self.file_permissions, base=8)
+            log.info("setting file permissions on compact cache file: " + self.file_permissions)
+            os.chmod(self.filename, permission)
 
     def _tile_idx_offset(self, x, y):
         return BUNDLE_V2_HEADER_SIZE + (x + BUNDLE_V2_GRID_HEIGHT * y) * 8
@@ -605,7 +634,7 @@ class BundleV2(object):
                 data = buf.read()
             tiles_data.append((t.coord, data))
 
-        with FileLock(self.lock_filename):
+        with FileLock(self.lock_filename, directory_permissions=self.directory_permissions, remove_on_unlock=True):
             with self._readwrite() as fh:
                 for tile_coord, data in tiles_data:
                     self._store_tile(fh, tile_coord, data, dimensions=dimensions)
@@ -617,7 +646,7 @@ class BundleV2(object):
             return True
 
         self._init_index()
-        with FileLock(self.lock_filename):
+        with FileLock(self.lock_filename, directory_permissions=self.directory_permissions, remove_on_unlock=True):
             with self._readwrite() as fh:
                 x, y = self._rel_tile_coord(tile.coord)
                 self._update_tile_offset(fh, x, y, 0, 0)

{MapProxy-3.0.1 → MapProxy-3.1.0}/mapproxy/cache/file.py

@@ -33,7 +33,8 @@ class FileCache(TileCacheBase):
     supports_dimensions = True
 
     def __init__(self, cache_dir, file_ext, directory_layout='tc',
-                 link_single_color_images=False, coverage=None, image_opts=None):
+                 link_single_color_images=False, coverage=None, image_opts=None,
+                 directory_permissions=None, file_permissions=None):
         """
         :param cache_dir: the path where the tile will be stored
         :param file_ext: the file extension that will be appended to
@@ -46,6 +47,8 @@ class FileCache(TileCacheBase):
         self.file_ext = file_ext
         self.image_opts = image_opts
         self.link_single_color_images = link_single_color_images
+        self.directory_permissions = directory_permissions
+        self.file_permissions = file_permissions
         self._tile_location, self._level_location = path.location_funcs(layout=directory_layout)
         if self._level_location is None:
             self.level_location = None  # disable level based clean-ups
@@ -57,7 +60,8 @@ class FileCache(TileCacheBase):
             dimensions_str = ['{key}-{value}'.format(key=i, value=dimensions[i].replace('/', '_')) for i in items]
             # todo: cache_dir is not used. should it get returned or removed?
             cache_dir = os.path.join(self.cache_dir, '_'.join(dimensions_str))  # noqa
-        return self._tile_location(tile, self.cache_dir, self.file_ext, create_dir=create_dir, dimensions=dimensions)
+        return self._tile_location(tile, self.cache_dir, self.file_ext, create_dir=create_dir, dimensions=dimensions,
+                                   directory_permissions=self.directory_permissions)
 
     def level_location(self, level, dimensions=None):
         """
@@ -82,7 +86,7 @@ class FileCache(TileCacheBase):
         )
         location = os.path.join(*parts)
         if create_dir:
-            ensure_directory(location)
+            ensure_directory(location, self.directory_permissions)
         return location
 
     def load_tile_metadata(self, tile, dimensions=None):