1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
|
#!/usr/bin/env python3
# holidays
# --------
# A fast, efficient Python library for generating country, province and state
# specific sets of holidays on the fly. It aims to make determining whether a
# specific date is a holiday as fast and flexible as possible.
#
# Authors: Vacanza Team and individual contributors (see CONTRIBUTORS file)
# dr-prodigy <dr.prodigy.github@gmail.com> (c) 2017-2023
# ryanss <ryanssdev@icloud.com> (c) 2014-2017
# Website: https://github.com/vacanza/holidays
# License: MIT (see LICENSE file)
# ruff: noqa: T201
import argparse
import json
import os
import re
import sys
import time
from typing import Optional
import requests
from requests.adapters import HTTPAdapter
from urllib3.util.retry import Retry
EXTENSIONS_TO_SCAN = [".py", ".po"]
FIND_URL_PATTERN = re.compile(r'https?://[^\s<>"]+')
IGNORED_DIRECTORIES = ["__pycache__"]
IGNORE_DOMAINS = [
r"archive\.is",
r"archive\.org",
r"archive\.ph",
r"archive\.today",
r"docs\.python\.org",
r"github\.com",
r"iso\.org",
r"loc\.gov",
r"namu\.wiki",
r"semver\.org",
r"web\.archive\.org",
r"wikipedia\.org",
r"wikisource\.org",
]
IGNORE_URL_REGEX = re.compile(r"|".join(IGNORE_DOMAINS))
# Characters that can be part of a URL - used to avoid replacing URLs that are part of larger URLs
URL_BOUNDARY_CHARS = r"a-zA-Z0-9_/.-"
CDX_API_URL = "https://web.archive.org/cdx/search/cdx"
SAVE_API_URL = "https://web.archive.org/save"
REQUEST_TIMEOUT = 60
USER_AGENT = "https://github.com/vacanza/holidays (python)"
def get_session():
session = requests.Session()
retries = Retry(
total=3,
backoff_factor=1,
status_forcelist=[429, 500, 502, 503, 504],
allowed_methods=["HEAD", "GET"],
)
adapter = HTTPAdapter(max_retries=retries)
session.mount("http://", adapter) # NOSONAR
session.mount("https://", adapter)
return session
def find_hyperlinks_in_file(filepath: str) -> list[str]:
"""
Finds all hyperlinks within a single text file, respecting IGNORE_URL_PATTERNS.
"""
try:
with open(filepath, encoding="utf-8") as file:
file_content = file.read()
except Exception as e:
print(f"Warning: Could not read file {filepath} due to: {e}", file=sys.stderr)
return []
try:
found_urls = {
match.rstrip(")")
for match in FIND_URL_PATTERN.findall(file_content)
if match and not IGNORE_URL_REGEX.search(match)
}
return sorted(found_urls)
except Exception as e:
print(f"Warning: Error processing file {filepath}: {e}", file=sys.stderr)
return []
def scan_directory_for_links(
directory_to_scan: str, allowed_extensions: list[str]
) -> tuple[dict[str, list[str]], set[str]]:
"""
Walks a directory, finds hyperlinks in specified file types.
Returns:
- A dictionary mapping {filepath: [urls]}
- A set of all unique URLs found across all files.
"""
print(f"Scanning directory: {directory_to_scan}")
print(f"Looking for files with extensions: {', '.join(allowed_extensions)}")
if not os.path.isdir(directory_to_scan):
print(
f"Error: Specified path '{directory_to_scan}' is not a valid directory.",
file=sys.stderr,
)
return {}, set()
file_to_urls_map: dict[str, list[str]] = {}
all_unique_urls: set[str] = set()
for root, _, files in os.walk(directory_to_scan):
if any(ignored in root.split(os.sep) for ignored in IGNORED_DIRECTORIES):
continue
for filename in files:
if filename.lower().endswith(tuple(allowed_extensions)):
full_path = os.path.join(root, filename)
print(f" Processing: {full_path}")
urls_in_file = find_hyperlinks_in_file(full_path)
if urls_in_file:
file_to_urls_map[full_path] = urls_in_file
all_unique_urls.update(urls_in_file)
print(
f"\nScan complete. Found links in {len(file_to_urls_map)} file(s)."
f" Found {len(all_unique_urls)} unique URLs."
)
return file_to_urls_map, all_unique_urls
def check_availability_api(url: str, session: requests.Session) -> Optional[str]:
"""
Checks the Wayback Machine CDX API for the latest available capture.
Returns the Wayback URL of the latest capture, or None if not found or error.
"""
try:
params: dict[str, str | int] = {
"url": url,
"output": "json",
"limit": -1,
"fastLatest": "true",
"filter": "statuscode:200",
}
response = session.get(
CDX_API_URL,
params=params,
headers={"User-Agent": USER_AGENT},
)
response.raise_for_status()
data = response.json()
if len(data) > 1:
# The first row is the header, the rest are captures
latest = data[1]
timestamp = latest[1]
original = latest[2]
wayback_url = f"https://web.archive.org/web/{timestamp}/{original}"
return wayback_url
except requests.exceptions.Timeout:
print(f"\tError: CDX API request timed out for {url}", file=sys.stderr)
except requests.exceptions.RequestException as e:
status_code = getattr(e.response, "status_code", "N/A")
if isinstance(e, json.JSONDecodeError):
print(
f"\tError: CDX API returned non-JSON response for {url}. Status: {status_code}",
file=sys.stderr,
)
else:
print(
f"\tError checking CDX API for {url} (Status: {status_code}): {e}",
file=sys.stderr,
)
except Exception as e:
print(f"\tUnexpected error during CDX API check for {url}: {e}", file=sys.stderr)
return None
def archive_url(url: str, session: requests.Session) -> None:
"""
Submits a URL to the Wayback Machine save API using POST.
Returns nothing; success is determined by subsequent availability check.
"""
print(f"\tSubmitting for archive: {url}")
try:
response = session.post(
SAVE_API_URL,
data={"url": url},
headers={"User-Agent": USER_AGENT},
timeout=REQUEST_TIMEOUT,
allow_redirects=True,
)
response.raise_for_status()
print(f"\tArchive submission complete (status: {response.status_code})")
except requests.exceptions.Timeout:
print(f"\tError: Archive request timed out for {url}", file=sys.stderr)
except requests.exceptions.RequestException as e:
print(f"\tError archiving {url}: {e}", file=sys.stderr)
def replace_urls_in_file(filepath: str, url_map: dict[str, str], urls_in_file: list[str]):
"""
Replaces original URLs with their Wayback Machine counterparts in a file.
Uses the provided valid url_map {original_url: wayback_url}.
Only replaces URLs specifically listed in urls_in_file for this path.
Returns True if replacements were made, False otherwise.
"""
try:
with open(filepath, encoding="utf-8") as file:
content = file.read()
except Exception as e:
print(f"Error reading file for replacement: {filepath} - {e}", file=sys.stderr)
return False
modified_content = content
replacements_made = 0
valid_replacements_for_file = {
original_url: url_map[original_url]
for original_url in urls_in_file
if original_url in url_map
}
if not valid_replacements_for_file:
return False
print(f" Attempting replacements in: {filepath}")
for original_url, wayback_url in valid_replacements_for_file.items():
escaped_original_url = re.escape(original_url)
# pattern that matches the URL when it's not part of a larger URL
# negative lookbehind: ensure URL doesn't follow a character that could be part of a URL
# negative lookahead: ensure URL isn't followed by a character that could be part of a URL
pattern = f"(?<![{URL_BOUNDARY_CHARS}]){escaped_original_url}(?![{URL_BOUNDARY_CHARS}])"
new_content, count = re.subn(pattern, wayback_url, modified_content)
if count > 0:
modified_content = new_content
replacements_made += count
print(f" Replaced '{original_url}' ({count}x)")
if replacements_made > 0:
try:
with open(filepath, "w", encoding="utf-8") as file:
file.write(modified_content)
print(f" Successfully wrote {replacements_made} replacement(s) to {filepath}")
return True
except Exception as e:
print(f"Error writing modified file: {filepath} - {e}", file=sys.stderr)
return False
else:
return False
def check_archive_urls_in_file(
urls_in_file: list[str],
url_map: dict[str, Optional[str]],
session: requests.Session,
archive_policy: str,
):
file_url_map: dict[str, str] = {}
for url in urls_in_file:
if url in url_map:
wayback_url = url_map[url]
else:
existing_capture = check_availability_api(url, session)
wayback_url = None
if existing_capture:
if archive_policy == "if-missing" or archive_policy == "never":
print(f"\tUsing existing capture for {url} (archive_policy={archive_policy}).")
wayback_url = existing_capture
elif archive_policy == "always":
print(
f"\tIgnoring existing capture for {url} (archive_policy=always), "
f"will attempt archive."
)
archive_url(url, session)
wayback_url = check_availability_api(url, session)
else:
if archive_policy == "never":
print(
f"\tExisting capture not found for {url}, not archiving"
f" (archive_policy=never)."
)
else:
archive_url(url, session)
wayback_url = check_availability_api(url, session)
url_map[url] = wayback_url
if wayback_url:
file_url_map[url] = wayback_url
return file_url_map
def run_show_only_mode(files_to_urls_data: dict[str, list[str]]) -> int:
"""
Runs the show-only mode which just displays URLs without checking or modifying.
Args:
files_to_urls_data: Dictionary mapping files to their URLs
Returns:
Exit code (0 for success, 1 if URLs are found)
"""
print("Check-only mode: Printing all URLs that would need archiving")
if files_to_urls_data:
print("FOUND: URLs that need archiving")
for source_file, urls_in_file in files_to_urls_data.items():
print(f"\nFile: {source_file}")
for url in urls_in_file:
print(f" {url}")
exit_code = 1
else:
print("SUCCESS: No URLs to archive")
exit_code = 0
return exit_code
def run_check_liveness_mode(files_to_urls_data: dict[str, list[str]]) -> int:
"""
Checks if URLs are alive by sending HTTP HEAD requests.
Args:
files_to_urls_data: Dictionary mapping files to their URLs
Returns:
Exit code (0 if all links alive, 1 if any dead links found)
"""
print("Liveness check mode: Checking if URLs are still alive")
session = get_session()
total_urls = 0
dead_count = 0
for source_file, urls_in_file in files_to_urls_data.items():
print(f"Checking file: {source_file}")
for url in urls_in_file:
total_urls += 1
try:
response = session.head(
url,
headers={"User-Agent": USER_AGENT},
timeout=REQUEST_TIMEOUT // 4, # use shorter timeout for HEAD requests
allow_redirects=True,
)
response.raise_for_status()
except Exception as e:
print(f" DEAD: {url} - {e}")
dead_count += 1
print("\n--- Liveness Check Summary ---")
print(f"Total URLs checked: {total_urls}")
print(f"Dead links found: {dead_count}")
return 1 if dead_count > 0 else 0
def run_archive_mode(
files_to_urls_data: dict[str, list[str]],
archive_policy: str,
) -> int:
"""
Archives URLs via Wayback Machine and replaces them in the files.
Args:
files_to_urls_data: Dictionary mapping files to their URLs
archive_policy: Policy for archiving ("if-missing", "always", or "never")
Returns:
Exit code (always 0 for success)
"""
if not files_to_urls_data:
print("No URLs found or no files processed. Exiting.")
return 0
print("\n--- Stage: Per-File Processing ---")
session = get_session()
url_map: dict[str, Optional[str]] = {}
total_files_processed = 0
total_files_modified = 0
for source_file, urls_in_file in files_to_urls_data.items():
if not source_file or not os.path.exists(source_file):
print(
f"Warning: Skipping replacement for non-existent file: {source_file}",
file=sys.stderr,
)
continue
if not urls_in_file:
continue
print(f"\nProcessing file: {source_file}")
file_url_map = check_archive_urls_in_file(urls_in_file, url_map, session, archive_policy)
total_files_processed += 1
if replace_urls_in_file(source_file, file_url_map, urls_in_file):
total_files_modified += 1
print(f"Processed {total_files_processed} files. Modified {total_files_modified} files.")
return 0
def main() -> None:
parser = argparse.ArgumentParser(
description="Find, check/archive via Wayback Machine, and replace URLs in project files.",
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
)
parser.add_argument(
"--archive-policy",
choices=["if-missing", "always", "never"],
default="if-missing",
help="Archiving policy: 'if-missing' (only archive if no capture exists), "
"'always' (always submit for archiving), 'never' (only search for "
"existing captures)",
)
mode_group = parser.add_mutually_exclusive_group()
mode_group.add_argument(
"--show-only",
action="store_true",
help="Only print URLs that would need to be archived without checking or modifying "
"anything. Exits with code 1 if any URLs are found.",
)
mode_group.add_argument(
"--check-liveness",
action="store_true",
help="Check if original URLs are still alive by sending HTTP HEAD requests. "
"Prints dead links and exits with code 1 if any are found.",
)
args = parser.parse_args()
start_time_total = time.time()
directory = os.path.abspath(os.path.join(__file__, "..", "..", "holidays"))
files_to_urls_data, _ = scan_directory_for_links(directory, EXTENSIONS_TO_SCAN)
if args.show_only:
exit_code = run_show_only_mode(files_to_urls_data)
elif args.check_liveness:
exit_code = run_check_liveness_mode(files_to_urls_data)
else:
exit_code = run_archive_mode(files_to_urls_data, args.archive_policy)
end_time_total = time.time()
print("-" * 30)
print(f"Script finished in {end_time_total - start_time_total:.2f} seconds.")
print("Done.")
sys.exit(exit_code)
if __name__ == "__main__":
main()
|