Changes In Branch deta-refactor Excluding Merge-Ins
This is equivalent to a diff from f06db447 to e90a714a
2020-01-13
| ||
19:38 | Merge deta refactor branch check-in: c06d4f58 user: joel tags: trunk | |
01:04 | Fix cache db filename, index page Leaf check-in: e90a714a user: joel tags: deta-refactor | |
00:52 | Fix series caching check-in: 624e5e2b user: joel tags: deta-refactor | |
00:27 | Redo everything cache-related check-in: 62f4a12e user: joel tags: deta-refactor | |
2019-08-19
| ||
21:36 | Add RSS feed. Closes [5cca77420922765f] check-in: f06db447 user: joel tags: trunk | |
21:33 | Add title-plain for notes; small refactor of note title generation check-in: 286673cf user: joel tags: trunk | |
Modified blog.rkt from [1ddb51ef] to [1dda01dc].
︙ | ︙ | |||
34 35 36 37 38 39 40 | <nav id="bottom-nav"><ul>◊|page-nav|</ul></nav> ◊html$-page-body-close[] </html>}) ;; Grabs all the articles+notes from the cache and writes out all the blog page files (define (build-blog) | < | < | | | 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | <nav id="bottom-nav"><ul>◊|page-nav|</ul></nav> ◊html$-page-body-close[] </html>}) ;; Grabs all the articles+notes from the cache and writes out all the blog page files (define (build-blog) (define arts-n-notes (slice-at (listing-htmls (articles+notes 'full #:series #f)) per-page)) (define pagecount (length arts-n-notes)) (for ([pagenum (in-range 1 (+ 1 pagecount))] [page (in-list arts-n-notes)]) (define filename (format "blog-pg~a.html" pagenum)) (displayln (format "Writing: ~a" filename)) (display-to-file (blog-page (apply string-append page) pagenum pagecount) filename #:mode 'text #:exists 'replace))) (define (main) ;; Do it! (build-blog)) |
Modified code-docs/crystalize.scrbl from [ff8f9919] to [146fa5fb].
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | #lang scribble/manual @; SPDX-License-Identifier: BlueOak-1.0.0 @; This file is licensed under the Blue Oak Model License 1.0.0. @(require "scribble-helpers.rkt") @(require (for-label "../pollen.rkt" "../dust.rkt" "../crystalize.rkt" racket/base racket/contract racket/string txexpr pollen/template pollen/pagetree sugar/coerce)) @title{@filepath{crystalize.rkt}} @defmodule["crystalize.rkt" #:packages ()] “Crystalizing” is an extra layer in between docs and templates that destructures the doc and stores it in various pieces in a SQLite cache. Individual articles save chunks of rendered HTML to the | > | | | | | | | | | > | | | | | | < < < < < < < < < < < | < < > | | < < < < < < | | < < < | < < < < < < < < < < < | | | > > | | | < < < < | | > > > > > > > > > | | | > > > > > > > | > | | | | | > | | < | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | #lang scribble/manual @; SPDX-License-Identifier: BlueOak-1.0.0 @; This file is licensed under the Blue Oak Model License 1.0.0. @(require "scribble-helpers.rkt") @(require (for-label "../pollen.rkt" "../dust.rkt" "../crystalize.rkt" racket/base racket/contract racket/string deta txexpr pollen/template pollen/pagetree sugar/coerce)) @title{@filepath{crystalize.rkt}} @defmodule["crystalize.rkt" #:packages ()] “Crystalizing” is an extra layer in between docs and templates that destructures the doc and stores it in various pieces in a SQLite cache. Individual articles save chunks of rendered HTML to the cache when their individual pages are rendered. When pulling together listings of articles in different contexts that need to be filtered and sorted, a SQL query is much faster than trolling through the Pollen cache for matching docs and regenerating the HTML. @defproc[(init-cache-db!) void?] Initializes the SQLite database cache file (named @filepath{vitreous.sqlite} and located in the project root folder) by running queries to create tables in the database if they do not exist. (The file itself is created at the module level.) This function is called automatically in @filepath{pollen.rkt} whenever HTML is the target output. @defproc[(parse-and-cache-article! [pagenode pagenode?] [doc txexpr?]) non-empty-string?] Returns a string containing the HTML of @racket[_doc]. @margin-note{This is one function that breaks my convention of using a prefix of @tt{html$-} for functions that return a single string of HTML.} Privately, it does a lot of other work. The article is analyzed, additional metadata is constructed, and it is saved to the SQLite cache. If the article specifies a @racket['series] meta, information about that series is fetched and used in the rendering of the article. If there are @racket[note]s in the doc, they are parsed and saved individually to the SQLite cache. If any of the notes use the @code{#:disposition} attribute, information about the disposition is parsed out and used in the rendering of the article. @deftogether[(@defproc[(<listing-full> [query-func (-> any/c query?)] [#:series series (or/c string? (listof string? boolean?)) #t] [#:limit limit integer? -1] [order stringish? 'desc]) txexpr?] @defproc[(<listing-excerpt> [query-func (-> any/c query?)] [#:series series (or/c string? (listof string? boolean?)) #t] [#:limit limit integer? -1] [order stringish? 'desc]) txexpr?] @defproc[(<listing-short> [query-func (-> any/c query?)] [#:series series (or/c string? (listof string? boolean?)) #t] [#:limit limit integer? -1] [order stringish? 'desc]) txexpr?])] Fetches the HTML for items from the SQLite cache and returns the HTML strings fenced inside a @racket['style] tagged X-expression. The items will be ordered by publish date according to @racket[_order] and optionally limited to the series specified in @racket[_series]. The @racket[_query-func] should be either @racket[articles], which will create a listing of articles only, or @racket[articles+notes], which will include notes intermingled with articles. @margin-note{Note that the signature shown for the @racket[_query-func] argument above is incomplete. If you choose to pass a function other than @racket[articles] or @racket[articles+notes], you must use a function with exactly the same signature as those functions.} If @racket[_series] expression evaluates to @racket[#f], articles will not be filtered by series. If it evaluates to @racket[#t] (the default), articles will be filtered by those that specify the current output of @racket[here-output-path] in their @tt{series_pagenode} column in the SQLite cache. If a string is supplied, articles will be filtered by those containing that exact value in their @tt{series_pagenode} column in the SQLite cache. The @racket[_order] expression must evaluate to either @racket["ASC"] or @racket["DESC"] and the @racket[_limit] expressions must evaluate to a value suitable for use in the @tt{LIMIT} clause of @ext-link["https://sqlite.org/lang_select.html"]{a SQLite @tt{SELECT} statement}. An expression that evaluates to a negative integer (the default) is the same as having no limit. The reason for enclosing the results in a @racket['style] txexpr is to prevent the HTML from being escaped by @racket[->html] in the template. This tag was picked for the job because there will generally never be a need to include any actual CSS information inside a @tt{<style>} tag in any page, so it can be safely filtered out later. To remove the enclosing @tt{<style>} tag, see @racket[unfence]. @deftogether[(@defproc[(articles [type (or/c 'full 'excerpt 'short)] [#:series series (or/c string? (listof string? boolean?)) #t] [#:limit limit integer? -1] [order stringish? 'desc]) query?] @defproc[(articles+notes [type (or/c 'full 'excerpt 'short)] [#:series series (or/c string? (listof string? boolean?)) #t] [#:limit limit integer? -1] [order stringish? 'desc]) query?])] Create a query that fetches either articles only (@racket[articles]) or articles and notes intermingled (@racket[articles+notes]), sorted by publish date and optionally limited to a particular series. Typically you will pass these functions by name to listing functions like @racket[<listing-full>] rather than calling them directly. @defproc[(unfence [html string?]) string?] Returns @racket[_html] with all occurrences of @racket["<style>"] and @racket["</style>"] removed. The contents of the style tags are left intact. Use this with strings returned from @racket[->html] when called on docs that use the @racket[<listing-full>] tag function or its siblings. @defparam[current-plain-title non-empty-string? #:value "void"] Contains (or sets) the “plain” title (i.e., with no HTML markup) for the current article based on analysis done by @racket[parse-and-cache-article!]. If the article did not specify a title, a default title is supplied. If the article contained a @racket[note] that used the @code{#:disposition} attribute, the disposition-mark may be included in the title. Note that this needs to be called @emph{after} @racket[parse-and-cache-article!] in order to get an up-to-date value. |
Modified code-docs/dust.scrbl from [d5eab31d] to [dfcfb9ab].
︙ | ︙ | |||
157 158 159 160 161 162 163 | (define doc '(root (p "If I had been astonished at first catching a glimpse of so outlandish an " "individual as Queequeg circulating among the polite society of a civilized " "town, that astonishment soon departed upon taking my first daylight " "stroll through the streets of New Bedford…"))) (default-title (get-elements doc))] | | | | | 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | (define doc '(root (p "If I had been astonished at first catching a glimpse of so outlandish an " "individual as Queequeg circulating among the polite society of a civilized " "town, that astonishment soon departed upon taking my first daylight " "stroll through the streets of New Bedford…"))) (default-title (get-elements doc))] @defproc[(metas-series-pagenode) pagenode?] If @code{(current-metas)} has the key @racket['series], converts its value to the pagenode pointing to that series, otherwise returns @racket['||]. @defproc[(series-metas-noun) string?] If @code{(current-metas)} has the key @racket['series], and if the corresponding series defines a meta value for @racket['noun-singular], then return it, otherwise return @racket[""]. @defproc[(series-metas-title) string?] If @code{(current-metas)} has the key @racket['series], and if the corresponding series defines a meta value for @racket['title], then return it, otherwise return @racket[""]. @defproc[(invalidate-series) (or/c void? boolean?)] If the current article specifies a @racket['series] meta, and if a corresponding @filepath{.poly.pm} |
︙ | ︙ |
Modified code-docs/main.scrbl from [1a5ea062] to [6cbd40b5].
︙ | ︙ | |||
26 27 28 29 30 31 32 | @local-table-of-contents[] @include-section["overview.scrbl"] @include-section["pollen.scrbl"] @; pollen.rkt @include-section["dust.scrbl"] @; dust.rkt | < | 26 27 28 29 30 31 32 33 34 35 | @local-table-of-contents[] @include-section["overview.scrbl"] @include-section["pollen.scrbl"] @; pollen.rkt @include-section["dust.scrbl"] @; dust.rkt @include-section["snippets-html.scrbl"] @; you get the idea @include-section["crystalize.scrbl"] |
Deleted code-docs/sqlite-tools.scrbl version [9cc80fcd].
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Modified crystalize.rkt from [0131cbe3] to [cb633ea2].
1 2 3 4 5 | #lang racket/base ; SPDX-License-Identifier: BlueOak-1.0.0 ; This file is licensed under the Blue Oak Model License 1.0.0. | < < < < | < < < < | > | < < < < > | | | < | | < | | < | > > > > | | | | > | | < < | > < | | < < | > | | | | | | | | | | | | | | | | | | > | | | | | | | | | | | | | | > | | | | | | > | | | | < < | | | | | < < < < | > > | > | | | | | | < > | > > > > > | < | | < > | | | | | | | | | | | | | | | | < < | < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | < < < < | < | < < | < | | > | | | < < > | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | #lang racket/base ; SPDX-License-Identifier: BlueOak-1.0.0 ; This file is licensed under the Blue Oak Model License 1.0.0. (require deta db/base db/sqlite3 threading txexpr gregor) (require racket/match racket/string pollen/pagetree pollen/template (except-in pollen/core select) ; avoid conflict with deta pollen/setup) (require "dust.rkt" "snippets-html.rkt") (provide init-cache-db! cache-conn ; The most eligible bachelor in Neo Yokyo parse-and-cache-article! cache-series! current-plain-title (schema-out cache:article) (schema-out cache:note) (schema-out cache:series) (schema-out cache:index-entry) articles articles+notes listing-htmls <listing-full> <listing-excerpt> <listing-short> unfence) ;; Cache DB and Schemas (define DBFILE (build-path (current-project-root) "vitreous.sqlite")) (define cache-conn (sqlite3-connect #:database DBFILE #:mode 'create)) (define current-plain-title (make-parameter "void")) (define-schema cache:article #:table "articles" ([id id/f #:primary-key #:auto-increment] [page symbol/f] [title-plain string/f] [title-html-flow string/f] [title-specified? boolean/f] [published string/f] [updated string/f] [author string/f] [conceal string/f] [series-page symbol/f] [noun-singular string/f] [note-count integer/f] [doc-html string/f] [disposition string/f] [disp-html-anchor string/f] [listing-full-html string/f] ; full content but without notes [listing-excerpt-html string/f] ; Not used for now [listing-short-html string/f])) ; Date and title only (define-schema cache:note #:table "notes" ([id id/f #:primary-key #:auto-increment] [page symbol/f] [html-anchor string/f] [title-html-flow string/f] ; No block-level HTML elements [title-plain string/f] [author string/f] [author-url string/f] [published string/f] [disposition string/f] [content-html string/f] [series-page symbol/f] [listing-full-html string/f] [listing-excerpt-html string/f] ; Not used for now [listing-short-html string/f])) ; Date and title only (define-schema cache:series #:table "series" ([id id/f #:primary-key #:auto-increment] [page symbol/f] [title string/f] [published string/f] [noun-plural string/f] [noun-singular string/f])) (define-schema cache:index-entry #:table "index_entries" ([id id/f #:primary-key #:auto-increment] [entry string/f] [subentry string/f] [page symbol/f] [html-anchor string/f])) (define-schema listing #:virtual ([html string/f] [published date/f] [series-page symbol/f])) (define (init-cache-db!) (create-table! cache-conn 'cache:article) (create-table! cache-conn 'cache:note) (create-table! cache-conn 'cache:series) (create-table! cache-conn 'cache:index-entry)) ;; Save an article and its notes (if any) to the database, and return the ;; rendered HTML of the complete article. ;; (define (parse-and-cache-article! pagenode doc) (define-values (doc-no-title maybe-title) (splitf-txexpr doc (make-tag-predicate 'title))) (define-values (body-txpr note-txprs) (splitf-txexpr doc-no-title (make-tag-predicate 'note))) (define-values (disposition disp-note-id) (notes->last-disposition-values note-txprs)) (let* ([pubdate (select-from-metas 'published (current-metas))] [doc-html (->html body-txpr #:splice? #t)] [title-specified? (not (equal? '() maybe-title))] [title-val (if (not (null? maybe-title)) (car maybe-title) (check-for-poem-title doc))] [title-tx (make-article-title pagenode title-val body-txpr disposition disp-note-id)] [title-html (->html title-tx #:splice? #t)] [title-plain (tx-strs title-tx)] [header (html$-article-open pagenode title-specified? title-tx pubdate)] [series-node (metas-series-pagenode)] [footertext (make-article-footertext pagenode series-node disposition disp-note-id (length note-txprs))] [footer (html$-article-close footertext)] [listing-short (html$-article-listing-short pagenode pubdate title-html)] [notes-section-html (cache-notes! pagenode title-plain note-txprs)]) (cache-index-entries! pagenode doc) ; note original doc is used here (current-plain-title title-plain) (insert-one! cache-conn (make-cache:article #:page pagenode #:title-plain title-plain #:title-html-flow title-html #:title-specified? title-specified? #:published pubdate #:updated (maybe-meta 'updated) #:author (maybe-meta 'author default-authorname) #:conceal (maybe-meta 'conceal) #:series-page series-node #:noun-singular (maybe-meta 'noun (series-metas-noun)) #:note-count (length note-txprs) #:doc-html doc-html #:disposition disposition #:disp-html-anchor disp-note-id #:listing-full-html (string-append header doc-html footer) #:listing-excerpt-html "" #:listing-short-html listing-short)) (string-append header doc-html notes-section-html footer))) (define (check-for-poem-title doc-txpr) (match (car (get-elements doc-txpr)) [(txexpr 'div (list (list 'class "poem")) (list* (txexpr 'p (list (list 'class "verse-heading")) heading-elems) _)) `(title (span [[class "smallcaps"]] "‘" ,@heading-elems "’"))] [_ '()])) ;; Return a title txexpr for the current article, constructing a default if no title text was specified. (define (make-article-title pagenode supplied-title body-tx disposition disp-note-id) (define title-elems (cond [(null? supplied-title) (list (default-title (get-elements body-tx)))] [else (get-elements supplied-title)])) (define disposition-part (cond [(non-empty-string? disposition) (define-values (mark _) (disposition-values disposition)) `(a [[class "disposition-mark"] [href ,(format "~a~a#~a" web-root pagenode disp-note-id)]] ,mark)] [else ""])) ;; Returns a txexpr, the tag will be discarded by the template/snippets `(title ,@title-elems ,disposition-part)) ;; Convert a bunch of information about an article into some nice English and links. (define (make-article-footertext pagenode series disposition disp-note-id note-count) (define series-part (match (series-metas-title) [(? non-empty-string? s-title) (format "<span class=\"series-part\">This is ~a, part of <a href=\"/~a\">‘~a’</a>.</span>" (series-metas-noun) series s-title)] [_ ""])) (define disp-part (cond [(non-empty-string? disposition) (define-values (mark verb) (disposition-values disposition)) (format "Now considered <a href=\"/~a#~a\">~a</a>." pagenode disp-note-id verb)] |
︙ | ︙ | |||
280 281 282 283 284 285 286 | (format "There is <a href=\"/~a#furthernotes\">a note</a> appended." pagenode)] [else ""])) (cond [(ormap non-empty-string? (list series-part disp-part notes-part)) (string-join (list series-part disp-part notes-part))] [else ""])) | < < < < | < > | | < | > > | < | | | < < | | | < > | < | < < | | | | | | > | | < | > | < | < < | < > | < < | < < < | > | > | < < < < < < | | | | | > > > > > > > > > > > > | | | > | | | | > > > | > > > > > > > > > | > | > > > | > > > > > > > > > > > > | | > | < > > | > > > > | > | > > > | > | > | | > > | > > > > | > > > | > > > > | > | < > > | < | > > > > > > > | | | | < | 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 | (format "There is <a href=\"/~a#furthernotes\">a note</a> appended." pagenode)] [else ""])) (cond [(ormap non-empty-string? (list series-part disp-part notes-part)) (string-join (list series-part disp-part notes-part))] [else ""])) ;; ~~~ Notes ~~~ (define (cache-notes! pagenode parent-title note-txprs) (query-exec cache-conn (delete (~> (from cache:note #:as n) (where (= n.page ,(symbol->string pagenode)))))) (cond [(not (null? note-txprs)) (define note-htmls (for/list ([n (in-list note-txprs)]) (cache-note! n pagenode parent-title))) (html$-notes-section note-htmls)] [else ""])) ;; Save an individual note to the DB and return the HTML of the complete note as ;; it should appear on an individual article page (define (cache-note! note-tx pagenode parent-title-plain) (define-values (_ attrs elems) (txexpr->values note-tx)) (define disposition-attr (maybe-attr 'disposition attrs)) (define note-date (maybe-attr 'date attrs)) ;; Check required attributes (unless (non-empty-string? note-date) (raise-arguments-error 'note "required attr missing: date" "attrs" attrs)) (unless (or (string=? "" disposition-attr) (>= (length (string-split disposition-attr)) 2)) (raise-arguments-error 'note "must be in format \"[symbol] [past-tense-verb]\"" "disposition attr" disposition-attr)) (define-values (disp-mark disp-verb) (disposition-values disposition-attr)) (let* ([note-id (build-note-id note-tx)] [title-tx (make-note-title pagenode parent-title-plain)] [title-html (->html title-tx #:splice? #t)] [author (maybe-attr 'author attrs default-authorname)] [author-url (maybe-attr 'author-url attrs)] [content-html (html$-note-contents disp-mark disp-verb elems)]) (insert-one! cache-conn (make-cache:note #:page pagenode #:html-anchor note-id #:title-html-flow title-html #:title-plain (tx-strs title-tx) #:published note-date #:author author #:author-url author-url #:disposition disposition-attr #:series-page (metas-series-pagenode) #:content-html content-html #:listing-full-html (html$-note-listing-full pagenode note-id title-html note-date content-html author author-url) #:listing-excerpt-html "" #:listing-short-html "")) (html$-note-in-article note-id note-date content-html author author-url))) (define (make-note-title pagenode parent-title-plain) `(note-title "Re: " (a [[class "cross-reference"] [href ,(format "~a~a" web-root pagenode)]] ,parent-title-plain))) ;; ~~~ Keyword Index Entries ~~~ ;; (private) Convert an entry key into a list of at most two elements, ;; a main entry and a sub-entry. ;; "entry" → '("entry" "") ;; "entry!sub" → '("entry" "sub") ;; "entry!sub!why?!? '("entry" "sub") (define (split-entry str) (define splits (string-split str "!")) (list (car splits) (cadr (append splits (list ""))))) (define (index-entry-txpr? tx) (and (txexpr? tx) (string=? "index-link" (attr-ref tx 'class "")) ; see definition of html-index (attr-ref tx 'data-index-entry #f))) (define (txexpr->index-entry tx pagenode) (match (split-entry (attr-ref tx 'data-index-entry)) [(list main sub) (make-cache:index-entry #:entry main #:subentry sub #:page pagenode #:html-anchor (attr-ref tx 'id))])) ;; Save any index entries in doc to the SQLite cache. ;; Sub-entries are specified by "!" in the index key (define (cache-index-entries! pagenode doc) (define-values (_ entry-txs) (splitf-txexpr doc index-entry-txpr?)) ; Naive idempotence: delete and re-insert all index entries every time doc is rendered. (query-exec cache-conn (delete (~> (from cache:index-entry #:as entry) (where (= entry.page ,(symbol->string pagenode)))))) (unless (null? entry-txs) (void (apply insert! cache-conn (for/list ([etx (in-list entry-txs)]) (txexpr->index-entry etx pagenode)))))) ;; ;; ~~~ Fetching articles and notes ~~~ ;; ;; (Private use) Conveniece function for the WHERE `series-page` clause (define (where-series q s) (define (s->p x) (format "~a/~a.html" series-folder x)) (match s [(list series ...) (where q (in a.series-page ,(map s->p series)))] ; WHERE series-page IN (item1 ...) [(or (? string? series) (? symbol? series)) (where q (= a.series-page ,(s->p series)))] ; WHERE series-page = "item" [#t (where q (= a.series-page ,(path->string (here-output-path))))] [_ q])) ;; Needed to "parameterize" column names ;; see https://github.com/Bogdanp/deta/issues/14#issuecomment-573344928 (require (prefix-in ast: deta/private/ast)) ;; Builds a query to fetch articles (define (articles type #:series [s #t] #:limit [lim -1] #:order [ord 'desc]) (define html-field (format "listing_~a_html" type)) (~> (from cache:article #:as a) (select (fragment (ast:as (ast:qualified "a" html-field) "html")) a.published a.series-page) (where-series s) (limit ,lim) (order-by ([a.published ,ord])) (project-onto listing-schema))) ;; Builds a query that returns articles and notes intermingled chronologically (define (articles+notes type #:series [s #t] #:limit [lim -1] #:order [ord 'desc]) (define html-field (format "listing_~a_html" type)) (~> (from (subquery (~> (from cache:article #:as A) (select (fragment (ast:as (ast:qualified "A" html-field) "html")) A.published A.series-page) (union (~> (from cache:note #:as N) (select (fragment (ast:as (ast:qualified "N" html-field) "html")) N.published N.series-page))))) #:as a) (where-series s) (limit ,lim) (order-by ([a.published ,ord])) (project-onto listing-schema))) ;; Get all the a list of the HTML all the results in a query (define (listing-htmls list-query) (for/list ([l (in-entities cache-conn list-query)]) (listing-html l))) ;; Return cached HTML of articles and/or notes, fenced within a style txexpr to prevent it being ;; escaped by ->html. See also: definition of `unfence` ;; E.g.: (<listing-full> articles+notes) (define (<listing-full> query-func #:series [s #t] #:limit [lim -1] #:order [ord 'desc]) `(style ,@(listing-htmls (query-func 'full #:series s #:limit lim #:order ord)))) ;; ^^^^^ (define (<listing-excerpt> query-func #:series [s #t] #:limit [lim -1] #:order [ord 'desc]) `(style ,@(listing-htmls (query-func 'excerpt #:series s #:limit lim #:order ord)))) ;; ^^^^^^^^ (define (<listing-short> query-func #:series [s #t] #:limit [lim -1] #:order [ord 'desc]) `(style "<ul class=\"article-list\">" ,@(listing-htmls (query-func 'short #:series s #:limit lim #:order ord)) "</ul>")) ;; ^^^^^^ ;; Remove "<style>" and "</style>" introduced by using ->html on docs containing output from ;; listing functions (define (unfence html-str) (regexp-replace* #px"<[\\/]{0,1}style>" html-str "")) ;; Save the current article to the `series` table of the SQLite cache ;; Should be called from a template for series pages (define (cache-series!) (define here-page (path->string (here-output-path))) (query-exec cache-conn (delete (~> (from cache:series #:as s) (where (= s.page ,here-page))))) (void (insert-one! cache-conn (make-cache:series #:page (string->symbol here-page) #:title (hash-ref (current-metas) 'title) #:published (hash-ref (current-metas) 'published "") #:noun-plural (hash-ref (current-metas) 'noun-plural "") #:noun-singular (hash-ref (current-metas) 'noun-singular ""))))) |
Modified dust.rkt from [4209ef85] to [c096eb0e].
︙ | ︙ | |||
17 18 19 20 21 22 23 | ;; Provides common helper functions used throughout the project (provide maybe-meta ; Select from (current-metas) or default value ("") if not available maybe-attr ; Return an attribute’s value or a default ("") if not available here-output-path here-id | | | | | 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | ;; Provides common helper functions used throughout the project (provide maybe-meta ; Select from (current-metas) or default value ("") if not available maybe-attr ; Return an attribute’s value or a default ("") if not available here-output-path here-id series-metas-noun ; Retrieve noun-singular from current 'series meta, or "" series-metas-title ; Retrieve title of series in current 'series meta, or "" metas-series-pagenode invalidate-series make-tag-predicate tx-strs ymd->english ymd->dateformat default-authorname default-title |
︙ | ︙ | |||
65 66 67 68 69 70 71 | (drop-common-prefix (explode-path (current-project-root)) (explode-path (string->path (select-from-metas 'here-path (current-metas)))))) (->output-path (apply build-path rel-path-parts))] [else (string->path ".")])) ;; Checks current-metas for a 'series meta and returns the pagenode of that series, ;; or '|| if no series is specified. | | | | | | | 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | (drop-common-prefix (explode-path (current-project-root)) (explode-path (string->path (select-from-metas 'here-path (current-metas)))))) (->output-path (apply build-path rel-path-parts))] [else (string->path ".")])) ;; Checks current-metas for a 'series meta and returns the pagenode of that series, ;; or '|| if no series is specified. (define (metas-series-pagenode) (define maybe-series (or (select-from-metas 'series (current-metas)) "")) (cond [(non-empty-string? maybe-series) (->pagenode (format "~a/~a.html" series-folder maybe-series))] [else '||])) (define (series-metas-noun) (define series-pnode (metas-series-pagenode)) (case series-pnode ['|| ""] ; no series specified [else (or (select-from-metas 'noun-singular series-pnode) "")])) (define (series-metas-title) (define series-pnode (metas-series-pagenode)) (case series-pnode ['|| ""] ; no series specified [else (or (select-from-metas 'title series-pnode) "")])) ;; Generates a short ID for the current article (define (here-id [suffix #f]) (define here-hash |
︙ | ︙ |
Modified index.html.pp from [930470e2] to [6ce20187].
1 2 3 4 5 6 7 8 | #lang pollen ◊; SPDX-License-Identifier: BlueOak-1.0.0 ◊; This file is licensed under the Blue Oak Model License 1.0.0. ◊(require pollen/template db/base racket/list racket/match) ◊(define (fetch-series) | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | #lang pollen ◊; SPDX-License-Identifier: BlueOak-1.0.0 ◊; This file is licensed under the Blue Oak Model License 1.0.0. ◊(require pollen/template db/base racket/list racket/match) ◊(define (fetch-series) (define q "SELECT noun_plural, page, title FROM series ORDER BY noun_plural DESC") (query-rows cache-conn q)) ◊(define (series-item->txpr s) (match-define (list n pagenode title) s) `(li (a [[href ,pagenode]] (i ,title)))) ◊(define (series-grouped-list) ;; Produces '((("noun1" "p.html" "Title") ("noun1" "q.html" "Title")) (("noun2" ...) ...)) |
︙ | ︙ | |||
84 85 86 87 88 89 90 | your own or someone else’s. ◊em{I’ve seen this before} says the voice on the other end. ¶ Everything (almost) is ◊link[1]{arranged in time order, newest first}. There are also a few arranged into named collections: ◊url[1]{/blog-pg1.html} }) | | | 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | your own or someone else’s. ◊em{I’ve seen this before} says the voice on the other end. ¶ Everything (almost) is ◊link[1]{arranged in time order, newest first}. There are also a few arranged into named collections: ◊url[1]{/blog-pg1.html} }) ◊; stop for now: (crystalize-index-entries! '|index.html| front-page-body) <main> ◊(->html front-page-body #:splice? #t) ◊(->html (series-grouped-list)) </main> </body> </html> |
Modified keyword-index.rkt from [433d5c8d] to [50258609].
︙ | ︙ | |||
100 101 102 103 104 105 106 | (cond [(non-empty-string? subhead) (add-new-subentry e record)] [else (add-entry-link e record)])) ;; Get the index entries from the SQLite cache, return them as a list of vectors (Records!) (define (fetch-entries) (define q ◊string-append{ | | | | | | 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | (cond [(non-empty-string? subhead) (add-new-subentry e record)] [else (add-entry-link e record)])) ;; Get the index entries from the SQLite cache, return them as a list of vectors (Records!) (define (fetch-entries) (define q ◊string-append{ SELECT entry, subentry, a.rowid, "◊web-root" || k.page || "#" || html_anchor AS href, title_plain FROM index_entries k INNER JOIN articles a ON a.page = k.page ORDER BY entry COLLATE NOCASE ASC, subentry COLLATE NOCASE ASC;}) (query-rows cache-conn q)) ;; Convert a list of vectors from the cache DB into a list of the form: ;; ((FIRST-LETTER (entries ...)) ...) ;; The method relies on the records being pre-sorted by the SQL query. (define (group-entries records) (define collated (for/fold ([entries (list (new-entry (first records)))] |
︙ | ︙ | |||
156 157 158 159 160 161 162 | <div id="keywordindex"> ◊the-index </div> ◊html$-page-body-close[] </html>}) (define (main) | < | 156 157 158 159 160 161 162 163 164 165 166 167 | <div id="keywordindex"> ◊the-index </div> ◊html$-page-body-close[] </html>}) (define (main) (displayln "Writing keyword-index.html…") (display-to-file (html$-keywordindex-page (html$-index (group-entries (fetch-entries)))) "keyword-index.html" #:mode 'text #:exists 'replace)) |
Modified pollen.rkt from [cbfc059e] to [ec6e30b5].
︙ | ︙ | |||
36 37 38 39 40 41 42 | (map resolve-module-path (list tags-html.rkt snippets-html.rkt dust.rkt crystalize.rkt)))) (case (current-poly-target) | | | 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | (map resolve-module-path (list tags-html.rkt snippets-html.rkt dust.rkt crystalize.rkt)))) (case (current-poly-target) [(html) (init-cache-db!)]) ;; Macro for defining tag functions that automatically branch based on the ;; current output format and the list of poly-targets in the setup module. ;; Use this macro when you know you will need keyword arguments. ;; (define-syntax (poly-branch-kwargs-tag stx) (syntax-parse stx |
︙ | ︙ |
Modified rss-feed.rkt from [e414aebe] to [9efceb86].
︙ | ︙ | |||
43 44 45 46 47 48 49 | (date->string now #t))) (string-append timestamp "Z")) ;; Get the data out of the SQLite cache as vectors (define (fetch-rows) (define fields '(pagenode title_plain published updated author doc_html)) (define select #<<--- | | | | | | | | | 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | (date->string now #t))) (string-append timestamp "Z")) ;; Get the data out of the SQLite cache as vectors (define (fetch-rows) (define fields '(pagenode title_plain published updated author doc_html)) (define select #<<--- SELECT `path`, `title`, `published`, `updated`, `author`, `entry_contents` FROM (SELECT `page` AS `path`, `title_plain` AS `title`, `published`, `updated`, `author`, `doc_html` AS `entry_contents` FROM `articles` UNION SELECT `page` || '#' || `html_anchor` AS `path`, `title_plain` AS `title`, `published`, "" AS `updated`, `author`, `content_html` as `entry_contents` FROM `notes`) ORDER BY `published` DESC LIMIT ~a --- ) (query-rows cache-conn (format select feed-item-limit))) (define (vector->rss-item vec) (match-define (vector path title published updated author contents) vec) (define entry-url (string-append feed-site-url web-root path)) (define update-ts (cond [(non-empty-string? updated) updated] |
︙ | ︙ | |||
97 98 99 100 101 102 103 | (name ,feed-author) (email ,@(email-encode feed-author-email))) ,@(map vector->rss-item (fetch-rows)))) (string-append "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" (xexpr->string feed-xpr))) (define (main) | < | 97 98 99 100 101 102 103 104 | (name ,feed-author) (email ,@(email-encode feed-author-email))) ,@(map vector->rss-item (fetch-rows)))) (string-append "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" (xexpr->string feed-xpr))) (define (main) (display-to-file (rss-feed) "feed.xml" #:mode 'text #:exists 'replace)) |
Modified series/template.html.p from [00a0ebd1] to [7a674800].
1 2 | <!DOCTYPE html> <html lang="en"> | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | <!DOCTYPE html> <html lang="en"> ◊cache-series![] ◊html$-page-head[(select-from-metas 'title metas)] ◊html$-page-body-open["series-page"] ◊(unfence (->html doc #:splice? #t)) ◊html$-page-body-close[] </html> |
Modified snippets-html.rkt from [2b13836e] to [9386bc7c].
︙ | ︙ | |||
111 112 113 114 115 116 117 | (define maybe-author-class (cond [(string=? author default-authorname) "by-proprietor"] [else ""])) ◊string-append{ <article class="with-title ◊maybe-author-class hentry"> <h1 class="entry-title note-full">◊|title-html-flow|</h1> | | | 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | (define maybe-author-class (cond [(string=? author default-authorname) "by-proprietor"] [else ""])) ◊string-append{ <article class="with-title ◊maybe-author-class hentry"> <h1 class="entry-title note-full">◊|title-html-flow|</h1> <p class="time"><a href="/◊(symbol->string pagenode)#◊note-id" class="rel-bookmark note-permlink"> <time datetime="◊date">◊ymd->english[date]</time> </a></p> <section class="entry-content"> <div class="p-content p-name">◊|contents|</div> ◊author-part </section> </article>}) |
︙ | ︙ |
Deleted sqlite-tools.rkt version [f4b3e603].
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Modified template.html.p from [d6041578] to [f2509ece].
1 2 3 4 | <!DOCTYPE html> ◊; SPDX-License-Identifier: BlueOak-1.0.0 ◊; This file is licensed under the Blue Oak Model License 1.0.0. <html lang="en"> | < | < | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | <!DOCTYPE html> ◊; SPDX-License-Identifier: BlueOak-1.0.0 ◊; This file is licensed under the Blue Oak Model License 1.0.0. <html lang="en"> ◊(define article-html (parse-and-cache-article! here doc)) ◊html$-page-head[(current-plain-title)] ◊html$-page-body-open[] ◊article-html ◊html$-page-body-close[] </html> |