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