second revision, logging output polished
This commit is contained in:
		@@ -23,24 +23,24 @@ class Userconfig:
 | 
			
		||||
        :param package_dir: root of package directory
 | 
			
		||||
        :return: list of tuples (prio, category, value, path), sorted with prio
 | 
			
		||||
        """
 | 
			
		||||
        self._cfg.debug.stdout(f'*** process package {package_dir}', 3)
 | 
			
		||||
        self._cfg.debug.stdout(f'process package_dir {package_dir}', 3)
 | 
			
		||||
        package_config_file = f'{package_dir}/{self._cfg.get("configfile")}'
 | 
			
		||||
        if not os.path.isfile(package_config_file):
 | 
			
		||||
            self._cfg.debug.stdout(f'No config file {self._cfg.get("configfile")} in {package_dir}, skipping',
 | 
			
		||||
                                   1, 'ERROR')
 | 
			
		||||
                                   0, 'ERROR')
 | 
			
		||||
            return None
 | 
			
		||||
        dir_config = self.get_config(package_config_file)
 | 
			
		||||
        if not dir_config:
 | 
			
		||||
            self._cfg.debug.stdout(f'Cannot read config file {package_config_file}, skipping', 1, 'ERROR')
 | 
			
		||||
            self._cfg.debug.stdout(f'Cannot read config file {package_config_file}, skipping', 0, 'ERROR')
 | 
			
		||||
            return None
 | 
			
		||||
        classes = []
 | 
			
		||||
        for category in os.scandir(package_dir):
 | 
			
		||||
            if category.path == package_config_file:
 | 
			
		||||
                continue
 | 
			
		||||
            if not category.is_dir():
 | 
			
		||||
                self._cfg.debug.stdout(f'{category.path} is not a directory, skipping', 3, 'WARNING')
 | 
			
		||||
                self._cfg.debug.stdout(f'{category.path} is not a directory, skipping', 3)
 | 
			
		||||
                continue
 | 
			
		||||
            self._cfg.debug.stdout(f'****** process category {category.path}', 3)
 | 
			
		||||
            self._cfg.debug.stdout(f'process category {category.path}', 3)
 | 
			
		||||
            content = category.name.split('_')
 | 
			
		||||
            # Format: <number>_<category>_<value>
 | 
			
		||||
            if len(content) == 3:
 | 
			
		||||
@@ -52,14 +52,14 @@ class Userconfig:
 | 
			
		||||
                category_name = content[1]
 | 
			
		||||
                value = ''
 | 
			
		||||
            else:
 | 
			
		||||
                self._cfg.debug.stdout(f'Format of package directory {category.path} wrong, skipping', 1, 'ERROR')
 | 
			
		||||
                self._cfg.debug.stdout(f'Format of package directory {category.path} wrong, skipping', 0, 'ERROR')
 | 
			
		||||
                continue
 | 
			
		||||
            try:
 | 
			
		||||
                prio = int(prio_string)
 | 
			
		||||
            except ValueError:
 | 
			
		||||
                self._cfg.debug.stdout(f'Cannot convert prio to integer ({category.path}, skipping', 1, 'ERROR')
 | 
			
		||||
                self._cfg.debug.stdout(f'Cannot convert prio to integer ({category.path}, skipping', 0, 'ERROR')
 | 
			
		||||
                continue
 | 
			
		||||
            # self._cfg.debug.stdout(f'****** Got class: {(prio, category_name, value)}', 3)
 | 
			
		||||
            # self._cfg.debug.stdout(f'Got class: {(prio, category_name, value)}', 3)
 | 
			
		||||
            classes.append((prio, category_name, value, category.path))
 | 
			
		||||
        classes.sort(key=lambda k: k[0])
 | 
			
		||||
        return classes, dir_config
 | 
			
		||||
@@ -74,7 +74,7 @@ class Userconfig:
 | 
			
		||||
        ret = []
 | 
			
		||||
        for c in categories:
 | 
			
		||||
            if not c[1]:
 | 
			
		||||
                self._cfg.debug.stdout(f'category not set for {c[3]}, skipping', 3, 'WARNING')
 | 
			
		||||
                self._cfg.debug.stdout(f'category not set for {c[3]}, skipping', 0, 'ERROR')
 | 
			
		||||
                continue
 | 
			
		||||
            if check_class(c):
 | 
			
		||||
                ret.append(c)
 | 
			
		||||
@@ -89,7 +89,7 @@ class Userconfig:
 | 
			
		||||
        :return:
 | 
			
		||||
        """
 | 
			
		||||
        (prio, category, value, category_dir) = category_dir_tuple
 | 
			
		||||
        self._cfg.debug.stdout(f'*** process category {category_dir}', 3)
 | 
			
		||||
        self._cfg.debug.stdout(f'process category {category_dir}', 3)
 | 
			
		||||
        for file in os.scandir(category_dir):
 | 
			
		||||
            if file.name not in file_list:
 | 
			
		||||
                file_list[file.name] = []
 | 
			
		||||
@@ -107,7 +107,7 @@ class Userconfig:
 | 
			
		||||
        """
 | 
			
		||||
 | 
			
		||||
        content = []
 | 
			
		||||
        self._cfg.debug.stdout(f'*** building file for {dest_file}', 3)
 | 
			
		||||
        self._cfg.debug.stdout(f'building file for {dest_file}', 3)
 | 
			
		||||
        if comment_string:
 | 
			
		||||
            content.append(f'{comment_string} {self._cfg.get("stamp")} {time.strftime("%+")}\n')
 | 
			
		||||
        for file in files:
 | 
			
		||||
@@ -124,7 +124,7 @@ class Userconfig:
 | 
			
		||||
        try:
 | 
			
		||||
            fp = os.fdopen(temp_fd, "w")
 | 
			
		||||
        except Exception as e:
 | 
			
		||||
            self._cfg.debug.stderr(f"Cannot write to temporary file {temp_filename}: {e}", 0, 'ERROR')
 | 
			
		||||
            self._cfg.debug.stderr(f'Cannot write to temporary file {temp_filename}: {e}', 0, 'ERROR')
 | 
			
		||||
            os.remove(temp_filename)
 | 
			
		||||
            return False
 | 
			
		||||
        self._cfg.debug.stdout(f'Writing merged files into temporary file {temp_filename}', 3)
 | 
			
		||||
@@ -135,32 +135,35 @@ class Userconfig:
 | 
			
		||||
        return temp_filename
 | 
			
		||||
 | 
			
		||||
    def diff_and_copy_file(self, temp_filename, dest_filename, comment_string):
 | 
			
		||||
        ret = False
 | 
			
		||||
        if self.diff(dest_filename, temp_filename, comment_string):
 | 
			
		||||
            self._cfg.debug.stdout(f"File {dest_filename} has changed", 0, 'NOTICE')
 | 
			
		||||
            if not self.user_config_generated(dest_filename):
 | 
			
		||||
                self._cfg.debug.stdout(f"{dest_filename} not generated by userconfig, backing up.", 3)
 | 
			
		||||
                self._cfg.debug.stdout(f'{dest_filename} not generated by userconfig, running back_up.', 3)
 | 
			
		||||
                self.backup_file(dest_filename)
 | 
			
		||||
            self._cfg.debug.stdout(f"Copy {temp_filename} to {dest_filename}", 0, 'NOTICE')
 | 
			
		||||
            self.copy_file(temp_filename, dest_filename)
 | 
			
		||||
        self._cfg.debug.stdout(f"Removing temporary file {temp_filename}", 3)
 | 
			
		||||
            ret = True
 | 
			
		||||
        os.remove(temp_filename)
 | 
			
		||||
        self._cfg.debug.stdout(f'Removed temporary file {temp_filename}', 3, 'SUCCESS')
 | 
			
		||||
        return ret
 | 
			
		||||
 | 
			
		||||
    def create_destination_directories(self, dest_directory):
 | 
			
		||||
        self._cfg.debug.stdout(f'*** Creating {dest_directory} if needed', 3)
 | 
			
		||||
        path = Path(dest_directory)
 | 
			
		||||
        if not path.exists():
 | 
			
		||||
            path.mkdir(parents=True)
 | 
			
		||||
            return True
 | 
			
		||||
        else:
 | 
			
		||||
            return False
 | 
			
		||||
 | 
			
		||||
    def get_config(self, filename):
 | 
			
		||||
        """reads filename as config, checks for DEST parameter and returns cfgfile object"""
 | 
			
		||||
        try:
 | 
			
		||||
            ret = Conf(filename=filename, debug=self._cfg.debug, force_filename=True)
 | 
			
		||||
        except ValueError:
 | 
			
		||||
            self._cfg.debug.stderr("Error reading config file %s" % filename)
 | 
			
		||||
            self._cfg.debug.stderr(f'Error reading config file {filename}', 0, 'ERROR')
 | 
			
		||||
            return False
 | 
			
		||||
        # check for DEST parameter
 | 
			
		||||
        if not ret.check(section="Main", option="dest"):
 | 
			
		||||
            self._cfg.debug.stderr("No dest in config file %s" % filename)
 | 
			
		||||
            self._cfg.debug.stderr(f'No dest in config file {filename}', 0, 'ERROR')
 | 
			
		||||
            return False
 | 
			
		||||
        # make sure DEST ends with /
 | 
			
		||||
        if not ret.get(section="Main", option="dest").endswith("/"):
 | 
			
		||||
@@ -179,14 +182,12 @@ class Userconfig:
 | 
			
		||||
 | 
			
		||||
    def diff(self, dest_file, temp_file, comment_string):
 | 
			
		||||
        """diff dest_file and temp_file, returns True if files differ, False if they are the same"""
 | 
			
		||||
        self._cfg.debug.stdout("Diffing %s and %s, comment: %s" % (dest_file, temp_file, comment_string), 3)
 | 
			
		||||
        self._cfg.debug.stdout(f'Diffing {dest_file} and {temp_file}, comment: {comment_string}', 3)
 | 
			
		||||
        if not os.path.isfile(dest_file):
 | 
			
		||||
            self._cfg.debug.stdout("Destination file %s does not exist, returning True." % dest_file, 3)
 | 
			
		||||
            # dest_file does not exist -> copy temp_file over
 | 
			
		||||
            self._cfg.debug.stdout(f'dest_file {dest_file} does not exist.', 3)
 | 
			
		||||
            return True
 | 
			
		||||
        if not os.path.isfile(temp_file):
 | 
			
		||||
            # temp_file does not exist, this should never happen
 | 
			
		||||
            self._cfg.debug.stderr("Temporary file %s does not exist, this should not happen." % temp_file)
 | 
			
		||||
            self._cfg.debug.stderr(f'Temporary file {temp_file} does not exist, this should not happen.', 0, 'ERROR')
 | 
			
		||||
            sys.exit(1)
 | 
			
		||||
 | 
			
		||||
        fp1 = open(temp_file)
 | 
			
		||||
@@ -196,11 +197,11 @@ class Userconfig:
 | 
			
		||||
            if line1 != line2:
 | 
			
		||||
                fp1.close()
 | 
			
		||||
                fp2.close()
 | 
			
		||||
                self._cfg.debug.stdout("%s differs, return true" % dest_file, 3)
 | 
			
		||||
                self._cfg.debug.stdout(f'{dest_file} differs from generated config', 3)
 | 
			
		||||
                return True
 | 
			
		||||
        fp1.close()
 | 
			
		||||
        fp2.close()
 | 
			
		||||
        self._cfg.debug.stdout("%s is the same, return false" % dest_file, 3)
 | 
			
		||||
        self._cfg.debug.stdout(f'{dest_file} is the same as generated config', 3)
 | 
			
		||||
        return False
 | 
			
		||||
 | 
			
		||||
    def user_config_generated(self, filename):
 | 
			
		||||
@@ -224,18 +225,18 @@ class Userconfig:
 | 
			
		||||
    def backup_file(self, filename):
 | 
			
		||||
        """make backup of filename, returns True if backup is successful, False else"""
 | 
			
		||||
        if os.path.isfile(filename):
 | 
			
		||||
            self._cfg.debug.stdout("%s exists, finding backup name." % filename, 3)
 | 
			
		||||
            self._cfg.debug.stdout(f'{filename} exists, finding backup name.', 3)
 | 
			
		||||
            backup_name = filename+".userconfig."+time.strftime("%F")
 | 
			
		||||
            test_backup_name = backup_name
 | 
			
		||||
            counter = 0
 | 
			
		||||
            while os.path.isfile(test_backup_name):
 | 
			
		||||
                counter += 1
 | 
			
		||||
                test_backup_name = backup_name+"."+str(counter)
 | 
			
		||||
            self._cfg.debug.stdout("Renaming %s to %s" % (filename, test_backup_name), 1)
 | 
			
		||||
            os.rename(filename, test_backup_name)
 | 
			
		||||
            self._cfg.debug.stdout(f'Renamed {filename} to {test_backup_name}', 1, 'SUCCESS')
 | 
			
		||||
            return True
 | 
			
		||||
        else:
 | 
			
		||||
            self._cfg.debug.stdout("%s does not exist, do not need backup." % filename, 3)
 | 
			
		||||
            self._cfg.debug.stdout(f'{filename} does not exist, do not need backup.', 3)
 | 
			
		||||
        return False
 | 
			
		||||
 | 
			
		||||
    def copy_file(self, sourcefile, dest_file):
 | 
			
		||||
@@ -243,11 +244,10 @@ class Userconfig:
 | 
			
		||||
 | 
			
		||||
        if os.path.isfile(sourcefile):
 | 
			
		||||
            # sourcefile exists
 | 
			
		||||
            self._cfg.debug.stdout("Source file %s exists, proceeding with copy." % sourcefile, 3)
 | 
			
		||||
            self._cfg.debug.stdout(f'Source file {sourcefile} exists, proceeding with copy.', 3)
 | 
			
		||||
            if not os.path.isfile(dest_file) or os.access(dest_file, os.W_OK):
 | 
			
		||||
                self._cfg.debug.stdout("Copying %s to %s" % (sourcefile, dest_file), 1)
 | 
			
		||||
                shutil.copy(sourcefile, dest_file)
 | 
			
		||||
                return True
 | 
			
		||||
            else:
 | 
			
		||||
                self._cfg.debug.stdout("Destination file %s does not exist or is not writable." % dest_file, 3)
 | 
			
		||||
                self._cfg.debug.stdout('Destination {dest_file} is not a file or not writable.', 0, 'ERROR')
 | 
			
		||||
        return False
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user