From 54b82931b22429f716b37b654e5e21eed7075ec7 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Sun, 9 Feb 2020 01:42:31 +0000 Subject: [PATCH 01/24] Major restructuring of extension processors, not yet complete --- resources/config.edn | 2 +- resources/public/content/Extensible Markup.md | 10 ++- resources/public/data/classes.mermaid | 14 +++ resources/templates/wiki.html | 2 +- src/smeagol/extensions/mermaid.clj | 85 +++++++++++++++++++ src/smeagol/extensions/utils.clj | 72 ++++++++++++++++ src/smeagol/extensions/vega.clj | 0 src/smeagol/formatting.clj | 11 +-- 8 files changed, 185 insertions(+), 11 deletions(-) create mode 100644 resources/public/data/classes.mermaid create mode 100644 src/smeagol/extensions/mermaid.clj create mode 100644 src/smeagol/extensions/utils.clj create mode 100644 src/smeagol/extensions/vega.clj diff --git a/resources/config.edn b/resources/config.edn index 5ceccd7..c2c9161 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -33,7 +33,7 @@ :default-locale "en-GB" ;; default language used for messages :formatters {"vega" smeagol.formatting/process-vega "vis" smeagol.formatting/process-vega - "mermaid" smeagol.formatting/process-mermaid + "mermaid" smeagol.extensions.mermaid/process-mermaid "backticks" smeagol.formatting/process-backticks} :log-level :info ;; the minimum logging level; one of ;; :trace :debug :info :warn :error :fatal diff --git a/resources/public/content/Extensible Markup.md b/resources/public/content/Extensible Markup.md index 129a375..aec9e82 100644 --- a/resources/public/content/Extensible Markup.md +++ b/resources/public/content/Extensible Markup.md @@ -36,7 +36,7 @@ Data files can be uploaded in the same way as images, by using the **upload a fi Graphs can now be embedded in a page using the [Mermaid](https://mermaid-js.github.io/mermaid/#/) graph description language. The graph description should start with a line comprising three back-ticks and then the word `mermaid`, and end with a line comprising just three backticks. -Here's an example culled from the Mermaid documentation. +Here's an example culled from the Mermaid documentation. Edit this page to see the specification. ### GANTT Chart @@ -58,6 +58,14 @@ gantt Add to mermaid :1d ``` +Mermaid graph specifications can also be loaded from URLs. Here's another example; again, edit this page to see how the trick is done. + +### Class Diagram + +```mermaid +data/classes.mermaid +``` + ## Writing your own custom formatters A custom formatter is simply a Clojure function which takes a string and an integer as arguments and produces a string as output. The string is the text the user has typed into their markdown; the integer is simply a number you can use to keep track of which addition to the page this is, in order, for example, to fix up some JavaScript to render it. diff --git a/resources/public/data/classes.mermaid b/resources/public/data/classes.mermaid new file mode 100644 index 0000000..e71885a --- /dev/null +++ b/resources/public/data/classes.mermaid @@ -0,0 +1,14 @@ +classDiagram +Class01 <|-- AveryLongClass : Cool +Class03 *-- Class04 +Class05 o-- Class06 +Class07 .. Class08 +Class09 --> C2 : Where am i? +Class09 --* C3 +Class09 --|> Class07 +Class07 : equals() +Class07 : Object[] elementData +Class01 : size() +Class01 : int chimp +Class01 : int gorilla +Class08 <--> C2: Cool label diff --git a/resources/templates/wiki.html b/resources/templates/wiki.html index 7dfa3c8..ffc9b1a 100644 --- a/resources/templates/wiki.html +++ b/resources/templates/wiki.html @@ -9,7 +9,7 @@ - {% endblock %} diff --git a/src/smeagol/extensions/mermaid.clj b/src/smeagol/extensions/mermaid.clj new file mode 100644 index 0000000..9fe271b --- /dev/null +++ b/src/smeagol/extensions/mermaid.clj @@ -0,0 +1,85 @@ +(ns ^{:doc "Format Semagol's extended markdown format." + :author "Simon Brooke"} + smeagol.extensions.mermaid + (:require [smeagol.extensions.utils :refer :all] + [taoensso.timbre :as log])) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; Smeagol: a very simple Wiki engine. +;;;; +;;;; This program is free software; you can redistribute it and/or +;;;; modify it under the terms of the GNU General Public License +;;;; as published by the Free Software Foundation; either version 2 +;;;; of the License, or (at your option) any later version. +;;;; +;;;; This program is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with this program; if not, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2017 Simon Brooke +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; Graphs can now be embedded in a page using the +;;;; [Mermaid](https://mermaid-js.github.io/mermaid/#/) graph description +;;;; language. The graph description should start with a line comprising three +;;;; back-ticks and then the word `mermaid`, and end with a line comprising just +;;;; three backticks. +;;;; +;;;; Here's an example culled from the Mermaid documentation. +;;;; +;;;; ### GANTT Chart +;;;; +;;;; ```mermaid +;;;; gantt +;;;; dateFormat YYYY-MM-DD +;;;; title Adding GANTT diagram functionality to mermaid +;;;; section A section +;;;; Completed task :done, des1, 2014-01-06,2014-01-08 +;;;; Active task :active, des2, 2014-01-09, 3d +;;;; Future task : des3, after des2, 5d +;;;; Future task2 : des4, after des3, 5d +;;;; section Critical tasks +;;;; Completed task in the critical line :crit, done, 2014-01-06,24h +;;;; Implement parser and jison :crit, done, after des1, 2d +;;;; Create tests for parser :crit, active, 3d +;;;; Future task in critical line :crit, 5d +;;;; Create tests for renderer :2d +;;;; Add to mermaid :1d +;;;; ``` +;;;; +;;;; Mermaid graph specifications can also be loaded from URLs. Here's another +;;;; example. +;;;; +;;;; ### Class Diagram +;;;; +;;;; ```mermaid +;;;; http://localhost:3000/data/classes.mermaid +;;;; ``` +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + + +(defn process-mermaid + "If this `url-or-graph-spec` is a valid URL, it is assumed to point to a plain + text file pointing to a valid `graph-spec`; otherwise, it is expected to BE a + valid `graph-spec`. + + Lightly mung this `graph-spec`, assumed to be a mermaid specification." + [^String url-or-graph-spec ^Integer index] + (let [data (resource-url-or-data->data url-or-graph-spec) + graph-spec (:data data)] + (log/info "Retrieved graph-spec from " (:from data) " `" ((:from data) data) "`") + (str "
\n" + graph-spec + "\n
"))) + +;; (fs/file? (str (nio/resource-path) "data/classes.mermaid")) +;; (slurp (str (nio/resource-path) "data/classes.mermaid")) diff --git a/src/smeagol/extensions/utils.clj b/src/smeagol/extensions/utils.clj new file mode 100644 index 0000000..06ed74c --- /dev/null +++ b/src/smeagol/extensions/utils.clj @@ -0,0 +1,72 @@ +(ns ^{:doc "Utility functions useful to extension processors." + :author "Simon Brooke"} + smeagol.extensions.utils + (:require [cemerick.url :refer (url url-encode url-decode)] + [clojure.string :as cs] + [me.raynes.fs :as fs] + [noir.io :as io] + [taoensso.timbre :as log])) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; Smeagol: a very simple Wiki engine. +;;;; +;;;; This program is free software; you can redistribute it and/or +;;;; modify it under the terms of the GNU General Public License +;;;; as published by the Free Software Foundation; either version 2 +;;;; of the License, or (at your option) any later version. +;;;; +;;;; This program is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with this program; if not, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2017 Simon Brooke +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(defn resource-url-or-data->data + "Interpret this `resource-url-or-data` string as data to be digested by a + `process-extension` function. It may be a URL or the pathname of a local + resource, in which case the content should be fetched; or it may just be + the data itself. + + Returns a map with a key `:from` whose value may be `:url`, `:resource` or + `:text`, and a key `:data` whose value is the data. There will be an + additional key being the value of the `:from` key, whose value will be the + source of the data." + [^String resource-url-or-data] + (let [default {:from :text + :text resource-url-or-data + :data resource-url-or-data}] + (try + (try + ;; is it a URL? + (let [url (str (url resource-url-or-data)) + result (slurp url)] + {:from :url + :url url + :data result}) + (catch java.net.MalformedURLException _ + ;; no. So is it a path to a local resource? + (let [t (cs/trim resource-url-or-data) + r (str (io/resource-path) t)] + (if + (fs/file? r) + {:from :resource + :resource t + :data (slurp r)} + default)))) + (catch Exception x + (log/error + "Could not read mermaid graph specification from `" + (cs/trim resource-url-or-data) + "` because " + (.getName (.getClass x)) + (.getMessage x) ) + default)))) diff --git a/src/smeagol/extensions/vega.clj b/src/smeagol/extensions/vega.clj new file mode 100644 index 0000000..e69de29 diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 8fe3697..eca5277 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -1,4 +1,4 @@ -(ns ^{:doc "Format Semagol's enhanced markdown format." +(ns ^{:doc "Format Semagol's extended markdown format." :author "Simon Brooke"} smeagol.formatting (:require [clojure.data.json :as json] @@ -6,7 +6,8 @@ [cemerick.url :refer (url url-encode url-decode)] [clj-yaml.core :as yaml] [markdown.core :as md] - [smeagol.configuration :refer [config]])) + [smeagol.configuration :refer [config]] + [smeagol.extensions.mermaid :refer [process-mermaid]])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -85,12 +86,6 @@ ");\n//]]\n")) -(defn process-mermaid - "Lightly mung this `graph-spec`, assumed to be a mermaid specification." - [^String graph-spec ^Integer index] - (str "
\n" - graph-spec - "\n
")) (defn process-backticks From 1df78111cd7ef2028ae4accb8e2fbd3483f4a1b7 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Sun, 9 Feb 2020 09:23:56 +0000 Subject: [PATCH 02/24] Added separate Vega extension file --- src/smeagol/extensions/vega.clj | 84 +++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) diff --git a/src/smeagol/extensions/vega.clj b/src/smeagol/extensions/vega.clj index e69de29..14cf285 100644 --- a/src/smeagol/extensions/vega.clj +++ b/src/smeagol/extensions/vega.clj @@ -0,0 +1,84 @@ +(ns ^{:doc "Format Semagol's extended markdown format." + :author "Simon Brooke"} + smeagol.extensions.vega + (:require [smeagol.extensions.utils :refer :all] + [taoensso.timbre :as log])) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; Smeagol: a very simple Wiki engine. +;;;; +;;;; This program is free software; you can redistribute it and/or +;;;; modify it under the terms of the GNU General Public License +;;;; as published by the Free Software Foundation; either version 2 +;;;; of the License, or (at your option) any later version. +;;;; +;;;; This program is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with this program; if not, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2017 Simon Brooke +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; Inspired by [visdown](https://visdown.com/) and +;;;; [vega-lite](https://vega.github.io/vega-lite/docs/), the Vega formatter +;;;; allows you to embed vega data visualisations into Smeagol pages. The graph +;;;; description should start with a line comprising three back-ticks and then +;;;; the word '`vega`', and end with a line comprising just three backticks. +;;;; +;;;; Here's an example cribbed in its entirety from +;;;; [here](http://visdown.amitkaps.com/london): +;;;; +;;;; ### Flight punctuality at London airports +;;;; +;;;; ```vega +;;;; data: +;;;; url: "data/london.csv" +;;;; transform: +;;;; - +;;;; filter: datum.year == 2016 +;;;; mark: rect +;;;; encoding: +;;;; x: +;;;; type: nominal +;;;; field: source +;;;; y: +;;;; type: nominal +;;;; field: dest +;;;; color: +;;;; type: quantitative +;;;; field: flights +;;;; aggregate: sum +;;;; ``` +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(defn process-vega + "If this `src-resource-or-url` is a valid URL, it is assumed to point to a + plain text file pointing to valid `vega-src`; otherwise, it is expected to + BE a valid `vega-src`. + + Process this `vega-src` string, assumed to be in YAML format, into a + specification of a Vega chart, and add the plumbing to render it." + [^String src-resource-or-url ^Integer index] + (let [data (resource-url-or-data->data url-or-graph-spec) + vega-src (:data data)] + (log/info "Retrieved vega-src from " (:from data) " `" ((:from data) data) "`") + (str + "
\n" + ""))) From 719222195e4d4cd12d072ddf3309686797ae63e7 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Mon, 10 Feb 2020 11:53:39 +0000 Subject: [PATCH 03/24] Working, but not finished. --- project.clj | 1 + resources/config.edn | 3 +- resources/public/content/Example gallery.md | 59 +++++++++++++++++ resources/public/content/Extensible Markup.md | 6 ++ .../html-includes/photoswipe-boilerplate.html | 65 +++++++++++++++++++ resources/public/vendor/README.md | 1 - resources/templates/wiki.html | 4 ++ src/smeagol/extensions/vega.clj | 11 +++- src/smeagol/formatting.clj | 23 ++++++- 9 files changed, 168 insertions(+), 5 deletions(-) create mode 100644 resources/public/content/Example gallery.md create mode 100644 resources/public/html-includes/photoswipe-boilerplate.html delete mode 100644 resources/public/vendor/README.md diff --git a/project.clj b/project.clj index b270587..1ab812a 100644 --- a/project.clj +++ b/project.clj @@ -52,6 +52,7 @@ [vega-embed "6.2.2"] [vega-lite "4.1.1"] [mermaid "8.4.6"] + [photoswipe "4.1.3"] [tablesort "5.2.0"]] :root "resources/public/vendor"} diff --git a/resources/config.edn b/resources/config.edn index c2c9161..4f9532d 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -34,7 +34,8 @@ :formatters {"vega" smeagol.formatting/process-vega "vis" smeagol.formatting/process-vega "mermaid" smeagol.extensions.mermaid/process-mermaid - "backticks" smeagol.formatting/process-backticks} + "backticks" smeagol.formatting/process-backticks + "pswp" smeagol.formatting/process-photoswipe} :log-level :info ;; the minimum logging level; one of ;; :trace :debug :info :warn :error :fatal :js-from :cloudflare ;; where to load JavaScript libraries diff --git a/resources/public/content/Example gallery.md b/resources/public/content/Example gallery.md new file mode 100644 index 0000000..8379206 --- /dev/null +++ b/resources/public/content/Example gallery.md @@ -0,0 +1,59 @@ +## The Gallery + +This page holds an example Photoswipe gallery. + +```pswp +{ + slides: [ + { src: 'content/uploads/g1.jpg', w: 2592, h:1944, + title: 'Frost on a gate, Laurieston' }, + { src: 'content/uploads/g2.jpg', w: 2560, h:1920, + title: 'Feathered crystals on snow surface, Taliesin' }, + { src: 'content/uploads/g3.jpg', w: 2560, h:1920, + title: 'Feathered snow on log, Taliesin' }, + { src: 'content/uploads/g4.jpg', w: 2560, h:1920, + title: 'Crystaline growth on seed head, Taliesin' }], + options: { + timeToIdle: 100 + }, + openImmediately: true +} + +``` + +## How this works + +The specification for this gallery is as follows: + +``` +{ + slides: [ + { src: 'content/uploads/g1.jpg', w: 2592, h:1944, + title: 'Frost on a gate, Laurieston' }, + { src: 'content/uploads/g2.jpg', w: 2560, h:1920, + title: 'Feathered crystals on snow surface, Taliesin' }, + { src: 'content/uploads/g3.jpg', w: 2560, h:1920, + title: 'Feathered snow on log, Taliesin' }, + { src: 'content/uploads/g4.jpg', w: 2560, h:1920, + title: 'Crystaline growth on seed head, Taliesin' }], + options: { + timeToIdle: 100 + }, + openImmediately: true +} + +``` + +The format of the specification is [JSON](https://www.json.org/json-en.html); there are (at present) three keys, as follows + +### slides + +Most be present. The value of `slides` is a list delimited by square brackets of slide objects. For more information, see the [authoritative documentation](https://photoswipe.com/documentation/getting-started.html) under the sub heading **'Creating an Array of Slide Objects'**. + +### options + +Optional. The value of `options` is a JSON object [as documented here](https://photoswipe.com/documentation/options.html). + +### openImmediately + +Optional. If the value of `openImmediately` is `true`, the gallery will open immediately, covering the whole page. If false, only a button with the label 'Open the gallery' will be shown. Selecting this button will cause the gallery to open. diff --git a/resources/public/content/Extensible Markup.md b/resources/public/content/Extensible Markup.md index aec9e82..3bc8301 100644 --- a/resources/public/content/Extensible Markup.md +++ b/resources/public/content/Extensible Markup.md @@ -66,6 +66,12 @@ Mermaid graph specifications can also be loaded from URLs. Here's another exampl data/classes.mermaid ``` +## Photoswipe galleries + +Not so much a formatter, this is an extension to allow you to embed image galleries in your markdown. To specify a gallery, use three backticks followed by `pswp`, followed on the following lines by a Photoswipe specification in [JSON](https://www.json.org/json-en.html) +followed by three backticks on a line by themselves. There is an [[Example gallery]] so that you can see how this works. + + ## Writing your own custom formatters A custom formatter is simply a Clojure function which takes a string and an integer as arguments and produces a string as output. The string is the text the user has typed into their markdown; the integer is simply a number you can use to keep track of which addition to the page this is, in order, for example, to fix up some JavaScript to render it. diff --git a/resources/public/html-includes/photoswipe-boilerplate.html b/resources/public/html-includes/photoswipe-boilerplate.html new file mode 100644 index 0000000..2dec488 --- /dev/null +++ b/resources/public/html-includes/photoswipe-boilerplate.html @@ -0,0 +1,65 @@ + + +
+ + +
+ + +
+
+
+
+
+ + +
+ +
+ + + +
+ + + + + + + + + + + +
+
+
+
+
+
+
+
+ + + + + + + +
+
+
+ +
+ +
diff --git a/resources/public/vendor/README.md b/resources/public/vendor/README.md deleted file mode 100644 index c3ab41c..0000000 --- a/resources/public/vendor/README.md +++ /dev/null @@ -1 +0,0 @@ -This folder must exist in order that the Bower package manager can deploy JavaScript packages to it. diff --git a/resources/templates/wiki.html b/resources/templates/wiki.html index ffc9b1a..9413902 100644 --- a/resources/templates/wiki.html +++ b/resources/templates/wiki.html @@ -2,6 +2,10 @@ {% block extra-headers %} + {% script "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe-ui-default.min.js" %} + {% script "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe.min.js" %} + {% style "vendor/node_modules/photoswipe/dist/photoswipe.css" %} + {% style "vendor/node_modules/photoswipe/dist/default-skin/default-skin.css" %} diff --git a/src/smeagol/extensions/vega.clj b/src/smeagol/extensions/vega.clj index 14cf285..1b9e2de 100644 --- a/src/smeagol/extensions/vega.clj +++ b/src/smeagol/extensions/vega.clj @@ -1,7 +1,9 @@ (ns ^{:doc "Format Semagol's extended markdown format." :author "Simon Brooke"} smeagol.extensions.vega - (:require [smeagol.extensions.utils :refer :all] + (:require [clojure.data.json :as json] + [clj-yaml.core :as yaml] + [smeagol.extensions.utils :refer :all] [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -60,6 +62,11 @@ ;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +(defn yaml->json + "Rewrite this string, assumed to be in YAML format, as JSON." + [^String yaml-src] + (json/write-str (yaml/parse-string yaml-src))) + (defn process-vega "If this `src-resource-or-url` is a valid URL, it is assumed to point to a plain text file pointing to valid `vega-src`; otherwise, it is expected to @@ -68,7 +75,7 @@ Process this `vega-src` string, assumed to be in YAML format, into a specification of a Vega chart, and add the plumbing to render it." [^String src-resource-or-url ^Integer index] - (let [data (resource-url-or-data->data url-or-graph-spec) + (let [data (resource-url-or-data->data src-resource-or-url) vega-src (:data data)] (log/info "Retrieved vega-src from " (:from data) " `" ((:from data) data) "`") (str diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index eca5277..357f6aa 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -6,6 +6,7 @@ [cemerick.url :refer (url url-encode url-decode)] [clj-yaml.core :as yaml] [markdown.core :as md] + [noir.io :as io] ;; used by photoswipe, only [smeagol.configuration :refer [config]] [smeagol.extensions.mermaid :refer [process-mermaid]])) @@ -85,7 +86,27 @@ index ");\n//]]\n")) - +(defn process-photoswipe + "Process specification for a photoswipe gallery" + [^String spec ^Integer index] + (str + "
\n" + (slurp (str (io/resource-path) "html-includes/photoswipe-boilerplate.html")) + "
+ +

+ ")) (defn process-backticks From ad5e41c23a0eaee8d48398ba66d080b1eed86740 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Mon, 10 Feb 2020 17:39:24 +0000 Subject: [PATCH 04/24] Progress on thumbnailing, but not working yet. --- project.clj | 1 + resources/config.edn | 7 +++- src/smeagol/uploads.clj | 89 +++++++++++++++++++++++++++++++---------- 3 files changed, 75 insertions(+), 22 deletions(-) diff --git a/project.clj b/project.clj index 1ab812a..c92f098 100644 --- a/project.clj +++ b/project.clj @@ -16,6 +16,7 @@ [environ "1.1.0"] [hiccup "1.0.5"] [im.chit/cronj "1.4.4"] + [image-resizer "0.1.10"] [lib-noir "0.9.9" :exclusions [org.clojure/tools.reader]] [markdown-clj "0.9.99" :exclusions [com.keminglabs/cljx]] [me.raynes/fs "1.4.6"] diff --git a/resources/config.edn b/resources/config.edn index 4f9532d..78390bb 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -42,5 +42,10 @@ ;; from: options are :local, :cloudflare :passwd "resources/passwd" ;; where the password file is stored - :site-title "Smeagol"} ;; overall title of the site, used in + :site-title "Smeagol" ;; overall title of the site, used in ;; page headings + :thumbnails {:small 64 ;; maximum dimension of thumbnails + ;; stored in the /small directory + :med 400 ;; maximum dimension of thumbnails + ;; stored in the /med directory + }} diff --git a/src/smeagol/uploads.clj b/src/smeagol/uploads.clj index 7cadaea..24f2c71 100644 --- a/src/smeagol/uploads.clj +++ b/src/smeagol/uploads.clj @@ -1,10 +1,18 @@ (ns ^{:doc "Handle file uploads." :author "Simon Brooke"} smeagol.uploads - (:import [java.io File]) (:require [clojure.string :as cs] - [noir.io :as io] - [taoensso.timbre :as timbre])) + [clojure.java.io :as io] + [image-resizer.core :refer [resize]] + [image-resizer.util :refer :all] + [me.raynes.fs :as fs] + [smeagol.configuration :refer [config]] + [taoensso.timbre :as log]) + (:import [java.io File] + [java.awt Image] + [java.awt.image RenderedImage BufferedImageOp] + [javax.imageio ImageIO ImageWriter ImageWriteParam IIOImage] + [javax.imageio.stream FileImageOutputStream])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -29,21 +37,59 @@ ;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; No longer used as uploaded files now go into Git. -;; (defn avoid-name-collisions -;; "Find a filename within this `path`, based on this `file-name`, that does not -;; reference an existing file. It is assumed that `path` ends with a path separator. -;; Returns a filename hwich does not currently reference a file within the path." -;; [path file-name] -;; (if (.exists (File. (str path file-name))) -;; (let [parts (cs/split file-name #"\.") -;; prefix (cs/join "." (butlast parts)) -;; suffix (last parts)] -;; (first -;; (filter #(not (.exists (File. (str path %)))) -;; (map #(str prefix "." % "." suffix) (range))))) -;; file-name)) +(def image-file-extns + "Extensions of file types we will attempt to thumbnail. GIF is excluded + because by default the javax.imageio package can read GIF, PNG, and JPEG + images but can only write PNG and JPEG images." + #{".jpg" ".jpeg" ".png"}) +(defn read-image + "Reads a BufferedImage from source, something that can be turned into + a file with clojure.java.io/file" + [source] + (ImageIO/read (io/file source))) + +(defn write-image + "Writes img, a RenderedImage, to dest, something that can be turned into + a file with clojure.java.io/file. + Takes the following keys as options: + :format - :gif, :jpg, :png or anything supported by ImageIO + :quality - for JPEG images, a number between 0 and 100" + [^RenderedImage img dest & {:keys [format quality] :or {format :jpg}}] + (if (or (not quality) (not (contains? #{:jpg :jpeg} format))) + (ImageIO/write img (name format) (io/file dest)) + (let [fmt (rest (fs/extension (cs/lower-case dest))) + iw (doto ^ImageWriter (first + (iterator-seq + (ImageIO/getImageWritersByFormatName + "jpeg"))) + (.setOutput (FileImageOutputStream. (io/file dest)))) + iw-param (doto ^ImageWriteParam (.getDefaultWriteParam iw) + (.setCompressionMode ImageWriteParam/MODE_EXPLICIT) + (.setCompressionQuality (float (/ quality 100)))) + iio-img (IIOImage. img nil nil)] + (.write iw nil iio-img iw-param)))) + +(defn auto-thumbnail + "For each of the thumbnail sizes in the configuration, create a thumbnail + for the file with this `filename` on this `path`, provided that it is a + scalable image and is larger than the size." + ([^String path ^String filename] + (if + (image-file-extns (fs/extension (cs/lower-case filename))) + (let [original (buffered-image (.File (str path filename)))] ;; fs/file? + (map + #(auto-thumbnail path filename % original) + (keys (config :thumbnails)))) + (log/info filename " cannot be thumbnailed."))) + ([^String path ^String filename size ^RenderedImage image] + (let [s (-> config :thumbnails size) + d (dimensions image)] + (if (and (integer? s) (some #(> % s) d)) + (do + (write-image (resize image s s) (io/file path (name size) filename)) + (log/info "Created a " size " thumbnail of " filename)) + (log/info filename "is smaller than " s "x" s " and was not scaled to " size))))) (defn store-upload "Store an upload both to the file system and to the database. @@ -56,17 +102,18 @@ (let [upload (:upload params) tmp-file (:tempfile upload) filename (:filename upload)] - (timbre/info + (log/info (str "Storing upload file: " upload)) - (timbre/debug + (log/debug (str "store-upload mv file: " tmp-file " to: " path filename)) (if tmp-file (try (do (.renameTo tmp-file - (File. (str path filename))) + (File. (str path filename))) ;; TODO: fs/file + (auto-thumbnail path filename) (File. (str path filename))) (catch Exception x - (timbre/error (str "Failed to move " tmp-file " to " path filename "; " (type x) ": " (.getMessage x))) + (log/error (str "Failed to move " tmp-file " to " path filename "; " (type x) ": " (.getMessage x))) (throw x))) (throw (Exception. "No file found?"))))) From 40f4f13667d1f2a193768d118e1cd85d6c754362 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Mon, 10 Feb 2020 21:36:49 +0000 Subject: [PATCH 05/24] Tactical commit: I'm fairly sure this is close to good. --- resources/templates/list-uploads.html | 4 +- resources/templates/upload.html | 29 +++++++------ src/smeagol/routes/wiki.clj | 52 +++++++++++----------- src/smeagol/uploads.clj | 62 ++++++++++++++++----------- src/smeagol/util.clj | 10 +++-- 5 files changed, 88 insertions(+), 69 deletions(-) diff --git a/resources/templates/list-uploads.html b/resources/templates/list-uploads.html index 761e4a8..e759dac 100644 --- a/resources/templates/list-uploads.html +++ b/resources/templates/list-uploads.html @@ -21,10 +21,10 @@ {{entry.base-name}} {{entry.modified}} - {% if entry.is-image %} ![{{entry.name|capitalize}}](uploads/{{entry.base-name}}) {% else %} [{{entry.name|capitalize}}](uploads/{{entry.base-name}}) {% endif %} + {% if entry.is-image %} ![{{entry.name|capitalize}}]({{entry.resource}}) {% else %} [{{entry.name|capitalize}}](uploads/{{entry.resource}}) {% endif %} - {% if entry.is-image %} {{entry.name|capitalize}} {% else %} link {% endif %} + {% if entry.is-image %} {{entry.name|capitalize}} {% else %} link {% endif %} diff --git a/resources/templates/upload.html b/resources/templates/upload.html index 7c0c373..bc469b4 100644 --- a/resources/templates/upload.html +++ b/resources/templates/upload.html @@ -1,22 +1,25 @@ {% extends "templates/base.html" %} {% block content %}
- {% if uploaded %} - {% if is-image %} -

- Uploaded image + {% if has-uploaded %} + {% for upload in uploaded %} + {{upload.filename}} + {% if upload.is-image %) +

+ Uploaded image - {% i18n file-upload-link-text %}: + {% i18n file-upload-link-text %}: - ![Uploaded image](uploads/{{uploaded}}) -

- {% else %} -

- {% i18n file-upload-link-text %}: + ![{{upload.filename}}]({{upload.resource}}) +

+ {% else %} +

+ {% i18n file-upload-link-text %}: - [Uploaded file](uploads/{{uploaded}}) -

- {% endif %} + [{{upload.filename}}]({{upload.resource}}) +

+ {% endif %} + {% endfor %} {% else %}
{% csrf-field %} diff --git a/src/smeagol/routes/wiki.clj b/src/smeagol/routes/wiki.clj index a8e13ce..c21e81b 100644 --- a/src/smeagol/routes/wiki.clj +++ b/src/smeagol/routes/wiki.clj @@ -4,6 +4,7 @@ (:require [cemerick.url :refer (url url-encode url-decode)] [clj-jgit.porcelain :as git] [clojure.java.io :as cjio] + [clojure.pprint :refer [pprint]] [clojure.string :as cs] [clojure.walk :refer :all] [compojure.core :refer :all] @@ -22,7 +23,7 @@ [smeagol.sanity :refer [show-sanity-check-error]] [smeagol.util :as util] [smeagol.uploads :as ul] - [taoensso.timbre :as timbre] + [taoensso.timbre :as log] [com.stuartsierra.component :as component] [smeagol.include.resolve-local-file :as resolve] [smeagol.include :as include])) @@ -54,7 +55,7 @@ "Process `source-text` and save it to the specified `file-path`, committing it to Git and finally redirecting to wiki-page." [params suffix request] - (timbre/trace (format "process-source: '%s'" request)) + (log/trace (format "process-source: '%s'" request)) (let [source-text (:src params) page (:page params) file-name (str page suffix) @@ -64,7 +65,7 @@ user (session/get :user) email (auth/get-email user) summary (format "%s: %s" user (or (:summary params) "no summary"))] - (timbre/info (format "Saving %s's changes ('%s') to %s in file '%s'" user summary page file-path)) + (log/info (format "Saving %s's changes ('%s') to %s in file '%s'" user summary page file-path)) (spit file-path source-text) (git/git-add git-repo file-name) (git/git-commit git-repo summary {:name user :email email}) @@ -94,9 +95,9 @@ user (session/get :user)] (if-not exists? - (timbre/info + (log/info (format "File '%s' not found; creating a new file" file-path)) - (timbre/info (format "Opening '%s' for editing" file-path))) + (log/info (format "Opening '%s' for editing" file-path))) (cond src-text (process-source params suffix request) true (layout/render template @@ -125,7 +126,7 @@ (defn wiki-page "Render the markdown page specified in this `request`, if any. If none found, redirect to edit-page" [request] - (timbre/trace (format "wiki-page: '%s'" request)) + (log/trace (format "wiki-page: '%s'" request)) (or (show-sanity-check-error) (let [params (keywordize-keys (:params request)) @@ -135,7 +136,7 @@ exists? (.exists (clojure.java.io/as-file file-path))] (cond exists? (do - (timbre/info (format "Showing page '%s' from file '%s'" page file-path)) + (log/info (format "Showing page '%s' from file '%s'" page file-path)) (layout/render "wiki.html" (merge (util/standard-params request) {:title page @@ -156,7 +157,7 @@ page (url-decode (or (:page params) (util/get-message :default-page-title request))) file-name (str page ".md") repo-path util/content-dir] - (timbre/info (format "Showing history of page '%s'" page)) + (log/info (format "Showing history of page '%s'" page)) (layout/render "history.html" (merge (util/standard-params request) {:title (util/get-message :history-title-prefix request) @@ -187,10 +188,11 @@ (let [params (keywordize-keys (:params request)) data-path (str util/content-dir "/uploads/") + cl (count (io/resource-path)) files (map #(zipmap - [:base-name :is-image :modified :name] + [:base-name :is-image :modified :name :resource] [(fs/base-name %) (if (and (fs/extension %) @@ -199,11 +201,13 @@ (if (fs/mod-time %) (format-instant (fs/mod-time %))) - (fs/name %)]) + (fs/name %) + (subs (str (fs/absolute %)) cl)]) (remove #(or (cs/starts-with? (fs/name %) ".") (fs/directory? %)) (file-seq (clojure.java.io/file data-path))))] + (log/info (with-out-str (pprint files))) (layout/render "list-uploads.html" (merge (util/standard-params request) @@ -236,20 +240,18 @@ uploaded (if upload (ul/store-upload params data-path)) user (session/get :user) summary (format "%s: %s" user (or (:summary params) "no summary"))] - (if - uploaded - (do - (git/git-add git-repo (str data-path (fs/name uploaded))) - (git/git-commit git-repo summary {:name user :email (auth/get-email user)}))) +;; (if +;; uploaded +;; (do +;; (map +;; #(git/git-add git-repo (str :resource %)) +;; uploaded) +;; (git/git-commit git-repo summary {:name user :email (auth/get-email user)}))) (layout/render "upload.html" (merge (util/standard-params request) {:title (util/get-message :file-upload-title request) - :uploaded (if uploaded (fs/base-name uploaded)) - :is-image (if - uploaded - (image-extns - (cs/lower-case - (fs/extension uploaded))))})))) + :has-uploaded (not (empty? uploaded)) + :uploaded uploaded})))) (defn version-page "Render a specific historical version of a page" @@ -259,7 +261,7 @@ version (:version params) file-name (str page ".md") content (hist/fetch-version util/content-dir file-name version)] - (timbre/info (format "Showing version '%s' of page '%s'" version page)) + (log/info (format "Showing version '%s' of page '%s'" version page)) (layout/render "wiki.html" (merge (util/standard-params request) {:title (str (util/get-message :vers-col-hdr request) " " version " " (util/get-message :of request) " " page) @@ -274,7 +276,7 @@ page (url-decode (or (:page params) (util/get-message :default-page-title request))) version (:version params) file-name (str page ".md")] - (timbre/info (format "Showing diff between version '%s' of page '%s' and current" version page)) + (log/info (format "Showing diff between version '%s' of page '%s' and current" version page)) (layout/render "wiki.html" (merge (util/standard-params request) {:title @@ -303,11 +305,11 @@ action (:action form-params) user (session/get :user) redirect-to (:redirect-to params)] - (if redirect-to (timbre/info (str "After auth, redirect to: " redirect-to))) + (if redirect-to (log/info (str "After auth, redirect to: " redirect-to))) (cond (= action (util/get-message :logout-label request)) (do - (timbre/info (str "User " user " logging out")) + (log/info (str "User " user " logging out")) (session/remove! :user) (response/redirect redirect-to)) (and username password (auth/authenticate username password)) diff --git a/src/smeagol/uploads.clj b/src/smeagol/uploads.clj index 24f2c71..2adb69f 100644 --- a/src/smeagol/uploads.clj +++ b/src/smeagol/uploads.clj @@ -6,6 +6,7 @@ [image-resizer.core :refer [resize]] [image-resizer.util :refer :all] [me.raynes.fs :as fs] + [noir.io :as nio] [smeagol.configuration :refer [config]] [taoensso.timbre :as log]) (:import [java.io File] @@ -53,22 +54,26 @@ "Writes img, a RenderedImage, to dest, something that can be turned into a file with clojure.java.io/file. Takes the following keys as options: - :format - :gif, :jpg, :png or anything supported by ImageIO - :quality - for JPEG images, a number between 0 and 100" + :format - :gif, :jpg, :png or anything supported by ImageIO + :quality - for JPEG images, a number between 0 and 100" [^RenderedImage img dest & {:keys [format quality] :or {format :jpg}}] - (if (or (not quality) (not (contains? #{:jpg :jpeg} format))) - (ImageIO/write img (name format) (io/file dest)) - (let [fmt (rest (fs/extension (cs/lower-case dest))) - iw (doto ^ImageWriter (first - (iterator-seq - (ImageIO/getImageWritersByFormatName - "jpeg"))) - (.setOutput (FileImageOutputStream. (io/file dest)))) - iw-param (doto ^ImageWriteParam (.getDefaultWriteParam iw) - (.setCompressionMode ImageWriteParam/MODE_EXPLICIT) - (.setCompressionQuality (float (/ quality 100)))) - iio-img (IIOImage. img nil nil)] - (.write iw nil iio-img iw-param)))) + (log/info "Writing to " dest) + (let [fmt (subs (fs/extension (cs/lower-case dest)) 1) + iw (doto ^ImageWriter (first + (iterator-seq + (ImageIO/getImageWritersByFormatName + fmt))) + (.setOutput (FileImageOutputStream. (io/file dest)))) + iw-param (doto ^ImageWriteParam (.getDefaultWriteParam iw) + (.setCompressionMode ImageWriteParam/MODE_EXPLICIT) + (.setCompressionQuality (float (/ (or quality 75) 100)))) + iio-img (IIOImage. img nil nil)] + (.write iw nil iio-img iw-param))) + +(def image? + (memoize + (fn [filename] + (image-file-extns (fs/extension (cs/lower-case (str filename))))))) (defn auto-thumbnail "For each of the thumbnail sizes in the configuration, create a thumbnail @@ -76,19 +81,21 @@ scalable image and is larger than the size." ([^String path ^String filename] (if - (image-file-extns (fs/extension (cs/lower-case filename))) - (let [original (buffered-image (.File (str path filename)))] ;; fs/file? + (image? filename) + (let [original (buffered-image (File. (str path filename)))] ;; fs/file? (map #(auto-thumbnail path filename % original) (keys (config :thumbnails)))) (log/info filename " cannot be thumbnailed."))) ([^String path ^String filename size ^RenderedImage image] (let [s (-> config :thumbnails size) - d (dimensions image)] + d (dimensions image) + p (io/file path (name size) filename)] (if (and (integer? s) (some #(> % s) d)) (do - (write-image (resize image s s) (io/file path (name size) filename)) - (log/info "Created a " size " thumbnail of " filename)) + (write-image (resize image s s) p) + (log/info "Created a " size " thumbnail of " filename) + {:size size :filename filename :location (str p) :is-image true}) (log/info filename "is smaller than " s "x" s " and was not scaled to " size))))) (defn store-upload @@ -108,11 +115,16 @@ (str "store-upload mv file: " tmp-file " to: " path filename)) (if tmp-file (try - (do - (.renameTo tmp-file - (File. (str path filename))) ;; TODO: fs/file - (auto-thumbnail path filename) - (File. (str path filename))) + (let [p (io/file path filename)] + (.renameTo tmp-file p) + (remove + nil? + (cons + {:size :original + :filename filename + :location (str p) + :is-image (and (image? filename) true)} + (remove nil? (or (auto-thumbnail path filename) '()))))) (catch Exception x (log/error (str "Failed to move " tmp-file " to " path filename "; " (type x) ": " (.getMessage x))) (throw x))) diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index c3ce6d4..002556f 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -3,6 +3,7 @@ smeagol.util (:require [clojure.java.io :as cjio] [environ.core :refer [env]] + [me.raynes.fs :as fs] [noir.io :as io] [noir.session :as session] [scot.weft.i18n.core :as i18n] @@ -39,10 +40,11 @@ (:start-page config)) (def content-dir - (or - (:content-dir config) - (cjio/file (io/resource-path) "content"))) - + (str + (fs/absolute + (or + (:content-dir config) + (cjio/file (io/resource-path) "content"))))) (defn standard-params "Return a map of standard parameters to pass to the template renderer." From ba45ea51637085301d35bac0e5d8885844c6d2bd Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Mon, 10 Feb 2020 22:51:59 +0000 Subject: [PATCH 06/24] #47, #49: Auto-thumbnailing now working and configurable Not yet documented. --- resources/templates/upload.html | 10 ++++++---- src/smeagol/routes/wiki.clj | 1 - src/smeagol/uploads.clj | 33 ++++++++++++++++++--------------- 3 files changed, 24 insertions(+), 20 deletions(-) diff --git a/resources/templates/upload.html b/resources/templates/upload.html index bc469b4..3e63f17 100644 --- a/resources/templates/upload.html +++ b/resources/templates/upload.html @@ -1,14 +1,14 @@ {% extends "templates/base.html" %} {% block content %}
- {% if has-uploaded %} + {% if uploaded|not-empty %} {% for upload in uploaded %} - {{upload.filename}} - {% if upload.is-image %) + {% if upload.is-image %}

Uploaded image - {% i18n file-upload-link-text %}: + + This is the {{upload.size|name}} file. {% i18n file-upload-link-text %}: ![{{upload.filename}}]({{upload.resource}})

@@ -19,6 +19,8 @@ [{{upload.filename}}]({{upload.resource}})

{% endif %} +
+
{% endfor %} {% else %} diff --git a/src/smeagol/routes/wiki.clj b/src/smeagol/routes/wiki.clj index c21e81b..95c1828 100644 --- a/src/smeagol/routes/wiki.clj +++ b/src/smeagol/routes/wiki.clj @@ -250,7 +250,6 @@ (layout/render "upload.html" (merge (util/standard-params request) {:title (util/get-message :file-upload-title request) - :has-uploaded (not (empty? uploaded)) :uploaded uploaded})))) (defn version-page diff --git a/src/smeagol/uploads.clj b/src/smeagol/uploads.clj index 2adb69f..34f43c3 100644 --- a/src/smeagol/uploads.clj +++ b/src/smeagol/uploads.clj @@ -8,6 +8,7 @@ [me.raynes.fs :as fs] [noir.io :as nio] [smeagol.configuration :refer [config]] + [smeagol.util :as util] [taoensso.timbre :as log]) (:import [java.io File] [java.awt Image] @@ -80,13 +81,13 @@ for the file with this `filename` on this `path`, provided that it is a scalable image and is larger than the size." ([^String path ^String filename] - (if - (image? filename) - (let [original (buffered-image (File. (str path filename)))] ;; fs/file? - (map - #(auto-thumbnail path filename % original) - (keys (config :thumbnails)))) - (log/info filename " cannot be thumbnailed."))) + (if + (image? filename) + (let [original (buffered-image (File. (str path filename)))] ;; fs/file? + (map + #(auto-thumbnail path filename % original) + (keys (config :thumbnails)))) + (log/info filename " cannot be thumbnailed."))) ([^String path ^String filename size ^RenderedImage image] (let [s (-> config :thumbnails size) d (dimensions image) @@ -117,14 +118,16 @@ (try (let [p (io/file path filename)] (.renameTo tmp-file p) - (remove - nil? - (cons - {:size :original - :filename filename - :location (str p) - :is-image (and (image? filename) true)} - (remove nil? (or (auto-thumbnail path filename) '()))))) + (map + #(assoc % :resource (subs (:location %) (inc (count util/content-dir)))) + (remove + nil? + (cons + {:size :original + :filename filename + :location (str p) + :is-image (and (image? filename) true)} + (remove nil? (or (auto-thumbnail path filename) '())))))) (catch Exception x (log/error (str "Failed to move " tmp-file " to " path filename "; " (type x) ": " (.getMessage x))) (throw x))) From fc4dcdb5d3c10afdd94ded5f9fa99e1dfa1f9091 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Tue, 11 Feb 2020 08:30:03 +0000 Subject: [PATCH 07/24] Mainly documenting the configuration file --- resources/config.edn | 11 +- resources/public/content/Configuration.md | 33 ------ .../public/content/Configuring Smeagol.md | 102 ++++++++++++++++++ resources/public/content/Docker Image.md | 2 +- .../public/content/User Documentation.md | 2 +- resources/public/content/_side-bar.md | 1 + resources/templates/wiki.html | 8 +- src/smeagol/routes/wiki.clj | 7 +- 8 files changed, 120 insertions(+), 46 deletions(-) delete mode 100644 resources/public/content/Configuration.md create mode 100644 resources/public/content/Configuring Smeagol.md diff --git a/resources/config.edn b/resources/config.edn index 78390bb..35a85e4 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -28,22 +28,25 @@ ;; ; ; ; ; ; ; ; ; ; { :content-dir "resources/public/content" - :start-page "Introduction" ;; where content is served from. :default-locale "en-GB" ;; default language used for messages - :formatters {"vega" smeagol.formatting/process-vega + :formatters ;; formatters for processing markdown + ;; extensions. + {"vega" smeagol.formatting/process-vega "vis" smeagol.formatting/process-vega "mermaid" smeagol.extensions.mermaid/process-mermaid "backticks" smeagol.formatting/process-backticks "pswp" smeagol.formatting/process-photoswipe} :log-level :info ;; the minimum logging level; one of ;; :trace :debug :info :warn :error :fatal - :js-from :cloudflare ;; where to load JavaScript libraries - ;; from: options are :local, :cloudflare + :js-from :cdnjs ;; where to load JavaScript libraries + ;; from: options are :local, :cdnjs :passwd "resources/passwd" ;; where the password file is stored :site-title "Smeagol" ;; overall title of the site, used in ;; page headings + :start-page "Introduction" ;; the page shown to a visitor to the + ;; root URL. :thumbnails {:small 64 ;; maximum dimension of thumbnails ;; stored in the /small directory :med 400 ;; maximum dimension of thumbnails diff --git a/resources/public/content/Configuration.md b/resources/public/content/Configuration.md deleted file mode 100644 index 4e5d987..0000000 --- a/resources/public/content/Configuration.md +++ /dev/null @@ -1,33 +0,0 @@ -Smeagol reads a configuration file, whose content should be formatted as a clojure map. - -The default content is as follows: - -``` -{ - :site-title "Smeagol" ;; overall title of the site, used in page headings - :default-locale "en-GB" ;; default language used for messages - :content-dir "/usr/local/etc/content" - ;; where content is served from - :passwd "/usr/local/etc/passwd" - ;; where the password file is stored - :log-level :info ;; the minimum logging level; one of - ;; :trace :debug :info :warn :error :fatal - :formatters {"vega" smeagol.formatting/process-vega - "vis" smeagol.formatting/process-vega - "mermaid" smeagol.formatting/process-mermaid - "backticks" smeagol.formatting/process-backticks} -} -``` - -The values should be: - -* `:content-dir` The directory in which your editable content is stored; -* `:default-locale` A string comprising a lower-case [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code specifying a language, optionally followed by a hyphen and an upper-case [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) specifying a country. -* `:formatters` A map of formatters used in [[Extensible Markup]], q.v. -* `:log-level` The minimum level of log messages to be logged; one of `:trace :debug :info :warn :error :fatal` -* `:passwd` The path to your `passwd` file - see [[Security and authentication]]; -* `:site-title` The title for your wiki. - -The default file is at `resources/config.edn`; this default can be overridden by providing an environment variable, `SMEAGOL_CONFIG`, whose value is the full or relative pathname of a suitable file. - -Note that all the values in the configuration can be overridden with [[Environment Variables]]. diff --git a/resources/public/content/Configuring Smeagol.md b/resources/public/content/Configuring Smeagol.md new file mode 100644 index 0000000..8f6472e --- /dev/null +++ b/resources/public/content/Configuring Smeagol.md @@ -0,0 +1,102 @@ +Smeagol's core configuration comes from a configuration file, `config.edn`, which may be overridden by [[Environment Variables]]. The default file is at `resources/config.edn`; this default can be overridden by providing an environment variable, `SMEAGOL_CONFIG`, whose value is the full or relative pathname of a suitable file. + + +The default configuration file is as follows: + +``` + +{ + + :content-dir "resources/public/content" + + ;; where content is served from. + + :default-locale "en-GB" ;; default language used for messages + + :formatters ;; formatters for processing markdown + + ;; extensions. + + {"vega" smeagol.formatting/process-vega + + "vis" smeagol.formatting/process-vega + + "mermaid" smeagol.extensions.mermaid/process-mermaid + + "backticks" smeagol.formatting/process-backticks + + "pswp" smeagol.formatting/process-photoswipe} + + :log-level :info ;; the minimum logging level; one of + + ;; :trace :debug :info :warn :error :fatal + + :js-from :cdnjs ;; where to load JavaScript libraries + + ;; from: options are :local, :cdnjs + + :passwd "resources/passwd" + + ;; where the password file is stored + + :site-title "Smeagol" ;; overall title of the site, used in + + ;; page headings + + :start-page "Introduction" ;; the page shown to a visitor to the + + ;; root URL. + + :thumbnails {:small 64 ;; maximum dimension of thumbnails + + ;; stored in the /small directory + + :med 400 ;; maximum dimension of thumbnails + + ;; stored in the /med directory + + }} + +``` + + +## content-dir + +The value of `content-dir` should be the full or relative path to the content to be served: the Markdown files, and the upload directories. Full paths are advised, where possible. The directory must be readable and writable by the process running Smeagol. The default is `resources/public/conten` + + +The value from the configuration file may be overridden with the value of the environment variable `SMEAGOL_CONTENT_DIR`. + + +## default-locale + +The locale which you expect the majority of your visitors will use. Content negotiation will be done of course, and the best internationalisation file available will be used, but this sets a default for users who do not have any acceptable locale known to us. The default value is `en-GB`. + + +This parameter may be overridden with the environment variable `SMEAGOL-DEFAULT-LOCALE`. + + +## formatters + +Specifications for formatters for markup extensions. The exact data stored will change before Smeagol 1.1.0. TODO: update this. + + +## log-level + +The level at which logging should operate. Each setting implies all of the settings more severe than itself so + + +1. setting `:debug` will log all of `debug, info, warn, error` and| `fatal` messages; + +2. setting `:info` will log all of `info, warn, error` and| `fatal` messages; + + +and so on, so that setting `:fatal` will show only messages which report reasons for Smeagol to fail. + + +The default setting is `:info`. + + +This parameter may be overridden with the environment variable `SMEAGOL-LOG-LEVEL`. + +## TODO: Complete this doumentation! diff --git a/resources/public/content/Docker Image.md b/resources/public/content/Docker Image.md index 9341628..2a3f766 100644 --- a/resources/public/content/Docker Image.md +++ b/resources/public/content/Docker Image.md @@ -8,7 +8,7 @@ Where 127.0.0.1 is the IP address through which you want to forward port 80 (in You can then browse to Smeagol by pointing your browser at http://localhost/. -As of version 0.99.10, the Docker image is now based on the Jetty, rather than the Tomcat, deployment of Smeagol (that is to say, it runs the executable jar file). This makes for a lighter weight Docker image. All configuration can be overridden with [[Environment Variables]], which can be passed into the Docker container when the image is invoked, or from a [[Configuration]] file. +As of version 0.99.10, the Docker image is now based on the Jetty, rather than the Tomcat, deployment of Smeagol (that is to say, it runs the executable jar file). This makes for a lighter weight Docker image. All configuration can be overridden with [[Environment Variables]], which can be passed into the Docker container when the image is invoked, or from a Configuration file, see [[Configuring Smeagol]]. The `config.edn` and `passwd` files and the `content` directory are copied into `/usr/local/etc` in the Docker image, and the appropriate environment variables are set up to point to them: ``` diff --git a/resources/public/content/User Documentation.md b/resources/public/content/User Documentation.md index 51489af..604f317 100644 --- a/resources/public/content/User Documentation.md +++ b/resources/public/content/User Documentation.md @@ -67,7 +67,7 @@ To upload a file (including an image file), select the link `Upload a file` from Selecting the link will take you to the `Upload a file` page. This will prompt you for the file you wish to upload. Select your file, and then select the green `Save!` button. -After your file has uploaded, you will be shown a link which can be copied and pasted into a Wiki page to link to that file. +After your file has uploaded, you will be shown a link which can be copied and pasted into a Wiki page to link to that file. When you upload a PNG or JPG image file, multiple copies of the file may be saved at different resolutions, and you will be shown links to each of these. The `Upload a file` form also has a link to the list of all files which have been uploaded, to help with finding the one you're looking for! You must be logged in to upload files. diff --git a/resources/public/content/_side-bar.md b/resources/public/content/_side-bar.md index ad01779..6cfc4f2 100644 --- a/resources/public/content/_side-bar.md +++ b/resources/public/content/_side-bar.md @@ -1,6 +1,7 @@ * [[Introduction]] * [[Change log]] * [[User Documentation]] +* [[Configuring Smeagol]] * [[Deploying Smeagol]] * [[Developing Smeagol]] diff --git a/resources/templates/wiki.html b/resources/templates/wiki.html index 9413902..cf0655e 100644 --- a/resources/templates/wiki.html +++ b/resources/templates/wiki.html @@ -2,10 +2,10 @@ {% block extra-headers %} - {% script "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe-ui-default.min.js" %} - {% script "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe.min.js" %} - {% style "vendor/node_modules/photoswipe/dist/photoswipe.css" %} - {% style "vendor/node_modules/photoswipe/dist/default-skin/default-skin.css" %} + + + {% style "/vendor/node_modules/photoswipe/dist/photoswipe.css" %} + {% style "/vendor/node_modules/photoswipe/dist/default-skin/default-skin.css" %} diff --git a/src/smeagol/routes/wiki.clj b/src/smeagol/routes/wiki.clj index 95c1828..e33cbdc 100644 --- a/src/smeagol/routes/wiki.clj +++ b/src/smeagol/routes/wiki.clj @@ -240,12 +240,13 @@ uploaded (if upload (ul/store-upload params data-path)) user (session/get :user) summary (format "%s: %s" user (or (:summary params) "no summary"))] -;; (if -;; uploaded +;; TODO: Get this working! it MUST work! +;; (if-not +;; (empty? uploaded) ;; (do ;; (map ;; #(git/git-add git-repo (str :resource %)) -;; uploaded) +;; (remove nil? uploaded)) ;; (git/git-commit git-repo summary {:name user :email (auth/get-email user)}))) (layout/render "upload.html" (merge (util/standard-params request) From d2e20162ef6d36d8a41cb32c7d5e72cdfdcde22d Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Tue, 11 Feb 2020 13:14:36 +0000 Subject: [PATCH 08/24] Simplified syntax for Photoswipe galleries now works --- project.clj | 1 + resources/config.edn | 2 +- resources/public/content/Example gallery.md | 39 ++-- resources/public/content/Extensible Markup.md | 5 +- .../content/Simplified example gallery.md | 24 +++ src/smeagol/extensions/mermaid.clj | 2 +- src/smeagol/extensions/photoswipe.clj | 181 ++++++++++++++++++ src/smeagol/extensions/utils.clj | 75 +++++--- src/smeagol/formatting.clj | 26 +-- src/smeagol/util.clj | 3 + 10 files changed, 279 insertions(+), 79 deletions(-) create mode 100644 resources/public/content/Simplified example gallery.md create mode 100644 src/smeagol/extensions/photoswipe.clj diff --git a/project.clj b/project.clj index c92f098..b753cd1 100644 --- a/project.clj +++ b/project.clj @@ -17,6 +17,7 @@ [hiccup "1.0.5"] [im.chit/cronj "1.4.4"] [image-resizer "0.1.10"] + [instaparse "1.4.10"] [lib-noir "0.9.9" :exclusions [org.clojure/tools.reader]] [markdown-clj "0.9.99" :exclusions [com.keminglabs/cljx]] [me.raynes/fs "1.4.6"] diff --git a/resources/config.edn b/resources/config.edn index 35a85e4..059dfeb 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -36,7 +36,7 @@ "vis" smeagol.formatting/process-vega "mermaid" smeagol.extensions.mermaid/process-mermaid "backticks" smeagol.formatting/process-backticks - "pswp" smeagol.formatting/process-photoswipe} + "pswp" smeagol.extensions.photoswipe/process-photoswipe} :log-level :info ;; the minimum logging level; one of ;; :trace :debug :info :warn :error :fatal :js-from :cdnjs ;; where to load JavaScript libraries diff --git a/resources/public/content/Example gallery.md b/resources/public/content/Example gallery.md index 8379206..a2fcd00 100644 --- a/resources/public/content/Example gallery.md +++ b/resources/public/content/Example gallery.md @@ -1,8 +1,8 @@ -## The Gallery +## How this works -This page holds an example Photoswipe gallery. +The specification for this gallery is as follows: -```pswp +``` { slides: [ { src: 'content/uploads/g1.jpg', w: 2592, h:1944, @@ -21,11 +21,25 @@ This page holds an example Photoswipe gallery. ``` -## How this works +The format of the specification is [JSON](https://www.json.org/json-en.html); there are (at present) three keys, as follows -The specification for this gallery is as follows: +### slides -``` +Most be present. The value of `slides` is a list delimited by square brackets of slide objects. For more information, see the [authoritative documentation](https://photoswipe.com/documentation/getting-started.html) under the sub heading **'Creating an Array of Slide Objects'**. + +### options + +Optional. The value of `options` is a JSON object [as documented here](https://photoswipe.com/documentation/options.html). + +### openImmediately + +Optional. If the value of `openImmediately` is `true`, the gallery will open immediately, covering the whole page. If false, only a button with the label 'Open the gallery' will be shown. Selecting this button will cause the gallery to open. + +## The Gallery + +This page holds an example Photoswipe gallery. + +```pswp { slides: [ { src: 'content/uploads/g1.jpg', w: 2592, h:1944, @@ -44,16 +58,3 @@ The specification for this gallery is as follows: ``` -The format of the specification is [JSON](https://www.json.org/json-en.html); there are (at present) three keys, as follows - -### slides - -Most be present. The value of `slides` is a list delimited by square brackets of slide objects. For more information, see the [authoritative documentation](https://photoswipe.com/documentation/getting-started.html) under the sub heading **'Creating an Array of Slide Objects'**. - -### options - -Optional. The value of `options` is a JSON object [as documented here](https://photoswipe.com/documentation/options.html). - -### openImmediately - -Optional. If the value of `openImmediately` is `true`, the gallery will open immediately, covering the whole page. If false, only a button with the label 'Open the gallery' will be shown. Selecting this button will cause the gallery to open. diff --git a/resources/public/content/Extensible Markup.md b/resources/public/content/Extensible Markup.md index 3bc8301..41c9873 100644 --- a/resources/public/content/Extensible Markup.md +++ b/resources/public/content/Extensible Markup.md @@ -68,9 +68,8 @@ data/classes.mermaid ## Photoswipe galleries -Not so much a formatter, this is an extension to allow you to embed image galleries in your markdown. To specify a gallery, use three backticks followed by `pswp`, followed on the following lines by a Photoswipe specification in [JSON](https://www.json.org/json-en.html) -followed by three backticks on a line by themselves. There is an [[Example gallery]] so that you can see how this works. - +Not so much a formatter, this is an extension to allow you to embed image galleries in your markdown. To specify a gallery, use three backticks followed by `pswp`, followed on the following lines by a [Photoswipe](https://photoswipe.com/documentation/getting-started.html) specification in [JSON](https://www.json.org/json-en.html) +followed by three backticks on a line by themselves. There is an [[Example gallery]] with the full PhotoSwipe configuration, and a [[Simplified example gallery]] using a much simpler syntax, so that you can see how this works. ## Writing your own custom formatters diff --git a/resources/public/content/Simplified example gallery.md b/resources/public/content/Simplified example gallery.md new file mode 100644 index 0000000..4cff2da --- /dev/null +++ b/resources/public/content/Simplified example gallery.md @@ -0,0 +1,24 @@ +## How this works + +The specification for this gallery is as follows: + +``` +![Frost on a gate, Laurieston](content/uploads/g1.jpg) +![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) +![Feathered snow on log, Taliesin](content/uploads/g3.jpg) +![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg) +``` + +That's all there is to it - a sequence of image links just as you'd write them anywhere else in the wiki. + +## The Gallery + +This page holds another example Photoswipe gallery, this time using a simpler, Markdown-based specification. Processing this specification takes more work than the full syntax used in the other [Example gallery], so the gallery may be slower to load; but it's much easier to configure. + +```pswp +![Frost on a gate, Laurieston](content/uploads/g1.jpg) +![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) +![Feathered snow on log, Taliesin](content/uploads/g3.jpg) +![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg) +``` + diff --git a/src/smeagol/extensions/mermaid.clj b/src/smeagol/extensions/mermaid.clj index 9fe271b..6185b5d 100644 --- a/src/smeagol/extensions/mermaid.clj +++ b/src/smeagol/extensions/mermaid.clj @@ -1,4 +1,4 @@ -(ns ^{:doc "Format Semagol's extended markdown format." +(ns ^{:doc "Mermaid formatter for Semagol's extendsible markdown format." :author "Simon Brooke"} smeagol.extensions.mermaid (:require [smeagol.extensions.utils :refer :all] diff --git a/src/smeagol/extensions/photoswipe.clj b/src/smeagol/extensions/photoswipe.clj new file mode 100644 index 0000000..764a7a4 --- /dev/null +++ b/src/smeagol/extensions/photoswipe.clj @@ -0,0 +1,181 @@ +(ns ^{:doc "Photoswipe gallery formatter for Semagol's extendsible markdown + format." + :author "Simon Brooke"} + smeagol.extensions.photoswipe + (:require [clojure.data.json :as json] + [clojure.java.io :as cio] + [clojure.string :as cs] + [image-resizer.util :refer [buffered-image dimensions]] + [instaparse.core :as insta] + [me.raynes.fs :as fs] + [noir.io :as io] + [smeagol.configuration :refer [config]] + [smeagol.extensions.utils :refer :all] + [taoensso.timbre :as log])) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; Smeagol: a very simple Wiki engine. +;;;; +;;;; This program is free software; you can redistribute it and/or +;;;; modify it under the terms of the GNU General Public License +;;;; as published by the Free Software Foundation; either version 2 +;;;; of the License, or (at your option) any later version. +;;;; +;;;; This program is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with this program; if not, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2017 Simon Brooke +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(defn process-full-photoswipe + "Process a specification for a photoswipe gallery, using a JSON + specification based on that documented on the Photoswipe website." + [^String spec ^Integer index] + (str + "
\n" + (slurp + (str (io/resource-path) "html-includes/photoswipe-boilerplate.html")) + "
+ +

+
")) + + +(def simple-grammar + "Parser to transform a sequence of Markdown image links into something we + can build into JSON. Yes, this could all have been done with regexes, but + they are very inscrutable." + (insta/parser "SLIDE := START-CAPTION title END-CAPTION src END-SRC; + START-CAPTION := '![' ; + END-CAPTION := '](' ; + END-SRC := ')' ; + title := #'[^]]*' ; + src := #'[^)]*' ; + SPACE := #'[\\r\\n\\W]*'")) + +(defn simplify + [tree] + (if + (coll? tree) + (case (first tree) + :SLIDE (remove empty? (map simplify (rest tree))) + :title tree + :src tree + :START-CAPTION nil + :END-CAPTION nil + :END-SRC nil + (remove empty? (map simplify tree))))) + +(defn uploaded? + "Does this `url` string appear to be one that has been uploaded to our + `uploads` directory?" + [url] + (and + (cs/starts-with? (str url) "content/uploads") + (fs/exists? (cio/file upload-dir (fs/base-name url))))) + +;; (uploaded? "content/uploads/g1.jpg") + +(defn slide-merge-dimensions + "If this `slide` appears to be local, return it decorated with the + dimensions of the image it references." + [slide] + (let [url (:src slide) + dimensions (try + (if (uploaded? url) + (dimensions + (buffered-image (cio/file upload-dir (fs/base-name url))))) + (catch Exception x (.getMessage x)))] + (if dimensions + (assoc slide :w (first dimensions) :h (nth dimensions 1)) + slide))) + +;; (slide-merge-dimensions +;; {:title "Frost on a gate, Laurieston", +;; :src "content/uploads/g1.jpg"}) + +(defn process-simple-slide + [slide-spec] + (let [s (simplify (simple-grammar slide-spec)) + s'(zipmap (map first s) (map #(nth % 1) s)) + thumbsizes (:thumbnails config) + thumbsize (first + (sort + #(> (%1 thumbsizes) (%2 thumbsizes)) + (keys thumbsizes))) + url (:url s') + thumb (if + (and + (uploaded? url) + thumbsize) + (let [p (str (cio/file "uploads" (name thumbsize) (fs/base-name url))) + p' (cio/file content-dir p)] + (if + (and (fs/exists? p') (fs/readable? p')) + p)))] + (slide-merge-dimensions + (if thumb + (assoc s' :msrc thumb) + s')))) + +(def process-simple-photoswipe + "Process a simplified specification for a photoswipe gallery, comprising just + a sequence of MarkDown image links. This is REALLY expensive to do, we don't + want to do it often. Hence memoised." + (memoize + (fn + [^String spec ^Integer index] + (process-full-photoswipe + (json/write-str + {:slides (map + process-simple-slide + (re-seq #"!\[[^(]*\([^)]*\)" spec)) + ;; TODO: better to split slides in instaparse + :options { :timeToIdle 100 } + :openImmediately true}) index)))) + +;; (map +;; process-simple-slide +;; (re-seq #"!\[[^(]*\([^)]*\)" +;; "![Frost on a gate, Laurieston](content/uploads/g1.jpg) +;; ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) +;; ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) +;; ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)")) + +;; (process-simple-photoswipe +;; "![Frost on a gate, Laurieston](content/uploads/g1.jpg) +;; ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) +;; ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) +;; ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" +;; 1) + +(defn process-photoswipe + [^String url-or-pswp-spec ^Integer index] + (let [data (resource-url-or-data->data url-or-pswp-spec) + spec (cs/trim (:data data))] + (if + (cs/starts-with? spec "![") + (process-simple-photoswipe spec index) + (process-full-photoswipe spec index)))) diff --git a/src/smeagol/extensions/utils.clj b/src/smeagol/extensions/utils.clj index 06ed74c..c73d086 100644 --- a/src/smeagol/extensions/utils.clj +++ b/src/smeagol/extensions/utils.clj @@ -2,9 +2,11 @@ :author "Simon Brooke"} smeagol.extensions.utils (:require [cemerick.url :refer (url url-encode url-decode)] + [clojure.java.io :as cjio] [clojure.string :as cs] [me.raynes.fs :as fs] [noir.io :as io] + [smeagol.configuration :refer [config]] [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -30,7 +32,17 @@ ;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(defn resource-url-or-data->data +(def content-dir + (str + (fs/absolute + (or + (:content-dir config) + (cjio/file (io/resource-path) "content"))))) + +(def upload-dir + (str (cjio/file content-dir "uploads"))) + +(def resource-url-or-data->data "Interpret this `resource-url-or-data` string as data to be digested by a `process-extension` function. It may be a URL or the pathname of a local resource, in which case the content should be fetched; or it may just be @@ -40,33 +52,34 @@ `:text`, and a key `:data` whose value is the data. There will be an additional key being the value of the `:from` key, whose value will be the source of the data." - [^String resource-url-or-data] - (let [default {:from :text - :text resource-url-or-data - :data resource-url-or-data}] - (try - (try - ;; is it a URL? - (let [url (str (url resource-url-or-data)) - result (slurp url)] - {:from :url - :url url - :data result}) - (catch java.net.MalformedURLException _ - ;; no. So is it a path to a local resource? - (let [t (cs/trim resource-url-or-data) - r (str (io/resource-path) t)] - (if - (fs/file? r) - {:from :resource - :resource t - :data (slurp r)} - default)))) - (catch Exception x - (log/error - "Could not read mermaid graph specification from `" - (cs/trim resource-url-or-data) - "` because " - (.getName (.getClass x)) - (.getMessage x) ) - default)))) + (memoize + (fn [^String resource-url-or-data] + (let [default {:from :text + :text resource-url-or-data + :data resource-url-or-data}] + (try + (try + ;; is it a URL? + (let [url (str (url resource-url-or-data)) + result (slurp url)] + {:from :url + :url url + :data result}) + (catch java.net.MalformedURLException _ + ;; no. So is it a path to a local resource? + (let [t (cs/trim resource-url-or-data) + r (str (io/resource-path) t)] + (if + (fs/file? r) + {:from :resource + :resource t + :data (slurp r)} + default)))) + (catch Exception x + (log/error + "Could not read mermaid graph specification from `" + (cs/trim resource-url-or-data) + "` because " + (.getName (.getClass x)) + (.getMessage x) ) + default)))))) diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 357f6aa..fa4f2f6 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -6,9 +6,9 @@ [cemerick.url :refer (url url-encode url-decode)] [clj-yaml.core :as yaml] [markdown.core :as md] - [noir.io :as io] ;; used by photoswipe, only [smeagol.configuration :refer [config]] - [smeagol.extensions.mermaid :refer [process-mermaid]])) + [smeagol.extensions.mermaid :refer [process-mermaid]] + [smeagol.extensions.photoswipe :refer [process-photoswipe]])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -86,28 +86,6 @@ index ");\n//]]\n")) -(defn process-photoswipe - "Process specification for a photoswipe gallery" - [^String spec ^Integer index] - (str - "
\n" - (slurp (str (io/resource-path) "html-includes/photoswipe-boilerplate.html")) - "
- -

-
")) - (defn process-backticks "Effectively, escape the backticks surrounding this `text`, by protecting them diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index 002556f..1ef44df 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -46,6 +46,9 @@ (:content-dir config) (cjio/file (io/resource-path) "content"))))) +(def upload-dir + (str (cjio/file content-dir "uploads"))) + (defn standard-params "Return a map of standard parameters to pass to the template renderer." [request] From b191f40d05c3dd64141ff59ecb9b13dd31db7373 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Tue, 11 Feb 2020 17:01:14 +0000 Subject: [PATCH 09/24] #47: warn if dimensions cannot be established. --- src/smeagol/extensions/photoswipe.clj | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/smeagol/extensions/photoswipe.clj b/src/smeagol/extensions/photoswipe.clj index 764a7a4..31c6e42 100644 --- a/src/smeagol/extensions/photoswipe.clj +++ b/src/smeagol/extensions/photoswipe.clj @@ -110,7 +110,9 @@ (catch Exception x (.getMessage x)))] (if dimensions (assoc slide :w (first dimensions) :h (nth dimensions 1)) - slide))) + (do + (log/warn "Failed to fetch dimensions of image " url) + slide)))) ;; (slide-merge-dimensions ;; {:title "Frost on a gate, Laurieston", From 0d686a9b6338f000219dfd5ef0cb1ac33f7abc71 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Wed, 12 Feb 2020 12:35:18 +0000 Subject: [PATCH 10/24] #47: Something well broken here, but I'm on the right path Fragment indices are being returned instead of fragments, and it does not seem that the extension formatters are being called at all. But... config is definitely improved in the right direction. --- project.clj | 1 + resources/config.edn | 11 ++++++----- .../content/Simplified example gallery.md | 2 +- src/smeagol/extensions/photoswipe.clj | 17 +++++++++++------ src/smeagol/formatting.clj | 15 +++++++++++++-- 5 files changed, 32 insertions(+), 14 deletions(-) diff --git a/project.clj b/project.clj index b753cd1..3898e1c 100644 --- a/project.clj +++ b/project.clj @@ -27,6 +27,7 @@ [org.clojure/core.memoize "0.5.9"] [org.clojure/data.json "0.2.6"] [org.clojure/tools.logging "0.4.0"] + [org.clojure/tools.trace "0.7.10"] [org.slf4j/slf4j-api "1.7.25"] [org.slf4j/log4j-over-slf4j "1.7.25"] [org.slf4j/jul-to-slf4j "1.7.25"] diff --git a/resources/config.edn b/resources/config.edn index 059dfeb..6ff0faf 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -32,11 +32,12 @@ :default-locale "en-GB" ;; default language used for messages :formatters ;; formatters for processing markdown ;; extensions. - {"vega" smeagol.formatting/process-vega - "vis" smeagol.formatting/process-vega - "mermaid" smeagol.extensions.mermaid/process-mermaid - "backticks" smeagol.formatting/process-backticks - "pswp" smeagol.extensions.photoswipe/process-photoswipe} + {:vega {:formatter "smeagol.extensions.vega/process-vega" } + :vis {:formatter "smeagol.extensions.vega/process-vega" } + :mermaid {:formatter "smeagol.extensions.mermaid/process-mermaid" } + :backticks {:formatter "smeagol.formatting/process-backticks" } + :pswp {:formatter "smeagol.extensions.photoswipe/process-photoswipe" } + } :log-level :info ;; the minimum logging level; one of ;; :trace :debug :info :warn :error :fatal :js-from :cdnjs ;; where to load JavaScript libraries diff --git a/resources/public/content/Simplified example gallery.md b/resources/public/content/Simplified example gallery.md index 4cff2da..eac0394 100644 --- a/resources/public/content/Simplified example gallery.md +++ b/resources/public/content/Simplified example gallery.md @@ -13,7 +13,7 @@ That's all there is to it - a sequence of image links just as you'd write them a ## The Gallery -This page holds another example Photoswipe gallery, this time using a simpler, Markdown-based specification. Processing this specification takes more work than the full syntax used in the other [Example gallery], so the gallery may be slower to load; but it's much easier to configure. +This page holds another example Photoswipe gallery, this time using a simpler, Markdown-based specification. Processing this specification takes more work than the full syntax used in the other [[Example gallery]], so the gallery may be slower to load; but it's much easier to configure. ```pswp ![Frost on a gate, Laurieston](content/uploads/g1.jpg) diff --git a/src/smeagol/extensions/photoswipe.clj b/src/smeagol/extensions/photoswipe.clj index 31c6e42..2df235e 100644 --- a/src/smeagol/extensions/photoswipe.clj +++ b/src/smeagol/extensions/photoswipe.clj @@ -174,10 +174,15 @@ ;; 1) (defn process-photoswipe - [^String url-or-pswp-spec ^Integer index] + [^String url-or-pswp-spec ^Integer index] + (log/info "process-photoswipe called with arg1 `" + url-or-pswp-spec "`; arg2 `" index "`.") (let [data (resource-url-or-data->data url-or-pswp-spec) - spec (cs/trim (:data data))] - (if - (cs/starts-with? spec "![") - (process-simple-photoswipe spec index) - (process-full-photoswipe spec index)))) + spec (cs/trim (:data data)) + result + (if + (cs/starts-with? spec "![") + (process-simple-photoswipe spec index) + (process-full-photoswipe spec index))] + (log/info "process-photoswipe returning `" result "`.") + )) diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index fa4f2f6..87d8f45 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -8,7 +8,8 @@ [markdown.core :as md] [smeagol.configuration :refer [config]] [smeagol.extensions.mermaid :refer [process-mermaid]] - [smeagol.extensions.photoswipe :refer [process-photoswipe]])) + [smeagol.extensions.photoswipe :refer [process-photoswipe]] + [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -149,7 +150,17 @@ ;; I need to put the backticks back in. remarked (if (odd? index) (str "```" fragment "\n```") fragment) first-token (get-first-token fragment) - formatter (eval ((:formatters config) first-token))] + formatter (if-not + (empty? first-token) + (try + (let [kw (keyword first-token)] + (read-string (-> config :formatters kw :formatter))) + (catch Exception _ + (do + (log/info "No formatter found for extension `" first-token "`") + ;; no extension registered - there sometimes won't be, + ;; and it doesn't matter + nil))))] (cond (empty? fragments) (assoc result :text From 2f22b733c1800ee6c07a23e866355c9932602982 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Wed, 12 Feb 2020 21:13:36 +0000 Subject: [PATCH 11/24] Tidy up alphordered includes, standardised on use 'log' as alias for timbre. --- src/smeagol/authenticate.clj | 20 ++++++++++---------- src/smeagol/configuration.clj | 12 ++++++------ src/smeagol/formatting.clj | 30 +++++++++++++++++++++++++----- src/smeagol/handler.clj | 12 ++++++------ src/smeagol/history.clj | 9 +++++---- src/smeagol/layout.clj | 3 +-- src/smeagol/middleware.clj | 14 +++++++------- src/smeagol/util.clj | 4 ++-- 8 files changed, 62 insertions(+), 42 deletions(-) diff --git a/src/smeagol/authenticate.clj b/src/smeagol/authenticate.clj index e4219e9..fec7e7a 100644 --- a/src/smeagol/authenticate.clj +++ b/src/smeagol/authenticate.clj @@ -5,7 +5,7 @@ [environ.core :refer [env]] [noir.io :as io] [smeagol.configuration :refer [config]] - [taoensso.timbre :as timbre])) + [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -52,7 +52,7 @@ "Return `true` if this `username`/`password` pair match, `false` otherwise" [username password] (let [user ((keyword username) (get-users))] - (timbre/info (str "Authenticating " username " against " password-file-path)) + (log/info (str "Authenticating " username " against " password-file-path)) (and user (:password user) (or @@ -92,7 +92,7 @@ Return `true` if password was successfully changed. Subsequent to user change, their password will be encrypted." [username oldpass newpass] - (timbre/info (format "Changing password for user %s" username)) + (log/info (format "Changing password for user %s" username)) (let [users (get-users) keywd (keyword username) user (keywd users) @@ -110,10 +110,10 @@ {keywd (merge user {:password (password/encrypt newpass)})}))) - (timbre/info (str "Successfully changed password for user " username)) + (log/info (str "Successfully changed password for user " username)) true)) (catch Exception any - (timbre/error any + (log/error any (format "Changing password failed for user %s failed: %s (%s)" username (.getName (.getClass any)) (.getMessage any))) false)))) @@ -138,7 +138,7 @@ `email` address and `admin` flag; *or*, modify an existing user. Return true if user is successfully stored, false otherwise." [username newpass email admin] - (timbre/info "Trying to add user " username) + (log/info "Trying to add user " username) (cond (not (string? username)) (throw (Exception. "Username must be a string.")) (zero? (count username)) (throw (Exception. "Username cannot be zero length")) @@ -160,10 +160,10 @@ (locking password-file-path (spit password-file-path (assoc users (keyword username) (merge user full-details))) - (timbre/info "Successfully added user " username) + (log/info "Successfully added user " username) true) (catch Exception any - (timbre/error any + (log/error any (format "Adding user %s failed: %s (%s)" username (.getName (.getClass any)) (.getMessage any))) false))))) @@ -177,10 +177,10 @@ (locking password-file-path (spit password-file-path (dissoc users (keyword username))) - (timbre/info (str "Successfully deleted user " username)) + (log/info (str "Successfully deleted user " username)) true) (catch Exception any - (timbre/error any + (log/error any (format "Deleting user %s failed: %s (%s)" username (.getName (.getClass any)) (.getMessage any))) false)))) diff --git a/src/smeagol/configuration.clj b/src/smeagol/configuration.clj index 025292a..24d1e55 100644 --- a/src/smeagol/configuration.clj +++ b/src/smeagol/configuration.clj @@ -5,7 +5,7 @@ [clojure.string :as s] [environ.core :refer [env]] [noir.io :as io] - [taoensso.timbre :as timbre])) + [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -73,7 +73,7 @@ and optionally a key :transform, whose value is a function of one argument to be used to transform the value of that key." [m tuples] - (timbre/debug + (log/debug "transform-map:\n" (with-out-str (clojure.pprint/pprint m))) (reduce @@ -112,11 +112,11 @@ file is read (if it is specified and present), but that individual values can be overridden by environment variables." (try - (timbre/info (str "Reading configuration from " config-file-path)) + (log/info (str "Reading configuration from " config-file-path)) (let [file-contents (try (read-string (slurp config-file-path)) (catch Exception x - (timbre/error + (log/error (str "Failed to read configuration from " config-file-path @@ -138,12 +138,12 @@ :smeagol-site-title) config-env-transforms))] (if (env :dev) - (timbre/debug + (log/debug "Loaded configuration\n" (with-out-str (clojure.pprint/pprint config)))) config) (catch Exception any - (timbre/error any "Could not load configuration") + (log/error any "Could not load configuration") {}))) (def config (build-config)) diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 87d8f45..8eff3ec 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -44,6 +44,7 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Error to show if text to be rendered is nil. +;; TODO: this should go through i18n (def no-text-error "No text: does the file exist?") @@ -150,28 +151,43 @@ ;; I need to put the backticks back in. remarked (if (odd? index) (str "```" fragment "\n```") fragment) first-token (get-first-token fragment) + kw (if-not (empty? first-token) (keyword first-token)) formatter (if-not (empty? first-token) (try - (let [kw (keyword first-token)] - (read-string (-> config :formatters kw :formatter))) + (read-string (-> config :formatters kw :formatter)) (catch Exception _ (do - (log/info "No formatter found for extension `" first-token "`") + (log/info "No formatter found for extension `" kw "`") ;; no extension registered - there sometimes won't be, ;; and it doesn't matter nil))))] (cond (empty? fragments) + ;; We've come to the end of the list of fragments. Reassemble them into + ;; a single HTML text and pass it back. (assoc result :text (local-links (md/md-to-html-string (cs/join "\n\n" (reverse processed)) :heading-anchors true))) formatter - (apply-formatter index result fragments processed fragment first-token formatter) + ;; We've found a formatter to apply to the current fragment, and recurse + ;; on down the list + (let [result (apply-formatter + index + result + fragments + processed + fragment + first-token + formatter)] + (assoc result :extensions (cons kw (:extensions result)))) true - (process-markdown-fragment index result remarked (rest fragments) processed))))) + ;; Otherwise process the current fragment as markdown and recurse on + ;; down the list + (process-markdown-fragment + index result remarked (rest fragments) processed))))) (defn reintegrate-inclusions @@ -182,6 +198,10 @@ ([inclusions text] (let [ks (keys inclusions)] (if (empty? (keys inclusions)) + ;; TODO: this is one opportunity to add scripts at the end of the + ;; constructed text. I've a feeling that that would be a mistake and + ;; that instead we should hand back a map comprising the text and the + ;; keys of the extensions text (let [kw (first ks)] (reintegrate-inclusions diff --git a/src/smeagol/handler.clj b/src/smeagol/handler.clj index 9cbaca5..db580e6 100644 --- a/src/smeagol/handler.clj +++ b/src/smeagol/handler.clj @@ -16,7 +16,7 @@ [smeagol.routes.wiki :refer [wiki-routes]] [smeagol.middleware :refer [load-middleware]] [smeagol.session-manager :as session-manager] - [taoensso.timbre :as timbre] + [taoensso.timbre :as log] [taoensso.timbre.appenders.3rd-party.rotor :as rotor])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -55,9 +55,9 @@ "destroy will be called when your application shuts down, put any clean up code here" [] - (timbre/info "smeagol is shutting down...") + (log/info "smeagol is shutting down...") (cronj/shutdown! session-manager/cleanup-job) - (timbre/info "shutdown complete!")) + (log/info "shutdown complete!")) (defn init @@ -67,7 +67,7 @@ put any initialization code here" [] (try - (timbre/merge-config! + (log/merge-config! {:appenders {:rotor (rotor/rotor-appender {:path "smeagol.log" @@ -80,10 +80,10 @@ (cronj/start! session-manager/cleanup-job) (if (env :dev) (parser/cache-off!)) ;;start the expired session cleanup job - (timbre/info "\n-=[ smeagol started successfully" + (log/info "\n-=[ smeagol started successfully" (when (env :dev) "using the development profile") "]=-") (catch Exception any - (timbre/error any "Failure during startup") + (log/error any "Failure during startup") (destroy)))) ;; timeout sessions after 30 minutes diff --git a/src/smeagol/history.clj b/src/smeagol/history.clj index aca6dbe..e567db3 100644 --- a/src/smeagol/history.clj +++ b/src/smeagol/history.clj @@ -1,10 +1,10 @@ (ns ^{:doc "Explore the history of a page." :author "Simon Brooke"} smeagol.history - (:require [taoensso.timbre :as timbre] - [clj-jgit.porcelain :as git] + (:require [clj-jgit.porcelain :as git] [clj-jgit.internal :as i] - [clj-jgit.querying :as q]) + [clj-jgit.querying :as q] + [taoensso.timbre :as log]) (:import [org.eclipse.jgit.api Git] [org.eclipse.jgit.lib Repository ObjectId] [org.eclipse.jgit.revwalk RevCommit RevTree RevWalk] @@ -39,7 +39,7 @@ "If this `log-entry` contains a reference to this `file-path`, return the entry; else nil." [^String log-entry ^String file-path] - (timbre/info (format "searching '%s' for '%s'" log-entry file-path)) + (log/info (format "searching '%s' for '%s'" log-entry file-path)) (cond (seq (filter (fn* [p1__341301#] (= (first p1__341301#) file-path)) (:changed_files log-entry))) log-entry)) @@ -54,6 +54,7 @@ (try (git/load-repo git-directory-path) (catch java.io.FileNotFoundException fnf + (log/info "Initialising Git repository at" git-directory-path) (git/git-init git-directory-path) (let [repo (git/load-repo git-directory-path)] (git/git-add-and-commit repo "Initial commit") diff --git a/src/smeagol/layout.clj b/src/smeagol/layout.clj index 34a7d0a..920a9b1 100644 --- a/src/smeagol/layout.clj +++ b/src/smeagol/layout.clj @@ -12,8 +12,7 @@ [selmer.parser :as parser] [smeagol.configuration :refer [config]] [smeagol.sanity :refer :all] - [smeagol.util :as util] - [taoensso.timbre :as timbre])) + [smeagol.util :as util])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; diff --git a/src/smeagol/middleware.clj b/src/smeagol/middleware.clj index 92cfac0..4ca288d 100644 --- a/src/smeagol/middleware.clj +++ b/src/smeagol/middleware.clj @@ -1,17 +1,17 @@ (ns ^{:doc "In truth, boilerplate provided by LuminusWeb." :author "Simon Brooke"} smeagol.middleware - (:require [taoensso.timbre :as timbre] - [environ.core :refer [env]] - [selmer.middleware :refer [wrap-error-page]] + (:require [environ.core :refer [env]] + [noir-exception.core :refer [wrap-internal-error]] [prone.middleware :refer [wrap-exceptions]] [ring.middleware.anti-forgery :refer [wrap-anti-forgery]] [ring.middleware.file :refer [wrap-file]] [ring.middleware.resource :refer [wrap-resource]] [ring.middleware.content-type :refer [wrap-content-type]] [ring.middleware.not-modified :refer [wrap-not-modified]] - [noir-exception.core :refer [wrap-internal-error]] - [smeagol.util :as util])) + [selmer.middleware :refer [wrap-error-page]] + [smeagol.util :as util] + [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -39,7 +39,7 @@ (defn log-request [handler] (fn [req] - (timbre/debug req) + (log/debug req) (handler req))) @@ -49,7 +49,7 @@ (def production-middleware - [#(wrap-internal-error % :log (fn [e] (timbre/error e))) + [#(wrap-internal-error % :log (fn [e] (log/error e))) #(wrap-resource % "public") #(wrap-file % util/content-dir {:index-files? false :prefer-handler? true}) diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index 1ef44df..0a5863a 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -10,7 +10,7 @@ [smeagol.authenticate :as auth] [smeagol.configuration :refer [config]] [smeagol.formatting :refer [md->html]] - [taoensso.timbre :as timbre])) + [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -69,7 +69,7 @@ messages (try (i18n/get-messages specifier "i18n" "en-GB") (catch Exception any - (timbre/error + (log/error any (str "Failed to parse accept-language header '" From 40ab296d1a4c7130323e48f0363cea8e424d9b4d Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Thu, 13 Feb 2020 14:44:52 +0000 Subject: [PATCH 12/24] #45: OK, it doesn't work, but it's close. Still getting fragment index instead of fragment text. --- resources/config.edn | 28 ++++++++++++++--- resources/templates/wiki.html | 20 ++++-------- src/smeagol/formatting.clj | 14 +++++++-- src/smeagol/routes/wiki.clj | 59 +++++++++++++++++++++++++++-------- src/smeagol/util.clj | 4 +-- 5 files changed, 88 insertions(+), 37 deletions(-) diff --git a/resources/config.edn b/resources/config.edn index 6ff0faf..7c462b3 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -32,11 +32,29 @@ :default-locale "en-GB" ;; default language used for messages :formatters ;; formatters for processing markdown ;; extensions. - {:vega {:formatter "smeagol.extensions.vega/process-vega" } - :vis {:formatter "smeagol.extensions.vega/process-vega" } - :mermaid {:formatter "smeagol.extensions.mermaid/process-mermaid" } - :backticks {:formatter "smeagol.formatting/process-backticks" } - :pswp {:formatter "smeagol.extensions.photoswipe/process-photoswipe" } + {:vega {:formatter "smeagol.extensions.vega/process-vega" + :scripts {:core {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega/5.9.1/vega.min.js"} + :lite {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-lite/4.1.1/vega-lite.min.js"} + :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"} + :styles {}}} + :vis {:formatter "smeagol.extensions.vega/process-vega" + :scripts {:core {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega/5.9.1/vega.min.js"} + :lite {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-lite/4.1.1/vega-lite.min.js"} + :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"} + :styles {}}} + :mermaid {:formatter "smeagol.extensions.mermaid/process-mermaid" + :scripts {:core {:local "vendor/mermaid/dist/mermaid.js"}} + :styles {}} + :backticks {:formatter "smeagol.formatting/process-backticks" + :scripts {} + :styles {}} + :pswp {:formatter "smeagol.extensions.photoswipe/process-photoswipe" + :scripts {:core {:local "/vendor/node_modules/photoswipe/dist/photoswipe.min.js" + :remote "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe.min.js"} + :ui {:local "/vendor/node_modules/photoswipe/dist/photoswipe-ui-default.min.js" + :remote "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe-ui-default.min.js"}} + :styles {:core {:local "/vendor/node_modules/photoswipe/dist/photoswipe.css" + :remote "/vendor/node_modules/photoswipe/dist/default-skin/default-skin.css"}}} } :log-level :info ;; the minimum logging level; one of ;; :trace :debug :info :warn :error :fatal diff --git a/resources/templates/wiki.html b/resources/templates/wiki.html index cf0655e..7342854 100644 --- a/resources/templates/wiki.html +++ b/resources/templates/wiki.html @@ -1,20 +1,12 @@ {% extends "templates/base.html" %} {% block extra-headers %} - - - - {% style "/vendor/node_modules/photoswipe/dist/photoswipe.css" %} - {% style "/vendor/node_modules/photoswipe/dist/default-skin/default-skin.css" %} - - - - - - - - + {% for script in scripts %} + + {% endfor %} + {% for style in styles %} + + {% endfor %} {% endblock %} {% block content %} diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 8eff3ec..115a2ca 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -182,7 +182,7 @@ fragment first-token formatter)] - (assoc result :extensions (cons kw (:extensions result)))) + (assoc-in result [:extensions kw] (-> config :formatters kw))) true ;; Otherwise process the current fragment as markdown and recurse on ;; down the list @@ -194,7 +194,12 @@ "Given a map of the form produced by `process-text`, return a string of HTML text with the inclusions (if any) reintegrated." ([processed-text] - (reintegrate-inclusions (:inclusions processed-text) (:text processed-text))) + (assoc + processed-text + :content + (reintegrate-inclusions + (:inclusions processed-text) + (:text processed-text)))) ([inclusions text] (let [ks (keys inclusions)] (if (empty? (keys inclusions)) @@ -213,7 +218,10 @@ (defn md->html - "Take this markdown source, and return HTML." + "Take this `md-src` markdown source, and return a map in which: + 1. the key `:content` is bound to the equivalent HTML source; + 2. the key `:extensions`. is bound to details of the extensions + used." [md-src] (reintegrate-inclusions (process-text md-src))) diff --git a/src/smeagol/routes/wiki.clj b/src/smeagol/routes/wiki.clj index e33cbdc..e4ca7ba 100644 --- a/src/smeagol/routes/wiki.clj +++ b/src/smeagol/routes/wiki.clj @@ -25,6 +25,7 @@ [smeagol.uploads :as ul] [taoensso.timbre :as log] [com.stuartsierra.component :as component] + [smeagol.configuration :refer [config]] [smeagol.include.resolve-local-file :as resolve] [smeagol.include :as include])) @@ -123,6 +124,34 @@ (include/new-includer) [:resolver])))) +(defn preferred-source + "Here, `component` is expected to be a map with two keys, `:local` and + `:remote`. If the value of `:extensions-from` in `config.edn` is remote + AND the value of `:remote` is not nil, then the value of `:remote` will + be returned. Otherwise, if the value of `:local` is nil and the value of + `:remote` is non-nil, the value of `:remote` will be returned. By default, + the value of `:local` will be returned." + [component] + (let [l (:local component) ;; TODO: look at the trick in Selmer to get relative URL + r (:remote component)] + (cond + (= (:extensions-from config) :remote) (if (empty? r) l r) + (empty? l) r + :else l))) + +(defn collect-preferred + "From extensions referenced in this `processed-text`, extract the preferred + URLs for this keyword `k`, expected to be either `:scripts` or `:styles`." + [processed-text k] + (set + (remove + nil? + (map + preferred-source + (apply + concat + (map vals (map k (vals (:extensions processed-text))))))))) + (defn wiki-page "Render the markdown page specified in this `request`, if any. If none found, redirect to edit-page" [request] @@ -134,19 +163,23 @@ file-name (str page ".md") file-path (cjio/file util/content-dir file-name) exists? (.exists (clojure.java.io/as-file file-path))] - (cond exists? - (do - (log/info (format "Showing page '%s' from file '%s'" page file-path)) - (layout/render "wiki.html" - (merge (util/standard-params request) - {:title page - :page page - :content (md->html - (include/expand-include-md - (:includer md-include-system) - (slurp file-path))) - :editable true}))) - true (response/redirect (str "/edit?page=" page)))))) + (if exists? + (do + (log/info (format "Showing page '%s' from file '%s'" page file-path)) + (let [processed-text (md->html + (include/expand-include-md + (:includer md-include-system) + (slurp file-path)))] + (layout/render "wiki.html" + (merge (util/standard-params request) + processed-text + {:title page + :scripts (collect-preferred processed-text :scripts) + :styles (collect-preferred processed-text :styles) + :page page + :editable true})))) + ;else + (response/redirect (str "/edit?page=" page)))))) (defn history-page diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index 0a5863a..972a0a7 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -56,8 +56,8 @@ {:user user :admin (auth/get-admin user) :js-from (:js-from config) - :side-bar (md->html (slurp (cjio/file content-dir "_side-bar.md"))) - :header (md->html (slurp (cjio/file content-dir "_header.md"))) + :side-bar (:content (md->html (slurp (cjio/file content-dir "_side-bar.md")))) + :header (:content (md->html (slurp (cjio/file content-dir "_header.md")))) :version (System/getProperty "smeagol.version")})) From 8032ad60af1de27bb8a273c38ce3a4c5f00aacfe Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Thu, 13 Feb 2020 19:46:58 +0000 Subject: [PATCH 13/24] No actual progress. --- src/smeagol/extensions/photoswipe.clj | 5 ++-- src/smeagol/formatting.clj | 43 ++++++++------------------- 2 files changed, 15 insertions(+), 33 deletions(-) diff --git a/src/smeagol/extensions/photoswipe.clj b/src/smeagol/extensions/photoswipe.clj index 2df235e..ee80792 100644 --- a/src/smeagol/extensions/photoswipe.clj +++ b/src/smeagol/extensions/photoswipe.clj @@ -175,8 +175,6 @@ (defn process-photoswipe [^String url-or-pswp-spec ^Integer index] - (log/info "process-photoswipe called with arg1 `" - url-or-pswp-spec "`; arg2 `" index "`.") (let [data (resource-url-or-data->data url-or-pswp-spec) spec (cs/trim (:data data)) result @@ -184,5 +182,6 @@ (cs/starts-with? spec "![") (process-simple-photoswipe spec index) (process-full-photoswipe spec index))] - (log/info "process-photoswipe returning `" result "`.") +;; (log/info "process-photoswipe returning `" result "`.") + result )) diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 115a2ca..3bb0d63 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -63,32 +63,9 @@ no-text-error)) -(defn yaml->json - "Rewrite this string, assumed to be in YAML format, as JSON." - [^String yaml-src] - (json/write-str (yaml/parse-string yaml-src))) - - (declare process-text) -(defn process-vega - "Process this `vega-src` string, assumed to be in YAML format, into a specification - of a Vega chart, and add the plumbing to render it." - [^String vega-src ^Integer index] - (str - "
\n" - "")) - - (defn process-backticks "Effectively, escape the backticks surrounding this `text`, by protecting them from the `md->html` filter." @@ -117,7 +94,7 @@ (cons fragment processed))) -(defn- apply-formatter +(defn apply-formatter "Within the context of `process-text`, process a fragment for which an explicit §formatter has been identified. @@ -128,11 +105,14 @@ [index result fragments processed fragment token formatter] (let [kw (keyword (str "inclusion-" index))] - (process-text - (inc index) - (assoc-in result [:inclusions kw] (apply formatter (list (subs fragment (count token)) index))) - (rest fragments) - (cons kw processed)))) + (assoc-in + (process-text + (inc index) + result + (rest fragments) + (cons kw processed)) + [:inclusions kw] + (apply formatter (list (subs fragment (count token)) index))))) (defn process-text @@ -182,8 +162,11 @@ fragment first-token formatter)] + ;; TODO: consistency: either these things are `extensions`, or + ;; they're `formatters`. I incline to the view that they're + ;; `:extensions` (assoc-in result [:extensions kw] (-> config :formatters kw))) - true + :else ;; Otherwise process the current fragment as markdown and recurse on ;; down the list (process-markdown-fragment From 37d850d30afaef02ecc440ba799e4874fb05e9a9 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Thu, 13 Feb 2020 21:07:36 +0000 Subject: [PATCH 14/24] Still no actual progress. --- resources/config.edn | 27 +++++----- src/smeagol/extensions/photoswipe.clj | 8 +-- src/smeagol/extensions/test.clj | 10 ++++ src/smeagol/extensions/vega.clj | 2 +- src/smeagol/formatting.clj | 72 ++++++++++++++++++--------- src/smeagol/util.clj | 36 +++++++------- test/smeagol/test/formatting.clj | 10 +++- 7 files changed, 102 insertions(+), 63 deletions(-) create mode 100644 src/smeagol/extensions/test.clj diff --git a/resources/config.edn b/resources/config.edn index 7c462b3..87d1361 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -32,22 +32,12 @@ :default-locale "en-GB" ;; default language used for messages :formatters ;; formatters for processing markdown ;; extensions. - {:vega {:formatter "smeagol.extensions.vega/process-vega" - :scripts {:core {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega/5.9.1/vega.min.js"} - :lite {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-lite/4.1.1/vega-lite.min.js"} - :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"} - :styles {}}} - :vis {:formatter "smeagol.extensions.vega/process-vega" - :scripts {:core {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega/5.9.1/vega.min.js"} - :lite {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-lite/4.1.1/vega-lite.min.js"} - :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"} - :styles {}}} + {:backticks {:formatter "smeagol.formatting/process-backticks" + :scripts {} + :styles {}} :mermaid {:formatter "smeagol.extensions.mermaid/process-mermaid" :scripts {:core {:local "vendor/mermaid/dist/mermaid.js"}} :styles {}} - :backticks {:formatter "smeagol.formatting/process-backticks" - :scripts {} - :styles {}} :pswp {:formatter "smeagol.extensions.photoswipe/process-photoswipe" :scripts {:core {:local "/vendor/node_modules/photoswipe/dist/photoswipe.min.js" :remote "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe.min.js"} @@ -55,6 +45,17 @@ :remote "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe-ui-default.min.js"}} :styles {:core {:local "/vendor/node_modules/photoswipe/dist/photoswipe.css" :remote "/vendor/node_modules/photoswipe/dist/default-skin/default-skin.css"}}} + :test {:formatter "smeagol.extensions.test/process-test" } + :vega {:formatter "smeagol.extensions.vega/process-vega" + :scripts {:core {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega/5.9.1/vega.min.js"} + :lite {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-lite/4.1.1/vega-lite.min.js"} + :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"} + :styles {}}} + :vis {:formatter "smeagol.extensions.vega/process-vega" + :scripts {:core {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega/5.9.1/vega.min.js"} + :lite {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-lite/4.1.1/vega-lite.min.js"} + :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"} + :styles {}}} } :log-level :info ;; the minimum logging level; one of ;; :trace :debug :info :warn :error :fatal diff --git a/src/smeagol/extensions/photoswipe.clj b/src/smeagol/extensions/photoswipe.clj index ee80792..7b16a09 100644 --- a/src/smeagol/extensions/photoswipe.clj +++ b/src/smeagol/extensions/photoswipe.clj @@ -176,12 +176,8 @@ (defn process-photoswipe [^String url-or-pswp-spec ^Integer index] (let [data (resource-url-or-data->data url-or-pswp-spec) - spec (cs/trim (:data data)) - result + spec (cs/trim (:data data))] (if (cs/starts-with? spec "![") (process-simple-photoswipe spec index) - (process-full-photoswipe spec index))] -;; (log/info "process-photoswipe returning `" result "`.") - result - )) + (process-full-photoswipe spec index)))) diff --git a/src/smeagol/extensions/test.clj b/src/smeagol/extensions/test.clj new file mode 100644 index 0000000..ffe5c1a --- /dev/null +++ b/src/smeagol/extensions/test.clj @@ -0,0 +1,10 @@ +(ns ^{:doc "Very simple extension for testing the extension processing flow." + :author "Simon Brooke"} + smeagol.extensions.test) + + +(def process-test-return-value "") + +(defn process-test + [^String fragment ^Integer index] + process-test-return-value) diff --git a/src/smeagol/extensions/vega.clj b/src/smeagol/extensions/vega.clj index 1b9e2de..49edea0 100644 --- a/src/smeagol/extensions/vega.clj +++ b/src/smeagol/extensions/vega.clj @@ -1,4 +1,4 @@ -(ns ^{:doc "Format Semagol's extended markdown format." +(ns ^{:doc "Format vega/vis extensions to Semagol's extended markdown format." :author "Simon Brooke"} smeagol.extensions.vega (:require [clojure.data.json :as json] diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 3bb0d63..bbcaaa7 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -93,10 +93,20 @@ fragments (cons fragment processed))) +(defn deep-merge [v & vs] + "Cripped in its entirety from https://clojuredocs.org/clojure.core/merge." + (letfn [(rec-merge [v1 v2] + (if (and (map? v1) (map? v2)) + (merge-with deep-merge v1 v2) + v2))] + (if (some identity vs) + (reduce #(rec-merge %1 %2) v vs) + (last vs)))) + (defn apply-formatter "Within the context of `process-text`, process a fragment for which an explicit - §formatter has been identified. + `formatter` has been identified. As with `process-text`, this function returns a map with two top-level keys: `:inclusions`, a map of constructed keywords to inclusion specifications, @@ -104,16 +114,28 @@ corresponding inclusion should be inserted." [index result fragments processed fragment token formatter] (let - [kw (keyword (str "inclusion-" index))] - (assoc-in - (process-text - (inc index) + [ident (keyword (str "inclusion-" index))] + (process-text + (inc index) + (deep-merge result - (rest fragments) - (cons kw processed)) - [:inclusions kw] - (apply formatter (list (subs fragment (count token)) index))))) - + {:inclusions {ident (apply formatter (list (subs fragment (count token)) index))} + :extensions (cons (keyword token) (:extensions result))}) + fragments + (cons ident processed)))) + +(apply-formatter + 3 + {:inclusions {}} + '() + '() + "pswp + ![Frost on a gate, Laurieston](content/uploads/g1.jpg) + ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) + ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) + ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" + "pswp" + smeagol.extensions.photoswipe/process-photoswipe) (defn process-text "Process this `text`, assumed to be markdown potentially containing both local links @@ -124,7 +146,7 @@ inclusion specifications, and `:text`, an HTML text string with the keywords present where the corresponding inclusion should be inserted." ([^String text] - (process-text 0 {:inclusions {}} (cs/split (or text "") #"```") '())) + (process-text 0 {} (cs/split (or text "") #"```") '())) ([index result fragments processed] (let [fragment (first fragments) ;; if I didn't find a formatter for a back-tick marked fragment, @@ -154,24 +176,28 @@ formatter ;; We've found a formatter to apply to the current fragment, and recurse ;; on down the list - (let [result (apply-formatter - index - result - fragments - processed - fragment - first-token - formatter)] - ;; TODO: consistency: either these things are `extensions`, or - ;; they're `formatters`. I incline to the view that they're - ;; `:extensions` - (assoc-in result [:extensions kw] (-> config :formatters kw))) + (let + [ident (keyword (str "inclusion-" index))] + (deep-merge + (process-text + (inc index) + result + (rest fragments) + (cons ident processed)) + {:inclusions {ident (apply formatter (list (subs fragment (count first-token)) index))} + :extensions (cons kw (:extensions result))})) :else ;; Otherwise process the current fragment as markdown and recurse on ;; down the list (process-markdown-fragment index result remarked (rest fragments) processed))))) +(process-text + "pswp + ![Frost on a gate, Laurieston](content/uploads/g1.jpg) + ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) + ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) + ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" ) (defn reintegrate-inclusions "Given a map of the form produced by `process-text`, return a string of HTML text diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index 972a0a7..9e0a6ba 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -61,33 +61,31 @@ :version (System/getProperty "smeagol.version")})) -(defn- raw-get-messages +(def get-messages "Return the most acceptable messages collection we have given the `Accept-Language` header in this `request`." - [request] - (let [specifier ((:headers request) "accept-language") - messages (try - (i18n/get-messages specifier "i18n" "en-GB") - (catch Exception any - (log/error - any - (str - "Failed to parse accept-language header '" - specifier - "'")) - {}))] + (memoize + (fn [request] + (let [specifier ((:headers request) "accept-language") + messages (try + (i18n/get-messages specifier "i18n" "en-GB") + (catch Exception any + (log/error + any + (str + "Failed to parse accept-language header '" + specifier + "'")) + {}))] (merge messages - config))) - - -(def get-messages (memoize raw-get-messages)) + config))))) (defn get-message "Return the message with this `message-key` from this `request`. - if not found, return this `default`, if provided; else return the - `message-key`." + if not found, return this `default`, if provided; else return the + `message-key`." ([message-key request] (get-message message-key message-key request)) ([message-key default request] diff --git a/test/smeagol/test/formatting.clj b/test/smeagol/test/formatting.clj index 2887047..9cb4956 100644 --- a/test/smeagol/test/formatting.clj +++ b/test/smeagol/test/formatting.clj @@ -1,6 +1,7 @@ (ns smeagol.test.formatting (:require [clojure.test :refer :all] - [smeagol.formatting :refer [local-links no-text-error]])) + [smeagol.formatting :refer [local-links no-text-error]] + [smeagol.extensions.test :refer :all])) (deftest test-local-links (testing "Rewriting of local links" @@ -10,3 +11,10 @@ (let [text (str "# This is a heading" "[This is a foreign link](http://to.somewhere)")] (is (= (local-links text) text) "Foreign links should be unchanged")))) + +(deftest test-process-text + (testing "The process-text flow" + (let [expected process-test-return-value + actual (process-text "```test + ```")] + (is (= actual expected))))) From 0417fda9107234ff9aa04e3394403a0b0612638b Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Fri, 14 Feb 2020 08:51:14 +0000 Subject: [PATCH 15/24] Added TODO note, only. --- src/smeagol/formatting.clj | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index fa4f2f6..750cf02 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -43,6 +43,7 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Error to show if text to be rendered is nil. +;; TODO: should go through i18n (def no-text-error "No text: does the file exist?") @@ -187,3 +188,4 @@ (reintegrate-inclusions (process-text md-src))) + From 2e106256f85d605a6360f45c179f9a9ae936ddb1 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Fri, 14 Feb 2020 11:43:07 +0000 Subject: [PATCH 16/24] More Ginny stylesheet --- resources/public/content/stylesheet.css | 101 ++++++++++++++++-------- 1 file changed, 67 insertions(+), 34 deletions(-) diff --git a/resources/public/content/stylesheet.css b/resources/public/content/stylesheet.css index 81a661c..62690e0 100644 --- a/resources/public/content/stylesheet.css +++ b/resources/public/content/stylesheet.css @@ -24,6 +24,16 @@ ## html elements generally in alphabetic order */ +a { + color: darkgray; + font-weight: bold; +} + +a:hover { + color: darkgray; + background:rgba(200,200,200,0.8); +} + body { margin: 0; padding: 0; @@ -52,14 +62,15 @@ dd { /* footer of the page - not-editable, provided by Smeagol */ footer { - border-top: thin solid gray; + border-top: thin solid silver; + color: gray; + background:rgba(200,200,200,0.8); clear: both; font-size: smaller; text-align: center; - color: gray; - background: rgba(224,224,224,0.95); width: 100%; margin: 0; + min-height: 4px; padding: 0.25em 0; bottom:0; position:fixed; @@ -71,9 +82,14 @@ footer { } footer div { + display: none; padding: 0.1em; } +footer:hover div { + display: block; +} + form { border: thin solid silver; } @@ -83,8 +99,6 @@ header { margin-top: 0; width:100%; max-width: 100%; - background-color: gray; - color: white; } header h1 { @@ -93,7 +107,6 @@ header h1 { header a { font-weight: bold; - color: white; } header a:hover { @@ -131,12 +144,12 @@ ins { label { width: 20%; min-width: 20em; - border-right: thin solid gray; + border-right: thin solid silver; display: inline-block; } table { - border: 2px solid black; + border: thin solid silver; border-collapse: collapse; } @@ -148,7 +161,7 @@ th, td { text-align: left; vertical-align: top; padding: 0.15em 1.5em; - border: 1px solid gray; + border: 1px solid silver; } th { @@ -166,6 +179,7 @@ th { /* left bar for all pages in the Wiki - editable, provided by users. Within main-container */ #side-bar { + display: none; width: 17%; height: 100%; float: left; @@ -173,10 +187,10 @@ th { /* cookies information box, fixed, in right margin, just above footer */ #cookies { - width: 30%; + width: 20%; float: right; position: fixed; - bottom: 3.5em; + bottom: 8px; right: 0; z-index: 175; background: transparent; @@ -190,8 +204,8 @@ th { text-align: right; padding: 0.25em 2em; border-radius: 0.25em; - color: white; - background:rgba(40,40,40,0.8); + color: gray; + background:rgba(200,200,200,0.8); } /* more-about-cookies box, normally hidden */ @@ -199,9 +213,9 @@ th { display: none; padding: 0.5em 2em; border-radius: 0.5em; - color: white; - background:rgba(40,40,40,0.8); - border-bottom: thin solid white; + color: gray; + background:rgba(200,200,200,0.8); + border-bottom: thin solid gray; } /* but magically appears on mouseover */ @@ -242,8 +256,8 @@ th { right: 0; padding: 0.25em 2em; border-radius: 0.25em; - color: white; - background:rgba(40,40,40,0.8); + color: gray; + background:rgba(200,200,200,0.8); font-size: 66%; } @@ -254,7 +268,11 @@ th { .minor-controls a { float: right; padding: 0.25em 2em; - color: white; + color: gray; +} + +.minor-controls a:hover { + color: darkgray; } .pseudo-input { @@ -303,8 +321,7 @@ th { /* content of the current page in the Wiki - editable, provided by users. Within main-container */ #content { border: thin solid silver; - width: 80%; - float: right; + width: 100%; padding-bottom: 5em; } @@ -312,16 +329,29 @@ th { display: none; } + #header { + font-size: smaller; + } + /* top-of-page navigation, not editable, provided by Smeagol */ #nav{ margin: 0; padding: 0; top: 0; - width: 100%; + min-height: 4px; _position: absolute; _top: expression(document.documentElement.scrollTop); z-index: 149; - background:rgba(40,40,40,0.8); + color: gray; + background:rgba(200,200,200,0.8); + } + + #nav #nav-menu { + display: none; + } + + #nav:hover #nav-menu { + display: block; } /* only needed for fly-out menu effect on tablet and phone stylesheets */ @@ -341,14 +371,14 @@ th { } #nav menu li a { - color: white; + color: gray; text-decoration: none; font-weight: bold; padding: 0.1em 0.75em; margin: 0; } - #nav menu li.active a { background: gray;} + #nav menu li.active a { background: gray; color: white;} li.nav-item a:hover { background: rgb( 240, 240, 240) } li.nav-item a:active { background: gray; color: white; } @@ -379,17 +409,15 @@ th { padding: 0; position: fixed; z-index: 149; - color: silver; - background:rgba(40,40,40,0.9); + color: black; + background:rgba(200,200,200,0.9); } #nav a { - color: white; - text-decoration: none; font-weight: bold; } - #nav:hover #nav-menu { + #nav:hover #nav-menu, #nav:hover #phone-side-bar { display: block; list-style-type: none; width: 100%; @@ -455,18 +483,21 @@ th { display: none; } + #header { + display: none; + } + #nav{ margin: 0; padding: 0; position: fixed; z-index: 149; - color: silver; - background:rgba(40,40,40,0.9); + color: black; + background:rgba(200,200,200,0.9); } #nav a { - color: white; - text-decoration: none; + color: black; font-weight: bold; } @@ -491,6 +522,8 @@ th { } #nav menu li a { + color: black; + font-weight: bold; } #nav ul li.active a { background: silver;} From c06fce3007166b790e83ff775a8526004857bef7 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Fri, 14 Feb 2020 11:43:50 +0000 Subject: [PATCH 17/24] Bugfix: looking in the wrong directory for uploads. --- resources/templates/base.html | 4 +++- src/smeagol/routes/wiki.clj | 14 +++++++++++--- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/resources/templates/base.html b/resources/templates/base.html index 7a31f07..01152af 100644 --- a/resources/templates/base.html +++ b/resources/templates/base.html @@ -46,7 +46,9 @@

{% i18n site-title %}: {{title}}

- {{header|safe}} + {% if message %}

{{message}}

diff --git a/src/smeagol/routes/wiki.clj b/src/smeagol/routes/wiki.clj index e33cbdc..c87dbef 100644 --- a/src/smeagol/routes/wiki.clj +++ b/src/smeagol/routes/wiki.clj @@ -15,6 +15,7 @@ [noir.util.route :as route] [noir.session :as session] [smeagol.authenticate :as auth] + [smeagol.configuration :refer [config]] [smeagol.diff2html :as d2h] [smeagol.formatting :refer [md->html]] [smeagol.history :as hist] @@ -187,7 +188,6 @@ [request] (let [params (keywordize-keys (:params request)) - data-path (str util/content-dir "/uploads/") cl (count (io/resource-path)) files (map @@ -202,11 +202,19 @@ (fs/mod-time %) (format-instant (fs/mod-time %))) (fs/name %) - (subs (str (fs/absolute %)) cl)]) + (try + (subs (str (fs/absolute %)) cl) + (catch StringIndexOutOfBoundsException x + (log/error "Could not resolve relative path for" % + ";\n resource-path is:" (io/resource-path) + ";\n absolute path is:" (fs/absolute %) + ";\n data-path is:" util/upload-dir + ";\n content path is:" (:content-dir config)) + %))]) (remove #(or (cs/starts-with? (fs/name %) ".") (fs/directory? %)) - (file-seq (clojure.java.io/file data-path))))] + (file-seq (clojure.java.io/file util/upload-dir))))] (log/info (with-out-str (pprint files))) (layout/render "list-uploads.html" From 392a5f82ecbc6f824e4efee9ff4eeb5fca3540f2 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Fri, 14 Feb 2020 16:08:17 +0000 Subject: [PATCH 18/24] These are the genuine improvements out of today 1. Table sorting 2. Fixed edit page title bugette 3. SimpleMDE working again. --- resources/i18n/en-GB.edn | 2 ++ resources/templates/edit-users.html | 23 ++++++++---- resources/templates/edit.html | 6 ++-- resources/templates/list-uploads.html | 19 +++++++--- src/smeagol/routes/wiki.clj | 51 ++++++++++++--------------- src/smeagol/util.clj | 50 ++++++++++++++++++++++++-- 6 files changed, 107 insertions(+), 44 deletions(-) diff --git a/resources/i18n/en-GB.edn b/resources/i18n/en-GB.edn index 6f4d8b2..442f097 100644 --- a/resources/i18n/en-GB.edn +++ b/resources/i18n/en-GB.edn @@ -131,6 +131,8 @@ "Smeagol has been unable to find some of the resources on which it depends, possibly because of misconfiguration or missing environment variables." ;; used in sanity check report + :sortable "You can sort this table by selecting column headers" + ;; used for sortable tables :user-lacks-field "User record in the passwd file lacks a field" ;; used in sanity check report :username-prompt "Username" ;; text of the username widget prompt on edit user page diff --git a/resources/templates/edit-users.html b/resources/templates/edit-users.html index 2621576..06d0d2e 100644 --- a/resources/templates/edit-users.html +++ b/resources/templates/edit-users.html @@ -1,10 +1,18 @@ {% extends "templates/base.html" %} +{% block extra-headers %} + {% script "/vendor/node_modules/tablesort/dist/tablesort.min.js" %} +{% endblock %} {% block content %}
- - - +

+ {% i18n sortable %} +

+
{% i18n edit-col-hdr %}{% i18n del-col-hdr %}
+ + + + {% for user in users %} @@ -13,11 +21,12 @@ {% endfor %} - - - - + +
{% i18n user-title-prefix %}{% i18n edit-col-hdr %}{% i18n del-col-hdr %}
{% i18n del-col-hdr %} {{user}}
{% i18n add-user-label %}
{% i18n add-user-label %}
+ {% endblock %} diff --git a/resources/templates/edit.html b/resources/templates/edit.html index 36426dc..44ee54a 100644 --- a/resources/templates/edit.html +++ b/resources/templates/edit.html @@ -1,11 +1,11 @@ {% extends "templates/base.html" %} {% block extra-headers %} - {% ifequal js-from ":cloudflare" %} + {% ifequal js-from ":cdnjs" %} {% else %} - {% style "/vendor/simplemde/dist/simplemde.min.css" %} - {% script "/vendor/simplemde/dist/simplemde.min.js" %} + {% style "vendor/simplemde/dist/simplemde.min.css" %} + {% script "vendor/simplemde/dist/simplemde.min.js" %} {% endifequal %} {% endblock %} diff --git a/resources/templates/list-uploads.html b/resources/templates/list-uploads.html index e759dac..4289485 100644 --- a/resources/templates/list-uploads.html +++ b/resources/templates/list-uploads.html @@ -1,4 +1,10 @@ {% extends "templates/base.html" %} +{% block extra-headers %} + {% script "/vendor/node_modules/tablesort/dist/tablesort.min.js" %} + {% script "/vendor/node_modules/tablesort/dist/sorts/tablesort.number.min.js" %} + {% script "/vendor/node_modules/tablesort/dist/sorts/tablesort.date.min.js" %} + {% script "/vendor/node_modules/tablesort/dist/sorts/tablesort.monthname.min.js" %} +{% endblock %} {% block content %}
@@ -9,12 +15,15 @@

- - +

+ {% i18n sortable %} +

+
+ - + {% for entry in files %} @@ -26,9 +35,11 @@ - {% endfor %}
Name Uploaded Type thisTo get thisTo get this
{% if entry.is-image %} {{entry.name|capitalize}} {% else %} link {% endif %}
+ {% endblock %} diff --git a/src/smeagol/routes/wiki.clj b/src/smeagol/routes/wiki.clj index c87dbef..104b6e0 100644 --- a/src/smeagol/routes/wiki.clj +++ b/src/smeagol/routes/wiki.clj @@ -161,7 +161,8 @@ (log/info (format "Showing history of page '%s'" page)) (layout/render "history.html" (merge (util/standard-params request) - {:title (util/get-message :history-title-prefix request) + {:title (str (util/get-message :history-title-prefix request) + " " page) :page page :history (hist/find-history repo-path file-name)})))) @@ -175,7 +176,7 @@ If `template` is supplied, use that as the formatting template as specified for java.time.Formatter. Assumes system default timezone. Returns a string." ([^Long unix-time] - (format-instant unix-time "EEEE, dd MMMM YYYY")) + (format-instant unix-time "dd MMMM YYYY")) ([^Long unix-time ^String template] (jt/format (java-time/formatter template) @@ -188,33 +189,26 @@ [request] (let [params (keywordize-keys (:params request)) - cl (count (io/resource-path)) files - (map - #(zipmap - [:base-name :is-image :modified :name :resource] - [(fs/base-name %) - (if - (and (fs/extension %) - (image-extns (cs/lower-case (fs/extension %)))) - true false) - (if - (fs/mod-time %) - (format-instant (fs/mod-time %))) - (fs/name %) - (try - (subs (str (fs/absolute %)) cl) - (catch StringIndexOutOfBoundsException x - (log/error "Could not resolve relative path for" % - ";\n resource-path is:" (io/resource-path) - ";\n absolute path is:" (fs/absolute %) - ";\n data-path is:" util/upload-dir - ";\n content path is:" (:content-dir config)) - %))]) - (remove - #(or (cs/starts-with? (fs/name %) ".") - (fs/directory? %)) - (file-seq (clojure.java.io/file util/upload-dir))))] + (sort-by + (juxt :name (fn [x] (- 0 (count (:resource x))))) + (map + #(zipmap + [:base-name :is-image :modified :name :resource] + [(fs/base-name %) + (if + (and (fs/extension %) + (image-extns (cs/lower-case (fs/extension %)))) + true false) + (if + (fs/mod-time %) + (format-instant (fs/mod-time %))) + (fs/name %) + (util/local-url %)]) + (remove + #(or (cs/starts-with? (fs/name %) ".") + (fs/directory? %)) + (file-seq (clojure.java.io/file util/upload-dir)))))] (log/info (with-out-str (pprint files))) (layout/render "list-uploads.html" @@ -236,6 +230,7 @@ files) })))) + ;;;; end of list-uploads section ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defn upload-page diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index 1ef44df..d33ee32 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -2,6 +2,7 @@ :author "Simon Brooke"} smeagol.util (:require [clojure.java.io :as cjio] + [clojure.string :as cs] [environ.core :refer [env]] [me.raynes.fs :as fs] [noir.io :as io] @@ -10,7 +11,7 @@ [smeagol.authenticate :as auth] [smeagol.configuration :refer [config]] [smeagol.formatting :refer [md->html]] - [taoensso.timbre :as timbre])) + [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -49,6 +50,51 @@ (def upload-dir (str (cjio/file content-dir "uploads"))) +(def local-url-base + (let [a (str (fs/absolute content-dir))] + (subs a 0 (- (count a) (count "content"))))) + +(defn not-servable-reason + "As a string, the reason this `file-path` cannot safely be served, or `nil` + if it is safe to serve. This reason may be logged, but should *not* be + shown to remote users, as it would allow file system probing." + [file-path] + (let [path (fs/absolute file-path)] + (cond + (cs/includes? file-path "..") + (cs/join " " file-path + "Attempts to ascend the file hierarchy are disallowed.") + (not (cs/starts-with? path local-url-base)) + (cs/join " " [path "is not servable"]) + (not (fs/exists? path)) + (cs/join " " [path "does not exist"]) + (not (fs/readable? path)) + (cs/join " " [path "is not readable"])))) + +(defn local-url? + "True if this `file-path` can be served as a local URL, else false." + [file-path] + (empty? (not-servable-reason file-path))) + +(defn local-url + "Return a local URL for this `file-path`, or a deliberate 404 if none + can be safely served." + [file-path] + (try + (let [path (fs/absolute file-path) + problem (not-servable-reason path)] + (if + (empty? problem) + (subs (str path) (count local-url-base)) + (do + (log/error + "In `smeagol.util/local-url `" file-path "` is not a servable resource.") + (str "404-not-found?path=" file-path)))) + (catch Exception any + (log/error + "In `smeagol.util/local-url `" file-path "` is not a servable resource:" any) + (str "404-not-found?path=" file-path)))) + (defn standard-params "Return a map of standard parameters to pass to the template renderer." [request] @@ -69,7 +115,7 @@ messages (try (i18n/get-messages specifier "i18n" "en-GB") (catch Exception any - (timbre/error + (log/error any (str "Failed to parse accept-language header '" From 151987e598b5ffc6c2ee997110d0f5259511f73b Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Sun, 16 Feb 2020 13:51:41 +0000 Subject: [PATCH 19/24] #45,#46: done --- resources/config.edn | 30 +++++++++------- resources/templates/wiki.html | 6 ++-- src/smeagol/formatting.clj | 42 ++++++++++++---------- src/smeagol/routes/wiki.clj | 68 +++++++++++++++++++++++++---------- src/smeagol/util.clj | 48 ++++++++++++++++++++----- 5 files changed, 131 insertions(+), 63 deletions(-) diff --git a/resources/config.edn b/resources/config.edn index 87d1361..ecb1ea0 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -30,37 +30,35 @@ :content-dir "resources/public/content" ;; where content is served from. :default-locale "en-GB" ;; default language used for messages + :extensions-from :local ;; where to load JavaScript libraries + ;; from: options are :local, :remote. :formatters ;; formatters for processing markdown ;; extensions. {:backticks {:formatter "smeagol.formatting/process-backticks" :scripts {} :styles {}} :mermaid {:formatter "smeagol.extensions.mermaid/process-mermaid" - :scripts {:core {:local "vendor/mermaid/dist/mermaid.js"}} + :scripts {:core {:local "vendor/mermaid/dist/mermaid.js" + :remote "https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.4.6/mermaid.min.js"}} :styles {}} :pswp {:formatter "smeagol.extensions.photoswipe/process-photoswipe" - :scripts {:core {:local "/vendor/node_modules/photoswipe/dist/photoswipe.min.js" + :scripts {:core {:local "vendor/node_modules/photoswipe/dist/photoswipe.min.js" :remote "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe.min.js"} - :ui {:local "/vendor/node_modules/photoswipe/dist/photoswipe-ui-default.min.js" + :ui {:local "vendor/node_modules/photoswipe/dist/photoswipe-ui-default.min.js" :remote "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe-ui-default.min.js"}} - :styles {:core {:local "/vendor/node_modules/photoswipe/dist/photoswipe.css" - :remote "/vendor/node_modules/photoswipe/dist/default-skin/default-skin.css"}}} + :styles {:core {:local "vendor/node_modules/photoswipe/dist/photoswipe.css"} + :skin {:local "vendor/node_modules/photoswipe/dist/default-skin/default-skin.css"}}} :test {:formatter "smeagol.extensions.test/process-test" } :vega {:formatter "smeagol.extensions.vega/process-vega" :scripts {:core {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega/5.9.1/vega.min.js"} :lite {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-lite/4.1.1/vega-lite.min.js"} - :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"} - :styles {}}} + :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"}}} :vis {:formatter "smeagol.extensions.vega/process-vega" :scripts {:core {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega/5.9.1/vega.min.js"} :lite {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-lite/4.1.1/vega-lite.min.js"} - :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"} - :styles {}}} - } + :embed {:remote "https://cdnjs.cloudflare.com/ajax/libs/vega-embed/6.2.2/vega-embed.min.js"}}}} :log-level :info ;; the minimum logging level; one of ;; :trace :debug :info :warn :error :fatal - :js-from :cdnjs ;; where to load JavaScript libraries - ;; from: options are :local, :cdnjs :passwd "resources/passwd" ;; where the password file is stored :site-title "Smeagol" ;; overall title of the site, used in @@ -71,4 +69,10 @@ ;; stored in the /small directory :med 400 ;; maximum dimension of thumbnails ;; stored in the /med directory - }} + ;; you can add as many extra keys and values as + ;; you like here for additional sizes of images. + ;; Images will only be scaled if their maximum + ;; dimension (in pixels) is greater than the value; + ;; only JPEG and PNG images will be scaled. + } + } diff --git a/resources/templates/wiki.html b/resources/templates/wiki.html index 7342854..81634ea 100644 --- a/resources/templates/wiki.html +++ b/resources/templates/wiki.html @@ -2,11 +2,9 @@ {% block extra-headers %} {% for script in scripts %} - - {% endfor %} + {% endfor %} {% for style in styles %} - - {% endfor %} + {% endfor %} {% endblock %} {% block content %} diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 153c904..5891eeb 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -93,6 +93,7 @@ fragments (cons fragment processed))) + (defn deep-merge [v & vs] "Cripped in its entirety from https://clojuredocs.org/clojure.core/merge." (letfn [(rec-merge [v1 v2] @@ -124,18 +125,18 @@ fragments (cons ident processed)))) -(apply-formatter - 3 - {:inclusions {}} - '() - '() - "pswp - ![Frost on a gate, Laurieston](content/uploads/g1.jpg) - ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) - ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) - ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" - "pswp" - smeagol.extensions.photoswipe/process-photoswipe) +;; (apply-formatter +;; 3 +;; {:inclusions {}} +;; '() +;; '() +;; "pswp +;; ![Frost on a gate, Laurieston](content/uploads/g1.jpg) +;; ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) +;; ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) +;; ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" +;; "pswp" +;; smeagol.extensions.photoswipe/process-photoswipe) (defn process-text "Process this `text`, assumed to be markdown potentially containing both local links @@ -145,6 +146,8 @@ The map has two top-level keys: `:inclusions`, a map of constructed keywords to inclusion specifications, and `:text`, an HTML text string with the keywords present where the corresponding inclusion should be inserted." + + ;; TODO: the inclusion->index bug is in here somewhere. ([^String text] (process-text 0 {} (cs/split (or text "") #"```") '())) ([index result fragments processed] @@ -185,19 +188,19 @@ (rest fragments) (cons ident processed)) {:inclusions {ident (apply formatter (list (subs fragment (count first-token)) index))} - :extensions (cons kw (:extensions result))})) + :extensions (assoc (or (:extensions result) {}) kw (-> config :formatters kw))})) :else ;; Otherwise process the current fragment as markdown and recurse on ;; down the list (process-markdown-fragment index result remarked (rest fragments) processed))))) -(process-text - "pswp - ![Frost on a gate, Laurieston](content/uploads/g1.jpg) - ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) - ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) - ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" ) +;; (process-text +;; "pswp +;; ![Frost on a gate, Laurieston](content/uploads/g1.jpg) +;; ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) +;; ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) +;; ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" ) (defn reintegrate-inclusions "Given a map of the form produced by `process-text`, return a string of HTML text @@ -236,3 +239,4 @@ + diff --git a/src/smeagol/routes/wiki.clj b/src/smeagol/routes/wiki.clj index 0fa7cac..a3456c1 100644 --- a/src/smeagol/routes/wiki.clj +++ b/src/smeagol/routes/wiki.clj @@ -28,7 +28,8 @@ [com.stuartsierra.component :as component] [smeagol.configuration :refer [config]] [smeagol.include.resolve-local-file :as resolve] - [smeagol.include :as include])) + [smeagol.include :as include] + [smeagol.util :refer [content-dir local-url]])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; @@ -118,6 +119,9 @@ (def md-include-system + "Allowing Markdown includes. Unfortunately the contributor who contributed + this didn't document it, and I haven't yet worked out how it works. TODO: + investigate and document." (component/start (component/system-map :resolver (resolve/new-resolver util/content-dir) @@ -125,6 +129,7 @@ (include/new-includer) [:resolver])))) + (defn preferred-source "Here, `component` is expected to be a map with two keys, `:local` and `:remote`. If the value of `:extensions-from` in `config.edn` is remote @@ -132,26 +137,51 @@ be returned. Otherwise, if the value of `:local` is nil and the value of `:remote` is non-nil, the value of `:remote` will be returned. By default, the value of `:local` will be returned." - [component] - (let [l (:local component) ;; TODO: look at the trick in Selmer to get relative URL - r (:remote component)] - (cond - (= (:extensions-from config) :remote) (if (empty? r) l r) - (empty? l) r - :else l))) + [component ks] + (try + (let [l (:local component) + l' (if-not (empty? l) (local-url l) l) + r (:remote component)] + (cond + (= (:extensions-from config) :remote) + (if (empty? r) l' r) + (empty? l') r + :else l')) + (catch Exception any + (log/error "Failed to find appropriate source for component" ks "because:" any) + nil))) + +;; (preferred-source {:local "vendor/node_modules/photoswipe/dist/photoswipe.min.js", +;; :remote "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe.min.js"} :core) (defn collect-preferred - "From extensions referenced in this `processed-text`, extract the preferred - URLs for this keyword `k`, expected to be either `:scripts` or `:styles`." - [processed-text k] - (set - (remove - nil? - (map - preferred-source - (apply - concat - (map vals (map k (vals (:extensions processed-text))))))))) + ([processed-text] + (concat + (collect-preferred processed-text :scripts) + (collect-preferred processed-text :styles))) + ([processed-text resource-type] + (reduce concat + (map + (fn [extension-key] + (map + (fn [requirement] + (let [r (preferred-source + (-> processed-text :extensions extension-key resource-type requirement) + requirement)] + (if (empty? r) + (log/warn "Found no valid URL for requirement" + requirement "of extension" extension-key)) + r)) + (keys (-> processed-text :extensions extension-key resource-type)))) + (keys (:extensions processed-text)))))) + +(cjio/file content-dir "vendor/node_modules/photoswipe/dist/photoswipe.min.js") + +(def processed-text (md->html (slurp "resources/public/content/Simplified example gallery.md" ))) + +(preferred-source (-> processed-text :extensions :pswp :scripts :core) :pswp) + +(collect-preferred processed-text :scripts) (defn wiki-page "Render the markdown page specified in this `request`, if any. If none found, redirect to edit-page" diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index 64e0a7c..e92bafe 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -51,6 +51,8 @@ (str (cjio/file content-dir "uploads"))) (def local-url-base + "Essentially, the slash-terminated absolute path of the `public` resource + directory." (let [a (str (fs/absolute content-dir))] (subs a 0 (- (count a) (count "content"))))) @@ -59,7 +61,11 @@ if it is safe to serve. This reason may be logged, but should *not* be shown to remote users, as it would allow file system probing." [file-path] - (let [path (fs/absolute file-path)] + (try + (let [path (if + (cs/starts-with? (str file-path) "/") + file-path + (cjio/file local-url-base file-path))] (cond (cs/includes? file-path "..") (cs/join " " file-path @@ -69,31 +75,57 @@ (not (fs/exists? path)) (cs/join " " [path "does not exist"]) (not (fs/readable? path)) - (cs/join " " [path "is not readable"])))) + (cs/join " " [path "is not readable"]))) + (catch Exception any (cs/join " " file-path "is not servable because" (.getMessage any))))) + + +;; (not-servable-reason "/home/simon/workspace/smeagol/resources/public/content/vendor/node_modules/photoswipe/dist/photoswipe.min.js") +;; (not-servable-reason "/root/froboz") (defn local-url? "True if this `file-path` can be served as a local URL, else false." [file-path] - (empty? (not-servable-reason file-path))) + (try + (if + (empty? (not-servable-reason file-path)) + true + (do + (log/error + "In `smeagol.util/local-url? `" file-path "` is not a servable resource.") + false)) + (catch Exception any + (log/error + "In `smeagol.util/local-url `" file-path "` is not a servable resource:" any) + false))) (defn local-url "Return a local URL for this `file-path`, or a deliberate 404 if none can be safely served." + ;; TODO: this actually returns a relative URL relative to local-url-base. + ;; That's not quite what we want because in Tomcat contexts the absolute + ;; URL may be different. We *ought* to be able to extract the offset from the + ;; servlet context, but it may be simpler to jam it in the config. [file-path] (try - (let [path (fs/absolute file-path) + (let [path (if + (cs/starts-with? file-path local-url-base) + (subs file-path (count local-url-base)) + file-path) problem (not-servable-reason path)] (if (empty? problem) - (subs (str path) (count local-url-base)) + path (do (log/error "In `smeagol.util/local-url `" file-path "` is not a servable resource.") (str "404-not-found?path=" file-path)))) (catch Exception any - (log/error - "In `smeagol.util/local-url `" file-path "` is not a servable resource:" any) - (str "404-not-found?path=" file-path)))) + (log/error + "In `smeagol.util/local-url `" file-path "` is not a servable resource:" any) + (str "404-not-found?path=" file-path)))) + +(local-url? "vendor/node_modules/photoswipe/dist/photoswipe.min.js") +(local-url? "/home/simon/workspace/smeagol/resources/public/vendor/node_modules/photoswipe/dist/photoswipe.min.js") (defn standard-params "Return a map of standard parameters to pass to the template renderer." From 0f0f2ecc48beda4b898adafc29b04e4169ae1cae Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Wed, 19 Feb 2020 12:50:52 +0000 Subject: [PATCH 20/24] Re-separated apply-formatter. Still doesn't work. (but doesn't blow up) --- src/smeagol/formatting.clj | 31 +++++++------------------------ 1 file changed, 7 insertions(+), 24 deletions(-) diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 5891eeb..fb94602 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -115,15 +115,12 @@ corresponding inclusion should be inserted." [index result fragments processed fragment token formatter] (let - [ident (keyword (str "inclusion-" index))] + [kw (keyword (str "inclusion-" index))] (process-text (inc index) - (deep-merge - result - {:inclusions {ident (apply formatter (list (subs fragment (count token)) index))} - :extensions (cons (keyword token) (:extensions result))}) - fragments - (cons ident processed)))) + (assoc-in result [:inclusions kw] (apply formatter (list (subs fragment (count token)) index))) + (rest fragments) + (cons kw processed)))) ;; (apply-formatter ;; 3 @@ -177,23 +174,9 @@ (cs/join "\n\n" (reverse processed)) :heading-anchors true))) formatter - ;; We've found a formatter to apply to the current fragment, and recurse - ;; on down the list - (let - [ident (keyword (str "inclusion-" index))] - (deep-merge - (process-text - (inc index) - result - (rest fragments) - (cons ident processed)) - {:inclusions {ident (apply formatter (list (subs fragment (count first-token)) index))} - :extensions (assoc (or (:extensions result) {}) kw (-> config :formatters kw))})) - :else - ;; Otherwise process the current fragment as markdown and recurse on - ;; down the list - (process-markdown-fragment - index result remarked (rest fragments) processed))))) + (apply-formatter index result fragments processed fragment first-token formatter) + true + (process-markdown-fragment index result remarked (rest fragments) processed))))) ;; (process-text ;; "pswp From 0649ecf1958010f17a39fd31c46c95ea66814c7b Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Wed, 19 Feb 2020 15:01:09 +0000 Subject: [PATCH 21/24] Thank fuck, it works. Now to remove all the crud. --- src/smeagol/formatting.clj | 163 +++++++++++++++++++------------ src/smeagol/routes/wiki.clj | 19 ++-- src/smeagol/util.clj | 12 ++- test/smeagol/test/formatting.clj | 12 +-- 4 files changed, 125 insertions(+), 81 deletions(-) diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index fb94602..cacc9ca 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -9,6 +9,7 @@ [smeagol.configuration :refer [config]] [smeagol.extensions.mermaid :refer [process-mermaid]] [smeagol.extensions.photoswipe :refer [process-photoswipe]] + [smeagol.extensions.vega :refer [process-vega]] [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -68,7 +69,7 @@ (defn process-backticks "Effectively, escape the backticks surrounding this `text`, by protecting them - from the `md->html` filter." + from the `process-text` filter." [^String text ^Integer index] (str "
```" (.trim text) "\n```
")) @@ -76,7 +77,9 @@ (defn get-first-token "Return the first space-separated token of this `string`." [^String string] - (if string (first (cs/split string #"[^a-zA-Z0-9]+")))) + (try + (if string (first (cs/split (first (cs/split-lines string)) #"[^a-zA-Z0-9]+"))) + (catch NullPointerException _ nil))) (defn- process-markdown-fragment @@ -86,7 +89,7 @@ `:inclusions`, a map of constructed keywords to inclusion specifications, and `:text`, an HTML text string with the keywords present where the corresponding inclusion should be inserted." - [index result fragment fragments processed] + [^Integer index ^clojure.lang.Associative result ^String fragment fragments processed] (process-text (inc index) result @@ -113,14 +116,29 @@ `:inclusions`, a map of constructed keywords to inclusion specifications, and `:text`, an HTML text string with the keywords present where the corresponding inclusion should be inserted." - [index result fragments processed fragment token formatter] + [^Integer index + ^clojure.lang.Associative result + fragments + processed + ^String fragment + ^String token + formatter] + (log/info "index:" index "(type result):" (type result) "(type fragments):" (type fragments) "fragment:" fragment "token:" token ":formatter" formatter) (let - [kw (keyword (str "inclusion-" index))] + [inky (keyword (str "inclusion-" index)) + fkey (keyword token)] (process-text (inc index) - (assoc-in result [:inclusions kw] (apply formatter (list (subs fragment (count token)) index))) - (rest fragments) - (cons kw processed)))) + (deep-merge + result + {:inclusions {inky (eval (list formatter (subs fragment (count token)) index))} + :extensions {fkey (-> config :formatters fkey)}}) +;; (assoc-in +;; (assoc-in result [:inclusions inky] (eval (list formatter (subs fragment (count token)) index))) +;; [:extensions fkey] (-> config :formatters fkey)) + (rest fragments) + (cons inky processed)))) + ;; (apply-formatter ;; 3 @@ -135,55 +153,16 @@ ;; "pswp" ;; smeagol.extensions.photoswipe/process-photoswipe) -(defn process-text - "Process this `text`, assumed to be markdown potentially containing both local links - and YAML visualisation specifications, and return a map comprising JSON visualisation - specification, and HTML text with markers for where those should be reinserted. - - The map has two top-level keys: `:inclusions`, a map of constructed keywords to - inclusion specifications, and `:text`, an HTML text string with the keywords - present where the corresponding inclusion should be inserted." - - ;; TODO: the inclusion->index bug is in here somewhere. - ([^String text] - (process-text 0 {} (cs/split (or text "") #"```") '())) - ([index result fragments processed] - (let [fragment (first fragments) - ;; if I didn't find a formatter for a back-tick marked fragment, - ;; I need to put the backticks back in. - remarked (if (odd? index) (str "```" fragment "\n```") fragment) - first-token (get-first-token fragment) - kw (if-not (empty? first-token) (keyword first-token)) - formatter (if-not - (empty? first-token) - (try - (read-string (-> config :formatters kw :formatter)) - (catch Exception _ - (do - (log/info "No formatter found for extension `" kw "`") - ;; no extension registered - there sometimes won't be, - ;; and it doesn't matter - nil))))] - (cond - (empty? fragments) - ;; We've come to the end of the list of fragments. Reassemble them into - ;; a single HTML text and pass it back. - (assoc result :text - (local-links - (md/md-to-html-string - (cs/join "\n\n" (reverse processed)) - :heading-anchors true))) - formatter - (apply-formatter index result fragments processed fragment first-token formatter) - true - (process-markdown-fragment index result remarked (rest fragments) processed))))) +(defn reassemble-text + "Reassemble these processed strings into a complete text, and process it as + Markdown." + [result processed] + (assoc result :text + (local-links + (md/md-to-html-string + (cs/join "\n\n" (reverse processed)) + :heading-anchors true)))) -;; (process-text -;; "pswp -;; ![Frost on a gate, Laurieston](content/uploads/g1.jpg) -;; ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) -;; ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) -;; ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" ) (defn reintegrate-inclusions "Given a map of the form produced by `process-text`, return a string of HTML text @@ -212,13 +191,73 @@ (cs/replace (kw inclusions) "\\/" "/")))))))) +(defn process-text + [^Integer index ^clojure.lang.Associative result fragments processed] + (let [fragment (first fragments) + ;; if I didn't find a formatter for a back-tick marked fragment, + ;; I need to put the backticks back in. + remarked (if (odd? index) (str "```" fragment "\n```") fragment) + first-token (get-first-token fragment) + kw (if-not (empty? first-token) (keyword first-token)) + formatter (if + kw + (try + (read-string (-> config :formatters kw :formatter)) + (catch Exception _ + (do + (log/info "No formatter found for extension `" kw "`") + ;; no extension registered - there sometimes won't be, + ;; and it doesn't matter + nil))))] + (cond + (empty? fragments) + ;; We've come to the end of the list of fragments. Reassemble them into + ;; a single HTML text and pass it back. + (reassemble-text result processed) + formatter + (apply-formatter index result fragments processed fragment first-token formatter) + true + (process-markdown-fragment index result remarked (rest fragments) processed)))) + (defn md->html - "Take this `md-src` markdown source, and return a map in which: - 1. the key `:content` is bound to the equivalent HTML source; - 2. the key `:extensions`. is bound to details of the extensions - used." - [md-src] - (reintegrate-inclusions (process-text md-src))) + "Process this `text`, assumed to be markdown potentially containing both local links + and YAML visualisation specifications, and return a map comprising JSON visualisation + specification, and HTML text with markers for where those should be reinserted. + + The map has two top-level keys: `:inclusions`, a map of constructed keywords to + inclusion specifications, and `:text`, an HTML text string with the keywords + present where the corresponding inclusion should be inserted." + [^clojure.lang.Associative context] + (reintegrate-inclusions + (process-text + 0 + (assoc context :extensions #{}) + (cs/split (or (:source context) "") #"```") + '()))) + + +;; (def first-token "pswp") +;; (def kw (keyword "pswp")) +;; (def fragment "pswp +;; ![Frost on a gate, Laurieston](content/uploads/g1.jpg) +;; ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) +;; ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) +;; ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)") +;; (def index 0) +;; (def formatter (read-string (-> config :formatters kw :formatter))) +;; formatter +;; (eval (list formatter (subs fragment (count first-token)) index)) +;; (process-photoswipe (subs fragment (count first-token)) index) + +;; (process-text +;; {:source "pswp +;; ![Frost on a gate, Laurieston](content/uploads/g1.jpg) +;; ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) +;; ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) +;; ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)"} ) + +;; (process-text {:source (slurp (clojure.java.io/file smeagol.util/content-dir "Extensible Markup.md"))}) + diff --git a/src/smeagol/routes/wiki.clj b/src/smeagol/routes/wiki.clj index a3456c1..a5d4fde 100644 --- a/src/smeagol/routes/wiki.clj +++ b/src/smeagol/routes/wiki.clj @@ -107,7 +107,7 @@ (merge (util/standard-params request) {:title (str (util/get-message :edit-title-prefix request) " " page) :page page - :side-bar (md->html (slurp (cjio/file util/content-dir side-bar))) + :side-bar (md->html (assoc request :source (slurp (cjio/file util/content-dir side-bar)))) :content (if exists? (slurp file-path) "") :exists exists?}))))))) @@ -175,13 +175,15 @@ (keys (-> processed-text :extensions extension-key resource-type)))) (keys (:extensions processed-text)))))) -(cjio/file content-dir "vendor/node_modules/photoswipe/dist/photoswipe.min.js") +;; (cjio/file content-dir "vendor/node_modules/photoswipe/dist/photoswipe.min.js") -(def processed-text (md->html (slurp "resources/public/content/Simplified example gallery.md" ))) +;; (def processed-text (md->html {:source (slurp "resources/public/content/Simplified example gallery.md" )})) -(preferred-source (-> processed-text :extensions :pswp :scripts :core) :pswp) +;; (preferred-source (-> processed-text :extensions :pswp :scripts :core) :pswp) -(collect-preferred processed-text :scripts) +;; (-> processed-text :extensions) + +;; (collect-preferred processed-text :scripts) (defn wiki-page "Render the markdown page specified in this `request`, if any. If none found, redirect to edit-page" @@ -198,9 +200,10 @@ (do (log/info (format "Showing page '%s' from file '%s'" page file-path)) (let [processed-text (md->html - (include/expand-include-md - (:includer md-include-system) - (slurp file-path)))] + (assoc request :source + (include/expand-include-md + (:includer md-include-system) + (slurp file-path))))] (layout/render "wiki.html" (merge (util/standard-params request) processed-text diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index e92bafe..653e056 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -4,13 +4,13 @@ (:require [clojure.java.io :as cjio] [clojure.string :as cs] [environ.core :refer [env]] + [markdown.core :as md] [me.raynes.fs :as fs] [noir.io :as io] [noir.session :as session] [scot.weft.i18n.core :as i18n] [smeagol.authenticate :as auth] [smeagol.configuration :refer [config]] - [smeagol.formatting :refer [md->html]] [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -124,8 +124,8 @@ "In `smeagol.util/local-url `" file-path "` is not a servable resource:" any) (str "404-not-found?path=" file-path)))) -(local-url? "vendor/node_modules/photoswipe/dist/photoswipe.min.js") -(local-url? "/home/simon/workspace/smeagol/resources/public/vendor/node_modules/photoswipe/dist/photoswipe.min.js") +;; (local-url? "vendor/node_modules/photoswipe/dist/photoswipe.min.js") +;; (local-url? "/home/simon/workspace/smeagol/resources/public/vendor/node_modules/photoswipe/dist/photoswipe.min.js") (defn standard-params "Return a map of standard parameters to pass to the template renderer." @@ -134,8 +134,10 @@ {:user user :admin (auth/get-admin user) :js-from (:js-from config) - :side-bar (:content (md->html (slurp (cjio/file content-dir "_side-bar.md")))) - :header (:content (md->html (slurp (cjio/file content-dir "_header.md")))) + :side-bar (md/md-to-html-string + (slurp (cjio/file content-dir "_side-bar.md")):heading-anchors true) + :header (md/md-to-html-string + (slurp (cjio/file content-dir "_header.md")) :heading-anchors true) :version (System/getProperty "smeagol.version")})) diff --git a/test/smeagol/test/formatting.clj b/test/smeagol/test/formatting.clj index 9cb4956..5172403 100644 --- a/test/smeagol/test/formatting.clj +++ b/test/smeagol/test/formatting.clj @@ -12,9 +12,9 @@ "[This is a foreign link](http://to.somewhere)")] (is (= (local-links text) text) "Foreign links should be unchanged")))) -(deftest test-process-text - (testing "The process-text flow" - (let [expected process-test-return-value - actual (process-text "```test - ```")] - (is (= actual expected))))) +;; (deftest test-process-text +;; (testing "The process-text flow" +;; (let [expected process-test-return-value +;; actual (process-text "```test +;; ```")] +;; (is (= actual expected))))) From 03c63da19edff1ea66f78a8e2244dc46e7ffe95a Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Wed, 19 Feb 2020 15:24:08 +0000 Subject: [PATCH 22/24] Tactical commit --- resources/public/content/stylesheet.css | 101 ++++++++---------------- src/smeagol/formatting.clj | 37 +-------- src/smeagol/local_links.clj | 50 ++++++++++++ src/smeagol/util.clj | 9 ++- test/smeagol/test/formatting.clj | 38 +++++---- test/smeagol/test/local_links.clj | 14 ++++ 6 files changed, 127 insertions(+), 122 deletions(-) create mode 100644 src/smeagol/local_links.clj create mode 100644 test/smeagol/test/local_links.clj diff --git a/resources/public/content/stylesheet.css b/resources/public/content/stylesheet.css index 62690e0..81a661c 100644 --- a/resources/public/content/stylesheet.css +++ b/resources/public/content/stylesheet.css @@ -24,16 +24,6 @@ ## html elements generally in alphabetic order */ -a { - color: darkgray; - font-weight: bold; -} - -a:hover { - color: darkgray; - background:rgba(200,200,200,0.8); -} - body { margin: 0; padding: 0; @@ -62,15 +52,14 @@ dd { /* footer of the page - not-editable, provided by Smeagol */ footer { - border-top: thin solid silver; - color: gray; - background:rgba(200,200,200,0.8); + border-top: thin solid gray; clear: both; font-size: smaller; text-align: center; + color: gray; + background: rgba(224,224,224,0.95); width: 100%; margin: 0; - min-height: 4px; padding: 0.25em 0; bottom:0; position:fixed; @@ -82,14 +71,9 @@ footer { } footer div { - display: none; padding: 0.1em; } -footer:hover div { - display: block; -} - form { border: thin solid silver; } @@ -99,6 +83,8 @@ header { margin-top: 0; width:100%; max-width: 100%; + background-color: gray; + color: white; } header h1 { @@ -107,6 +93,7 @@ header h1 { header a { font-weight: bold; + color: white; } header a:hover { @@ -144,12 +131,12 @@ ins { label { width: 20%; min-width: 20em; - border-right: thin solid silver; + border-right: thin solid gray; display: inline-block; } table { - border: thin solid silver; + border: 2px solid black; border-collapse: collapse; } @@ -161,7 +148,7 @@ th, td { text-align: left; vertical-align: top; padding: 0.15em 1.5em; - border: 1px solid silver; + border: 1px solid gray; } th { @@ -179,7 +166,6 @@ th { /* left bar for all pages in the Wiki - editable, provided by users. Within main-container */ #side-bar { - display: none; width: 17%; height: 100%; float: left; @@ -187,10 +173,10 @@ th { /* cookies information box, fixed, in right margin, just above footer */ #cookies { - width: 20%; + width: 30%; float: right; position: fixed; - bottom: 8px; + bottom: 3.5em; right: 0; z-index: 175; background: transparent; @@ -204,8 +190,8 @@ th { text-align: right; padding: 0.25em 2em; border-radius: 0.25em; - color: gray; - background:rgba(200,200,200,0.8); + color: white; + background:rgba(40,40,40,0.8); } /* more-about-cookies box, normally hidden */ @@ -213,9 +199,9 @@ th { display: none; padding: 0.5em 2em; border-radius: 0.5em; - color: gray; - background:rgba(200,200,200,0.8); - border-bottom: thin solid gray; + color: white; + background:rgba(40,40,40,0.8); + border-bottom: thin solid white; } /* but magically appears on mouseover */ @@ -256,8 +242,8 @@ th { right: 0; padding: 0.25em 2em; border-radius: 0.25em; - color: gray; - background:rgba(200,200,200,0.8); + color: white; + background:rgba(40,40,40,0.8); font-size: 66%; } @@ -268,11 +254,7 @@ th { .minor-controls a { float: right; padding: 0.25em 2em; - color: gray; -} - -.minor-controls a:hover { - color: darkgray; + color: white; } .pseudo-input { @@ -321,7 +303,8 @@ th { /* content of the current page in the Wiki - editable, provided by users. Within main-container */ #content { border: thin solid silver; - width: 100%; + width: 80%; + float: right; padding-bottom: 5em; } @@ -329,29 +312,16 @@ th { display: none; } - #header { - font-size: smaller; - } - /* top-of-page navigation, not editable, provided by Smeagol */ #nav{ margin: 0; padding: 0; top: 0; - min-height: 4px; + width: 100%; _position: absolute; _top: expression(document.documentElement.scrollTop); z-index: 149; - color: gray; - background:rgba(200,200,200,0.8); - } - - #nav #nav-menu { - display: none; - } - - #nav:hover #nav-menu { - display: block; + background:rgba(40,40,40,0.8); } /* only needed for fly-out menu effect on tablet and phone stylesheets */ @@ -371,14 +341,14 @@ th { } #nav menu li a { - color: gray; + color: white; text-decoration: none; font-weight: bold; padding: 0.1em 0.75em; margin: 0; } - #nav menu li.active a { background: gray; color: white;} + #nav menu li.active a { background: gray;} li.nav-item a:hover { background: rgb( 240, 240, 240) } li.nav-item a:active { background: gray; color: white; } @@ -409,15 +379,17 @@ th { padding: 0; position: fixed; z-index: 149; - color: black; - background:rgba(200,200,200,0.9); + color: silver; + background:rgba(40,40,40,0.9); } #nav a { + color: white; + text-decoration: none; font-weight: bold; } - #nav:hover #nav-menu, #nav:hover #phone-side-bar { + #nav:hover #nav-menu { display: block; list-style-type: none; width: 100%; @@ -483,21 +455,18 @@ th { display: none; } - #header { - display: none; - } - #nav{ margin: 0; padding: 0; position: fixed; z-index: 149; - color: black; - background:rgba(200,200,200,0.9); + color: silver; + background:rgba(40,40,40,0.9); } #nav a { - color: black; + color: white; + text-decoration: none; font-weight: bold; } @@ -522,8 +491,6 @@ th { } #nav menu li a { - color: black; - font-weight: bold; } #nav ul li.active a { background: silver;} diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index cacc9ca..3807cb0 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -10,6 +10,7 @@ [smeagol.extensions.mermaid :refer [process-mermaid]] [smeagol.extensions.photoswipe :refer [process-photoswipe]] [smeagol.extensions.vega :refer [process-vega]] + [smeagol.local-links :refer :all] [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -44,26 +45,6 @@ ;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; Error to show if text to be rendered is nil. -;; TODO: this should go through i18n -(def no-text-error "No text: does the file exist?") - - -(defn local-links - "Rewrite text in `html-src` surrounded by double square brackets as a local link into this wiki." - [^String html-src] - (if html-src - (cs/replace html-src #"\[\[[^\[\]]*\]\]" - #(let [text (cs/replace %1 #"[\[\]]" "") - encoded (url-encode text) - ;; I use '\_' to represent '_' in wiki markup, because - ;; '_' is meaningful in Markdown. However, this needs to - ;; be stripped out when interpreting local links. - munged (cs/replace encoded #"%26%2395%3B" "_")] - (format "%s" munged text))) - no-text-error)) - - (declare process-text) @@ -133,26 +114,10 @@ result {:inclusions {inky (eval (list formatter (subs fragment (count token)) index))} :extensions {fkey (-> config :formatters fkey)}}) -;; (assoc-in -;; (assoc-in result [:inclusions inky] (eval (list formatter (subs fragment (count token)) index))) -;; [:extensions fkey] (-> config :formatters fkey)) (rest fragments) (cons inky processed)))) -;; (apply-formatter -;; 3 -;; {:inclusions {}} -;; '() -;; '() -;; "pswp -;; ![Frost on a gate, Laurieston](content/uploads/g1.jpg) -;; ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) -;; ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) -;; ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" -;; "pswp" -;; smeagol.extensions.photoswipe/process-photoswipe) - (defn reassemble-text "Reassemble these processed strings into a complete text, and process it as Markdown." diff --git a/src/smeagol/local_links.clj b/src/smeagol/local_links.clj new file mode 100644 index 0000000..f1bed0b --- /dev/null +++ b/src/smeagol/local_links.clj @@ -0,0 +1,50 @@ +(ns ^{:doc "Format Semagol's local links." + :author "Simon Brooke"} + smeagol.local-links + (:require [clojure.data.json :as json] + [clojure.string :as cs] + [cemerick.url :refer (url url-encode url-decode)])) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; Smeagol: a very simple Wiki engine. +;;;; +;;;; This program is free software; you can redistribute it and/or +;;;; modify it under the terms of the GNU General Public License +;;;; as published by the Free Software Foundation; either version 2 +;;;; of the License, or (at your option) any later version. +;;;; +;;;; This program is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with this program; if not, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2017 Simon Brooke +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +;; Error to show if text to be rendered is nil. +;; TODO: this should go through i18n +(def no-text-error "No text: does the file exist?") + + +(defn local-links + "Rewrite text in `html-src` surrounded by double square brackets as a local link into this wiki." + [^String html-src] + (if html-src + (cs/replace html-src #"\[\[[^\[\]]*\]\]" + #(let [text (cs/replace %1 #"[\[\]]" "") + encoded (url-encode text) + ;; I use '\_' to represent '_' in wiki markup, because + ;; '_' is meaningful in Markdown. However, this needs to + ;; be stripped out when interpreting local links. + munged (cs/replace encoded #"%26%2395%3B" "_")] + (format "%s" munged text))) + no-text-error)) + + diff --git a/src/smeagol/util.clj b/src/smeagol/util.clj index 653e056..86fdfac 100644 --- a/src/smeagol/util.clj +++ b/src/smeagol/util.clj @@ -11,6 +11,7 @@ [scot.weft.i18n.core :as i18n] [smeagol.authenticate :as auth] [smeagol.configuration :refer [config]] + [smeagol.local-links :refer :all] [taoensso.timbre :as log])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -135,9 +136,13 @@ :admin (auth/get-admin user) :js-from (:js-from config) :side-bar (md/md-to-html-string - (slurp (cjio/file content-dir "_side-bar.md")):heading-anchors true) + (local-links + (slurp (cjio/file content-dir "_side-bar.md"))) + :heading-anchors true) :header (md/md-to-html-string - (slurp (cjio/file content-dir "_header.md")) :heading-anchors true) + (local-links + (slurp (cjio/file content-dir "_header.md"))) + :heading-anchors true) :version (System/getProperty "smeagol.version")})) diff --git a/test/smeagol/test/formatting.clj b/test/smeagol/test/formatting.clj index 5172403..52e9817 100644 --- a/test/smeagol/test/formatting.clj +++ b/test/smeagol/test/formatting.clj @@ -1,20 +1,24 @@ (ns smeagol.test.formatting (:require [clojure.test :refer :all] - [smeagol.formatting :refer [local-links no-text-error]] - [smeagol.extensions.test :refer :all])) + [smeagol.formatting :refer :all] + [smeagol.extensions.test :refer :all] + [smeagol.local-links :refer :all])) -(deftest test-local-links - (testing "Rewriting of local links" - (is (= (local-links nil) no-text-error) "Should NOT fail with a no pointer exception!") - (is (= (local-links "") "") "Empty string should pass through unchanged.") - (is (= (local-links "[[froboz]]") "froboz") "Local link should be rewritten.") - (let [text (str "# This is a heading" - "[This is a foreign link](http://to.somewhere)")] - (is (= (local-links text) text) "Foreign links should be unchanged")))) - -;; (deftest test-process-text -;; (testing "The process-text flow" -;; (let [expected process-test-return-value -;; actual (process-text "```test -;; ```")] -;; (is (= actual expected))))) +(deftest test-apply-formatter + (testing "apply-formatter" + (let [actual (-> (apply-formatter + 3 + {:inclusions {}} + '() + '() + "test + ![Frost on a gate, Laurieston](content/uploads/g1.jpg) + ![Feathered crystals on snow surface, Taliesin](content/uploads/g2.jpg) + ![Feathered snow on log, Taliesin](content/uploads/g3.jpg) + ![Crystaline growth on seed head, Taliesin](content/uploads/g4.jpg)" + "test" + smeagol.extensions.test/process-test) + :inclusions + :inclusion-3) + expected ""] + (is (= actual expected))))) diff --git a/test/smeagol/test/local_links.clj b/test/smeagol/test/local_links.clj new file mode 100644 index 0000000..54d31e9 --- /dev/null +++ b/test/smeagol/test/local_links.clj @@ -0,0 +1,14 @@ +(ns smeagol.test.local-links + (:require [clojure.test :refer :all] + [smeagol.local-links :refer [local-links no-text-error]] + [smeagol.extensions.test :refer :all] + [smeagol.local-links :refer :all])) + +(deftest test-local-links + (testing "Rewriting of local links" + (is (= (local-links nil) no-text-error) "Should NOT fail with a no pointer exception!") + (is (= (local-links "") "") "Empty string should pass through unchanged.") + (is (= (local-links "[[froboz]]") "froboz") "Local link should be rewritten.") + (let [text (str "# This is a heading" + "[This is a foreign link](http://to.somewhere)")] + (is (= (local-links text) text) "Foreign links should be unchanged")))) From f82ad725c151feab74e1d1ae0e5b49bebe5d2bb6 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Wed, 19 Feb 2020 16:18:58 +0000 Subject: [PATCH 23/24] Working,, but regression in Mermaid stylesheet --- resources/test/test_extension.md | 7 +++++++ resources/test/test_local_links.md | 6 ++++++ src/smeagol/formatting.clj | 1 - test/smeagol/test/formatting.clj | 19 +++++++++++++++++++ test/smeagol/test/local_links.clj | 9 +++++++-- 5 files changed, 39 insertions(+), 3 deletions(-) create mode 100644 resources/test/test_extension.md create mode 100644 resources/test/test_local_links.md diff --git a/resources/test/test_extension.md b/resources/test/test_extension.md new file mode 100644 index 0000000..1f43160 --- /dev/null +++ b/resources/test/test_extension.md @@ -0,0 +1,7 @@ +# This is a test + +```test +the quick brown fox jumped over the lazy dog +``` + +This concludes the test. diff --git a/resources/test/test_local_links.md b/resources/test/test_local_links.md new file mode 100644 index 0000000..659f03a --- /dev/null +++ b/resources/test/test_local_links.md @@ -0,0 +1,6 @@ +# This is a test + +[[Local link]] +[Not a local link](http://nowhere.at.al) + +This concludes the test. diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 3807cb0..3617514 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -104,7 +104,6 @@ ^String fragment ^String token formatter] - (log/info "index:" index "(type result):" (type result) "(type fragments):" (type fragments) "fragment:" fragment "token:" token ":formatter" formatter) (let [inky (keyword (str "inclusion-" index)) fkey (keyword token)] diff --git a/test/smeagol/test/formatting.clj b/test/smeagol/test/formatting.clj index 52e9817..18769cd 100644 --- a/test/smeagol/test/formatting.clj +++ b/test/smeagol/test/formatting.clj @@ -1,5 +1,6 @@ (ns smeagol.test.formatting (:require [clojure.test :refer :all] + [clojure.string :as cs] [smeagol.formatting :refer :all] [smeagol.extensions.test :refer :all] [smeagol.local-links :refer :all])) @@ -22,3 +23,21 @@ :inclusion-3) expected ""] (is (= actual expected))))) + +(deftest test-md->html + (let [actual (:content (md->html + {:source + (cs/join + "\n" + ["# This is a test" + "" + "```test" + "![Frost on a gate, Laurieston](content/uploads/g1.jpg)" + "```" + "" + "This concludes the test"])} )) + expected (str + "

This is a test

" + "

" + "

This concludes the test

")] + (is (= expected actual)))) diff --git a/test/smeagol/test/local_links.clj b/test/smeagol/test/local_links.clj index 54d31e9..dc3682d 100644 --- a/test/smeagol/test/local_links.clj +++ b/test/smeagol/test/local_links.clj @@ -1,5 +1,6 @@ (ns smeagol.test.local-links (:require [clojure.test :refer :all] + [clojure.string :as cs] [smeagol.local-links :refer [local-links no-text-error]] [smeagol.extensions.test :refer :all] [smeagol.local-links :refer :all])) @@ -10,5 +11,9 @@ (is (= (local-links "") "") "Empty string should pass through unchanged.") (is (= (local-links "[[froboz]]") "froboz") "Local link should be rewritten.") (let [text (str "# This is a heading" - "[This is a foreign link](http://to.somewhere)")] - (is (= (local-links text) text) "Foreign links should be unchanged")))) + "[This is a foreign link](http://to.somewhere)")] + (is (= (local-links text) text) "Foreign links should be unchanged")) + (let [text (cs/trim (slurp "resources/test/test_local_links.md")) + actual (local-links text) + expected "# This is a test\n\nLocal link\n[Not a local link](http://nowhere.at.al)\n\nThis concludes the test."] + (is (= actual expected))))) From 019f2e8276c37af3d5f6e9295ab272e4c9995d2b Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Wed, 19 Feb 2020 16:42:58 +0000 Subject: [PATCH 24/24] Regression fixed. --- resources/config.edn | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/resources/config.edn b/resources/config.edn index ecb1ea0..96ab5ca 100644 --- a/resources/config.edn +++ b/resources/config.edn @@ -38,9 +38,8 @@ :scripts {} :styles {}} :mermaid {:formatter "smeagol.extensions.mermaid/process-mermaid" - :scripts {:core {:local "vendor/mermaid/dist/mermaid.js" - :remote "https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.4.6/mermaid.min.js"}} - :styles {}} + :scripts {:core {:local "vendor/node_modules/mermaid/dist/mermaid.min.js" + :remote "https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.4.6/mermaid.min.js"}}} :pswp {:formatter "smeagol.extensions.photoswipe/process-photoswipe" :scripts {:core {:local "vendor/node_modules/photoswipe/dist/photoswipe.min.js" :remote "https://cdnjs.cloudflare.com/ajax/libs/photoswipe/4.1.3/photoswipe.min.js"}