Action: {esc_html(action)}
Project: {esc_html(project)}
{POSTAMBLE}") +@app.post("/project/{project:path}") +def project_post_dispatch( + project: str, + a: Annotated[str | None, Query(alias="a")] = None, + key: Annotated[str | None, Query(alias="key")] = None, + value: Annotated[str | None, Query(alias="value")] = None, +): + if a != "set_config": + raise HTTPException(status_code=400, detail="Unknown POST action") + return project_git_config_set_post(project, key or "", value) + + if __name__ == "__main__": import uvicorn diff --git a/pygitweb/pyproject.toml b/pygitweb/pyproject.toml index 5c9a416..eb2d8d8 100644 --- a/pygitweb/pyproject.toml +++ b/pygitweb/pyproject.toml @@ -25,7 +25,7 @@ packages = ["pygitweb"] pygitweb = "." [tool.setuptools.package-data] -pygitweb = ["templates/**/*", "static/**/*"] +pygitweb = ["templates/**/*", "static/**/*", "data/**/*"] [tool.uv.sources] distgit = { workspace = true } diff --git a/pygitweb/settings_project.py b/pygitweb/settings_project.py new file mode 100644 index 0000000..dfde617 --- /dev/null +++ b/pygitweb/settings_project.py @@ -0,0 +1,234 @@ +""" +Per-project git config UI backed by config-options.json (all sections except color and alias). +""" + +from __future__ import annotations + +import json +from contextlib import suppress +from pathlib import Path +from typing import Any, Final +from urllib.parse import quote + +import pygit2 +from fastapi import HTTPException +from fastapi.responses import HTMLResponse, JSONResponse + +from pygitweb import config +from pygitweb.config import EXPORT_OK, PROJECTROOT, STRICT_EXPORT +from pygitweb.formatting import esc_html +from pygitweb.git_helpers import open_repo +from pygitweb.projects import git_get_projects_list +from pygitweb.settings import GIT_CONFIG_LEVEL_LOCAL, GIT_CONFIG_LEVEL_WORKTREE +from pygitweb.templates_env import POSTAMBLE, PREAMBLE, env +from pygitweb.validation import is_valid_project + +_GIT_CONFIG_OPTIONS_PATH: Final[Path] = Path(__file__).resolve().parent / "data" / "config-options.json" + +_EXCLUDED_CONFIG_SECTIONS: Final[frozenset[str]] = frozenset({"color", "alias"}) + +_ORDERED_GIT_CONFIG_OPTIONS: list[dict[str, Any]] = [] +_OPTION_BY_KEY: dict[str, dict[str, Any]] = {} + + +def init_git_config_options_registry() -> None: + """Load config-options.json and index allowed options (startup). Skips [color], [alias], and subsection '*'.""" + global _ORDERED_GIT_CONFIG_OPTIONS, _OPTION_BY_KEY + raw = json.loads(_GIT_CONFIG_OPTIONS_PATH.read_text(encoding="utf-8")) + if not isinstance(raw, list): + raise RuntimeError("config-options.json must be a JSON array") + by_key: dict[str, dict[str, Any]] = {} + ordered: list[dict[str, Any]] = [] + for item in raw: + if not isinstance(item, dict): + continue + sec = item.get("section") + if not isinstance(sec, str) or sec in _EXCLUDED_CONFIG_SECTIONS: + continue + if item.get("subsection") == "*": + continue + try: + k = _git_config_key(item) + except (KeyError, TypeError, ValueError): + continue + if k in by_key: + continue + by_key[k] = item + ordered.append(item) + _ORDERED_GIT_CONFIG_OPTIONS = ordered + _OPTION_BY_KEY = by_key + + +def _git_config_key(item: dict[str, Any]) -> str: + section = str(item["section"]) + subsection = item.get("subsection") + leaf = item.get("configName") or item.get("name") + if not isinstance(leaf, str) or not leaf: + raise ValueError("invalid config option entry: missing name") + if subsection and subsection != "*": + return f"{section}.{subsection}.{leaf}" + return f"{section}.{leaf}" + + +def _project_in_list(project: str) -> bool: + lst = git_get_projects_list( + filter_path="", + paranoid=STRICT_EXPORT, + export_ok=EXPORT_OK, + ) + return any(p.get("path") == project for p in lst) + + +def _validate_project_or_404(project: str | None) -> str: + if not project: + raise HTTPException(status_code=400, detail="Project needed") + if not is_valid_project( + project, + PROJECTROOT, + EXPORT_OK, + STRICT_EXPORT, + _project_in_list, + ): + raise HTTPException(status_code=404, detail="No such project") + return project + + +def _is_option_type(t: str) -> bool: + return t == "select" + + +def _is_textual_type(t: str) -> bool: + return t in ("text", "email") or not _is_option_type(t) + + +def _repo_config_local_worktree_values(repo: pygit2.Repository) -> dict[str, str]: + """ + Config values from LOCAL (5) and WORKTREE (6) only; last value wins per name. + Same iteration rules as settings._get_project_config_entries. + """ + cfg = repo.config + by_name: dict[str, str] = {} + for entry in cfg: + if entry.level not in (GIT_CONFIG_LEVEL_LOCAL, GIT_CONFIG_LEVEL_WORKTREE): + continue + by_name[entry.name] = entry.value + return by_name + + +def _field_dict(item: dict[str, Any], local_worktree: dict[str, str]) -> dict[str, Any]: + key = _git_config_key(item) + current = local_worktree.get(key, "") + opt_type = str(item.get("type") or "text") + return { + "git_key": key, + "display_name": str(item.get("displayName") or item.get("name") or key), + "description": str(item.get("description") or ""), + "control_kind": "select" if _is_option_type(opt_type) else "text", + "current": current, + "options": list(item["options"]) if isinstance(item.get("options"), list) else [], + } + + +def _group_options_by_section_and_subsection( + items: list[dict[str, Any]], +) -> list[dict[str, Any]]: + """Same grouping as gitconfig-generator: section → subsection → options (order preserved).""" + section_order: list[str] = [] + section_subsection_order: dict[str, list[str]] = {} + buckets: dict[str, dict[str, list[dict[str, Any]]]] = {} + for item in items: + sec = str(item.get("section") or "") + raw_sub = item.get("subsection") + sub = "" if raw_sub in (None, "") else str(raw_sub) + if sub == "*": + continue + if sec not in buckets: + buckets[sec] = {} + section_order.append(sec) + section_subsection_order[sec] = [] + if sub not in buckets[sec]: + buckets[sec][sub] = [] + section_subsection_order[sec].append(sub) + buckets[sec][sub].append(item) + out: list[dict[str, Any]] = [] + for sec in section_order: + subs: list[dict[str, Any]] = [] + for sub in section_subsection_order[sec]: + subs.append({"subsection": sub, "items": buckets[sec][sub]}) + out.append({"section": sec, "subsections": subs}) + return out + + +def project_git_config_page(project: str) -> HTMLResponse: + """HTML page listing git config options; + Values shown are LOCAL + WORKTREE only (see settings._get_project_config_entries).""" + project = _validate_project_or_404(project) + if not _OPTION_BY_KEY: + raise HTTPException(status_code=500, detail="Git config registry not loaded") + repo = open_repo(project) + local_worktree = _repo_config_local_worktree_values(repo) + grouped = _group_options_by_section_and_subsection(_ORDERED_GIT_CONFIG_OPTIONS) + sections: list[dict[str, Any]] = [] + for sec in grouped: + subsections_out: list[dict[str, Any]] = [] + for sub in sec["subsections"]: + fields = [_field_dict(item, local_worktree) for item in sub["items"]] + subsections_out.append({"subsection": sub["subsection"], "fields": fields}) + sections.append({"section": sec["section"], "subsections": subsections_out}) + pre = PREAMBLE.render( + title=f"{esc_html(config.SITE_NAME)} - Git config — {esc_html(project)}", + site_name=config.SITE_NAME, + ) + project_qp = quote(project, safe="/") + body = env.get_template("project_git_config.html").render( + project=project, + project_esc=esc_html(project), + summary_url=f"/project/{project_qp}", + set_config_url=f"/project/{project_qp}?a=set_config", + sections=sections, + ) + return HTMLResponse(f"{pre}{body}{POSTAMBLE}") + + +def _normalize_set_value(opt: dict[str, Any], raw: str) -> str: + opt_type = str(opt.get("type") or "text") + stripped = raw.strip() + if not stripped: + return "" + if _is_option_type(opt_type): + options = opt.get("options") + if not isinstance(options, list) or stripped not in [str(x) for x in options]: + raise HTTPException( + status_code=400, + detail="value must be one of the allowed options for this key", + ) + return stripped + if not _is_textual_type(opt_type): + raise HTTPException(status_code=400, detail="unsupported config type for this key") + return raw + + +def project_git_config_set_post(project: str, key: str, value: str | None = None) -> JSONResponse: + """Set or unset a single local config key validated against config-options.json.""" + project = _validate_project_or_404(project) + if not _OPTION_BY_KEY: + raise HTTPException(status_code=500, detail="Git config registry not loaded") + lookup = (key or "").strip() + if not lookup: + raise HTTPException(status_code=400, detail="key is required") + opt = _OPTION_BY_KEY.get(lookup) + if opt is None: + raise HTTPException(status_code=400, detail="unknown or unsupported config key") + raw_val = value if value is not None else "" + normalized = _normalize_set_value(opt, raw_val) + repo = open_repo(project) + cfg = repo.config + try: + if not normalized: + with suppress(KeyError): + del cfg[lookup] + else: + cfg[lookup] = normalized + except (pygit2.GitError, TypeError, ValueError) as e: + raise HTTPException(status_code=400, detail=f"could not update config: {e}") from e + return JSONResponse({"ok": True}) diff --git a/pygitweb/static/main.css b/pygitweb/static/main.css index 502b3d3..c4d7c21 100644 --- a/pygitweb/static/main.css +++ b/pygitweb/static/main.css @@ -793,3 +793,160 @@ tbody tr { resize: vertical; } } + +/* Git config page: collapsible sections (gitconfig-generator style) */ +.gitconfig-sections { + display: flex; + flex-direction: column; + gap: 1rem; +} + +.gitconfig-config-section { + margin: 0; + padding: 1.25rem; + background: var(--pgw-bg-muted); + border-radius: 0.5rem; + border: 1px solid var(--pgw-border); + border-left: 4px solid var(--pgw-link); +} + +.gitconfig-section-header { + display: flex; + justify-content: space-between; + align-items: center; + gap: 0.75rem; + margin-bottom: 0; + cursor: default; +} + +.gitconfig-config-section.collapsed .gitconfig-section-header { + margin-bottom: 0; +} + +.gitconfig-section-title { + color: var(--pgw-text); + font-size: 1.35rem; + font-weight: 600; + flex: 1; +} + +.gitconfig-section-toggle { + background: transparent; + border: 2px solid var(--pgw-border); + color: var(--pgw-text); + width: 2rem; + height: 2rem; + border-radius: 0.375rem; + cursor: pointer; + display: flex; + align-items: center; + justify-content: center; + font-size: 1.25rem; + font-weight: bold; + line-height: 1; + padding: 0; + flex-shrink: 0; + transition: background 0.15s ease, color 0.15s ease, border-color 0.15s ease; +} + +.gitconfig-section-toggle:hover { + background: var(--pgw-accent-bg); + border-color: var(--pgw-link); + color: var(--pgw-link); +} + +.gitconfig-toggle-icon { + display: inline-block; + user-select: none; +} + +.gitconfig-config-section.collapsed .gitconfig-section-content { + display: none; +} + +.gitconfig-section-content { + padding-top: 1rem; +} + +.gitconfig-subsection-header { + color: var(--pgw-text); + margin: 1.25rem 0 0.75rem 0; + font-size: 1.1rem; + font-weight: 600; + padding-bottom: 0.5rem; + border-bottom: 2px solid var(--pgw-border-muted); +} + +.gitconfig-subsection-header:first-child { + margin-top: 0; +} + +/* Git config rows: label | control | description (gitconfig-generator style) */ +.gitconfig-form-group { + display: flex; + flex-wrap: wrap; + align-items: center; + column-gap: 1rem; + row-gap: 0.5rem; + margin-bottom: 0.75rem; + padding-bottom: 0.75rem; + border-bottom: 1px solid var(--pgw-border-muted); +} + +.gitconfig-form-group .gitconfig-form-label[title] { + cursor: help; +} + +.gitconfig-form-label { + flex: 0 0 150px; + max-width: min(150px, 35vw); + margin-bottom: 0; + font-weight: 600; + line-height: 1.3; +} + +.gitconfig-form-control { + flex: 1 1 auto; + min-width: 0; + max-width: 25%; +} + +.gitconfig-form-group:not(:has(.gitconfig-form-description)) .gitconfig-form-control { + max-width: none; +} + +.gitconfig-form-control .form-select, +.gitconfig-form-control .form-control { + width: 100%; + min-width: 0; +} + +.gitconfig-form-description { + flex: 1 1 auto; + min-width: 0; + max-width: 40%; + font-size: 0.85rem; + font-style: italic; + line-height: 1.4; + color: var(--pgw-text-muted); +} + +@media (max-width: 991.98px) { + .gitconfig-form-group { + flex-direction: column; + align-items: stretch; + } + + .gitconfig-form-label { + flex: 0 0 auto; + max-width: 100%; + } + + .gitconfig-form-control { + max-width: 100%; + } + + .gitconfig-form-description { + max-width: 100%; + } +} diff --git a/pygitweb/static/project_config.js b/pygitweb/static/project_config.js new file mode 100644 index 0000000..f3f2faf --- /dev/null +++ b/pygitweb/static/project_config.js @@ -0,0 +1,63 @@ +(function () { + const root = document.getElementById("project-git-config"); + if (!root) return; + const base = root.dataset.setUrl; + if (!base) return; + + function showErr(msg) { + try { + alert(msg); + } catch (e) { + /* ignore */ + } + } + + function onChange(ev) { + const el = ev.target; + const key = el.dataset.configKey; + if (!key) return; + const value = el.value; + const url = + base + "&key=" + encodeURIComponent(key) + "&value=" + encodeURIComponent(value); + fetch(url, { + method: "POST", + credentials: "same-origin", + headers: { Accept: "application/json" }, + }) + .then(async (r) => { + if (!r.ok) { + let detail = "Save failed"; + try { + const j = await r.json(); + if (typeof j.detail === "string") detail = j.detail; + else if (j.detail !== undefined) detail = JSON.stringify(j.detail); + } catch (e) { + try { + detail = await r.text(); + } catch (e2) { + /* ignore */ + } + } + throw new Error(detail); + } + return r.json(); + }) + .catch((err) => showErr(err.message || String(err))); + } + + root.querySelectorAll("[data-config-key]").forEach((el) => { + el.addEventListener("change", onChange); + }); + + root.querySelectorAll("[data-gitconfig-section]").forEach((section) => { + const btn = section.querySelector(".gitconfig-section-toggle"); + const icon = section.querySelector(".gitconfig-toggle-icon"); + if (!btn) return; + btn.addEventListener("click", (e) => { + e.preventDefault(); + const hasCollapsed = section.classList.toggle("collapsed"); + btn.setAttribute("aria-expanded", hasCollapsed ? "false" : "true"); + if (icon) icon.textContent = hasCollapsed ? "+" : "\u2212"; + }); + }); +})(); diff --git a/pygitweb/templates/project_git_config.html b/pygitweb/templates/project_git_config.html new file mode 100644 index 0000000..d9de9f3 --- /dev/null +++ b/pygitweb/templates/project_git_config.html @@ -0,0 +1,47 @@ +Project: {{ project_esc | safe }}
+Changes are saved to this repository’s local config. Select “unset” to remove a value.
+