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))
42 (luna-define-class elmo-net-folder
44 (user auth server port stream-type))
45 (luna-define-internal-accessors 'elmo-net-folder))
49 (autoload 'starttls-negotiate "starttls")
50 (autoload 'sasl-find-mechanism "sasl")
51 (autoload 'sasl-make-client "sasl")
52 (autoload 'sasl-mechanism-name "sasl")
53 (autoload 'sasl-next-step "sasl")
54 (autoload 'sasl-step-data "sasl")
55 (autoload 'sasl-step-set-data "sasl"))
57 (defvar sasl-mechanisms)
62 (luna-define-class elmo-network-session () (name
70 (luna-define-internal-accessors 'elmo-network-session))
72 (luna-define-generic elmo-network-initialize-session (session)
73 "Initialize SESSION (Called before authentication).")
75 (luna-define-generic elmo-network-initialize-session-buffer (session buffer)
76 "Initialize SESSION's BUFFER.")
78 (luna-define-generic elmo-network-authenticate-session (session)
79 "Authenticate SESSION.")
81 (luna-define-generic elmo-network-setup-session (session)
82 "Setup SESSION. (Called after authentication).")
84 (luna-define-generic elmo-network-close-session (session)
88 elmo-network-initialize-session-buffer ((session
89 elmo-network-session) buffer)
90 (with-current-buffer buffer
91 (elmo-set-buffer-multibyte nil)
92 (buffer-disable-undo (current-buffer))))
94 (luna-define-method elmo-network-close-session ((session elmo-network-session))
95 (when (elmo-network-session-process-internal session)
96 ;;; (memq (process-status (elmo-network-session-process-internal session))
98 (kill-buffer (process-buffer
99 (elmo-network-session-process-internal session)))
100 (delete-process (elmo-network-session-process-internal session))))
102 (defmacro elmo-network-stream-type-spec-string (stream-type)
103 (` (nth 0 (, stream-type))))
105 (defmacro elmo-network-stream-type-symbol (stream-type)
106 (` (nth 1 (, stream-type))))
108 (defmacro elmo-network-stream-type-feature (stream-type)
109 (` (nth 2 (, stream-type))))
111 (defmacro elmo-network-stream-type-function (stream-type)
112 (` (nth 3 (, stream-type))))
114 (defsubst elmo-network-session-password-key (session)
115 (format "%s:%s/%s@%s:%d"
117 (nth 1 (split-string (symbol-name
118 (luna-class-name session)) "[4-]")))
119 (elmo-network-session-user-internal session)
120 (elmo-network-session-auth-internal session)
121 (elmo-network-session-server-internal session)
122 (elmo-network-session-port-internal session)))
124 (defvar elmo-network-session-cache nil)
126 (defsubst elmo-network-session-cache-key (name folder)
127 "Returns session cache key for NAME and FOLDER."
128 (format "%s:%s/%s@%s:%d%s"
130 (elmo-net-folder-user-internal folder)
131 (elmo-net-folder-auth-internal folder)
132 (elmo-net-folder-server-internal folder)
133 (elmo-net-folder-port-internal folder)
135 (elmo-network-stream-type-spec-string
136 (elmo-net-folder-stream-type-internal folder)) "")))
138 (defun elmo-network-clear-session-cache ()
139 "Clear session cache."
141 (dolist (pair elmo-network-session-cache)
142 (elmo-network-close-session (cdr pair)))
143 (setq elmo-network-session-cache nil))
145 (defmacro elmo-network-session-buffer (session)
146 "Get buffer for SESSION."
147 (` (process-buffer (elmo-network-session-process-internal
150 (defun elmo-network-get-session (class name folder &optional if-exists)
151 "Get network session from session cache or a new network session.
152 CLASS is the class name of the session.
153 NAME is the name of the process.
154 FOLDER is the ELMO folder structure.
155 Returns a `elmo-network-session' instance.
156 If optional argument IF-EXISTS is non-nil, it does not return session
157 if there is no session cache.
158 if making session failed, returns nil."
159 (let (pair session key)
160 (if (not (elmo-plugged-p
161 (elmo-net-folder-server-internal folder)
162 (elmo-net-folder-port-internal folder)
163 (elmo-network-stream-type-symbol
164 (elmo-net-folder-stream-type-internal folder))))
166 (setq pair (assoc (setq key (elmo-network-session-cache-key name folder))
167 elmo-network-session-cache))
169 (not (memq (process-status
170 (elmo-network-session-process-internal
173 (setq elmo-network-session-cache
174 (delq pair elmo-network-session-cache))
175 (elmo-network-close-session (cdr pair))
178 (cdr pair) ; connection cache exists.
181 (elmo-network-open-session
184 (elmo-net-folder-server-internal folder)
185 (elmo-net-folder-port-internal folder)
186 (elmo-net-folder-user-internal folder)
187 (elmo-net-folder-auth-internal folder)
188 (elmo-net-folder-stream-type-internal folder)))
189 (setq elmo-network-session-cache
190 (cons (cons key session)
191 elmo-network-session-cache))
194 (defun elmo-network-open-session (class name server port user auth
196 "Open an authenticated network session.
197 CLASS is the class name of the session.
198 NAME is the name of the process.
199 SERVER is the name of the server server.
200 PORT is the port number of the service.
201 USER is the user-id for the authenticate.
202 AUTH is the authenticate method name (symbol).
203 STREAM-TYPE is the stream type (See also `elmo-network-stream-type-alist').
204 Returns a process object. if making session failed, returns nil."
206 (luna-make-entity class
212 :stream-type stream-type
215 (buffer (format " *%s session for %s@%s:%d%s"
220 (or (elmo-network-stream-type-spec-string stream-type)
223 (condition-case error
225 (if (get-buffer buffer) (kill-buffer buffer))
226 (setq buffer (get-buffer-create buffer))
227 (elmo-network-initialize-session-buffer session buffer)
228 (elmo-network-session-set-process-internal
230 (setq process (elmo-open-network-stream
231 (elmo-network-session-name-internal session)
232 buffer server port stream-type)))
234 (elmo-network-initialize-session session)
235 (elmo-network-authenticate-session session)
236 (elmo-network-setup-session session)))
238 (when (eq (car error) 'elmo-open-error)
239 (elmo-set-plugged nil server port
240 (elmo-network-stream-type-symbol stream-type)
242 (message "Auto plugged off at %s:%d :%s" server port (cadr error))
244 (when (eq (car error) 'elmo-authenticate-error)
245 (elmo-remove-passwd (elmo-network-session-password-key session)))
246 (elmo-network-close-session session)
247 (signal (car error)(cdr error))))
250 (defun elmo-open-network-stream (name buffer server service stream-type)
251 (let ((auto-plugged (and elmo-auto-change-plugged
252 (> elmo-auto-change-plugged 0)))
255 (elmo-network-stream-type-feature stream-type))
256 (require (elmo-network-stream-type-feature stream-type)))
258 (let (process-connection-type)
262 (funcall (elmo-network-stream-type-function stream-type)
263 name buffer server service)
264 (open-network-stream name buffer server service)))))
267 (elmo-set-plugged nil server service
268 (elmo-network-stream-type-symbol stream-type)
270 (message "Auto plugged off at %s:%d" server service)
272 (signal (car err) (cdr err))))
274 (process-kill-without-query process)
276 (elmo-set-plugged t server service
277 (elmo-network-stream-type-symbol stream-type)))
280 (defun elmo-get-network-stream-type (symbol)
281 "Return network stream type corresponding to SYMBOL.
282 Returned value is searched from `elmo-network-stream-type-alist'."
283 (let ((alist elmo-network-stream-type-alist)
286 (when (eq (nth 1 (car alist)) symbol)
287 (setq spec (car alist))
289 (setq alist (cdr alist)))
292 (luna-define-method elmo-folder-initialize ((folder
295 ;; user and auth should be set in subclass.
296 (when (string-match "\\(@[^@:/!]+\\)?\\(:[0-9]+\\)?\\(!.*\\)?$" name)
297 (if (match-beginning 1)
298 (elmo-net-folder-set-server-internal
300 (elmo-match-substring 1 name 1)))
301 (if (match-beginning 2)
302 (elmo-net-folder-set-port-internal
304 (string-to-int (elmo-match-substring 2 name 1))))
305 (if (match-beginning 3)
306 (elmo-net-folder-set-stream-type-internal
308 (assoc (elmo-match-string 3 name)
309 elmo-network-stream-type-alist)))
310 (substring name 0 (match-beginning 0))))
312 (luna-define-method elmo-net-port-info ((folder elmo-net-folder))
313 (list (elmo-net-folder-server-internal folder)
314 (elmo-net-folder-port-internal folder)
315 (elmo-network-stream-type-symbol
316 (elmo-net-folder-stream-type-internal folder))))
318 (defun elmo-net-port-label (folder)
320 (symbol-name (elmo-folder-type-internal folder))
321 (if (elmo-net-folder-stream-type-internal folder)
322 (concat "!" (symbol-name
323 (elmo-network-stream-type-symbol
324 (elmo-net-folder-stream-type-internal
327 (luna-define-method elmo-folder-plugged-p ((folder elmo-net-folder))
328 (apply 'elmo-plugged-p
329 (append (elmo-net-port-info folder)
330 (list nil (quote (elmo-net-port-label folder))))))
332 (luna-define-method elmo-folder-set-plugged ((folder elmo-net-folder)
333 plugged &optional add)
334 (apply 'elmo-set-plugged plugged
335 (append (elmo-net-port-info folder)
336 (list nil nil (quote (elmo-net-port-label folder)) add))))
338 (luna-define-method elmo-folder-exists-p ((folder elmo-net-folder))
339 (if (elmo-folder-plugged-p folder)
340 (elmo-folder-send folder 'elmo-folder-exists-p-plugged)
341 t)) ; If unplugged, assume the folder exists.
343 (luna-define-method elmo-folder-status ((folder elmo-net-folder))
344 (if (elmo-folder-plugged-p folder)
345 (elmo-folder-send folder 'elmo-folder-status-plugged)
346 (elmo-folder-send folder 'elmo-folder-status-unplugged)))
348 (luna-define-method elmo-folder-status-unplugged
349 ((folder elmo-net-folder))
350 (if elmo-enable-disconnected-operation
351 (elmo-folder-status-dop folder)
352 (error "Unplugged")))
354 (luna-define-method elmo-folder-list-messages-internal
355 ((folder elmo-net-folder) &optional nohide)
356 (elmo-net-folder-list-messages-internal folder nohide))
358 (defun elmo-net-folder-list-messages-internal (folder nohide)
359 (if (elmo-folder-plugged-p folder)
360 (elmo-folder-send folder 'elmo-folder-list-messages-plugged nohide)
361 (elmo-folder-send folder 'elmo-folder-list-messages-unplugged)))
363 (luna-define-method elmo-folder-list-messages-plugged
364 ((folder elmo-net-folder))
367 ;; Should consider offline append and removal.
368 (luna-define-method elmo-folder-list-messages-unplugged ((folder
370 (if elmo-enable-disconnected-operation
371 (let ((deleting (elmo-dop-list-deleting-messages folder)))
373 ;; delete deleting messages
375 (lambda (number) (memq number deleting))
376 ;; current number-list.
379 (elmo-msgdb-get-number-alist (elmo-folder-msgdb folder))))
380 ;; append appending messages
381 (mapcar (lambda (x) (* -1 x))
382 (elmo-dop-spool-folder-list-messages folder))))
385 (luna-define-method elmo-folder-list-unreads-internal
386 ((folder elmo-net-folder) unread-marks &optional mark-alist)
387 (if (and (elmo-folder-plugged-p folder)
388 (elmo-folder-use-flag-p folder))
389 (elmo-folder-send folder 'elmo-folder-list-unreads-plugged)
392 (luna-define-method elmo-folder-list-importants-internal
393 ((folder elmo-net-folder) important-mark)
394 (if (and (elmo-folder-plugged-p folder)
395 (elmo-folder-use-flag-p folder))
396 (elmo-folder-send folder 'elmo-folder-list-importants-plugged)
399 (luna-define-method elmo-folder-list-unreads-plugged
400 ((folder elmo-net-folder))
403 (luna-define-method elmo-folder-list-importants-plugged
404 ((folder elmo-net-folder))
407 (luna-define-method elmo-folder-delete-messages ((folder elmo-net-folder)
409 (if (elmo-folder-plugged-p folder)
410 (elmo-folder-send folder 'elmo-folder-delete-messages-plugged numbers)
411 (elmo-folder-send folder 'elmo-folder-delete-messages-unplugged numbers)))
413 (luna-define-method elmo-folder-delete-messages-unplugged ((folder
416 (elmo-folder-delete-messages-dop folder numbers))
418 (luna-define-method elmo-folder-msgdb-create ((folder elmo-net-folder)
420 already-mark seen-mark
421 important-mark seen-list)
422 (if (elmo-folder-plugged-p folder)
423 (elmo-folder-send folder 'elmo-folder-msgdb-create-plugged
426 already-mark seen-mark
427 important-mark seen-list)
428 (elmo-folder-send folder 'elmo-folder-msgdb-create-unplugged
430 new-mark already-mark seen-mark
431 important-mark seen-list)))
433 (luna-define-method elmo-folder-msgdb-create-unplugged ((folder
436 new-mark already-mark
440 ;; XXXX should be appended to already existing msgdb.
442 (elmo-folder-msgdb-create (elmo-dop-spool-folder folder)
443 (mapcar 'abs numbers)
444 new-mark already-mark
449 (luna-define-method elmo-folder-unmark-important ((folder elmo-net-folder)
451 (if (elmo-folder-use-flag-p folder)
452 (if (elmo-folder-plugged-p folder)
453 (elmo-folder-send folder 'elmo-folder-unmark-important-plugged
455 (elmo-folder-send folder
456 'elmo-folder-unmark-important-unplugged numbers))
459 (luna-define-method elmo-folder-mark-as-important ((folder elmo-net-folder)
461 (if (elmo-folder-use-flag-p folder)
462 (if (elmo-folder-plugged-p folder)
463 (elmo-folder-send folder 'elmo-folder-mark-as-important-plugged
465 (elmo-folder-send folder 'elmo-folder-mark-as-important-unplugged
469 (luna-define-method elmo-folder-unmark-read ((folder elmo-net-folder)
471 (if (elmo-folder-use-flag-p folder)
472 (if (elmo-folder-plugged-p folder)
473 (elmo-folder-send folder 'elmo-folder-unmark-read-plugged numbers)
474 (elmo-folder-send folder 'elmo-folder-unmark-read-unplugged numbers))
477 (luna-define-method elmo-folder-mark-as-read ((folder elmo-net-folder)
479 (if (elmo-folder-use-flag-p folder)
480 (if (elmo-folder-plugged-p folder)
481 (elmo-folder-send folder 'elmo-folder-mark-as-read-plugged numbers)
483 folder 'elmo-folder-mark-as-read-unplugged numbers))
486 (luna-define-method elmo-folder-mark-as-read-unplugged ((folder
489 (elmo-folder-mark-as-read-dop folder numbers))
491 (luna-define-method elmo-folder-unmark-read-unplugged ((folder elmo-net-folder)
493 (elmo-folder-unmark-read-dop folder numbers))
495 (luna-define-method elmo-folder-mark-as-important-unplugged ((folder
498 (elmo-folder-mark-as-important-dop folder numbers))
500 (luna-define-method elmo-folder-unmark-important-unplugged ((folder
503 (elmo-folder-unmark-important-dop folder numbers))
505 (luna-define-method elmo-message-encache :around ((folder elmo-net-folder)
506 number &optional read)
507 (if (elmo-folder-plugged-p folder)
508 (luna-call-next-method)
509 (if elmo-enable-disconnected-operation
510 (elmo-message-encache-dop folder number read)
511 (error "Unplugged"))))
513 (luna-define-generic elmo-message-fetch-plugged (folder number strategy
520 (luna-define-generic elmo-message-fetch-unplugged (folder number strategy
527 (luna-define-method elmo-message-fetch-internal ((folder elmo-net-folder)
529 &optional section unseen)
530 (if (elmo-folder-plugged-p folder)
531 (elmo-message-fetch-plugged folder number
533 (current-buffer) unseen)
534 (elmo-message-fetch-unplugged folder number
536 (current-buffer) unseen)))
538 (luna-define-method elmo-message-fetch-unplugged
539 ((folder elmo-net-folder) number strategy &optional section outbuf unseen)
540 (if (and elmo-enable-disconnected-operation
542 (elmo-message-fetch-internal
543 (elmo-dop-spool-folder folder) (abs number) strategy
545 (error "Unplugged")))
547 (luna-define-method elmo-folder-check ((folder elmo-net-folder))
548 (if (elmo-folder-plugged-p folder)
549 (elmo-folder-send folder 'elmo-folder-check-plugged)))
551 (luna-define-method elmo-folder-close :after ((folder elmo-net-folder))
552 (if (elmo-folder-plugged-p folder)
553 (elmo-folder-send folder 'elmo-folder-check-plugged)))
555 (luna-define-method elmo-folder-diff :around ((folder elmo-net-folder)
557 (if (and (elmo-folder-use-flag-p folder)
558 (elmo-folder-plugged-p folder))
559 (elmo-folder-send folder 'elmo-folder-diff-plugged)
560 (luna-call-next-method)))
562 (luna-define-method elmo-folder-local-p ((folder elmo-net-folder))
565 (luna-define-method elmo-quit ((folder elmo-net-folder))
566 (elmo-network-clear-session-cache))
569 (product-provide (provide 'elmo-net) (require 'elmo-version))
571 ;;; elmo-net.el ends here