mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tvl-depot/fun/elblog/blog.el

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

124 lines
3.9 KiB
EmacsLisp
Raw Permalink Normal View History

feat(blog): Add initial elblog implementation Implements a (very) simple "blogging" software in Emacs Lisp using org-mode and elnode. Once loaded and started, elblog will serve individual blog posts at `localhost:8010/en/$post-name`, where "post-name" can be any string. Elblog will attempt to find a buffer called "$post-name.org" and render it to HTML. An index of blog posts is currently not implemented and everything is completely unthemed, but for a language this old this is ridiculously productive given the amount of code.
2017-11-12 23:48:21 +01:00
;;; blog.el --- A simple org-mode & elnode blog software.
;;; -*- lexical-binding: t; -*-
feat(blog): Register blog articles in hash-table * adds a hash-table stored in a variable called `elblog-articles` that defines a map of article names (used as URI fragments) to file names of org-mode files * adds a custom variable `elblog-article-directory` which must be set to the base path of the org-mode files representing elblog articles * refactors the article-rendering functions to look up articles in the articles hash-table and renders them from there After this change elblog is almost functional as a blog software, only missing index generation.
2017-11-13 18:40:59 +01:00
(require 'dash)
feat(blog): Add initial elblog implementation Implements a (very) simple "blogging" software in Emacs Lisp using org-mode and elnode. Once loaded and started, elblog will serve individual blog posts at `localhost:8010/en/$post-name`, where "post-name" can be any string. Elblog will attempt to find a buffer called "$post-name.org" and render it to HTML. An index of blog posts is currently not implemented and everything is completely unthemed, but for a language this old this is ridiculously productive given the amount of code.
2017-11-12 23:48:21 +01:00
(require 'elnode)
(require 'f)
feat(blog): Register blog articles in hash-table * adds a hash-table stored in a variable called `elblog-articles` that defines a map of article names (used as URI fragments) to file names of org-mode files * adds a custom variable `elblog-article-directory` which must be set to the base path of the org-mode files representing elblog articles * refactors the article-rendering functions to look up articles in the articles hash-table and renders them from there After this change elblog is almost functional as a blog software, only missing index generation.
2017-11-13 18:40:59 +01:00
(require 'ht)
feat(blog): Add initial elblog implementation Implements a (very) simple "blogging" software in Emacs Lisp using org-mode and elnode. Once loaded and started, elblog will serve individual blog posts at `localhost:8010/en/$post-name`, where "post-name" can be any string. Elblog will attempt to find a buffer called "$post-name.org" and render it to HTML. An index of blog posts is currently not implemented and everything is completely unthemed, but for a language this old this is ridiculously productive given the amount of code.
2017-11-12 23:48:21 +01:00
feat(blog): Add customization group for configuring elblog settings Adds a customization group which can currently be used to configure the host and port that elblog should run on.
2017-11-13 00:16:26 +01:00
;; Definition of customization options
(defgroup elblog nil
"Configuration for the Emacs Lisp blog software"
:link '(url-link "https://github.com/tazjin/elblog"))
(defcustom elblog-port 8010
"Port to run elblog's HTTP server on"
:group 'elblog
:type 'integer)
(defcustom elblog-host "localhost"
"Host for elblog's HTTP server to listen on"
:group 'elblog
:type 'string)
feat: Make blog-title configurable in preamble
2017-11-13 16:49:41 +01:00
(defcustom elblog-title "Elblog"
"Title text for this elblog instance"
:group 'elblog
:type 'string)
feat(blog): Register blog articles in hash-table * adds a hash-table stored in a variable called `elblog-articles` that defines a map of article names (used as URI fragments) to file names of org-mode files * adds a custom variable `elblog-article-directory` which must be set to the base path of the org-mode files representing elblog articles * refactors the article-rendering functions to look up articles in the articles hash-table and renders them from there After this change elblog is almost functional as a blog software, only missing index generation.
2017-11-13 18:40:59 +01:00
(defcustom elblog-article-directory nil
"Directory in which elblog articles are stored"
:group 'elblog
:type 'string)
feat(blog): Let users extend/customize elblog routes The default elblog route (/{article-name}) can now be extended with user-supplied routes by overriding the elblog-additional-routes customize variable. This variable takes the same format as the alist supplied to elnode-hostpath-dispatcher. The prefix `/en` has been dropped from the default handler because that only existed to be compatible with my old blog, which is no longer required as it can now be handled with a custom legacy route in my personal blog configuration.
2017-11-13 22:45:30 +01:00
(defcustom elblog-additional-routes '()
"Additional Elnode routes to register in the Elblog instance"
:group 'elblog
:type '(alist :key-type regexp :value-type function))
feat(blog): Register blog articles in hash-table * adds a hash-table stored in a variable called `elblog-articles` that defines a map of article names (used as URI fragments) to file names of org-mode files * adds a custom variable `elblog-article-directory` which must be set to the base path of the org-mode files representing elblog articles * refactors the article-rendering functions to look up articles in the articles hash-table and renders them from there After this change elblog is almost functional as a blog software, only missing index generation.
2017-11-13 18:40:59 +01:00
;; Declare user-configurable variables needed at runtime.
(defvar elblog-articles (ht-create)
"A hash-table of blog articles. This is used for looking up articles from
URL fragments as well as for rendering the index.")
feat: Make blog-title configurable in preamble
2017-11-13 16:49:41 +01:00
;; HTML templating setup
(defun template-preamble ()
"Templates the preamble snippet with the correct blog title."
(format (f-read-text "preamble.html") elblog-title))
feat(blog): Configure org-mode's HTML export to match blog theme This gets elblog close, but not quite there, to my previous blog theme. Comparison screenshot: http://i.imgur.com/UK49Fhi.png
2017-11-13 00:57:20 +01:00
(defun configure-org-html-export ()
refactor: Load preamble from an HTML file, too.
2017-11-13 16:42:29 +01:00
"Configure org-mode settings for elblog's HTML templating to work correctly."
feat(blog): Configure org-mode's HTML export to match blog theme This gets elblog close, but not quite there, to my previous blog theme. Comparison screenshot: http://i.imgur.com/UK49Fhi.png
2017-11-13 00:57:20 +01:00
(setq org-html-postamble t)
(setq org-html-doctype "html5")
(setq org-html-head-include-scripts nil)
(setq org-html-style-default (f-read-text "blog.css"))
feat: Make blog-title configurable in preamble
2017-11-13 16:49:41 +01:00
(setq org-html-preamble-format `(("en" ,(template-preamble))))
feat(blog): Configure org-mode's HTML export to match blog theme This gets elblog close, but not quite there, to my previous blog theme. Comparison screenshot: http://i.imgur.com/UK49Fhi.png
2017-11-13 00:57:20 +01:00
(setq org-html-postamble-format `(("en" ,(f-read-text "postamble.html")))))
feat(blog): Add customization group for configuring elblog settings Adds a customization group which can currently be used to configure the host and port that elblog should run on.
2017-11-13 00:16:26 +01:00
;; Article fetching & rendering functions
feat(blog): Register blog articles in hash-table * adds a hash-table stored in a variable called `elblog-articles` that defines a map of article names (used as URI fragments) to file names of org-mode files * adds a custom variable `elblog-article-directory` which must be set to the base path of the org-mode files representing elblog articles * refactors the article-rendering functions to look up articles in the articles hash-table and renders them from there After this change elblog is almost functional as a blog software, only missing index generation.
2017-11-13 18:40:59 +01:00
(defun render-org-buffer (input-buffer &optional force)
feat(blog): Add initial elblog implementation Implements a (very) simple "blogging" software in Emacs Lisp using org-mode and elnode. Once loaded and started, elblog will serve individual blog posts at `localhost:8010/en/$post-name`, where "post-name" can be any string. Elblog will attempt to find a buffer called "$post-name.org" and render it to HTML. An index of blog posts is currently not implemented and everything is completely unthemed, but for a language this old this is ridiculously productive given the amount of code.
2017-11-12 23:48:21 +01:00
"Renders an org-mode buffer as HTML and returns the name of the output buffer."
feat(blog): Register blog articles in hash-table * adds a hash-table stored in a variable called `elblog-articles` that defines a map of article names (used as URI fragments) to file names of org-mode files * adds a custom variable `elblog-article-directory` which must be set to the base path of the org-mode files representing elblog articles * refactors the article-rendering functions to look up articles in the articles hash-table and renders them from there After this change elblog is almost functional as a blog software, only missing index generation.
2017-11-13 18:40:59 +01:00
(letrec ((output-buffer (concat (buffer-name input-buffer) "-rendered"))
feat(blog): Add initial elblog implementation Implements a (very) simple "blogging" software in Emacs Lisp using org-mode and elnode. Once loaded and started, elblog will serve individual blog posts at `localhost:8010/en/$post-name`, where "post-name" can be any string. Elblog will attempt to find a buffer called "$post-name.org" and render it to HTML. An index of blog posts is currently not implemented and everything is completely unthemed, but for a language this old this is ridiculously productive given the amount of code.
2017-11-12 23:48:21 +01:00
;; Don't re-render articles unless forced.
(must-render (or force
(not (get-buffer output-buffer)))))
(if (and input-buffer must-render)
(with-current-buffer input-buffer
(org-export-to-buffer 'html output-buffer nil nil t)))
(if input-buffer output-buffer nil)))
(defun get-buffer-string (buffer)
"Returns the contents of the specified buffer as a string."
(with-current-buffer (get-buffer buffer)
(buffer-string)))
(defvar-local article-not-found
'(404 . "<html><body><p>Oh no, the article was not found.</p></body></html>"))
(defvar-local text-html '("Content-Type" . "text/html"))
(defun render-article (article)
"Renders an article, if it exists."
feat(blog): Register blog articles in hash-table * adds a hash-table stored in a variable called `elblog-articles` that defines a map of article names (used as URI fragments) to file names of org-mode files * adds a custom variable `elblog-article-directory` which must be set to the base path of the org-mode files representing elblog articles * refactors the article-rendering functions to look up articles in the articles hash-table and renders them from there After this change elblog is almost functional as a blog software, only missing index generation.
2017-11-13 18:40:59 +01:00
(letrec ((rendered (-some->>
(ht-get elblog-articles article)
(concat elblog-article-directory)
(find-file)
(render-org-buffer))))
(if rendered `(200 . ,(get-buffer-string rendered))
feat(blog): Add initial elblog implementation Implements a (very) simple "blogging" software in Emacs Lisp using org-mode and elnode. Once loaded and started, elblog will serve individual blog posts at `localhost:8010/en/$post-name`, where "post-name" can be any string. Elblog will attempt to find a buffer called "$post-name.org" and render it to HTML. An index of blog posts is currently not implemented and everything is completely unthemed, but for a language this old this is ridiculously productive given the amount of code.
2017-11-12 23:48:21 +01:00
article-not-found)))
(defun blog-post-handler (httpcon)
"This handler servers a blog post from the configured blog post directory."
(let ((response (render-article (elnode-http-mapping httpcon 1))))
(elnode-http-start httpcon (car response) text-html)
(elnode-http-return httpcon (cdr response))))
feat(blog): Add customization group for configuring elblog settings Adds a customization group which can currently be used to configure the host and port that elblog should run on.
2017-11-13 00:16:26 +01:00
;; Web server implementation
feat(blog): Let users extend/customize elblog routes The default elblog route (/{article-name}) can now be extended with user-supplied routes by overriding the elblog-additional-routes customize variable. This variable takes the same format as the alist supplied to elnode-hostpath-dispatcher. The prefix `/en` has been dropped from the default handler because that only existed to be compatible with my old blog, which is no longer required as it can now be handled with a custom legacy route in my personal blog configuration.
2017-11-13 22:45:30 +01:00
(defvar elblog-routes
'(("^.*//\\(.*\\)" . blog-post-handler))
"The default routes available in elblog. They can be extended by the user
by setting the elblog-additional-routes customize option.")
feat(blog): Add initial elblog implementation Implements a (very) simple "blogging" software in Emacs Lisp using org-mode and elnode. Once loaded and started, elblog will serve individual blog posts at `localhost:8010/en/$post-name`, where "post-name" can be any string. Elblog will attempt to find a buffer called "$post-name.org" and render it to HTML. An index of blog posts is currently not implemented and everything is completely unthemed, but for a language this old this is ridiculously productive given the amount of code.
2017-11-12 23:48:21 +01:00
(defun elblog-handler (httpcon)
feat(blog): Let users extend/customize elblog routes The default elblog route (/{article-name}) can now be extended with user-supplied routes by overriding the elblog-additional-routes customize variable. This variable takes the same format as the alist supplied to elnode-hostpath-dispatcher. The prefix `/en` has been dropped from the default handler because that only existed to be compatible with my old blog, which is no longer required as it can now be handled with a custom legacy route in my personal blog configuration.
2017-11-13 22:45:30 +01:00
(elnode-hostpath-dispatcher
httpcon
(-concat elblog-additional-routes elblog-routes)))
feat(blog): Add initial elblog implementation Implements a (very) simple "blogging" software in Emacs Lisp using org-mode and elnode. Once loaded and started, elblog will serve individual blog posts at `localhost:8010/en/$post-name`, where "post-name" can be any string. Elblog will attempt to find a buffer called "$post-name.org" and render it to HTML. An index of blog posts is currently not implemented and everything is completely unthemed, but for a language this old this is ridiculously productive given the amount of code.
2017-11-12 23:48:21 +01:00
feat(blog): Add interactive start/stop functions
2017-11-12 23:56:27 +01:00
(defun start-elblog ()
(interactive)
feat(blog): Configure org-mode's HTML export to match blog theme This gets elblog close, but not quite there, to my previous blog theme. Comparison screenshot: http://i.imgur.com/UK49Fhi.png
2017-11-13 00:57:20 +01:00
(configure-org-html-export)
feat(blog): Add interactive start/stop functions
2017-11-12 23:56:27 +01:00
(elnode-start 'elblog-handler
feat(blog): Add customization group for configuring elblog settings Adds a customization group which can currently be used to configure the host and port that elblog should run on.
2017-11-13 00:16:26 +01:00
:port elblog-port
:host elblog-host))
feat(blog): Add interactive start/stop functions
2017-11-12 23:56:27 +01:00
(defun stop-elblog ()
(interactive)
feat(blog): Add customization group for configuring elblog settings Adds a customization group which can currently be used to configure the host and port that elblog should run on.
2017-11-13 00:16:26 +01:00
(elnode-stop elblog-port))
refactor: Load preamble from an HTML file, too.
2017-11-13 16:42:29 +01:00
(provide 'elblog)
Reference in a new issue Copy permalink