git.pond.sub.org Git - eow/blob - empire.lisp

   1 (in-package :empire)
   2
   3 (defparameter *version* "0.0.1")
   4
   5 ;;
   6 ;; Connection
   7 ;;
   8
   9 (defvar *default-empire-server* "localhost")
  10 (defvar *default-empire-server-port* 6665)
  11
  12 (defclass connection ()
  13   ((user
  14     :initarg :user
  15     :accessor user)
  16    (password
  17     :initarg :password
  18     :accessor password
  19     :initform nil)
  20    (server-name
  21     :initarg :server-name
  22     :accessor server-name
  23     :initform "Unknown server")
  24    (server-port
  25     :initarg :server-port
  26     :accessor server-port
  27     :initform *default-empire-server-port*)
  28    (socket
  29     :initarg :socket
  30     :accessor socket
  31     :documentation "Slot to store socket (for internal use only).")
  32    (stream
  33     :initarg :stream
  34     :accessor network-stream
  35     :documentation "Stream used to talk to the empire server.")
  36    (connection-handler
  37     :accessor connection-handler
  38     :initform nil
  39     :documentation "Handler function for incoming messages")
  40    (mode
  41     :accessor connection-mode
  42     :initform nil
  43     :documentation "TODO(gefla)")
  44    (session
  45     :accessor session
  46     :initarg :session
  47     :documentation "web session to which this connection belongs")
  48    (send-queue
  49     :accessor send-queue
  50     :initform (locked-queue:create)
  51     :documentation "lines outstanding to be sent at next prompt")
  52    (xdump :accessor xdump :initform (xdump:make-parser))))
  53
  54 (defun make-connection (&key (user nil)
  55                         (password nil)
  56                         (server-name *default-empire-server*)
  57                         (server-port *default-empire-server-port*)
  58                         (socket nil)
  59                         (network-stream nil)
  60                         session)
  61   (make-instance 'connection
  62                  :user user
  63                  :password password
  64                  :server-name server-name
  65                  :server-port server-port
  66                  :socket socket
  67                  :stream network-stream
  68                  :session session))
  69
  70 ;;; interface
  71 (defun connect  (&key (user nil)
  72                  (password nil)
  73                  (server-name *default-empire-server*)
  74                  (server-port *default-empire-server-port*)
  75                  session)
  76   "Connect to server and return a connection object."
  77   (let* ((socket (usocket:socket-connect server-name server-port))
  78          (stream (usocket:socket-stream socket))
  79          (connection (make-connection :user user
  80                                       :password password
  81                                       :socket socket
  82                                       :network-stream stream
  83                                       :server-name server-name
  84                                       :server-port server-port
  85                                       :session session))
  86          (handler (spawn-with-name (format nil "empire-handler-~a" user)
  87                                    #'handle-connection connection)))
  88     (setf (connection-handler connection) handler)
  89     (empire-log:info "~a: connect" connection)
  90     connection))
  91
  92 (defgeneric quit (connection))
  93 (defgeneric handle-connection (connection))
  94 (defgeneric read-message (connection))
  95 (defgeneric send-message (connection message &key next-mode))
  96 (defgeneric connected-p (connection))
  97 (defgeneric reconnect (conncetion))
  98
  99 (defmethod connected-p ((c connection))
 100   (sb-thread:thread-alive-p (connection-handler c)))
 101
 102 (defmethod reconnect ((c connection))
 103   (with-slots (server-name server-port user password socket stream connection-handler) c
 104       (let* ((sock (usocket:socket-connect server-name server-port))
 105              (s (usocket:socket-stream sock)))
 106         (setf socket sock
 107               stream s
 108               connection-handler (spawn-with-name (format nil "empire-handler-~a" user)
 109                                                   #'handle-connection c))))
 110   (empire-log:info "~a: reconnect" c))
 111
 112 (defparameter +C_CMDOK+ "0")
 113 (defparameter +C_DATA+ "1")
 114 (defparameter +C_INIT+ "2")
 115 (defparameter +C_EXIT+ "3")
 116 (defparameter +C_FLUSH+ "4")
 117 (defparameter +C_NOECHO+ "5")
 118 (defparameter +C_PROMPT+ "6")
 119 (defparameter +C_ABORT+ "7")
 120 (defparameter +C_REDIR+ "8")
 121 (defparameter +C_PIPE+ "9")
 122 (defparameter +C_CMDERR+ "a")
 123 (defparameter +C_BADCMD+ "b")
 124 (defparameter +C_EXECUTE+ "c")
 125 (defparameter +C_FLASH+ "d")
 126 (defparameter +C_INFORM+ "e")
 127
 128 (defclass base-mode ()
 129   ((connection :initarg :connection :accessor connection)))
 130 (defclass init-mode (base-mode)
 131   ((phase :initform :initial
 132           :documentation "Initialization phase")))
 133 (defclass play-mode (base-mode) nil)
 134
 135 (defun make-mode (connection mode)
 136   (make-instance mode :connection connection))
 137
 138 (defgeneric set-new-mode (base-mode new-mode))
 139 (defmethod set-new-mode ((m base-mode) new-mode)
 140   (let* ((c (connection m))
 141          (mode (make-mode c new-mode)))
 142     (empire-log:info "~a: set-new-mode ~a -> ~a" c (connection-mode c) new-mode)
 143     (setf (connection-mode c) mode)))
 144
 145 (defgeneric handle-cmdok (base-mode message))
 146 (defgeneric handle-data (base-mode message))
 147 (defgeneric handle-init (base-mode message))
 148 (defgeneric handle-exit (base-mode message))
 149 (defgeneric handle-prompt (base-mode message))
 150 (defgeneric handle-flush (base-mode message))
 151 (defgeneric handle-simple-message (base-mode message))
 152 (defgeneric handle-ignore (base-mode message))
 153
 154 (defmethod handle-init ((m init-mode) message)
 155   (declare (ignorable message))
 156   (with-slots (phase connection) m
 157     (ecase phase
 158       (:initial (handle-cmdok m message))
 159       (:play-sent (set-new-mode m 'play-mode)))))
 160
 161 (defmethod handle-cmdok ((m init-mode) message)
 162   (declare (ignorable message))
 163   (with-slots (phase connection) m
 164     (flet ((init-phase (mode send-args next-phase)
 165              (with-slots (phase connection) mode
 166                (send-message-one connection (apply #'format nil send-args))
 167                (setf phase next-phase))))
 168       (with-slots (user password) (connection m)
 169         (ecase phase
 170           (:initial (init-phase m `("client eow ~a" ,*version*) :client-sent))
 171           (:client-sent (init-phase m `("coun ~a" ,user) :coun-sent))
 172           (:coun-sent (init-phase m `("pass ~a" ,password) :pass-sent))
 173           (:pass-sent (init-phase m '("play") :play-sent)))))))
 174
 175 (defmethod handle-exit ((m init-mode) message)
 176   (declare (ignorable message))
 177   (with-slots (phase connection) m
 178     (ecase phase
 179       (:play-sent (send-message-one connection "kill")
 180                   (setf phase :kill-sent))
 181       (:kill-sent (send-message-one connection "play")
 182                   (setf phase :play-sent)))))
 183
 184 (defmethod handle-data ((m init-mode) message)
 185   (declare (ignorable message))
 186   t)
 187
 188 (defmethod handle-exit ((m play-mode) message)
 189   (declare (ignorable message))
 190   (quit (connection m)))
 191
 192 (defmethod handle-data ((m play-mode) message)
 193   (let* ((c (connection m)))
 194     (empire-web:data (session c) message)))
 195
 196 (defmethod handle-simple-message ((m play-mode) message)
 197   (let* ((c (connection m)))
 198     (empire-web:data (session c) message)))
 199
 200 (defmethod handle-flush ((m play-mode) message)
 201   (let* ((c (connection m)))
 202     (empire-web:prompt (session c) message)
 203     (send-next-line c)))
 204
 205 (defmethod send-next-line ((c connection))
 206   (let ((next-event (locked-queue:dequeue (send-queue c))))
 207     (etypecase next-event
 208       (string (send-message-one c next-event))
 209       (cons (let ((message (car next-event))
 210                   (mode (cdr next-event)))
 211               (send-message-one c message)
 212               (set-new-mode (connection-mode c) mode))))))
 213
 214 (defun read-no-eval (stream)
 215   (let ((*read-eval* nil))
 216     (read stream)))
 217
 218 (defmethod handle-prompt ((m play-mode) message)
 219   (let* ((c (connection m)))
 220     (with-input-from-string (s message)
 221       (let* ((minutes (read-no-eval s))
 222              (btus (read-no-eval s)))
 223         (empire-web:prompt (session c)
 224                            (format nil "[~a,~a]: " minutes btus))))
 225     (send-next-line c)))
 226
 227 (defmethod handle-ignore ((m init-mode) message)
 228   (declare (ignorable message))
 229   t)
 230
 231 (defparameter *line-type-dispatch*
 232   (list `(,+C_DATA+ . handle-data)
 233         `(,+C_INIT+ . handle-init)
 234         `(,+C_EXIT+ . handle-exit)
 235         `(,+C_FLUSH+ . handle-flush)
 236         `(,+C_BADCMD+ . handle-simple-message)
 237         `(,+C_FLASH+ . handle-simple-message)
 238         `(,+C_CMDOK+ . handle-cmdok)
 239         `(,+C_PROMPT+ . handle-prompt)))
 240
 241 (defun parse-server-line (line)
 242   (let* ((first-space-index
 243           (loop for i from 0 below (length line)
 244              if (eq (char line i) #\Space)
 245              do (return i)))
 246          (message-type (subseq line 0 first-space-index))
 247          (message (if first-space-index
 248                       (subseq line (+ first-space-index 1))
 249                       "")))
 250     (values message message-type)))
 251
 252 (defmethod handle-connection ((c connection))
 253   (setf (connection-mode c) (make-mode c 'init-mode))
 254   (loop while (read-message c)))
 255
 256 (defun lookup-handler (message-type)
 257   (cdr (assoc message-type *line-type-dispatch* :test 'string=)))
 258
 259 (define-condition no-handler (error)
 260   ((mode :initarg :mode)
 261    (type :initarg :type))
 262   (:report (lambda (condition stream)
 263              (with-slots (mode type) condition
 264                (format stream "No handler for ~a in mode ~a."
 265                        type mode)))))
 266 (defmethod read-message ((c connection))
 267   (handler-case
 268       (let* ((s (network-stream c))
 269              (line (read-line s)))
 270         (empire-log:info "~a: < ~a" c line)
 271         (multiple-value-bind (message type) (parse-server-line line)
 272           (let ((handler (lookup-handler type))
 273                 (mode (connection-mode c)))
 274             (if handler
 275                 (funcall handler mode message)
 276                 (error 'no-handler :mode mode :type type))))
 277         line)
 278     (sb-int:closed-stream-error () nil)
 279     (sb-int:simple-stream-error () nil)
 280     (end-of-file () nil)))
 281
 282 (defun raw-send-message (s message)
 283     (write-sequence message s)
 284     (terpri s)
 285     (force-output s))
 286
 287 (defgeneric send-message-one (connection string))
 288 (defmethod send-message-one ((c connection) message)
 289   (empire-log:info "~a: > ~a" c message)
 290   (let ((s (network-stream c)))
 291     (raw-send-message s message)))
 292
 293 (defmethod send-message ((c connection) message &key next-mode)
 294   (if (not (connected-p c))
 295       (reconnect c))
 296   (if next-mode
 297       (locked-queue:enqueue (send-queue c) (cons message next-mode))
 298       (locked-queue:enqueue (send-queue c) message)))
 299
 300 (defparameter +special-command-char+ #\;)
 301
 302 (defun special-command-p (line)
 303   (and (> (length line) 0)
 304        (char= +special-command-char+ (aref line 0))))
 305
 306 (defclass xdump-mode (play-mode)
 307   ((phase :initform :meta-meta)
 308    (dump-queue :initform nil)
 309    (dump-index :initform 0)))
 310
 311 (defmethod handle-data ((m xdump-mode) message)
 312   (with-slots (connection phase dump-queue dump-index) m
 313     (if (xdump:parse-line (xdump connection) message)
 314         ;;XXX consider something like a 'pop-mode function
 315         (ccase phase
 316           (:meta-meta
 317            (setf phase :meta-table)
 318            (send-message connection "xdump meta table"))
 319           (:meta-table
 320            (setf phase :table-table)
 321            (send-message connection "xdump table *"))
 322           (:table-table
 323            (setf phase :tables-meta
 324                  dump-queue (xdump::table-entries (xdump::get-table "table"))
 325                  dump-index 0)
 326            (send-message connection (format nil "xdump meta ~a" (xdump-data::table-name (aref dump-queue 0)))))
 327           (:tables-meta
 328            (setf phase :tables-content)
 329            (send-message connection (format nil "xdump ~a *" (xdump-data::table-name (aref dump-queue dump-index)))))
 330           (:tables-content
 331            (if (< dump-index (fill-pointer dump-queue))
 332                (progn (setf phase :tables-meta)
 333                       (incf dump-index)
 334                       (loop while (and (< dump-index (fill-pointer dump-queue))
 335                                        (let ((dump-queue-entry (aref dump-queue dump-index)))
 336                                          (or (null dump-queue-entry)
 337                                              (string= "meta" (xdump-data::table-name dump-queue-entry)))))
 338                          do (incf dump-index))
 339                       (if (and (<= dump-index (fill-pointer dump-queue))
 340                                (not (null (aref dump-queue dump-index))))
 341                           (send-message connection (format nil "xdump meta ~a" (xdump-data::table-name (aref dump-queue dump-index))))))
 342                (set-new-mode (connection-mode connection) 'play-mode)))))))
 343
 344 (defmethod special-xup ((c connection))
 345   (send-message c "xdump meta meta" :next-mode 'xdump-mode))
 346
 347 (defmethod special-command ((c connection) line)
 348   (cond ((string= line "xup") (special-xup c))
 349         (t (empire-web:data (session c) "Unknown special command")))
 350   line)
 351
 352 (defmethod command ((c connection) line)
 353   (cond ((special-command-p line) (special-command c (subseq line 1)))
 354         (t (send-message c line))))
 355
 356 (defmethod quit ((c connection))
 357   (usocket:socket-close (socket c)))