From 1d68acf8f0a4ffa23ecf831ed048449ca83df39a Mon Sep 17 00:00:00 2001
From: ed <s@ocv.me>
Date: Fri, 11 Oct 2024 21:52:44 +0000
Subject: [PATCH] add `preadme.md`; closes #105

---
 README.md                 |  4 ++-
 copyparty/__main__.py     |  6 ++---
 copyparty/httpcli.py      | 51 ++++++++++++++++++++++++++-------------
 copyparty/web/browser.css |  2 +-
 copyparty/web/browser.js  | 27 +++++++++++++++------
 5 files changed, 60 insertions(+), 30 deletions(-)

diff --git a/README.md b/README.md
index bb06258b..76fbad21 100644
--- a/README.md
+++ b/README.md
@@ -937,6 +937,8 @@ see [./srv/expand/](./srv/expand/) for usage and examples
 
 * files named `README.md` / `readme.md` will be rendered after directory listings unless `--no-readme` (but `.epilogue.html` takes precedence)
 
+  * and `PREADME.md` / `preadme.md` is shown above directory listings unless `--no-readme` or `.prologue.html`
+
 * `README.md` and `*logue.html` can contain placeholder values which are replaced server-side before embedding into directory listings; see `--help-exp`
 
 
@@ -2047,7 +2049,7 @@ other misc notes:
 
 behavior that might be unexpected
 
-* users without read-access to a folder can still see the `.prologue.html` / `.epilogue.html` / `README.md` contents, for the purpose of showing a description on how to use the uploader for example
+* users without read-access to a folder can still see the `.prologue.html` / `.epilogue.html` / `PREADME.md` / `README.md` contents, for the purpose of showing a description on how to use the uploader for example
 * users can submit `<script>`s which autorun (in a sandbox) for other visitors in a few ways;
   * uploading a `README.md` -- avoid with `--no-readme`
   * renaming `some.html` to `.epilogue.html` -- avoid with either `--no-logues` or `--no-dot-ren`
diff --git a/copyparty/__main__.py b/copyparty/__main__.py
index edf90044..4df48dcf 100644
--- a/copyparty/__main__.py
+++ b/copyparty/__main__.py
@@ -780,7 +780,7 @@ def get_sects():
             dedent(
                 """
             specify --exp or the "exp" volflag to enable placeholder expansions
-            in README.md / .prologue.html / .epilogue.html
+            in README.md / PREADME.md / .prologue.html / .epilogue.html
 
             --exp-md (volflag exp_md) holds the list of placeholders which can be
             expanded in READMEs, and --exp-lg (volflag exp_lg) likewise for logues;
@@ -1255,7 +1255,7 @@ def add_safety(ap):
     ap2.add_argument("--no-dot-mv", action="store_true", help="disallow moving dotfiles; makes it impossible to move folders containing dotfiles")
     ap2.add_argument("--no-dot-ren", action="store_true", help="disallow renaming dotfiles; makes it impossible to turn something into a dotfile")
     ap2.add_argument("--no-logues", action="store_true", help="disable rendering .prologue/.epilogue.html into directory listings")
-    ap2.add_argument("--no-readme", action="store_true", help="disable rendering readme.md into directory listings")
+    ap2.add_argument("--no-readme", action="store_true", help="disable rendering readme/preadme.md into directory listings")
     ap2.add_argument("--vague-403", action="store_true", help="send 404 instead of 403 (security through ambiguity, very enterprise)")
     ap2.add_argument("--force-js", action="store_true", help="don't send folder listings as HTML, force clients to use the embedded json instead -- slight protection against misbehaving search engines which ignore \033[33m--no-robots\033[0m")
     ap2.add_argument("--no-robots", action="store_true", help="adds http and html headers asking search engines to not index anything (volflag=norobots)")
@@ -1453,7 +1453,7 @@ def add_ui(ap, retry):
     ap2.add_argument("--k304", metavar="NUM", type=int, default=0, help="configure the option to enable/disable k304 on the controlpanel (workaround for buggy reverse-proxies); [\033[32m0\033[0m] = hidden and default-off, [\033[32m1\033[0m] = visible and default-off, [\033[32m2\033[0m] = visible and default-on")
     ap2.add_argument("--md-sbf", metavar="FLAGS", type=u, default="downloads forms popups scripts top-navigation-by-user-activation", help="list of capabilities to ALLOW for README.md docs (volflag=md_sbf); see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox")
     ap2.add_argument("--lg-sbf", metavar="FLAGS", type=u, default="downloads forms popups scripts top-navigation-by-user-activation", help="list of capabilities to ALLOW for prologue/epilogue docs  (volflag=lg_sbf)")
-    ap2.add_argument("--no-sb-md", action="store_true", help="don't sandbox README.md documents (volflags: no_sb_md | sb_md)")
+    ap2.add_argument("--no-sb-md", action="store_true", help="don't sandbox README/PREADME.md documents (volflags: no_sb_md | sb_md)")
     ap2.add_argument("--no-sb-lg", action="store_true", help="don't sandbox prologue/epilogue docs (volflags: no_sb_lg | sb_lg); enables non-js support")
 
 
diff --git a/copyparty/httpcli.py b/copyparty/httpcli.py
index 8989fb1f..12cf4380 100644
--- a/copyparty/httpcli.py
+++ b/copyparty/httpcli.py
@@ -127,6 +127,10 @@ _ = (argparse, threading)
 
 NO_CACHE = {"Cache-Control": "no-cache"}
 
+LOGUES = [[0, ".prologue.html"], [1, ".epilogue.html"]]
+
+READMES = [[0, ["preadme.md", "PREADME.md"]], [1, ["readme.md", "README.md"]]]
+
 
 class HttpCli(object):
     """
@@ -3255,10 +3259,10 @@ class HttpCli(object):
 
     def _add_logues(
         self, vn: VFS, abspath: str, lnames: Optional[dict[str, str]]
-    ) -> tuple[list[str], str]:
+    ) -> tuple[list[str], list[str]]:
         logues = ["", ""]
         if not self.args.no_logues:
-            for n, fn in enumerate([".prologue.html", ".epilogue.html"]):
+            for n, fn in LOGUES:
                 if lnames is not None and fn not in lnames:
                     continue
                 fn = "%s/%s" % (abspath, fn)
@@ -3270,25 +3274,31 @@ class HttpCli(object):
                             logues[n], vn.flags.get("exp_lg") or []
                         )
 
-        readme = ""
-        if not self.args.no_readme and not logues[1]:
-            if lnames is None:
-                fns = ["README.md", "readme.md"]
-            elif "readme.md" in lnames:
-                fns = [lnames["readme.md"]]
+        readmes = ["", ""]
+        for n, fns in [] if self.args.no_readme else READMES:
+            if logues[n]:
+                continue
+            elif lnames is None:
+                pass
+            elif fns[0] in lnames:
+                fns = [lnames[fns[0]]]
             else:
                 fns = []
 
+            txt = ""
             for fn in fns:
                 fn = "%s/%s" % (abspath, fn)
                 if bos.path.isfile(fn):
                     with open(fsenc(fn), "rb") as f:
-                        readme = f.read().decode("utf-8")
+                        txt = f.read().decode("utf-8")
                         break
-            if readme and "exp" in vn.flags:
-                readme = self._expand(readme, vn.flags.get("exp_md") or [])
 
-        return logues, readme
+            if txt and "exp" in vn.flags:
+                txt = self._expand(txt, vn.flags.get("exp_md") or [])
+
+            readmes[n] = txt
+
+        return logues, readmes
 
     def _expand(self, txt: str, phs: list[str]) -> str:
         for ph in phs:
@@ -5142,9 +5152,9 @@ class HttpCli(object):
             j2a["no_prism"] = True
 
         if not self.can_read and not is_dk:
-            logues, readme = self._add_logues(vn, abspath, None)
+            logues, readmes = self._add_logues(vn, abspath, None)
             ls_ret["logues"] = j2a["logues"] = logues
-            ls_ret["readme"] = cgv["readme"] = readme
+            ls_ret["readmes"] = cgv["readmes"] = readmes
 
             if is_ls:
                 return self.tx_ls(ls_ret)
@@ -5401,11 +5411,18 @@ class HttpCli(object):
         else:
             taglist = list(tagset)
 
-        logues, readme = self._add_logues(vn, abspath, lnames)
+        logues, readmes = self._add_logues(vn, abspath, lnames)
         ls_ret["logues"] = j2a["logues"] = logues
-        ls_ret["readme"] = cgv["readme"] = readme
+        ls_ret["readmes"] = cgv["readmes"] = readmes
 
-        if not files and not dirs and not readme and not logues[0] and not logues[1]:
+        if (
+            not files
+            and not dirs
+            and not readmes[0]
+            and not readmes[1]
+            and not logues[0]
+            and not logues[1]
+        ):
             logues[1] = "this folder is empty"
 
         if "descript.ion" in lnames and os.path.isfile(
diff --git a/copyparty/web/browser.css b/copyparty/web/browser.css
index 0da6563c..f8bd9a86 100644
--- a/copyparty/web/browser.css
+++ b/copyparty/web/browser.css
@@ -896,7 +896,7 @@ html.y #path a:hover {
 	max-width: 52em;
 }
 .mdo.sb,
-#epi.logue.mdo>iframe {
+.logue.mdo>iframe {
 	max-width: 54em;
 }
 .mdo,
diff --git a/copyparty/web/browser.js b/copyparty/web/browser.js
index 8cec4175..ac53db8b 100644
--- a/copyparty/web/browser.js
+++ b/copyparty/web/browser.js
@@ -7345,6 +7345,9 @@ var treectl = (function () {
 
 		var lg0 = res.logues ? res.logues[0] || "" : "",
 			lg1 = res.logues ? res.logues[1] || "" : "",
+			mds = res.readmes && treectl.ireadme,
+			md0 = mds ? res.readmes[0] || "" : "",
+			md1 = mds ? res.readmes[1] || "" : "",
 			dirchg = get_evpath() != cdir;
 
 		if (lg1 === Ls.eng.f_empty)
@@ -7354,9 +7357,14 @@ var treectl = (function () {
 		if (dirchg)
 			sandbox(ebi('epi'), sb_lg, '', lg1);
 
+		clmod(ebi('pro'), 'mdo');
 		clmod(ebi('epi'), 'mdo');
-		if (res.readme && treectl.ireadme)
-			show_readme(res.readme);
+
+		if (md0)
+			show_readme(md0, 0);
+
+		if (md1)
+			show_readme(md1, 1);
 		else if (!dirchg)
 			sandbox(ebi('epi'), sb_lg, '', lg1);
 
@@ -8877,14 +8885,17 @@ function set_tabindex() {
 }
 
 
-function show_readme(md) {
-	if (!treectl.ireadme)
-		return sandbox(ebi('epi'), '', '', 'a');
+function show_readme(md, n) {
+	var tgt = ebi(n ? 'epi' : 'pro');
 
-	show_md(md, 'README.md', ebi('epi'));
+	if (!treectl.ireadme)
+		return sandbox(tgt, '', '', 'a');
+
+	show_md(md, n ? 'README.md' : 'PREADME.md', tgt);
 }
-if (readme)
-	show_readme(readme);
+for (var a = 0; a < readmes.length; a++)
+	if (readmes[a])
+		show_readme(readmes[a], a);
 
 
 function sandbox(tgt, rules, cls, html) {