Throw error on unknown event type
[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   ((play-sent-p :initform nil
131                 :documentation "Have we already sent the play command?")))
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-data (base-mode message))
145 (defgeneric handle-init (base-mode message))
146 (defgeneric handle-exit (base-mode message))
147 (defgeneric handle-prompt (base-mode message))
148 (defgeneric handle-flush (base-mode message))
149 (defgeneric handle-simple-message (base-mode message))
150 (defgeneric handle-ignore (base-mode message))
151
152 (defmethod handle-init ((m init-mode) message)
153   (declare (ignorable message))
154   (with-slots (play-sent-p) m
155     (if (not play-sent-p)
156         (let ((c (connection m)))
157           (login-and-play c)
158           (setf play-sent-p t))
159         (set-new-mode m 'play-mode))))
160
161 (defmethod handle-exit ((m init-mode) message)
162   (declare (ignorable message))
163   t)
164
165 (defmethod handle-exit ((m play-mode) message)
166   (declare (ignorable message))
167   (quit (connection m)))
168
169 (defmethod handle-data ((m play-mode) message)
170   (let* ((c (connection m)))
171     (empire-web:data (session c) message)))
172
173 (defmethod handle-simple-message ((m play-mode) message)
174   (let* ((c (connection m)))
175     (empire-web:data (session c) message)))
176
177 (defmethod handle-flush ((m play-mode) message)
178   (let* ((c (connection m)))
179     (empire-web:prompt (session c) message)
180     (send-next-line c)))
181
182 (defmethod send-next-line ((c connection))
183   (let ((next-event (locked-queue:dequeue (send-queue c))))
184     (etypecase next-event
185       (string (send-message-one c next-event))
186       (cons (let ((message (car next-event))
187                   (mode (cdr next-event)))
188               (send-message-one c message)
189               (set-new-mode c mode))))))
190
191 (defmethod handle-prompt ((m play-mode) message)
192   (let* ((c (connection m)))
193     (with-input-from-string (s message)
194       (let* ((minutes (read s)) ;;FIXME DANGEROUS
195              (btus (read s)))
196         (empire-web:prompt (session c)
197                            (format nil "[~a,~a]: " minutes btus))))
198     (send-next-line c)))
199
200 (defmethod handle-ignore ((m init-mode) message)
201   (declare (ignorable message))
202   t)
203
204 (defparameter *line-type-dispatch*
205   (list `(,+C_DATA+ . handle-data)
206         `(,+C_INIT+ . handle-init)
207         `(,+C_EXIT+ . handle-exit)
208         `(,+C_FLUSH+ . handle-flush)
209         `(,+C_BADCMD+ . handle-simple-message)
210         `(,+C_FLASH+ . handle-simple-message)
211         `(,+C_CMDOK+ . handle-ignore)
212         `(,+C_PROMPT+ . handle-prompt)))
213
214 (defun parse-server-line (line)
215   (let* ((first-space-index
216           (loop for i from 0 below (length line)
217              if (eq (char line i) #\Space)
218              do (return i)))
219          (message-type (subseq line 0 first-space-index))
220          (message (if first-space-index
221                       (subseq line (+ first-space-index 1))
222                       "")))
223     (values message message-type)))
224
225 (defmethod handle-connection ((c connection))
226   (setf (connection-mode c) (make-mode c 'init-mode))
227   (loop while (read-message c)))
228
229 (defun lookup-handler (message-type)
230   (cdr (assoc message-type *line-type-dispatch* :test 'string=)))
231
232 (define-condition no-handler (error)
233   ((mode :initarg :mode)
234    (type :initarg :type))
235   (:report (lambda (condition stream)
236              (with-slots (mode type) condition
237                (format stream "No handler for ~a in mode ~a."
238                        type mode)))))
239 (defmethod read-message ((c connection))
240   (handler-case
241       (let* ((s (network-stream c))
242              (line (read-line s)))
243         (empire-log:info "~a: < ~a" c line)
244         (multiple-value-bind (message type) (parse-server-line line)
245           (let ((handler (lookup-handler type))
246                 (mode (connection-mode c)))
247             (if handler
248                 (funcall handler mode message)
249                 (error 'no-handler :mode mode :type type))))
250         line)
251     (sb-int:closed-stream-error () nil)
252     (end-of-file () nil)))
253
254 (defun raw-send-message (s message)
255     (write-sequence message s)
256     (terpri s)
257     (force-output s))
258
259 (defgeneric send-message-one (connection string))
260 (defmethod send-message-one ((c connection) message)
261   (empire-log:info "~a: > ~a" c message)
262   (let ((s (network-stream c)))
263     (raw-send-message s message)))
264
265 (defmethod send-message ((c connection) message &key next-mode)
266   (if (not (connected-p c))
267       (reconnect c))
268   (if next-mode
269       (locked-queue:enqueue (send-queue c) (cons message next-mode))
270       (locked-queue:enqueue (send-queue c) message)))
271
272 (defparameter +special-command-char+ #\;)
273
274 (defun special-command-p (line)
275   (and (> (length line) 0)
276        (char= +special-command-char+ (aref line 0))))
277
278 (defmethod special-xup ((c connection))
279   t)
280
281 (defmethod special-command ((c connection) line)
282   (cond ((string= line "xup") (special-xup c))
283         (t (empire-web:data (session c) "Unknown special command")))
284   line)
285
286 (defmethod command ((c connection) line)
287   (cond ((special-command-p line) (special-command c (subseq line 1)))
288         (t (send-message c line))))
289
290 (defgeneric login-and-play (connection))
291 (defmethod login-and-play ((c connection))
292   (send-message-one c (format nil "client eow ~a" *version*))
293   (send-message-one c "user FIXME")
294   (with-slots (user password) c
295     (send-message-one c (format nil "coun ~a" user))
296     (send-message-one c (format nil "pass ~a" password)))
297   (send-message-one c "kill")
298   (send-message-one c "play"))
299
300 (defmethod quit ((c connection))
301   (usocket:socket-close (socket c)))
302
303
304 ;;; Tests
305 (defvar *l1* "2 Empire server ready")
306 ;; (parse-server-line *l1*)