Skip to content

Support adding "disambiguation suffixes" to filenames on conflicts, instead of overwriting or failing #29

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

Open
Samasaur1 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Support adding "disambiguation suffixes" to filenames on conflicts, instead of overwriting or failing #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2c723f
support passing a suffix to disambiguate fics without overwriting
Samasaur1 May 27, 2025
4366223
allow specifying disambiguation suffix
Samasaur1 May 27, 2025
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
9 changes: 6 additions & 3 deletions fichub_cli/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ def default(
force: bool = typer.Option(
False, "--force", help="Force overwrite of an existing file", is_flag=True),

disamgibuation_suffix = typer.Option(
"", "--disambiguation-suffix", help="Suffix to use when two different fics have the same filename"),

supported_sites: bool = typer.Option(
False, "-ss", "--supported-sites", help="List of supported sites", is_flag=True),

Expand Down Expand Up @@ -136,19 +139,19 @@ def default(

format_type = get_format_type(format)
if infile:
fic = FetchData(format_type=format_type, out_dir=out_dir, force=force,
fic = FetchData(format_type=format_type, out_dir=out_dir, force=force or (disamgibuation_suffix if not disamgibuation_suffix == "" else False),
debug=debug, changelog=changelog,
automated=automated, verbose=verbose)
fic.get_fic_with_infile(infile)

elif list_url:
fic = FetchData(format_type=format_type, out_dir=out_dir, force=force,
fic = FetchData(format_type=format_type, out_dir=out_dir, force=force or (disamgibuation_suffix if not disamgibuation_suffix == "" else False),
debug=debug, changelog=changelog,
automated=automated, verbose=verbose)
fic.get_fic_with_list(list_url)

elif url:
fic = FetchData(format_type=format_type, out_dir=out_dir, force=force,
fic = FetchData(format_type=format_type, out_dir=out_dir, force=force or (disamgibuation_suffix if not disamgibuation_suffix == "" else False),
debug=debug, automated=automated, verbose=verbose)
fic.get_fic_with_url(url)

Expand Down
107 changes: 69 additions & 38 deletions fichub_cli/utils/processing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ def check_url(url: str, debug: bool = False,


def save_data(out_dir: str, files: dict,
debug: bool, force: bool,
debug: bool, force: bool | str,
exit_status: int, automated: bool) -> int:

exit_status = url_exit_status = 0
Expand All @@ -101,12 +101,25 @@ def save_data(out_dir: str, files: dict,
with open(os.path.join(app_dirs.user_data_dir, "config.json"), 'r') as f:
app_config = json.load(f)

if not app_config["filename_format"] == "":
file_name= construct_filename(file_name,filename_formats,app_config["filename_format"])

# clean the filename
file_name = re.sub(r"[\\/:\"*?<>|]+", "", file_name, re.MULTILINE)
ebook_file = os.path.join(out_dir, file_name)
def build_full_file_path(file_name: str, filename_formats: dict, filename_format: str, out_dir: str, suffix: str):
if not filename_format == "":
if suffix == "":
name = construct_filename(file_name, filename_formats, filename_format)
else:
name = construct_filename(file_name, filename_formats, filename_format + suffix)
else:
if suffix == "":
name = file_name
else:
base_name = pathlib.Path(file_name).with_suffix('')
templated = construct_filename(file_name, filename_formats, suffix)
name = base_name + templated

name = re.sub(r"[\\/:\"*?<>|]+", "", name, re.MULTILINE)
return os.path.join(out_dir, name)

filename_format = app_config["filename_format"]
ebook_file = build_full_file_path(file_name, filename_formats, filename_format, out_dir, "")

try:
hash_flag = check_hash(ebook_file,file_data["hash"])
Expand All @@ -115,38 +128,56 @@ def save_data(out_dir: str, files: dict,
hash_flag = False


if os.path.exists(ebook_file) and force is False and hash_flag is True:
exit_status = url_exit_status = 1
if debug:
logger.warning(
"The md5 hash of the local file & the remote file are the same.")

logger.error(
f"{ebook_file} is already the latest version. Skipping download. Use --force flag to overwrite.")

tqdm.write(
Fore.RED +
f"{ebook_file} is already the latest version. Skipping download." +
Style.RESET_ALL + Fore.CYAN + " Use --force flag to overwrite.")

else:
if force and debug:
logger.warning(
f"--force flag was passed. Overwriting {ebook_file}")

fic = FicHub(debug, automated, exit_status)
fic.get_fic_data(file_data["download_url"])

try:
with open(ebook_file, "wb") as f:
if os.path.exists(ebook_file):
if force is True:
# --force, always overwrite (fallthrough)
if debug:
logger.warning(
f"--force flag was passed. Overwriting {ebook_file}")
elif force is False:
# no --force, only overwrite if out of date
if hash_flag is True:
exit_status = url_exit_status = 1
if debug:
logger.info(
f"Saving {ebook_file}")
f.write(fic.response_data.content)
downloaded_log(debug, ebook_file)
except FileNotFoundError:
tqdm.write(Fore.RED + "Output directory doesn't exist. Exiting!")
logger.warning(
"The md5 hash of the local file & the remote file are the same.")

logger.error(
f"{ebook_file} is already the latest version. Skipping download. Use --force flag to overwrite.")

tqdm.write(
Fore.RED +
f"{ebook_file} is already the latest version. Skipping download." +
Style.RESET_ALL + Fore.CYAN + " Use --force flag to overwrite.")
continue # don't overwrite if up to date
elif isinstance(force, str):
# --force="file_suffix", modify filename and write
ebook_file = build_full_file_path(file_name, filename_formats, filename_format, out_dir, force)
if debug:
logger.warning(f"--force flag passed with file suffix {force}")
else:
# Invalid argument
logger.error(f"--force flag has invalid argument {force}")
sys.exit(1)
# continue
else:
pass
# Nothing special to do if the filename doesn't exist

# download file
fic = FicHub(debug, automated, exit_status)
fic.get_fic_data(file_data["download_url"])

try:
with open(ebook_file, "wb") as f:
if debug:
logger.info(
f"Saving {ebook_file}")
f.write(fic.response_data.content)
downloaded_log(debug, ebook_file)
except FileNotFoundError:
tqdm.write(Fore.RED + "Output directory doesn't exist. Exiting!")
sys.exit(1)

return exit_status, url_exit_status

Expand Down Expand Up @@ -432,4 +463,4 @@ def output_log_cleanup(app_dirs):
elif config["delete_output_log"] == "true":
os.remove("output.log")
elif config["delete_output_log"] == "false":
pass
pass