-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathThreadedAppServer.py
More file actions
1499 lines (1259 loc) · 50.8 KB
/
Copy pathThreadedAppServer.py
File metadata and controls
1499 lines (1259 loc) · 50.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
"""Threaded Application Server
The AppServer is the main process of WebKit. It handles requests for
servlets from webservers.
ThreadedAppServer uses a threaded model for handling multiple requests.
At one time there were other experimental execution models for AppServer,
but none of these were successful and have been removed.
The ThreadedAppServer/AppServer distinction is thus largely historical.
ThreadedAppServer takes the following command line arguments:
start: start the AppServer (default argument)
stop: stop the currently running Apperver
daemon: run as a daemon
ClassName.SettingName=value: change configuration settings
When started, the app server records its pid in appserver.pid.
"""
import errno
import os
import select
import socket
import sys
import threading
import traceback
import Queue
from marshal import dumps, loads
from threading import Thread, currentThread
from time import time, localtime, sleep
try:
from ctypes import pythonapi, c_long, py_object
except ImportError:
py_object = c_long = pythonapi = None
try:
PyThreadState_SetAsyncExc = pythonapi.PyThreadState_SetAsyncExc
except (TypeError, AttributeError):
PyThreadState_SetAsyncExc = None
try:
import fcntl
F_GETFD, F_SETFD = fcntl.F_SETFD, fcntl.F_SETFD
except (ImportError, AttributeError): # not Unix
fcntl = None
else:
try:
FD_CLOEXEC = fcntl.FD_CLOEXEC
except AttributeError: # not always defined
FD_CLOEXEC = 1
from MiscUtils.Funcs import asclocaltime
from WebUtils.Funcs import requestURI
import AppServer as AppServerModule
from PidFile import ProcessRunning
from AutoReloadingAppServer import AutoReloadingAppServer as AppServer
from ASStreamOut import ASStreamOut, ConnectionAbortedError
from HTTPExceptions import HTTPServiceUnavailable
debug = False
defaultConfig = dict(
Host = 'localhost', # same as '127.0.0.1'
EnableAdapter = True, # enable WebKit adapter
AdapterPort = 8086,
EnableMonitor = False, # disable status monitoring
SCGIPort = 8084,
EnableSCGI = False, # disable SCGI adapter
MonitorPort = 8085,
EnableHTTP = True, # enable built-in HTTP server
HTTPPort = 8080,
StartServerThreads = 10, # initial number of server threads
MinServerThreads = 5, # minimum number
MaxServerThreads = 20, # maxium number
UseDaemonThreads = True, # use daemonic worker threads
MaxRequestTime = 300, # maximum request execution time in seconds
RequestQueueSize = 0, # means twice the maximum number of threads
RequestBufferSize = 8*1024, # 8 kBytes
ResponseBufferSize = 8*1024, # 8 kBytes
AddressFiles = '%s.address', # %s stands for the protocol name
# @@ the following setting is not yet implemented
# SocketType = 'inet', # inet, inet6, unix
)
# Need to know this value for communications
# (note that this limits the size of the dictionary we receive
# from the AppServer to 2,147,483,647 bytes):
intLength = len(dumps(int(1)))
# Initialize global variables
server = None
exitStatus = 0
class NotEnoughDataError(Exception):
"""Not enough data received error"""
class ProtocolError(Exception):
"""Network protocol error"""
class ThreadAbortedError(HTTPServiceUnavailable):
"""Thread aborted error"""
class RequestAbortedError(ThreadAbortedError):
"""Request aborted error"""
class RequestTooLongError(RequestAbortedError):
"""Request lasts too long error"""
class ServerShutDownError(ThreadAbortedError):
"""Server has been shut down error"""
class WorkerThread(Thread):
"""Base class for Webware worker threads that can be aborted.
(Idea taken from: http://sebulba.wikispaces.com/recipe+thread2)
"""
_canAbort = PyThreadState_SetAsyncExc is not None
def threadID(self):
"""Return the thread's internal id."""
try:
return self._threadID
except AttributeError:
for threadID, t in threading._active.items():
if t is self:
self._threadID = threadID
return threadID
def abort(self, exception=ThreadAbortedError):
"""Abort the current thread by raising an exception in its context.
A return value of one means the thread was successfully aborted,
a value of zero means the thread could not be found,
any other value indicates that an error has occurred.
"""
if not self._canAbort:
if debug:
print "Error: Aborting threads is not possible"
return -1
if debug:
print "Aborting worker thread..."
try:
processing = self.isAlive() and self._processing
except AttributeError:
processing = False
if not processing:
if debug:
print "Error: Thread is not working."
threadID = self.threadID()
if threadID is None:
if debug:
print "Error: Worker thread id not found"
return 0
if debug:
print "Worker thread id is", threadID
try:
ret = PyThreadState_SetAsyncExc(
c_long(threadID), py_object(exception))
# If it returns a number greater than one, we're in trouble,
# and should call it again with exc=NULL to revert the effect
if ret > 1:
PyThreadState_SetAsyncExc(c_long(threadID), py_object())
except Exception:
ret = -1
if debug:
if ret == 0:
print "Error: Could not find thread", threadID
elif ret != 1:
print "Error: Could not abort thread", threadID
return ret
def setCloseOnExecFlag(fd):
"""Set flag for file descriptor not to be inherited by child processes."""
try:
fcntl.fcntl(fd, F_SETFD, fcntl.fcntl(fd, F_GETFD) | FD_CLOEXEC)
except IOError:
pass
class ThreadedAppServer(AppServer):
"""Threaded Application Server.
`ThreadedAppServer` accepts incoming socket requests, spawns a
new thread or reuses an existing one, then dispatches the request
to the appropriate handler (e.g., an Adapter handler, HTTP handler,
etc., one for each protocol).
The transaction is connected directly to the socket, so that the
response is sent directly (if streaming is used, like if you call
`response.flush()`). Thus the ThreadedAppServer packages the
socket/response, rather than value being returned up the call chain.
"""
## Init ##
def __init__(self, path=None):
"""Setup the AppServer.
Create an initial thread pool (threads created with `spawnThread`),
and the request queue, record the PID in a file, and add any enabled
handlers (Adapter, HTTP, Monitor).
"""
self._threadPool = []
self._threadCount = 0
self._threadUseCounter = []
self._addr = {}
self._requestID = 0
self._socketHandlers = {}
self._handlerCache = {}
self._threadHandler = {}
self._sockets = {}
self._defaultConfig = None
AppServer.__init__(self, path)
try:
threadCount = self.setting('StartServerThreads')
self._maxServerThreads = self.setting('MaxServerThreads')
self._minServerThreads = self.setting('MinServerThreads')
self._useDaemonThreads = self.setting('UseDaemonThreads')
self._requestQueueSize = self.setting('RequestQueueSize')
if not self._requestQueueSize:
# if not set, make queue size twice the max number of threads
self._requestQueueSize = 2 * self._maxServerThreads
elif self._requestQueueSize < self._maxServerThreads:
# otherwise do not make it smaller than the max number of threads
self._requestQueueSize = self._maxServerThreads
self._requestBufferSize = self.setting('RequestBufferSize')
self._responseBufferSize = self.setting('ResponseBufferSize')
self._requestQueue = Queue.Queue(self._requestQueueSize)
maxRequestTime = self.setting('MaxRequestTime') or None
if maxRequestTime and not self._canAbortRequest:
print ("Warning: MaxRequestTime setting ineffective"
" (cannot abort requests)")
maxRequestTime = None
self._maxRequestTime = maxRequestTime
self._checkRequestTime = None
out = sys.stdout
out.write('Creating %d threads' % threadCount)
for i in range(threadCount):
self.spawnThread()
if not debug:
out.write(".")
out.flush()
out.write("\n")
if self.setting('EnableAdapter'):
self.addSocketHandler(AdapterHandler)
if self.setting('EnableMonitor'):
self.addSocketHandler(MonitorHandler)
if self.setting('EnableSCGI'):
self.addSocketHandler(SCGIHandler)
if self.setting('EnableHTTP'):
from HTTPServer import HTTPAppServerHandler
self.addSocketHandler(HTTPAppServerHandler)
self.readyForRequests()
if maxRequestTime:
self._checkRequestTime = time() + maxRequestTime
except:
AppServer.initiateShutdown(self)
raise
def addSocketHandler(self, handlerClass, serverAddress=None):
"""Add socket handler.
Adds a socket handler for `serverAddress` -- `serverAddress`
is a tuple ``(host, port)``, where ``host`` is the interface
to connect to (for instance, the IP address on a machine with
multiple IP numbers), and ``port`` is the port (e.g. HTTP is on
80 by default, and Webware adapters use 8086 by default).
The `handlerClass` is a subclass of `Handler`, and is used to
handle the actual request -- usually returning control back
to ThreadedAppServer in some fashion. See `Handler` for more.
"""
if serverAddress is None:
serverAddress = self.address(handlerClass.settingPrefix)
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
try:
sock.bind(serverAddress)
sock.listen(1024)
if fcntl:
setCloseOnExecFlag(sock.fileno())
except Exception:
print "Error: Can not listen for %s on %s" % (
handlerClass.settingPrefix, str(serverAddress))
sys.stdout.flush()
raise
serverAddress = sock.getsockname() # resolve/normalize
self._socketHandlers[serverAddress] = handlerClass
self._handlerCache[serverAddress] = []
self._sockets[serverAddress] = sock
adrStr = ':'.join(map(str, serverAddress))
print "Listening for %s on %s" % (handlerClass.settingPrefix, adrStr)
# write text file with server address
adrFile = self.addressFileName(handlerClass)
if os.path.exists(adrFile):
print "Warning: %s already exists" % adrFile
try:
os.unlink(adrFile)
except (AttributeError, OSError): # we cannot remove the file
if open(adrFile).read() == adrStr:
return # same content, so never mind
else:
print "Error: Could not remove", adrFile
sys.stdout.flush()
raise
try:
f = open(adrFile, 'w')
f.write(adrStr)
f.close()
except IOError:
print "Error: Could not write", adrFile
sys.stdout.flush()
raise
def isPersistent(self):
return True
def defaultConfig(self):
"""The default AppServer.config."""
if self._defaultConfig is None:
self._defaultConfig = AppServer.defaultConfig(self).copy()
# Update with ThreadedAppServer specific settings
# as defined in defaultConfig on the module level:
self._defaultConfig.update(defaultConfig)
return self._defaultConfig
_ignoreErrnos = [] # silently ignore these errors:
for e in 'EAGAIN', 'EWOULDBLOCK', 'EINTR', 'ECONNABORTED', 'EPROTO':
try:
_ignoreErrnos.append(getattr(errno, e))
except AttributeError:
pass
def mainloop(self, timeout=1):
"""Main thread loop.
This is the main thread loop that accepts and dispatches
socket requests.
It goes through a loop as long as ``self._running > 2``.
Setting ``self._running = 2`` asks the the main loop to end.
When the main loop is finished, it sets ``self._running = 1``.
When the AppServer is completely down, it sets ``self._running = 0``.
The loop waits for connections, then based on the connecting
port it initiates the proper Handler (e.g.,
AdapterHandler, HTTPHandler). Handlers are reused when possible.
The initiated handlers are put into a queue, and
worker threads poll that queue to look for requests that
need to be handled (worker threads use `threadloop`).
Every so often (every 5 loops) it updates thread usage
information (`updateThreadUsage`), and every
``MaxServerThreads * 2`` loops it it will manage
threads (killing or spawning new ones, in `manageThreadCount`).
"""
threadCheckInterval = self._maxServerThreads * 2
threadUpdateDivisor = 5 # grab stat interval
threadCheck = 0
self._running = 3 # server is in the main loop now
try:
while self._running > 2:
# block for timeout seconds waiting for connections
try:
input, output, exc = select.select(
self._sockets.values(), [], [], timeout)
except select.error, e:
if e[0] not in self._ignoreErrnos:
raise
if debug:
print "Socket select error:", e
continue
for sock in input:
try:
client, addr = sock.accept()
except select.error, e:
if e[0] not in self._ignoreErrnos:
raise
if debug:
print "Socket accept error:", e
continue
serverAddress = sock.getsockname()
try:
handler = self._handlerCache[serverAddress].pop()
except IndexError:
handler = self._socketHandlers[serverAddress](self,
serverAddress)
self._requestID += 1
handler.activate(client, self._requestID)
self._requestQueue.put(handler)
if threadCheck % threadUpdateDivisor == 0:
self.updateThreadUsage()
if threadCheck > threadCheckInterval:
threadCheck = 0
self.manageThreadCount()
else:
threadCheck += 1
self.abortLongRequests()
self.restartIfNecessary()
finally:
self._running = 1
## Thread Management ##
# These methods handle the thread pool. The AppServer pre-allocates
# threads, and reuses threads for requests. So as more threads
# are needed with varying load, new threads are spawned, and if there
# are excess threads, then threads are removed.
def updateThreadUsage(self):
"""Update the threadUseCounter list.
Called periodically from `mainloop`.
"""
count = self.activeThreadCount()
if len(self._threadUseCounter) > self._maxServerThreads:
self._threadUseCounter.pop(0)
self._threadUseCounter.append(count)
def activeThreadCount(self):
"""Get a snapshot of the number of threads currently in use.
Called from `updateThreadUsage`.
"""
count = 0
for t in self._threadPool:
if t._processing:
count += 1
return count
def manageThreadCount(self):
"""Adjust the number of threads in use.
From information gleened from `updateThreadUsage`, we see about how
many threads are being used, to see if we have too many threads or
too few. Based on this we create or absorb threads.
"""
# @@: This algorithm needs work. The edges (i.e. at the
# minserverthreads) are tricky. When working with this,
# remember thread creation is *cheap*.
average = max = 0
if debug:
print "ThreadUse Samples:", self._threadUseCounter
for i in self._threadUseCounter:
average += i
if i > max:
max = i
average /= len(self._threadUseCounter)
if debug:
print "Average Thread Use: ", average
print "Max Thread Use: ", max
print "ThreadCount: ", self._threadCount
if len(self._threadUseCounter) < self._maxServerThreads:
return # not enough samples
margin = self._threadCount / 2 # smoothing factor
if debug:
print "Margin:", margin
if (average > self._threadCount - margin
and self._threadCount < self._maxServerThreads):
# Running low: double thread count
n = min(self._threadCount,
self._maxServerThreads - self._threadCount)
if debug:
print "Adding %s threads" % n
for i in range(n):
self.spawnThread()
elif (average < self._threadCount - margin
and self._threadCount > self._minServerThreads):
n = min(self._threadCount - self._minServerThreads,
self._threadCount - max)
self.absorbThread(n)
else:
# cleanup any stale threads that we killed but haven't joined
self.absorbThread(0)
def spawnThread(self):
"""Create a new worker thread.
Worker threads poll with the `threadloop` method.
"""
if debug:
print "Spawning new thread"
t = WorkerThread(target=self.threadloop)
t._processing = False
if self._useDaemonThreads:
t.setDaemon(True)
t.start()
self._threadPool.append(t)
self._threadCount += 1
if debug:
print "New thread spawned, threadCount =", self._threadCount
def absorbThread(self, count=1):
"""Absorb a thread.
We do this by putting a None on the Queue.
When a thread gets it, that tells it to exit.
We also keep track of the threads, so after killing
threads we go through all the threads and find the
thread(s) that have exited, so that we can take them
out of the thread pool.
"""
for i in range(count):
self._requestQueue.put(None)
# _threadCount is an estimate, just because we
# put None in the queue, the threads don't immediately
# disappear, but they will eventually.
self._threadCount -= 1
for t in self._threadPool:
# There may still be a None in the queue, and some
# of the threads we want gone may not yet be gone.
# But we'll pick them up later -- they'll wait.
if not t.isAlive():
t.join() # don't need a timeout, it isn't alive
self._threadPool.remove(t)
if debug:
print "Thread absorbed, real threadCount =", len(self._threadPool)
_canAbortRequest = WorkerThread._canAbort
def abortRequest(self, requestID, exception=RequestAbortedError):
"""Abort a request by raising an exception in its worker thread.
A return value of one means the thread was successfully aborted,
a value of zero means the thread could not be found,
any other value indicates that an error has occurred.
"""
verbose = self._verbose
if verbose:
print "Aborting request", requestID
if not self._canAbortRequest:
if verbose:
print "Error: Cannot abort requests"
return -1
for t, h in self._threadHandler.items():
try:
handlerRequestID = h._requestID
except AttributeError:
handlerRequestID = None
if requestID == handlerRequestID:
t._abortHandler = h
try:
if self._threadHandler[t] is not h:
# request already finished in the meantime
raise KeyError
ret = t.abort(exception)
except Exception:
ret = 0
t._abortHandler = None
break
else:
ret = 0
if verbose:
if ret == 0:
print "Error: Could not find thread for this request"
elif ret == 1:
print "The worker thread for this request has been aborted"
else:
print "Error: Could not abort thread for this request"
return ret
def abortLongRequests(self):
"""Check for long-running requests and cancel these.
The longest allowed execution time for requests is controlled
by the MaxRequestTime setting.
"""
if self._checkRequestTime is None:
return
currentTime = time()
if currentTime > self._checkRequestTime:
if debug:
print "Checking for long-running requests"
verbose = self._verbose
minRequestTime = currentTime - self._maxRequestTime
for t, h in self._threadHandler.items():
try:
requestDict = h._requestDict
requestID = requestDict['requestID']
requestTime = requestDict['time']
except (AttributeError, KeyError):
continue
if requestTime < minRequestTime:
t._abortHandler = h
try:
if self._threadHandler[t] is not h:
# request already finished in the meantime
raise KeyError
if verbose:
print "Aborting long-running request", requestID
t.abort(RequestTooLongError)
except Exception:
pass
t._abortHandler = None
elif requestTime < currentTime:
currentTime = requestTime
self._checkRequestTime = currentTime + self._maxRequestTime
## Worker Threads ##
def threadloop(self):
"""The main loop for worker threads.
Worker threads poll the `_requestQueue` to find a request handler
waiting to run. If they find a None in the queue, this thread has
been selected to die, which is the way the loop ends.
The handler object does all the work when its `handleRequest` method
is called.
`initThread` and `delThread` methods are called at the beginning and
end of the thread loop, but they aren't being used for anything
(future use as a hook).
"""
self.initThread()
t = currentThread()
t._processing = False
t._abortHandler = None
try:
while 1:
try:
handler = self._requestQueue.get()
except Queue.Empty:
continue
if handler is None:
# None means time to quit
break
try:
t._processing = True
self._threadHandler[t] = handler
try:
handler.handleRequest()
except ThreadAbortedError:
print "Worker thread has been aborted"
except Exception:
print "Exception in worker thread"
traceback.print_exc(file=sys.stderr)
del self._threadHandler[t]
t._processing = False
finally:
handler.close()
while t._abortHandler is handler:
# this handler is to be aborted,
# so don't handle another request now
sleep(0.1)
finally:
try:
del self._threadHandler[t]
t._processing = False
except KeyError:
pass
self.delThread()
if debug:
print "Quitting", t
def initThread(self):
"""Initialize thread.
Invoked immediately by threadloop() as a hook for subclasses.
This implementation does nothing and subclasses need not invoke super.
"""
pass
def delThread(self):
"""Delete thread.
Invoked immediately by threadloop() as a hook for subclasses.
This implementation does nothing and subclasses need not invoke super.
"""
pass
## Shutting Down ##
def shutDown(self):
"""Called on shutdown.
Also calls `AppServer.shutDown`, but first closes all sockets
and tells all the threads to die.
"""
print "ThreadedAppServer is shutting down..."
if self._running > 2:
self._running = 2 # ask main loop to finish
self.awakeSelect() # unblock select call in mainloop()
sys.stdout.flush()
for i in range(30): # wait at most 3 seconds for shutdown
if self._running < 2:
break
sleep(0.1)
if self._sockets:
# Close all sockets now:
for sock in self._sockets.values():
sock.close()
if self._socketHandlers:
# Remove the text files with the server addresses:
for handler in self._socketHandlers.values():
adrFile = self.addressFileName(handler)
if os.path.exists(adrFile):
try:
os.unlink(adrFile)
except (AttributeError, OSError):
print "Warning: Could not remove", adrFile
# Tell all threads to end:
for i in range(self._threadCount):
self._requestQueue.put(None)
# Join all threads:
closeTime = time() + 3
for t in self._threadPool:
timeout = max(0.1, closeTime - time())
try:
t.join(timeout)
except Exception:
pass
# Check whether all threads have ended:
for t in self._threadPool:
if t.isAlive():
if debug:
print "Hanging worker thread", t.threadID()
running = True
break
else:
running = False
if running and self._canAbortRequest:
# Abort all remaining threads:
print "Aborting hanging worker threads..."
for t in self._threadPool:
if t.isAlive():
t.abort(ServerShutDownError)
# Join remaining threads:
closeTime = time() + 3
for t in self._threadPool:
if t.isAlive():
timeout = max(0.1, closeTime - time())
try:
t.join(timeout)
except Exception:
pass
# Check whether remaining threads have ended:
for t in self._threadPool:
if t.isAlive():
if debug:
print "Warning: Could not abort thread", t.threadID()
else:
print "Warning: Could not abort all worker threads"
break
else:
print "Hanging worker threads have been aborted."
running = False
# Call super's shutdown:
AppServer.shutDown(self)
def awakeSelect(self):
"""Awake the select() call.
The `select()` in `mainloop()` is blocking, so when
we shut down we have to make a connect to unblock it.
Here's where we do that.
"""
for host, port in self._sockets:
if host == '0.0.0.0':
# Can't connect to 0.0.0.0; use 127.0.0.1 instead
host = '127.0.0.1'
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
try:
sock.connect((host, port))
sock.close()
except Exception:
pass
## Misc ##
def address(self, settingPrefix):
"""Get host address.
The address for the Adapter (Host/interface, and port),
as taken from ``Configs/AppServer.config``,
settings ``Host`` and ``AdapterPort``.
"""
try:
return self._addr[settingPrefix]
except KeyError:
host = self.setting(settingPrefix + 'Host', self.setting('Host'))
port = self.setting(settingPrefix + 'Port')
self._addr[settingPrefix] = (host, port)
return self._addr[settingPrefix]
def addressFileName(self, handlerClass):
"""Get the name of the text file with the server address."""
return self.serverSidePath(
self.setting('AddressFiles') % handlerClass.protocolName)
class Handler(object):
"""A very general socket handler.
Handler is an abstract superclass -- specific protocol implementations
will subclass this. A Handler takes a socket to interact with, and
creates a raw request.
Handlers will be reused. When a socket is received `activate` will be
called -- but the handler should not do anything, as it is still running
in the main thread. The handler is put into a queue, and a worker thread
picks it up and runs `handleRequest`, which subclasses should override.
Several methods are provided which are typically used by subclasses.
"""
def __init__(self, server, serverAddress):
"""Create a new socket handler.
Each handler is attached to a specific host and port,
and of course to the AppServer.
"""
self._server = server
self._serverAddress = serverAddress
self._verbose = server._verbose
self._silentURIs = server._silentURIs
def activate(self, sock, requestID):
"""Activate the handler for processing the request.
`sock` is the incoming socket that this handler will work with,
and `requestID` is a serial number unique for each request.
This isn't where work gets done -- the handler is queued after this,
and work is done when `handleRequest` is called.
"""
self._requestID = requestID
self._sock = sock
def close(self):
"""Close the socket.
Called when the handler is finished. Closes the socket and
returns the handler to the pool of inactive handlers.
"""
self._sock = None
self._server._handlerCache[self._serverAddress].append(self)
def receiveDict(self):
"""Receive a dictionary from the socket.
Utility function to receive a marshalled dictionary from the socket.
Returns None if the request was empty.
"""
chunk = ''
missing = intLength
while missing > 0:
block = self._sock.recv(missing)
if not block:
self._sock.close()
if not chunk:
# We probably awakened due to awakeSelect being called.
return None
# We got a partial request -- something went wrong.
raise NotEnoughDataError('received only %d of %d bytes'
' when receiving dictLength' % (len(chunk), intLength))
chunk += block
missing -= len(block)
try:
dictLength = loads(chunk)
except (ValueError, EOFError), msg:
if chunk[:3] == 'GET':
# Common error: client is speaking HTTP.
while msg and len(chunk) < 8192:
block = self._sock.recv(1)
if not block:
break
chunk += block
if (chunk.endswith('\r\r') or chunk.endswith('\n\n')
or chunk.endswith('\r\n\r\n')):
msg = None
if msg:
print "ERROR:", msg
else:
print "ERROR: HTTP GET from WebKit adapter port."
self._sock.sendall('''\
HTTP/1.0 505 HTTP Version Not Supported\r
Content-Type: text/plain\r
\r
Error: Invalid AppServer protocol.\r
Sorry, I don't speak HTTP. You must connect via an adapter.\r
See the Troubleshooting section of the WebKit Install Guide.\r''')
self._sock.close()
print (" You can only connect to %s via an adapter"
" like mod_webkit or wkcgi." % self._serverAddress[1])
return None
if not isinstance(dictLength, int):
self._sock.close()
raise ProtocolError("Invalid AppServer protocol")
chunk = ''
missing = dictLength
while missing > 0:
block = self._sock.recv(missing)
if not block:
self._sock.close()
raise NotEnoughDataError('received only %d of %d bytes'
' when receiving dict' % (len(chunk), dictLength))
chunk += block
missing -= len(block)
return loads(chunk)
def handleRequest(self):
"""Handle a raw request.
This is where the work gets done. Subclasses should override.
"""
pass
def startRequest(self, requestDict=None):
"""Track start of a raw request.
Subclasses can use and override this method.
"""
requestDict = requestDict or {}
requestID = self._requestID
requestTime = requestDict.get('time') or time()
requestDict['requestID'] = requestID
requestDict['time'] = requestTime
# The request object is stored for tracking/debugging purposes.
self._requestDict = requestDict
if self._verbose:
env = requestDict.get('environ')
uri = env and requestURI(env) or '-'
if not self._silentURIs or not self._silentURIs.search(uri):
requestDict['verbose'] = True
requestTime = localtime(requestTime)[:6]
print '%5d %4d-%02d-%02d %02d:%02d:%02d %s' % (
(requestID,) + requestTime + (uri,))
def endRequest(self, error=None):