elmo/elmo-shimbun.el

   1 ;;; elmo-shimbun.el --- Shimbun interface for ELMO.
   2
   3 ;; Copyright (C) 2001 Yuuichi Teranishi <teranisi@gohome.org>
   4
   5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
   6 ;; Keywords: mail, net news
   7
   8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
   9
  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)
  13 ;; any later version.
  14 ;;
  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.
  19 ;;
  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.
  24 ;;
  25
  26 ;;; Commentary:
  27 ;;
  28
  29 ;;; Code:
  30 ;;
  31 (require 'elmo)
  32 (require 'elmo-map)
  33 (require 'elmo-dop)
  34 (require 'shimbun)
  35
  36 (eval-when-compile
  37   (defun-maybe shimbun-servers-list ()))
  38
  39 (defcustom elmo-shimbun-check-interval 60
  40   "*Check interval for shimbun."
  41   :type 'integer
  42   :group 'elmo)
  43
  44 (defcustom elmo-shimbun-default-index-range 2
  45   "*Default value for the range of header indices."
  46   :type '(choice (const :tag "all" all)
  47                  (const :tag "last" last)
  48                  (integer :tag "number"))
  49   :group 'elmo)
  50
  51 (defcustom elmo-shimbun-use-cache t
  52   "*If non-nil, use cache for each article."
  53   :type 'boolean
  54   :group 'elmo)
  55
  56 (defcustom elmo-shimbun-index-range-alist nil
  57   "*Alist of FOLDER-REGEXP and RANGE.
  58 FOLDER-REGEXP is the regexp for shimbun folder name.
  59 RANGE is the range of the header indices .
  60 See `shimbun-headers' for more detail about RANGE."
  61   :type '(repeat (cons (regexp :tag "Folder Regexp")
  62                        (choice (const :tag "all" all)
  63                                (const :tag "last" last)
  64                                (integer :tag "number"))))
  65   :group 'elmo)
  66
  67 (defcustom elmo-shimbun-update-overview-folder-list 'all
  68   "*List of FOLDER-REGEXP.
  69 FOLDER-REGEXP is the regexp of shimbun folder name which should be
  70 update overview when message is fetched.
  71 If it is the symbol `all', update overview for all shimbun folders."
  72   :type '(choice (const :tag "All shimbun folders" all)
  73                  (repeat (regexp :tag "Folder Regexp")))
  74   :group 'elmo)
  75
  76 ;; Shimbun header.
  77 (defsubst elmo-shimbun-header-extra-field (header field-name)
  78   (let ((extra (and header (shimbun-header-extra header))))
  79     (and extra
  80          (cdr (assoc field-name extra)))))
  81
  82 (defsubst elmo-shimbun-header-set-extra-field (header field-name value)
  83   (let ((extras (and header (shimbun-header-extra header)))
  84         extra)
  85     (if (setq extra (assoc field-name extras))
  86         (setcdr extra value)
  87       (shimbun-header-set-extra
  88        header
  89        (cons (cons field-name value) extras)))))
  90
  91 ;; Shimbun mua.
  92 (eval-and-compile
  93   (luna-define-class shimbun-elmo-mua (shimbun-mua) (folder))
  94   (luna-define-internal-accessors 'shimbun-elmo-mua))
  95
  96 (luna-define-method shimbun-mua-search-id ((mua shimbun-elmo-mua) id)
  97   (elmo-message-entity (shimbun-elmo-mua-folder-internal mua) id))
  98
  99 (eval-and-compile
 100   (luna-define-class elmo-shimbun-folder
 101                      (elmo-map-folder) (shimbun headers header-hash
 102                                                 entity-hash
 103                                                 group range last-check))
 104   (luna-define-internal-accessors 'elmo-shimbun-folder))
 105
 106 (defun elmo-shimbun-folder-entity-hash (folder)
 107   (or (elmo-shimbun-folder-entity-hash-internal folder)
 108       (let ((overviews (elmo-folder-list-message-entities folder))
 109             hash id)
 110         (when overviews
 111           (setq hash (elmo-make-hash (length overviews)))
 112           (dolist (entity overviews)
 113             (elmo-set-hash-val (elmo-message-entity-field entity 'message-id)
 114                                entity hash)
 115             (when (setq id (elmo-message-entity-field entity 'x-original-id))
 116               (elmo-set-hash-val id entity hash)))
 117           (elmo-shimbun-folder-set-entity-hash-internal folder hash)))))
 118
 119 (defsubst elmo-shimbun-folder-shimbun-header (folder location)
 120   (let ((hash (elmo-shimbun-folder-header-hash-internal folder)))
 121     (or (and hash (elmo-get-hash-val location hash))
 122         (let ((entity (elmo-message-entity folder location))
 123               (elmo-hash-minimum-size 63)
 124               header)
 125           (when entity
 126             (setq header (elmo-shimbun-entity-to-header entity))
 127             (unless hash
 128               (elmo-shimbun-folder-set-header-hash-internal
 129                folder
 130                (setq hash (elmo-make-hash))))
 131             (elmo-set-hash-val (elmo-message-entity-field entity
 132                                                           'message-id)
 133                                header
 134                                hash)
 135             header)))))
 136
 137 (defsubst elmo-shimbun-lapse-seconds (time)
 138   (let ((now (current-time)))
 139     (+ (* (- (car now) (car time)) 65536)
 140        (- (nth 1 now) (nth 1 time)))))
 141
 142 (defun elmo-shimbun-parse-time-string (string)
 143   "Parse the time-string STRING and return its time as Emacs style."
 144   (ignore-errors
 145     (let ((x (timezone-fix-time string nil nil)))
 146       (encode-time (aref x 5) (aref x 4) (aref x 3)
 147                    (aref x 2) (aref x 1) (aref x 0)
 148                    (aref x 6)))))
 149
 150 (defsubst elmo-shimbun-headers-check-p (folder)
 151   (or (null (elmo-shimbun-folder-last-check-internal folder))
 152       (and (elmo-shimbun-folder-last-check-internal folder)
 153            (> (elmo-shimbun-lapse-seconds
 154                (elmo-shimbun-folder-last-check-internal folder))
 155               elmo-shimbun-check-interval))))
 156
 157 (defun elmo-shimbun-entity-to-header (entity)
 158   (let (message-id shimbun-id)
 159     (if (setq message-id (elmo-message-entity-field
 160                           entity 'x-original-id))
 161         (setq shimbun-id (elmo-message-entity-field entity 'message-id))
 162       (setq message-id (elmo-message-entity-field entity 'message-id)
 163             shimbun-id nil))
 164     (elmo-set-work-buf
 165      (set-buffer-multibyte t)
 166      (shimbun-make-header
 167       (elmo-message-entity-number entity)
 168       (shimbun-mime-encode-string
 169        (elmo-message-entity-field entity 'subject 'decode))
 170       (shimbun-mime-encode-string
 171        (elmo-message-entity-field entity 'from 'decode))
 172       (elmo-message-entity-field entity 'date)
 173       message-id
 174       (elmo-message-entity-field entity 'references)
 175       0
 176       0
 177       (elmo-message-entity-field entity 'xref)
 178       (and shimbun-id
 179            (list (cons "x-shimbun-id" shimbun-id)))))))
 180
 181 (defsubst elmo-shimbun-folder-header-hash-setup (folder headers)
 182   (let ((hash (or (elmo-shimbun-folder-header-hash-internal folder)
 183                   (elmo-make-hash (length headers)))))
 184     (dolist (header headers)
 185       (elmo-set-hash-val (shimbun-header-id header) header hash))
 186     (elmo-shimbun-folder-set-header-hash-internal folder hash)))
 187
 188 (defun elmo-shimbun-get-headers (folder)
 189   (let* ((shimbun (elmo-shimbun-folder-shimbun-internal folder))
 190          (key (concat (shimbun-server shimbun)
 191                       "." (shimbun-current-group shimbun)))
 192          (elmo-hash-minimum-size 63)
 193          headers)
 194     ;; new headers.
 195     (setq headers
 196           (delq nil
 197                 (mapcar
 198                  (lambda (x)
 199                    (unless (elmo-message-entity folder (shimbun-header-id x))
 200                      x))
 201                  ;; This takes much time.
 202                  (shimbun-headers
 203                   (elmo-shimbun-folder-shimbun-internal folder)
 204                   (elmo-shimbun-folder-range-internal folder)))))
 205     (elmo-shimbun-folder-set-headers-internal folder headers)
 206     (when headers
 207       (elmo-shimbun-folder-header-hash-setup folder headers))
 208     (elmo-shimbun-folder-set-last-check-internal folder (current-time))))
 209
 210 (luna-define-method elmo-folder-initialize ((folder
 211                                              elmo-shimbun-folder)
 212                                             name)
 213   (if (string= name "")
 214       folder
 215     (let ((server-group (if (string-match "\\([^.]+\\)\\." name)
 216                             (list (elmo-match-string 1 name)
 217                                   (substring name (match-end 0)))
 218                           (list name))))
 219       (when (nth 0 server-group) ; server
 220         (elmo-shimbun-folder-set-shimbun-internal
 221          folder
 222          (condition-case nil
 223              (shimbun-open (nth 0 server-group)
 224                            (luna-make-entity 'shimbun-elmo-mua :folder folder))
 225            (file-error
 226             (luna-make-entity 'shimbun :server (nth 0 server-group))))))
 227       (when (nth 1 server-group)
 228         (elmo-shimbun-folder-set-group-internal
 229          folder
 230          (nth 1 server-group)))
 231       (elmo-shimbun-folder-set-range-internal
 232        folder
 233        (or (cdr (elmo-string-matched-assoc (elmo-folder-name-internal folder)
 234                                            elmo-shimbun-index-range-alist))
 235            elmo-shimbun-default-index-range))
 236       folder)))
 237
 238 (luna-define-method elmo-folder-open-internal ((folder elmo-shimbun-folder))
 239   (when (elmo-shimbun-folder-shimbun-internal folder)
 240     (shimbun-open-group
 241      (elmo-shimbun-folder-shimbun-internal folder)
 242      (elmo-shimbun-folder-group-internal folder))
 243     (let ((inhibit-quit t))
 244       (unless (elmo-map-folder-location-alist-internal folder)
 245         (elmo-map-folder-location-setup
 246          folder
 247          (elmo-msgdb-location-load (elmo-folder-msgdb-path folder))))
 248       (when (and (elmo-folder-plugged-p folder)
 249                  (elmo-shimbun-headers-check-p folder))
 250         (elmo-shimbun-get-headers folder)
 251         (elmo-map-folder-update-locations
 252          folder
 253          (elmo-map-folder-list-message-locations folder))))))
 254
 255 (luna-define-method elmo-folder-reserve-status-p ((folder elmo-shimbun-folder))
 256   t)
 257
 258 (luna-define-method elmo-folder-local-p ((folder elmo-shimbun-folder))
 259   nil)
 260
 261 (luna-define-method elmo-message-use-cache-p ((folder elmo-shimbun-folder)
 262                                               number)
 263   elmo-shimbun-use-cache)
 264
 265 (luna-define-method elmo-folder-close-internal :after ((folder
 266                                                         elmo-shimbun-folder))
 267   (shimbun-close-group
 268    (elmo-shimbun-folder-shimbun-internal folder))
 269   (elmo-shimbun-folder-set-headers-internal
 270    folder nil)
 271   (elmo-shimbun-folder-set-header-hash-internal
 272    folder nil)
 273   (elmo-shimbun-folder-set-entity-hash-internal
 274    folder nil)
 275   (elmo-shimbun-folder-set-last-check-internal
 276    folder nil))
 277
 278 (luna-define-method elmo-folder-plugged-p ((folder elmo-shimbun-folder))
 279   (elmo-plugged-p
 280    "shimbun"
 281    (and (elmo-shimbun-folder-shimbun-internal folder)
 282         (shimbun-server (elmo-shimbun-folder-shimbun-internal folder)))
 283    nil nil
 284    (and (elmo-shimbun-folder-shimbun-internal folder)
 285         (shimbun-server (elmo-shimbun-folder-shimbun-internal folder)))))
 286
 287 (luna-define-method elmo-folder-set-plugged ((folder elmo-shimbun-folder)
 288                                              plugged &optional add)
 289   (elmo-set-plugged plugged
 290                     "shimbun"
 291                     (shimbun-server
 292                      (elmo-shimbun-folder-shimbun-internal folder))
 293                     nil nil nil
 294                     (shimbun-server
 295                      (elmo-shimbun-folder-shimbun-internal folder))
 296                     add))
 297
 298 (luna-define-method elmo-net-port-info ((folder elmo-shimbun-folder))
 299   (list "shimbun"
 300         (shimbun-server
 301          (elmo-shimbun-folder-shimbun-internal folder))
 302         nil))
 303
 304 (luna-define-method elmo-folder-check :around ((folder elmo-shimbun-folder))
 305   (when (shimbun-current-group
 306          (elmo-shimbun-folder-shimbun-internal folder))
 307     (when (and (elmo-folder-plugged-p folder)
 308                (elmo-shimbun-headers-check-p folder))
 309       (elmo-shimbun-get-headers folder)
 310       (luna-call-next-method))))
 311
 312 (luna-define-method elmo-folder-clear :around ((folder elmo-shimbun-folder)
 313                                                &optional keep-killed)
 314   (elmo-shimbun-folder-set-headers-internal folder nil)
 315   (elmo-shimbun-folder-set-header-hash-internal folder nil)
 316   (elmo-shimbun-folder-set-entity-hash-internal folder nil)
 317   (elmo-shimbun-folder-set-last-check-internal folder nil)
 318   (luna-call-next-method))
 319
 320 (luna-define-method elmo-folder-expand-msgdb-path ((folder
 321                                                     elmo-shimbun-folder))
 322   (expand-file-name
 323    (concat (shimbun-server
 324             (elmo-shimbun-folder-shimbun-internal folder))
 325            "/"
 326            (elmo-shimbun-folder-group-internal folder))
 327    (expand-file-name "shimbun" elmo-msgdb-directory)))
 328
 329 (defun elmo-shimbun-msgdb-create-entity (folder number)
 330   (let ((header (elmo-shimbun-folder-shimbun-header
 331                  folder
 332                  (elmo-map-message-location folder number)))
 333         ov)
 334     (when header
 335       (with-temp-buffer
 336         (shimbun-header-insert
 337          (elmo-shimbun-folder-shimbun-internal folder)
 338          header)
 339         (setq ov (elmo-msgdb-create-message-entity-from-buffer
 340                   (elmo-msgdb-message-entity-handler
 341                    (elmo-folder-msgdb-internal folder)) number))
 342         (elmo-message-entity-set-field
 343          ov
 344          'xref (shimbun-header-xref header)))
 345       ov)))
 346
 347 (luna-define-method elmo-folder-msgdb-create ((folder elmo-shimbun-folder)
 348                                               numlist flag-table)
 349   (let ((new-msgdb (elmo-make-msgdb))
 350         entity i percent length msgid flags)
 351     (setq length (length numlist))
 352     (setq i 0)
 353     (message "Creating msgdb...")
 354     (while numlist
 355       (setq entity
 356             (elmo-shimbun-msgdb-create-entity
 357              folder (car numlist)))
 358       (when entity
 359         (setq msgid (elmo-message-entity-field entity 'message-id)
 360               flags (elmo-flag-table-get flag-table msgid))
 361         (elmo-global-flags-set flags folder (car numlist) msgid)
 362         (elmo-msgdb-append-entity new-msgdb entity flags))
 363       (when (> length elmo-display-progress-threshold)
 364         (setq i (1+ i))
 365         (setq percent (/ (* i 100) length))
 366         (elmo-display-progress
 367          'elmo-folder-msgdb-create "Creating msgdb..."
 368          percent))
 369       (setq numlist (cdr numlist)))
 370     (message "Creating msgdb...done")
 371     (elmo-msgdb-sort-by-date new-msgdb)))
 372
 373 (luna-define-method elmo-folder-message-file-p ((folder elmo-shimbun-folder))
 374   nil)
 375
 376 (defsubst elmo-shimbun-update-overview (folder shimbun-id header)
 377   (let ((entity (elmo-message-entity folder shimbun-id))
 378         (message-id (shimbun-header-id header))
 379         references)
 380     (unless (string= shimbun-id message-id)
 381       (elmo-message-entity-set-field
 382        entity 'x-original-id message-id)
 383       (elmo-shimbun-header-set-extra-field
 384        header "x-shimbun-id" shimbun-id)
 385       (elmo-set-hash-val message-id
 386                          entity
 387                          (elmo-shimbun-folder-entity-hash folder))
 388       (elmo-set-hash-val shimbun-id
 389                          entity
 390                          (elmo-shimbun-folder-entity-hash folder)))
 391     (elmo-message-entity-set-field
 392      entity
 393      'from
 394      (elmo-mime-string (shimbun-header-from header)))
 395     (elmo-message-entity-set-field
 396      entity
 397      'subject
 398      (elmo-mime-string (shimbun-header-subject header)))
 399     (elmo-message-entity-set-field
 400      entity
 401      'date
 402      (shimbun-header-date header))
 403     (when (setq references
 404                 (or (elmo-msgdb-get-last-message-id
 405                      (elmo-field-body "in-reply-to"))
 406                     (elmo-msgdb-get-last-message-id
 407                      (elmo-field-body "references"))))
 408       (elmo-message-entity-set-field
 409        entity
 410        'references
 411        (or (elmo-message-entity-field
 412             (elmo-get-hash-val
 413              references
 414              (elmo-shimbun-folder-entity-hash folder))
 415             'message-id)
 416            references)))))
 417
 418 (luna-define-method elmo-map-message-fetch ((folder elmo-shimbun-folder)
 419                                             location strategy
 420                                             &optional section unseen)
 421   (if (elmo-folder-plugged-p folder)
 422       (let ((header (elmo-shimbun-folder-shimbun-header
 423                      folder
 424                      location))
 425             shimbun-id)
 426         (shimbun-article (elmo-shimbun-folder-shimbun-internal folder)
 427                          header)
 428         (when (or (eq elmo-shimbun-update-overview-folder-list 'all)
 429                   (elmo-string-match-member
 430                    (elmo-folder-name-internal folder)
 431                    elmo-shimbun-update-overview-folder-list))
 432           (elmo-shimbun-update-overview folder location header))
 433         (when (setq shimbun-id
 434                     (elmo-shimbun-header-extra-field header "x-shimbun-id"))
 435           (goto-char (point-min))
 436           (insert (format "X-Shimbun-Id: %s\n" shimbun-id)))
 437         t)
 438     (error "Unplugged")))
 439
 440 (luna-define-method elmo-message-encache :around ((folder
 441                                                    elmo-shimbun-folder)
 442                                                   number &optional read)
 443   (if (elmo-folder-plugged-p folder)
 444       (luna-call-next-method)
 445     (if elmo-enable-disconnected-operation
 446         (elmo-message-encache-dop folder number read)
 447       (error "Unplugged"))))
 448
 449 (luna-define-method elmo-folder-list-messages-internal :around
 450   ((folder elmo-shimbun-folder) &optional nohide)
 451   (if (elmo-folder-plugged-p folder)
 452       (luna-call-next-method)
 453     t))
 454
 455 (luna-define-method elmo-map-folder-list-message-locations
 456   ((folder elmo-shimbun-folder))
 457   (let ((expire-days (shimbun-article-expiration-days
 458                       (elmo-shimbun-folder-shimbun-internal folder))))
 459     (elmo-uniq-list
 460      (nconc
 461       (delq nil
 462             (mapcar
 463              (lambda (ov)
 464                (when (and (elmo-message-entity-field ov 'xref)
 465                           (if expire-days
 466                               (< (elmo-shimbun-lapse-seconds
 467                                   (elmo-shimbun-parse-time-string
 468                                    (elmo-message-entity-field ov 'date)))
 469                                  (* expire-days 86400 ; seconds per day
 470                                     ))
 471                             t))
 472                  (elmo-message-entity-field ov 'message-id)))
 473              (elmo-folder-list-message-entities folder)))
 474       (mapcar
 475        (lambda (header)
 476          (or (elmo-shimbun-header-extra-field header "x-shimbun-id")
 477              (shimbun-header-id header)))
 478        (elmo-shimbun-folder-headers-internal folder))))))
 479
 480 (luna-define-method elmo-folder-list-subfolders ((folder elmo-shimbun-folder)
 481                                                  &optional one-level)
 482   (let ((prefix (elmo-folder-prefix-internal folder)))
 483     (cond ((elmo-shimbun-folder-shimbun-internal folder)
 484            (unless (elmo-shimbun-folder-group-internal folder)
 485              (mapcar
 486               (lambda (fld)
 487                 (concat prefix
 488                         (shimbun-server
 489                          (elmo-shimbun-folder-shimbun-internal folder))
 490                         "." fld))
 491               (shimbun-groups (elmo-shimbun-folder-shimbun-internal folder)))))
 492           ;; the rest are for "@/" group
 493           (one-level
 494            (mapcar
 495             (lambda (server) (list (concat prefix server)))
 496             (shimbun-servers-list)))
 497           (t
 498            (let (folders)
 499              (dolist (server (shimbun-servers-list))
 500                (setq folders
 501                      (append folders
 502                              (mapcar
 503                               (lambda (fld) (concat prefix server "." fld))
 504                               (shimbun-groups
 505                                (shimbun-open server
 506                                              (let ((fld
 507                                                     (elmo-make-folder
 508                                                      (concat prefix server))))
 509                                                (luna-make-entity
 510                                                 'shimbun-elmo-mua
 511                                                 :folder fld))))))))
 512              folders)))))
 513
 514 (luna-define-method elmo-folder-exists-p ((folder elmo-shimbun-folder))
 515   (if (elmo-shimbun-folder-group-internal folder)
 516       (progn
 517         (member
 518          (elmo-shimbun-folder-group-internal folder)
 519          (shimbun-groups (elmo-shimbun-folder-shimbun-internal
 520                           folder))))
 521     t))
 522
 523 (luna-define-method elmo-folder-delete-messages ((folder elmo-shimbun-folder)
 524                                                  numbers)
 525   (elmo-folder-kill-messages folder numbers)
 526   t)
 527
 528 (require 'product)
 529 (product-provide (provide 'elmo-shimbun) (require 'elmo-version))
 530
 531 ;;; elmo-shimbun.el ends here