summaryrefslogtreecommitdiff
path: root/ennu.el
blob: 04017ba71868179794e04f322e94dcc751d9b3c7 (plain)
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
199
200
201
202
203
204
205
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
;; -*- lexical-binding: t -*-

(require 'ennu-html)
(require 'ennu-image)
(require 'ox)
(require 'seq)
(require 'cl)
(require 'map)
(require 'memoize)
(require 'simple-httpd)

(defvar ennu-version "0.1.0"
  "Ennu version string")

(cl-defstruct (ennu-post (:constructor ennu-make-post)
                         (:copier nil))
  filename author date language links
  summary tags thumbnail title translation-group)

(defun ennu-posts (posts-directory)
  (sort (seq-map 'ennu-read-post
                 (file-expand-wildcards
                  (concat (file-name-as-directory
                           (ennu-setting :posts-directory))
                          "*.org")))
        'ennu-later-post-p))

(defun ennu-later-post-p (post1 post2)
  (time-less-p (ennu-post-date post2)
               (ennu-post-date post1)))

(defun ennu-read-post (filename)
  (ennu--read-post
   filename (file-attribute-modification-time
             (file-attributes filename))))

(defmemoize ennu--read-post (filename last-modified)
  (ennu-with-file-contents filename
    (let ((metadata (org-export-get-environment 'ennu-html))
          (export (apply-partially 'org-export-with-backend 'ennu-html)))
      (seq-do (lambda (key)
                (unless (plist-member metadata key)
                  (user-error "Metadata %s not specified" key)))
              ennu-mandatory-metadata)
      (let ((links (org-element-map (org-element-parse-buffer) 'link
                     (lambda (link)
                       (pcase link
                         (`(link ,properties . ,_)
                          (let ((link-type (org-element-property :type link)))
                            (when (member link-type (list "image" "static" "video"))
                              (cons link-type (org-element-property :path link))))))))))
        (ennu-make-post
         :filename filename
         :author (funcall export (first (plist-get metadata :author)))
         :date (org-timestamp-to-time (first (plist-get metadata :date)))
         :language (plist-get metadata :language)
         :links links
         :summary (funcall export (first (plist-get metadata :summary)))
         :tags (plist-get metadata :filetags)
         :thumbnail (or (plist-get metadata :thumbnail)
                        (seq-some (lambda (link)
                                    (pcase link
                                      (`("image" . ,path) path)
                                      (`("video" . ,path) (ennu-video-poster path))))
                                  links))
         :title (funcall export (first (plist-get metadata :title)))
         :translation-group (or (plist-get metadata :translation-group)
                                (file-name-base filename)))))))

(defvar ennu-mandatory-metadata
  (list :title :date))

(defmacro ennu-with-file-contents (file &rest body)
  "Create a temporary buffer, insert contents of FILE into that
buffer and evaluate BODY. The value returned is the value of the
last form in BODY."
  (declare (indent defun))
  `(with-temp-buffer
     (insert-file-contents ,file)
     ,@body))

(defun ennu--org-output-filename (filename)
  (concat (file-name-sans-extension filename) ".html"))

(defun ennu-publish-post (post)
  ;; TODO: Tangle post
  `((,(ennu-post-filename post))
    (,(ennu--org-output-filename (ennu-post-filename post)))
    ,(lambda (output-file)
       (ennu-with-file-contents (ennu-post-filename post)
         (org-export-to-file 'ennu-html output-file))
       ;; (when-let (tangle-dir (or (plist-get posts-plist :valai-tangle-directory)
       ;;                           valai-tangle-directory))
       ;;   (dolist (tangled-file
       ;;            (org-babel-tangle-file post-path))
       ;;     (when (member (file-name-extension tangled-file) '("sh" "py"))
       ;;       (chmod tangled-file (string-to-number "755" 8)))
       ;;     (make-directory tangle-dir t)
       ;;     (rename-file tangled-file
       ;;                  (expand-file-name (file-name-nondirectory tangled-file)
       ;;                                    tangle-dir)
       ;;                  t)))
       )))

(defun ennu-publish-page (pages-directory page)
  `((,page)
    (,(ennu--org-output-filename
       (string-remove-prefix
        (file-name-as-directory pages-directory)
        page)))
    ,(lambda (output-file)
       (ennu-with-file-contents page
         (org-export-to-file 'html output-file)))))

(defun ennu-video-poster (video)
  (pcase (directory-files (ennu-setting :images-directory) nil
                          (concat (file-name-sans-extension video)
                                  "\\.\\(jpg\\|png\\)$"))
    (`(,poster . ,_) poster)
    (`() (user-error "Poster for %s not found" video))))

(defun ennu-add-tongue-suffix (filename tongue)
  (pcase tongue
    ("en" filename)
    (_ (format "%s.%s.%s"
               (file-name-sans-extension filename)
               tongue
               (file-name-extension filename)))))

(defun ennu-index-filename (filename-prefix tongue &optional extension page-number)
  (let ((extension (if extension (concat "." extension) "")))
    (ennu-add-tongue-suffix
     (if page-number
         (format "%s-%s%s" filename-prefix page-number extension)
       (concat filename-prefix extension))
     tongue)))

(defun ennu-publish-index (filename-prefix tongue title posts-per-page posts)
  (let* ((number-of-pages (ceiling (length posts) posts-per-page))
         (page-numbers (number-sequence 1 number-of-pages)))
    `(,(seq-map 'ennu-post-filename posts)
      ,(cons (ennu-add-tongue-suffix (format "%s.html" filename-prefix) tongue)
             (seq-map (apply-partially 'ennu-index-filename filename-prefix tongue "html")
                      page-numbers))
      ,(lambda (home-page &rest output-files)
         (seq-mapn
          (lambda (posts page-number output-file)
            (with-temp-buffer
              (insert (format "#+TITLE: %s\n" title))
              (insert (format "#+LANGUAGE: %s\n" tongue))
              (insert "#+OPTIONS: num:nil toc:nil\n\n")
              (seq-do (lambda (post)
                        (insert (format "* [[post:%s]]\n" (file-name-base (ennu-post-filename post))))
                        (insert (format-time-string
                                 "/%b %e, %Y/\n\n"
                                 (ennu-post-date post)))
                        (when-let ((thumbnail (ennu-post-thumbnail post)))
                          (insert (format "[[thumbnail:%s]]\n\n" thumbnail)))
                        (when-let ((summary (ennu-post-summary post)))
                          (insert summary)
                          (insert "\n\n"))
                        (when-let ((tags (ennu-post-tags post)))
                          (insert "Tags: ")
                          (insert
                           (string-join (seq-map (apply-partially 'format "[[tag:%s]]")
                                                 tags)
                                        ", "))
                          (insert "\n\n")))
                      posts)
              (unless (= page-number 1)
                (insert (format "[[./%s][Newer posts]]\n"
                                (ennu-index-filename (file-name-nondirectory filename-prefix)
                                                     tongue nil (1- page-number)))))
              (unless (= page-number number-of-pages)
                (insert (format "[[./%s][Older posts]]\n"
                                (ennu-index-filename (file-name-nondirectory filename-prefix)
                                                     tongue nil (1+ page-number)))))
              (org-export-to-file 'ennu-html output-file)))
          (seq-partition posts posts-per-page)
          page-numbers
          output-files)
         (copy-file (first output-files) home-page)))))

(defun ennu--absolute-uri (path)
  (format "%s://%s/%s"
          (ennu-setting :blog-scheme)
          (ennu-setting :blog-domain)
          path))

(defun ennu--atom-date (date)
  (format-time-string "%Y-%m-%dT%H:%M:%SZ" date))

(defun ennu-publish-feed (feed-file title rights posts)
  `(,(seq-map 'ennu-post-filename posts)
    (,feed-file)
    ,(lambda (output-file)
       (with-temp-file output-file
         (insert
          (xmlgen
           `(feed :xmlns "http://www.w3.org/2005/Atom"
                  (id ,(ennu--absolute-uri ""))
                  (title ,title)
                  (updated ,(ennu--atom-date (ennu-post-date (first posts))))
                  (link :rel "self" :href ,(ennu--absolute-uri feed-file))
                  (generator
                   ,(format "Emacs %d.%d Org-mode %s ennu %s"
                            emacs-major-version emacs-minor-version (org-version) ennu-version))
                  (rights ,rights)
                  ,@(seq-map 'ennu--feed-entry posts))))))))

(defun ennu--feed-entry (post)
  (let ((link (ennu--absolute-uri (ennu--org-output-filename
                                   (ennu-post-filename post)))))
    `(entry (id ,link)
            (title :xml:lang ,(ennu-post-language post) ,(ennu-post-title post))
            (updated ,(ennu--atom-date (ennu-post-date post)))
            (author
             (name ,(ennu-post-author post))
             (email ,user-mail-address))
            (content :type "html" :xml:lang ,(ennu-post-language post)
                     ,(ennu-with-file-contents (ennu-post-filename post)
                        (org-export-as 'ennu-html nil nil t)))
            (link :rel "alternate" :href ,link)
            ,@(seq-map (lambda (tag) `(category :term ,tag))
                       (ennu-post-tags post)))))

(defun ennu-setting (property)
  (pcase property
    (:blog-scheme
     (or (plist-get ennu-blog :blog-scheme)
         "https"))
    (:atom-feed-file
     (or (plist-get ennu-blog :atom-feed-file)
         "blog.atom"))
    (:index-posts-per-page
     (or (plist-get ennu-blog :index-posts-per-page)
         12))
    (:atom-feed-number-of-posts
     (or (plist-get ennu-blog :atom-feed-number-of-posts)
         12))
    (:thumbnail-image-width
     (or (plist-get ennu-blog :thumbnail-image-width)
         320))
    (:default-image-width
     (or (plist-get ennu-blog :default-image-width)
         640))
    (:image-link-width
     (or (plist-get ennu-blog :image-link-width)
         1024))
    (:tag-directory
     (or (plist-get ennu-blog :tag-directory)
         "tag"))
    ((or :blog-domain :blog-license :blog-title
         :images-directory :output-directory :posts-directory
         :static-directory :tag-directory :video-directory
         :working-directory)
     (or (plist-get ennu-blog property)
         (user-error "Property %s not defined" property)))
    ((or :pages-directory :unattached-static-files)
     (plist-get ennu-blog property))
    (_ (error "Unknown property %s" property))))

(defun ennu-image-output-filename (image width)
  (format "%s-%spx.%s"
          (file-name-sans-extension image)
          width (file-name-extension image)))

(defun ennu--expand-relative (name directory)
  (concat (file-name-as-directory directory) name))

(defun ennu-publish-image (widths image)
  `((,image)
    ,(seq-map (apply-partially 'ennu-image-output-filename image)
              widths)
    ,(lambda (&rest output-files)
       (seq-mapn (lambda (output-file width)
                   (ennu-image-optimize-image
                    (ennu-image-resize-image image output-file width)))
                 output-files widths))))

(defun ennu-publish-copy (file)
  `((,file) (,file) ,(apply-partially 'copy-file file)))

(defun newest-file (files)
  (pcase files
    (`(,head . ,tail)
     (seq-reduce (lambda (file1 file2)
                   (if (file-newer-than-file-p file1 file2)
                       file1 file2))
                 tail head))))

(defun ennu-mkdir-p (directory)
  (make-directory directory t))

(defun ennu-copy (source destination)
  "Copy file or directory from SOURCE to DESTINATION."
  (if (file-directory-p source)
      (copy-directory source destination)
    (make-directory (file-name-directory destination) t)
    (copy-file source destination)))

(defun ennu--do-operation (temporary-directory operation)
  (let ((expand (lambda (directory file)
                  (expand-file-name file directory))))
    (pcase operation
      (`(,input-files ,output-files ,publish)
       (let ((absolute-output-files
              (seq-map (apply-partially expand temporary-directory)
                       output-files))
             (previous-output-files
              (seq-map (apply-partially expand (ennu-setting :output-directory))
                       output-files)))
         (cond
          ((and (seq-every-p 'file-exists-p previous-output-files)
                (file-newer-than-file-p (newest-file previous-output-files)
                                        (newest-file input-files)))
           (message "Skipping publishing %s to %s" input-files output-files)
           (seq-mapn 'ennu-copy previous-output-files absolute-output-files))
          (t (message "Publishing %s to %s" input-files output-files)
             (seq-do 'ennu-mkdir-p
                     (seq-uniq
                      (seq-map 'file-name-directory absolute-output-files)))
             (apply publish absolute-output-files))))))))

(defun ennu-publish-static-file (file)
  `((,file) (,file) ,(apply-partially 'copy-file file)))

(defun ennu-publish-link (link)
  (pcase link
    (`("image" . ,path)
     (ennu-publish-image
      (list (ennu-setting :default-image-width)
            (ennu-setting :image-link-width))
      (ennu--expand-relative path (ennu-setting :images-directory))))
    (`("static" . ,path)
     (ennu-publish-copy (ennu--expand-relative path (ennu-setting :static-directory))))
    (`("video" . ,path)
     (ennu-publish-copy (ennu--expand-relative path (ennu-setting :video-directory)))
     (ennu-publish-copy (ennu--expand-relative (ennu-video-poster path)
                                               (ennu-setting :images-directory))))))

(defmacro ennu-with-current-directory (directory &rest body)
  "Change to DIRECTORY, evaluate BODY and restore the current
working directory. The value returned is the value of the last
form in BODY."
  (declare (indent defun))
  (let ((current-directory-symbol (make-symbol "current-directory")))
    `(let ((,current-directory-symbol default-directory))
       (unwind-protect (progn (cd ,directory) ,@body)
         (cd ,current-directory-symbol)))))

(defmacro ennu-with-temporary-directory (temporary-directory &rest body)
  "Create temporary directory, evaluate BODY with the absolute
path of that directory assigned to TEMPORARY-DIRECTORY and
finally delete the temporary directory. The value returned is the
value of the last form in BODY."
  (declare (indent defun))
  `(let ((,temporary-directory (make-temp-file "ennu" t)))
     (unwind-protect
         (progn ,@body)
       (delete-directory ,temporary-directory t))))

(defun ennu-many-to-many-group-by (function sequence)
  "Apply FUNCTION to each element of SEQUENCE.
Separate the elements of SEQUENCE into an alist using the results
as keys. Keys are compared using `equal'."
  (seq-reduce
   (lambda (result element)
     (seq-do
      (lambda (key)
        (map-put result key
                 (cons element (map-elt result key nil 'equal))
                 'equal))
      (funcall function element))
     result)
   (seq-reverse sequence)
   nil))

(defun ennu-publish ()
  (interactive)
  (let ((make-backup-files nil)
        (blog-title (ennu-setting :blog-title))
        (posts-per-page (ennu-setting :index-posts-per-page)))
    (ennu-with-current-directory (ennu-setting :working-directory)
      (ennu-with-temporary-directory temporary-directory
        (seq-do
         (apply-partially 'ennu--do-operation temporary-directory)
         (append
          (let ((posts (ennu-posts (ennu-setting :posts-directory))))
            (append
             ;; Publish posts
             (seq-map 'ennu-publish-post posts)
             ;; Publish feed
             (list (ennu-publish-feed (ennu-setting :atom-feed-file)
                                      blog-title
                                      (ennu-setting :blog-license)
                                      (seq-take posts (ennu-setting :atom-feed-number-of-posts))))
             ;; Publish indices
             (seq-map
              (pcase-lambda (`(,tongue . ,posts))
                (ennu-publish-index "index" tongue blog-title posts-per-page posts))
              (seq-group-by 'ennu-post-language posts))
             (seq-mapcat
              (pcase-lambda (`(,tag . ,posts))
                (seq-map
                 (pcase-lambda (`(,tongue . ,posts))
                   (ennu-publish-index
                    (ennu--expand-relative tag (ennu-setting :tag-directory))
                    tongue tag posts-per-page posts))
                 (seq-group-by 'ennu-post-language posts)))
              (ennu-many-to-many-group-by 'ennu-post-tags posts))
             ;; Publish links
             (seq-map 'ennu-publish-link
                      (seq-uniq (seq-mapcat 'ennu-post-links posts)))
             ;; Publish thumbnails
             (seq-map
              (apply-partially 'ennu-publish-image (list (ennu-setting :thumbnail-image-width)))
              (seq-map (lambda (image)
                         (ennu--expand-relative image (ennu-setting :images-directory)))
                       (seq-uniq (seq-filter 'identity (seq-map 'ennu-post-thumbnail posts)))))))
          ;; Publish pages
          (when-let ((pages-directory (ennu-setting :pages-directory)))
            (seq-map (apply-partially 'ennu-publish-page pages-directory)
                     (seq-map (apply-partially 'string-remove-prefix
                                               (file-name-as-directory (expand-file-name default-directory)))
                              (directory-files-recursively pages-directory "\\.org$"))))
          ;; Publish unattached static files
          (seq-map 'ennu-publish-static-file
                   (ennu-setting :unattached-static-files))))
        ;; Replace old output directory
        (let ((output (ennu-setting :output-directory)))
          (delete-directory output t)
          (rename-file temporary-directory output t))))))

;;; Server
;;;
;;; Test HTTP server to serve the blog locally

(defun ennu-serve ()
  (interactive)
  (setq httpd-root (expand-file-name (ennu-setting :output-directory)
                                     (ennu-setting :working-directory)))
  (defun httpd/ (proc uri-path query request)
    (pcase (httpd-status (httpd-gen-path uri-path))
      (200 (httpd-serve-root proc httpd-root uri-path request))
      (_ (httpd-serve-root proc httpd-root (concat uri-path ".html") request))))
  (httpd-start))

(provide 'ennu)