3 ### Administration connection with tripe server
5 ### (c) 2006 Straylight/Edgeware
8 ###----- Licensing notice ---------------------------------------------------
10 ### This file is part of Trivial IP Encryption (TrIPE).
12 ### TrIPE is free software; you can redistribute it and/or modify
13 ### it under the terms of the GNU General Public License as published by
14 ### the Free Software Foundation; either version 2 of the License, or
15 ### (at your option) any later version.
17 ### TrIPE is distributed in the hope that it will be useful,
18 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ### GNU General Public License for more details.
22 ### You should have received a copy of the GNU General Public License
23 ### along with TrIPE; if not, write to the Free Software Foundation,
24 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 This module provides classes and functions for connecting to a running tripe
28 server, sending it commands, receiving and processing replies, and
29 implementing services.
31 Rather than end up in lost in a storm of little event-driven classes, or a
32 morass of concurrent threads, the module uses coroutines to present a fairly
33 simple function call/return interface to potentially long-running commands
34 which must run without blocking the main process. It assumes a coroutine
35 module presenting a subset of the `greenlet' interface: if actual greenlets
36 are available, they are used; otherwise there's an implementation in terms of
37 threads (with lots of locking) which will do instead.
39 The simple rule governing the coroutines used here is this:
41 * The root coroutine never cares what values are passed to it when it
42 resumes: it just discards them.
44 * Other, non-root, coroutines are presumed to be waiting for some specific
47 Configuration variables:
55 Other useful variables:
80 TripeSynchronousCommand
81 TripeAsynchronousCommand
84 TripeCommandDispatcher
97 __pychecker__ = 'self=me no-constCond no-argsused'
101 ###--------------------------------------------------------------------------
102 ### External dependencies.
112 if OS.getenv('TRIPE_FORCE_RMCR') is not None:
114 from py.magic import greenlet as _Coroutine
116 from rmcr import Coroutine as _Coroutine
118 ###--------------------------------------------------------------------------
119 ### Coroutine hacking.
121 rootcr = _Coroutine.getcurrent()
123 class Coroutine (_Coroutine):
125 A coroutine class which can only be invoked by the root coroutine.
127 The root, by construction, cannot be an instance of this class.
129 def switch(me, *args, **kw):
130 assert _Coroutine.getcurrent() is rootcr
131 if _debug: print '* %s' % me
132 _Coroutine.switch(me, *args, **kw)
133 if _debug: print '* %s' % rootcr
135 ###--------------------------------------------------------------------------
136 ### Default places for things.
138 configdir = OS.environ.get('TRIPEDIR', "@configdir@")
139 socketdir = "@socketdir@"
140 PACKAGE = "@PACKAGE@"
141 VERSION = "@VERSION@"
143 tripesock = OS.environ.get('TRIPESOCK', OS.path.join(socketdir, 'tripesock'))
144 peerdb = OS.environ.get('TRIPEPEERDB', 'peers.cdb')
146 ###--------------------------------------------------------------------------
147 ### Connection to the server.
149 def readnonblockingly(sock, len):
151 Nonblocking read from SOCK.
153 Try to return LEN bytes. If couldn't read anything, return None. EOF is
154 returned as an empty string.
158 return sock.recv(len)
160 if exc[0] == E.EWOULDBLOCK:
164 class TripeConnectionError (StandardError):
165 """Something happened to the connection with the server."""
167 class TripeInternalError (StandardError):
168 """This program is very confused."""
171 class TripeConnection (object):
173 A logical connection to the tripe administration socket.
175 There may or may not be a physical connection. (This is needed for the
176 monitor, for example.)
178 This class isn't very useful on its own, but it has useful subclasses. At
179 this level, the class is agnostic about I/O multiplexing schemes; that gets
183 def __init__(me, socket):
185 Make a connection to the named SOCKET.
187 No physical connection is made initially.
192 me.iowatch = SelIOWatcher(me)
196 Ensure that there's a physical connection.
198 Do nothing if we're already connected. Invoke the `connected' method if
202 sock = S.socket(S.AF_UNIX, S.SOCK_STREAM)
203 sock.connect(me.socket)
205 me.lbuf = M.LineBuffer(me.line, me._eof)
210 def disconnect(me, reason):
212 Disconnect the physical connection.
214 Invoke the `disconnected' method, giving the provided REASON, which
215 should be either None or an exception.
217 if not me.sock: return
218 me.disconnected(reason)
227 Return true if there's a current, believed-good physical connection.
229 return me.sock is not None
231 __nonzero__ = connectedp
235 Send the LINE to the connection's socket.
237 All output is done through this method; it can be overridden to provide
238 proper nonblocking writing, though this seems generally unnecessary.
241 me.sock.setblocking(1)
242 me.sock.send(line + '\n')
243 except Exception, exc:
250 Receive whatever's ready from the connection's socket.
252 Call `line' on each complete line, and `eof' if the connection closed.
253 Subclasses which attach this class to an I/O-event system should call
254 this method when the socket (CONN.sock) is ready for reading.
256 while me.sock is not None:
258 buf = readnonblockingly(me.sock, 16384)
259 except Exception, exc:
271 """Internal end-of-file handler."""
272 me.disconnect(TripeConnectionError('connection lost'))
277 To be overridden by subclasses to react to a connection being
280 me.iowatch.connected(me.sock)
282 def disconnected(me, reason):
284 To be overridden by subclasses to react to a connection being severed.
286 me.iowatch.disconnected()
289 """To be overridden by subclasses to handle end-of-file."""
293 """To be overridden by subclasses to handle incoming lines."""
296 ###--------------------------------------------------------------------------
297 ### I/O loop integration.
299 class SelIOWatcher (object):
301 Integration with mLib's I/O event system.
303 You can replace this object with a different one for integration with,
304 e.g., glib's main loop, by setting CONN.iowatcher to a different object
305 while the CONN is disconnected.
308 def __init__(me, conn):
312 def connected(me, sock):
314 Called when a connection is made.
316 SOCK is the socket. The watcher must arrange to call CONN.receive when
319 me._selfile = M.SelFile(sock.fileno(), M.SEL_READ, me._conn.receive)
322 def disconnected(me):
324 Called when the connection is lost.
330 Wait for something interesting to happen, and issue events.
332 That is, basically, do one iteration of a main select loop, processing
333 all of the events, and then return. This isn't needed for
334 TripeCommandDispatcher, but runservices wants it.
338 ###--------------------------------------------------------------------------
339 ### Inter-coroutine communication.
341 class Queue (object):
343 A queue of things arriving asynchronously.
345 This is a very simple single-reader multiple-writer queue. It's useful for
346 more complex coroutines which need to cope with a variety of possible
351 """Create a new empty queue."""
352 me.contents = M.Array()
357 Internal: wait for an item to arrive in the queue.
359 Complain if someone is already waiting, because this is just a
363 raise ValueError('queue already being waited on')
365 me.waiter = Coroutine.getcurrent()
366 while not me.contents:
367 me.waiter.parent.switch()
373 Remove and return the item at the head of the queue.
375 If the queue is empty, wait until an item arrives.
378 return me.contents.shift()
382 Return the item at the head of the queue without removing it.
384 If the queue is empty, wait until an item arrives.
387 return me.contents[0]
391 Write THING to the queue.
393 If someone is waiting on the queue, wake him up immediately; otherwise
394 just leave the item there for later.
396 me.contents.push(thing)
400 ###--------------------------------------------------------------------------
401 ### Dispatching coroutine.
403 ## Match a string if it can stand on its own as a bareword: i.e., it doesn't
404 ## contain backslashes, quotes or whitespace.
405 rx_ordinary = RX.compile(r'^[^\\\'\"\s]+$')
407 ## Match characters which need to be escaped, even in quoted text.
408 rx_weird = RX.compile(r'([\\\'])')
411 """Quote S according to the tripe-admin(5) rules."""
412 m = rx_ordinary.match(s)
413 if m and m.end() == len(s):
416 return "'" + rx_weird.sub(r'\\\1', s) + "'"
420 Return a wrapper for FUNC which reports exceptions thrown by it.
422 Useful in the case of callbacks invoked by C functions which ignore
427 return func(*a, **kw)
429 SYS.excepthook(*SYS.exc_info())
433 class TripeCommand (object):
435 This abstract class represents a command in progress.
437 The `words' attribute contains the list of tokens which make up the
440 Subclasses must implement a method to handle server responses:
442 * response(CODE, *ARGS): CODE is one of the strings 'OK', 'INFO' or
443 'FAIL'; ARGS are the remaining tokens from the server's response.
446 def __init__(me, words):
447 """Make a new command consisting of the given list of WORDS."""
450 class TripeSynchronousCommand (TripeCommand):
452 A simple command, processed apparently synchronously.
454 Must be invoked from a coroutine other than the root (or whichever one is
455 running the dispatcher); in reality, other coroutines carry on running
456 while we wait for a response from the server.
458 Each server response causes the calling coroutine to be resumed with the
459 pair (CODE, REST) -- where CODE is the server's response code (`OK', `INFO'
460 or `FAIL') and REST is a list of the server's other response tokens. The
461 calling coroutine must continue switching back to the dispatcher until a
462 terminating response (`OK' or `FAIL') is received or become very
465 Mostly it's better to use the TripeCommandIterator to do this
469 def __init__(me, words):
470 """Initialize the command, specifying the WORDS to send to the server."""
471 TripeCommand.__init__(me, words)
472 me.owner = Coroutine.getcurrent()
474 def response(me, code, *rest):
475 """Handle a server response by forwarding it to the calling coroutine."""
476 me.owner.switch((code, rest))
478 class TripeError (StandardError):
480 A tripe command failed with an error (a FAIL code). The args attribute
481 contains a list of the server's message tokens.
485 class TripeCommandIterator (object):
487 Iterator interface to a tripe command.
489 The values returned by the iterator are lists of tokens from the server's
490 INFO lines, as processed by the given filter function, if any. The
491 iterator completes normally (by raising StopIteration) if the server
492 reported OK, and raises an exception if the command failed for some reason.
494 A TripeError is raised if the server issues a FAIL code. If the connection
495 failed, some other exception is raised.
498 def __init__(me, dispatcher, words, bg = False, filter = None):
500 Create a new command iterator.
502 The command is submitted to the DISPATCHER; it consists of the given
503 WORDS. If BG is true, then an option is inserted to request that the
504 server run the command in the background. The FILTER is applied to the
505 token lists which the server responds, and the filter's output are the
506 items returned by the iterator.
508 me.dcr = Coroutine.getcurrent().parent
510 raise ValueError, 'must invoke from coroutine'
511 me.filter = filter or (lambda x: x)
513 words = [words[0], '-background', dispatcher.bgtag()] + list(words[1:])
514 dispatcher.rawcommand(TripeSynchronousCommand(words))
517 """Iterator protocol: I am my own iterator."""
522 Iterator protocol: return the next piece of information from the server.
524 INFO responses are filtered and returned as the values of the iteration.
525 FAIL and CONNERR responses are turned into exceptions and raised.
526 Finally, OK is turned into StopIteration, which should cause a normal end
527 to the iteration process.
529 thing = me.dcr.switch()
532 return me.filter(rest)
535 elif code == 'CONNERR':
537 raise TripeConnectionError, 'connection terminated by user'
541 raise TripeError(*rest)
543 raise TripeInternalError \
544 ('unexpected tripe response %r' % ([code] + rest))
546 ### Simple utility functions for the TripeCommandIterator convenience
549 def _tokenjoin(words):
550 """Filter function: simply join the given tokens with spaces between."""
551 return ' '.join(words)
554 """Return a dictionary formed from the KEY=VALUE pairs returned by the
560 kv[w[:q]] = w[q + 1:]
564 """Raise an error if ITER contains any item."""
567 raise TripeInternalError('expected no response')
571 """If ITER contains a single item, return it; otherwise raise an error."""
574 raise TripeInternalError('expected only one line of response')
577 def _tracelike(iter):
578 """Handle a TRACE-like command. The result is a list of tuples (CHAR,
579 STATUS, DESC): CHAR is a selector character, STATUS is the status (empty if
580 disabled, `+' if enabled, maybe something else later), and DESC is the
581 human-readable description."""
586 desc = ' '.join(ww[1:])
587 stuff.append((ch, st, desc))
590 def _kwopts(kw, allowed):
591 """Parse keyword arguments into options. ALLOWED is a list of allowable
592 keywords; raise errors if other keywords are present. KEY = VALUE becomes
593 an option pair -KEY VALUE if VALUE is a string, just the option -KEY if
594 VALUE is a true non-string, or nothing if VALUE is false.. Insert a `--'
595 at the end to stop the parser getting confused."""
598 for a in allowed: amap[a] = True
599 for k, v in kw.iteritems():
601 raise ValueError('option %s not allowed here' % k)
602 if isinstance(v, str):
611 def defer(func, *args, **kw):
612 """Call FUNC(*ARGS, **KW) later, in the root coroutine."""
613 _deferq.append((func, args, kw))
615 def funargstr(func, args, kw):
616 items = [repr(a) for a in args]
617 for k, v in kw.iteritems():
618 items.append('%s = %r' % (k, v))
619 return '%s(%s)' % (func.__name__, ', '.join(items))
621 def spawn(func, *args, **kw):
622 """Call FUNC, passing ARGS and KW, in a fresh coroutine."""
623 defer(lambda: (Coroutine(func, name = funargstr(func, args, kw))
624 .switch(*args, **kw)))
630 Read (FUNC, ARGS, KW) triples from queue and invoke FUNC(*ARGS, **KW).
633 func, args, kw = _asideq.get()
637 SYS.excepthook(*SYS.exc_info())
639 def aside(func, *args, **kw):
640 """Call FUNC(*ARGS, **KW) later, in a non-root coroutine."""
641 defer(_asideq.put, (func, args, kw))
643 class TripeCommandDispatcher (TripeConnection):
647 The command dispatcher is a connection which knows how to handle commands.
648 This is probably the most important class in this module to understand.
650 Lines from the server are parsed into tokens. The first token is a code
651 (OK or NOTE or something) explaining what kind of line this is. The
652 `handler' attribute is a dictionary mapping server line codes to handler
653 functions, which are applied to the words of the line as individual
654 arguments. *Exception*: the content of TRACE lines is not tokenized.
656 There are default handlers for server codes which respond to commands.
657 Commands arrive as TripeCommand instances through the `rawcommand'
658 interface. The dispatcher keeps track of which command objects represent
659 which jobs, and sends responses on to the appropriate command objects by
660 invoking their `response' methods. Command objects don't see the
661 BG... codes, because the dispatcher has already transformed them into
662 regular codes when it was looking up job code.
664 The dispatcher also has a special response code of its own: CONNERR
665 indicates that the connection failed and the command has therefore been
669 ## --- Infrastructure ---
671 ## We will get confused if we pipeline commands. Send them one at a time.
672 ## Only send a command when the previous one detaches or completes.
674 ## The following attributes are interesting:
676 ## tagseq Sequence number for next background job (for bgtag)
678 ## queue Commands awaiting submission.
680 ## cmd Mapping from job tags to commands: cmd[None] is the
681 ## foreground command.
683 ## handler Mapping from server codes to handler functions.
685 def __init__(me, socket):
687 Initialize the dispatcher.
689 The SOCKET is the filename of the administration socket to connect to,
690 for TripeConnection.__init__.
692 TripeConnection.__init__(me, socket)
695 me.handler['BGDETACH'] = me._detach
696 for i in 'BGOK', 'BGINFO', 'BGFAIL':
697 me.handler[i] = me._response
698 for i in 'OK', 'INFO', 'FAIL':
699 me.handler[i] = me._fgresponse
702 """Should we quit the main loop? Subclasses should override."""
705 def mainloop(me, quitp = None):
707 Iterate the I/O watcher until QUITP returns true.
709 Arranges for asides and deferred calls to be made at the right times.
713 assert _Coroutine.getcurrent() is rootcr
714 Coroutine(_runasides, name = '_runasides').switch()
721 for func, args, kw in q:
729 If a subclass overrides this method, it must call us; clears out the
730 command queue and job map.
734 TripeConnection.connected(me)
736 def disconnected(me, reason):
740 If a subclass hooks overrides this method, it must call us; sends a
741 special CONNERR code to all incomplete commands.
743 TripeConnection.disconnected(me, reason)
744 for cmd in me.cmd.itervalues():
745 cmd.response('CONNERR', reason)
747 cmd.response('CONNERR', reason)
751 """Handle an incoming line, sending it to the right place."""
752 if _debug: print '<', line
753 code, rest = M.word(line, quotep = True)
754 func = me.handler.get(code)
759 func(code, *M.split(rest, quotep = True)[0])
764 Pull the oldest command off the queue and try to send it to the server.
766 if not me.queue or None in me.cmd: return
767 cmd = me.queue.shift()
768 if _debug: print '>', ' '.join([quotify(w) for w in cmd.words])
769 me.send(' '.join([quotify(w) for w in cmd.words]))
774 Return an unused job tag.
776 May be of use when composing commands by hand.
778 tag = 'J%05d' % me.tagseq
782 ## --- Built-in handler functions for server responses ---
784 def _detach(me, _, tag):
786 Respond to a BGDETACH TAG message.
788 Move the current foreground command to the background.
790 assert tag not in me.cmd
791 me.cmd[tag] = me.cmd[None]
794 def _response(me, code, tag, *w):
796 Respond to an OK, INFO or FAIL message.
798 If this is a message for a background job, find the tag; then dispatch
799 the result to the command object.
801 if code.startswith('BG'):
806 cmd.response(code, *w)
808 def _fgresponse(me, code, *w):
809 """Process responses to the foreground command."""
810 me._response(code, None, *w)
812 ## --- Interface methods ---
814 def rawcommand(me, cmd):
816 Submit the TripeCommand CMD to the server, and look after it until it
819 if not me.connectedp():
820 raise TripeConnectionError('connection closed')
824 def command(me, *cmd, **kw):
825 """Convenience wrapper for creating a TripeCommandIterator object."""
826 return TripeCommandIterator(me, cmd, **kw)
828 ## --- Convenience methods for server commands ---
830 def add(me, peer, *addr, **kw):
831 return _simple(me.command(bg = True,
833 _kwopts(kw, ['tunnel', 'keepalive', 'cork']) +
837 return _oneline(me.command('ADDR', peer))
839 return _keyvals(me.command('ALGS'))
840 def checkchal(me, chal):
841 return _simple(me.command('CHECKCHAL', chal))
843 return _simple(me.command('DAEMON'))
844 def eping(me, peer, **kw):
845 return _oneline(me.command(bg = True,
847 _kwopts(kw, ['timeout']) +
849 def forcekx(me, peer):
850 return _simple(me.command('FORCEKX', peer))
852 return _oneline(me.command('GETCHAL', filter = _tokenjoin))
853 def greet(me, peer, chal):
854 return _simple(me.command('GREET', peer, chal))
856 return list(me.command('HELP', filter = _tokenjoin))
857 def ifname(me, peer):
858 return _oneline(me.command('IFNAME', peer, filter = _tokenjoin))
860 return _simple(me.command('KILL', peer))
862 return list(me.command('LIST', filter = _tokenjoin))
863 def notify(me, *msg):
864 return _simple(me.command('NOTIFY', *msg))
865 def peerinfo(me, peer):
866 return _keyvals(me.command('PEERINFO', peer))
867 def ping(me, peer, **kw):
868 return _oneline(me.command(bg = True,
870 _kwopts(kw, ['timeout']) +
873 return _oneline(me.command('PORT', filter = _tokenjoin))
875 return _simple(me.command('QUIT'))
877 return _simple(me.command('RELOAD'))
879 return _keyvals(me.command('SERVINFO'))
880 def setifname(me, new):
881 return _simple(me.command('SETIFNAME', new))
882 def svcclaim(me, service, version):
883 return _simple(me.command('SVCCLAIM', service, version))
884 def svcensure(me, service, version = None):
885 return _simple(me.command('SVCENSURE', service,
886 *((version is not None and [version]) or [])))
887 def svcfail(me, job, *msg):
888 return _simple(me.command('SVCFAIL', job, *msg))
889 def svcinfo(me, job, *msg):
890 return _simple(me.command('SVCINFO', job, *msg))
892 return list(me.command('SVCLIST'))
894 return _simple(me.command('SVCOK', job))
895 def svcquery(me, service):
896 return _keyvals(me.command('SVCQUERY', service))
897 def svcrelease(me, service):
898 return _simple(me.command('SVCRELEASE', service))
899 def svcsubmit(me, service, *args, **kw):
900 return me.command(bg = True,
902 _kwopts(kw, ['version']) +
906 return _keyvals(me.command('STATS', peer))
907 def trace(me, *args):
908 return _tracelike(me.command('TRACE', *args))
910 return list(me.command('TUNNELS', filter = _tokenjoin))
912 return _oneline(me.command('VERSION', filter = _tokenjoin))
914 return _simple(me.command('WARN', *msg))
915 def watch(me, *args):
916 return _tracelike(me.command('WATCH', *args))
918 ###--------------------------------------------------------------------------
919 ### Asynchronous commands.
921 class TripeAsynchronousCommand (TripeCommand):
923 Asynchronous commands.
925 This is the complicated way of issuing commands. You must set up a queue,
926 and associate the command with the queue. Responses arriving for the
927 command will be put on the queue as an triple of the form (TAG, CODE, REST)
928 -- where TAG is an object of your choice, not interpreted by this class,
929 CODE is the server's response code (OK, INFO, FAIL), and REST is the list
930 of the rest of the server's tokens.
932 Using this, you can write coroutines which process many commands (and
933 possibly other events) simultaneously.
936 def __init__(me, queue, tag, words):
937 """Make an asynchronous command consisting of the given WORDS, which
938 sends responses to QUEUE, labelled with TAG."""
939 TripeCommand.__init__(me, words)
943 def response(me, code, *stuff):
944 """Handle a server response by writing it to the caller's queue."""
945 me.queue.put((me.tag, code, list(stuff)))
947 ###--------------------------------------------------------------------------
950 class TripeJobCancelled (Exception):
952 Exception sent to job handler if the client kills the job.
954 Not propagated further.
958 class TripeJobError (Exception):
960 Exception to cause failure report for running job.
962 Sends an SVCFAIL code back.
966 class TripeSyntaxError (Exception):
968 Exception to report a syntax error for a job.
970 Sends an SVCFAIL bad-svc-syntax message back.
974 class TripeServiceManager (TripeCommandDispatcher):
976 A command dispatcher with added handling for incoming service requests.
978 There is usually only one instance of this class, called svcmgr. Some of
979 the support functions in this module assume that this is the case.
981 To use, run mLib.select in a loop until the quitp method returns true;
982 then, in a non-root coroutine, register your services by calling `add', and
983 then call `running' when you've finished setting up.
985 The instance handles server service messages SVCJOB, SVCCANCEL and
986 SVCCLAIM. It maintains a table of running services. Incoming jobs cause
987 the service's `job' method to be invoked; SVCCANCEL sends a
988 TripeJobCancelled exception to the handler coroutine, and SVCCLAIM causes
989 the relevant service to be deregistered.
991 There is no base class for jobs, but a job must implement two methods:
993 start() Begin processing; might be a no-op.
995 cancel() Stop processing; the original client has killed the
998 The life of a service manager is divided into two parts: setup and running;
999 you tell the manager that you've finished setting up by calling the
1000 `running' method. If, at any point after setup is finished, there are no
1001 remaining services or jobs, `quitp' will return true, ending the process.
1004 ## --- Attributes ---
1006 ## svc Mapping name -> service object
1008 ## job Mapping jobid -> job handler coroutine
1010 ## runningp True when setup is finished
1012 ## _quitp True if explicit quit has been requested
1014 def __init__(me, socket):
1016 Initialize the service manager.
1018 SOCKET is the administration socket to connect to.
1020 TripeCommandDispatcher.__init__(me, socket)
1024 me.handler['SVCCANCEL'] = me._cancel
1025 me.handler['SVCJOB'] = me._job
1026 me.handler['SVCCLAIM'] = me._claim
1029 def addsvc(me, svc):
1030 """Register a new service; SVC is a TripeService instance."""
1031 assert svc.name not in me.svc
1032 me.svcclaim(svc.name, svc.version)
1033 me.svc[svc.name] = svc
1035 def _cancel(me, _, jid):
1037 Called when the server cancels a job; invokes the job's `cancel' method.
1043 def _claim(me, _, svc, __):
1044 """Called when another program claims our service at a higher version."""
1047 def _job(me, _, jid, svc, cmd, *args):
1049 Called when the server sends us a job to do.
1051 Calls the service to collect a job, and begins processing it.
1053 assert jid not in me.job
1054 svc = me.svc[svc.lower()]
1055 job = svc.job(jid, cmd, args)
1060 """Answer true if setup is finished."""
1063 def jobdone(me, jid):
1064 """Informs the service manager that the job with id JID has finished."""
1072 Return true if no services or jobs are active (and, therefore, if this
1073 process can quit without anyone caring).
1075 return me._quitp or (me.runningp and ((not me.svc and not me.job) or
1079 """Forces the quit flag (returned by quitp) on."""
1082 class TripeService (object):
1086 The NAME and VERSION are passed on to the server. The CMDTAB is a
1087 dictionary mapping command names (in lowercase) to command objects.
1089 If the CMDTAB doesn't have entries for commands HELP and QUIT then defaults
1092 TripeService itself is mostly agnostic about the nature of command objects,
1093 but the TripeServiceJob class (below) has some requirements. The built-in
1094 HELP command requires command objects to have `usage' attributes.
1097 def __init__(me, name, version, cmdtab):
1099 Create and register a new service with the given NAME and VERSION.
1101 CMDTAB maps command names (in lower-case) to command objects.
1104 me.version = version
1107 me.cmd.setdefault('help',
1108 TripeServiceCommand('help', 0, 0, '', me._help))
1109 me.cmd.setdefault('quit',
1110 TripeServiceCommand('quit', 0, 0, '', me._quit))
1112 def job(me, jid, cmd, args):
1114 Called by the service manager: a job arrived with id JID.
1116 It asks for comamnd CMD with argument list ARGS. Creates a new job,
1117 passing it the information needed.
1119 return TripeServiceJob(jid, me, cmd, me.cmd.get(cmd.lower()), args)
1121 ## Simple default command handlers, complying with the spec in
1122 ## tripe-service(7).
1125 """Send a help summary to the user."""
1126 cmds = me.cmd.items()
1128 for name, cmd in cmds:
1129 svcinfo(name, *cmd.usage)
1132 """Terminate the service manager."""
1133 svcmgr.notify('svc-quit', me.name, 'admin-request')
1136 class TripeServiceCommand (object):
1137 """A simple service command."""
1139 def __init__(me, name, min, max, usage, func):
1141 Creates a new command.
1143 NAME is the command's name (in lowercase).
1145 MIN and MAX are the minimum and maximum number of allowed arguments (used
1146 for checking); either may be None to indicate no minimum or maximum.
1148 USAGE is a usage string, used for generating help and error messages.
1150 FUNC is the function to invoke.
1155 me.usage = usage.split()
1160 Called when the command is invoked.
1162 Does minimal checking of the arguments and calls the supplied function.
1164 if (me.min is not None and len(args) < me.min) or \
1165 (me.max is not None and len(args) > me.max):
1166 raise TripeSyntaxError
1169 class TripeServiceJob (Coroutine):
1171 Job handler coroutine.
1173 A standard TripeService invokes a TripeServiceJob for each incoming job
1174 request, passing it the jobid, command and arguments, and a command
1175 object. The command object needs the following attributes.
1177 usage A usage list (excluding the command name) showing
1178 arguments and options.
1180 run(*ARGS) Function to react to the command with ARGS split into
1181 separate arguments. Invoked in a coroutine. The
1182 svcinfo function (not the TripeCommandDispatcher
1183 method) may be used to send INFO lines. The function
1184 may raise TripeJobError to send a FAIL response back,
1185 or TripeSyntaxError to send a generic usage error.
1186 TripeJobCancelled exceptions are trapped silently.
1187 Other exceptions are translated into a generic
1188 internal-error message.
1190 This class automatically takes care of sending some closing response to the
1191 job, and for informing the service manager that the job is completed.
1193 The `jid' attribute stores the job's id.
1196 def __init__(me, jid, svc, cmd, command, args):
1200 The job is created with id JID, for service SVC, processing command name
1201 CMD (which the service resolved into the command object COMMAND, or
1202 None), and with the arguments ARGS.
1204 Coroutine.__init__(me)
1208 me.command = command
1213 Main body of the coroutine.
1215 Does the tedious exception handling boilerplate and invokes the command's
1220 if me.command is None:
1221 svcmgr.svcfail(me.jid, 'unknown-svc-command', me.cmd)
1223 me.command.run(*me.args)
1224 svcmgr.svcok(me.jid)
1225 except TripeJobError, exc:
1226 svcmgr.svcfail(me.jid, *exc.args)
1227 except TripeSyntaxError:
1228 svcmgr.svcfail(me.jid, 'bad-svc-syntax',
1229 me.svc.name, me.command.name,
1231 except TripeJobCancelled:
1233 except Exception, exc:
1234 svcmgr.svcfail(me.jid, 'svc-internal-error',
1235 exc.__class__.__name__, str(exc))
1237 svcmgr.jobdone(me.jid)
1240 """Invoked by the service manager to start running the coroutine."""
1244 """Invoked by the service manager to cancel the job."""
1245 me.throw(TripeJobCancelled())
1249 If invoked from a TripeServiceJob coroutine, sends an INFO line to the
1250 job's sender, automatically using the correct job id.
1252 svcmgr.svcinfo(Coroutine.getcurrent().jid, *args)
1254 def _setupsvc(tab, func):
1256 Setup coroutine for setting up service programs.
1258 Register the given services.
1262 svcmgr.addsvc(service)
1268 svcmgr = TripeServiceManager(None)
1269 def runservices(socket, tab, init = None, setup = None, daemon = False):
1271 Function to start a service provider.
1273 SOCKET is the socket to connect to, usually tripesock.
1275 TAB is a list of entries. An entry may be either a tuple
1277 (NAME, VERSION, COMMANDS)
1279 or a service object (e.g., a TripeService instance).
1281 COMMANDS is a dictionary mapping command names to tuples
1283 (MIN, MAX, USAGE, FUNC)
1285 of arguments for a TripeServiceCommand object.
1287 If DAEMON is true, then the process is forked into the background before we
1288 start. If INIT is given, it is called in the main coroutine, immediately
1289 after forking. If SETUP is given, it is called in a coroutine, after
1290 calling INIT and setting up the services but before marking the service
1293 It is a really bad idea to do any initialization, particularly setting up
1294 coroutines, outside of the INIT or SETUP functions. In particular, if
1295 we're using rmcr for fake coroutines, the daemonizing fork will kill off
1296 the currently established coroutines in a most surprising way.
1298 The function runs a main select loop until the service manager decides to
1302 svcmgr.socket = socket
1306 if not isinstance(service, tuple):
1307 svcs.append(service)
1309 name, version, commands = service
1311 for cmd, stuff in commands.iteritems():
1312 cmdmap[cmd] = TripeServiceCommand(cmd, *stuff)
1313 svcs.append(TripeService(name, version, cmdmap))
1316 if init is not None:
1318 spawn(_setupsvc, svcs, setup)
1321 ###--------------------------------------------------------------------------
1322 ### Utilities for services.
1324 _timeunits = {'s': 1, 'm': 60, 'h': 3600, 'd': 86400}
1326 """Parse the timespec SPEC, returning a number of seconds."""
1328 if len(spec) > 1 and spec[-1] in _timeunits:
1329 mul = _timeunits[spec[-1]]
1334 raise TripeJobError('bad-time-spec', spec)
1336 raise TripeJobError('bad-time-spec', spec)
1337 return mul * int(spec)
1339 class OptParse (object):
1341 Parse options from a command list in the conventional fashion.
1343 ARGS is a list of arguments to a command. ALLOWED is a sequence of allowed
1344 options. The returned values are the option tags. During parsing, the
1345 `arg' method may be used to retrieve the argument for the most recent
1346 option. Afterwards, `rest' may be used to retrieve the remaining
1347 non-option arguments, and do a simple check on how many there are.
1349 The parser correctly handles `--' option terminators.
1352 def __init__(me, args, allowed):
1354 Create a new option parser.
1356 The parser will scan the ARGS for options given in the sequence ALLOWED
1357 (which are expected to include the `-' prefix).
1361 me.allowed[a] = True
1362 me.args = list(args)
1365 """Iterator protocol: I am my own iterator."""
1370 Iterator protocol: return the next option.
1372 If we've run out, raise StopIteration.
1374 if len(me.args) == 0 or \
1375 len(me.args[0]) < 2 or \
1376 not me.args[0].startswith('-'):
1378 opt = me.args.pop(0)
1381 if opt not in me.allowed:
1382 raise TripeSyntaxError
1387 Return the argument for the most recent option.
1389 If none is available, raise TripeSyntaxError.
1391 if len(me.args) == 0:
1392 raise TripeSyntaxError
1393 return me.args.pop(0)
1395 def rest(me, min = None, max = None):
1397 After option parsing is done, return the remaining arguments.
1399 Check that there are at least MIN and at most MAX arguments remaining --
1400 either may be None to suppress the check.
1402 if (min is not None and len(me.args) < min) or \
1403 (max is not None and len(me.args) > max):
1404 raise TripeSyntaxError
1407 ###----- That's all, folks --------------------------------------------------