ocrd workspace: file paths should be made relative to self.directory

[bertsky]

On the CLI, the user expects that paths are resolved once (on the input side) and from then onwards everything is automatically done relative to the workspace (whenever possible). So if a file path is absolute, then its workspace prefix gets removed regarding METS FLocat. Or if it is relative, then it is relative to the CWD, but gets resolved relative to the workspace.

Unfortunately, that's not what we have implemented yet, esp. if you combine with an overall -d path/to/workspace (so CWD is not equal workspace directory).

For example, in add_file, we currently have:

core/src/ocrd/cli/workspace.py

Lines 221 to 222 in 2993010

	if not isabs(fname) and exists(join(ctx.directory, fname)):
	fname = join(ctx.directory, fname)

Meaning, the workspace directory gets added, with no regard to the caller's CWD.

Another example is in bulk_add, where we do:

core/src/ocrd/cli/workspace.py

Lines 375 to 381 in 2993010

	if src_path_option:
	src_path = src_path_option
	for group_name in group_dict:
	src_path = src_path.replace('{{ %s }}' % group_name, group_dict[group_name])
	srcpath = Path(src_path)
	else:
	srcpath = file_path

Here, again, no difference is made between CWD and self.directory.

In the latter case (bulk-add), what makes things worse is that the glob pattern gets treated verbatim if empty:

core/src/ocrd/cli/workspace.py

Lines 333 to 335 in 2993010

	expanded = glob(fglob)
	if not expanded:
	file_paths += [Path(fglob)]

So if one tries to compensate for the above path resolving issue by passing a glob relative to the workspace, then that itself will break the METS with a verbatim asterisk path entry:

ocrd workspace -d nd1967-12-14_var1/ bulk-add -r "TEXTRACT_PAGE/(?P<page>.*)[.]xml" -G TEXTRACT_PAGE -g '{{ page }}' "TEXTRACT_PAGE/*.xml"
INFO ocrd.cli.workspace.bulk-add - [   1/1] TEXTRACT_PAGE/*.xml

[bertsky]

Same is true for the --mets-server-url argument: relative paths don't work (not relative to the workspace and not relative to CWD).

(Again, the user expectation is that whatever resolves at startup time from the user's CWD should be kept.)