Skip to content

Use updated, more permissive, regex for file and directory names #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gkreitz merged 1 commit into from
Nov 28, 2025
Merged

Use updated, more permissive, regex for file and directory names #371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions problemtools/verifyproblem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1734,7 +1734,6 @@ def _recompute_jobs(self) -> None:


class Submissions(ProblemPart):
_SUB_REGEXP = re.compile(r'^[a-zA-Z0-9][a-zA-Z0-9_.-]*[a-zA-Z0-9](\.c\+\+)?$')
# (verdict, directory, required)
_VERDICTS: list[tuple[Verdict, str, bool]] = [
('AC', 'accepted', True),
Expand All @@ -1754,7 +1753,6 @@ def setup(self):
self._submissions[acr] = run.find_programs(
os.path.join(srcdir, verdict[1]),
language_config=self.problem.language_config,
pattern=Submissions._SUB_REGEXP,
work_dir=self.problem.tmpdir,
include_dir=os.path.join(self.problem.probdir, 'include'),
)
Expand Down Expand Up @@ -2091,10 +2089,8 @@ def _check_symlinks(self):
)

def _check_file_and_directory_names(self):
filename_regex = re.compile(r'^[a-z0-9][a-z0-9_.-]{0,253}[a-z0-9]$', re.I)
directory_regex = re.compile(r'^[a-z0-9]([a-z0-9_-]{0,253}[a-z0-9])?$', re.I)
regex = re.compile(r'^[a-zA-Z0-9_][a-zA-Z0-9_.-]{0,254}$')
Copy link
Contributor

@pehrsoderman pehrsoderman Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I understand the logic, we might want a somewhat more descriptive variable name ;)

Copy link
Contributor Author

@gkreitz gkreitz Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine. It's a local variable in a function called "_check_file_and_directory_names".


# Adding some pragmatic custom rules until https://github.com/Kattis/problem-package-format/issues/453 has resolved
def _special_case_allowed_files(file: str, reldir: str) -> bool:
return file == '.gitignore' or (file == '.timelimit' and reldir == os.path.basename(self.probdir))

Expand All @@ -2105,13 +2101,11 @@ def _special_case_allowed_dirs(directory: str, reldir: str) -> bool:
# Path of the directory we're in, starting with problem shortname. Only used for nicer error messages.
reldir = os.path.relpath(root, os.path.dirname(self.probdir))
for file in files:
if not filename_regex.match(file) and not _special_case_allowed_files(file, reldir):
self.error(f"Invalid file name '{file}' in {reldir} (should match {filename_regex.pattern} ignoring case)")
if not regex.match(file) and not _special_case_allowed_files(file, reldir):
self.error(f"Invalid file name '{file}' in {reldir}, should match {regex.pattern}")
for directory in dirs:
if not directory_regex.match(directory) and not _special_case_allowed_dirs(directory, reldir):
self.error_in_2023_07(
f"Invalid directory name '{directory}' in {reldir} (should match {directory_regex.pattern} ignoring case)"
)
if not regex.match(directory) and not _special_case_allowed_dirs(directory, reldir):
self.error(f"Invalid directory name '{directory}' in {reldir}, should match {regex.pattern}")

def bail_on_error(self) -> bool:
return self._args.bail_on_error
Expand Down