1 ;;; elmo-net.el -- Network module for ELMO.
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;; Keywords: mail, net news
8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
10 ;; This program 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 2, or (at your option)
15 ;; This program 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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval-when-compile (require 'cl))
41 (luna-define-class elmo-net-folder
43 (user auth server port stream-type))
44 (luna-define-internal-accessors 'elmo-net-folder))
48 (autoload 'starttls-negotiate "starttls")
49 (autoload 'sasl-find-mechanism "sasl")
50 (autoload 'sasl-make-client "sasl")
51 (autoload 'sasl-mechanism-name "sasl")
52 (autoload 'sasl-next-step "sasl")
53 (autoload 'sasl-step-data "sasl")
54 (autoload 'sasl-step-set-data "sasl"))
56 (defvar sasl-mechanisms)
61 (luna-define-class elmo-network-session () (name
69 (luna-define-internal-accessors 'elmo-network-session))
71 (luna-define-generic elmo-network-initialize-session (session)
72 "Initialize SESSION (Called before authentication).")
74 (luna-define-generic elmo-network-initialize-session-buffer (session buffer)
75 "Initialize SESSION's BUFFER.")
77 (luna-define-generic elmo-network-authenticate-session (session)
78 "Authenticate SESSION.")
80 (luna-define-generic elmo-network-setup-session (session)
81 "Setup SESSION. (Called after authentication).")
83 (luna-define-generic elmo-network-close-session (session)
87 elmo-network-initialize-session-buffer ((session
88 elmo-network-session) buffer)
89 (with-current-buffer buffer
90 (elmo-set-buffer-multibyte nil)
91 (buffer-disable-undo (current-buffer))))
93 (luna-define-method elmo-network-close-session ((session elmo-network-session))
94 (when (elmo-network-session-process-internal session)
95 ;;; (memq (process-status (elmo-network-session-process-internal session))
97 (kill-buffer (process-buffer
98 (elmo-network-session-process-internal session)))
99 (delete-process (elmo-network-session-process-internal session))))
101 (defmacro elmo-network-stream-type-spec-string (stream-type)
102 (` (nth 0 (, stream-type))))
104 (defmacro elmo-network-stream-type-symbol (stream-type)
105 (` (nth 1 (, stream-type))))
107 (defmacro elmo-network-stream-type-feature (stream-type)
108 (` (nth 2 (, stream-type))))
110 (defmacro elmo-network-stream-type-function (stream-type)
111 (` (nth 3 (, stream-type))))
113 (defsubst elmo-network-session-password-key (session)
114 (format "%s:%s/%s@%s:%d"
115 (elmo-network-session-name-internal session)
116 (elmo-network-session-user-internal session)
117 (elmo-network-session-auth-internal session)
118 (elmo-network-session-server-internal session)
119 (elmo-network-session-port-internal session)))
121 (defvar elmo-network-session-cache nil)
122 (defvar elmo-network-session-name-prefix nil)
124 (defsubst elmo-network-session-cache-key (name folder)
125 "Returns session cache key for NAME and FOLDER."
126 (format "%s:%s/%s@%s:%d%s"
127 (concat elmo-network-session-name-prefix name)
128 (elmo-net-folder-user-internal folder)
129 (elmo-net-folder-auth-internal folder)
130 (elmo-net-folder-server-internal folder)
131 (elmo-net-folder-port-internal folder)
133 (elmo-network-stream-type-spec-string
134 (elmo-net-folder-stream-type-internal folder)) "")))
136 (defun elmo-network-clear-session-cache ()
137 "Clear session cache."
139 (dolist (pair elmo-network-session-cache)
140 (elmo-network-close-session (cdr pair)))
141 (setq elmo-network-session-cache nil))
143 (defmacro elmo-network-session-buffer (session)
144 "Get buffer for SESSION."
145 (` (process-buffer (elmo-network-session-process-internal
148 (defun elmo-network-get-session (class name folder &optional if-exists)
149 "Get network session from session cache or a new network session.
150 CLASS is the class name of the session.
151 NAME is the name of the process.
152 FOLDER is the ELMO folder structure.
153 Returns a `elmo-network-session' instance.
154 If optional argument IF-EXISTS is non-nil, it does not return session
155 if there is no session cache.
156 if making session failed, returns nil."
157 (let (pair session key)
158 (if (not (elmo-plugged-p
159 (elmo-net-folder-server-internal folder)
160 (elmo-net-folder-port-internal folder)))
162 (setq pair (assoc (setq key (elmo-network-session-cache-key name folder))
163 elmo-network-session-cache))
165 (not (memq (process-status
166 (elmo-network-session-process-internal
169 (setq elmo-network-session-cache
170 (delq pair elmo-network-session-cache))
171 (elmo-network-close-session (cdr pair))
174 (cdr pair) ; connection cache exists.
177 (elmo-network-open-session
180 (elmo-net-folder-server-internal folder)
181 (elmo-net-folder-port-internal folder)
182 (elmo-net-folder-user-internal folder)
183 (elmo-net-folder-auth-internal folder)
184 (elmo-net-folder-stream-type-internal folder)))
185 (setq elmo-network-session-cache
186 (cons (cons key session)
187 elmo-network-session-cache))
190 (defun elmo-network-open-session (class name server port user auth
192 "Open an authenticated network session.
193 CLASS is the class name of the session.
194 NAME is the name of the process.
195 SERVER is the name of the server server.
196 PORT is the port number of the service.
197 USER is the user-id for the authenticate.
198 AUTH is the authenticate method name (symbol).
199 STREAM-TYPE is the stream type (See also `elmo-network-stream-type-alist').
200 Returns a process object. if making session failed, returns nil."
202 (luna-make-entity class
208 :stream-type stream-type
211 (buffer (format " *%s session for %s@%s:%d%s"
212 (concat elmo-network-session-name-prefix name)
216 (or (elmo-network-stream-type-spec-string stream-type)
219 (condition-case error
221 (if (get-buffer buffer) (kill-buffer buffer))
222 (setq buffer (get-buffer-create buffer))
223 (elmo-network-initialize-session-buffer session buffer)
224 (elmo-network-session-set-process-internal
226 (setq process (elmo-open-network-stream
227 (elmo-network-session-name-internal session)
228 buffer server port stream-type)))
230 (elmo-network-initialize-session session)
231 (elmo-network-authenticate-session session)
232 (elmo-network-setup-session session)))
234 (when (eq (car error) 'elmo-authenticate-error)
235 (elmo-remove-passwd (elmo-network-session-password-key session)))
236 (elmo-network-close-session session)
237 (signal (car error)(cdr error))))
240 (defun elmo-open-network-stream (name buffer server service stream-type)
241 (let ((auto-plugged (and elmo-auto-change-plugged
242 (> elmo-auto-change-plugged 0)))
245 (elmo-network-stream-type-feature stream-type))
246 (require (elmo-network-stream-type-feature stream-type)))
248 (let (process-connection-type)
252 (funcall (elmo-network-stream-type-function stream-type)
253 name buffer server service)
254 (open-network-stream name buffer server service)))))
257 (elmo-set-plugged nil server service stream-type (current-time))
258 (message "Auto plugged off at %s:%d" server service)
260 (signal (car err) (cdr err))))
262 (process-kill-without-query process)
264 (elmo-set-plugged t server service stream-type))
267 (luna-define-method elmo-folder-initialize ((folder
270 ;; user and auth should be set in subclass.
271 (when (string-match "\\(@[^@:/!]+\\)?\\(:[0-9]+\\)?\\(!.*\\)?$" name)
272 (if (match-beginning 1)
273 (elmo-net-folder-set-server-internal
275 (elmo-match-substring 1 name 1)))
276 (if (match-beginning 2)
277 (elmo-net-folder-set-port-internal
279 (string-to-int (elmo-match-substring 2 name 1))))
280 (if (match-beginning 3)
281 (elmo-net-folder-set-stream-type-internal
283 (assoc (elmo-match-string 3 name)
284 elmo-network-stream-type-alist)))
285 (substring name 0 (match-beginning 0))))
287 (defun elmo-net-port-info (folder)
288 (list (elmo-net-folder-server-internal folder)
289 (elmo-net-folder-port-internal folder)
290 (elmo-network-stream-type-symbol
291 (elmo-net-folder-stream-type-internal folder))))
293 (defun elmo-net-port-label (folder)
295 (symbol-name (elmo-folder-type-internal folder))
296 (if (elmo-net-folder-stream-type-internal folder)
297 (concat "!" (symbol-name
298 (elmo-network-stream-type-symbol
299 (elmo-net-folder-stream-type-internal
302 (luna-define-method elmo-folder-plugged-p ((folder elmo-net-folder))
303 (apply 'elmo-plugged-p
304 (append (elmo-net-port-info folder)
305 (list nil (quote (elmo-net-port-label folder))))))
307 (luna-define-method elmo-folder-set-plugged ((folder elmo-net-folder)
308 plugged &optional add)
309 (apply 'elmo-set-plugged plugged
310 (append (elmo-net-port-info folder)
311 (list nil nil (quote (elmo-net-port-label folder)) add))))
313 (luna-define-method elmo-folder-exists-p ((folder elmo-net-folder))
314 (if (elmo-folder-plugged-p folder)
315 (elmo-folder-send folder 'elmo-folder-exists-p-plugged)
316 t)) ; If unplugged, assume the folder exists.
318 (luna-define-method elmo-folder-status ((folder elmo-net-folder))
319 (if (elmo-folder-plugged-p folder)
320 (elmo-folder-send folder 'elmo-folder-status-plugged)
321 (elmo-folder-send folder 'elmo-folder-status-unplugged)))
323 (luna-define-method elmo-folder-status-unplugged
324 ((folder elmo-net-folder))
325 (if elmo-enable-disconnected-operation
327 (elmo-dop-folder-status folder))
328 (error "Unplugged")))
330 (luna-define-method elmo-folder-list-messages-internal
331 ((folder elmo-net-folder))
332 (elmo-net-folder-list-messages-internal folder))
334 (defun elmo-net-folder-list-messages-internal (folder)
335 (if (elmo-folder-plugged-p folder)
336 (elmo-folder-send folder 'elmo-folder-list-messages-plugged)
337 (elmo-folder-send folder 'elmo-folder-list-messages-unplugged)))
339 (luna-define-method elmo-folder-list-messages-plugged
340 ((folder elmo-net-folder))
344 ;; Should consider offline append and removal.
345 (luna-define-method elmo-folder-list-messages-unplugged
346 ((folder elmo-net-folder))
347 (if elmo-enable-disconnected-operation
349 (error "Unplugged")))
351 (luna-define-method elmo-folder-list-unreads-internal
352 ((folder elmo-net-folder) unread-marks)
353 (if (and (elmo-folder-plugged-p folder)
354 (elmo-folder-use-flag-p folder))
355 (elmo-folder-send folder 'elmo-folder-list-unreads-plugged)
358 (luna-define-method elmo-folder-list-importants-internal
359 ((folder elmo-net-folder) important-mark)
360 (if (and (elmo-folder-plugged-p folder)
361 (elmo-folder-use-flag-p folder))
362 (elmo-folder-send folder 'elmo-folder-list-importants-plugged)
365 (luna-define-method elmo-folder-list-unreads-plugged
366 ((folder elmo-net-folder))
369 (luna-define-method elmo-folder-list-importants-plugged
370 ((folder elmo-net-folder))
373 (luna-define-method elmo-folder-delete-messages ((folder elmo-net-folder)
375 (if (elmo-folder-plugged-p folder)
376 (elmo-folder-send folder 'elmo-folder-delete-messages-plugged numbers)
377 (elmo-folder-send folder 'elmo-folder-delete-messages-unplugged numbers)))
379 (luna-define-method elmo-folder-unmark-important ((folder elmo-net-folder)
381 (if (elmo-folder-use-flag-p folder)
382 (if (elmo-folder-plugged-p folder)
383 (elmo-folder-send folder 'elmo-folder-unmark-important-plugged
385 (elmo-folder-send folder
386 'elmo-folder-unmark-important-unplugged numbers))
389 (luna-define-method elmo-folder-mark-as-important ((folder elmo-net-folder)
391 (if (elmo-folder-use-flag-p folder)
392 (if (elmo-folder-plugged-p folder)
393 (elmo-folder-send folder 'elmo-folder-mark-as-important-plugged
395 (elmo-folder-send folder 'elmo-folder-mark-as-important-unplugged
399 (luna-define-method elmo-folder-unmark-read ((folder elmo-net-folder)
401 (if (elmo-folder-use-flag-p folder)
402 (if (elmo-folder-plugged-p folder)
403 (elmo-folder-send folder 'elmo-folder-unmark-read-plugged numbers)
404 (elmo-folder-send folder 'elmo-folder-unmark-read-unplugged numbers))
407 (luna-define-method elmo-folder-mark-as-read ((folder elmo-net-folder)
409 (if (elmo-folder-use-flag-p folder)
410 (if (elmo-folder-plugged-p folder)
411 (elmo-folder-send folder 'elmo-folder-mark-as-read-plugged numbers)
413 folder 'elmo-folder-mark-as-read-unplugged numbers))
416 (luna-define-method elmo-message-fetch ((folder elmo-net-folder)
421 (if (elmo-folder-plugged-p folder)
422 (let ((cache-file (elmo-file-cache-expand-path
423 (elmo-fetch-strategy-cache-path strategy)
425 (if (and (elmo-fetch-strategy-use-cache strategy)
426 (file-exists-p cache-file))
428 (with-current-buffer outbuf
429 (insert-file-contents-as-binary cache-file)
432 (insert-file-contents-as-binary cache-file)
435 (with-current-buffer outbuf
436 (elmo-folder-send folder 'elmo-message-fetch-plugged
437 number strategy section
438 (current-buffer) unseen)
439 (elmo-delete-cr-buffer)
440 (when (elmo-fetch-strategy-save-cache strategy)
441 (elmo-file-cache-save
442 (elmo-fetch-strategy-cache-path strategy)
446 (elmo-folder-send folder 'elmo-message-fetch-plugged
447 number strategy section
448 (current-buffer) unseen)
449 (elmo-delete-cr-buffer)
450 (when (elmo-fetch-strategy-save-cache strategy)
451 (elmo-file-cache-save
452 (elmo-fetch-strategy-cache-path strategy)
455 (elmo-folder-send folder 'elmo-message-fetch-unplugged
456 number strategy section outbuf unseen)))
458 (luna-define-method elmo-message-fetch-unplugged
459 ((folder elmo-net-folder) number strategy &optional section outbuf unseen)
460 (if (elmo-fetch-strategy-use-cache strategy)
462 (with-current-buffer outbuf
463 (insert-file-contents-as-binary
464 (elmo-file-cache-expand-path
465 (elmo-fetch-strategy-cache-path strategy)
469 (insert-file-contents-as-binary
470 (elmo-file-cache-expand-path
471 (elmo-fetch-strategy-cache-path strategy)
474 (error "Unplugged")))
476 (luna-define-method elmo-folder-check ((folder elmo-net-folder))
477 (if (elmo-folder-plugged-p folder)
478 (elmo-folder-send folder 'elmo-folder-check-plugged)))
480 (luna-define-method elmo-folder-close :after ((folder elmo-net-folder))
481 (if (elmo-folder-plugged-p folder)
482 (elmo-folder-send folder 'elmo-folder-check-plugged)))
484 (luna-define-method elmo-folder-diff :around ((folder elmo-net-folder)
486 (if (and (elmo-folder-use-flag-p folder)
487 (elmo-folder-plugged-p folder))
488 (elmo-folder-send folder 'elmo-folder-diff-plugged)
489 (luna-call-next-method)))
491 (luna-define-method elmo-folder-local-p ((folder elmo-net-folder))
494 (luna-define-method elmo-quit ((folder elmo-net-folder))
495 (elmo-network-clear-session-cache))
498 (product-provide (provide 'elmo-net) (require 'elmo-version))
500 ;;; elmo-net.el ends here