from __future__ import annotations
from pathlib import Path
from ansible.errors import AnsibleError
from ansible.plugins.lookup import LookupBase
class LookupModule(LookupBase):
"""
Return a cache-busting string based on the LOCAL file's mtime.
Usage (single path → string via Jinja):
{{ lookup('local_mtime_qs', '/path/to/file.css') }}
-> "?version=1712323456"
Options:
param (str): query parameter name (default: "version")
mode (str): "qs" (default) → returns "?="
"epoch" → returns ""
Multiple paths (returns list, one result per term):
{{ lookup('local_mtime_qs', '/a.js', '/b.js', param='v') }}
"""
def run(self, terms, variables=None, **kwargs):
if not terms:
return []
param = kwargs.get("param", "version")
mode = kwargs.get("mode", "qs")
if mode not in ("qs", "epoch"):
raise AnsibleError("local_mtime_qs: 'mode' must be 'qs' or 'epoch'")
results = []
for term in terms:
path = str(Path(str(Path(str(term)).expanduser())).resolve())
if not Path(path).exists():
raise AnsibleError(f"local_mtime_qs: file does not exist: {path}")
if not Path(path).is_file():
raise AnsibleError(f"local_mtime_qs: not a regular file: {path}")
try:
mtime = int(Path(path).stat().st_mtime)
except OSError as e:
raise AnsibleError(f"local_mtime_qs: cannot stat '{path}': {e}") from e
if mode == "qs":
results.append(f"?{param}={mtime}")
else:
results.append(str(mtime))
return results