Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

Source code for tool_shed.util.hgweb_config

import configparser
import logging
import os
import shutil
import threading
from datetime import date

log = logging.getLogger(__name__)

new_hgweb_config_template = """
[paths]

"""




class HgWebConfigManager:


    def __init__(self) -> None:
        self.hgweb_config_dir: str
        self._in_memory_config: configparser.ConfigParser | None = None
        self.lock = threading.Lock()
        self.hgweb_repo_prefix: str




    def add_entry(self, lhs: str, rhs: str) -> None:
        """Add an entry in the hgweb.config file for a new repository."""
        self.lock.acquire(True)
        try:
            # Since we're changing the config, make sure the latest is loaded into memory.
            in_memory_config = self.read_config(force_read=True)
            # An entry looks something like: repos/test/mira_assembler = database/community_files/000/repo_123.
            if rhs.startswith("./"):
                rhs = rhs.replace("./", "", 1)
            self.make_backup()
            # Add the new entry into memory.
            in_memory_config.set("paths", lhs, rhs)
            # Persist our in-memory configuration.
            self.write_config(in_memory_config)
        except Exception:
            log.exception("Exception in HgWebConfigManager.add_entry()")
        finally:
            self.lock.release()




    def change_entry(self, old_lhs: str, new_lhs: str, new_rhs: str) -> None:
        """Change an entry in the hgweb.config file for a repository - this only happens when the owner changes the name of the repository."""
        self.lock.acquire(True)
        try:
            in_memory_config = self.read_config(force_read=True)
            self.make_backup()
            # Remove the old entry.
            in_memory_config.remove_option("paths", old_lhs)
            # Add the new entry.
            in_memory_config.set("paths", new_lhs, new_rhs)
            # Persist our in-memory configuration.
            self.write_config(in_memory_config)
        except Exception:
            log.exception("Exception in HgWebConfigManager.change_entry()")
        finally:
            self.lock.release()




    def get_entry(self, lhs: str) -> str:
        """Return an entry in the hgweb.config file for a repository"""
        in_memory_config = self.read_config()
        try:
            entry: str = in_memory_config.get("paths", lhs)
        except configparser.NoOptionError:
            try:
                # We have a multi-threaded front-end, so one of the threads may not have the latest version of the hgweb.config file.
                # Re-read under the lock so we never parse a file that add_entry or change_entry is rewriting.
                with self.lock:
                    in_memory_config = self.read_config(force_read=True)
                entry = in_memory_config.get("paths", lhs)
            except configparser.NoOptionError:
                raise Exception(f"Entry for repository {lhs} missing in file {self.hgweb_config}.")
        return entry


    @property
    def hgweb_config(self) -> str:
        hgweb_config = os.path.join(self.hgweb_config_dir, "hgweb.config")
        if not os.path.exists(hgweb_config):
            # We used to raise an exception here...
            # raise Exception( "Required file %s does not exist - check config setting for hgweb_config_dir." % hgweb_config )
            # ...but now we just log the missing file and create a new empty one.
            log.debug(
                f"Required file {hgweb_config} does not exist, so creating a new, empty file.  Check your config setting for hgweb_config_dir."
            )
            with open(hgweb_config, "w") as hgweb_config_file:
                hgweb_config_file.write(new_hgweb_config_template)
        return os.path.abspath(hgweb_config)



    def make_backup(self) -> None:
        # Make a backup of the hgweb.config file.
        today = date.today()
        backup_date = today.strftime("%Y_%m_%d")
        hgweb_config_backup_filename = f"hgweb.config_{backup_date}_backup"
        hgweb_config_copy = os.path.join(self.hgweb_config_dir, hgweb_config_backup_filename)
        shutil.copy(os.path.abspath(self.hgweb_config), os.path.abspath(hgweb_config_copy))




    def read_config(self, force_read: bool = False) -> configparser.ConfigParser:
        if force_read or self._in_memory_config is None:
            config = configparser.ConfigParser()
            config.read(self.hgweb_config)
            self._in_memory_config = config
        return self._in_memory_config




    def write_config(self, config: configparser.ConfigParser) -> None:
        """Write the configuration to the hgweb.config file on disk and use it as the in-memory configuration."""
        with open(self.hgweb_config, "w") as config_file:
            config.write(config_file)
        self._in_memory_config = config




hgweb_config_manager = HgWebConfigManager()