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