-o;;; -*- Mode: Lisp -*-
+;;; -*- Mode: Lisp -*-
;;;; $Id: logger.lisp,v 1.11 2003/12/16 21:19:56 krosenberg Exp $
;;;;
-;;;; Purpose: A IRC logging bot
+;;;; Purpose: A IRC logging bot
;;;; Author: Kevin Rosenberg
-(in-package irc-logger)
+(in-package #:irc-logger)
(defvar *daemon-monitor-process* nil "Process of background monitor.")
+(defparameter *timeout* 60)
-(defclass channel ()
- ((name :initarg :name :reader name
- :documentation "Name of channel.")
+(defclass log-channel ()
+ ((name :initarg :name :reader c-name
+ :documentation "Name of channel.")
(streams :initarg :streams :reader streams
- :documentation "List of output streams.")
+ :documentation "List of output streams.")
(output-root :initarg :output-root :reader output-root)
(current-output-names :initarg :current-output-names :accessor current-output-names)))
-
+
(defclass logger ()
((connection :initarg :connection :accessor connection
- :documentation "IRC connection object.")
+ :documentation "IRC connection object.")
(handler :initform nil :accessor handler
- :documentation "Background handler process.")
- (nick :initarg :nick :reader nickname
- :documentation "Nickname of the bot.")
+ :documentation "Background handler process.")
+ (nick :initarg :nick :reader l-nickname
+ :documentation "Nickname of the bot.")
(password :initarg :password :reader password
- :documentation "Nickname's nickserver password.")
+ :documentation "Nickname's nickserver password.")
(server :initarg :server :reader server
- :documentation "Connected IRC server.")
+ :documentation "Connected IRC server.")
(channel-names :initarg :channel-names :accessor channel-names
- :documentation "List of channel names.")
- (realname :initarg :realname :reader realname
- :documentation "Realname for cl-irc")
- (username :initarg :username :reader username
- :documentation "Username for cl-irc")
- (logging-stream :initarg :logging-stream :reader logging-stream
- :documentation "logging-stream for cl-irc.")
+ :documentation "List of channel names.")
+ (realname :initarg :realname :reader l-realname
+ :documentation "Realname for cl-irc")
+ (username :initarg :username :reader l-username
+ :documentation "Username for cl-irc")
+ (logging-stream :initarg :logging-stream :reader logging-stream
+ :documentation "logging-stream for cl-irc.")
(channels :initarg :channels :accessor channels
- :documentation "List of channels.")
+ :documentation "List of channels.")
(user-output :initarg :user-output :reader user-output
- :documentation
- "Output parameter from user, maybe stream or pathname.")
+ :documentation
+ "Output parameter from user, maybe stream or pathname.")
(unichannel :initarg :unichannel :reader unichannel :type boolean
- :documentation "T if user-output is directory for individual channel output.")
+ :documentation "T if user-output is directory for individual channel output.")
(formats :initarg :formats :reader formats
- :documentation
- "A list of output formats.")
+ :documentation
+ "A list of output formats.")
(async :initarg :async :reader async
- :documentation
- "Whether to use async")
+ :documentation
+ "Whether to use async")
(last-pong :initform nil :accessor last-pong
- :documentation
- "utime of last pong message")
+ :documentation
+ "utime of last pong message")
+ (private-log :initarg :private-log :reader private-log
+ :documentation "Pathname of the private log file for the daemon.")
+ (unknown-log :initarg :unknown-log :reader unknown-log
+ :documentation "Pathname of the log file for unknown messages.")
+ (private-log-stream :initarg :private-log-stream :reader private-log-stream
+ :documentation "Stream of the private log file for the daemon.")
+ (unknown-log-stream :initarg :unknown-log-stream :reader unknown-log-stream
+ :documentation "Stream of the log file for unknown messages.")
+ (monitor-events :initform nil :accessor monitor-events
+ :documentation "List of events for the monitor to process.")
(warning-message-utime :initform nil :accessor warning-message-utime
- :documentation
- "Time of last, potentially active, warning message.")))
+ :documentation
+ "Time of last, potentially active, warning message.")))
+
+(defmethod print-object ((obj logger) stream)
+ (print-unreadable-object (obj stream :type t :identity t)
+ (format stream "~A" (l-nickname obj))))
(defvar *loggers* nil "List of active loggers.")
:case-insensitive-mode t))
(defun find-logger-with-nick (nick)
- (find nick (the list *loggers*) :test #'string-equal :key #'nickname))
+ (find nick (the list *loggers*) :test #'string-equal :key #'l-nickname))
(defun find-logger-with-connection (conn)
(find conn (the list *loggers*) :test #'eq :key #'connection))
(string-left-trim '(#\#) name))
(defun find-channel-with-name (logger name)
- (find name (the list (channels logger)) :test #'string-equal :key #'name))
-
+ (find name (the list (channels logger)) :test #'string-equal :key #'c-name))
+
(defun make-output-name (name year month day)
(format nil "~A-~4,'0D.~2,'0D.~2,'0D" (canonicalize-channel-name name)
- year month day))
+ year month day))
+
+(defmacro with-decoding ((utime &optional zone) &body body)
+ `(multiple-value-bind
+ (second minute hour day-of-month month year day-of-week daylight-p zone)
+ (decode-universal-time ,utime ,@(if zone (list zone)))
+ (declare (ignorable second minute hour day-of-month month year day-of-week daylight-p zone))
+ ,@body))
+
+(defun format-utime (utime &optional zone)
+ (with-decoding (utime zone)
+ (format nil "~2,'0D:~2,'0D:~2,'0D" hour minute second)))
+
+(defun format-date-time (utime &key stream)
+ (with-decoding (utime)
+ (format stream "~4,'0D/~2,'0D/~2,'0D ~2,'0D:~2,'0D:~2,'0D" year month day-of-month hour minute second)))
(defun make-output-name-utime (name utime)
- (multiple-value-bind
- (second minute hour day-of-month month year day-of-week daylight-p zone)
- (decode-universal-time utime)
- (declare (ignore second minute hour day-of-week daylight-p zone))
+ (with-decoding (utime 0)
(make-output-name name year month day-of-month)))
(defgeneric write-file-header (format channel-name stream))
(defmethod write-file-footer ((format t) channel-name stream)
(declare (ignore channel-name stream))
)
-
+
(defun %log-file-path (output-root channel-name year month day type)
(make-pathname
:defaults output-root
:directory (append (pathname-directory output-root)
- (list
- (string-left-trim '(#\#) channel-name)
- (format nil "~4,'0D-~2,'0D" year month)))
+ (list
+ (string-left-trim '(#\#) channel-name)
+ (format nil "~4,'0D-~2,'0D" year month)))
:name (make-output-name channel-name year month day)
:type type))
(defgeneric log-file-path (output-root channel-name year month day format))
(defmethod log-file-path (output-root channel-name year month day
- (format (eql :raw)))
+ (format (eql :raw)))
(%log-file-path output-root channel-name year month day "raw"))
(defmethod log-file-path (output-root channel-name year month day (format (eql :sexp)))
(%log-file-path output-root channel-name year month day "sexp"))
+(defmethod log-file-path (output-root channel-name year month day (format (eql :binary)))
+ (%log-file-path output-root channel-name year month day "bin"))
+
(defmethod log-file-path (output-root channel-name year month day (format (eql :text)))
(%log-file-path output-root channel-name year month day "txt"))
(defun log-file-path-utime (output-root channel-name format utime)
- (multiple-value-bind
- (second minute hour day month year day-of-week daylight-p zone)
- (decode-universal-time utime)
- (declare (ignore second minute hour day-of-week daylight-p zone))
- (log-file-path output-root channel-name year month day format)))
+ (with-decoding (utime 0)
+ (log-file-path output-root channel-name year month day-of-month format)))
(defun get-stream (channel istream)
(elt (streams channel) istream))
(setf (elt (current-output-names channel) istream) value))
(defun ensure-output-stream-for-unichannel (utime logger channel istream)
- (let ((name (make-output-name-utime (name channel) utime)))
+ (let ((name (make-output-name-utime (c-name channel) utime)))
(unless (string= name (get-output-name channel istream))
(when (get-stream channel istream)
- (write-file-footer (get-format logger istream)
- (name channel)
- (get-stream channel istream))
- (close (get-stream channel istream)))
+ (write-file-footer (get-format logger istream)
+ (c-name channel)
+ (get-stream channel istream))
+ (close (get-stream channel istream)))
(setf (get-output-name channel istream) name)
- (let ((path (log-file-path-utime (output-root channel) (name channel)
- (get-format logger istream) utime)))
- (unless (probe-file path)
- (ensure-directories-exist path)
- (setf (get-stream channel istream)
- (open path :direction :output :if-exists :error
- :if-does-not-exist :create))
- (write-file-header (get-format logger istream)
- (name channel)
- (get-stream channel istream))
- (close (get-stream channel istream)))
- (setf (get-stream channel istream)
- (open path :direction :output :if-exists :append
- :if-does-not-exist :error))))))
+ (let ((path (log-file-path-utime (output-root channel) (c-name channel)
+ (get-format logger istream) utime)))
+ (unless (probe-file path)
+ (ensure-directories-exist path)
+ (setf (get-stream channel istream)
+ (open path :direction :output :if-exists :error
+ :if-does-not-exist :create))
+ (write-file-header (get-format logger istream)
+ (c-name channel)
+ (get-stream channel istream))
+ (close (get-stream channel istream)))
+ (setf (get-stream channel istream)
+ (open path :direction :output :if-exists :append
+ :if-does-not-exist :create))))))
(defun ensure-output-stream (utime logger channel istream)
"Ensures that *output-stream* is correct."
(ensure-output-stream-for-unichannel utime logger channel istream))
(t
(setf (get-stream channel istream)
- (open (user-output logger) :direction :output :if-exists :append)))))))
-
-(defun format-date-time (utime)
- (multiple-value-bind
- (second minute hour day-of-month month year day-of-week daylight-p zone)
- (decode-universal-time utime)
- (declare (ignore day-of-week daylight-p zone))
- (format nil "~4,'0D/~2,'0D/~2,'0D ~2,'0D:~2,'0D:~2,'0D" year month day-of-month hour minute second)))
-
-(defun format-utime (utime)
- (multiple-value-bind
- (second minute hour day-of-month month year day-of-week daylight-p zone)
- (decode-universal-time utime)
- (declare (ignore day-of-month month year day-of-week daylight-p zone))
- (format nil "~2,'0D:~2,'0D:~2,'0D" hour minute second)))
-
-(defun format-utime-short (utime)
- (multiple-value-bind
- (second minute hour day-of-month month year day-of-week daylight-p zone)
- (decode-universal-time utime)
- (declare (ignore second day-of-month month year day-of-week daylight-p zone))
- (format nil "~2,'0D:~2,'0D" hour minute)))
+ (open (user-output logger) :direction :output :if-exists :append
+ :if-does-not-exist :create)))))))
(defun user-address (msg)
(let ((split (split *user-address-scanner* (raw-message-string msg)
- :with-registers-p t)))
+ :with-registers-p t)))
(if (second split)
- (second split)
- "")))
+ (second split)
+ "")))
(defun need-user-address? (type)
- (not (or (eq :action type) (eq :privmsg type))))
+ (case type
+ ((:action :privmsg :names :rpl_topic)
+ nil)
+ (t
+ t)))
-(defgeneric %output-event (format stream utime type channel source text msg
- unichannel))
+(defgeneric %output-event (format stream utime type channel source text msg
+ unichannel))
(defmethod %output-event ((format t) stream utime type channel source text
- msg unichannel)
+ msg unichannel)
(%output-event :raw stream utime type channel source text msg unichannel))
(defmethod %output-event ((format (eql :raw)) stream utime type channel source
- text msg unichannel)
+ text msg unichannel)
(declare (ignore utime type channel source text text unichannel))
(when msg
- (format stream "~S~%"
- (string-right-trim '(#\return) (raw-message-string msg)))))
+ (format stream "~S~%"
+ (string-right-trim '(#\return) (raw-message-string msg)))))
+
+(defconstant +posix-epoch+
+ (encode-universal-time 0 0 0 1 1 1970 0))
+
+(defun posix-time-to-utime (time)
+ (+ time +posix-epoch+))
(defun last-sexp-field (type msg)
(cond
nil)
((eq type :kick)
(trailing-argument msg))
+ ((eq type :rpl_topicwhotime)
+ (when (stringp (car (last (arguments msg))))
+ (let ((secs (parse-integer (car (last (arguments msg))) :junk-allowed t)))
+ (when secs
+ (posix-time-to-utime secs)))))
((need-user-address? type)
(user-address msg))))
(defmethod %output-event ((format (eql :sexp)) stream utime type channel source text
- msg unichannel)
- (let ((*print-circle* nil)
- (*print-pretty* nil))
- (if unichannel
- (format stream "(~S ~S ~S ~S ~S)~%" utime type source text (last-sexp-field type msg))
- (format stream "(~S ~S ~S ~S ~S ~S)~%" utime type source channel text
- (last-sexp-field type msg)))))
-
-(defmethod %output-event ((format (eql :text)) stream utime type channel source text
- msg unichannel)
- (format stream "~A " (format-utime utime))
+ msg unichannel)
+ (with-standard-io-syntax
+ (let ((cl:*print-case* :downcase))
+ (if unichannel
+ (format stream "(~S ~S ~S ~S ~S)~%" utime type source text (last-sexp-field type msg))
+ (format stream "(~S ~S ~S ~S ~S ~S)~%" utime type source channel text
+ (last-sexp-field type msg))))))
+
+(defmethod %output-event ((format (eql :text)) stream utime type channel
+ source text msg unichannel)
+ (format stream "~A " (format-utime utime 0))
(when (and (null unichannel) channel)
(format stream "[~A] " channel))
-
+
(let ((user-address (when (and msg (need-user-address? type)) (user-address msg))))
(case type
(:privmsg
(format stream "-~A:~A- ~A" source channel text))
(:daemon
(format stream "-!!!- ~A" text))
- (:server
- (format stream "-!!!- server send message ~A" source channel text))
- (:error
- (format stream "-!!!- error: ~A ~A" source text))
- (:kill
- (format stream "-!!!- kill: ~A ~A" source text))
+ (:names
+ (format stream "-!- names: ~A" text))
+ (:rpl_topic
+ (format stream "-!- topic: ~A" text))
(t
(warn "Unhandled msg type ~A." type))))
(write-char #\Newline stream))
(defun output-event-for-a-stream (msg type channel text logger istream)
(ensure-output-stream (received-time msg) logger channel istream)
(%output-event (get-format logger istream) (get-stream channel istream)
- (received-time msg) type (name channel) (source msg) text msg
- (unichannel logger))
+ (received-time msg) type (c-name channel) (source msg) text msg
+ (unichannel logger))
(force-output (get-stream channel istream)))
(defun log-daemon-message (logger fmt &rest args)
- (let ((text (apply #'format nil fmt args))
- (time (get-universal-time)))
+ (let ((text (apply #'format nil fmt args)))
+ (add-private-log-entry logger "~A" text)
+ ;;don't daemon messages to the logs
+ #+ignore
(dolist (channel (channels logger))
(dotimes (istream (length (formats logger)))
- (ensure-output-stream time logger channel istream)
- (%output-event (get-format logger istream) (get-stream channel istream)
- time :daemon nil nil text nil
- (unichannel logger))
- (force-output (get-stream channel istream))))))
+ (ensure-output-stream time logger channel istream)
+ (%output-event (get-format logger istream)
+ (get-stream channel istream)
+ time :daemon nil nil text nil
+ (unichannel logger))
+ (force-output (get-stream channel istream))))))
(defvar *msg*)
(defun output-event (msg type channel-name &optional text)
(dolist (logger *loggers*)
(case type
((:error :server :kill)
- ;;send to all channels
- (dolist (channel (channels logger))
- (dotimes (i (length (formats logger)))
- (output-event-for-a-stream msg type channel text logger i))))
+ (add-private-log-entry logger "~A" (raw-message-string msg)))
((:quit :nick)
;; send to all channels that a nickname is joined
(let* ((user (find-user (connection logger)
- (case type
- (:nick (source msg))
- (:quit (source msg)))))
- (channels (when user (cl-irc::channels user))))
- (dolist (channel (mapcar
- #'(lambda (name) (find-channel-with-name logger name))
- (mapcar #'cl-irc::name channels)))
- (when channel
- (dotimes (i (length (formats logger)))
- (output-event-for-a-stream msg type channel text logger i))))))
+ (case type
+ (:nick (source msg))
+ (:quit (source msg)))))
+ (channels (when user (cl-irc::channels user))))
+ (dolist (channel (mapcar
+ #'(lambda (name) (find-channel-with-name logger name))
+ (mapcar #'cl-irc::name channels)))
+ (when channel
+ (dotimes (i (length (formats logger)))
+ (output-event-for-a-stream msg type channel text logger i))))))
(t
;; msg contains channel name
(let* ((channel (find-channel-with-name logger channel-name)))
- (when channel
- (dotimes (i (length (formats logger)))
- (output-event-for-a-stream msg type channel text logger i))))))))
+ (when channel
+ (dotimes (i (length (formats logger)))
+ (output-event-for-a-stream msg type channel text logger i))))))))
+
+(defun get-private-log-stream (logger)
+ (if (and logger (private-log-stream logger))
+ (private-log-stream logger)
+ *standard-output*))
+
+(defun get-unknown-log-stream (logger)
+ (if (and logger (unknown-log-stream logger))
+ (unknown-log-stream logger)
+ *standard-output*))
+
+(defun add-log-entry (stream fmt &rest args)
+ (handler-case
+ (progn
+ (format-date-time (get-universal-time) :stream stream)
+ (write-char #\space stream)
+ (apply #'format stream fmt args)
+ (write-char #\newline stream)
+ (force-output stream))
+ (error (e)
+ (warn "Error ~A when trying to add-log-entry '~A'." e
+ (apply #'format nil fmt args)))))
+
+(defun add-private-log-entry (logger fmt &rest args)
+ (apply #'add-log-entry
+ (if (and logger (get-private-log-stream logger))
+ (get-private-log-stream logger)
+ *standard-output*)
+ fmt args))
(defun privmsg-hook (msg)
- (output-event msg :privmsg (first (arguments msg)) (trailing-argument msg)))
+ (let ((logger (find-logger-with-connection (connection msg)))
+ (channel (first (arguments msg))))
+ (cond
+ ((equal channel (l-nickname logger))
+ (add-private-log-entry logger "~A" (raw-message-string msg)))
+ (t
+ (output-event msg :privmsg channel (trailing-argument msg))))))
(defun action-hook (msg)
- (output-event msg :action (first (arguments msg))
- (subseq (trailing-argument msg) 8
- (- (length (trailing-argument msg)) 1))))
+ (let ((end (- (length (trailing-argument msg)) 1)))
+ ;; end has been as low as 7
+ (when (< end 8)
+ (warn "End is less than 8: `~A'." msg))
+ (output-event msg :action (first (arguments msg))
+ (subseq (trailing-argument msg) (min 8 end)
+ (- (length (trailing-argument msg)) 1)))))
(defun nick-hook (msg)
(output-event msg :nick nil (trailing-argument msg)))
(defun kick-hook (msg)
(let ((logger (find-logger-with-connection (connection msg)))
- (channel (first (arguments msg)))
- (who-kicked (second (arguments msg))))
- (when (string-equal (nickname logger) who-kicked)
- (warn "*** Logging daemon ~A has been kicked from ~A at ~A" (nickname logger)
- channel (format-date-time (received-time msg)))
- #+ignore (remove-channel-logger logger channel))
- (output-event msg :kick channel who-kicked)))
+ (channel (first (arguments msg)))
+ (who-kicked (second (arguments msg))))
+ (output-event msg :kick channel who-kicked)
+ (when (string-equal (l-nickname logger) who-kicked)
+ (add-private-log-entry
+ logger
+ "Logging daemon ~A has been kicked from ~A (~A)"
+ (l-nickname logger) channel (trailing-argument msg))
+ (daemon-sleep 5)
+ (remove-channel-logger logger channel)
+ (daemon-sleep 10)
+ (add-channel-logger logger channel)
+ (add-private-log-entry logger "Rejoined ~A" channel))))
(defun notice-hook (msg)
- (if (and (string-equal (source msg) "NickServ")
- (string-equal "owned by someone else" (trailing-argument msg)))
- (let ((logger (find-logger-with-connection (connection msg))))
- (if logger
- (privmsg (connection msg) (source msg) (format nil "IDENTIFY ~A" (password logger)))
- (warn "NickServ asks for identity with connection not found.")))
- (output-event msg :notice (first (arguments msg)) (trailing-argument msg))))
+ (let ((logger (find-logger-with-connection (connection msg)))
+ (channel (first (arguments msg))))
+ (cond
+ ((and (string-equal (source msg) "NickServ")
+ (string-equal channel (l-nickname logger))
+ (string-equal "owned by someone else" (trailing-argument msg)))
+ (if logger
+ (privmsg (connection msg) (source msg) (format nil "IDENTIFY ~A" (password logger)))
+ (add-private-log-entry logger "NickServ asks for identity with connection not found.")))
+ ((equal channel (l-nickname logger))
+ (add-private-log-entry logger "~A" (raw-message-string msg)))
+ (t
+ (output-event msg :notice channel (trailing-argument msg))))))
(defun ping-hook (msg)
(let ((logger (find-logger-with-connection (connection msg))))
(defun pong-hook (msg)
(let ((logger (find-logger-with-connection (connection msg))))
(setf (last-pong logger) (received-time msg))))
-
+
(defun topic-hook (msg)
(output-event msg :topic (first (arguments msg)) (trailing-argument msg)))
(defun mode-hook (msg)
- (output-event msg :mode (first (arguments msg))
- (format nil "~{~A~^ ~}" (cdr (arguments msg)))))
+ (output-event msg :mode (first (arguments msg))
+ (format nil "~{~A~^ ~}" (cdr (arguments msg)))))
+
+(defun rpl_namreply-hook (msg)
+ (output-event msg :names (third (arguments msg))
+ (trailing-argument msg)))
+
+(defun rpl_endofnames-hook (msg)
+ (declare (ignore msg))
+ ;; nothing to do for this message
+ )
+
+(defun rpl_topic-hook (msg)
+ (output-event msg :rpl_topic (format nil "~{~A~^ ~}" (arguments msg))
+ (trailing-argument msg)))
+
+(defun rpl_topicwhotime-hook (msg)
+ (output-event msg :rpl_topicwhotime
+ (second (arguments msg))
+ (third (arguments msg))))
+
+
+(defun invite-hook (msg)
+ (let ((logger (find-logger-with-connection (connection msg))))
+ (add-private-log-entry logger "~A" (raw-message-string msg))))
+
(defun make-a-channel (name formats output)
- (make-instance 'channel
- :name name
- :streams (make-array (length formats) :initial-element nil)
- :output-root (when (and (pathnamep output)
- (null (pathname-name output)))
- output)
- :current-output-names (make-array (length formats)
- :initial-element nil)))
-
+ (make-instance 'log-channel
+ :name name
+ :streams (make-array (length formats) :initial-element nil)
+ :output-root (when (and (pathnamep output)
+ (null (pathname-name output)))
+ output)
+ :current-output-names (make-array (length formats)
+ :initial-element nil)))
+
(defun make-channels (names formats output)
(loop for i from 0 to (1- (length names))
- collect (make-a-channel (elt names i) formats output)))
+ collect (make-a-channel (elt names i) formats output)))
(defun is-unichannel-output (user-output)
"Returns T if output is setup for a single channel directory structure."
(defun do-connect-and-join (nick server username realname logging-stream channels)
(let ((conn (connect :nickname nick :server server
- :username username :realname realname
- :logging-stream logging-stream)))
+ :username username :realname realname
+ :logging-stream logging-stream)))
(mapc #'(lambda (channel) (join conn channel)) channels)
(add-hook conn 'irc::irc-privmsg-message 'privmsg-hook)
(add-hook conn 'irc::ctcp-action-message 'action-hook)
(add-hook conn 'irc::irc-mode-message 'mode-hook)
(add-hook conn 'irc::irc-topic-message 'topic-hook)
(add-hook conn 'irc::irc-notice-message 'notice-hook)
- (add-hook conn 'irc::irc-rpl_killdone-message 'warning-hook)
- (add-hook conn 'irc::irc-rpl_closing-message 'warning-hook)
(add-hook conn 'irc::irc-error-message 'error-hook)
(add-hook conn 'irc::irc-ping-message 'ping-hook)
(add-hook conn 'irc::irc-pong-message 'pong-hook)
(add-hook conn 'irc::irc-kill-message 'kill-hook)
+ (add-hook conn 'irc::irc-invite-message 'invite-hook)
+ (add-hook conn 'irc::irc-rpl_killdone-message 'warning-hook)
+ (add-hook conn 'irc::irc-rpl_closing-message 'warning-hook)
+ (add-hook conn 'irc::irc-rpl_topic-message 'rpl_topic-hook)
+ (add-hook conn 'irc::irc-rpl_namreply-message 'rpl_namreply-hook)
+ (add-hook conn 'irc::irc-rpl_endofnames-message 'rpl_endofnames-hook)
+ (add-hook conn 'irc::irc-rpl_topicwhotime-message 'rpl_topicwhotime-hook)
conn))
+(defmethod cl-irc::irc-message-event :around ((msg cl-irc::irc-message))
+ (let ((result (call-next-method msg)))
+ (typecase msg
+ ((or irc::irc-privmsg-message irc::ctcp-action-message irc::irc-nick-message
+ irc::irc-part-message irc::irc-quit-message irc::irc-join-message
+ irc::irc-kick-message irc::irc-mode-message irc::irc-topic-message
+ irc::irc-notice-message irc::irc-error-message irc::irc-ping-message
+ irc::irc-pong-message irc::irc-kill-message irc::irc-invite-message
+ irc::irc-rpl_killdone-message irc::irc-rpl_closing-message
+ irc::irc-rpl_topic-message irc::irc-rpl_namreply-message
+ irc::irc-rpl_endofnames-message irc::irc-rpl_topicwhotime-message
+ irc::irc-rpl_motd-message irc::irc-rpl_motdstart-message
+ irc::irc-rpl_endofmotd-message)
+ ;; nothing to do
+ )
+ (t
+ (add-log-entry
+ (get-unknown-log-stream (find-logger-with-connection (connection msg)))
+ "~A"
+ (raw-message-string msg))))
+ result))
+
(defun create-logger (nick server &key channels output password
- realname username async
- (logging-stream t) (formats '(:text)))
+ realname username async
+ private-log unknown-log
+ (logging-stream t) (formats '(:text)))
"OUTPUT may be a pathname or a stream"
;; check arguments
(assert formats)
(if (stringp output)
(setq output (parse-namestring output)))
(let* ((conn (do-connect-and-join nick server username realname logging-stream channels))
- (logger (make-instance
- 'logger
- :connection conn
- :nick nick
- :password password
- :server server
- :channels (make-channels channels formats output)
- :channel-names channels
- :username username
- :realname realname
- :async async
- :logging-stream logging-stream
- :user-output output
- :formats formats
- :unichannel (is-unichannel-output output))))
+ (logger (make-instance
+ 'logger
+ :connection conn
+ :nick nick
+ :password password
+ :server server
+ :channels (make-channels channels formats output)
+ :channel-names channels
+ :username username
+ :realname realname
+ :async async
+ :logging-stream logging-stream
+ :user-output output
+ :formats formats
+ :private-log private-log
+ :unknown-log unknown-log
+ :private-log-stream (when private-log
+ (open private-log :direction :output
+ :if-exists :append
+ :if-does-not-exist :create))
+ :unknown-log-stream (when unknown-log
+ (open unknown-log :direction :output
+ :if-exists :append
+ :if-does-not-exist :create))
+ :unichannel (is-unichannel-output output))))
(unless *daemon-monitor-process*
(setq *daemon-monitor-process* (cl-irc::start-process 'daemon-monitor "logger-monitor")))
logger))
(defun start-logger (logger async)
(if async
(setf (handler logger)
- (start-background-message-handler (connection logger)))
+ (start-background-message-handler (connection logger)))
(read-message-loop (connection logger))))
(defun remove-logger (nick)
(let ((logger (find-logger-with-nick nick)))
(cond
((null logger)
- (warn "No active connection found with nick ~A." nick)
+ (warn
+ "~A No active connection found with nick ~A [remove-logger].~%"
+ (format-date-time (get-universal-time))
+ nick)
nil)
(t
- (ignore-errors (irc:quit (connection logger) ""))
- (stop-background-message-handler (handler logger))
+ (ignore-errors (quit-with-timeout (connection logger) ""))
+ (ignore-errors (stop-background-message-handler (handler logger)))
(sleep 1)
- (dolist (channel (channels logger))
- (let ((c (connection logger)))
- (when c
- (ignore-errors (remove-channel c (find-channel c (name channel)))))))
+ (ignore-errors
+ (let* ((c (connection logger))
+ (user (find-user c (l-nickname logger))))
+ (when (and c user)
+ (dolist (channel (channels logger))
+ (remove-channel user channel)))))
+ (ignore-errors (add-private-log-entry logger "Deleting loggers with nick of '~A' [remove-logger]." nick))
+ (when (private-log-stream logger)
+ (close (private-log-stream logger)))
+ (when (unknown-log-stream logger)
+ (close (unknown-log-stream logger)))
+
(setq *loggers*
- (delete nick *loggers* :test #'string-equal :key #'nickname))
+ (delete nick *loggers* :test #'string-equal :key #'l-nickname))
t))))
(defun add-logger (nick server &key channels output (password "")
- realname username
- (logging-stream t) (async t) (formats '(:text)))
+ realname username private-log unknown-log
+ (logging-stream t) (async t)
+ (formats '(:sexp)))
(when (find-logger-with-nick nick)
- (warn "Closing previously active connection.")
+ (add-private-log-entry (find-logger-with-nick nick)
+ "Closing previously active connection [add-logger].")
(ignore-errors (remove-logger nick)))
- (let ((logger (create-logger nick server :channels channels :output output
- :logging-stream logging-stream :password password
- :realname realname :username username
- :formats formats
- :async async)))
+ (add-private-log-entry nil "Calling create-logger [add-logger].~%")
+ (let ((logger
+ (do ((new-logger
+ (#-sbcl mp:with-timeout #-sbcl (*timeout* nil)
+ #+sbcl sb-ext:with-timeout #+sbcl *timeout*
+ (create-logger nick server :channels channels :output output
+ :logging-stream logging-stream :password password
+ :realname realname :username username
+ :private-log private-log
+ :unknown-log unknown-log
+ :formats formats
+ :async async))
+ (#-sbcl mp:with-timeout #-sbcl (*timeout* nil)
+ #+sbcl sb-ext:with-timeout #+sbcl *timeout*
+ (create-logger nick server :channels channels :output output
+ :logging-stream logging-stream :password password
+ :realname realname :username username
+ :private-log private-log
+ :unknown-log unknown-log
+ :formats formats
+ :async async))))
+ (new-logger
+ (progn
+ (add-private-log-entry nil "Acquired new logger ~A." new-logger)
+ new-logger))
+ (add-private-log-entry nil "Timeout trying to create new logger [add-logger]."))))
+ (add-private-log-entry logger "Pushing newly created logger ~A [add-logger].~%" logger)
(push logger *loggers*)
(start-logger logger async)
logger))
(defun add-channel-logger (logger channel-name)
(cond
((find-channel-with-name logger channel-name)
- (warn "Channel ~A already in logger ~A." channel-name logger)
+ (add-private-log-entry logger "Channel ~A already in logger ~A." channel-name logger)
nil)
(t
(let ((channel (make-a-channel channel-name (formats logger) (user-output logger))))
(channel
(part (connection logger) channel-name)
(dotimes (i (length (streams channel)))
- (when (streamp (get-stream channel i))
- (close (get-stream channel i))
- (setf (get-stream channel i) nil)))
+ (when (streamp (get-stream channel i))
+ (close (get-stream channel i))
+ (setf (get-stream channel i) nil)))
(setf (channels logger) (delete channel-name (channels logger)
- :test #'string-equal
- :key #'name))
+ :test #'string-equal
+ :key #'c-name))
(setf (channel-names logger) (delete channel-name (channel-names logger)
- :test #'string-equal))
+ :test #'string-equal))
t)
(t
- (warn "Channel name ~A not found in logger ~A."
- channel-name logger)
+ (add-private-log-entry
+ logger "Channel name ~A not found in logger ~A." channel-name logger)
nil))))
(defun add-hook-logger (logger class hook)
(defun kill-hook (msg)
(let ((target (second (arguments msg)))
- (logger (find-logger-with-connection (connection msg))))
+ (logger (find-logger-with-connection (connection msg))))
(when (and (stringp target)
- (string-equal target (nickname logger)))
+ (string-equal target (l-nickname logger)))
(setf (warning-message-utime logger) (received-time msg)))
- (output-event msg :kill nil (format nil "~{~A~^ ~}" (arguments msg)))))
+ (add-private-log-entry logger "Killed by ~A" (source msg))))
(defun error-hook (msg)
(let ((text (trailing-argument msg))
- (logger (find-logger-with-connection (connection msg))))
- (when (and (stringp text)
- (zerop (search (format nil "Closing Link: ~A" (nickname logger)) text)))
+ (logger (find-logger-with-connection (connection msg))))
+ (when (and (stringp text)
+ (eql 0 (search (format nil "Closing Link: ~A"
+ (l-nickname logger)) text)))
(setf (warning-message-utime logger) (received-time msg)))
(output-event msg :error nil (trailing-argument msg))))
(defun warning-hook (msg)
(let ((logger (find-logger-with-connection (connection msg))))
- (output-event msg :server
- (format nil "~{~A~^ ~} ~A)"
- (arguments msg)
- (trailing-argument msg)))
+ (output-event msg :server
+ (format nil "~{~A~^ ~} ~A)"
+ (arguments msg)
+ (trailing-argument msg)))
(when logger
(setf (warning-message-utime logger) (get-universal-time)))))
-
+
(defun daemon-sleep (seconds)
#-allegro (sleep seconds)
#+allegro (mp:process-sleep seconds))
(defun log-disconnection (logger)
;; avoid generating too many reconnect messages in the logs
(when (or (null (warning-message-utime logger))
- (< (- (get-universal-time) (warning-message-utime logger)) 300))
- (log-daemon-message logger "Disconnected. Attempting reconnection at ~A."
- (format-date-time (get-universal-time)))))
+ (< (- (get-universal-time) (warning-message-utime logger)) 300))
+ (log-daemon-message logger "Disconnected. Attempting reconnection.")))
(defun log-reconnection (logger)
- (log-daemon-message logger
- "Connection restablished at ~A." (format-date-time (get-universal-time))))
+ (log-daemon-message logger "Connection restablished."))
+#+ignore
(defun is-connected (logger)
+ (%is-connected logger))
+
+
+(defun is-connected (logger)
+ #-allegro (%is-connected logger)
+ #+allegro (mp:with-timeout (*timeout* nil)
+ (%is-connected logger)))
+
+(defun quit-with-timeout (connection msg)
+ #-allegro (quit connection msg)
+ #+allegro (mp:with-timeout (*timeout* nil)
+ (quit connection msg)))
+
+(defun %is-connected (logger)
(when (ignore-errors (ping (connection logger) (server logger)))
(dotimes (i 20)
(when (and (last-pong logger)
- (< (- (get-universal-time) (last-pong logger)) 21))
- (return-from is-connected t))
- (sleep 1))))
+ (< (- (get-universal-time) (last-pong logger)) 21))
+ (return-from %is-connected t))
+ (daemon-sleep 1))))
(let (*recon-nick* *recon-server* *recon-username* *recon-realname*
- *recon-user-output*
+ *recon-user-output* *recon-private-log* *recon-unknown-log*
*recon-formats* *recon-async* *recon-logging-stream* *recon-channel-names*)
(declare (special *recon-nick* *recon-server* *recon-username* *recon-realname*
- *recon-formats* *recon-password* *recon-async*
- *recon-user-output*
- *recon-logging-stream* *recon-channel-names*))
-
+ *recon-formats* *recon-password* *recon-async*
+ *recon-user-output* *recon-private-log* *recon-unknown-log*
+ *recon-logging-stream* *recon-channel-names*))
+
(defun attempt-reconnection (logger)
(when (is-connected logger)
(return-from attempt-reconnection nil))
-
+
(log-disconnection logger)
(when (connection logger)
- (ignore-errors (quit (connection logger) "Client terminated by server"))
- (setf *recon-nick* (nickname logger)
- *recon-server* (server logger)
- *recon-username* (username logger)
- *recon-realname* (realname logger)
- *recon-password* (password logger)
- *recon-async* (async logger)
- *recon-user-output* (user-output logger)
- *recon-formats* (formats logger)
- *recon-logging-stream* (logging-stream logger)
- *recon-channel-names* (channel-names logger))
+ (ignore-errors (quit-with-timeout (connection logger) "Client terminated by server"))
+ (setf *recon-nick* (l-nickname logger)
+ *recon-server* (server logger)
+ *recon-username* (l-username logger)
+ *recon-realname* (l-realname logger)
+ *recon-password* (password logger)
+ *recon-async* (async logger)
+ *recon-user-output* (user-output logger)
+ *recon-private-log* (private-log logger)
+ *recon-unknown-log* (unknown-log logger)
+ *recon-formats* (formats logger)
+ *recon-logging-stream* (logging-stream logger)
+ *recon-channel-names* (channel-names logger))
(ignore-errors (remove-logger logger)))
-
- (ignore-errors
- (add-logger *recon-nick* *recon-server*
- :channels *recon-channel-names*
- :output *recon-user-output*
- :password *recon-password*
- :realname *recon-realname*
- :username *recon-username*
- :logging-stream *recon-logging-stream*
- :async *recon-async*
- :formats *recon-formats*)))
- )
+
+ (do ((new-logger nil))
+ (new-logger)
+ (setq new-logger
+ (ignore-errors
+ (add-logger *recon-nick* *recon-server*
+ :channels *recon-channel-names*
+ :output *recon-user-output*
+ :password *recon-password*
+ :realname *recon-realname*
+ :username *recon-username*
+ :logging-stream *recon-logging-stream*
+ :private-log *recon-private-log*
+ :unknown-log *recon-unknown-log*
+ :async *recon-async*
+ :formats *recon-formats*)))
+ (cond
+ (new-logger
+ (sleep 240)
+ (cond
+ ((is-connected new-logger)
+ (log-reconnection new-logger))
+ (t
+ (log-daemon-message new-logger "Newly added logger is not connected. Removing connection and will re-attempt.")
+ (ignore-errors (remove-logger new-logger))
+ (sleep 60)
+ (setq new-logger nil))))
+ (t
+ (log-daemon-message nil "Got NIL for new logger. Waiting and retrying.")
+ (sleep 20)))))
+ ) ;; end closure
(defun daemon-monitor ()
"This function runs in the background and monitors the connection of the logger."
;; run forever
- (do ()
- ()
- (block main-loop
- (dolist (logger *loggers*)
- (do ((warning-time (warning-message-utime logger) (warning-message-utime logger)))
- ((or (is-connected logger) (null warning-time)))
- (cond
- ((and warning-time (> (- (get-universal-time) warning-time) 180))
- ;;give up frequent checking because no disconnection despite waiting
- (setf (warning-message-utime logger) nil))
- ((not (is-connected logger))
- (unless warning-time
- (setf (warning-message-utime logger) (get-universal-time)))
- (attempt-reconnection logger)
- ;;after a succesful reconnection, the value of logger will be invalid
- (sleep 30)
- (return-from main-loop))
- (t
- (daemon-sleep 30)))))
- (do ((i 0 (1+ i)))
- ((or (>= i 20) (some (lambda (logger) (warning-message-utime logger)) *loggers*)))
- (daemon-sleep 15)))))
-
+ (loop
+ do
+ (monitor-once)))
+
+(defun monitor-once ()
+ (dolist (logger *loggers*)
+ (do ((warning-time (warning-message-utime logger) (warning-message-utime logger)))
+ ((and (is-connected logger) (null warning-time)))
+ (cond
+ ((and warning-time (> (- (get-universal-time) warning-time) 180))
+ ;;give up frequent checking because no disconnection despite waiting
+ (setf (warning-message-utime logger) nil))
+ ((not (is-connected logger))
+ (unless warning-time
+ (setf (warning-message-utime logger) (get-universal-time)))
+ (attempt-reconnection logger)
+ ;;after a succesful reconnection, the value of logger will be invalid
+ (sleep 30)
+ (return-from monitor-once))
+ (t
+ (daemon-sleep 30)))))
+ (do ((i 0 (1+ i)))
+ ((or (>= i 10) (some (lambda (logger) (warning-message-utime logger)) *loggers*)))
+ (daemon-sleep 15)))
+
+
+
projects / irc-logger.git / blobdiff