fba1e028887e52b21e0c3ca918d4efe54cb83de1
[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 c mode))))))
212
213 (defmethod handle-prompt ((m play-mode) message)
214   (let* ((c (connection m)))
215     (with-input-from-string (s message)
216       (let* ((minutes (read s)) ;;FIXME DANGEROUS
217              (btus (read s)))
218         (empire-web:prompt (session c)
219                            (format nil "[~a,~a]: " minutes btus))))
220     (send-next-line c)))
221
222 (defmethod handle-ignore ((m init-mode) message)
223   (declare (ignorable message))
224   t)
225
226 (defparameter *line-type-dispatch*
227   (list `(,+C_DATA+ . handle-data)
228         `(,+C_INIT+ . handle-init)
229         `(,+C_EXIT+ . handle-exit)
230         `(,+C_FLUSH+ . handle-flush)
231         `(,+C_BADCMD+ . handle-simple-message)
232         `(,+C_FLASH+ . handle-simple-message)
233         `(,+C_CMDOK+ . handle-cmdok)
234         `(,+C_PROMPT+ . handle-prompt)))
235
236 (defun parse-server-line (line)
237   (let* ((first-space-index
238           (loop for i from 0 below (length line)
239              if (eq (char line i) #\Space)
240              do (return i)))
241          (message-type (subseq line 0 first-space-index))
242          (message (if first-space-index
243                       (subseq line (+ first-space-index 1))
244                       "")))
245     (values message message-type)))
246
247 (defmethod handle-connection ((c connection))
248   (setf (connection-mode c) (make-mode c 'init-mode))
249   (loop while (read-message c)))
250
251 (defun lookup-handler (message-type)
252   (cdr (assoc message-type *line-type-dispatch* :test 'string=)))
253
254 (define-condition no-handler (error)
255   ((mode :initarg :mode)
256    (type :initarg :type))
257   (:report (lambda (condition stream)
258              (with-slots (mode type) condition
259                (format stream "No handler for ~a in mode ~a."
260                        type mode)))))
261 (defmethod read-message ((c connection))
262   (handler-case
263       (let* ((s (network-stream c))
264              (line (read-line s)))
265         (empire-log:info "~a: < ~a" c line)
266         (multiple-value-bind (message type) (parse-server-line line)
267           (let ((handler (lookup-handler type))
268                 (mode (connection-mode c)))
269             (if handler
270                 (funcall handler mode message)
271                 (error 'no-handler :mode mode :type type))))
272         line)
273     (sb-int:closed-stream-error () nil)
274     (sb-int:simple-stream-error () nil)
275     (end-of-file () nil)))
276
277 (defun raw-send-message (s message)
278     (write-sequence message s)
279     (terpri s)
280     (force-output s))
281
282 (defgeneric send-message-one (connection string))
283 (defmethod send-message-one ((c connection) message)
284   (empire-log:info "~a: > ~a" c message)
285   (let ((s (network-stream c)))
286     (raw-send-message s message)))
287
288 (defmethod send-message ((c connection) message &key next-mode)
289   (if (not (connected-p c))
290       (reconnect c))
291   (if next-mode
292       (locked-queue:enqueue (send-queue c) (cons message next-mode))
293       (locked-queue:enqueue (send-queue c) message)))
294
295 (defparameter +special-command-char+ #\;)
296
297 (defun special-command-p (line)
298   (and (> (length line) 0)
299        (char= +special-command-char+ (aref line 0))))
300
301 (defmethod special-xup ((c connection))
302   t)
303
304 (defmethod special-command ((c connection) line)
305   (cond ((string= line "xup") (special-xup c))
306         (t (empire-web:data (session c) "Unknown special command")))
307   line)
308
309 (defmethod command ((c connection) line)
310   (cond ((special-command-p line) (special-command c (subseq line 1)))
311         (t (send-message c line))))
312
313 (defmethod quit ((c connection))
314   (usocket:socket-close (socket c)))