logger.lisp

   1 ;;;  -*- Mode: Lisp -*-
   2 ;;;; $Id: logger.lisp,v 1.11 2003/12/16 21:19:56 krosenberg Exp $
   3 ;;;;
   4 ;;;; Purpose: A IRC logging bot
   5 ;;;; Author:  Kevin Rosenberg
   6
   7 (in-package irc-logger)
   8
   9 (defvar *daemon-monitor-process* nil "Process of background monitor.")
  10
  11 (defclass channel ()
  12   ((name :initarg :name :reader name
  13          :documentation "Name of channel.")
  14    (streams :initarg :streams :reader streams
  15             :documentation "List of output streams.")
  16    (output-root :initarg :output-root :reader output-root)
  17    (current-output-names :initarg :current-output-names :accessor current-output-names)))
  18
  19
  20 (defclass logger ()
  21   ((connection :initarg :connection :accessor connection
  22                :documentation "IRC connection object.")
  23    (handler :initform nil :accessor handler
  24             :documentation "Background handler process.")
  25    (nick :initarg :nick :reader nickname
  26          :documentation "Nickname of the bot.")
  27    (password :initarg :password :reader password
  28              :documentation "Nickname's nickserver password.")
  29    (server :initarg :server :reader server
  30            :documentation "Connected IRC server.")
  31    (channel-names :initarg :channel-names :accessor channel-names
  32                   :documentation "List of channel names.")
  33    (realname :initarg :realname :reader realname
  34            :documentation "Realname for cl-irc")
  35    (username :initarg :username :reader username
  36            :documentation "Username for cl-irc")
  37    (logging-stream :initarg :logging-stream :reader logging-stream
  38                    :documentation "logging-stream for cl-irc.")
  39    (channels :initarg :channels :accessor channels
  40              :documentation "List of channels.")
  41    (user-output :initarg :user-output :reader user-output
  42                 :documentation
  43                 "Output parameter from user, maybe stream or pathname.")
  44    (unichannel :initarg :unichannel :reader unichannel :type boolean
  45                :documentation "T if user-output is directory for individual channel output.")
  46    (formats :initarg :formats :reader formats
  47                   :documentation
  48                   "A list of output formats.")
  49    (async :initarg :async :reader async
  50                   :documentation
  51                   "Whether to use async")
  52    (last-pong :initform nil :accessor last-pong
  53                   :documentation
  54                   "utime of last pong message")
  55    (private-log :initarg :private-log :reader private-log
  56                 :documentation "Pathname of the private log file for the daemon.")
  57    (unknown-log :initarg :unknown-log :reader unknown-log
  58                 :documentation "Pathname of the log file for unknown messages.")
  59    (private-log-stream :initarg :private-log-stream :reader private-log-stream
  60                        :documentation "Stream of the private log file for the daemon.")
  61    (unknown-log-stream :initarg :unknown-log-stream :reader unknown-log-stream
  62                 :documentation "Stream of the log file for unknown messages.")
  63    (monitor-events :initform nil :accessor monitor-events
  64                    :documentation "List of events for the monitor to process.")
  65    (warning-message-utime :initform nil :accessor warning-message-utime
  66                   :documentation
  67                   "Time of last, potentially active, warning message.")))
  68
  69 (defvar *loggers* nil "List of active loggers.")
  70
  71 (defparameter *user-address-scanner*
  72   (create-scanner
  73    '(:sequence #\!
  74      (:register
  75       (:greedy-repetition 1 nil :non-whitespace-char-class)))
  76    :case-insensitive-mode t))
  77
  78 (defun find-logger-with-nick (nick)
  79   (find nick (the list *loggers*) :test #'string-equal :key #'nickname))
  80
  81 (defun find-logger-with-connection (conn)
  82   (find conn (the list *loggers*) :test #'eq :key #'connection))
  83
  84 (defun canonicalize-channel-name (name)
  85   (string-left-trim '(#\#) name))
  86
  87 (defun find-channel-with-name (logger name)
  88   (find name (the list (channels logger)) :test #'string-equal :key #'name))
  89
  90 (defun make-output-name (name year month day)
  91     (format nil "~A-~4,'0D.~2,'0D.~2,'0D" (canonicalize-channel-name name)
  92             year month day))
  93
  94 (defun make-output-name-utime (name utime)
  95   (multiple-value-bind
  96         (second minute hour day-of-month month year day-of-week daylight-p zone)
  97       (decode-universal-time utime)
  98     (declare (ignore second minute hour day-of-week daylight-p zone))
  99     (make-output-name name year month day-of-month)))
 100
 101 (defgeneric write-file-header (format channel-name stream))
 102
 103 (defmethod write-file-header ((format t) channel-name stream)
 104   (declare (ignore channel-name stream))
 105   )
 106
 107 (defgeneric write-file-footer (format channel-name stream))
 108
 109 (defmethod write-file-footer ((format t) channel-name stream)
 110   (declare (ignore channel-name stream))
 111   )
 112
 113 (defun %log-file-path (output-root channel-name year month day type)
 114   (make-pathname
 115    :defaults output-root
 116    :directory (append (pathname-directory output-root)
 117                       (list
 118                        (string-left-trim '(#\#) channel-name)
 119                        (format nil "~4,'0D-~2,'0D" year month)))
 120    :name (make-output-name channel-name year month day)
 121    :type type))
 122
 123 (defgeneric log-file-path (output-root channel-name year month day format))
 124
 125 (defmethod log-file-path (output-root channel-name year month day
 126                           (format (eql :raw)))
 127   (%log-file-path output-root channel-name year month day "raw"))
 128
 129 (defmethod log-file-path (output-root channel-name year month day (format (eql :sexp)))
 130   (%log-file-path output-root channel-name year month day "sexp"))
 131
 132 (defmethod log-file-path (output-root channel-name year month day (format (eql :text)))
 133   (%log-file-path output-root channel-name year month day "txt"))
 134
 135 (defmethod log-file-path (output-root channel-name year month day (format string))
 136   (%log-file-path output-root channel-name year month day format))
 137
 138
 139 (defun log-file-path-utime (output-root channel-name format utime)
 140   (multiple-value-bind
 141         (second minute hour day month year day-of-week daylight-p zone)
 142       (decode-universal-time utime)
 143     (declare (ignore second minute hour day-of-week daylight-p zone))
 144     (log-file-path output-root channel-name year month day format)))
 145
 146 (defun get-stream (channel istream)
 147   (elt (streams channel) istream))
 148
 149 (defun (setf get-stream) (value channel istream)
 150   (setf (elt (streams channel) istream) value))
 151
 152 (defun get-format (logger istream)
 153   (elt (formats logger) istream))
 154
 155 (defun get-output-name (channel istream)
 156   (elt (current-output-names channel) istream))
 157
 158 (defun (setf get-output-name) (value channel istream)
 159   (setf (elt (current-output-names channel) istream) value))
 160
 161 (defun ensure-output-stream-for-unichannel (utime logger channel istream)
 162   (let ((name (make-output-name-utime (name channel) utime)))
 163     (unless (string= name (get-output-name channel istream))
 164       (when (get-stream channel istream)
 165         (write-file-footer (get-format logger istream)
 166                            (name channel)
 167                            (get-stream channel istream))
 168         (close (get-stream channel istream)))
 169       (setf (get-output-name channel istream) name)
 170       (let ((path (log-file-path-utime (output-root channel) (name channel)
 171                                        (get-format logger istream) utime)))
 172         (unless (probe-file path)
 173           (ensure-directories-exist path)
 174           (setf (get-stream channel istream)
 175                 (open path :direction :output :if-exists :error
 176                       :if-does-not-exist :create))
 177           (write-file-header (get-format logger istream)
 178                              (name channel)
 179                               (get-stream channel istream))
 180           (close (get-stream channel istream)))
 181         (setf (get-stream channel istream)
 182               (open path :direction :output :if-exists :append
 183                     :if-does-not-exist :create))))))
 184
 185 (defun ensure-output-stream (utime logger channel istream)
 186   "Ensures that *output-stream* is correct."
 187   (cond
 188    ((streamp (user-output logger))
 189     (unless (get-stream channel istream)
 190       (setf (get-stream channel istream) (user-output logger))))
 191    ((pathnamep (user-output logger))
 192     (cond
 193      ((unichannel logger)
 194       (ensure-output-stream-for-unichannel utime logger channel istream))
 195      (t
 196       (setf (get-stream channel istream)
 197         (open (user-output logger) :direction :output :if-exists :append
 198               :if-does-not-exist :create)))))))
 199
 200 (defun format-date-time (utime)
 201   (multiple-value-bind
 202         (second minute hour day-of-month month year day-of-week daylight-p zone)
 203       (decode-universal-time utime)
 204     (declare (ignore day-of-week daylight-p zone))
 205     (format nil "~4,'0D/~2,'0D/~2,'0D ~2,'0D:~2,'0D:~2,'0D" year month day-of-month hour minute second)))
 206
 207 (defun format-utime (utime)
 208   (multiple-value-bind
 209         (second minute hour day-of-month month year day-of-week daylight-p zone)
 210       (decode-universal-time utime)
 211     (declare (ignore day-of-month month year day-of-week daylight-p zone))
 212     (format nil "~2,'0D:~2,'0D:~2,'0D" hour minute second)))
 213
 214 (defun format-utime-short (utime)
 215   (multiple-value-bind
 216         (second minute hour day-of-month month year day-of-week daylight-p zone)
 217       (decode-universal-time utime)
 218     (declare (ignore second day-of-month month year day-of-week daylight-p zone))
 219     (format nil "~2,'0D:~2,'0D" hour minute)))
 220
 221 (defun user-address (msg)
 222   (let ((split (split *user-address-scanner* (raw-message-string msg)
 223                       :with-registers-p t)))
 224     (if (second split)
 225         (second split)
 226         "")))
 227
 228 (defun need-user-address? (type)
 229   (case type
 230     ((:action :privmsg :names :rpl_topic)
 231      nil)
 232     (t
 233      t)))
 234
 235 (defgeneric %output-event (format stream utime type channel source text msg
 236                            unichannel))
 237
 238 (defmethod %output-event ((format t) stream utime type channel source text
 239                           msg unichannel)
 240   (%output-event :raw stream utime type channel source text msg unichannel))
 241
 242 (defmethod %output-event ((format (eql :raw)) stream utime type channel source
 243                           text msg unichannel)
 244   (declare (ignore utime type channel source text text unichannel))
 245   (when msg
 246     (format stream "~S~%"
 247             (string-right-trim '(#\return) (raw-message-string msg)))))
 248
 249 (defconstant +posix-epoch+
 250   (encode-universal-time 0 0 0 1 1 1970 0))
 251
 252 (defun posix-time-to-utime (time)
 253   (+ time +posix-epoch+))
 254
 255 (defun last-sexp-field (type msg)
 256   (cond
 257    ((null msg)
 258     nil)
 259    ((eq type :kick)
 260     (trailing-argument msg))
 261    ((eq type :rpl_topicwhotime)
 262     (when (stringp (car (last (arguments msg))))
 263       (let ((secs (parse-integer (car (last (arguments msg))) :junk-allowed t)))
 264         (when secs
 265           (posix-time-to-utime secs)))))
 266    ((need-user-address? type)
 267     (user-address msg))))
 268
 269 (defmethod %output-event ((format (eql :sexp)) stream utime type channel source text
 270                           msg unichannel)
 271   (let ((*print-circle* nil)
 272         (*print-pretty* nil))
 273     (if unichannel
 274         (format stream "(~S ~S ~S ~S ~S)~%" utime type source text (last-sexp-field type msg))
 275       (format stream "(~S ~S ~S ~S ~S ~S)~%" utime type source channel text
 276               (last-sexp-field type msg)))))
 277
 278 (defmethod %output-event ((format (eql :text)) stream utime type channel
 279                           source text msg unichannel)
 280   (format stream "~A " (format-utime utime))
 281   (when (and (null unichannel) channel)
 282     (format stream "[~A] " channel))
 283
 284   (let ((user-address (when (and msg (need-user-address? type)) (user-address msg))))
 285     (case type
 286       (:privmsg
 287        (format stream "<~A> ~A" source text))
 288       (:action
 289        (format stream "*~A* ~A" source text))
 290       (:join
 291        (format stream "~A [~A] has joined ~A" source user-address channel))
 292       (:part
 293        (format stream "-!- ~A [~A] has left ~A" source user-address channel))
 294       (:nick
 295        (format stream "-!- ~A is now known as ~A" source text))
 296       (:kick
 297        (format stream "-!- ~A [~A] has been kicked from ~A" source user-address channel))
 298       (:quit
 299        (format stream "-!- ~A [~A] has quit [~A]" source user-address (if text text "")))
 300       (:mode
 301        (format stream "-!- ~A has set mode ~A"  source text))
 302       (:topic
 303        (format stream "-!- ~A changed the topic of ~A to: ~A" source channel text))
 304       (:notice
 305        (format stream "-~A:~A- ~A" source channel text))
 306       (:daemon
 307        (format stream "-!!!- ~A" text))
 308       (:names
 309        (format stream "-!- names: ~A" text))
 310       (:rpl_topic
 311        (format stream "-!- topic: ~A" text))
 312       (t
 313        (warn "Unhandled msg type ~A." type))))
 314   (write-char #\Newline stream))
 315
 316 (defun output-event-for-a-stream (msg type channel text logger istream)
 317   (ensure-output-stream (received-time msg) logger channel istream)
 318   (%output-event  (get-format logger istream) (get-stream channel istream)
 319                   (received-time msg) type (name channel) (source msg) text msg
 320                   (unichannel logger))
 321   (force-output (get-stream channel istream)))
 322
 323 (defun log-daemon-message (logger fmt &rest args)
 324   (let ((text (apply #'format nil fmt args))
 325         (time (get-universal-time)))
 326     (format (get-private-log-stream logger)
 327             "~A ~A~%" (format-date-time time) text)
 328     (force-output (get-private-log-stream logger))
 329     (dolist (channel (channels logger))
 330       (dotimes (istream (length (formats logger)))
 331         (ensure-output-stream time logger channel istream)
 332         (%output-event  (get-format logger istream)
 333                         (get-stream channel istream)
 334                         time :daemon nil nil text nil
 335                         (unichannel logger))
 336         (force-output (get-stream channel istream))))))
 337
 338 (defvar *msg*)
 339 (defun output-event (msg type channel-name &optional text)
 340   (setq *msg* msg)
 341   (dolist (logger *loggers*)
 342     (case type
 343       ((:error :server :kill)
 344        (format (get-private-log-stream logger)
 345                "~A ~A~%"
 346                (format-date-time (received-time msg))
 347                (raw-message-string msg))
 348        (force-output (get-private-log-stream logger)))
 349       ((:quit :nick)
 350        ;; send to all channels that a nickname is joined
 351        (let* ((user (find-user (connection logger)
 352                                (case type
 353                                  (:nick (source msg))
 354                                  (:quit (source msg)))))
 355               (channels (when user (cl-irc::channels user))))
 356          (dolist (channel (mapcar
 357                            #'(lambda (name) (find-channel-with-name logger name))
 358                            (mapcar #'cl-irc::name channels)))
 359            (when channel
 360              (dotimes (i (length (formats logger)))
 361                (output-event-for-a-stream msg type channel text logger i))))))
 362       (t
 363        ;; msg contains channel name
 364        (let* ((channel (find-channel-with-name logger channel-name)))
 365          (when channel
 366            (dotimes (i (length (formats logger)))
 367              (output-event-for-a-stream msg type channel text logger i))))))))
 368
 369 (defun get-private-log-stream (logger)
 370   (or (private-log-stream logger) *standard-output*))
 371
 372 (defun get-unknown-log-stream (logger)
 373   (or (unknown-log-stream logger) *standard-output*))
 374
 375 (defun privmsg-hook (msg)
 376   (let ((logger (find-logger-with-connection (connection msg)))
 377         (channel (first (arguments msg))))
 378     (cond
 379      ((equal channel (nickname logger))
 380       (format
 381        (get-private-log-stream logger)
 382        "~A ~A~%"
 383        (format-date-time (get-universal-time))
 384        (raw-message-string msg))
 385       (force-output (get-private-log-stream logger)))
 386      (t
 387       (output-event msg :privmsg channel (trailing-argument msg))))))
 388
 389 (defun action-hook (msg)
 390   (output-event msg :action (first (arguments msg))
 391                 (subseq (trailing-argument msg) 8
 392                         (- (length (trailing-argument msg)) 1))))
 393
 394 (defun nick-hook (msg)
 395   (output-event msg :nick nil (trailing-argument msg)))
 396
 397 (defun part-hook (msg)
 398   (output-event msg :part (first (arguments msg))))
 399
 400 (defun quit-hook (msg)
 401   (output-event msg :quit nil (trailing-argument msg)))
 402
 403 (defun join-hook (msg)
 404   (output-event msg :join (trailing-argument msg)))
 405
 406 (defun kick-hook (msg)
 407   (let ((logger (find-logger-with-connection (connection msg)))
 408         (channel (first (arguments msg)))
 409         (who-kicked (second (arguments msg))))
 410     (output-event msg :kick channel who-kicked)
 411     (when (string-equal (nickname logger) who-kicked)
 412       (format
 413        (get-private-log-stream logger)
 414        "~A Logging daemon ~A has been kicked from ~A (~A)~%"
 415        (format-date-time (received-time msg))
 416        (nickname logger)
 417        channel
 418        (trailing-argument msg))
 419       (force-output (get-private-log-stream logger))
 420       (daemon-sleep 1)
 421       (remove-channel-logger logger channel)
 422       (daemon-sleep 1)
 423       (add-channel-logger logger channel)
 424       (format
 425        (get-private-log-stream logger)
 426        "~A Rejoined ~A~%"
 427        (format-date-time (received-time msg))
 428        channel)
 429       (force-output (get-private-log-stream logger)))))
 430
 431 (defun notice-hook (msg)
 432   (let ((logger (find-logger-with-connection (connection msg)))
 433         (channel (first (arguments msg))))
 434     (cond
 435       ((and (string-equal (source msg) "NickServ")
 436             (string-equal channel (nickname logger))
 437             (string-equal "owned by someone else" (trailing-argument msg)))
 438        (if logger
 439            (privmsg (connection msg) (source msg) (format nil "IDENTIFY ~A" (password logger)))
 440          (format
 441           (get-private-log-stream logger)
 442           "~A NickServ asks for identity with connection not found.~%"
 443           (format-date-time (received-time msg)))))
 444       ((equal channel (nickname logger))
 445        (format
 446         (get-private-log-stream logger)
 447         "~A ~A~%"
 448         (format-date-time (get-universal-time))
 449         (raw-message-string msg))
 450        (force-output (get-private-log-stream logger)))
 451       (t
 452        (output-event msg :notice channel (trailing-argument msg))))))
 453
 454 (defun ping-hook (msg)
 455   (let ((logger (find-logger-with-connection (connection msg))))
 456     (pong (connection msg) (server logger))
 457     #+debug (format *standard-output* "Sending pong to ~A~%" (server logger))))
 458
 459 (defun pong-hook (msg)
 460   (let ((logger (find-logger-with-connection (connection msg))))
 461     (setf (last-pong logger) (received-time msg))))
 462
 463 (defun topic-hook (msg)
 464   (output-event msg :topic (first (arguments msg)) (trailing-argument msg)))
 465
 466 (defun mode-hook (msg)
 467   (output-event msg :mode (first (arguments msg))
 468                 (format nil "~{~A~^ ~}" (cdr (arguments msg)))))
 469
 470 (defun rpl_namreply-hook (msg)
 471   (output-event msg :names (third (arguments msg))
 472                 (trailing-argument msg)))
 473
 474 (defun rpl_endofnames-hook (msg)
 475   (declare (ignore msg))
 476   ;; nothing to do for this message
 477   )
 478
 479 (defun rpl_topic-hook (msg)
 480   (output-event msg :rpl_topic (format nil "~{~A~^ ~}" (arguments msg))
 481                 (trailing-argument msg)))
 482
 483 (defun rpl_topicwhotime-hook (msg)
 484   (output-event msg :rpl_topicwhotime
 485                 (second (arguments msg))
 486                 (third (arguments msg))))
 487
 488
 489 (defun invite-hook (msg)
 490   (let ((logger (find-logger-with-connection (connection msg))))
 491     (format
 492      (get-private-log-stream logger)
 493      "~A ~A~%"
 494      (format-date-time (get-universal-time))
 495      (raw-message-string msg))
 496     (force-output (get-private-log-stream logger))))
 497
 498
 499 (defun make-a-channel (name formats output)
 500   (make-instance 'channel
 501                  :name name
 502                  :streams (make-array (length formats) :initial-element nil)
 503                  :output-root (when (and (pathnamep output)
 504                                          (null (pathname-name output)))
 505                                 output)
 506                  :current-output-names (make-array (length formats)
 507                                                    :initial-element nil)))
 508
 509 (defun make-channels (names formats output)
 510   (loop for i from 0 to (1- (length names))
 511         collect (make-a-channel (elt names i) formats output)))
 512
 513 (defun is-unichannel-output (user-output)
 514   "Returns T if output is setup for a single channel directory structure."
 515   (and (pathnamep user-output) (null (pathname-name user-output))))
 516
 517 (defun do-connect-and-join (nick server username realname logging-stream channels)
 518   (let ((conn (connect :nickname nick :server server
 519                        :username username :realname realname
 520                        :logging-stream logging-stream)))
 521     (mapc #'(lambda (channel) (join conn channel)) channels)
 522     (add-hook conn 'irc::irc-privmsg-message 'privmsg-hook)
 523     (add-hook conn 'irc::ctcp-action-message 'action-hook)
 524     (add-hook conn 'irc::irc-nick-message 'nick-hook)
 525     (add-hook conn 'irc::irc-part-message 'part-hook)
 526     (add-hook conn 'irc::irc-quit-message 'quit-hook)
 527     (add-hook conn 'irc::irc-join-message 'join-hook)
 528     (add-hook conn 'irc::irc-kick-message 'kick-hook)
 529     (add-hook conn 'irc::irc-mode-message 'mode-hook)
 530     (add-hook conn 'irc::irc-topic-message 'topic-hook)
 531     (add-hook conn 'irc::irc-notice-message 'notice-hook)
 532     (add-hook conn 'irc::irc-error-message 'error-hook)
 533     (add-hook conn 'irc::irc-ping-message 'ping-hook)
 534     (add-hook conn 'irc::irc-pong-message 'pong-hook)
 535     (add-hook conn 'irc::irc-kill-message 'kill-hook)
 536     (add-hook conn 'irc::irc-invite-message 'invite-hook)
 537     (add-hook conn 'irc::irc-rpl_killdone-message 'warning-hook)
 538     (add-hook conn 'irc::irc-rpl_closing-message 'warning-hook)
 539     (add-hook conn 'irc::irc-rpl_topic-message 'rpl_topic-hook)
 540     (add-hook conn 'irc::irc-rpl_namreply-message 'rpl_namreply-hook)
 541     (add-hook conn 'irc::irc-rpl_endofnames-message 'rpl_endofnames-hook)
 542     (add-hook conn 'irc::irc-rpl_topicwhotime-message 'rpl_topicwhotime-hook)
 543     conn))
 544
 545 (defmethod cl-irc::irc-message-event :around ((msg cl-irc::irc-message))
 546   (let ((result (call-next-method msg)))
 547     (typecase msg
 548       ((or irc::irc-privmsg-message irc::ctcp-action-message irc::irc-nick-message
 549         irc::irc-part-message irc::irc-quit-message irc::irc-join-message
 550         irc::irc-kick-message irc::irc-mode-message irc::irc-topic-message
 551         irc::irc-notice-message irc::irc-error-message irc::irc-ping-message
 552         irc::irc-pong-message irc::irc-kill-message irc::irc-invite-message
 553         irc::irc-rpl_killdone-message irc::irc-rpl_closing-message
 554         irc::irc-rpl_topic-message irc::irc-rpl_namreply-message
 555         irc::irc-rpl_endofnames-message irc::irc-rpl_topicwhotime-message
 556         irc::irc-rpl_motd-message irc::irc-rpl_motdstart-message
 557         irc::irc-rpl_endofmotd-message)
 558        ;; nothing to do
 559        )
 560       (t
 561        (let ((logger (find-logger-with-connection (connection msg))))
 562          (format (get-unknown-log-stream
 563                   (find-logger-with-connection (connection msg)))
 564                  "~A ~A~%"
 565                  (format-date-time (received-time msg ))
 566                  (raw-message-string msg))
 567          (force-output (get-unknown-log-stream logger)))))
 568     result))
 569
 570 (defun create-logger (nick server &key channels output password
 571                       realname username async
 572                       private-log unknown-log
 573                       (logging-stream t) (formats '(:text)))
 574   "OUTPUT may be a pathname or a stream"
 575   ;; check arguments
 576   (assert formats)
 577   (if (and channels (atom channels))
 578       (setq channels (list channels)))
 579   (if (atom formats)
 580       (setq formats (list formats)))
 581   (if (stringp output)
 582       (setq output (parse-namestring output)))
 583   (let* ((conn (do-connect-and-join nick server username realname logging-stream channels))
 584          (logger (make-instance
 585                   'logger
 586                   :connection conn
 587                   :nick nick
 588                   :password password
 589                   :server server
 590                   :channels (make-channels channels formats output)
 591                   :channel-names channels
 592                   :username username
 593                   :realname realname
 594                   :async async
 595                   :logging-stream logging-stream
 596                   :user-output output
 597                   :formats formats
 598                   :private-log private-log
 599                   :unknown-log unknown-log
 600                   :private-log-stream (when private-log
 601                                         (open private-log :direction :output
 602                                               :if-exists :append
 603                                               :if-does-not-exist :create))
 604                   :unknown-log-stream (when unknown-log
 605                                         (open unknown-log :direction :output
 606                                               :if-exists :append
 607                                               :if-does-not-exist :create))
 608                   :unichannel (is-unichannel-output output))))
 609     (unless *daemon-monitor-process*
 610       (setq *daemon-monitor-process* (cl-irc::start-process 'daemon-monitor "logger-monitor")))
 611     logger))
 612
 613 (defun start-logger (logger async)
 614   (if async
 615       (setf (handler logger)
 616         (start-background-message-handler (connection logger)))
 617       (read-message-loop (connection logger))))
 618
 619 (defun remove-logger (nick)
 620   "Quit the active connection with nick and remove from active list."
 621   (let ((logger (find-logger-with-nick nick)))
 622     (cond
 623       ((null logger)
 624        (warn
 625         "~A No active connection found with nick ~A [remove-logger].~%"
 626         (format-date-time (get-universal-time))
 627         nick)
 628        nil)
 629       (t
 630        (ignore-errors (irc:quit (connection logger) ""))
 631        (stop-background-message-handler (handler logger))
 632        (sleep 1)
 633        (dolist (channel (channels logger))
 634          (let ((c (connection logger)))
 635            (when c
 636              (ignore-errors (remove-channel c (find-channel c (name channel)))))))
 637        (when (private-log-stream logger)
 638          (close (private-log-stream logger)))
 639        (when (unknown-log-stream logger)
 640          (close (unknown-log-stream logger)))
 641
 642        (setq *loggers*
 643              (delete nick *loggers*  :test #'string-equal :key #'nickname))
 644        t))))
 645
 646 (defun add-logger (nick server &key channels output (password "")
 647                                     realname username private-log unknown-log
 648                                     (logging-stream t) (async t)
 649                                     (formats '(:sexp)))
 650   (when (find-logger-with-nick nick)
 651     (format
 652      (get-private-log-stream (find-logger-with-nick nick))
 653      "~A Closing previously active connection [add-logger].~%"
 654      (format-date-time (get-universal-time)))
 655     (ignore-errors (remove-logger nick)))
 656   (let ((logger (create-logger nick server :channels channels :output output
 657                                :logging-stream logging-stream :password password
 658                                :realname realname :username username
 659                                :private-log private-log
 660                                :unknown-log unknown-log
 661                                :formats formats
 662                                :async async)))
 663     (push logger *loggers*)
 664     (start-logger logger async)
 665     logger))
 666
 667 (defun add-channel-logger (logger channel-name)
 668   (cond
 669     ((find-channel-with-name logger channel-name)
 670      (format (get-private-log-stream logger)
 671              "~A Channel ~A already in logger ~A.~%"
 672              (format-date-time (get-universal-time))
 673              channel-name logger)
 674      (force-output (get-private-log-stream logger))
 675      nil)
 676     (t
 677      (let ((channel (make-a-channel channel-name (formats logger) (user-output logger))))
 678        (join (connection logger) channel-name)
 679        (push channel (channels logger))
 680        (push channel-name (channel-names logger))))))
 681
 682 (defun remove-channel-logger (logger channel-name)
 683   (let ((channel (find-channel-with-name logger channel-name)))
 684     (cond
 685       (channel
 686        (part (connection logger) channel-name)
 687        (dotimes (i (length (streams channel)))
 688          (when (streamp (get-stream channel i))
 689            (close (get-stream channel i))
 690            (setf (get-stream channel i) nil)))
 691        (setf (channels logger) (delete channel-name (channels logger)
 692                                        :test #'string-equal
 693                                        :key #'name))
 694        (setf (channel-names logger) (delete channel-name (channel-names logger)
 695                                             :test #'string-equal))
 696        t)
 697       (t
 698        (format
 699         (get-private-log-stream logger)
 700         "~A Channel name ~A not found in logger ~A.~%"
 701         (format-date-time (get-universal-time))
 702         channel-name logger)
 703        nil))))
 704
 705 (defun add-hook-logger (logger class hook)
 706   (add-hook (connection logger) class hook))
 707
 708 (defun remove-hook-logger (logger class hook)
 709   (remove-hook (connection logger) class hook))
 710
 711 (defvar *warning-message-utime* nil)
 712
 713 (defun kill-hook (msg)
 714   (let ((target (second (arguments msg)))
 715         (logger (find-logger-with-connection (connection msg))))
 716     (when (and (stringp target)
 717                (string-equal target (nickname logger)))
 718       (setf (warning-message-utime logger) (received-time msg)))
 719     (format (get-private-log-stream logger)
 720             "~A Killed by ~A~%"
 721             (format-date-time (received-time msg))
 722             (source msg))
 723     (force-output (get-private-log-stream logger))))
 724
 725 (defun error-hook (msg)
 726   (let ((text (trailing-argument msg))
 727         (logger (find-logger-with-connection (connection msg))))
 728     (when (and (stringp text)
 729                (zerop (search (format nil "Closing Link: ~A" (nickname logger)) text)))
 730       (setf (warning-message-utime logger) (received-time msg)))
 731     (output-event msg :error nil (trailing-argument msg))))
 732
 733 (defun warning-hook (msg)
 734   (let ((logger (find-logger-with-connection (connection msg))))
 735     (output-event msg :server
 736                   (format nil "~{~A~^ ~} ~A)"
 737                           (arguments msg)
 738                           (trailing-argument msg)))
 739     (when logger
 740       (setf (warning-message-utime logger) (get-universal-time)))))
 741
 742 (defun daemon-sleep (seconds)
 743   #-allegro (sleep seconds)
 744   #+allegro (mp:process-sleep seconds))
 745
 746 (defun log-disconnection (logger)
 747   ;; avoid generating too many reconnect messages in the logs
 748   (when (or (null (warning-message-utime logger))
 749             (< (- (get-universal-time) (warning-message-utime logger)) 300))
 750     (log-daemon-message logger "Disconnected. Attempting reconnection at ~A."
 751                         (format-date-time (get-universal-time)))))
 752
 753 (defun log-reconnection (logger)
 754   (log-daemon-message
 755    logger
 756    "Connection restablished at ~A." (format-date-time (get-universal-time))))
 757
 758 (defun is-connected (logger)
 759   (when (ignore-errors (ping (connection logger) (server logger)))
 760     (dotimes (i 20)
 761       (when (and (last-pong logger)
 762                  (< (- (get-universal-time) (last-pong logger)) 21))
 763         (return-from is-connected t))
 764       (sleep 1))))
 765
 766
 767 (let (*recon-nick* *recon-server* *recon-username* *recon-realname*
 768       *recon-user-output* *recon-private-log* *recon-unknown-log*
 769       *recon-formats* *recon-async* *recon-logging-stream* *recon-channel-names*)
 770   (declare (special *recon-nick* *recon-server* *recon-username* *recon-realname*
 771                     *recon-formats* *recon-password* *recon-async*
 772                     *recon-user-output* *recon-private-log* *recon-unknown-log*
 773                     *recon-logging-stream* *recon-channel-names*))
 774
 775   (defun attempt-reconnection (logger)
 776     (when (is-connected logger)
 777       (return-from attempt-reconnection nil))
 778
 779     (log-disconnection logger)
 780     (when (connection logger)
 781       (ignore-errors (quit (connection logger) "Client terminated by server"))
 782       (setf *recon-nick* (nickname logger)
 783             *recon-server* (server logger)
 784             *recon-username* (username logger)
 785             *recon-realname* (realname logger)
 786             *recon-password* (password logger)
 787             *recon-async* (async logger)
 788             *recon-user-output* (user-output logger)
 789             *recon-private-log* (private-log logger)
 790             *recon-unknown-log* (unknown-log logger)
 791             *recon-formats* (formats logger)
 792             *recon-logging-stream* (logging-stream logger)
 793             *recon-channel-names* (channel-names logger))
 794       (ignore-errors (remove-logger logger)))
 795
 796     (let ((new-logger
 797            (ignore-errors
 798             (add-logger *recon-nick* *recon-server*
 799                         :channels *recon-channel-names*
 800                         :output *recon-user-output*
 801                         :password *recon-password*
 802                         :realname *recon-realname*
 803                         :username *recon-username*
 804                         :logging-stream *recon-logging-stream*
 805                         :private-log *recon-private-log*
 806                         :unknown-log *recon-unknown-log*
 807                         :async *recon-async*
 808                         :formats *recon-formats*))))
 809       (when new-logger
 810         (sleep 5)
 811         (when (is-connected new-logger)
 812           (log-reconnection new-logger)))))
 813
 814   )
 815
 816 (defun daemon-monitor ()
 817   "This function runs in the background and monitors the connection of the logger."
 818   ;; run forever
 819   (do ()
 820       ()
 821     (block main-loop
 822       (dolist (logger *loggers*)
 823         (do ((warning-time (warning-message-utime logger) (warning-message-utime logger)))
 824             ((or (is-connected logger) (null warning-time)))
 825           (cond
 826            ((and warning-time (> (- (get-universal-time) warning-time) 180))
 827             ;;give up frequent checking because no disconnection despite waiting
 828             (setf (warning-message-utime logger) nil))
 829            ((not (is-connected logger))
 830             (unless warning-time
 831               (setf (warning-message-utime logger) (get-universal-time)))
 832             (attempt-reconnection logger)
 833             ;;after a succesful reconnection, the value of logger will be invalid
 834             (sleep 30)
 835             (return-from main-loop))
 836            (t
 837             (daemon-sleep 30)))))
 838       (do ((i 0 (1+ i)))
 839           ((or (>= i 20) (some (lambda (logger) (warning-message-utime logger)) *loggers*)))
 840         (daemon-sleep 15)))))
 841
 842
 843