1 ;;; org-irc.el --- Store Links to IRC Sessions -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2008-2017 Free Software Foundation, Inc.
5 ;; Author: Philip Jackson <emacs@shellarchive.co.uk>
6 ;; Keywords: erc, irc, link, org
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
25 ;; This file implements links to an IRC session from within Org mode.
26 ;; Org mode loads this module by default - if this is not what you want,
27 ;; configure the variable `org-modules'.
29 ;; Please customize the variable `org-modules' to select
30 ;; extensions you would like to use, and to deselect those which you don't
33 ;; Please note that at the moment only ERC is supported. Other clients
34 ;; shouldn't be difficult to add though.
36 ;; Then set `org-irc-link-to-logs' to non-nil if you would like a
37 ;; file:/ type link to be created to the current line in the logs or
38 ;; to t if you would like to create an irc:/ style link.
40 ;; Links within an org buffer might look like this:
42 ;; [[irc:/irc.freenode.net/#emacs/bob][chat with bob in #emacs on freenode]]
43 ;; [[irc:/irc.freenode.net/#emacs][#emacs on freenode]]
44 ;; [[irc:/irc.freenode.net/]]
46 ;; If, when the resulting link is visited, there is no connection to a
47 ;; requested server then one will be created.
53 (declare-function erc-buffer-filter
"erc" (predicate &optional proc
))
54 (declare-function erc-channel-p
"erc" (channel))
55 (declare-function erc-cmd-JOIN
"erc" (channel &optional key
))
56 (declare-function erc-current-logfile
"erc-log" (&optional buffer
))
57 (declare-function erc-default-target
"erc" ())
58 (declare-function erc-get-server-nickname-list
"erc" ())
59 (declare-function erc-logging-enabled
"erc-log" (&optional buffer
))
60 (declare-function erc-prompt
"erc" ())
61 (declare-function erc-save-buffer-in-logs
"erc-log" (&optional buffer
))
62 (declare-function erc-server-buffer
"erc" ())
64 (defvar org-irc-client
'erc
65 "The IRC client to act on.")
67 (defvar org-irc-link-to-logs nil
68 "Non-nil will store a link to the logs, nil will store an irc: style link.")
70 (defvar erc-default-port
) ; dynamically scoped from erc.el
71 (defvar erc-session-port
) ; dynamically scoped form erc-backend.el
72 (defvar erc-session-server
) ; dynamically scoped form erc-backend.el
74 ;; Generic functions/config (extend these for other clients)
76 (org-link-set-parameters "irc" :follow
#'org-irc-visit
:store
#'org-irc-store-link
)
78 (defun org-irc-visit (link)
79 "Parse LINK and dispatch to the correct function based on the client found."
80 (let ((link (org-irc-parse-link link
)))
82 ((eq org-irc-client
'erc
)
83 (org-irc-visit-erc link
))
85 (error "ERC only known client")))))
87 (defun org-irc-parse-link (link)
88 "Parse an IRC LINK and return the attributes found.
89 Parse a LINK that looks like server:port/chan/user (port, chan
90 and user being optional) and return any of the port, channel or user
91 attributes that are found."
92 (let* ((parts (split-string link
"/" t
))
94 (when (or (< len
1) (> len
3))
95 (error "Failed to parse link needed 1-3 parts, got %d" len
))
96 (setcar parts
(split-string (car parts
) ":" t
))
100 (defun org-irc-store-link ()
101 "Dispatch to the appropriate function to store a link to an IRC session."
103 ((eq major-mode
'erc-mode
)
104 (org-irc-erc-store-link))))
106 (defun org-irc-ellipsify-description (string &optional after
)
107 "Remove unnecessary white space from STRING and add ellipses if necessary.
108 Strip starting and ending white space from STRING and replace any
109 chars that the value AFTER with `...'"
110 (let* ((after (number-to-string (or after
30)))
111 (replace-map (list (cons "^[ \t]*" "")
113 (cons (concat "^\\(.\\{" after
114 "\\}\\).*") "\\1..."))))
115 (dolist (x replace-map string
)
116 (when (string-match (car x
) string
)
117 (setq string
(replace-match (cdr x
) nil nil string
))))))
119 ;; ERC specific functions
121 (defun org-irc-erc-get-line-from-log (erc-line)
122 "Find the best line to link to from the ERC logs given ERC-LINE as a start.
123 If the user is on the ERC-prompt then search backward for the
124 first non-blank line, otherwise return the current line. The
125 result is a cons of the filename and search string."
126 (erc-save-buffer-in-logs)
128 (with-current-buffer (find-file-noselect (erc-current-logfile))
129 (goto-char (point-max))
131 (abbreviate-file-name buffer-file-name
)
132 ;; can we get a '::' part?
133 (if (string= erc-line
(erc-prompt))
135 (goto-char (point-at-bol))
136 (when (search-backward-regexp "^[^ ]" nil t
)
137 (buffer-substring-no-properties (point-at-bol)
139 (when (search-backward erc-line nil t
)
140 (buffer-substring-no-properties (point-at-bol)
143 (defun org-irc-erc-store-link ()
144 "Store a link to the IRC log file or the session itself.
145 Depending on the variable `org-irc-link-to-logs' store either a
146 link to the log file for the current session or an irc: link to
149 (if org-irc-link-to-logs
150 (let* ((erc-line (buffer-substring-no-properties
151 (point-at-bol) (point-at-eol)))
152 (parsed-line (org-irc-erc-get-line-from-log erc-line
)))
153 (if (erc-logging-enabled nil
)
155 (org-store-link-props
157 :description
(concat "'" (org-irc-ellipsify-description
158 (cadr parsed-line
) 20)
159 "' from an IRC conversation")
160 :link
(concat "file:" (car parsed-line
) "::"
163 (error "This ERC session is not being logged")))
164 (let* ((link-text (org-irc-get-erc-link))
165 (link (org-irc-parse-link link-text
)))
168 (org-store-link-props
170 :link
(concat "irc:/" link-text
)
171 :description
(concat "irc session `" link-text
"'")
172 :server
(car (car link
))
173 :port
(or (string-to-number (cadr (pop link
))) erc-default-port
)
176 (error "Failed to create ('irc:/' style) ERC link")))))
178 (defun org-irc-get-erc-link ()
179 "Return an org compatible irc:/ link from an ERC buffer."
180 (let* ((session-port (if (numberp erc-session-port
)
181 (number-to-string erc-session-port
)
183 (link (concat erc-session-server
":" session-port
)))
185 (if (and (erc-default-target)
186 (erc-channel-p (erc-default-target))
187 (car (get-text-property (point) 'erc-data
)))
189 (let ((nick (car (get-text-property (point) 'erc-data
))))
190 (concat (erc-default-target) "/" nick
))
191 (erc-default-target)))))
193 (defun org-irc-get-current-erc-port ()
194 "Return the current port as a number.
195 Return the current port number or, if none is set, return the ERC
198 ((stringp erc-session-port
)
199 (string-to-number erc-session-port
))
200 ((numberp erc-session-port
)
205 (defun org-irc-visit-erc (link)
206 "Visit an ERC buffer based on criteria found in LINK."
209 (let* ((server (car (car link
)))
210 (port (let ((p (cadr (pop link
))))
211 (if p
(string-to-number p
) erc-default-port
)))
216 (let ((tmp-server-buf (erc-server-buffer)))
218 (with-current-buffer tmp-server-buf
220 (eq (org-irc-get-current-erc-port) port
)
221 (string= erc-session-server server
)
222 (setq server-buffer tmp-server-buf
)))))))))
224 (let ((chan-name (pop link
)))
225 ;; if we got a channel name then switch to it or join it
227 (let ((chan-buf (catch 'found
228 (dolist (x buffer-list
)
229 (if (string= (buffer-name x
) chan-name
)
230 (throw 'found x
))))))
233 (pop-to-buffer-same-window chan-buf
)
234 ;; if we got a nick, and they're in the chan,
235 ;; then start a chat with them
236 (let ((nick (pop link
)))
238 (if (member nick
(erc-get-server-nickname-list))
240 (goto-char (point-max))
241 (insert (concat nick
": ")))
242 (error "%s not found in %s" nick chan-name
)))))
244 (pop-to-buffer-same-window server-buffer
)
245 (erc-cmd-JOIN chan-name
))))
246 (pop-to-buffer-same-window server-buffer
)))
247 ;; no server match, make new connection
248 (erc-select :server server
:port port
))))
253 ;; generated-autoload-file: "org-loaddefs.el"
256 ;;; org-irc.el ends here