|
|
@@ -0,0 +1,255 @@
|
|
|
+"""
|
|
|
+Checking objects in a GRASS GIS Spatial Database
|
|
|
+
|
|
|
+(C) 2020 by the GRASS Development Team
|
|
|
+This program is free software under the GNU General Public
|
|
|
+License (>=v2). Read the file COPYING that comes with GRASS
|
|
|
+for details.
|
|
|
+
|
|
|
+.. sectionauthor:: Vaclav Petras <wenzeslaus gmail com>
|
|
|
+"""
|
|
|
+
|
|
|
+
|
|
|
+import os
|
|
|
+
|
|
|
+
|
|
|
+def mapset_exists(database, location, mapset):
|
|
|
+ """Returns True whether mapset path exists."""
|
|
|
+ location_path = os.path.join(database, location)
|
|
|
+ mapset_path = os.path.join(location_path, mapset)
|
|
|
+ if os.path.exists(mapset_path):
|
|
|
+ return True
|
|
|
+ return False
|
|
|
+
|
|
|
+
|
|
|
+def location_exists(database, location):
|
|
|
+ """Returns True whether location path exists."""
|
|
|
+ location_path = os.path.join(database, location)
|
|
|
+ if os.path.exists(location_path):
|
|
|
+ return True
|
|
|
+ return False
|
|
|
+
|
|
|
+
|
|
|
+# TODO: distinguish between valid for getting maps and usable as current
|
|
|
+# https://lists.osgeo.org/pipermail/grass-dev/2016-September/082317.html
|
|
|
+# interface created according to the current usage
|
|
|
+def is_mapset_valid(mapset_path):
|
|
|
+ """Return True if GRASS Mapset is valid"""
|
|
|
+ # WIND is created from DEFAULT_WIND by `g.region -d` and functions
|
|
|
+ # or modules which create a new mapset. Most modules will fail if
|
|
|
+ # WIND doesn't exist (assuming that neither GRASS_REGION nor
|
|
|
+ # WIND_OVERRIDE environmental variables are set).
|
|
|
+ return os.access(os.path.join(mapset_path, "WIND"), os.R_OK)
|
|
|
+
|
|
|
+
|
|
|
+def is_location_valid(database, location):
|
|
|
+ """Return True if GRASS Location is valid
|
|
|
+
|
|
|
+ :param database: Path to GRASS GIS database directory
|
|
|
+ :param location: name of a Location
|
|
|
+ """
|
|
|
+ # DEFAULT_WIND file should not be required until you do something
|
|
|
+ # that actually uses them. The check is just a heuristic; a directory
|
|
|
+ # containing a PERMANENT/DEFAULT_WIND file is probably a GRASS
|
|
|
+ # location, while a directory lacking it probably isn't.
|
|
|
+ return os.access(
|
|
|
+ os.path.join(database, location, "PERMANENT", "DEFAULT_WIND"), os.F_OK
|
|
|
+ )
|
|
|
+
|
|
|
+
|
|
|
+def is_mapset_users(mapset_path):
|
|
|
+ """Check if the mapset belongs to the user"""
|
|
|
+ # Note that this does account for libgis built with SKIP_MAPSET_OWN_CHK
|
|
|
+ # which disables the ownerships check, i.e., even if it was build with the
|
|
|
+ # skip, it still needs the env variable.
|
|
|
+ if os.environ.get("GRASS_SKIP_MAPSET_OWNER_CHECK", None):
|
|
|
+ # Mapset just needs to be accessible for writing.
|
|
|
+ return os.access(mapset_path, os.W_OK)
|
|
|
+ # Mapset needs to be owned by user.
|
|
|
+ stat_info = os.stat(mapset_path)
|
|
|
+ mapset_uid = stat_info.st_uid
|
|
|
+ return mapset_uid == os.getuid()
|
|
|
+
|
|
|
+
|
|
|
+def is_mapset_locked(mapset_path):
|
|
|
+ """Check if the mapset is locked"""
|
|
|
+ lock_name = ".gislock"
|
|
|
+ lockfile = os.path.join(mapset_path, lock_name)
|
|
|
+ return os.path.exists(lockfile)
|
|
|
+
|
|
|
+
|
|
|
+def get_lockfile_if_present(database, location, mapset):
|
|
|
+ """Return path to lock if present, None otherwise
|
|
|
+
|
|
|
+ Returns the path as a string or None if nothing was found, so the
|
|
|
+ return value can be used to test if the lock is present.
|
|
|
+ """
|
|
|
+ lock_name = ".gislock"
|
|
|
+ lockfile = os.path.join(database, location, mapset, lock_name)
|
|
|
+ if os.path.isfile(lockfile):
|
|
|
+ return lockfile
|
|
|
+ return None
|
|
|
+
|
|
|
+
|
|
|
+def can_start_in_mapset(mapset_path, ignore_lock=False):
|
|
|
+ """Check if a mapset from a gisrc file is usable for new session"""
|
|
|
+ if not is_mapset_valid(mapset_path):
|
|
|
+ return False
|
|
|
+ if not is_mapset_users(mapset_path):
|
|
|
+ return False
|
|
|
+ if not ignore_lock and is_mapset_locked(mapset_path):
|
|
|
+ return False
|
|
|
+ return True
|
|
|
+
|
|
|
+
|
|
|
+def dir_contains_location(path):
|
|
|
+ """Return True if directory *path* contains a valid location"""
|
|
|
+ if not os.path.isdir(path):
|
|
|
+ return False
|
|
|
+ for name in os.listdir(path):
|
|
|
+ if os.path.isdir(os.path.join(path, name)):
|
|
|
+ if is_location_valid(path, name):
|
|
|
+ return True
|
|
|
+ return False
|
|
|
+
|
|
|
+
|
|
|
+# basically checking location, possibly split into two functions
|
|
|
+# (mapset one can call location one)
|
|
|
+def get_mapset_invalid_reason(database, location, mapset, none_for_no_reason=False):
|
|
|
+ """Returns a message describing what is wrong with the Mapset
|
|
|
+
|
|
|
+ The goal is to provide the most suitable error message
|
|
|
+ (rather than to do a quick check).
|
|
|
+
|
|
|
+ :param database: Path to GRASS GIS database directory
|
|
|
+ :param location: name of a Location
|
|
|
+ :param mapset: name of a Mapset
|
|
|
+ :returns: translated message
|
|
|
+ """
|
|
|
+ # Since we are trying to get the one most likely message, we need all
|
|
|
+ # those return statements here.
|
|
|
+ # pylint: disable=too-many-return-statements
|
|
|
+ location_path = os.path.join(database, location)
|
|
|
+ mapset_path = os.path.join(location_path, mapset)
|
|
|
+ # first checking the location validity
|
|
|
+ # perhaps a special set of checks with different messages mentioning mapset
|
|
|
+ # will be needed instead of the same set of messages used for location
|
|
|
+ location_msg = get_location_invalid_reason(
|
|
|
+ database, location, none_for_no_reason=True
|
|
|
+ )
|
|
|
+ if location_msg:
|
|
|
+ return location_msg
|
|
|
+ # if location is valid, check mapset
|
|
|
+ if mapset not in os.listdir(location_path):
|
|
|
+ # TODO: remove the grass.py specific wording
|
|
|
+ return _(
|
|
|
+ "Mapset <{mapset}> doesn't exist in GRASS Location <{location}>"
|
|
|
+ ).format(mapset=mapset, location=location)
|
|
|
+ if not os.path.isdir(mapset_path):
|
|
|
+ return _("<%s> is not a GRASS Mapset because it is not a directory") % mapset
|
|
|
+ if not os.path.isfile(os.path.join(mapset_path, "WIND")):
|
|
|
+ return (
|
|
|
+ _(
|
|
|
+ "<%s> is not a valid GRASS Mapset"
|
|
|
+ " because it does not have a WIND file"
|
|
|
+ )
|
|
|
+ % mapset
|
|
|
+ )
|
|
|
+ # based on the is_mapset_valid() function
|
|
|
+ if not os.access(os.path.join(mapset_path, "WIND"), os.R_OK):
|
|
|
+ return (
|
|
|
+ _(
|
|
|
+ "<%s> is not a valid GRASS Mapset"
|
|
|
+ " because its WIND file is not readable"
|
|
|
+ )
|
|
|
+ % mapset
|
|
|
+ )
|
|
|
+ # no reason for invalidity found (might be valid)
|
|
|
+ if none_for_no_reason:
|
|
|
+ return None
|
|
|
+ return _(
|
|
|
+ "Mapset <{mapset}> or Location <{location}> is invalid for an unknown reason"
|
|
|
+ ).format(mapset=mapset, location=location)
|
|
|
+
|
|
|
+
|
|
|
+def get_location_invalid_reason(database, location, none_for_no_reason=False):
|
|
|
+ """Returns a message describing what is wrong with the Location
|
|
|
+
|
|
|
+ The goal is to provide the most suitable error message
|
|
|
+ (rather than to do a quick check).
|
|
|
+
|
|
|
+ By default, when no reason is found, a message about unknown reason is
|
|
|
+ returned. This applies also to the case when this function is called on
|
|
|
+ a valid location (e.g. as a part of larger investigation).
|
|
|
+ ``none_for_no_reason=True`` allows the function to be used as part of other
|
|
|
+ diagnostic. When this function fails to find reason for invalidity, other
|
|
|
+ the caller can continue the investigation in their context.
|
|
|
+
|
|
|
+ :param database: Path to GRASS GIS database directory
|
|
|
+ :param location: name of a Location
|
|
|
+ :param none_for_no_reason: When True, return None when reason is unknown
|
|
|
+ :returns: translated message or None
|
|
|
+ """
|
|
|
+ location_path = os.path.join(database, location)
|
|
|
+ permanent_path = os.path.join(location_path, "PERMANENT")
|
|
|
+
|
|
|
+ # directory
|
|
|
+ if not os.path.exists(location_path):
|
|
|
+ return _("Location <%s> doesn't exist") % location_path
|
|
|
+ # permament mapset
|
|
|
+ if "PERMANENT" not in os.listdir(location_path):
|
|
|
+ return (
|
|
|
+ _(
|
|
|
+ "<%s> is not a valid GRASS Location"
|
|
|
+ " because PERMANENT Mapset is missing"
|
|
|
+ )
|
|
|
+ % location_path
|
|
|
+ )
|
|
|
+ if not os.path.isdir(permanent_path):
|
|
|
+ return (
|
|
|
+ _(
|
|
|
+ "<%s> is not a valid GRASS Location"
|
|
|
+ " because PERMANENT is not a directory"
|
|
|
+ )
|
|
|
+ % location_path
|
|
|
+ )
|
|
|
+ # partially based on the is_location_valid() function
|
|
|
+ if not os.path.isfile(os.path.join(permanent_path, "DEFAULT_WIND")):
|
|
|
+ return (
|
|
|
+ _(
|
|
|
+ "<%s> is not a valid GRASS Location"
|
|
|
+ " because PERMANENT Mapset does not have a DEFAULT_WIND file"
|
|
|
+ " (default computational region)"
|
|
|
+ )
|
|
|
+ % location_path
|
|
|
+ )
|
|
|
+ # no reason for invalidity found (might be valid)
|
|
|
+ if none_for_no_reason:
|
|
|
+ return None
|
|
|
+ return _("Location <{location_path}> is invalid for an unknown reason").format(
|
|
|
+ location_path=location_path
|
|
|
+ )
|
|
|
+
|
|
|
+
|
|
|
+def get_location_invalid_suggestion(database, location):
|
|
|
+ """Return suggestion what to do when specified location is not valid
|
|
|
+
|
|
|
+ It gives suggestion when:
|
|
|
+ * A mapset was specified instead of a location.
|
|
|
+ * A GRASS database was specified instead of a location.
|
|
|
+ """
|
|
|
+ location_path = os.path.join(database, location)
|
|
|
+ # a common error is to use mapset instead of location,
|
|
|
+ # if that's the case, include that info into the message
|
|
|
+ if is_mapset_valid(location_path):
|
|
|
+ return _(
|
|
|
+ "<{location}> looks like a mapset, not a location."
|
|
|
+ " Did you mean just <{one_dir_up}>?"
|
|
|
+ ).format(location=location, one_dir_up=database)
|
|
|
+ # confusion about what is database and what is location
|
|
|
+ if dir_contains_location(location_path):
|
|
|
+ return _(
|
|
|
+ "It looks like <{location}> contains locations."
|
|
|
+ " Did you mean to specify one of them?"
|
|
|
+ ).format(location=location)
|
|
|
+ return None
|
Vaclav Petras