;;; emacsconf-pad.el --- Working with Etherpad -*- lexical-binding: t; -*- ;; Copyright (C) 2022 Sacha Chua ;; Author: Sacha Chua ;; Keywords: convenience ;; 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 . ;;; Commentary: ;; Prepopulate the Etherpad (defcustom emacsconf-pad-base "https://pad.emacsconf.org/" "Base URL for the Etherpad. Include trailing slash. Use \"wikimedia\" to use etherpad.wikimedia.org instead." :group 'emacsconf :type 'string) (defcustom emacsconf-pad-api-key nil "API key for authenticating against the Etherpad. You can find it in $ETHERPAD_PATH/APIKEY.txt" :group 'emacsconf :type 'string) (defcustom emacsconf-pad-slug-base (concat emacsconf-year) "Base for the pad IDs" :group 'emacsconf :type 'string) (defcustom emacsconf-pad-directory "" "Set to /p/ if you don't have friendly URLs set up in the proxy." :group 'emacsconf :type 'string) ;;; Code: (defun emacsconf-pad-delete-pad (pad-id) (interactive "MPad ID: ") (switch-to-buffer (url-retrieve-synchronously (format "%sapi/1/deletePad?apikey=%s&padID=%s" emacsconf-pad-base emacsconf-pad-api-key pad-id)))) (defun emacsconf-pad-json-request (url &optional display-result) (with-current-buffer (url-retrieve-synchronously url) (goto-char (point-min)) (re-search-forward "^$") (let ((result (json-read))) (when display-result (prin1 result)) (kill-buffer) result))) (defun emacsconf-pad-create-pad (pad-id) (interactive "MPad ID: ") (emacsconf-pad-json-request (format "%sapi/1/createPad?apikey=%s&padID=%s" emacsconf-pad-base (url-hexify-string emacsconf-pad-api-key) (url-hexify-string pad-id)) (called-interactively-p 'any))) (defun emacsconf-pad-delete-pad (pad-id) (interactive "MPad ID: ") (emacsconf-pad-json-request (format "%sapi/1/deletePad?apikey=%s&padID=%s" emacsconf-pad-base (url-hexify-string emacsconf-pad-api-key) (url-hexify-string pad-id)) (called-interactively-p 'any))) (defun emacsconf-pad-get-text (pad-id) (interactive "MPad ID: ") (emacsconf-pad-json-request (format "%sapi/1/getText?apikey=%s&padID=%s" emacsconf-pad-base (url-hexify-string emacsconf-pad-api-key) (url-hexify-string pad-id)) (called-interactively-p 'any))) (defun emacsconf-pad-set-text (pad-id text) (interactive "MPad ID: \nMText: ") (emacsconf-pad-json-request (format "%sapi/1/setText?apikey=%s&padID=%s&text=%s" emacsconf-pad-base (url-hexify-string emacsconf-pad-api-key) (url-hexify-string pad-id) (url-hexify-string text)) (called-interactively-p 'any))) (defun emacsconf-pad-append-text (pad-id text) (interactive "MPad ID: \nMText: ") (emacsconf-pad-json-request (format "%sapi/1/appendText?apikey=%s&padID=%s&text=%s" emacsconf-pad-base (url-hexify-string emacsconf-pad-api-key) (url-hexify-string pad-id) (url-hexify-string text)) (called-interactively-p 'any))) (defun emacsconf-pad-get-html (pad-id) (interactive "MPad ID: ") (emacsconf-pad-json-request (format "%sapi/1/getHTML?apikey=%s&padID=%s" emacsconf-pad-base (url-hexify-string emacsconf-pad-api-key) (url-hexify-string pad-id)) (called-interactively-p 'any))) (defun emacsconf-pad-set-html (pad-id html) (interactive "MPad ID: \nMHTML: ") (let ((url-request-data (concat "html=" (url-hexify-string html))) (url-request-method "POST") (url-request-extra-headers '(("Content-Type" . "application/x-www-form-urlencoded")))) (emacsconf-pad-json-request (format "%sapi/1/setHTML?apikey=%s&padID=%s" emacsconf-pad-base (url-hexify-string emacsconf-pad-api-key) (url-hexify-string pad-id)) (called-interactively-p 'any)))) ;; (emacsconf-pad-append-text "emacsconf-2022-journalism" "Hello again") ;; (emacsconf-pad-get-html "emacsconf-2022-journalism") ;; (emacsconf-pad-set-html "emacsconf-2022-journalism" "
Hello world
") (defun emacsconf-pad-get-last-edited (pad-id) (interactive "MPad ID: ") (emacsconf-pad-json-request (format "%sapi/1/getLastEdited?apikey=%s&padID=%s" emacsconf-pad-base (url-hexify-string emacsconf-pad-api-key) (url-hexify-string pad-id)) (called-interactively-p 'any))) (defun emacsconf-pad-id (o) (concat emacsconf-pad-slug-base "-" (plist-get o :slug))) (defun emacsconf-pad-url (o) (if (string= emacsconf-pad-base "wikimedia") (format "https://etherpad.wikimedia.org/p/emacsconf-%s-%s" emacsconf-year (plist-get o :slug)) (concat emacsconf-pad-base emacsconf-pad-directory (emacsconf-pad-id o)))) (defvar emacsconf-pad-number-of-next-talks 3 "Integer limiting the number of next talks to link to from the pad.") (defun emacsconf-pad-initial-content (o) (emacsconf-replace-plist-in-string (append (list :base-url emacsconf-base-url :channel (concat "emacsconf-" (plist-get (emacsconf-get-track (plist-get o :track)) :id)) :bbb-info (cond ((null (plist-get o :q-and-a)) "
Q&A: none
") ((string-match "live" (plist-get o :q-and-a)) (format "
Q&A room: %s
" (plist-get o :bbb-redirect))) (t "
Q&A: IRC
")) :next-talk-list (if (plist-get o :next-talks) (concat "
Next talks:\n
    " (mapconcat (lambda (o) (format "
  • %s: %s %s
    • " (plist-get o :track) (plist-get o :title) (emacsconf-pad-url o))) (plist-get o :next-talks) "\n") "
") "") :track-id (plist-get (emacsconf-get-track (plist-get o :track)) :id) :watch (concat emacsconf-base-url emacsconf-year "/watch/" (plist-get (emacsconf-get-track (plist-get o :track)) :id) "/") :talks (concat emacsconf-base-url emacsconf-year "/talks/") :notes (string-join (make-list 6 "
  • ")) :questions (string-join (make-list 6 "
  • Q:
    • A:
    • ")) :conf-pad-url (concat "https://pad.emacsconf.org/" emacsconf-year) :irc-nick-details (if (plist-get o :irc) (concat "Speaker nick: " (plist-get o :irc) " - ") "") :irc-url (concat "" )) o) "
    All talks: ${talks}
    ${title}
    ${base-url}${url} - ${speakers} - Track: ${track}
    Watch/participate: ${watch}
    ${bbb-info}
    IRC: ${irc-nick-details} https://chat.emacsconf.org/#/connect?join=emacsconf,emacsconf-${track-id} or #emacsconf-${track-id} on libera.chat network
    Guidelines for conduct: ${base-url}conduct
    See end of file for license (CC Attribution-ShareAlike 4.0 + GPLv3 or later)
    ----------------------------------------------------------------
    Notes, discussions, links, feedback:
      ${notes}
    ----------------------------------------------------------------
    Questions and answers go here:
      ${questions}
    ----------------------------------------------------------------
    ${next-talk-list}
    Questions/comments related to EmacsConf ${year} as a whole? ${conf-pad-url}
    ----------------------------------------------------------------
    This pad will be archived at ${base-url}${url} after the conference.
    Except where otherwise noted, the material on the EmacsConf pad are dual-licensed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International Public License; and the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) an later version. Copies of these two licenses are included in the EmacsConf wiki repository, in the COPYING.GPL and COPYING.CC-BY-SA files (https://emacsconf.org/COPYING/)
    By contributing to this pad, you agree to make your contributions available under the above licenses. You are also promising that you are the author of your changes, or that you copied them from a work in the public domain or a work released under a free license that is compatible with the above two licenses. DO NOT SUBMIT COPYRIGHTED WORK WITHOUT PERMISSION.
    ")) (defun emacsconf-pad-prepopulate-main-pad () (interactive) (let ((pad-id emacsconf-year)) (emacsconf-pad-create-pad pad-id) (emacsconf-pad-set-html pad-id (emacsconf-replace-plist-in-string (list :base-url emacsconf-base-url :notes (string-join (make-list 6 "
  • ")) :questions (string-join (make-list 6 "
  • Q:
    • A:
    • ")) :year emacsconf-year) "
    EmacsConf ${year} - this pad is for general conference-related questions and feedback
    All talks: ${base-url}${year}/talks - see specific talk pages for links to their Etherpads
    Conference hallway IRC channel: https://chat.emacsconf.org/#/connect?join=emacsconf or #emacsconf on libera.chat network
    Organizers channel: https://chat.emacsconf.org/#/connect?join=emacsconf,emacsconf-org or #emacsconf-org on libera.chat network
    Guidelines for conduct: ${base-url}conduct
    See end of file for license (CC Attribution-ShareAlike 4.0 + GPLv3 or later)
    ----------------------------------------------------------------
    Notes, discussions, links, feedback:
      ${notes}
    ----------------------------------------------------------------
    Questions and answers go here:
      ${questions}
    ----------------------------------------------------------------
    This pad will be archived at ${base-url}${url} after the conference.
    Except where otherwise noted, the material on the EmacsConf pad are dual-licensed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International Public License; and the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) an later version. Copies of these two licenses are included in the EmacsConf wiki repository, in the COPYING.GPL and COPYING.CC-BY-SA files (https://emacsconf.org/COPYING/)
    By contributing to this pad, you agree to make your contributions available under the above licenses. You are also promising that you are the author of your changes, or that you copied them from a work in the public domain or a work released under a free license that is compatible with the above two licenses. DO NOT SUBMIT COPYRIGHTED WORK WITHOUT PERMISSION.
    ")))) (defvar emacsconf-pad-force-all nil "Set to t to clear everything.") (defun emacsconf-pad-prepopulate-talk-pad (o) (interactive (list (let ((info (emacsconf-include-next-talks (emacsconf-get-talk-info) emacsconf-pad-number-of-next-talks))) (emacsconf-complete-talk-info info)))) (let ((pad-id (emacsconf-pad-id o))) (emacsconf-pad-create-pad pad-id) (when (or emacsconf-pad-force-all (not (emacsconf-pad-modified-p pad-id)) (progn (browse-url (emacsconf-pad-url o)) (y-or-n-p (format "%s might have been modified. Reset? " (plist-get o :slug))))) (emacsconf-pad-set-html pad-id (emacsconf-pad-initial-content o)) (save-window-excursion (emacsconf-with-talk-heading (plist-get o :slug) (let-alist (emacsconf-pad-get-last-edited pad-id) (org-entry-put (point) "PAD_RESET" (number-to-string .data.lastEdited)))))))) (defun emacsconf-pad-prepopulate-all-talks (&optional info) (interactive) (mapc #'emacsconf-pad-prepopulate-talk-pad (emacsconf-include-next-talks (or info (emacsconf-get-talk-info)) emacsconf-pad-number-of-next-talks))) (defun emacsconf-pad-export-initial-content (o file) (interactive (list (let ((info (emacsconf-include-next-talks (emacsconf-get-talk-info) emacsconf-pad-number-of-next-talks))) (emacsconf-complete-talk-info info)) (read-file-name "Output file: "))) (when (file-directory-p file) (setq file (expand-file-name (concat (plist-get o :slug) ".html") file))) (with-temp-file file (insert (emacsconf-pad-initial-content o)))) (defun emacsconf-pad-export-initial-content-for-all-talks (dir &optional info) (interactive (list (read-file-name "Output directory: " nil nil nil nil 'file-directory-p))) (setq info (emacsconf-include-next-talks (or info (emacsconf-get-talk-info)) emacsconf-pad-number-of-next-talks)) (mapcar (lambda (o) (emacsconf-pad-export-initial-content o dir)) (emacsconf-active-talks (emacsconf-filter-talks info)))) (defmacro emacsconf-pad-with-heading (pad-id &rest body) (declare (indent 1) (debug t)) `(progn (with-current-buffer (find-file emacsconf-org-file) (goto-char (org-find-property "CUSTOM_ID" (if (string-match "^[0-9]+-\\(.*\\)$" ,pad-id) (match-string 1 ,pad-id) "meta"))) ,@body))) (defun emacsconf-pad-modified-p (pad-id) (save-window-excursion (save-excursion (let ((cached-last-modified (emacsconf-pad-with-heading pad-id (org-entry-get (point) "PAD_RESET"))) (result (emacsconf-pad-get-last-edited pad-id))) (let-alist result (not (string= cached-last-modified (number-to-string .data.lastEdited)))))))) ;;; Hyperlists (defun emacsconf-pad-export-initial-content-for-hyperlists (dir &optional info) (interactive (list (read-file-name "Output directory: " nil nil nil nil 'file-directory-p))) (setq info (emacsconf-prepare-for-display (emacsconf-get-talk-info))) (unless (file-directory-p dir) (make-directory dir)) (mapc (lambda (shift) (with-temp-file (expand-file-name (concat (plist-get shift :id) ".html") dir) (insert (emacsconf-pad-format-shift-hyperlist (append (list :year emacsconf-year :track-id (plist-get (emacsconf-get-track (plist-get shift :track)) :id))) shift info)))) emacsconf-shifts)) ;; (emacsconf-pad-export-initial-content-for-hyperlists "/ssh:media:~/backstage/hyperlists") (defun emacsconf-pad-format-shift-hyperlist (shift info) (let* ((prefixed (list :start (plist-get shift :start) :end (plist-get shift :end) :base-url emacsconf-base-url :year emacsconf-year :host (format "%s" (emacsconf-surround "HOST-" (plist-get shift :host) "" "HOST")) :stream (format "%s" (emacsconf-surround "STREAM-" (plist-get shift :streamer) "" "STREAM")) :irc-volunteer (format "%s" (emacsconf-surround "IRC-" (plist-get shift :irc) "" "IRC")) :track-id (plist-get (emacsconf-get-track (plist-get shift :track)) :id) :checkin (format "%s" (emacsconf-surround "CHECKIN-" (plist-get shift :checkin) "" "CHECKIN")) :pad (format "%s" (emacsconf-surround "PAD-" (plist-get shift :pad) "" "PAD")) :coord (format "%s" (emacsconf-surround "COORD-" (plist-get shift :coord) "" "COORD")) :checkin-pad (concat emacsconf-pad-base "checkin-" (downcase (format-time-string "%a" (date-to-time (plist-get shift :start))))))) (shift-talks (mapcar (lambda (o) (append prefixed o)) (seq-filter (lambda (talk) (string= (plist-get talk :track) (plist-get shift :track))) (emacsconf-filter-talks-by-time (plist-get shift :start) (plist-get shift :end) info))))) (concat (emacsconf-replace-plist-in-string (append (list :index (concat emacsconf-pad-base "private_" emacsconf-private-pad-prefix "_" emacsconf-id)) shift) (concat "Back to ${index}
    In case of ...: https://emacsconf.org/2022/organizers-notebook/#exceptions
    " "

    " (plist-get shift :id) "

    " "

    Host: ${host}, Streamer: ${streamer}, IRC: ${irc}, Pad: ${pad}, Check-in: ${checkin}, Coord: ${coord}

    ")) (emacsconf-replace-plist-in-string prefixed (concat "

    Ctrl-5 is the shortcut for striking through on Etherpad.

    Setup