1 ;;; org-irc.el --- Store links to IRC sessions
3 ;; Copyright (C) 2008 Free Software Foundation, Inc.
5 ;; Author: Philip Jackson <emacs@shellarchive.co.uk>
6 ;; Keywords: erc, irc, link, org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; Link to an IRC session. Only ERC has been implemented at the
31 ;; This file is loaded by default whenever org.el is loaded. Please
32 ;; customize the variable `org-default-extensions' to select extensions
33 ;; you would like to use, and to deselect those which you don't want.
35 ;; Please note that at the moment only ERC is supported. Other clients
36 ;; shouldn't be diffficult to add though.
38 ;; Then set `org-irc-link-to-logs' to non-nil if you would like a
39 ;; file:/ type link to be created to the current line in the logs or
40 ;; to t if you would like to create an irc:/ style link.
42 ;; Links within an org buffer might look like this:
44 ;; [[irc:/irc.freenode.net/#emacs/bob][chat with bob in #emacs on freenode]]
45 ;; [[irc:/irc.freenode.net/#emacs][#emacs on freenode]]
46 ;; [[irc:/irc.freenode.net/]]
48 ;; If, when the resulting link is visited, there is no connection to a
49 ;; requested server then one will be created.
61 (defvar org-irc-client
'erc
62 "The IRC client to act on")
63 (defvar org-irc-link-to-logs nil
64 "non-nil will store a link to the logs, nil will store an irc: style link")
66 (defvar erc-default-port
) ; dynamically scoped from erc.el
67 (defvar erc-session-port
) ; dynamically scoped form erc-backend.el
68 (defvar erc-session-server
) ; dynamically scoped form erc-backend.el
70 ;; Generic functions/config (extend these for other clients)
72 (add-to-list 'org-store-link-functions
75 (org-add-link-type "irc" 'org-irc-visit nil
)
77 (defun org-irc-visit (link)
78 "Dispatch to the correct visit function based on the client"
79 (let ((link (org-irc-parse-link link
)))
81 ((eq org-irc-client
'erc
)
82 (org-irc-visit-erc link
))
84 (error "erc only known client")))))
86 (defun org-irc-parse-link (link)
87 "Get a of irc link attributes where `link' looks like
88 server:port/chan/user (port, chan and user being optional)."
89 (let* ((parts (split-string link
"/" t
))
91 (when (or (< len
1) (> len
3))
92 (error "Failed to parse link needed 1-3 parts, got %d." len
))
93 (setcar parts
(split-string (car parts
) ":" t
))
97 (defun org-irc-store-link ()
98 "Dispatch to the appropreate function to store a link to
99 something IRC related"
101 ((eq major-mode
'erc-mode
)
102 (org-irc-erc-store-link))))
104 (defun org-irc-elipsify-description (string &optional after
)
105 "Strip starting and ending whitespace and replace any chars
106 that appear after the value in `after' with '...'"
107 (let* ((after (number-to-string (or after
30)))
108 (replace-map (list (cons "^[ \t]*" "")
110 (cons (concat "^\\(.\\{" after
111 "\\}\\).*") "\\1..."))))
113 (when (string-match (car x
) string
)
114 (setq string
(replace-match (cdr x
) nil nil string
))))
118 ;; ERC specific functions
120 (defun org-irc-erc-get-line-from-log (erc-line)
121 "Find the most suitable line to link to from the erc logs. If
122 the user is on the erc-prompt then search backward for the first
123 non-blank line, otherwise return the current line. The result is
124 a cons of the filename and search string."
125 (erc-save-buffer-in-logs)
126 (with-current-buffer (find-file-noselect (erc-current-logfile))
127 (goto-char (point-max))
129 (abbreviate-file-name buffer-file-name
)
130 ;; can we get a '::' part?
131 (if (string= erc-line
(erc-prompt))
133 (goto-char (point-at-bol))
134 (when (search-backward-regexp "^[^ ]" nil t
)
135 (buffer-substring-no-properties (point-at-bol)
137 (when (search-backward erc-line nil t
)
138 (buffer-substring-no-properties (point-at-bol)
141 (defun org-irc-erc-store-link ()
142 "Depending on the variable `org-irc-link-to-logs' store either
143 a link to the log file for the current session or an irc: link to
145 (if org-irc-link-to-logs
146 (let* ((erc-line (buffer-substring-no-properties
147 (point-at-bol) (point-at-eol)))
148 (parsed-line (org-irc-erc-get-line-from-log erc-line
)))
149 (if (erc-logging-enabled nil
)
151 (org-store-link-props
153 :description
(concat "'" (org-irc-elipsify-description
154 (cadr parsed-line
) 20)
155 "' from an IRC conversation")
156 :link
(concat "file:" (car parsed-line
) "::"
159 (error "This ERC session is not being logged")))
160 (let* ((link-text (org-irc-get-erc-link))
161 (link (org-irc-parse-link link-text
)))
164 (org-store-link-props
166 :link
(org-make-link "irc:/" link-text
)
167 :description
(concat "irc session '" link-text
"'")
168 :server
(car (car link
))
169 :port
(or (string-to-number (cadr (pop link
))) erc-default-port
)
172 (error "Failed to create ('irc:/' style) ERC link")))))
174 (defun org-irc-get-erc-link ()
175 "Return an org compatible irc:/ link from an ERC buffer"
176 (let* ((session-port (if (numberp erc-session-port
)
177 (number-to-string erc-session-port
)
179 (link (concat erc-session-server
":" session-port
)))
181 (if (and (erc-default-target)
182 (erc-channel-p (erc-default-target))
183 (car (get-text-property (point) 'erc-data
)))
185 (let ((nick (car (get-text-property (point) 'erc-data
))))
186 (concat (erc-default-target) "/" nick
))
187 (erc-default-target)))))
189 (defun org-irc-get-current-erc-port ()
190 "Return the current port as a number. If there is not an
191 explicit port set then return the erc default."
193 ((stringp erc-session-port
)
194 (string-to-number erc-session-port
))
195 ((numberp erc-session-port
)
200 (defun org-irc-visit-erc (link)
201 "Visit an ERC buffer based on criteria from the followed link"
202 (let* ((server (car (car link
)))
203 (port (or (string-to-number (cadr (pop link
))) erc-default-port
))
208 (let ((tmp-server-buf (erc-server-buffer)))
210 (with-current-buffer tmp-server-buf
212 (eq (org-irc-get-current-erc-port) port
)
213 (string= erc-session-server server
)
214 (setq server-buffer tmp-server-buf
)))))))))
216 (let ((chan-name (pop link
)))
217 ;; if we got a channel name then switch to it or join it
219 (let ((chan-buf (find-if
221 (string= (buffer-name x
) chan-name
))
225 (switch-to-buffer chan-buf
)
226 ;; if we got a nick, and they're in the chan,
227 ;; then start a chat with them
228 (let ((nick (pop link
)))
230 (if (find nick
(erc-get-server-nickname-list)
233 (goto-char (point-max))
234 (insert (concat nick
": ")))
235 (error "%s not found in %s" nick chan-name
)))))
237 (switch-to-buffer server-buffer
)
238 (erc-cmd-JOIN chan-name
))))
239 (switch-to-buffer server-buffer
)))
240 ;; no server match, make new connection
241 (erc-select :server server
:port port
))))
245 ;;; org-irc.el ends here