Processor resource discovery

ocrd/ocrd/cli/resmgr.py

@@ -9,18 +9,11 @@
 from ocrd_utils import (
     initLogging,
     getLogger,
-    VIRTUAL_ENV,
-    RESOURCE_LOCATIONS,
-    XDG_CACHE_HOME,
-    XDG_CONFIG_HOME,
-    XDG_DATA_HOME
+    RESOURCE_LOCATIONS
 )
 from ocrd_validators import OcrdZipValidator
 
 from ..resource_manager import OcrdResourceManager
-from ..config import load_config_file
-
-config = load_config_file()
 
 def print_resources(executable, reslist, resmgr):
     print('%s' % executable)
@@ -64,7 +57,7 @@ def list_installed(executable=None):
 @resmgr_cli.command('download')
 @click.option('-n', '--any-url', help='Allow downloading/copying unregistered resources', is_flag=True)
 @click.option('-o', '--overwrite', help='Overwrite existing resources', is_flag=True)
-@click.option('-l', '--location', help='Where to store resources', type=click.Choice(RESOURCE_LOCATIONS), default=config.resource_location, show_default=True)
+@click.option('-l', '--location', help='Where to store resources', type=click.Choice(RESOURCE_LOCATIONS), default='data', show_default=True)
 @click.argument('executable', required=True)
 @click.argument('url_or_name', required=True)
 def download(any_url, overwrite, location, executable, url_or_name):

ocrd/ocrd/processor/base.py

@@ -26,7 +26,6 @@
     initLogging,
     list_resource_candidates,
     list_all_resources,
-    XDG_CACHE_HOME
 )
 from ocrd_validators import ParameterValidator
 from ocrd_models.ocrd_page import MetadataItemType, LabelType, LabelsType

ocrd/ocrd/resource_manager.py

@@ -12,11 +12,10 @@
 
 from ocrd_validators import OcrdResourceListValidator
 from ocrd_utils import getLogger
-from ocrd_utils.constants import HOME, XDG_CACHE_HOME, XDG_CONFIG_HOME, XDG_DATA_HOME, VIRTUAL_ENV
+from ocrd_utils.constants import HOME, XDG_DATA_HOME, XDG_CONFIG_HOME
 from ocrd_utils.os import list_all_resources, pushd_popd
 
 from .constants import RESOURCE_LIST_FILENAME, RESOURCE_USER_LIST_COMMENT
-from .config import load_config_file
 
 class OcrdResourceManager():
 
@@ -71,9 +70,7 @@ def list_installed(self, executable=None):
             # resources we know about
             all_executables = list(self.database.keys())
             # resources in the file system
-            parent_dirs = [join(x, 'ocrd-resources') for x in [XDG_CACHE_HOME, XDG_CONFIG_HOME, XDG_DATA_HOME]]
-            if VIRTUAL_ENV:
-                parent_dirs += [join(VIRTUAL_ENV, 'share', 'ocrd-resources')]
+            parent_dirs = [join(x, 'ocrd-resources') for x in [XDG_DATA_HOME, '/usr/local/share']]
             for parent_dir in parent_dirs:
                 if Path(parent_dir).exists():
                     all_executables += [x for x in listdir(parent_dir) if x.startswith('ocrd-')]
@@ -135,25 +132,16 @@ def find_resources(self, executable=None, name=None, url=None, database=None):
         return ret
 
     def location_to_resource_dir(self, location):
-        return join(VIRTUAL_ENV, 'share', 'ocrd-resources') if location == 'virtualenv' and VIRTUAL_ENV else \
-                join(XDG_CACHE_HOME, 'ocrd-resources') if location == 'cache' else \
+        return '/usr/local/share/ocrd-resources' if location == 'system' else \
                 join(XDG_DATA_HOME, 'ocrd-resources') if location == 'data' else \
-                join(XDG_CONFIG_HOME, 'ocrd-resources') if location == 'config' else \
                 getcwd()
 
     def resource_dir_to_location(self, resource_path):
         resource_path = str(resource_path)
-        return 'virtualenv' if VIRTUAL_ENV and resource_path.startswith(join(VIRTUAL_ENV, 'share', 'ocrd-resources')) else \
-               'cache' if resource_path.startswith(join(XDG_CACHE_HOME, 'ocrd-resources')) else \
+        return 'system' if resource_path.startswith('/usr/local/share/ocrd-resources') else \
                'data' if resource_path.startswith(join(XDG_DATA_HOME, 'ocrd-resources')) else \
-               'config' if resource_path.startswith(join(XDG_CONFIG_HOME, 'ocrd-resources')) else \
                resource_path
 
-    @property
-    def default_resource_dir(self):
-        config = load_config_file()
-        return self.location_to_resource_dir(config.resource_location)
-
     def parameter_usage(self, name, usage='as-is'):
         if usage == 'as-is':
             return name
@@ -189,8 +177,8 @@ def download(
         self,
         executable,
         url,
+        basedir,
         overwrite=False,
-        basedir=XDG_CACHE_HOME,
         name=None,
         resource_type='file',
         path_in_archive='.',

ocrd_modelfactory/ocrd_modelfactory/__init__.py

@@ -10,7 +10,7 @@
 from PIL import Image
 
 from ocrd_utils import VERSION, MIMETYPE_PAGE
-from ocrd_models import OcrdExif, OcrdConfig
+from ocrd_models import OcrdExif
 from ocrd_models.ocrd_page import PcGtsType, PageType, MetadataType, parse
 
 __all__ = [

ocrd_models/ocrd_models/__init__.py

@@ -2,7 +2,6 @@
 APIs and schemas for various file formats in the OCR domain.
 """
 from .ocrd_agent import OcrdAgent
-from .ocrd_config import OcrdConfig
 from .ocrd_exif import OcrdExif
 from .ocrd_file import OcrdFile
 from .ocrd_mets import OcrdMets

ocrd_utils/ocrd_utils/__init__.py

@@ -80,8 +80,6 @@
     LOG_FORMAT,
     LOG_TIMEFMT,
     VERSION,
-    VIRTUAL_ENV,
-    XDG_CACHE_HOME,
     XDG_CONFIG_HOME,
     XDG_DATA_HOME)
 

ocrd_utils/ocrd_utils/constants.py

@@ -18,10 +18,8 @@
     'REGEX_FILE_ID',
     'RESOURCE_LOCATIONS',
     'VERSION',
-    'VIRTUAL_ENV',
     'XDG_CONFIG_HOME',
     'XDG_DATA_HOME',
-    'XDG_CACHE_HOME',
 ]
 
 VERSION = get_distribution('ocrd_utils').version
@@ -106,7 +104,5 @@
     HOME = expanduser('~')
 XDG_DATA_HOME = environ['XDG_DATA_HOME'] if 'XDG_DATA_HOME' in environ else join(HOME, '.local', 'share')
 XDG_CONFIG_HOME = environ['XDG_CONFIG_HOME'] if 'XDG_CONFIG_HOME' in environ else join(HOME, '.config')
-XDG_CACHE_HOME = environ['XDG_CACHE_HOME'] if 'XDG_CACHE_HOME' in environ else join(HOME, '.cache')
-VIRTUAL_ENV = environ.get('VIRTUAL_ENV', None)
 
-RESOURCE_LOCATIONS = ['virtualenv', 'cwd', 'cache', 'config', 'data']
+RESOURCE_LOCATIONS = ['data', 'cwd', 'system']

ocrd_utils/ocrd_utils/os.py

@@ -18,7 +18,7 @@
 
 from atomicwrites import atomic_write as atomic_write_, AtomicWriter
 
-from .constants import XDG_DATA_HOME, XDG_CONFIG_HOME, XDG_CACHE_HOME
+from .constants import XDG_DATA_HOME
 
 def abspath(url):
     """
@@ -69,11 +69,8 @@ def list_resource_candidates(executable, fname, cwd=getcwd(), is_file=False, is_
     processor_path_var = '%s_PATH' % executable.replace('-', '_').upper()
     if processor_path_var in environ:
         candidates += [join(x, fname) for x in environ[processor_path_var].split(':')]
-    if 'VIRTUAL_ENV' in environ:
-        candidates.append(join(environ['VIRTUAL_ENV'], 'share', 'ocrd-resources', executable, fname))
     candidates.append(join(XDG_DATA_HOME, 'ocrd-resources', executable, fname))
-    candidates.append(join(XDG_CONFIG_HOME, 'ocrd-resources', executable, fname))
-    candidates.append(join(XDG_CACHE_HOME, 'ocrd-resources', executable, fname))
+    candidates.append(join('/usr/local/share/ocrd-resources', executable, fname))
     if is_file:
         candidates = [c for c in candidates if Path(c).is_file()]
     if is_dir:
@@ -94,13 +91,12 @@ def list_all_resources(executable):
         for processor_path in environ[processor_path_var].split(':'):
             if isdir(processor_path):
                 candidates += list(scandir(processor_path))
-    if 'VIRTUAL_ENV' in environ:
-        sharedir = join(environ['VIRTUAL_ENV'], 'share', 'ocrd-resources', executable)
-        if isdir(sharedir):
-            candidates += list(scandir(sharedir))
-    for xdgdir in [join(d, 'ocrd-resources', executable) for d in [XDG_DATA_HOME, XDG_CONFIG_HOME, XDG_CACHE_HOME]]:
-        if isdir(xdgdir):
-            candidates += list(scandir(xdgdir))
+    datadir = join(XDG_DATA_HOME, 'ocrd-resources', executable)
+    if isdir(datadir):
+        candidates += list(scandir(datadir))
+    systemdir = join('/usr/local/share/ocrd-resources', executable)
+    if isdir(systemdir):
+        candidates += list(scandir(systemdir))
     return [x.path for x in candidates]
 
 # ht @pabs3

ocrd_validators/ocrd_validators/__init__.py

@@ -6,7 +6,6 @@
     'WorkspaceValidator',
     'PageValidator',
     'OcrdToolValidator',
-    'OcrdConfigValidator',
     'OcrdResourceListValidator',
     'OcrdZipValidator',
     'XsdValidator',
@@ -18,7 +17,6 @@
 from .workspace_validator import WorkspaceValidator
 from .page_validator import PageValidator
 from .ocrd_tool_validator import OcrdToolValidator
-from .ocrd_config_validator import OcrdConfigValidator
 from .resource_list_validator import OcrdResourceListValidator
 from .ocrd_zip_validator import OcrdZipValidator
 from .xsd_validator import XsdValidator

ocrd_validators/ocrd_validators/constants.py

@@ -20,7 +20,6 @@
 
 OCRD_TOOL_SCHEMA = yaml.safe_load(resource_string(__name__, 'ocrd_tool.schema.yml'))
 RESOURCE_LIST_SCHEMA = yaml.safe_load(resource_string(__name__, 'resource_list.schema.yml'))
-CONFIG_SCHEMA = yaml.safe_load(resource_string(__name__, 'ocrd_config.schema.yml'))
 OCRD_BAGIT_PROFILE = yaml.safe_load(resource_string(__name__, 'bagit-profile.yml'))
 
 BAGIT_TXT = 'BagIt-Version: 1.0\nTag-File-Character-Encoding: UTF-8'

tests/utils/test_os.py

@@ -13,19 +13,11 @@ class TestOsUtils(TestCase):
     def setUp(self):
         self.maxDiff = None
         self.tempdir_path = mkdtemp()
-        self.tempdir_venv = mkdtemp()
         ENV['OCRD_DUMMY_PATH'] = self.tempdir_path
-        self.VIRTUAL_ENV = ENV.get('VIRTUAL_ENV')
-        ENV['VIRTUAL_ENV'] = self.tempdir_venv
 
     def tearDown(self):
         rmtree(self.tempdir_path)
-        rmtree(self.tempdir_venv)
         del ENV['OCRD_DUMMY_PATH']
-        if self.VIRTUAL_ENV:
-            ENV['VIRTUAL_ENV'] = self.VIRTUAL_ENV
-        else:
-            del ENV['VIRTUAL_ENV']
 
     def test_resolve_basic(self):
         def dehomify(s):
@@ -37,10 +29,8 @@ def dehomify(s):
         self.assertEqual(cands, [join(x, fname) for x in [
             dehomify(join(getcwd(), 'ocrd-resources')),
             dehomify(self.tempdir_path),
-            dehomify(join(self.tempdir_venv, 'share', 'ocrd-resources', 'ocrd-dummy')),
             '$HOME/.local/share/ocrd-resources/ocrd-dummy',
-            '$HOME/.config/ocrd-resources/ocrd-dummy',
-            '$HOME/.cache/ocrd-resources/ocrd-dummy',
+            '/usr/local/share/ocrd-resources/ocrd-dummy',
         ]])