/usr/share/emacs/site-lisp/wl/elmo/elmo-flag.el is in wl-beta 2.15.9+0.20151119-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 | ;;; elmo-flag.el --- global flag handling.
;; Copyright (C) 2003 Yuuichi Teranishi <teranisi@gohome.org>
;; Author: Yuuichi Teranishi <teranisi@gohome.org>
;; Keywords: mail, net news
;; This file is part of ELMO (Elisp Library for Message Orchestration).
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;
;;; Commentary:
;;
;;; Code:
(require 'elmo-util)
(require 'elmo-localdir)
(eval-when-compile (require 'cl))
(defcustom elmo-global-flags '(important)
"A list of flag symbol which is managed globally by the flag folder."
:type '(repeat symbol)
:group 'elmo)
(defcustom elmo-local-flags '(unread any digest)
"A list of flag symbol which is not treated as global flag."
:type '(repeat symbol)
:group 'elmo)
(defvar elmo-global-flag-folder-alist nil
"Internal variable to hold global-flag-folder structures.")
(eval-and-compile
(defconst elmo-flag-char-regexp "]!#$&'+,./0-9:;<=>?@A-Z[^_`a-z|}~-"))
(defun elmo-flag-valid-p (flag)
(string-match (eval-when-compile
(concat "^[" elmo-flag-char-regexp "]+$"))
(if (stringp flag) flag (symbol-name flag))))
(eval-and-compile
(luna-define-class elmo-flag-folder (elmo-localdir-folder)
(flag minfo minfo-hash max-number))
(luna-define-internal-accessors 'elmo-flag-folder))
(luna-define-method elmo-folder-initialize ((folder
elmo-flag-folder)
name)
(unless (string-match (eval-when-compile
(concat "^flag\\(/\\(["
elmo-flag-char-regexp
"]+\\)\\)?$"))
name)
(error "Error in folder name `%s'" (elmo-folder-name-internal folder)))
(if (match-beginning 1)
(setq name (match-string 2 name))
(setq name (symbol-name (car elmo-global-flags)))
(elmo-folder-set-name-internal
folder
(concat (elmo-folder-name-internal folder) "/" name)))
(or (cdr (assq (intern name) elmo-global-flag-folder-alist))
(let ((flag (intern name))
msgdb-path)
(elmo-flag-folder-set-flag-internal folder flag)
(unless (elmo-global-flag-p flag)
(setq elmo-global-flags
(nconc elmo-global-flags (list flag))))
;; must be AFTER set flag slot.
(setq msgdb-path (elmo-folder-msgdb-path folder))
(unless (file-directory-p msgdb-path)
(elmo-make-directory msgdb-path))
(elmo-localdir-folder-set-dir-name-internal
folder
msgdb-path)
(elmo-localdir-folder-set-directory-internal
folder
msgdb-path)
(if (file-exists-p (expand-file-name "max" msgdb-path))
(elmo-flag-folder-set-max-number-internal
folder
(elmo-object-load (expand-file-name "max" msgdb-path))))
(elmo-flag-folder-set-minfo
folder
(and (file-exists-p (expand-file-name ".minfo" msgdb-path))
(elmo-object-load (expand-file-name ".minfo" msgdb-path))))
(setq elmo-global-flag-folder-alist
(cons (cons flag folder) elmo-global-flag-folder-alist))
folder)))
(defun elmo-flag-folder-set-minfo (folder minfo)
(let ((hash (elmo-make-hash (length minfo))))
(dolist (elem minfo)
(elmo-set-hash-val (nth 1 elem) elem hash)
(elmo-set-hash-val (concat "#" (number-to-string (nth 2 elem)))
elem hash)
(dolist (pair (car elem))
(elmo-set-hash-val (concat (number-to-string (cdr pair))
":" (car pair))
elem hash)))
(elmo-flag-folder-set-minfo-internal folder minfo)
(elmo-flag-folder-set-minfo-hash-internal folder hash)))
(luna-define-method elmo-folder-expand-msgdb-path ((folder elmo-flag-folder))
(expand-file-name (concat "flag/"
(elmo-replace-string-as-filename
(symbol-name
(elmo-flag-folder-flag-internal folder))))
elmo-msgdb-directory))
(luna-define-method elmo-folder-commit :after ((folder
elmo-flag-folder))
(elmo-object-save
(expand-file-name ".minfo" (elmo-folder-msgdb-path folder))
(elmo-flag-folder-minfo-internal folder)
elmo-mime-charset)
(if (elmo-flag-folder-max-number-internal folder)
(elmo-object-save
(expand-file-name "max" (elmo-folder-msgdb-path folder))
(elmo-flag-folder-max-number-internal folder))))
(luna-define-method elmo-folder-list-subfolders ((folder elmo-flag-folder)
&optional one-level)
(mapcar (lambda (flag)
(concat
(elmo-folder-prefix-internal folder)
(symbol-name (elmo-folder-type-internal folder))
"/"
(symbol-name flag)))
elmo-global-flags))
(defun elmo-flag-folder-delete-message (folder number
&optional keep-referrer)
(let* ((elem (elmo-get-hash-val (concat "#" (number-to-string number))
(elmo-flag-folder-minfo-hash-internal
folder)))
target-folder key)
(dolist (pair (car elem))
(when (and (car pair) (cdr pair))
(elmo-clear-hash-val (concat (number-to-string (cdr pair)) ":"
(car pair))
(elmo-flag-folder-minfo-hash-internal
folder))
(unless keep-referrer
(setq target-folder (elmo-get-folder (car pair)))
(elmo-folder-open target-folder 'load-msgdb)
;; Unset the flag of the original folder.
;; (XXX Should the message-id checked?)
(elmo-message-unset-flag target-folder (cdr pair)
(elmo-flag-folder-flag-internal folder))
(elmo-folder-close target-folder))))
(elmo-clear-hash-val (concat "#" (number-to-string number))
(elmo-flag-folder-minfo-hash-internal
folder))
(elmo-clear-hash-val (nth 1 elem) (elmo-flag-folder-minfo-hash-internal
folder))
(elmo-flag-folder-set-minfo-internal
folder
(delq elem (elmo-flag-folder-minfo-internal folder))))
t)
(luna-define-method elmo-folder-delete-messages-internal ((folder
elmo-flag-folder)
numbers)
(dolist (number numbers)
(elmo-flag-folder-delete-message folder number)
(elmo-localdir-delete-message folder number))
(elmo-folder-commit folder)
t)
;; Same as localdir except that the flag is always the flag.
(luna-define-method elmo-folder-msgdb-create ((folder elmo-flag-folder)
numbers
flag-table)
(when numbers
(let ((dir (elmo-localdir-folder-directory-internal folder))
(new-msgdb (elmo-make-msgdb))
(flags (list (elmo-flag-folder-flag-internal folder)))
entity)
(elmo-with-progress-display (elmo-folder-msgdb-create (length numbers))
"Creating msgdb"
(dolist (number numbers)
(when (setq entity (elmo-localdir-msgdb-create-entity
new-msgdb dir number))
(elmo-msgdb-append-entity new-msgdb entity flags))
(elmo-progress-notify 'elmo-folder-msgdb-create)))
new-msgdb)))
(defun elmo-folder-append-messages-*-flag (dst-folder
src-folder
numbers
same-number)
(let ((flag (elmo-flag-folder-flag-internal dst-folder)))
(dolist (number numbers)
(elmo-global-flag-set flag src-folder number
(elmo-message-field
src-folder number 'message-id)))
(elmo-folder-set-flag src-folder numbers flag))
numbers)
(luna-define-method elmo-folder-append-buffer ((folder elmo-flag-folder)
&optional flag number
return-number)
(error "Cannot append to the flag folder"))
(luna-define-method elmo-folder-unset-flag :before ((folder elmo-flag-folder)
numbers
flag
&optional is-local)
(when (eq flag (elmo-flag-folder-flag-internal folder))
(error "Cannot unset flag `%s' in this folder" flag)))
;;; Utilities
(defmacro elmo-flag-get-folder (flag)
"Get the flag folder structure for FLAG."
`(when (memq ,flag elmo-global-flags)
(elmo-get-folder (concat "'flag/" (symbol-name ,flag)))))
(defun elmo-flag-folder-referrer (folder number)
"Return a list of referrer message information.
Each element is a cons cell like following:
\(FNAME . NUMBER\)
FNAME is the name of the folder which the message is contained.
NUMBER is the number of the message."
(when (eq (elmo-folder-type-internal folder) 'flag)
(car (elmo-get-hash-val (concat "#" (number-to-string number))
(elmo-flag-folder-minfo-hash-internal
folder)))))
;;; Global-Flag API
(defun elmo-global-flag-p (flag)
"Return non-nil when FLAG is global."
(memq flag elmo-global-flags))
(defun elmo-global-flags (fname number)
"Return a list of global flags for the message.
FNAME is the name string of the folder.
NUMBER is the number of the message."
(let ((flag-list elmo-global-flags)
folder matches)
(while flag-list
(setq folder (elmo-flag-get-folder (car flag-list)))
(when (elmo-get-hash-val
(concat (number-to-string number) ":" fname)
(elmo-flag-folder-minfo-hash-internal folder))
(setq matches (cons (elmo-flag-folder-flag-internal folder)
matches)))
(setq flag-list (cdr flag-list)))
matches))
(defun elmo-folder-list-global-flag-messages (folder flag)
"List messages which have global flag.
FOLDER is the elmo folder structure.
FLAG is the symbol of the flag."
(when (elmo-global-flag-p flag)
(let ((flag-folder (elmo-flag-get-folder flag))
result number)
(dolist (elem (elmo-flag-folder-minfo-internal flag-folder))
(if (setq number (elmo-message-number folder (nth 1 elem)))
(setq result (cons number result))))
result)))
;;;
;; minfo is a list of following cell.
;; ((((FNAME . NUMBER)...(FNAME . NUMBER)) MESSAGE-ID NUMBER-IN-FLAG-FOLDER)
;; minfo-index is the hash table of above with following indice;
(defun elmo-global-flags-set (flags folder number message-id)
"Set global flags to the message.
FLAGS is a list of symbol of the flag.
FOLDER is the elmo folder structure.
NUMBER is the message number."
(dolist (flag flags)
(elmo-global-flag-set flag folder number message-id)))
(defun elmo-local-flag-p (flag)
"Return non-nil when flag is not appropriate for global flag."
(memq flag elmo-local-flags))
(defsubst elmo-global-flag-set-internal (flag folder number message-id)
(when (elmo-local-flag-p flag)
(error "Cannot treat `%s' as global flag" flag))
(when message-id
(let ((flag-folder (elmo-flag-get-folder flag))
filename cache new-file new-number elem)
(if (setq elem (elmo-get-hash-val
message-id
(elmo-flag-folder-minfo-hash-internal
flag-folder)))
;; Same ID already exists.
(when (and folder number
(not (member (cons (elmo-folder-name-internal folder)
number) (car elem))))
(setcar elem
(cons (cons (elmo-folder-name-internal folder)
number) (car elem)))
(setq new-number (nth 2 elem))
(elmo-set-hash-val (concat (number-to-string number)
":" (elmo-folder-name-internal
folder))
elem
(elmo-flag-folder-minfo-hash-internal
flag-folder)))
;; Append new element.
(elmo-flag-folder-set-max-number-internal
flag-folder
(+ (or (elmo-flag-folder-max-number-internal flag-folder)
;; This is the first time.
(car (elmo-folder-status flag-folder)))
1))
(setq new-file
(expand-file-name
(number-to-string
(setq new-number
(elmo-flag-folder-max-number-internal flag-folder)))
(elmo-localdir-folder-directory-internal flag-folder)))
(cond
((setq filename (elmo-message-file-name folder number))
(elmo-copy-file filename new-file))
((and (setq cache (elmo-file-cache-get message-id))
(eq (elmo-file-cache-status cache) 'entire))
(elmo-copy-file (elmo-file-cache-path cache) new-file))
(t
(with-temp-buffer
(elmo-message-fetch folder number
(elmo-make-fetch-strategy 'entire))
(write-region-as-binary (point-min) (point-max) new-file nil
'no-msg))))
(elmo-flag-folder-set-minfo-internal
flag-folder
(cons
(setq elem (list
(when (and folder number)
(list (cons (elmo-folder-name-internal folder)
number)))
message-id
new-number))
(elmo-flag-folder-minfo-internal flag-folder)))
(when (and folder number)
(elmo-set-hash-val (concat (number-to-string number)
":" (elmo-folder-name-internal
folder))
elem
(elmo-flag-folder-minfo-hash-internal
flag-folder)))
(elmo-set-hash-val message-id elem
(elmo-flag-folder-minfo-hash-internal
flag-folder))
(elmo-set-hash-val (concat "#" (number-to-string new-number)) elem
(elmo-flag-folder-minfo-hash-internal
flag-folder)))
(elmo-folder-commit flag-folder)
new-number)))
(defun elmo-global-flag-set (flag folder number message-id)
"Set global flag to the message.
FLAG is a symbol of the flag.
FOLDER is the elmo folder structure.
NUMBER is the message number.
MESSAGE-ID is the message-id of the message."
(when (elmo-global-flag-p flag)
(elmo-global-flag-set-internal flag folder number message-id)))
(defun elmo-global-flag-detach (flag folder number &optional delete-if-none)
"Detach the message from the global flag.
FOLDER is the folder structure.
NUMBERS is the message number.
If optional DELETE-IF-NONE is non-nil, delete message from flag folder when
the message is not flagged in any folder.
If DELETE-IF-NONE is a symbol `always',
delete message without flagged in other folder."
(unless (and (eq (elmo-folder-type-internal folder) 'flag)
(eq (elmo-flag-folder-flag-internal folder) flag))
(let ((flag-folder (elmo-flag-get-folder flag))
elem key)
(when flag-folder
(setq key (concat (number-to-string number) ":"
(elmo-folder-name-internal folder))
elem (elmo-get-hash-val
key
(elmo-flag-folder-minfo-hash-internal flag-folder)))
(when elem
(setcar elem (delete (cons (elmo-folder-name-internal folder)
number) (car elem)))
(elmo-clear-hash-val key (elmo-flag-folder-minfo-hash-internal
flag-folder))
;; Does not have any referrer, remove.
(when (and delete-if-none
(or (eq delete-if-none 'always)
(null (car elem))))
(elmo-flag-folder-delete-message flag-folder (nth 2 elem)
(null (car elem)))
(elmo-localdir-delete-message flag-folder (nth 2 elem))
(elmo-folder-commit flag-folder)))))))
(defun elmo-global-flag-detach-messages (folder numbers &optional
delete-if-none)
"Detach all messages specified from all global flags.
FOLDER is the folder structure.
NUMBERS is the message number list.
If optional DELETE-IF-NONE is non-nil, delete message from flag folder when
the message is not flagged in any folder."
(unless (eq (elmo-folder-type-internal folder) 'flag)
(dolist (flag elmo-global-flags)
(dolist (number numbers)
(elmo-global-flag-detach flag folder number delete-if-none)))))
(defun elmo-global-flag-replace-referrer (old-folder new-folder)
(dolist (flag elmo-global-flags)
(let* ((folder (elmo-flag-get-folder flag))
(minfo (elmo-flag-folder-minfo-internal folder))
modified)
(dolist (entry minfo)
(let ((pair (assoc old-folder (nth 0 entry))))
(when pair
(setcar pair new-folder)
(setq modified t))))
(when modified
(elmo-flag-folder-set-minfo folder minfo)
(elmo-folder-commit folder)))))
(defun elmo-get-global-flags (&optional flags ignore-preserved)
"Get global flags.
Return value is a subset of optional argument FLAGS.
If FLAGS is `t', all global flags becomes candidates.
If optional IGNORE-PRESERVED is non-nil, preserved flags
\(answered, cached, new, unread\) are not included."
(let ((result (copy-sequence (if (eq flags t)
(setq flags elmo-global-flags)
flags))))
(while flags
(unless (elmo-global-flag-p (car flags))
(setq result (delq (car flags) result)))
(setq flags (cdr flags)))
(when ignore-preserved
(dolist (flag elmo-preserved-flags)
(setq result (delq flag result))))
result))
(defun elmo-global-flags-initialize (&optional additional-flags)
(let ((dir (expand-file-name "flag" elmo-msgdb-directory)))
(setq elmo-global-flags
(elmo-list-delete
elmo-local-flags
(elmo-uniq-list
(append
elmo-global-flags
additional-flags
(and (file-directory-p dir)
(mapcar (lambda (x)
(intern (elmo-recover-string-from-filename x)))
(elmo-list-delete
'(".." ".")
(directory-files dir))))))
#'delq))))
;;; To migrate from global mark folder
(defvar elmo-global-mark-filename "global-mark"
"Obsolete variable. (Just for migration)")
(defun elmo-global-mark-migrate ()
"Migrate from 'mark to 'flag. For automatic migration."
(when (and (file-exists-p (expand-file-name elmo-global-mark-filename
elmo-msgdb-directory))
(elmo-global-flag-p 'important)
(not (file-exists-p (elmo-folder-msgdb-path
(elmo-flag-get-folder 'important)))))
(elmo-global-mark-upgrade)))
(defun elmo-global-mark-upgrade ()
"Upgrade old `global-mark' structure."
(interactive)
(when (file-exists-p (expand-file-name
elmo-global-mark-filename elmo-msgdb-directory))
(message "Upgrading flag structure...")
(when (elmo-global-flag-p 'important)
(let ((global-marks
(elmo-object-load
(expand-file-name
elmo-global-mark-filename elmo-msgdb-directory)))
(folder (elmo-flag-get-folder 'important))
file-cache)
(dolist (elem global-marks)
(setq file-cache (elmo-file-cache-get (car elem)))
(when (eq (elmo-file-cache-status file-cache) 'entire)
(elmo-global-flag-set 'important nil nil (car elem))))))
(message "Upgrading flag structure...done")))
(luna-define-method elmo-folder-delete :around ((folder elmo-flag-folder))
(let ((flag (elmo-flag-folder-flag-internal folder)))
(when (luna-call-next-method)
(setq elmo-global-flags (delq flag elmo-global-flags))
(setq elmo-global-flag-folder-alist
(delq (assq flag elmo-global-flag-folder-alist)
elmo-global-flag-folder-alist))
t)))
(require 'product)
(product-provide (provide 'elmo-flag) (require 'elmo-version))
;;; elmo-flag.el ends here
|