add new markdown packages to org profile ahead of activating them for code blocks
This commit is contained in:
parent
b188b6d2dd
commit
37ae00042f
|
|
@ -0,0 +1,64 @@
|
|||
;;; markdown-mode-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
|
||||
;;
|
||||
;;; Code:
|
||||
|
||||
(add-to-list 'load-path (directory-file-name
|
||||
(or (file-name-directory #$) (car load-path))))
|
||||
|
||||
|
||||
;;;### (autoloads nil "markdown-mode" "markdown-mode.el" (0 0 0 0))
|
||||
;;; Generated autoloads from markdown-mode.el
|
||||
|
||||
(autoload 'markdown-mode "markdown-mode" "\
|
||||
Major mode for editing Markdown files.
|
||||
|
||||
\(fn)" t nil)
|
||||
|
||||
(add-to-list 'auto-mode-alist '("\\.\\(?:md\\|markdown\\|mkd\\|mdown\\|mkdn\\|mdwn\\)\\'" . markdown-mode))
|
||||
|
||||
(autoload 'gfm-mode "markdown-mode" "\
|
||||
Major mode for editing GitHub Flavored Markdown files.
|
||||
|
||||
\(fn)" t nil)
|
||||
|
||||
(autoload 'markdown-view-mode "markdown-mode" "\
|
||||
Major mode for viewing Markdown content.
|
||||
|
||||
\(fn)" t nil)
|
||||
|
||||
(autoload 'gfm-view-mode "markdown-mode" "\
|
||||
Major mode for viewing GitHub Flavored Markdown content.
|
||||
|
||||
\(fn)" t nil)
|
||||
|
||||
(autoload 'markdown-live-preview-mode "markdown-mode" "\
|
||||
Toggle native previewing on save for a specific markdown file.
|
||||
|
||||
This is a minor mode. If called interactively, toggle the
|
||||
`Markdown-Live-Preview mode' mode. If the prefix argument is
|
||||
positive, enable the mode, and if it is zero or negative, disable
|
||||
the mode.
|
||||
|
||||
If called from Lisp, toggle the mode if ARG is `toggle'. Enable
|
||||
the mode if ARG is nil, omitted, or is a positive number.
|
||||
Disable the mode if ARG is a negative number.
|
||||
|
||||
To check whether the minor mode is enabled in the current buffer,
|
||||
evaluate `markdown-live-preview-mode'.
|
||||
|
||||
The mode's hook is called both when the mode is enabled and when
|
||||
it is disabled.
|
||||
|
||||
\(fn &optional ARG)" t nil)
|
||||
|
||||
(register-definition-prefixes "markdown-mode" '("defun-markdown-" "gfm-" "markdown"))
|
||||
|
||||
;;;***
|
||||
|
||||
;; Local Variables:
|
||||
;; version-control: never
|
||||
;; no-byte-compile: t
|
||||
;; no-update-autoloads: t
|
||||
;; coding: utf-8
|
||||
;; End:
|
||||
;;; markdown-mode-autoloads.el ends here
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
;;; Generated package description from markdown-mode.el -*- no-byte-compile: t -*-
|
||||
(define-package "markdown-mode" "20220829.225" "Major mode for Markdown-formatted text" '((emacs "26.1")) :commit "3f1c61b25cb0677122414e9ea14064a13e548c36" :authors '(("Jason R. Blevins" . "jblevins@xbeta.org")) :maintainer '("Jason R. Blevins" . "jblevins@xbeta.org") :keywords '("markdown" "github flavored markdown" "itex") :url "https://jblevins.org/projects/markdown-mode/")
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
|
|
@ -0,0 +1,54 @@
|
|||
;;; markdown-preview-mode-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
|
||||
;;
|
||||
;;; Code:
|
||||
|
||||
(add-to-list 'load-path (directory-file-name
|
||||
(or (file-name-directory #$) (car load-path))))
|
||||
|
||||
|
||||
;;;### (autoloads nil "markdown-preview-mode" "markdown-preview-mode.el"
|
||||
;;;;;; (0 0 0 0))
|
||||
;;; Generated autoloads from markdown-preview-mode.el
|
||||
|
||||
(autoload 'markdown-preview-open-browser "markdown-preview-mode" "\
|
||||
Open the `markdown-preview' in the browser." t nil)
|
||||
|
||||
(autoload 'markdown-preview-cleanup "markdown-preview-mode" "\
|
||||
Cleanup `markdown-preview' mode." t nil)
|
||||
|
||||
(autoload 'markdown-preview-mode "markdown-preview-mode" "\
|
||||
Markdown preview mode.
|
||||
|
||||
This is a minor mode. If called interactively, toggle the
|
||||
`Markdown-Preview mode' mode. If the prefix argument is
|
||||
positive, enable the mode, and if it is zero or negative, disable
|
||||
the mode.
|
||||
|
||||
If called from Lisp, toggle the mode if ARG is `toggle'. Enable
|
||||
the mode if ARG is nil, omitted, or is a positive number.
|
||||
Disable the mode if ARG is a negative number.
|
||||
|
||||
To check whether the minor mode is enabled in the current buffer,
|
||||
evaluate `markdown-preview-mode'.
|
||||
|
||||
The mode's hook is called both when the mode is enabled and when
|
||||
it is disabled.
|
||||
|
||||
\(fn &optional ARG)" t nil)
|
||||
|
||||
(register-definition-prefixes "markdown-preview-mode" '("markdown-preview-"))
|
||||
|
||||
;;;***
|
||||
|
||||
;;;### (autoloads nil nil ("markdown-preview-mode-pkg.el") (0 0 0
|
||||
;;;;;; 0))
|
||||
|
||||
;;;***
|
||||
|
||||
;; Local Variables:
|
||||
;; version-control: never
|
||||
;; no-byte-compile: t
|
||||
;; no-update-autoloads: t
|
||||
;; coding: utf-8
|
||||
;; End:
|
||||
;;; markdown-preview-mode-autoloads.el ends here
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
(define-package "markdown-preview-mode" "20210516.936" "markdown realtime preview minor mode."
|
||||
'((emacs "24.4")
|
||||
(websocket "1.6")
|
||||
(markdown-mode "2.0")
|
||||
(cl-lib "0.5")
|
||||
(web-server "0.1.1"))
|
||||
:commit "dde87b96de9e81dd01d174da67ef68687b3a5eb5" :authors
|
||||
'(("Igor Shymko" . "igor.shimko@gmail.com"))
|
||||
:maintainer
|
||||
'("Igor Shymko" . "igor.shimko@gmail.com")
|
||||
:keywords
|
||||
'("markdown" "gfm" "convenience")
|
||||
:url "https://github.com/ancane/markdown-preview-mode")
|
||||
;; Local Variables:
|
||||
;; no-byte-compile: t
|
||||
;; End:
|
||||
|
|
@ -0,0 +1,418 @@
|
|||
;;; markdown-preview-mode.el --- markdown realtime preview minor mode.
|
||||
|
||||
;; Copyright (C) 2014 <igor.shimko@gmail.com>
|
||||
|
||||
;; Author: Igor Shymko <igor.shimko@gmail.com>
|
||||
;; URL: https://github.com/ancane/markdown-preview-mode
|
||||
;; Keywords: markdown, gfm, convenience
|
||||
;; Version: 0.9.4
|
||||
;; Package-Requires: ((emacs "24.4") (websocket "1.6") (markdown-mode "2.0") (cl-lib "0.5") (web-server "0.1.1") )
|
||||
|
||||
;; This file is not part of GNU Emacs.
|
||||
|
||||
;; 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 3, 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Commentary:
|
||||
;;
|
||||
;; This package makes use of websockets to deliver rendered markdown to a web browser.
|
||||
;; Updates happen upon buffer save or on idle.
|
||||
;;
|
||||
;;; Code:
|
||||
|
||||
(eval-when-compile (require 'cl))
|
||||
(require 'cl-lib)
|
||||
(require 'websocket)
|
||||
(require 'markdown-mode)
|
||||
(require 'web-server)
|
||||
|
||||
(defgroup markdown-preview nil
|
||||
"Markdown preview mode."
|
||||
:group 'text
|
||||
:prefix "markdown-preview-"
|
||||
:link '(url-link "https://github.com/ancane/markdown-preview-mode"))
|
||||
|
||||
(defcustom markdown-preview-host "localhost"
|
||||
"Markdown preview websocket server address."
|
||||
:group 'markdown-preview
|
||||
:type 'string)
|
||||
|
||||
(defcustom markdown-preview-ws-port 7379
|
||||
"Markdown preview websocket server port."
|
||||
:group 'markdown-preview
|
||||
:type 'integer)
|
||||
|
||||
(defcustom markdown-preview-http-host "localhost"
|
||||
"Markdown preview http server address."
|
||||
:group 'markdown-preview
|
||||
:type 'string)
|
||||
|
||||
(defcustom markdown-preview-http-port 9000
|
||||
"Markdown preview http server port."
|
||||
:group 'markdown-preview
|
||||
:type 'integer)
|
||||
|
||||
(defcustom markdown-preview-style nil
|
||||
"Deprecated. Use `markdown-preview-stylesheets'."
|
||||
:group 'markdown-preview
|
||||
:type 'string)
|
||||
|
||||
(defcustom markdown-preview-file-name ".markdown-preview.html"
|
||||
"Markdown preview file name."
|
||||
:group 'markdown-preview
|
||||
:type 'string)
|
||||
|
||||
(defcustom markdown-preview-auto-open 'http
|
||||
"Markdown preview websocket server address."
|
||||
:group 'markdown-preview
|
||||
:type '(choice (const :tag "As local file" file)
|
||||
(const :tag "Via http" http)
|
||||
(const :tag "Off" nil)))
|
||||
|
||||
(defcustom markdown-preview-delay-time 2.0
|
||||
"Refresh preview after this certain of time."
|
||||
:group 'markdown-preview
|
||||
:type 'float)
|
||||
|
||||
(defvar markdown-preview-javascript '()
|
||||
"List of client javascript libs for preview.")
|
||||
|
||||
(defvar markdown-preview-stylesheets
|
||||
(list "https://thomasf.github.io/solarized-css/solarized-dark.min.css")
|
||||
"List of client stylesheets for preview.")
|
||||
|
||||
(defvar markdown-preview--websocket-server nil
|
||||
"`markdown-preview' Websocket server.")
|
||||
|
||||
(defvar markdown-preview--http-server nil
|
||||
"`markdown-preview' http server.")
|
||||
|
||||
(defvar markdown-preview--local-client nil
|
||||
"`markdown-preview' local client.")
|
||||
|
||||
(defvar markdown-preview--remote-clients (make-hash-table :test 'equal)
|
||||
"Remote clients hashtable. UUID -> WS.")
|
||||
|
||||
(defvar markdown-preview--home-dir (file-name-directory load-file-name)
|
||||
"`markdown-preview-mode' home directory.")
|
||||
|
||||
(defvar markdown-preview--preview-template
|
||||
(expand-file-name "preview.html" markdown-preview--home-dir)
|
||||
"`markdown-preview-mode' html preview template.")
|
||||
|
||||
(defvar markdown-preview--idle-timer nil
|
||||
"Preview idle timer.")
|
||||
|
||||
(defvar markdown-preview--uuid nil
|
||||
"Unique preview identifier.")
|
||||
|
||||
(defvar markdown-preview--preview-buffers (make-hash-table :test 'equal)
|
||||
"Preview buffers hashtable. UUID -> buffer name.")
|
||||
|
||||
(defun markdown-preview--stop-idle-timer ()
|
||||
"Stop the `markdown-preview' idle timer."
|
||||
(when (timerp markdown-preview--idle-timer)
|
||||
(cancel-timer markdown-preview--idle-timer)))
|
||||
|
||||
(defun markdown-preview--css ()
|
||||
"Get list of styles for preview in backward compatible way."
|
||||
(let* ((custom-style (list markdown-preview-style))
|
||||
(all-styles
|
||||
(mapc (lambda (x) (add-to-list 'custom-style x t)) markdown-preview-stylesheets)))
|
||||
(mapconcat
|
||||
(lambda (x)
|
||||
(if (string-match-p "^[\n\t ]*<style" x)
|
||||
x
|
||||
(concat "<link rel=\"stylesheet\" type=\"text/css\" href=\"" x "\">")))
|
||||
all-styles
|
||||
"\n")))
|
||||
|
||||
(defun markdown-preview--scripts ()
|
||||
"Get list of javascript script tags for preview."
|
||||
(mapconcat
|
||||
(lambda (x)
|
||||
(if (string-match-p "^[\n\t ]*<script" x)
|
||||
x
|
||||
(concat
|
||||
"<script src=\"" (if (consp x) (car x) x) "\""
|
||||
(if (consp x) (format " %s" (cdr x)))
|
||||
"></script>")))
|
||||
markdown-preview-javascript
|
||||
"\n"))
|
||||
|
||||
(defun markdown-preview--read-preview-template (preview-uuid preview-file)
|
||||
"Read preview template and writes identified by PREVIEW-UUID rendered copy to PREVIEW-FILE, ready to be open in browser."
|
||||
(with-temp-file preview-file
|
||||
(insert-file-contents markdown-preview--preview-template)
|
||||
(when (search-forward "${MD_STYLE}" nil t)
|
||||
(replace-match (markdown-preview--css) t))
|
||||
(when (search-forward "${MD_JS}" nil t)
|
||||
(replace-match (markdown-preview--scripts) t))
|
||||
(when (search-forward "${WS_HOST}" nil t)
|
||||
(replace-match markdown-preview-host t))
|
||||
(when (search-forward "${WS_PORT}" nil t)
|
||||
(replace-match (format "%s" markdown-preview-ws-port) t))
|
||||
(when (search-forward "${MD_UUID}" nil t)
|
||||
(replace-match (format "%s" preview-uuid) t))
|
||||
(buffer-string)))
|
||||
|
||||
;; Emacs 26 async network workaround
|
||||
(defun markdown-preview--fix-network-process-wait (plist)
|
||||
"Ensure PLIST contain :nowait nil."
|
||||
(if (and (>= emacs-major-version 26)
|
||||
(equal (plist-get plist :name) "ws-server")
|
||||
(plist-get plist :server)
|
||||
(plist-get plist :nowait))
|
||||
(plist-put plist :nowait nil)
|
||||
plist))
|
||||
|
||||
(defun markdown-preview--start-http-server (port)
|
||||
"Start http server at PORT to serve preview file via http."
|
||||
(unless markdown-preview--http-server
|
||||
(lexical-let ((docroot default-directory))
|
||||
(advice-add 'make-network-process :filter-args #'markdown-preview--fix-network-process-wait)
|
||||
(setq markdown-preview--http-server
|
||||
(ws-start
|
||||
(lambda (request)
|
||||
(with-slots (process headers) request
|
||||
(let* ((path (substring (cdr (assoc :GET headers)) 1))
|
||||
(filename (expand-file-name path docroot)))
|
||||
(if (string= path "")
|
||||
(progn
|
||||
(ws-send-file
|
||||
process
|
||||
(expand-file-name
|
||||
markdown-preview-file-name
|
||||
(with-current-buffer
|
||||
(gethash (markdown-preview--parse-uuid headers)
|
||||
markdown-preview--preview-buffers)
|
||||
default-directory
|
||||
))))
|
||||
(if (string= path "favicon.ico")
|
||||
(ws-send-file process (expand-file-name path markdown-preview--home-dir))
|
||||
(if (and (not (file-directory-p filename)) (file-exists-p filename))
|
||||
(ws-send-file process filename)
|
||||
(ws-send-404 process)
|
||||
))))))
|
||||
markdown-preview-http-port nil :host markdown-preview-http-host))
|
||||
(advice-remove 'make-network-process #'markdown-preview--fix-network-process-wait))))
|
||||
|
||||
(defun markdown-preview--parse-uuid (headers)
|
||||
"Find uuid query param in HEADERS."
|
||||
(let ((found (cl-find-if (lambda (x)
|
||||
(when (stringp (car x))
|
||||
(equal "uuid" (format "%s" (car x)))))
|
||||
headers)))
|
||||
(when found (cdr found))))
|
||||
|
||||
|
||||
(defun markdown-preview--open-browser-preview ()
|
||||
"Open the markdown preview in the browser."
|
||||
(when (eq markdown-preview-auto-open 'file)
|
||||
(browse-url (expand-file-name markdown-preview-file-name default-directory)))
|
||||
(when (eq markdown-preview-auto-open 'http)
|
||||
(browse-url
|
||||
(format "http://localhost:%d/?uuid=%s" markdown-preview-http-port markdown-preview--uuid)))
|
||||
(unless markdown-preview-auto-open
|
||||
(message
|
||||
(format
|
||||
"Preview address: http://0.0.0.0:%d/?uuid=%s"
|
||||
markdown-preview-http-port
|
||||
markdown-preview--uuid))))
|
||||
|
||||
(defun markdown-preview--stop-websocket-server ()
|
||||
"Stop the `markdown-preview' websocket server."
|
||||
(clrhash markdown-preview--preview-buffers)
|
||||
(when markdown-preview--local-client
|
||||
(websocket-close markdown-preview--local-client))
|
||||
(when markdown-preview--websocket-server
|
||||
(delete-process markdown-preview--websocket-server)
|
||||
(setq markdown-preview--websocket-server nil)
|
||||
(clrhash markdown-preview--remote-clients)))
|
||||
|
||||
(defun markdown-preview--stop-http-server ()
|
||||
"Stop the `markdown-preview' http server."
|
||||
(when markdown-preview--http-server
|
||||
(ws-stop markdown-preview--http-server)
|
||||
(setq markdown-preview--http-server nil)))
|
||||
|
||||
(defun markdown-preview--drop-closed-clients ()
|
||||
"Clean closed clients in `markdown-preview--remote-clients' list."
|
||||
(maphash (lambda (ws-uuid websocket)
|
||||
(unless (websocket-openp websocket))
|
||||
(remhash ws-uuid markdown-preview--remote-clients))
|
||||
markdown-preview--remote-clients))
|
||||
|
||||
(defun markdown-preview--start-websocket-server ()
|
||||
"Start `markdown-preview' websocket server."
|
||||
(when (not markdown-preview--websocket-server)
|
||||
(setq markdown-preview--websocket-server
|
||||
(websocket-server
|
||||
markdown-preview-ws-port
|
||||
:host markdown-preview-host
|
||||
:on-message (lambda (websocket frame)
|
||||
(let ((ws-frame-text (websocket-frame-payload frame)))
|
||||
(if (and
|
||||
(stringp ws-frame-text)
|
||||
(string-prefix-p "MDPM-Register-UUID: " ws-frame-text))
|
||||
(let ((ws-uuid (substring ws-frame-text 20)))
|
||||
(puthash ws-uuid websocket markdown-preview--remote-clients)
|
||||
(markdown-preview--send-preview-to websocket ws-uuid))
|
||||
(progn
|
||||
(websocket-send
|
||||
(gethash markdown-preview--uuid markdown-preview--remote-clients)
|
||||
frame))
|
||||
)))
|
||||
:on-open (lambda (websocket) (message "Websocket opened"))
|
||||
:on-error (lambda (websocket type err) (message (format "====> Error: %s" err)))
|
||||
:on-close (lambda (websocket) (markdown-preview--drop-closed-clients))))
|
||||
(add-hook 'kill-emacs-hook 'markdown-preview--stop-websocket-server))
|
||||
(markdown-preview--open-browser-preview))
|
||||
|
||||
(defun markdown-preview--start-local-client ()
|
||||
"Start the `markdown-preview' local client."
|
||||
(when (not markdown-preview--local-client)
|
||||
(setq markdown-preview--local-client
|
||||
(websocket-open
|
||||
(format "ws://%s:%d" markdown-preview-host markdown-preview-ws-port)
|
||||
:on-error (lambda (ws type err)
|
||||
(message "error connecting"))
|
||||
:on-close (lambda (websocket)
|
||||
(setq markdown-preview--local-client nil))))))
|
||||
|
||||
(defun markdown-preview--send-preview (preview-uuid)
|
||||
"Send the `markdown-preview' with PREVIEW-UUID preview to clients."
|
||||
(when (bound-and-true-p markdown-preview-mode)
|
||||
(markdown-preview--send-preview-to markdown-preview--local-client preview-uuid)))
|
||||
|
||||
(defun markdown-preview--send-preview-to (websocket preview-uuid)
|
||||
"Send the `markdown-preview' with PREVIEW-UUID to a specific WEBSOCKET."
|
||||
(let ((mark-position-percent
|
||||
(number-to-string
|
||||
(truncate
|
||||
(* 100
|
||||
(/
|
||||
(float (- (line-number-at-pos) (/ (count-screen-lines (window-start) (point)) 2)))
|
||||
(count-lines (point-min) (point-max))))))))
|
||||
|
||||
(let ((md-buffer (gethash preview-uuid markdown-preview--preview-buffers)))
|
||||
(when md-buffer
|
||||
(with-current-buffer md-buffer
|
||||
|
||||
(markdown markdown-output-buffer-name))))
|
||||
|
||||
(with-current-buffer markdown-output-buffer-name ;; get-buffer
|
||||
(websocket-send-text websocket
|
||||
(concat
|
||||
"<div>"
|
||||
"<span id='position-percentage'>"
|
||||
mark-position-percent
|
||||
"</span>"
|
||||
"<div id='content'>"
|
||||
(buffer-substring-no-properties (point-min) (point-max))
|
||||
"</div>"
|
||||
"</div>")
|
||||
))))
|
||||
|
||||
(defun markdown-preview--start ()
|
||||
"Start `markdown-preview' mode."
|
||||
(setq-local markdown-preview--uuid (markdown-preview--random-uuid))
|
||||
(puthash markdown-preview--uuid (buffer-name) markdown-preview--preview-buffers)
|
||||
;; (gethash markdown-preview--uuid markdown-preview--preview-buffers)
|
||||
(markdown-preview--read-preview-template
|
||||
markdown-preview--uuid
|
||||
(expand-file-name markdown-preview-file-name default-directory))
|
||||
(markdown-preview--start-websocket-server)
|
||||
(markdown-preview--start-local-client)
|
||||
(markdown-preview--start-http-server markdown-preview-http-port)
|
||||
(setq markdown-preview--idle-timer
|
||||
(run-with-idle-timer markdown-preview-delay-time t
|
||||
(lambda ()
|
||||
(when markdown-preview--uuid
|
||||
(markdown-preview--send-preview markdown-preview--uuid)))))
|
||||
(add-hook 'after-save-hook (lambda ()
|
||||
(when markdown-preview--uuid
|
||||
(markdown-preview--send-preview markdown-preview--uuid))) nil t))
|
||||
|
||||
(defun markdown-preview--stop ()
|
||||
"Stop `markdown-preview' mode."
|
||||
(remove-hook 'after-save-hook 'markdown-preview--send-preview t)
|
||||
(markdown-preview--stop-idle-timer)
|
||||
(remhash markdown-preview--uuid markdown-preview--preview-buffers)
|
||||
(let* ((preview-file-dir (if (buffer-file-name)
|
||||
(file-name-directory (buffer-file-name))
|
||||
default-directory))
|
||||
(preview-file (concat preview-file-dir markdown-preview-file-name)))
|
||||
(if (file-exists-p preview-file)
|
||||
(delete-file preview-file))))
|
||||
|
||||
(defun markdown-preview--random-uuid ()
|
||||
"Insert a UUID using a simple hashing of variable data.
|
||||
Example of a UUID: 1df63142-a513-c850-31a3-535fc3520c3d
|
||||
Note: this code uses https://en.wikipedia.org/wiki/Md5,
|
||||
which is not cryptographically safe. I'm not sure what's
|
||||
the implication of its use here.
|
||||
Version 2015-01-30
|
||||
URL `http://ergoemacs.org/emacs/elisp_generate_uuid.html'"
|
||||
;; by Christopher Wellons, 2011-11-18. Editted by Xah Lee.
|
||||
;; Edited by Hideki Saito further to generate all valid variants for "N" in xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx format.
|
||||
;; (interactive)
|
||||
(let ((myStr (md5 (format "%s%s%s%s%s%s%s%s%s%s"
|
||||
(user-uid)
|
||||
(emacs-pid)
|
||||
(system-name)
|
||||
(user-full-name)
|
||||
(current-time)
|
||||
(emacs-uptime)
|
||||
(garbage-collect)
|
||||
(buffer-string)
|
||||
(random)
|
||||
(recent-keys)))))
|
||||
|
||||
(format "%s-%s-4%s-%s%s-%s"
|
||||
(substring myStr 0 8)
|
||||
(substring myStr 8 12)
|
||||
(substring myStr 13 16)
|
||||
(format "%x" (+ 8 (random 4)))
|
||||
(substring myStr 17 20)
|
||||
(substring myStr 20 32))))
|
||||
|
||||
;;;###autoload
|
||||
(defun markdown-preview-open-browser ()
|
||||
"Open the `markdown-preview' in the browser."
|
||||
(interactive)
|
||||
(markdown-preview--open-browser-preview))
|
||||
|
||||
;;;###autoload
|
||||
(defun markdown-preview-cleanup ()
|
||||
"Cleanup `markdown-preview' mode."
|
||||
(interactive)
|
||||
(markdown-preview--stop-websocket-server)
|
||||
(markdown-preview--stop-http-server))
|
||||
|
||||
;;;###autoload
|
||||
(define-minor-mode markdown-preview-mode
|
||||
"Markdown preview mode."
|
||||
:group 'markdown-preview
|
||||
:init-value nil
|
||||
(when (not (or
|
||||
(equal major-mode 'markdown-mode)
|
||||
(equal major-mode 'gfm-mode)))
|
||||
(markdown-mode))
|
||||
(if markdown-preview-mode
|
||||
(markdown-preview--start)
|
||||
(markdown-preview--stop)))
|
||||
|
||||
(provide 'markdown-preview-mode)
|
||||
|
||||
;;; markdown-preview-mode.el ends here
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1, minimal-ui">
|
||||
<title>Markdown preview</title>
|
||||
${MD_STYLE}
|
||||
<script src="http://code.jquery.com/jquery-1.12.4.min.js"></script>
|
||||
${MD_JS}
|
||||
<script>
|
||||
(function($, undefined) {
|
||||
var socket = new WebSocket("ws://${WS_HOST}:${WS_PORT}");
|
||||
socket.onopen = function() {
|
||||
console.log("Connection established.");
|
||||
socket.send("MDPM-Register-UUID: ${MD_UUID}");
|
||||
};
|
||||
socket.onclose = function(event) {
|
||||
if (event.wasClean) {
|
||||
console.log('Connection closed gracefully.');
|
||||
} else {
|
||||
console.log('Connection terminated.');
|
||||
}
|
||||
console.log('Code: ' + event.code + ' reason: ' + event.reason);
|
||||
};
|
||||
socket.onmessage = function(event) {
|
||||
$("#markdown-body").html($(event.data).find("#content").html()).trigger('mdContentChange');
|
||||
var scroll = $(document).height() * ($(event.data).find("#position-percentage").html() / 100);
|
||||
$("html, body").animate({ scrollTop: scroll }, 600);
|
||||
};
|
||||
socket.onerror = function(error) {
|
||||
console.log("Error: " + error.message);
|
||||
};
|
||||
})(jQuery);
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<article id="markdown-body" class="markdown-body">
|
||||
<p>Markdown preview</p>
|
||||
</article>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
;;; rainbow-delimiters-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
|
||||
;;
|
||||
;;; Code:
|
||||
|
||||
(add-to-list 'load-path (directory-file-name
|
||||
(or (file-name-directory #$) (car load-path))))
|
||||
|
||||
|
||||
;;;### (autoloads nil "rainbow-delimiters" "rainbow-delimiters.el"
|
||||
;;;;;; (0 0 0 0))
|
||||
;;; Generated autoloads from rainbow-delimiters.el
|
||||
|
||||
(autoload 'rainbow-delimiters-mode "rainbow-delimiters" "\
|
||||
Highlight nested parentheses, brackets, and braces according to their depth.
|
||||
|
||||
This is a minor mode. If called interactively, toggle the
|
||||
`Rainbow-Delimiters mode' mode. If the prefix argument is
|
||||
positive, enable the mode, and if it is zero or negative, disable
|
||||
the mode.
|
||||
|
||||
If called from Lisp, toggle the mode if ARG is `toggle'. Enable
|
||||
the mode if ARG is nil, omitted, or is a positive number.
|
||||
Disable the mode if ARG is a negative number.
|
||||
|
||||
To check whether the minor mode is enabled in the current buffer,
|
||||
evaluate `rainbow-delimiters-mode'.
|
||||
|
||||
The mode's hook is called both when the mode is enabled and when
|
||||
it is disabled.
|
||||
|
||||
\(fn &optional ARG)" t nil)
|
||||
|
||||
(autoload 'rainbow-delimiters-mode-enable "rainbow-delimiters" "\
|
||||
Enable `rainbow-delimiters-mode'." nil nil)
|
||||
|
||||
(autoload 'rainbow-delimiters-mode-disable "rainbow-delimiters" "\
|
||||
Disable `rainbow-delimiters-mode'." nil nil)
|
||||
|
||||
(register-definition-prefixes "rainbow-delimiters" '("rainbow-delimiters-"))
|
||||
|
||||
;;;***
|
||||
|
||||
;; Local Variables:
|
||||
;; version-control: never
|
||||
;; no-byte-compile: t
|
||||
;; no-update-autoloads: t
|
||||
;; coding: utf-8
|
||||
;; End:
|
||||
;;; rainbow-delimiters-autoloads.el ends here
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
;;; Generated package description from rainbow-delimiters.el -*- no-byte-compile: t -*-
|
||||
(define-package "rainbow-delimiters" "20210515.1254" "Highlight brackets according to their depth" 'nil :commit "7919681b0d883502155d5b26e791fec15da6aeca" :authors '(("Jeremy Rayman" . "opensource@jeremyrayman.com") ("Fanael Linithien" . "fanael4@gmail.com")) :maintainer '("Fanael Linithien" . "fanael4@gmail.com") :keywords '("faces" "convenience" "lisp" "tools") :url "https://github.com/Fanael/rainbow-delimiters")
|
||||
|
|
@ -0,0 +1,311 @@
|
|||
;;; rainbow-delimiters.el --- Highlight brackets according to their depth -*- lexical-binding: t -*-
|
||||
|
||||
;; Copyright (C)
|
||||
;; 2010-2013 Jeremy Rayman
|
||||
;; 2013-2021 Fanael Linithien
|
||||
;; Author: Jeremy Rayman <opensource@jeremyrayman.com>
|
||||
;; Fanael Linithien <fanael4@gmail.com>
|
||||
;; Maintainer: Fanael Linithien <fanael4@gmail.com>
|
||||
;; Created: 2010-09-02
|
||||
;; Version: 2.1.5
|
||||
;; Package-Version: 20210515.1254
|
||||
;; Package-Commit: 7919681b0d883502155d5b26e791fec15da6aeca
|
||||
;; Keywords: faces, convenience, lisp, tools
|
||||
;; Homepage: https://github.com/Fanael/rainbow-delimiters
|
||||
|
||||
;; Note: despite `lexical-binding', there's no Emacs 24 dependency.
|
||||
;; This is merely an optimization for Emacs 24+, the code is supposed to work
|
||||
;; with *both* dynamic and lexical binding.
|
||||
|
||||
;; 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 3 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, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Installation:
|
||||
|
||||
;; The recommended way is to use MELPA (http://melpa.org/) or MELPA Stable
|
||||
;; (http://stable.melpa.org/). If either is in your `package-archives', do
|
||||
;; M-x package-install RET rainbow-delimiters RET
|
||||
;; Otherwise, open `rainbow-delimiters.el' in Emacs and use
|
||||
;; M-x package-install-from-buffer
|
||||
;; Any other methods of installation are unsupported.
|
||||
|
||||
;;; Commentary:
|
||||
;;
|
||||
;; Rainbow-delimiters is a "rainbow parentheses"-like mode which highlights
|
||||
;; parentheses, brackets, and braces according to their depth. Each
|
||||
;; successive level is highlighted in a different color. This makes it easy
|
||||
;; to spot matching delimiters, orient yourself in the code, and tell which
|
||||
;; statements are at a given level.
|
||||
;;
|
||||
;; Great care has been taken to make this mode fast. You shouldn't see
|
||||
;; any discernible change in scrolling or editing speed while using it,
|
||||
;; even in delimiter-rich languages like Clojure, Lisp, and Scheme.
|
||||
;;
|
||||
;; Usage:
|
||||
;;
|
||||
;; To toggle the mode in the current buffer:
|
||||
;; M-x rainbow-delimiters-mode
|
||||
;; To start the mode automatically in `foo-mode', add the following to your init
|
||||
;; file:
|
||||
;; (add-hook 'foo-mode-hook #'rainbow-delimiters-mode)
|
||||
;; To start the mode automatically in most programming modes (Emacs 24 and
|
||||
;; above):
|
||||
;; (add-hook 'prog-mode-hook #'rainbow-delimiters-mode)
|
||||
;;
|
||||
;; Customization:
|
||||
;;
|
||||
;; To customize various options, including the color theme:
|
||||
;; M-x customize-group rainbow-delimiters
|
||||
;;
|
||||
;; You can specify custom colors by customizing following faces:
|
||||
;; - Faces take the form `rainbow-delimiters-depth-N-face', with N being the
|
||||
;; depth. Depth begins at 1, the outermost color. Faces exist for depths 1-9.
|
||||
;; - The unmatched delimiter face: `rainbow-delimiters-unmatched-face'.
|
||||
;; - The mismatched delimiter face: `rainbow-delimiters-mismatched-face'.
|
||||
|
||||
;;; Code:
|
||||
|
||||
(defgroup rainbow-delimiters nil
|
||||
"Highlight nested parentheses, brackets, and braces according to their depth."
|
||||
:prefix "rainbow-delimiters-"
|
||||
:link '(url-link :tag "Website for rainbow-delimiters"
|
||||
"https://github.com/Fanael/rainbow-delimiters")
|
||||
:group 'applications)
|
||||
|
||||
(defgroup rainbow-delimiters-faces nil
|
||||
"Faces for successively nested pairs of delimiters.
|
||||
|
||||
When depth exceeds innermost defined face, colors cycle back through."
|
||||
:group 'rainbow-delimiters
|
||||
:group 'faces
|
||||
:link '(custom-group-link "rainbow-delimiters")
|
||||
:prefix "rainbow-delimiters-")
|
||||
|
||||
(defcustom rainbow-delimiters-pick-face-function
|
||||
#'rainbow-delimiters-default-pick-face
|
||||
"The function used to pick a face used to highlight a delimiter.
|
||||
The function should take three arguments (DEPTH MATCH LOC), where:
|
||||
- DEPTH is the delimiter depth; when zero or negative, it's an unmatched
|
||||
delimiter.
|
||||
- MATCH is nil iff the delimiter is a mismatched closing delimiter.
|
||||
- LOC is the location of the delimiter.
|
||||
The function should return a value suitable to use as a value of the `face' text
|
||||
property, or nil, in which case the delimiter is not highlighted.
|
||||
The function should not move the point or mark or change the match data."
|
||||
:tag "Pick face function"
|
||||
:type 'function
|
||||
:group 'rainbow-delimiters)
|
||||
|
||||
(defface rainbow-delimiters-base-face
|
||||
'((default (:inherit unspecified)))
|
||||
"Face inherited by all other rainbow-delimiter faces."
|
||||
:group 'rainbow-delimiters-faces)
|
||||
|
||||
(defface rainbow-delimiters-base-error-face
|
||||
'((default (:inherit rainbow-delimiters-base-face))
|
||||
(t (:foreground "#88090B")))
|
||||
"Face inherited by all other rainbow-delimiter error faces."
|
||||
:group 'rainbow-delimiters-faces)
|
||||
|
||||
(defface rainbow-delimiters-unmatched-face
|
||||
'((default (:inherit rainbow-delimiters-base-error-face)))
|
||||
"Face to highlight unmatched closing delimiters in."
|
||||
:group 'rainbow-delimiters-faces)
|
||||
|
||||
(defface rainbow-delimiters-mismatched-face
|
||||
'((default (:inherit rainbow-delimiters-unmatched-face)))
|
||||
"Face to highlight mismatched closing delimiters in."
|
||||
:group 'rainbow-delimiters-faces)
|
||||
|
||||
(eval-when-compile
|
||||
(defmacro rainbow-delimiters--define-depth-faces ()
|
||||
(let ((faces '())
|
||||
(light-colors ["#707183" "#7388d6" "#909183" "#709870" "#907373"
|
||||
"#6276ba" "#858580" "#80a880" "#887070"])
|
||||
(dark-colors ["grey55" "#93a8c6" "#b0b1a3" "#97b098" "#aebed8"
|
||||
"#b0b0b3" "#90a890" "#a2b6da" "#9cb6ad"]))
|
||||
(dotimes (i 9)
|
||||
(push `(defface ,(intern (format "rainbow-delimiters-depth-%d-face" (1+ i)))
|
||||
'((default (:inherit rainbow-delimiters-base-face))
|
||||
(((class color) (background light)) :foreground ,(aref light-colors i))
|
||||
(((class color) (background dark)) :foreground ,(aref dark-colors i)))
|
||||
,(format "Nested delimiter face, depth %d." (1+ i))
|
||||
:group 'rainbow-delimiters-faces)
|
||||
faces))
|
||||
`(progn ,@faces))))
|
||||
(rainbow-delimiters--define-depth-faces)
|
||||
|
||||
(defcustom rainbow-delimiters-max-face-count 9
|
||||
"Number of faces defined for highlighting delimiter levels.
|
||||
|
||||
Determines depth at which to cycle through faces again.
|
||||
|
||||
It's safe to change this variable provided that for all integers from 1 to the
|
||||
new value inclusive, a face `rainbow-delimiters-depth-N-face' is defined."
|
||||
:type 'integer
|
||||
:group 'rainbow-delimiters)
|
||||
|
||||
(defcustom rainbow-delimiters-outermost-only-face-count 0
|
||||
"Number of faces to be used only for N outermost delimiter levels.
|
||||
|
||||
This should be smaller than `rainbow-delimiters-max-face-count'."
|
||||
:type 'integer
|
||||
:group 'rainbow-delimiters)
|
||||
|
||||
|
||||
(defun rainbow-delimiters-default-pick-face (depth match _loc)
|
||||
"Return a face name appropriate for nesting depth DEPTH.
|
||||
DEPTH and MATCH are as in `rainbow-delimiters-pick-face-function'.
|
||||
|
||||
The returned value is either `rainbow-delimiters-unmatched-face',
|
||||
`rainbow-delimiters-mismatched-face', or one of the
|
||||
`rainbow-delimiters-depth-N-face' faces, obeying
|
||||
`rainbow-delimiters-max-face-count' and
|
||||
`rainbow-delimiters-outermost-only-face-count'."
|
||||
(cond
|
||||
((<= depth 0)
|
||||
'rainbow-delimiters-unmatched-face)
|
||||
((not match)
|
||||
'rainbow-delimiters-mismatched-face)
|
||||
(t
|
||||
(intern-soft
|
||||
(concat "rainbow-delimiters-depth-"
|
||||
(number-to-string
|
||||
(if (<= depth rainbow-delimiters-max-face-count)
|
||||
;; Our nesting depth has a face defined for it.
|
||||
depth
|
||||
;; Deeper than # of defined faces; cycle back through to
|
||||
;; `rainbow-delimiters-outermost-only-face-count' + 1.
|
||||
;; Return face # that corresponds to current nesting level.
|
||||
(+ 1 rainbow-delimiters-outermost-only-face-count
|
||||
(mod (- depth rainbow-delimiters-max-face-count 1)
|
||||
(- rainbow-delimiters-max-face-count
|
||||
rainbow-delimiters-outermost-only-face-count)))))
|
||||
"-face")))))
|
||||
|
||||
(defun rainbow-delimiters--apply-color (loc depth match)
|
||||
"Highlight a single delimiter at LOC according to DEPTH.
|
||||
|
||||
LOC is the location of the character to add text properties to.
|
||||
DEPTH is the nested depth at LOC, which determines the face to use.
|
||||
MATCH is nil iff it's a mismatched closing delimiter."
|
||||
(let ((face (funcall rainbow-delimiters-pick-face-function depth match loc)))
|
||||
(when face
|
||||
(font-lock-prepend-text-property loc (1+ loc) 'face face))))
|
||||
|
||||
(defun rainbow-delimiters--char-ineligible-p (loc ppss delim-syntax-code)
|
||||
"Return t if char at LOC should not be highlighted.
|
||||
PPSS is the `parse-partial-sexp' state at LOC.
|
||||
DELIM-SYNTAX-CODE is the `car' of a raw syntax descriptor at LOC.
|
||||
|
||||
Returns t if char at loc meets one of the following conditions:
|
||||
- Inside a string.
|
||||
- Inside a comment.
|
||||
- Is an escaped char, e.g. ?\)"
|
||||
(or
|
||||
(nth 3 ppss) ; inside string?
|
||||
(nth 4 ppss) ; inside comment?
|
||||
(nth 5 ppss) ; escaped according to the syntax table?
|
||||
;; Note: no need to consider single-char openers, they're already handled
|
||||
;; by looking at ppss.
|
||||
(cond
|
||||
;; Two character opener, LOC at the first character?
|
||||
((/= 0 (logand #x10000 delim-syntax-code))
|
||||
(/= 0 (logand #x20000 (or (car (syntax-after (1+ loc))) 0))))
|
||||
;; Two character opener, LOC at the second character?
|
||||
((/= 0 (logand #x20000 delim-syntax-code))
|
||||
(/= 0 (logand #x10000 (or (car (syntax-after (1- loc))) 0))))
|
||||
(t
|
||||
nil))))
|
||||
|
||||
;; Main function called by font-lock.
|
||||
(defun rainbow-delimiters--propertize (end)
|
||||
"Highlight delimiters in region between point and END.
|
||||
|
||||
Used by font-lock for dynamic highlighting."
|
||||
(when (bound-and-true-p mmm-current-submode)
|
||||
;; `mmm-mode' is weird and apparently needs this hack, because otherwise we
|
||||
;; may end up thinking matched parentheses are mismatched.
|
||||
(widen))
|
||||
(let* ((last-ppss-pos (point))
|
||||
(ppss (syntax-ppss)))
|
||||
(while (> end (progn (skip-syntax-forward "^()" end)
|
||||
(point)))
|
||||
(let* ((delim-pos (point))
|
||||
(delim-syntax (syntax-after delim-pos)))
|
||||
(setq ppss (parse-partial-sexp last-ppss-pos delim-pos nil nil ppss))
|
||||
(setq last-ppss-pos delim-pos)
|
||||
;; `skip-syntax-forward' leaves the point at the delimiter, move past
|
||||
;; it.
|
||||
(forward-char)
|
||||
(let ((delim-syntax-code (car delim-syntax)))
|
||||
(cond
|
||||
((rainbow-delimiters--char-ineligible-p delim-pos ppss delim-syntax-code)
|
||||
nil)
|
||||
((= 4 (logand #xFFFF delim-syntax-code))
|
||||
;; The (1+ ...) is needed because `parse-partial-sexp' returns the
|
||||
;; depth at the opening delimiter, not in the block being started.
|
||||
(rainbow-delimiters--apply-color delim-pos (1+ (nth 0 ppss)) t))
|
||||
(t
|
||||
;; Not an opening delimiter, so it's a closing delimiter.
|
||||
(let ((matches-p (eq (cdr delim-syntax) (char-after (nth 1 ppss)))))
|
||||
(rainbow-delimiters--apply-color delim-pos (nth 0 ppss) matches-p))))))))
|
||||
;; We already fontified the delimiters, tell font-lock there's nothing more
|
||||
;; to do.
|
||||
nil)
|
||||
|
||||
;; NB: no face defined here because we apply the faces ourselves instead of
|
||||
;; leaving that to font-lock.
|
||||
(defconst rainbow-delimiters--font-lock-keywords
|
||||
'(rainbow-delimiters--propertize))
|
||||
|
||||
;;;###autoload
|
||||
(define-minor-mode rainbow-delimiters-mode
|
||||
"Highlight nested parentheses, brackets, and braces according to their depth."
|
||||
:init-value nil
|
||||
:lighter "" ; No modeline lighter - it's already obvious when the mode is on.
|
||||
:keymap nil
|
||||
(font-lock-remove-keywords nil rainbow-delimiters--font-lock-keywords)
|
||||
(when rainbow-delimiters-mode
|
||||
(font-lock-add-keywords nil rainbow-delimiters--font-lock-keywords 'append)
|
||||
(set (make-local-variable 'jit-lock-contextually) t)
|
||||
(when (or (bound-and-true-p syntax-begin-function)
|
||||
(bound-and-true-p font-lock-beginning-of-syntax-function))
|
||||
;; We're going to modify `syntax-begin-function', so flush the cache to
|
||||
;; avoid getting cached values that used the old value.
|
||||
(syntax-ppss-flush-cache 0))
|
||||
;; `syntax-begin-function' may break the assumption we rely on that
|
||||
;; `syntax-ppss' is exactly equivalent to `parse-partial-sexp' from
|
||||
;; `point-min'. Just don't use it, the performance hit should be negligible.
|
||||
(when (boundp 'syntax-begin-function)
|
||||
(set (make-local-variable 'syntax-begin-function) nil))
|
||||
;; Obsolete equivalent of `syntax-begin-function'.
|
||||
(when (boundp 'font-lock-beginning-of-syntax-function)
|
||||
(set (make-local-variable 'font-lock-beginning-of-syntax-function) nil)))
|
||||
(when font-lock-mode
|
||||
(if (fboundp 'font-lock-flush)
|
||||
(font-lock-flush)
|
||||
(with-no-warnings (font-lock-fontify-buffer)))))
|
||||
|
||||
;;;###autoload
|
||||
(defun rainbow-delimiters-mode-enable ()
|
||||
"Enable `rainbow-delimiters-mode'."
|
||||
(rainbow-delimiters-mode 1))
|
||||
|
||||
;;;###autoload
|
||||
(defun rainbow-delimiters-mode-disable ()
|
||||
"Disable `rainbow-delimiters-mode'."
|
||||
(rainbow-delimiters-mode 0))
|
||||
|
||||
(provide 'rainbow-delimiters)
|
||||
;;; rainbow-delimiters.el ends here
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
This is the file .../info/dir, which contains the
|
||||
topmost node of the Info hierarchy, called (dir)Top.
|
||||
The first time you invoke Info you start off looking at this node.
|
||||
|
||||
File: dir, Node: Top This is the top of the INFO tree
|
||||
|
||||
This (the Directory node) gives a menu of major topics.
|
||||
Typing "q" exits, "H" lists all Info commands, "d" returns here,
|
||||
"h" gives a primer for first-timers,
|
||||
"mEmacs<Return>" visits the Emacs manual, etc.
|
||||
|
||||
In Emacs, you can click mouse button 2 on a menu item or cross reference
|
||||
to select it.
|
||||
|
||||
* Menu:
|
||||
|
||||
Emacs
|
||||
* Web Server: (web-server). Web Server for Emacs.
|
||||
|
|
@ -0,0 +1,489 @@
|
|||
This is doclicense.info, produced by makeinfo version 6.7 from
|
||||
doclicense.texi.
|
||||
|
||||
Version 1.3, 3 November 2008
|
||||
|
||||
Copyright (C) 2000, 2001, 2002, 2007, 2008, 2009 Free Software Foundation, Inc.
|
||||
<http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
0. PREAMBLE
|
||||
|
||||
The purpose of this License is to make a manual, textbook, or other
|
||||
functional and useful document "free" in the sense of freedom: to
|
||||
assure everyone the effective freedom to copy and redistribute it,
|
||||
with or without modifying it, either commercially or
|
||||
noncommercially. Secondarily, this License preserves for the
|
||||
author and publisher a way to get credit for their work, while not
|
||||
being considered responsible for modifications made by others.
|
||||
|
||||
This License is a kind of "copyleft", which means that derivative
|
||||
works of the document must themselves be free in the same sense.
|
||||
It complements the GNU General Public License, which is a copyleft
|
||||
license designed for free software.
|
||||
|
||||
We have designed this License in order to use it for manuals for
|
||||
free software, because free software needs free documentation: a
|
||||
free program should come with manuals providing the same freedoms
|
||||
that the software does. But this License is not limited to
|
||||
software manuals; it can be used for any textual work, regardless
|
||||
of subject matter or whether it is published as a printed book. We
|
||||
recommend this License principally for works whose purpose is
|
||||
instruction or reference.
|
||||
|
||||
1. APPLICABILITY AND DEFINITIONS
|
||||
|
||||
This License applies to any manual or other work, in any medium,
|
||||
that contains a notice placed by the copyright holder saying it can
|
||||
be distributed under the terms of this License. Such a notice
|
||||
grants a world-wide, royalty-free license, unlimited in duration,
|
||||
to use that work under the conditions stated herein. The
|
||||
"Document", below, refers to any such manual or work. Any member
|
||||
of the public is a licensee, and is addressed as "you". You accept
|
||||
the license if you copy, modify or distribute the work in a way
|
||||
requiring permission under copyright law.
|
||||
|
||||
A "Modified Version" of the Document means any work containing the
|
||||
Document or a portion of it, either copied verbatim, or with
|
||||
modifications and/or translated into another language.
|
||||
|
||||
A "Secondary Section" is a named appendix or a front-matter section
|
||||
of the Document that deals exclusively with the relationship of the
|
||||
publishers or authors of the Document to the Document's overall
|
||||
subject (or to related matters) and contains nothing that could
|
||||
fall directly within that overall subject. (Thus, if the Document
|
||||
is in part a textbook of mathematics, a Secondary Section may not
|
||||
explain any mathematics.) The relationship could be a matter of
|
||||
historical connection with the subject or with related matters, or
|
||||
of legal, commercial, philosophical, ethical or political position
|
||||
regarding them.
|
||||
|
||||
The "Invariant Sections" are certain Secondary Sections whose
|
||||
titles are designated, as being those of Invariant Sections, in the
|
||||
notice that says that the Document is released under this License.
|
||||
If a section does not fit the above definition of Secondary then it
|
||||
is not allowed to be designated as Invariant. The Document may
|
||||
contain zero Invariant Sections. If the Document does not identify
|
||||
any Invariant Sections then there are none.
|
||||
|
||||
The "Cover Texts" are certain short passages of text that are
|
||||
listed, as Front-Cover Texts or Back-Cover Texts, in the notice
|
||||
that says that the Document is released under this License. A
|
||||
Front-Cover Text may be at most 5 words, and a Back-Cover Text may
|
||||
be at most 25 words.
|
||||
|
||||
A "Transparent" copy of the Document means a machine-readable copy,
|
||||
represented in a format whose specification is available to the
|
||||
general public, that is suitable for revising the document
|
||||
straightforwardly with generic text editors or (for images composed
|
||||
of pixels) generic paint programs or (for drawings) some widely
|
||||
available drawing editor, and that is suitable for input to text
|
||||
formatters or for automatic translation to a variety of formats
|
||||
suitable for input to text formatters. A copy made in an otherwise
|
||||
Transparent file format whose markup, or absence of markup, has
|
||||
been arranged to thwart or discourage subsequent modification by
|
||||
readers is not Transparent. An image format is not Transparent if
|
||||
used for any substantial amount of text. A copy that is not
|
||||
"Transparent" is called "Opaque".
|
||||
|
||||
Examples of suitable formats for Transparent copies include plain
|
||||
ASCII without markup, Texinfo input format, LaTeX input format,
|
||||
SGML or XML using a publicly available DTD, and standard-conforming
|
||||
simple HTML, PostScript or PDF designed for human modification.
|
||||
Examples of transparent image formats include PNG, XCF and JPG.
|
||||
Opaque formats include proprietary formats that can be read and
|
||||
edited only by proprietary word processors, SGML or XML for which
|
||||
the DTD and/or processing tools are not generally available, and
|
||||
the machine-generated HTML, PostScript or PDF produced by some word
|
||||
processors for output purposes only.
|
||||
|
||||
The "Title Page" means, for a printed book, the title page itself,
|
||||
plus such following pages as are needed to hold, legibly, the
|
||||
material this License requires to appear in the title page. For
|
||||
works in formats which do not have any title page as such, "Title
|
||||
Page" means the text near the most prominent appearance of the
|
||||
work's title, preceding the beginning of the body of the text.
|
||||
|
||||
The "publisher" means any person or entity that distributes copies
|
||||
of the Document to the public.
|
||||
|
||||
A section "Entitled XYZ" means a named subunit of the Document
|
||||
whose title either is precisely XYZ or contains XYZ in parentheses
|
||||
following text that translates XYZ in another language. (Here XYZ
|
||||
stands for a specific section name mentioned below, such as
|
||||
"Acknowledgements", "Dedications", "Endorsements", or "History".)
|
||||
To "Preserve the Title" of such a section when you modify the
|
||||
Document means that it remains a section "Entitled XYZ" according
|
||||
to this definition.
|
||||
|
||||
The Document may include Warranty Disclaimers next to the notice
|
||||
which states that this License applies to the Document. These
|
||||
Warranty Disclaimers are considered to be included by reference in
|
||||
this License, but only as regards disclaiming warranties: any other
|
||||
implication that these Warranty Disclaimers may have is void and
|
||||
has no effect on the meaning of this License.
|
||||
|
||||
2. VERBATIM COPYING
|
||||
|
||||
You may copy and distribute the Document in any medium, either
|
||||
commercially or noncommercially, provided that this License, the
|
||||
copyright notices, and the license notice saying this License
|
||||
applies to the Document are reproduced in all copies, and that you
|
||||
add no other conditions whatsoever to those of this License. You
|
||||
may not use technical measures to obstruct or control the reading
|
||||
or further copying of the copies you make or distribute. However,
|
||||
you may accept compensation in exchange for copies. If you
|
||||
distribute a large enough number of copies you must also follow the
|
||||
conditions in section 3.
|
||||
|
||||
You may also lend copies, under the same conditions stated above,
|
||||
and you may publicly display copies.
|
||||
|
||||
3. COPYING IN QUANTITY
|
||||
|
||||
If you publish printed copies (or copies in media that commonly
|
||||
have printed covers) of the Document, numbering more than 100, and
|
||||
the Document's license notice requires Cover Texts, you must
|
||||
enclose the copies in covers that carry, clearly and legibly, all
|
||||
these Cover Texts: Front-Cover Texts on the front cover, and
|
||||
Back-Cover Texts on the back cover. Both covers must also clearly
|
||||
and legibly identify you as the publisher of these copies. The
|
||||
front cover must present the full title with all words of the title
|
||||
equally prominent and visible. You may add other material on the
|
||||
covers in addition. Copying with changes limited to the covers, as
|
||||
long as they preserve the title of the Document and satisfy these
|
||||
conditions, can be treated as verbatim copying in other respects.
|
||||
|
||||
If the required texts for either cover are too voluminous to fit
|
||||
legibly, you should put the first ones listed (as many as fit
|
||||
reasonably) on the actual cover, and continue the rest onto
|
||||
adjacent pages.
|
||||
|
||||
If you publish or distribute Opaque copies of the Document
|
||||
numbering more than 100, you must either include a machine-readable
|
||||
Transparent copy along with each Opaque copy, or state in or with
|
||||
each Opaque copy a computer-network location from which the general
|
||||
network-using public has access to download using public-standard
|
||||
network protocols a complete Transparent copy of the Document, free
|
||||
of added material. If you use the latter option, you must take
|
||||
reasonably prudent steps, when you begin distribution of Opaque
|
||||
copies in quantity, to ensure that this Transparent copy will
|
||||
remain thus accessible at the stated location until at least one
|
||||
year after the last time you distribute an Opaque copy (directly or
|
||||
through your agents or retailers) of that edition to the public.
|
||||
|
||||
It is requested, but not required, that you contact the authors of
|
||||
the Document well before redistributing any large number of copies,
|
||||
to give them a chance to provide you with an updated version of the
|
||||
Document.
|
||||
|
||||
4. MODIFICATIONS
|
||||
|
||||
You may copy and distribute a Modified Version of the Document
|
||||
under the conditions of sections 2 and 3 above, provided that you
|
||||
release the Modified Version under precisely this License, with the
|
||||
Modified Version filling the role of the Document, thus licensing
|
||||
distribution and modification of the Modified Version to whoever
|
||||
possesses a copy of it. In addition, you must do these things in
|
||||
the Modified Version:
|
||||
|
||||
A. Use in the Title Page (and on the covers, if any) a title
|
||||
distinct from that of the Document, and from those of previous
|
||||
versions (which should, if there were any, be listed in the
|
||||
History section of the Document). You may use the same title
|
||||
as a previous version if the original publisher of that
|
||||
version gives permission.
|
||||
|
||||
B. List on the Title Page, as authors, one or more persons or
|
||||
entities responsible for authorship of the modifications in
|
||||
the Modified Version, together with at least five of the
|
||||
principal authors of the Document (all of its principal
|
||||
authors, if it has fewer than five), unless they release you
|
||||
from this requirement.
|
||||
|
||||
C. State on the Title page the name of the publisher of the
|
||||
Modified Version, as the publisher.
|
||||
|
||||
D. Preserve all the copyright notices of the Document.
|
||||
|
||||
E. Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.
|
||||
|
||||
F. Include, immediately after the copyright notices, a license
|
||||
notice giving the public permission to use the Modified
|
||||
Version under the terms of this License, in the form shown in
|
||||
the Addendum below.
|
||||
|
||||
G. Preserve in that license notice the full lists of Invariant
|
||||
Sections and required Cover Texts given in the Document's
|
||||
license notice.
|
||||
|
||||
H. Include an unaltered copy of this License.
|
||||
|
||||
I. Preserve the section Entitled "History", Preserve its Title,
|
||||
and add to it an item stating at least the title, year, new
|
||||
authors, and publisher of the Modified Version as given on the
|
||||
Title Page. If there is no section Entitled "History" in the
|
||||
Document, create one stating the title, year, authors, and
|
||||
publisher of the Document as given on its Title Page, then add
|
||||
an item describing the Modified Version as stated in the
|
||||
previous sentence.
|
||||
|
||||
J. Preserve the network location, if any, given in the Document
|
||||
for public access to a Transparent copy of the Document, and
|
||||
likewise the network locations given in the Document for
|
||||
previous versions it was based on. These may be placed in the
|
||||
"History" section. You may omit a network location for a work
|
||||
that was published at least four years before the Document
|
||||
itself, or if the original publisher of the version it refers
|
||||
to gives permission.
|
||||
|
||||
K. For any section Entitled "Acknowledgements" or "Dedications",
|
||||
Preserve the Title of the section, and preserve in the section
|
||||
all the substance and tone of each of the contributor
|
||||
acknowledgements and/or dedications given therein.
|
||||
|
||||
L. Preserve all the Invariant Sections of the Document, unaltered
|
||||
in their text and in their titles. Section numbers or the
|
||||
equivalent are not considered part of the section titles.
|
||||
|
||||
M. Delete any section Entitled "Endorsements". Such a section
|
||||
may not be included in the Modified Version.
|
||||
|
||||
N. Do not retitle any existing section to be Entitled
|
||||
"Endorsements" or to conflict in title with any Invariant
|
||||
Section.
|
||||
|
||||
O. Preserve any Warranty Disclaimers.
|
||||
|
||||
If the Modified Version includes new front-matter sections or
|
||||
appendices that qualify as Secondary Sections and contain no
|
||||
material copied from the Document, you may at your option designate
|
||||
some or all of these sections as invariant. To do this, add their
|
||||
titles to the list of Invariant Sections in the Modified Version's
|
||||
license notice. These titles must be distinct from any other
|
||||
section titles.
|
||||
|
||||
You may add a section Entitled "Endorsements", provided it contains
|
||||
nothing but endorsements of your Modified Version by various
|
||||
parties--for example, statements of peer review or that the text
|
||||
has been approved by an organization as the authoritative
|
||||
definition of a standard.
|
||||
|
||||
You may add a passage of up to five words as a Front-Cover Text,
|
||||
and a passage of up to 25 words as a Back-Cover Text, to the end of
|
||||
the list of Cover Texts in the Modified Version. Only one passage
|
||||
of Front-Cover Text and one of Back-Cover Text may be added by (or
|
||||
through arrangements made by) any one entity. If the Document
|
||||
already includes a cover text for the same cover, previously added
|
||||
by you or by arrangement made by the same entity you are acting on
|
||||
behalf of, you may not add another; but you may replace the old
|
||||
one, on explicit permission from the previous publisher that added
|
||||
the old one.
|
||||
|
||||
The author(s) and publisher(s) of the Document do not by this
|
||||
License give permission to use their names for publicity for or to
|
||||
assert or imply endorsement of any Modified Version.
|
||||
|
||||
5. COMBINING DOCUMENTS
|
||||
|
||||
You may combine the Document with other documents released under
|
||||
this License, under the terms defined in section 4 above for
|
||||
modified versions, provided that you include in the combination all
|
||||
of the Invariant Sections of all of the original documents,
|
||||
unmodified, and list them all as Invariant Sections of your
|
||||
combined work in its license notice, and that you preserve all
|
||||
their Warranty Disclaimers.
|
||||
|
||||
The combined work need only contain one copy of this License, and
|
||||
multiple identical Invariant Sections may be replaced with a single
|
||||
copy. If there are multiple Invariant Sections with the same name
|
||||
but different contents, make the title of each such section unique
|
||||
by adding at the end of it, in parentheses, the name of the
|
||||
original author or publisher of that section if known, or else a
|
||||
unique number. Make the same adjustment to the section titles in
|
||||
the list of Invariant Sections in the license notice of the
|
||||
combined work.
|
||||
|
||||
In the combination, you must combine any sections Entitled
|
||||
"History" in the various original documents, forming one section
|
||||
Entitled "History"; likewise combine any sections Entitled
|
||||
"Acknowledgements", and any sections Entitled "Dedications". You
|
||||
must delete all sections Entitled "Endorsements."
|
||||
|
||||
6. COLLECTIONS OF DOCUMENTS
|
||||
|
||||
You may make a collection consisting of the Document and other
|
||||
documents released under this License, and replace the individual
|
||||
copies of this License in the various documents with a single copy
|
||||
that is included in the collection, provided that you follow the
|
||||
rules of this License for verbatim copying of each of the documents
|
||||
in all other respects.
|
||||
|
||||
You may extract a single document from such a collection, and
|
||||
distribute it individually under this License, provided you insert
|
||||
a copy of this License into the extracted document, and follow this
|
||||
License in all other respects regarding verbatim copying of that
|
||||
document.
|
||||
|
||||
7. AGGREGATION WITH INDEPENDENT WORKS
|
||||
|
||||
A compilation of the Document or its derivatives with other
|
||||
separate and independent documents or works, in or on a volume of a
|
||||
storage or distribution medium, is called an "aggregate" if the
|
||||
copyright resulting from the compilation is not used to limit the
|
||||
legal rights of the compilation's users beyond what the individual
|
||||
works permit. When the Document is included in an aggregate, this
|
||||
License does not apply to the other works in the aggregate which
|
||||
are not themselves derivative works of the Document.
|
||||
|
||||
If the Cover Text requirement of section 3 is applicable to these
|
||||
copies of the Document, then if the Document is less than one half
|
||||
of the entire aggregate, the Document's Cover Texts may be placed
|
||||
on covers that bracket the Document within the aggregate, or the
|
||||
electronic equivalent of covers if the Document is in electronic
|
||||
form. Otherwise they must appear on printed covers that bracket
|
||||
the whole aggregate.
|
||||
|
||||
8. TRANSLATION
|
||||
|
||||
Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section
|
||||
4. Replacing Invariant Sections with translations requires special
|
||||
permission from their copyright holders, but you may include
|
||||
translations of some or all Invariant Sections in addition to the
|
||||
original versions of these Invariant Sections. You may include a
|
||||
translation of this License, and all the license notices in the
|
||||
Document, and any Warranty Disclaimers, provided that you also
|
||||
include the original English version of this License and the
|
||||
original versions of those notices and disclaimers. In case of a
|
||||
disagreement between the translation and the original version of
|
||||
this License or a notice or disclaimer, the original version will
|
||||
prevail.
|
||||
|
||||
If a section in the Document is Entitled "Acknowledgements",
|
||||
"Dedications", or "History", the requirement (section 4) to
|
||||
Preserve its Title (section 1) will typically require changing the
|
||||
actual title.
|
||||
|
||||
9. TERMINATION
|
||||
|
||||
You may not copy, modify, sublicense, or distribute the Document
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense, or distribute it is void,
|
||||
and will automatically terminate your rights under this License.
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the
|
||||
copyright holder fails to notify you of the violation by some
|
||||
reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from
|
||||
that copyright holder, and you cure the violation prior to 30 days
|
||||
after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate
|
||||
the licenses of parties who have received copies or rights from you
|
||||
under this License. If your rights have been terminated and not
|
||||
permanently reinstated, receipt of a copy of some or all of the
|
||||
same material does not give you any rights to use it.
|
||||
|
||||
10. FUTURE REVISIONS OF THIS LICENSE
|
||||
|
||||
The Free Software Foundation may publish new, revised versions of
|
||||
the GNU Free Documentation License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns. See
|
||||
<http://www.gnu.org/copyleft/>.
|
||||
|
||||
Each version of the License is given a distinguishing version
|
||||
number. If the Document specifies that a particular numbered
|
||||
version of this License "or any later version" applies to it, you
|
||||
have the option of following the terms and conditions either of
|
||||
that specified version or of any later version that has been
|
||||
published (not as a draft) by the Free Software Foundation. If the
|
||||
Document does not specify a version number of this License, you may
|
||||
choose any version ever published (not as a draft) by the Free
|
||||
Software Foundation. If the Document specifies that a proxy can
|
||||
decide which future versions of this License can be used, that
|
||||
proxy's public statement of acceptance of a version permanently
|
||||
authorizes you to choose that version for the Document.
|
||||
|
||||
11. RELICENSING
|
||||
|
||||
"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
|
||||
World Wide Web server that publishes copyrightable works and also
|
||||
provides prominent facilities for anybody to edit those works. A
|
||||
public wiki that anybody can edit is an example of such a server.
|
||||
A "Massive Multiauthor Collaboration" (or "MMC") contained in the
|
||||
site means any set of copyrightable works thus published on the MMC
|
||||
site.
|
||||
|
||||
"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
|
||||
license published by Creative Commons Corporation, a not-for-profit
|
||||
corporation with a principal place of business in San Francisco,
|
||||
California, as well as future copyleft versions of that license
|
||||
published by that same organization.
|
||||
|
||||
"Incorporate" means to publish or republish a Document, in whole or
|
||||
in part, as part of another Document.
|
||||
|
||||
An MMC is "eligible for relicensing" if it is licensed under this
|
||||
License, and if all works that were first published under this
|
||||
License somewhere other than this MMC, and subsequently
|
||||
incorporated in whole or in part into the MMC, (1) had no cover
|
||||
texts or invariant sections, and (2) were thus incorporated prior
|
||||
to November 1, 2008.
|
||||
|
||||
The operator of an MMC Site may republish an MMC contained in the
|
||||
site under CC-BY-SA on the same site at any time before August 1,
|
||||
2009, provided the MMC is eligible for relicensing.
|
||||
|
||||
ADDENDUM: How to use this License for your documents
|
||||
====================================================
|
||||
|
||||
To use this License in a document you have written, include a copy of
|
||||
the License in the document and put the following copyright and license
|
||||
notices just after the title page:
|
||||
|
||||
Copyright (C) YEAR YOUR NAME.
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.3
|
||||
or any later version published by the Free Software Foundation;
|
||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
||||
Texts. A copy of the license is included in the section entitled ``GNU
|
||||
Free Documentation License''.
|
||||
|
||||
If you have Invariant Sections, Front-Cover Texts and Back-Cover
|
||||
Texts, replace the "with...Texts." line with this:
|
||||
|
||||
with the Invariant Sections being LIST THEIR TITLES, with
|
||||
the Front-Cover Texts being LIST, and with the Back-Cover Texts
|
||||
being LIST.
|
||||
|
||||
If you have Invariant Sections without Cover Texts, or some other
|
||||
combination of the three, merge those two alternatives to suit the
|
||||
situation.
|
||||
|
||||
If your document contains nontrivial examples of program code, we
|
||||
recommend releasing these examples in parallel under your choice of free
|
||||
software license, such as the GNU General Public License, to permit
|
||||
their use in free software.
|
||||
|
||||
|
||||
|
||||
Tag Table:
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
Local Variables:
|
||||
coding: utf-8
|
||||
End:
|
||||
|
|
@ -0,0 +1,721 @@
|
|||
This is gpl.info, produced by makeinfo version 6.7 from gpl.texi.
|
||||
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
========
|
||||
|
||||
The GNU General Public License is a free, copyleft license for software
|
||||
and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
====================
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public
|
||||
License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other
|
||||
kinds of works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the
|
||||
work in a fashion requiring copyright permission, other than the
|
||||
making of an exact copy. The resulting work is called a "modified
|
||||
version" of the earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work
|
||||
based on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on
|
||||
a computer or modifying a private copy. Propagation includes
|
||||
copying, distribution (with or without modification), making
|
||||
available to the public, and in some countries other activities as
|
||||
well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user
|
||||
through a computer network, with no transfer of a copy, is not
|
||||
conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to
|
||||
the extent that warranties are provided), that licensees may convey
|
||||
the work under this License, and how to view a copy of this
|
||||
License. If the interface presents a list of user commands or
|
||||
options, such as a menu, a prominent item in the list meets this
|
||||
criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an
|
||||
official standard defined by a recognized standards body, or, in
|
||||
the case of interfaces specified for a particular programming
|
||||
language, one that is widely used among developers working in that
|
||||
language.
|
||||
|
||||
The "System Libraries" of an executable work include anything,
|
||||
other than the work as a whole, that (a) is included in the normal
|
||||
form of packaging a Major Component, but which is not part of that
|
||||
Major Component, and (b) serves only to enable use of the work with
|
||||
that Major Component, or to implement a Standard Interface for
|
||||
which an implementation is available to the public in source code
|
||||
form. A "Major Component", in this context, means a major
|
||||
essential component (kernel, window system, and so on) of the
|
||||
specific operating system (if any) on which the executable work
|
||||
runs, or a compiler used to produce the work, or an object code
|
||||
interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts
|
||||
to control those activities. However, it does not include the
|
||||
work's System Libraries, or general-purpose tools or generally
|
||||
available free programs which are used unmodified in performing
|
||||
those activities but which are not part of the work. For example,
|
||||
Corresponding Source includes interface definition files associated
|
||||
with source files for the work, and the source code for shared
|
||||
libraries and dynamically linked subprograms that the work is
|
||||
specifically designed to require, such as by intimate data
|
||||
communication or control flow between those subprograms and other
|
||||
parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can
|
||||
regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running
|
||||
a covered work is covered by this License only if the output, given
|
||||
its content, constitutes a covered work. This License acknowledges
|
||||
your rights of fair use or other equivalent, as provided by
|
||||
copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise
|
||||
remains in force. You may convey covered works to others for the
|
||||
sole purpose of having them make modifications exclusively for you,
|
||||
or provide you with facilities for running those works, provided
|
||||
that you comply with the terms of this License in conveying all
|
||||
material for which you do not control copyright. Those thus making
|
||||
or running the covered works for you must do so exclusively on your
|
||||
behalf, under your direction and control, on terms that prohibit
|
||||
them from making any copies of your copyrighted material outside
|
||||
their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section
|
||||
10 makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under
|
||||
article 11 of the WIPO copyright treaty adopted on 20 December
|
||||
1996, or similar laws prohibiting or restricting circumvention of
|
||||
such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such
|
||||
circumvention is effected by exercising rights under this License
|
||||
with respect to the covered work, and you disclaim any intention to
|
||||
limit operation or modification of the work as a means of
|
||||
enforcing, against the work's users, your or third parties' legal
|
||||
rights to forbid circumvention of technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the
|
||||
code; keep intact all notices of the absence of any warranty; and
|
||||
give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these
|
||||
conditions:
|
||||
|
||||
a. The work must carry prominent notices stating that you
|
||||
modified it, and giving a relevant date.
|
||||
|
||||
b. The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under
|
||||
section 7. This requirement modifies the requirement in
|
||||
section 4 to "keep intact all notices".
|
||||
|
||||
c. You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable
|
||||
section 7 additional terms, to the whole of the work, and all
|
||||
its parts, regardless of how they are packaged. This License
|
||||
gives no permission to license the work in any other way, but
|
||||
it does not invalidate such permission if you have separately
|
||||
received it.
|
||||
|
||||
d. If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has
|
||||
interactive interfaces that do not display Appropriate Legal
|
||||
Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered
|
||||
work, and which are not combined with it such as to form a larger
|
||||
program, in or on a volume of a storage or distribution medium, is
|
||||
called an "aggregate" if the compilation and its resulting
|
||||
copyright are not used to limit the access or legal rights of the
|
||||
compilation's users beyond what the individual works permit.
|
||||
Inclusion of a covered work in an aggregate does not cause this
|
||||
License to apply to the other parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this
|
||||
License, in one of these ways:
|
||||
|
||||
a. Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b. Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that
|
||||
product model, to give anyone who possesses the object code
|
||||
either (1) a copy of the Corresponding Source for all the
|
||||
software in the product that is covered by this License, on a
|
||||
durable physical medium customarily used for software
|
||||
interchange, for a price no more than your reasonable cost of
|
||||
physically performing this conveying of source, or (2) access
|
||||
to copy the Corresponding Source from a network server at no
|
||||
charge.
|
||||
|
||||
c. Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially,
|
||||
and only if you received the object code with such an offer,
|
||||
in accord with subsection 6b.
|
||||
|
||||
d. Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to
|
||||
the Corresponding Source in the same way through the same
|
||||
place at no further charge. You need not require recipients
|
||||
to copy the Corresponding Source along with the object code.
|
||||
If the place to copy the object code is a network server, the
|
||||
Corresponding Source may be on a different server (operated by
|
||||
you or a third party) that supports equivalent copying
|
||||
facilities, provided you maintain clear directions next to the
|
||||
object code saying where to find the Corresponding Source.
|
||||
Regardless of what server hosts the Corresponding Source, you
|
||||
remain obligated to ensure that it is available for as long as
|
||||
needed to satisfy these requirements.
|
||||
|
||||
e. Convey the object code using peer-to-peer transmission,
|
||||
provided you inform other peers where the object code and
|
||||
Corresponding Source of the work are being offered to the
|
||||
general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is
|
||||
excluded from the Corresponding Source as a System Library, need
|
||||
not be included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means
|
||||
any tangible personal property which is normally used for personal,
|
||||
family, or household purposes, or (2) anything designed or sold for
|
||||
incorporation into a dwelling. In determining whether a product is
|
||||
a consumer product, doubtful cases shall be resolved in favor of
|
||||
coverage. For a particular product received by a particular user,
|
||||
"normally used" refers to a typical or common use of that class of
|
||||
product, regardless of the status of the particular user or of the
|
||||
way in which the particular user actually uses, or expects or is
|
||||
expected to use, the product. A product is a consumer product
|
||||
regardless of whether the product has substantial commercial,
|
||||
industrial or non-consumer uses, unless such uses represent the
|
||||
only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to
|
||||
install and execute modified versions of a covered work in that
|
||||
User Product from a modified version of its Corresponding Source.
|
||||
The information must suffice to ensure that the continued
|
||||
functioning of the modified object code is in no case prevented or
|
||||
interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with,
|
||||
or specifically for use in, a User Product, and the conveying
|
||||
occurs as part of a transaction in which the right of possession
|
||||
and use of the User Product is transferred to the recipient in
|
||||
perpetuity or for a fixed term (regardless of how the transaction
|
||||
is characterized), the Corresponding Source conveyed under this
|
||||
section must be accompanied by the Installation Information. But
|
||||
this requirement does not apply if neither you nor any third party
|
||||
retains the ability to install modified object code on the User
|
||||
Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not
|
||||
include a requirement to continue to provide support service,
|
||||
warranty, or updates for a work that has been modified or installed
|
||||
by the recipient, or for the User Product in which it has been
|
||||
modified or installed. Access to a network may be denied when the
|
||||
modification itself materially and adversely affects the operation
|
||||
of the network or violates the rules and protocols for
|
||||
communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information
|
||||
provided, in accord with this section must be in a format that is
|
||||
publicly documented (and with an implementation available to the
|
||||
public in source code form), and must require no special password
|
||||
or key for unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of
|
||||
this License by making exceptions from one or more of its
|
||||
conditions. Additional permissions that are applicable to the
|
||||
entire Program shall be treated as though they were included in
|
||||
this License, to the extent that they are valid under applicable
|
||||
law. If additional permissions apply only to part of the Program,
|
||||
that part may be used separately under those permissions, but the
|
||||
entire Program remains governed by this License without regard to
|
||||
the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part
|
||||
of it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material
|
||||
you add to a covered work, you may (if authorized by the copyright
|
||||
holders of that material) supplement the terms of this License with
|
||||
terms:
|
||||
|
||||
a. Disclaiming warranty or limiting liability differently from
|
||||
the terms of sections 15 and 16 of this License; or
|
||||
|
||||
b. Requiring preservation of specified reasonable legal notices
|
||||
or author attributions in that material or in the Appropriate
|
||||
Legal Notices displayed by works containing it; or
|
||||
|
||||
c. Prohibiting misrepresentation of the origin of that material,
|
||||
or requiring that modified versions of such material be marked
|
||||
in reasonable ways as different from the original version; or
|
||||
|
||||
d. Limiting the use for publicity purposes of names of licensors
|
||||
or authors of the material; or
|
||||
|
||||
e. Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f. Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified
|
||||
versions of it) with contractual assumptions of liability to
|
||||
the recipient, for any liability that these contractual
|
||||
assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as
|
||||
you received it, or any part of it, contains a notice stating that
|
||||
it is governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document
|
||||
contains a further restriction but permits relicensing or conveying
|
||||
under this License, you may add to a covered work material governed
|
||||
by the terms of that license document, provided that the further
|
||||
restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in
|
||||
the form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights
|
||||
under this License (including any patent licenses granted under the
|
||||
third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the
|
||||
copyright holder fails to notify you of the violation by some
|
||||
reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from
|
||||
that copyright holder, and you cure the violation prior to 30 days
|
||||
after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate
|
||||
the licenses of parties who have received copies or rights from you
|
||||
under this License. If your rights have been terminated and not
|
||||
permanently reinstated, you do not qualify to receive new licenses
|
||||
for the same material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer
|
||||
transmission to receive a copy likewise does not require
|
||||
acceptance. However, nothing other than this License grants you
|
||||
permission to propagate or modify any covered work. These actions
|
||||
infringe copyright if you do not accept this License. Therefore,
|
||||
by modifying or propagating a covered work, you indicate your
|
||||
acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not
|
||||
responsible for enforcing compliance by third parties with this
|
||||
License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a
|
||||
covered work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or
|
||||
could give under the previous paragraph, plus a right to possession
|
||||
of the Corresponding Source of the work from the predecessor in
|
||||
interest, if the predecessor has it or can get it with reasonable
|
||||
efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you
|
||||
may not impose a license fee, royalty, or other charge for exercise
|
||||
of rights granted under this License, and you may not initiate
|
||||
litigation (including a cross-claim or counterclaim in a lawsuit)
|
||||
alleging that any patent claim is infringed by making, using,
|
||||
selling, offering for sale, or importing the Program or any portion
|
||||
of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based.
|
||||
The work thus licensed is called the contributor's "contributor
|
||||
version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner,
|
||||
permitted by this License, of making, using, or selling its
|
||||
contributor version, but do not include claims that would be
|
||||
infringed only as a consequence of further modification of the
|
||||
contributor version. For purposes of this definition, "control"
|
||||
includes the right to grant patent sublicenses in a manner
|
||||
consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide,
|
||||
royalty-free patent license under the contributor's essential
|
||||
patent claims, to make, use, sell, offer for sale, import and
|
||||
otherwise run, modify and propagate the contents of its contributor
|
||||
version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any
|
||||
express agreement or commitment, however denominated, not to
|
||||
enforce a patent (such as an express permission to practice a
|
||||
patent or covenant not to sue for patent infringement). To "grant"
|
||||
such a patent license to a party means to make such an agreement or
|
||||
commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent
|
||||
license, and the Corresponding Source of the work is not available
|
||||
for anyone to copy, free of charge and under the terms of this
|
||||
License, through a publicly available network server or other
|
||||
readily accessible means, then you must either (1) cause the
|
||||
Corresponding Source to be so available, or (2) arrange to deprive
|
||||
yourself of the benefit of the patent license for this particular
|
||||
work, or (3) arrange, in a manner consistent with the requirements
|
||||
of this License, to extend the patent license to downstream
|
||||
recipients. "Knowingly relying" means you have actual knowledge
|
||||
that, but for the patent license, your conveying the covered work
|
||||
in a country, or your recipient's use of the covered work in a
|
||||
country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate,
|
||||
modify or convey a specific copy of the covered work, then the
|
||||
patent license you grant is automatically extended to all
|
||||
recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that
|
||||
are specifically granted under this License. You may not convey a
|
||||
covered work if you are a party to an arrangement with a third
|
||||
party that is in the business of distributing software, under which
|
||||
you make payment to the third party based on the extent of your
|
||||
activity of conveying the work, and under which the third party
|
||||
grants, to any of the parties who would receive the covered work
|
||||
from you, a discriminatory patent license (a) in connection with
|
||||
copies of the covered work conveyed by you (or copies made from
|
||||
those copies), or (b) primarily for and in connection with specific
|
||||
products or compilations that contain the covered work, unless you
|
||||
entered into that arrangement, or that patent license was granted,
|
||||
prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement
|
||||
or otherwise) that contradict the conditions of this License, they
|
||||
do not excuse you from the conditions of this License. If you
|
||||
cannot convey a covered work so as to satisfy simultaneously your
|
||||
obligations under this License and any other pertinent obligations,
|
||||
then as a consequence you may not convey it at all. For example,
|
||||
if you agree to terms that obligate you to collect a royalty for
|
||||
further conveying from those to whom you convey the Program, the
|
||||
only way you could satisfy both those terms and this License would
|
||||
be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a
|
||||
single combined work, and to convey the resulting work. The terms
|
||||
of this License will continue to apply to the part which is the
|
||||
covered work, but the special requirements of the GNU Affero
|
||||
General Public License, section 13, concerning interaction through
|
||||
a network will apply to the combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new
|
||||
versions of the GNU General Public License from time to time. Such
|
||||
new versions will be similar in spirit to the present version, but
|
||||
may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU
|
||||
General Public License "or any later version" applies to it, you
|
||||
have the option of following the terms and conditions either of
|
||||
that numbered version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version
|
||||
number of the GNU General Public License, you may choose any
|
||||
version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that
|
||||
proxy's public statement of acceptance of a version permanently
|
||||
authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
|
||||
COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
|
||||
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
|
||||
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
|
||||
RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
|
||||
SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
|
||||
NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
|
||||
AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
|
||||
DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
|
||||
THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
|
||||
BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
|
||||
THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely
|
||||
approximates an absolute waiver of all civil liability in
|
||||
connection with the Program, unless a warranty or assumption of
|
||||
liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
===========================
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
=============================================
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these
|
||||
terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
|
||||
Copyright (C) YEAR NAME OF AUTHOR
|
||||
|
||||
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 3 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, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper
|
||||
mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
PROGRAM Copyright (C) YEAR NAME OF AUTHOR
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type 'show c' for details.
|
||||
|
||||
The hypothetical commands 'show w' and 'show c' should show the
|
||||
appropriate parts of the General Public License. Of course, your
|
||||
program's commands might be different; for a GUI interface, you would
|
||||
use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. For more information on this, and how to apply and follow
|
||||
the GNU GPL, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your
|
||||
program into proprietary programs. If your program is a subroutine
|
||||
library, you may consider it more useful to permit linking proprietary
|
||||
applications with the library. If this is what you want to do, use the
|
||||
GNU Lesser General Public License instead of this License. But first,
|
||||
please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
||||
|
||||
Tag Table:
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
Local Variables:
|
||||
coding: utf-8
|
||||
End:
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
;;; web-server-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
|
||||
;;
|
||||
;;; Code:
|
||||
|
||||
(add-to-list 'load-path (directory-file-name
|
||||
(or (file-name-directory #$) (car load-path))))
|
||||
|
||||
|
||||
;;;### (autoloads nil "web-server" "web-server.el" (0 0 0 0))
|
||||
;;; Generated autoloads from web-server.el
|
||||
|
||||
(autoload 'ws-start "web-server" "\
|
||||
Start a server using HANDLERS and return the server object.
|
||||
|
||||
HANDLERS may be a single function (which is then called on every
|
||||
request) or a list of conses of the form (MATCHER . FUNCTION),
|
||||
where the FUNCTION associated with the first successful MATCHER
|
||||
is called. Handler functions are called with two arguments, the
|
||||
process and the request object.
|
||||
|
||||
A MATCHER may be either a function (in which case it is called on
|
||||
the request object) or a cons cell of the form (KEYWORD . STRING)
|
||||
in which case STRING is matched against the value of the header
|
||||
specified by KEYWORD.
|
||||
|
||||
Any supplied NETWORK-ARGS are assumed to be keyword arguments for
|
||||
`make-network-process' to which they are passed directly.
|
||||
|
||||
For example, the following starts a simple hello-world server on
|
||||
port 8080.
|
||||
|
||||
(ws-start
|
||||
(lambda (request)
|
||||
(with-slots (process headers) request
|
||||
(process-send-string process
|
||||
\"HTTP/1.1 200 OK\\r\\nContent-Type: text/plain\\r\\n\\r\\nhello world\")))
|
||||
8080)
|
||||
|
||||
Equivalently, the following starts an identical server using a
|
||||
function MATCH and the `ws-response-header' convenience
|
||||
function.
|
||||
|
||||
(ws-start
|
||||
`(((lambda (_) t) .
|
||||
(lambda (request)
|
||||
(with-slots ((proc process)) request
|
||||
(ws-response-header proc 200 '(\"Content-Type\" . \"text/plain\"))
|
||||
(process-send-string proc \"hello world\")))))
|
||||
8080)
|
||||
|
||||
\(fn HANDLERS PORT &optional LOG-BUFFER &rest NETWORK-ARGS)" nil nil)
|
||||
|
||||
(register-definition-prefixes "web-server" '("ws-"))
|
||||
|
||||
;;;***
|
||||
|
||||
;;;### (autoloads nil "web-server-status-codes" "web-server-status-codes.el"
|
||||
;;;;;; (0 0 0 0))
|
||||
;;; Generated autoloads from web-server-status-codes.el
|
||||
|
||||
(register-definition-prefixes "web-server-status-codes" '("ws-status-codes"))
|
||||
|
||||
;;;***
|
||||
|
||||
;;;### (autoloads nil nil ("web-server-pkg.el") (0 0 0 0))
|
||||
|
||||
;;;***
|
||||
|
||||
;; Local Variables:
|
||||
;; version-control: never
|
||||
;; no-byte-compile: t
|
||||
;; no-update-autoloads: t
|
||||
;; coding: utf-8
|
||||
;; End:
|
||||
;;; web-server-autoloads.el ends here
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
(define-package "web-server" "20210708.2242" "Emacs Web Server"
|
||||
'((emacs "24.1")
|
||||
(cl-lib "0.6"))
|
||||
:commit "6357a1c2d1718778503f7ee0909585094117525b" :authors
|
||||
'(("Eric Schulte" . "schulte.eric@gmail.com"))
|
||||
:maintainer
|
||||
'("Eric Schulte" . "schulte.eric@gmail.com")
|
||||
:keywords
|
||||
'("http" "server" "network")
|
||||
:url "https://github.com/eschulte/emacs-web-server")
|
||||
;; Local Variables:
|
||||
;; no-byte-compile: t
|
||||
;; End:
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
;;; web-server-status-codes.el --- Emacs Web Server HTML status codes -*- lexical-binding: t; -*-
|
||||
|
||||
;; Copyright (C) 2013-2021 Free Software Foundation, Inc.
|
||||
|
||||
;; This software 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 3 of the License, or
|
||||
;; (at your option) any later version.
|
||||
|
||||
;; This software 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Code:
|
||||
(defvar ws-status-codes
|
||||
'((100 . "Continue")
|
||||
(101 . "Switching Protocols")
|
||||
(102 . "Processing")
|
||||
(200 . "OK")
|
||||
(201 . "Created")
|
||||
(202 . "Accepted")
|
||||
(203 . "Non-Authoritative Information")
|
||||
(204 . "No Content")
|
||||
(205 . "Reset Content")
|
||||
(206 . "Partial Content")
|
||||
(207 . "Multi-Status")
|
||||
(208 . "Already Reported")
|
||||
(226 . "IM Used")
|
||||
(300 . "Multiple Choices")
|
||||
(301 . "Moved Permanently")
|
||||
(302 . "Found")
|
||||
(303 . "See Other")
|
||||
(304 . "Not Modified")
|
||||
(305 . "Use Proxy")
|
||||
(306 . "Switch Proxy")
|
||||
(307 . "Temporary Redirect")
|
||||
(308 . "Permanent Redirect")
|
||||
(400 . "Bad Request")
|
||||
(401 . "Unauthorized")
|
||||
(402 . "Payment Required")
|
||||
(403 . "Forbidden")
|
||||
(404 . "Not Found")
|
||||
(405 . "Method Not Allowed")
|
||||
(406 . "Not Acceptable")
|
||||
(407 . "Proxy Authentication Required")
|
||||
(408 . "Request Timeout")
|
||||
(409 . "Conflict")
|
||||
(410 . "Gone")
|
||||
(411 . "Length Required")
|
||||
(412 . "Precondition Failed")
|
||||
(413 . "Request Entity Too Large")
|
||||
(414 . "Request-URI Too Long")
|
||||
(415 . "Unsupported Media Type")
|
||||
(416 . "Requested Range Not Satisfiable")
|
||||
(417 . "Expectation Failed")
|
||||
(418 . "I'm a teapot")
|
||||
(419 . "Authentication Timeout")
|
||||
(420 . "Method Failure")
|
||||
(420 . "Enhance Your Calm")
|
||||
(422 . "Unprocessable Entity")
|
||||
(423 . "Locked")
|
||||
(424 . "Failed Dependency")
|
||||
(424 . "Method Failure")
|
||||
(425 . "Unordered Collection")
|
||||
(426 . "Upgrade Required")
|
||||
(428 . "Precondition Required")
|
||||
(429 . "Too Many Requests")
|
||||
(431 . "Request Header Fields Too Large")
|
||||
(440 . "Login Timeout")
|
||||
(444 . "No Response")
|
||||
(449 . "Retry With")
|
||||
(450 . "Blocked by Windows Parental Controls")
|
||||
(451 . "Unavailable For Legal Reasons")
|
||||
(451 . "Redirect")
|
||||
(494 . "Request Header Too Large")
|
||||
(495 . "Cert Error")
|
||||
(496 . "No Cert")
|
||||
(497 . "HTTP to HTTPS")
|
||||
(499 . "Client Closed Request")
|
||||
(500 . "Internal Server Error")
|
||||
(501 . "Not Implemented")
|
||||
(502 . "Bad Gateway")
|
||||
(503 . "Service Unavailable")
|
||||
(504 . "Gateway Timeout")
|
||||
(505 . "HTTP Version Not Supported")
|
||||
(506 . "Variant Also Negotiates")
|
||||
(507 . "Insufficient Storage")
|
||||
(508 . "Loop Detected")
|
||||
(509 . "Bandwidth Limit Exceeded")
|
||||
(510 . "Not Extended")
|
||||
(511 . "Network Authentication Required")
|
||||
(520 . "Origin Error")
|
||||
(522 . "Connection timed out")
|
||||
(523 . "Proxy Declined Request")
|
||||
(524 . "A timeout occurred")
|
||||
(598 . "Network read timeout error")
|
||||
(599 . "Network connect timeout error"))
|
||||
"Possible HTML status codes with names.
|
||||
From http://en.wikipedia.org/wiki/List_of_HTTP_status_codes.")
|
||||
|
||||
(provide 'web-server-status-codes)
|
||||
;;; web-server-status-codes.el ends here
|
||||
|
|
@ -0,0 +1,749 @@
|
|||
;;; web-server.el --- Emacs Web Server -*- lexical-binding: t -*-
|
||||
|
||||
;; Copyright (C) 2013-2014 Free Software Foundation, Inc.
|
||||
|
||||
;; Author: Eric Schulte <schulte.eric@gmail.com>
|
||||
;; Maintainer: Eric Schulte <schulte.eric@gmail.com>
|
||||
;; Version: 0.1.2
|
||||
;; Package-Requires: ((emacs "24.1") (cl-lib "0.6"))
|
||||
;; Keywords: http, server, network
|
||||
;; URL: https://github.com/eschulte/emacs-web-server
|
||||
|
||||
;; This software 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 3 of the License, or
|
||||
;; (at your option) any later version.
|
||||
|
||||
;; This software 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
;; A web server in Emacs running handlers written in Emacs Lisp.
|
||||
;;
|
||||
;; Full support for GET and POST requests including URL-encoded
|
||||
;; parameters and multipart/form data. Supports web sockets.
|
||||
;;
|
||||
;; See the examples/ directory for examples demonstrating the usage of
|
||||
;; the Emacs Web Server. The following launches a simple "hello
|
||||
;; world" server.
|
||||
;;
|
||||
;; (ws-start
|
||||
;; '(((lambda (_) t) . ; match every request
|
||||
;; (lambda (request) ; reply with "hello world"
|
||||
;; (with-slots (process) request
|
||||
;; (ws-response-header process 200 '("Content-type" . "text/plain"))
|
||||
;; (process-send-string process "hello world")))))
|
||||
;; 9000)
|
||||
|
||||
;;; Code:
|
||||
(require 'web-server-status-codes)
|
||||
(require 'mail-parse) ; to parse multipart data in headers
|
||||
(require 'mm-encode) ; to look-up mime types for files
|
||||
(require 'url-util) ; to decode url-encoded params
|
||||
(require 'eieio)
|
||||
(require 'cl-lib)
|
||||
|
||||
(defclass ws-server ()
|
||||
((handlers :initarg :handlers :accessor ws-handlers :initform nil)
|
||||
(process :initarg :process :accessor ws-process :initform nil)
|
||||
(port :initarg :port :accessor ws-port :initform nil)
|
||||
(requests :initarg :requests :accessor ws-requests :initform nil)))
|
||||
|
||||
(defclass ws-request ()
|
||||
((process :initarg :process :accessor ws-process :initform nil)
|
||||
(pending :initarg :pending :accessor ws-pending :initform "")
|
||||
(context :initarg :context :accessor ws-context :initform nil)
|
||||
(boundary :initarg :boundary :accessor ws-boundary :initform nil)
|
||||
(index :initarg :index :accessor ws-index :initform 0)
|
||||
(active :initarg :active :accessor ws-active :initform nil)
|
||||
(headers :initarg :headers :accessor ws-headers :initform (list nil))
|
||||
(body :initarg :body :accessor ws-body :initform "")))
|
||||
|
||||
(defvar ws-servers nil
|
||||
"List holding all web servers.")
|
||||
|
||||
(defvar ws-log-time-format "%Y.%m.%d.%H.%M.%S.%N"
|
||||
"Logging time format passed to `format-time-string'.")
|
||||
|
||||
(defvar ws-guid "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
|
||||
"This GUID is defined in RFC6455.")
|
||||
|
||||
;;;###autoload
|
||||
(defun ws-start (handlers port &optional log-buffer &rest network-args)
|
||||
"Start a server using HANDLERS and return the server object.
|
||||
|
||||
HANDLERS may be a single function (which is then called on every
|
||||
request) or a list of conses of the form (MATCHER . FUNCTION),
|
||||
where the FUNCTION associated with the first successful MATCHER
|
||||
is called. Handler functions are called with two arguments, the
|
||||
process and the request object.
|
||||
|
||||
A MATCHER may be either a function (in which case it is called on
|
||||
the request object) or a cons cell of the form (KEYWORD . STRING)
|
||||
in which case STRING is matched against the value of the header
|
||||
specified by KEYWORD.
|
||||
|
||||
Any supplied NETWORK-ARGS are assumed to be keyword arguments for
|
||||
`make-network-process' to which they are passed directly.
|
||||
|
||||
For example, the following starts a simple hello-world server on
|
||||
port 8080.
|
||||
|
||||
(ws-start
|
||||
(lambda (request)
|
||||
(with-slots (process headers) request
|
||||
(process-send-string process
|
||||
\"HTTP/1.1 200 OK\\r\\nContent-Type: text/plain\\r\\n\\r\\nhello world\")))
|
||||
8080)
|
||||
|
||||
Equivalently, the following starts an identical server using a
|
||||
function MATCH and the `ws-response-header' convenience
|
||||
function.
|
||||
|
||||
(ws-start
|
||||
`(((lambda (_) t) .
|
||||
(lambda (request)
|
||||
(with-slots ((proc process)) request
|
||||
(ws-response-header proc 200 '(\"Content-Type\" . \"text/plain\"))
|
||||
(process-send-string proc \"hello world\")))))
|
||||
8080)
|
||||
|
||||
"
|
||||
(let ((server (make-instance 'ws-server :handlers handlers :port port))
|
||||
(log (when log-buffer (get-buffer-create log-buffer))))
|
||||
(setf (ws-process server)
|
||||
(apply
|
||||
#'make-network-process
|
||||
:name "ws-server"
|
||||
:service (ws-port server)
|
||||
:filter 'ws-filter
|
||||
:server t
|
||||
:nowait (< emacs-major-version 26)
|
||||
:family 'ipv4
|
||||
:coding 'no-conversion
|
||||
:plist (append (list :server server)
|
||||
(when log (list :log-buffer log)))
|
||||
:log (when log
|
||||
(lambda (proc request message)
|
||||
(let ((c (process-contact request))
|
||||
(buf (plist-get (process-plist proc) :log-buffer)))
|
||||
(with-current-buffer buf
|
||||
(goto-char (point-max))
|
||||
(insert (format "%s\t%s\t%s\t%s"
|
||||
(format-time-string ws-log-time-format)
|
||||
(cl-first c) (cl-second c) message))))))
|
||||
network-args))
|
||||
(push server ws-servers)
|
||||
server))
|
||||
|
||||
(defun ws-stop (server)
|
||||
"Stop SERVER."
|
||||
(setq ws-servers (remove server ws-servers))
|
||||
(mapc #'delete-process (append (mapcar #'ws-process (ws-requests server))
|
||||
(list (ws-process server)))))
|
||||
|
||||
(defun ws-stop-all ()
|
||||
"Stop all servers in `ws-servers'."
|
||||
(interactive)
|
||||
(mapc #'ws-stop ws-servers))
|
||||
|
||||
(defvar ws-http-common-methods '(GET HEAD POST PUT DELETE TRACE)
|
||||
"HTTP methods from http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.")
|
||||
|
||||
(defvar ws-http-method-rx
|
||||
(format "^\\(%s\\) \\([^[:space:]]+\\) \\([^[:space:]]+\\)$"
|
||||
(mapconcat #'symbol-name ws-http-common-methods "\\|")))
|
||||
|
||||
(defun ws-parse-query-string (string)
|
||||
"Thin wrapper around `url-parse-query-string'."
|
||||
(mapcar (lambda (pair) (cons (cl-first pair) (cl-second pair)))
|
||||
(url-parse-query-string string nil 'allow-newlines)))
|
||||
|
||||
(defun ws-parse (proc string)
|
||||
"Parse HTTP headers in STRING reporting errors to PROC."
|
||||
(cl-flet ((to-keyword (s) (intern (concat ":" (upcase s)))))
|
||||
(cond
|
||||
;; Method
|
||||
((string-match ws-http-method-rx string)
|
||||
(let ((method (to-keyword (match-string 1 string)))
|
||||
(url (match-string 2 string)))
|
||||
(if (string-match "?" url)
|
||||
(cons (cons method (substring url 0 (match-beginning 0)))
|
||||
(ws-parse-query-string
|
||||
(url-unhex-string (substring url (match-end 0)))))
|
||||
(list (cons method url)))))
|
||||
;; Authorization
|
||||
((string-match "^AUTHORIZATION: \\([^[:space:]]+\\) \\(.*\\)$" string)
|
||||
(let ((protocol (to-keyword (match-string 1 string)))
|
||||
(credentials (match-string 2 string)))
|
||||
(list (cons :AUTHORIZATION
|
||||
(cons protocol
|
||||
(cl-case protocol
|
||||
(:BASIC
|
||||
(let ((cred (base64-decode-string credentials)))
|
||||
(if (string-match ":" cred)
|
||||
(cons (substring cred 0 (match-beginning 0))
|
||||
(substring cred (match-end 0)))
|
||||
(ws-error proc "bad credentials: %S" cred))))
|
||||
(t (ws-error proc "un-support protocol: %s"
|
||||
protocol))))))))
|
||||
;; All other headers
|
||||
((string-match "^\\([^[:space:]]+\\): \\(.*\\)$" string)
|
||||
(list (cons (to-keyword (match-string 1 string))
|
||||
(match-string 2 string))))
|
||||
(:otherwise (ws-error proc "bad header: %S" string) nil))))
|
||||
|
||||
(defun ws-trim (string)
|
||||
(while (and (> (length string) 0)
|
||||
(or (and (string-match "[\r\n]" (substring string -1))
|
||||
(setq string (substring string 0 -1)))
|
||||
(and (string-match "[\r\n]" (substring string 0 1))
|
||||
(setq string (substring string 1))))))
|
||||
string)
|
||||
|
||||
(defun ws-parse-multipart/form (proc string)
|
||||
;; ignore empty and non-content blocks
|
||||
(when (string-match "Content-Disposition:[[:space:]]*\\(.*\\)\r\n" string)
|
||||
(let ((dp (cdr (mail-header-parse-content-disposition
|
||||
(match-string 1 string))))
|
||||
(last-index (match-end 0))
|
||||
index)
|
||||
;; every line up until the double \r\n is a header
|
||||
(while (and (setq index (string-match "\r\n" string last-index))
|
||||
(not (= index last-index)))
|
||||
(setcdr (last dp) (ws-parse proc (substring string last-index index)))
|
||||
(setq last-index (+ 2 index)))
|
||||
;; after double \r\n is all content
|
||||
(cons (cdr (assoc 'name dp))
|
||||
(cons (cons 'content (substring string (+ 2 last-index)))
|
||||
dp)))))
|
||||
|
||||
(defun ws-filter (proc string)
|
||||
(with-slots (handlers requests) (plist-get (process-plist proc) :server)
|
||||
(unless (cl-find-if (lambda (c) (equal proc (ws-process c))) requests)
|
||||
(push (make-instance 'ws-request :process proc) requests))
|
||||
(let ((request (cl-find-if (lambda (c) (equal proc (ws-process c))) requests)))
|
||||
(with-slots (pending) request (setq pending (concat pending string)))
|
||||
(unless (ws-active request) ; don't re-start if request is being parsed
|
||||
(setf (ws-active request) t)
|
||||
(when (not (eq (catch 'close-connection
|
||||
(if (ws-parse-request request)
|
||||
(ws-call-handler request handlers)
|
||||
:keep-alive))
|
||||
:keep-alive))
|
||||
;; Properly shut down processes requiring an ending (e.g., chunked)
|
||||
(let ((ender (plist-get (process-plist proc) :ender)))
|
||||
(when ender (process-send-string proc ender)))
|
||||
(setq requests (cl-remove-if (lambda (r) (eql proc (ws-process r))) requests))
|
||||
(delete-process proc))))))
|
||||
|
||||
(defun ws-parse-request (request)
|
||||
"Parse request STRING from REQUEST with process PROC.
|
||||
Return non-nil only when parsing is complete."
|
||||
(catch 'finished-parsing-headers
|
||||
(with-slots (process pending context boundary headers body index) request
|
||||
(let ((delimiter (concat "\r\n" (if boundary (concat "--" boundary) "")))
|
||||
;; Track progress through string, always work with the
|
||||
;; section of string between INDEX and NEXT-INDEX.
|
||||
next-index
|
||||
body-stored)
|
||||
;; parse headers and append to request
|
||||
(while (setq next-index (string-match delimiter pending index))
|
||||
(let ((tmp (+ next-index (length delimiter))))
|
||||
(if (= index next-index) ; double \r\n ends current run of headers
|
||||
(progn
|
||||
;; Store the body
|
||||
(unless
|
||||
;; Multipart form data has multiple passes - store on
|
||||
;; first pass only.
|
||||
body-stored
|
||||
(let ((after-headers (substring pending index)))
|
||||
(when (string-prefix-p "\r\n" after-headers)
|
||||
(setq body
|
||||
;; Trim off the additional CRLF
|
||||
(substring after-headers 2))))
|
||||
(setq body-stored t))
|
||||
(cl-case context
|
||||
;; Parse URL data.
|
||||
;; http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4
|
||||
(application/x-www-form-urlencoded
|
||||
(mapc (lambda (pair) (setcdr (last headers) (list pair)))
|
||||
(ws-parse-query-string
|
||||
(replace-regexp-in-string
|
||||
"\\+" " "
|
||||
(ws-trim (substring pending index)))))
|
||||
(throw 'finished-parsing-headers t))
|
||||
;; Set custom delimiter for multipart form data.
|
||||
(multipart/form-data
|
||||
(setq delimiter (concat "\r\n--" boundary)))
|
||||
;; No special context so we're done.
|
||||
(t (throw 'finished-parsing-headers t))))
|
||||
(if (eql context 'multipart/form-data)
|
||||
(progn
|
||||
(setcdr (last headers)
|
||||
(list (ws-parse-multipart/form process
|
||||
(substring pending index next-index))))
|
||||
;; Boundary suffixed by "--" indicates end of the headers.
|
||||
(when (and (> (length pending) (+ tmp 2))
|
||||
(string= (substring pending tmp (+ tmp 2)) "--"))
|
||||
(throw 'finished-parsing-headers t)))
|
||||
;; Standard header parsing.
|
||||
(let ((header (ws-parse process (substring pending
|
||||
index next-index))))
|
||||
;; Content-Type indicates that the next double \r\n
|
||||
;; will be followed by a special type of content which
|
||||
;; will require special parsing. Thus we will note
|
||||
;; the type in the CONTEXT variable for parsing
|
||||
;; dispatch above.
|
||||
(when (and (caar header) (eql (caar header) :CONTENT-TYPE))
|
||||
(cl-destructuring-bind (type &rest data)
|
||||
(mail-header-parse-content-type (cdar header))
|
||||
(setq boundary (cdr (assoc 'boundary data)))
|
||||
(setq context (intern (downcase type)))))
|
||||
;; All other headers are collected directly.
|
||||
(setcdr (last headers) header))))
|
||||
(setq index tmp)))))
|
||||
(setf (ws-active request) nil)
|
||||
nil))
|
||||
|
||||
(defun ws-call-handler (request handlers)
|
||||
(catch 'matched-handler
|
||||
(when (functionp handlers)
|
||||
(throw 'matched-handler
|
||||
(condition-case e (funcall handlers request)
|
||||
(error (ws-error (ws-process request) "Caught Error: %S" e)))))
|
||||
(mapc (lambda (handler)
|
||||
(let ((match (car handler))
|
||||
(function (cdr handler)))
|
||||
(when (or (and (consp match)
|
||||
(assoc (car match) (ws-headers request))
|
||||
(string-match (cdr match)
|
||||
(cdr (assoc (car match)
|
||||
(ws-headers request)))))
|
||||
(and (functionp match) (funcall match request)))
|
||||
(throw 'matched-handler
|
||||
(condition-case e (funcall function request)
|
||||
(error (ws-error (ws-process request)
|
||||
"Caught Error: %S" e)))))))
|
||||
handlers)
|
||||
(ws-error (ws-process request) "no handler matched request: %S"
|
||||
(ws-headers request))))
|
||||
|
||||
(defun ws-error (proc msg &rest args)
|
||||
(let ((buf (plist-get (process-plist proc) :log-buffer))
|
||||
(c (process-contact proc)))
|
||||
(when buf
|
||||
(with-current-buffer buf
|
||||
(goto-char (point-max))
|
||||
(insert (format "%s\t%s\t%s\tWS-ERROR: %s"
|
||||
(format-time-string ws-log-time-format)
|
||||
(cl-first c) (cl-second c)
|
||||
(apply #'format msg args)))))
|
||||
(apply #'ws-send-500 proc msg args)))
|
||||
|
||||
|
||||
;;; Web Socket
|
||||
;; Implement to conform to http://tools.ietf.org/html/rfc6455.
|
||||
|
||||
;; The `ws-message' object is used to hold state across multiple calls
|
||||
;; of the process filter on the websocket network process. The fields
|
||||
;; play the following roles.
|
||||
;; process ------ holds the process itself, used for communication
|
||||
;; pending ------ holds text received from the client but not yet parsed
|
||||
;; active ------- indicates that parsing is active to avoid re-entry
|
||||
;; of the `ws-web-socket-parse-messages' function
|
||||
;; new ---------- indicates that new text was received during parsing
|
||||
;; and causes `ws-web-socket-parse-messages' to be
|
||||
;; called again after it terminates
|
||||
;; data --------- holds the data of parsed messages
|
||||
;; handler ------ holds the user-supplied function of two arguments
|
||||
;; called on the process and the data of parsed
|
||||
;; messages
|
||||
(defclass ws-message () ; web socket message object
|
||||
((process :initarg :process :accessor ws-process :initform "")
|
||||
(pending :initarg :pending :accessor ws-pending :initform "")
|
||||
(active :initarg :active :accessor ws-active :initform nil)
|
||||
(new :initarg :new :accessor ws-new :initform nil)
|
||||
(data :initarg :data :accessor ws-data :initform "")
|
||||
(handler :initarg :handler :accessor ws-handler :initform "")))
|
||||
|
||||
(defun ws-web-socket-connect (request handler)
|
||||
"Establish a web socket connection with request.
|
||||
If the connection is successful this function will throw
|
||||
`:keep-alive' to `close-connection' skipping any remaining code
|
||||
in the request handler. If no web-socket connection is
|
||||
established (e.g., because REQUEST is not attempting to establish
|
||||
a connection) then no actions are taken and nil is returned.
|
||||
|
||||
Second argument HANDLER should be a function of two arguments,
|
||||
the process and a string, which will be called on all complete
|
||||
messages as they are received and parsed from the network."
|
||||
(with-slots (process headers) request
|
||||
(when (assoc :SEC-WEBSOCKET-KEY headers)
|
||||
;; Accept the connection
|
||||
(ws-response-header process 101
|
||||
(cons "Upgrade" "websocket")
|
||||
(cons "Connection" "upgrade")
|
||||
(cons "Sec-WebSocket-Accept"
|
||||
(ws-web-socket-handshake
|
||||
(cdr (assoc :SEC-WEBSOCKET-KEY headers)))))
|
||||
;; Setup the process filter
|
||||
(set-process-coding-system process 'binary)
|
||||
(set-process-plist
|
||||
process (list :message (make-instance 'ws-message
|
||||
:handler handler :process process)))
|
||||
(set-process-filter process 'ws-web-socket-filter)
|
||||
process)))
|
||||
|
||||
(defun ws-web-socket-filter (process string)
|
||||
(let ((message (plist-get (process-plist process) :message)))
|
||||
(if (ws-active message) ; don't re-start if message is being parsed
|
||||
(setf (ws-new message) string)
|
||||
(setf (ws-pending message) (concat (ws-pending message) string))
|
||||
(setf (ws-active message) t)
|
||||
(ws-web-socket-parse-messages message))
|
||||
(setf (ws-active message) nil)))
|
||||
|
||||
(defun ws-web-socket-mask (masking-key data)
|
||||
(let ((masking-data (apply #'concat (make-list (+ 1 (/ (length data) 4))
|
||||
masking-key))))
|
||||
(apply #'string (cl-mapcar #'logxor masking-data data))))
|
||||
|
||||
;; Binary framing protocol
|
||||
;; from http://tools.ietf.org/html/rfc6455#section-5.2
|
||||
;;
|
||||
;; 0 1 2 3
|
||||
;; 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||
;; +-+-+-+-+-------+-+-------------+-------------------------------+
|
||||
;; |F|R|R|R| opcode|M| Payload len | Extended payload length |
|
||||
;; |I|S|S|S| (4) |A| (7) | (16/64) |
|
||||
;; |N|V|V|V| |S| | (if payload len==126/127) |
|
||||
;; | |1|2|3| |K| | |
|
||||
;; +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
|
||||
;; | Extended payload length continued, if payload len == 127 |
|
||||
;; + - - - - - - - - - - - - - - - +-------------------------------+
|
||||
;; | |Masking-key, if MASK set to 1 |
|
||||
;; +-------------------------------+-------------------------------+
|
||||
;; | Masking-key (continued) | Payload Data |
|
||||
;; +-------------------------------- - - - - - - - - - - - - - - - +
|
||||
;; : Payload Data continued ... :
|
||||
;; + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
|
||||
;; | Payload Data continued ... |
|
||||
;; +---------------------------------------------------------------+
|
||||
;;
|
||||
(defun ws-web-socket-parse-messages (message)
|
||||
"Web socket filter to pass whole frames to the client.
|
||||
See RFC6455."
|
||||
(with-slots (process active pending data handler new) message
|
||||
(let ((index 0))
|
||||
(cl-labels ((int-to-bits (int size)
|
||||
(let ((result (make-bool-vector size nil)))
|
||||
(mapc (lambda (place)
|
||||
(let ((val (expt 2 place)))
|
||||
(when (>= int val)
|
||||
(setq int (- int val))
|
||||
(aset result place t))))
|
||||
(reverse (number-sequence 0 (- size 1))))
|
||||
(reverse (append result nil))))
|
||||
(bits-to-int (bits)
|
||||
(let ((place 0))
|
||||
(apply #'+
|
||||
(mapcar (lambda (bit)
|
||||
(prog1 (if bit (expt 2 place) 0) (cl-incf place)))
|
||||
(reverse bits)))))
|
||||
(bits (length)
|
||||
(apply #'append
|
||||
(mapcar (lambda (int) (int-to-bits int 8))
|
||||
(cl-subseq
|
||||
pending index (cl-incf index length))))))
|
||||
(let (fin rsvs opcode mask pl mask-key)
|
||||
;; Parse fin bit, rsvs bits and opcode
|
||||
(let ((byte (bits 1)))
|
||||
(setq fin (car byte)
|
||||
rsvs (cl-subseq byte 1 4)
|
||||
opcode
|
||||
(let ((it (bits-to-int (cl-subseq byte 4))))
|
||||
(cl-case it
|
||||
(0 :CONTINUATION)
|
||||
(1 :TEXT)
|
||||
(2 :BINARY)
|
||||
((3 4 5 6 7) :NON-CONTROL)
|
||||
(8 :CLOSE)
|
||||
(9 :PING)
|
||||
(10 :PONG)
|
||||
((11 12 13 14 15) :CONTROL)
|
||||
;; If an unknown opcode is received, the receiving
|
||||
;; endpoint MUST _Fail the WebSocket Connection_.
|
||||
(t (ws-error process
|
||||
"Web Socket Fail: bad opcode %d" it))))))
|
||||
(unless (cl-every #'null rsvs)
|
||||
;; MUST be 0 unless an extension is negotiated that defines
|
||||
;; meanings for non-zero values.
|
||||
(ws-error process "Web Socket Fail: non-zero RSV 1 2 or 3"))
|
||||
;; Parse mask and payload length
|
||||
(let ((byte (bits 1)))
|
||||
(setq mask (car byte)
|
||||
pl (bits-to-int (cl-subseq byte 1))))
|
||||
(unless (eq mask t)
|
||||
;; All frames sent from client to server have this bit set to 1.
|
||||
(ws-error process "Web Socket Fail: client must mask data"))
|
||||
(cond
|
||||
((= pl 126) (setq pl (bits-to-int (bits 2))))
|
||||
((= pl 127) (setq pl (bits-to-int (bits 8)))))
|
||||
;; unmask data
|
||||
(when mask (setq mask-key (cl-subseq pending index (cl-incf index 4))))
|
||||
(setq data (concat data
|
||||
(ws-web-socket-mask
|
||||
mask-key (cl-subseq pending index (+ index pl)))))
|
||||
(if fin
|
||||
;; wipe the message state and call the handler
|
||||
(let ((it data))
|
||||
(setq data "" active nil pending "" new nil)
|
||||
;; close on a close frame, otherwise call the handler
|
||||
(if (not (eql opcode :CLOSE))
|
||||
(funcall handler process it)
|
||||
(process-send-string process
|
||||
(unibyte-string (logior (lsh 1 7) 8) 0))))
|
||||
;; add any remaining un-parsed network data to pending
|
||||
(when (< (+ index pl) (length pending))
|
||||
(setq pending (substring pending (+ index pl)))))))
|
||||
;; possibly re-parse any pending input
|
||||
(when (ws-new message) (ws-web-socket-parse-messages message)))))
|
||||
|
||||
(defun ws-web-socket-frame (string &optional opcode)
|
||||
"Frame STRING for web socket communication."
|
||||
(let* ((fin 1) ;; set to 0 if not final frame
|
||||
(len (length string))
|
||||
(opcode (cl-ecase (or opcode :TEXT) (:TEXT 1) (:BINARY 2))))
|
||||
;; Does not do any masking which is only required of client communication
|
||||
(concat
|
||||
(cond
|
||||
((< len 126) (unibyte-string (logior (lsh fin 7) opcode) len))
|
||||
((< len 65536) (unibyte-string (logior (lsh fin 7) opcode) 126
|
||||
;; extended 16-bit length
|
||||
(logand (lsh len -8) 255)
|
||||
(logand len 255)))
|
||||
(t (unibyte-string (logior (lsh fin 7) opcode) 127
|
||||
;; more extended 64-bit length
|
||||
(logand (lsh len -56) 255)
|
||||
(logand (lsh len -48) 255)
|
||||
(logand (lsh len -40) 255)
|
||||
(logand (lsh len -32) 255)
|
||||
(logand (lsh len -24) 255)
|
||||
(logand (lsh len -16) 255)
|
||||
(logand (lsh len -8) 255)
|
||||
(logand len 255))))
|
||||
string)))
|
||||
|
||||
|
||||
;;; Content and Transfer encoding support
|
||||
(defvar ws-compress-cmd "compress"
|
||||
"Command used for the \"compress\" Content or Transfer coding.")
|
||||
|
||||
(defvar ws-deflate-cmd "zlib-flate -compress"
|
||||
"Command used for the \"deflate\" Content or Transfer coding.")
|
||||
|
||||
(defvar ws-gzip-cmd "gzip"
|
||||
"Command used for the \"gzip\" Content or Transfer coding.")
|
||||
|
||||
(defmacro ws-encoding-cmd-to-fn (cmd)
|
||||
"Return a function which applies CMD to strings."
|
||||
`(lambda (s)
|
||||
(with-temp-buffer
|
||||
(insert s)
|
||||
(shell-command-on-region (point-min) (point-max) ,cmd nil 'replace)
|
||||
(buffer-string))))
|
||||
|
||||
(defun ws-chunk (string)
|
||||
"Convert STRING to a valid chunk for HTTP chunked Transfer-encoding."
|
||||
(format "%x\r\n%s\r\n" (string-bytes string) string))
|
||||
|
||||
|
||||
;;; Convenience functions to write responses
|
||||
(defun ws-response-header (proc code &rest headers)
|
||||
"Send the headers for an HTTP response to PROC.
|
||||
CODE should be an HTTP status code, see `ws-status-codes' for a
|
||||
list of known codes.
|
||||
|
||||
When \"Content-Encoding\" or \"Transfer-Encoding\" headers are
|
||||
supplied any subsequent data written to PROC using `ws-send' will
|
||||
be encoded appropriately including sending the appropriate data
|
||||
upon the end of transmission for chunked transfer encoding.
|
||||
|
||||
For example with the header `(\"Content-Encoding\" . \"gzip\")',
|
||||
any data subsequently written to PROC using `ws-send' will be
|
||||
compressed using the command specified in `ws-gzip-cmd'."
|
||||
;; update process to reflect any Content or Transfer encodings
|
||||
(let ((content (cdr (assoc "Content-Encoding" headers)))
|
||||
(transfer (cdr (assoc "Transfer-Encoding" headers))))
|
||||
(when content
|
||||
(set-process-plist proc
|
||||
(append
|
||||
(list :content-encoding
|
||||
(cl-ecase (intern content)
|
||||
((compress x-compress) (ws-encoding-cmd-to-fn ws-compress-cmd))
|
||||
((deflate x-deflate) (ws-encoding-cmd-to-fn ws-deflate-cmd))
|
||||
((gzip x-gzip) (ws-encoding-cmd-to-fn ws-gzip-cmd))
|
||||
(identity #'identity)
|
||||
((exi pack200-zip)
|
||||
(ws-error proc "`%s' Content-encoding not supported."
|
||||
content))))
|
||||
(process-plist proc))))
|
||||
(when transfer
|
||||
(set-process-plist proc
|
||||
(append
|
||||
(when (string= transfer "chunked") (list :ender "0\r\n\r\n"))
|
||||
(list :transfer-encoding
|
||||
(cl-ecase (intern transfer)
|
||||
(chunked #'ws-chunk)
|
||||
((compress x-compress) (ws-encoding-cmd-to-fn ws-compress-cmd))
|
||||
((deflate x-deflate) (ws-encoding-cmd-to-fn ws-deflate-cmd))
|
||||
((gzip x-gzip) (ws-encoding-cmd-to-fn ws-gzip-cmd))))
|
||||
(process-plist proc)))))
|
||||
(let ((headers
|
||||
(cons
|
||||
(format "HTTP/1.1 %d %s" code (cdr (assoc code ws-status-codes)))
|
||||
(mapcar (lambda (h) (format "%s: %s" (car h) (cdr h))) headers))))
|
||||
(setcdr (last headers) (list "" ""))
|
||||
(process-send-string proc (mapconcat #'identity headers "\r\n"))))
|
||||
|
||||
(defun ws-send (proc string)
|
||||
"Send STRING to process PROC.
|
||||
If any Content or Transfer encodings are in use, apply them to
|
||||
STRING before sending."
|
||||
(let
|
||||
((cc (or (plist-get (process-plist proc) :content-encoding) #'identity))
|
||||
(tc (or (plist-get (process-plist proc) :transfer-encoding) #'identity)))
|
||||
(process-send-string proc (funcall tc (funcall cc string)))))
|
||||
|
||||
(defun ws-send-500 (proc &rest msg-and-args)
|
||||
"Send 500 \"Internal Server Error\" to PROC with an optional message."
|
||||
(ws-response-header proc 500
|
||||
'("Content-type" . "text/plain"))
|
||||
(process-send-string proc (if msg-and-args
|
||||
(apply #'format msg-and-args)
|
||||
"500 Internal Server Error"))
|
||||
(throw 'close-connection nil))
|
||||
|
||||
(defun ws-send-404 (proc &rest msg-and-args)
|
||||
"Send 404 \"Not Found\" to PROC with an optional message."
|
||||
(ws-response-header proc 404
|
||||
'("Content-type" . "text/plain"))
|
||||
(process-send-string proc (if msg-and-args
|
||||
(apply #'format msg-and-args)
|
||||
"404 Not Found"))
|
||||
(throw 'close-connection nil))
|
||||
|
||||
(defun ws-send-file (proc path &optional mime-type)
|
||||
"Send PATH to PROC.
|
||||
Optionally explicitly set MIME-TYPE, otherwise it is guessed by
|
||||
`mm-default-file-encoding'."
|
||||
(let ((mime (or mime-type
|
||||
(mm-default-file-encoding path)
|
||||
"application/octet-stream")))
|
||||
(process-send-string proc
|
||||
(with-temp-buffer
|
||||
(insert-file-contents-literally path)
|
||||
(ws-response-header proc 200
|
||||
(cons "Content-type" mime)
|
||||
(cons "Content-length" (- (point-max) (point-min))))
|
||||
(buffer-string)))))
|
||||
|
||||
(defun ws-send-directory-list (proc directory &optional match)
|
||||
"Send a listing of files in DIRECTORY to PROC.
|
||||
Optional argument MATCH is passed to `directory-files' and may be
|
||||
used to limit the files sent."
|
||||
(ws-response-header proc 200 (cons "Content-type" "text/html"))
|
||||
(process-send-string proc
|
||||
(concat "<ul>"
|
||||
(mapconcat (lambda (f)
|
||||
(let* ((full (expand-file-name f directory))
|
||||
(end (if (file-directory-p full) "/" ""))
|
||||
(url (url-encode-url (concat f end))))
|
||||
(format "<li><a href=%s>%s</li>" url f)))
|
||||
(directory-files directory nil match)
|
||||
"\n")
|
||||
"</ul>")))
|
||||
|
||||
(defun ws-in-directory-p (parent path)
|
||||
"Check if PATH is under the PARENT directory.
|
||||
If so return PATH, if not return nil. Note: the PARENT directory
|
||||
must be full expanded as with `expand-file-name' and should not
|
||||
contain e.g., \"~\" for a user home directory."
|
||||
(if (zerop (length path))
|
||||
parent
|
||||
(let ((expanded (expand-file-name path parent)))
|
||||
(and (>= (length expanded) (length parent))
|
||||
(string= parent (substring expanded 0 (length parent)))
|
||||
expanded))))
|
||||
|
||||
(defun ws-with-authentication (handler credentials
|
||||
&optional realm unauth invalid)
|
||||
"Return a version of HANDLER protected by CREDENTIALS.
|
||||
HANDLER should be a function as passed to `ws-start', and
|
||||
CREDENTIALS should be an alist of elements of the form (USERNAME
|
||||
. PASSWORD).
|
||||
|
||||
Optional argument REALM sets the realm in the authentication
|
||||
challenge. Optional arguments UNAUTH and INVALID should be
|
||||
functions which are called on the request when no authentication
|
||||
information, or invalid authentication information are provided
|
||||
respectively."
|
||||
(let ((handler handler)
|
||||
(credentials credentials)
|
||||
(realm realm)
|
||||
(unauth unauth)
|
||||
(invalid invalid))
|
||||
(lambda (request)
|
||||
(with-slots (process headers) request
|
||||
(let ((auth (cddr (assoc :AUTHORIZATION headers))))
|
||||
(cond
|
||||
;; no authentication information provided
|
||||
((not auth)
|
||||
(if unauth
|
||||
(funcall unauth request)
|
||||
(ws-response-header process 401
|
||||
(cons "WWW-Authenticate"
|
||||
(format "Basic realm=%S" (or realm "restricted")))
|
||||
'("Content-type" . "text/plain"))
|
||||
(process-send-string process "authentication required")))
|
||||
;; valid authentication information
|
||||
((string= (cdr auth) (cdr (assoc (car auth) credentials)))
|
||||
(funcall handler request))
|
||||
;; invalid authentication information
|
||||
(t
|
||||
(if invalid
|
||||
(funcall invalid request)
|
||||
(ws-response-header process 403 '("Content-type" . "text/plain"))
|
||||
(process-send-string process "invalid credentials")))))))))
|
||||
|
||||
(defun ws-web-socket-handshake (key)
|
||||
"Perform the handshake defined in RFC6455."
|
||||
(base64-encode-string (sha1 (concat (ws-trim key) ws-guid) nil nil 'binary)))
|
||||
|
||||
;;; Enable the old accessors without the `ws-' namespace as obsolete.
|
||||
;;; Lets plan to remove these within a year of the date they were
|
||||
;;; marked obsolete, so that would be roughly 2021-03-12.
|
||||
(define-obsolete-function-alias 'active 'ws-active "2020-03-12")
|
||||
(define-obsolete-function-alias 'body 'ws-body "2020-03-12")
|
||||
(define-obsolete-function-alias 'boundary 'ws-boundary "2020-03-12")
|
||||
(define-obsolete-function-alias 'context 'ws-context "2020-03-12")
|
||||
(define-obsolete-function-alias 'data 'ws-data "2020-03-12")
|
||||
(define-obsolete-function-alias 'handler 'ws-handler "2020-03-12")
|
||||
(define-obsolete-function-alias 'handlers 'ws-handlers "2020-03-12")
|
||||
(define-obsolete-function-alias 'headers 'ws-headers "2020-03-12")
|
||||
(define-obsolete-function-alias 'index 'ws-index "2020-03-12")
|
||||
(define-obsolete-function-alias 'new 'ws-new "2020-03-12")
|
||||
(define-obsolete-function-alias 'pending 'ws-pending "2020-03-12")
|
||||
(define-obsolete-function-alias 'port 'ws-port "2020-03-12")
|
||||
(define-obsolete-function-alias 'process 'ws-process "2020-03-12")
|
||||
(define-obsolete-function-alias 'requests 'ws-requests "2020-03-12")
|
||||
|
||||
(provide 'web-server)
|
||||
;;; web-server.el ends here
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,22 @@
|
|||
;;; websocket-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
|
||||
;;
|
||||
;;; Code:
|
||||
|
||||
(add-to-list 'load-path (directory-file-name
|
||||
(or (file-name-directory #$) (car load-path))))
|
||||
|
||||
|
||||
;;;### (autoloads nil "websocket" "websocket.el" (0 0 0 0))
|
||||
;;; Generated autoloads from websocket.el
|
||||
|
||||
(register-definition-prefixes "websocket" '("websocket-"))
|
||||
|
||||
;;;***
|
||||
|
||||
;; Local Variables:
|
||||
;; version-control: never
|
||||
;; no-byte-compile: t
|
||||
;; no-update-autoloads: t
|
||||
;; coding: utf-8
|
||||
;; End:
|
||||
;;; websocket-autoloads.el ends here
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
;;; Generated package description from websocket.el -*- no-byte-compile: t -*-
|
||||
(define-package "websocket" "20210110.17" "Emacs WebSocket client and server" '((cl-lib "0.5")) :commit "34e11124fdd9d73e431499ba8a6b6a8023519664" :authors '(("Andrew Hyatt" . "ahyatt@gmail.com")) :maintainer '("Andrew Hyatt" . "ahyatt@gmail.com") :keywords '("communication" "websocket" "server") :url "https://github.com/ahyatt/emacs-websocket")
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue