class StompCLI(Cmd, ConnectionListener):
"""
A command line interface to the stomp.py client. See \link stomp::internal::connect::Connection \endlink
for more information on establishing a connection to a stomp server.
"""
def __init__(self,
host='localhost',
port=61613,
user='',
passcode='',
ver=1.0,
stdin=sys.stdin,
stdout=sys.stdout):
Cmd.__init__(self, 'Tab', stdin, stdout)
ConnectionListener.__init__(self)
self.conn = Connection([(host, port)],
user,
passcode,
wait_on_receipt=True,
version=ver)
self.conn.set_listener('', self)
self.conn.start()
self.transaction_id = None
self.version = ver
self.__subscriptions = {}
self.__subscription_id = 1
self.prompt = '> '
def __print_async(self, frame_type, headers, body):
"""
Utility function to print a message and setup the command prompt
for the next input
"""
self.__sysout("\r \r", end='')
self.__sysout(frame_type)
for header_key in headers.keys():
self.__sysout('%s: %s' % (header_key, headers[header_key]))
self.__sysout('')
self.__sysout(body)
self.__sysout('> ', end='')
self.stdout.flush()
def __sysout(self, msg, end="\n"):
self.stdout.write(str(msg) + end)
def __error(self, msg, end="\n"):
self.stdout.write(colors.BOLD + colors.RED + str(msg) +
colors.NO_COLOR + end)
def on_connecting(self, host_and_port):
"""
\see ConnectionListener::on_connecting
"""
self.conn.connect(wait=True)
def on_disconnected(self):
"""
\see ConnectionListener::on_disconnected
"""
self.__error("lost connection")
def on_message(self, headers, body):
"""
\see ConnectionListener::on_message
Special case: if the header 'filename' is present, the content is written out
as a file
"""
if 'filename' in headers:
content = base64.b64decode(body.encode())
if os.path.exists(headers['filename']):
fname = '%s.%s' % (headers['filename'], int(time.time()))
else:
fname = headers['filename']
f = open(fname, 'wb')
f.write(content)
f.close()
self.__print_async("MESSAGE", headers, "Saved file: %s" % fname)
else:
self.__print_async("MESSAGE", headers, body)
def on_error(self, headers, body):
"""
\see ConnectionListener::on_error
"""
self.__print_async("ERROR", headers, body)
def on_receipt(self, headers, body):
"""
\see ConnectionListener::on_receipt
"""
self.__print_async("RECEIPT", headers, body)
def on_connected(self, headers, body):
"""
\see ConnectionListener::on_connected
"""
self.__print_async("CONNECTED", headers, body)
def help_help(self):
self.__sysout('Quick help on commands')
def default(self, line):
self.__error('Unknown command: %s' % line.split()[0])
def emptyline(self):
pass
def help(self, usage, description, required=[], optional=[]):
required.insert(0, '')
rparams = "\n\t".join(required)
optional.insert(0, '')
oparams = "\n\t".join(optional)
m = {
'hl': colors.BOLD + colors.GREEN,
'nc': colors.NO_COLOR,
'usage': usage,
'description': description,
'required': rparams.rstrip(),
'optional': oparams.rstrip()
}
if rparams.rstrip() != '':
rparams = '''%(hl)sRequired Parameters:%(nc)s%(required)s\n\n''' % m
m['required'] = rparams
if oparams.rstrip() != '':
oparams = '''%(hl)sOptional Parameters:%(nc)s%(optional)s\n\n''' % m
m['optional'] = oparams
self.__sysout('''%(hl)sUsage:%(nc)s
\t%(usage)s
%(required)s%(optional)s%(hl)sDescription:%(nc)s
\t%(description)s
''' % m)
def do_quit(self, args):
self.conn.stop()
sys.exit(0)
do_exit = do_quit
do_EOF = do_quit
def help_quit(self):
self.help('exit', 'Exit the stomp client')
help_exit = help_quit
def help_EOF(self):
self.__sysout('')
def do_subscribe(self, args):
args = args.split()
if len(args) < 1:
self.__error('Expecting: subscribe <destination> [ack]')
return
name = args[0]
if name in self.__subscriptions:
self.__error('Already subscribed to %s' % name)
return
ack_mode = 'auto'
if len(args) >= 2:
ack_mode = args[1]
sid = self.__subscription_id
self.__subscription_id += 1
self.__sysout(
'Subscribing to "%s" with acknowledge set to "%s", id set to "%s"'
% (name, ack_mode, sid))
self.conn.subscribe(destination=name, ack=ack_mode, id=sid)
self.__subscriptions[name] = SubscriptionInfo(sid, ack_mode)
def help_subscribe(self):
self.help(
'subscribe <destination> [ack]',
'''Register to listen to a given destination. Like send, the subscribe command requires a destination
\theader indicating which destination to subscribe to. The ack parameter is optional, and defaults to
\tauto.''', ['destination - the name to subscribe to'], [
'ack - how to handle acknowledgements for a message; either automatically (auto) or manually (client)'
])
def do_unsubscribe(self, args):
args = args.split()
if len(args) < 1:
self.__error('Expecting: unsubscribe <destination>')
return
if args[0] not in self.__subscriptions.keys():
self.__sysout('Subscription %s not found' % args[0])
return
self.__sysout('Unsubscribing from "%s"' % args[0])
self.conn.unsubscribe(destination=args[0],
id=self.__subscriptions[args[0]].id)
del self.__subscriptions[args[0]]
def help_unsubscribe(self):
self.help(
'unsubscribe <destination>',
'Remove an existing subscription - so that the client no longer receive messages from that destination.',
['destination - the name to unsubscribe from'], [
'ack - how to handle acknowledgements for a message; either automatically (auto) or manually (client)'
])
def do_disconnect(self, args):
try:
self.__sysout("")
self.conn.disconnect()
except NotConnectedException:
pass # ignore if no longer connected
def help_disconnect(self):
self.help('disconnect <destination>',
'Gracefully disconnect from the server.')
def do_send(self, args):
args = args.split()
if len(args) < 2:
self.__error('Expecting: send <destination> <message>')
elif not self.transaction_id:
self.conn.send(destination=args[0], message=' '.join(args[1:]))
else:
self.conn.send(destination=args[0],
message=' '.join(args[1:]),
transaction=self.transaction_id)
def complete_send(self, text, line, begidx, endidx):
mline = line.split(' ')[1]
offs = len(mline) - len(text)
return [s[offs:] for s in self.__subscriptions if s.startswith(mline)]
complete_unsubscribe = complete_send
complete_sendrec = complete_send
complete_sendreply = complete_send
complete_sendfile = complete_send
def help_send(self):
self.help('send <destination> <message>',
'Sends a message to a destination in the messaging system.',
[
'destination - where to send the message',
'message - the content to send'
])
def do_sendrec(self, args):
args = args.split()
receipt_id = str(uuid.uuid4())
if len(args) < 2:
self.__error('Expecting: sendrec <destination> <message>')
elif not self.transaction_id:
self.conn.send(destination=args[0],
message=' '.join(args[1:]),
receipt=receipt_id)
else:
self.conn.send(destination=args[0],
message=' '.join(args[1:]),
transaction=self.transaction_id,
receipt=receipt_id)
def help_sendrec(self):
self.help(
'sendrec <destination> <message>',
'Sends a message to a destination in the messaging system and blocks for receipt of the message.',
[
'destination - where to send the message',
'message - the content to send'
])
def do_sendreply(self, args):
args = args.split()
if len(args) < 3:
self.__error(
'Expecting: sendreply <destination> <correlation-id> <message>'
)
else:
self.conn.send(destination=args[0],
message="%s\n" % ' '.join(args[2:]),
headers={'correlation-id': args[1]})
def help_sendreply(self):
self.help(
'sendreply <destination> <correlation-id> <message>',
'Sends a reply message to a destination in the messaging system.',
[
'destination - where to send the message',
'correlation-id - the correlating identifier to send with the response',
'message - the content to send'
])
def do_sendfile(self, args):
args = args.split()
if len(args) < 2:
self.__error('Expecting: sendfile <destination> <filename>')
elif not os.path.exists(args[1]):
self.__error('File %s does not exist' % args[1])
else:
s = open(args[1], mode='rb').read()
msg = base64.b64encode(s).decode()
if not self.transaction_id:
self.conn.send(destination=args[0],
message=msg,
filename=args[1])
else:
self.conn.send(destination=args[0],
message=msg,
filename=args[1],
transaction=self.transaction_id)
def help_sendfile(self):
self.help('sendfile <destination> <filename>',
'Sends a file to a destination in the messaging system.', [
'destination - where to send the message',
'filename - the file to send'
])
def do_version(self, args):
self.__sysout(
'%s%s [Protocol version %s]%s' %
(colors.BOLD, stomppy_version, self.conn.version, colors.NO_COLOR))
do_ver = do_version
def help_version(self):
self.help('version', 'Display the version of the client')
help_ver = help_version
def check_ack_nack(self, cmd, args):
if self.version >= 1.1 and len(args) < 2:
self.__error("Expecting: %s <message-id> <subscription-id>" % cmd)
return None
elif len(args) < 1:
self.__error("Expecting: %s <message-id>" % cmd)
return None
hdrs = {'message-id': args[0]}
if self.version >= 1.1:
if len(args) < 2:
self.__error("Expecting: %s <message-id> <subscription-id>" %
cmd)
return
hdrs['subscription'] = args[1]
return hdrs
def do_ack(self, args):
args = args.split()
hdrs = self.check_ack_nack('ack', args)
if hdrs is None:
return
if not self.transaction_id:
self.conn.ack(headers=hdrs)
else:
self.conn.ack(headers=hdrs, transaction=self.transaction_id)
def help_ack(self):
self.help(
'ack <message-id> [subscription-id]',
'''The command 'ack' is used to acknowledge consumption of a message from a subscription using client
\tacknowledgment. When a client has issued a 'subscribe' with the ack flag set to client, any messages
\treceived from that destination will not be considered to have been consumed (by the server) until
\tthe message has been acknowledged.''',
['message-id - the id of the message being acknowledged'], [
'subscription-id the id of the subscription (only required for STOMP 1.1)'
])
def do_nack(self, args):
args = args.split()
hdrs = self.check_ack_nack('nack', args)
if hdrs is None:
return
if not self.transaction_id:
self.conn.nack(headers=hdrs)
else:
self.conn.nack(headers=hdrs, transaction=self.transaction_id)
def help_nack(self):
self.help(
'nack <message-id> [subscription]',
'''The command 'nack' is used to acknowledge the failure of a message from a subscription using client
\tacknowledgment. When a client has issued a 'subscribe' with the ack flag set to client, any messages
\treceived from that destination will not be considered to have been consumed (by the server) until
\tthe message has been acknowledged (ack or nack).''',
['message-id - the id of the message being acknowledged'])
def do_abort(self, args):
if not self.transaction_id:
self.__error("Not currently in a transaction")
else:
self.conn.abort(transaction=self.transaction_id)
self.transaction_id = None
do_rollback = do_abort
def help_abort(self):
self.help('abort', 'Roll back a transaction in progress.')
help_rollback = help_abort
def do_begin(self, args):
if self.transaction_id:
self.__error("Currently in a transaction (%s)" %
self.transaction_id)
else:
self.transaction_id = self.conn.begin()
self.__sysout('Transaction id: %s' % self.transaction_id)
def help_begin(self):
self.help(
'begin',
'''Start a transaction. Transactions in this case apply to sending and acknowledging -
\tany messages sent or acknowledged during a transaction will be handled atomically based on the
\ttransaction.''')
def do_commit(self, args):
if not self.transaction_id:
self.__error("Not currently in a transaction")
else:
self.__sysout('Committing %s' % self.transaction_id)
self.conn.commit(transaction=self.transaction_id)
self.transaction_id = None
def help_commit(self):
self.help('commit', 'Commit a transaction in progress.')
def do_stats(self, args):
args = args.split()
if len(args) < 1:
stats = self.conn.get_listener('stats')
if stats:
self.__sysout(stats)
else:
self.__error('No stats available')
elif args[0] == 'on':
self.conn.set_listener('stats', StatsListener())
elif args[0] == 'off':
self.conn.remove_listener('stats')
else:
self.__error('Expecting: stats [on|off]')
def help_stats(self):
self.help(
'stats [on|off]',
'''Record statistics on messages sent, received, errors, etc. If no argument (on|off) is specified,
\tdump the current statistics.''')
def do_run(self, args):
args = args.split()
if len(args) == 0:
self.__error("Expecting: run <filename>")
elif not os.path.exists(args[0]):
self.__error("File %s was not found" % args[0])
else:
lines = open(args[0]).read().split('\n')
for line in lines:
self.onecmd(line)
def help_run(self):
self.help('run <filename>', 'Execute commands in a specified file')
class StompCLI(ConnectionListener):
"""
A command line interface to the stomp.py client. See \link stomp::internal::connect::Connection \endlink
for more information on establishing a connection to a stomp server.
"""
def __init__(self, host='localhost', port=61613, user='', passcode=''):
self.conn = Connection([(host, port)], user, passcode)
self.conn.set_listener('', self)
self.conn.start()
self.__commands = get_commands()
self.transaction_id = None
def __print_async(self, frame_type, headers, body):
"""
Utility function to print a message and setup the command prompt
for the next input
"""
sysout("\r \r", end='')
sysout(frame_type)
for header_key in headers.keys():
sysout('%s: %s' % (header_key, headers[header_key]))
sysout('')
sysout(body)
sysout('> ', end='')
sys.stdout.flush()
def on_connecting(self, host_and_port):
"""
\see ConnectionListener::on_connecting
"""
self.conn.connect(wait=True)
def on_disconnected(self):
"""
\see ConnectionListener::on_disconnected
"""
sysout("lost connection")
def on_message(self, headers, body):
"""
\see ConnectionListener::on_message
Special case: if the header 'filename' is present, the content is written out
as a file
"""
if 'filename' in headers:
content = base64.b64decode(body.encode())
if os.path.exists(headers['filename']):
fname = '%s.%s' % (headers['filename'], int(time.time()))
else:
fname = headers['filename']
f = open(fname, 'wb')
f.write(content)
f.close()
self.__print_async("MESSAGE", headers, "Saved file: %s" % fname)
else:
self.__print_async("MESSAGE", headers, body)
def on_error(self, headers, body):
"""
\see ConnectionListener::on_error
"""
self.__print_async("ERROR", headers, body)
def on_receipt(self, headers, body):
"""
\see ConnectionListener::on_receipt
"""
self.__print_async("RECEIPT", headers, body)
def on_connected(self, headers, body):
"""
\see ConnectionListener::on_connected
"""
self.__print_async("CONNECTED", headers, body)
def ack(self, args):
"""
Usage:
ack <message-id>
Required Parameters:
message-id - the id of the message being acknowledged
Description:
The command 'ack' is used to acknowledge consumption of a message from a subscription using client
acknowledgment. When a client has issued a 'subscribe' with the ack flag set to client, any messages
received from that destination will not be considered to have been consumed (by the server) until
the message has been acknowledged.
"""
if len(args) < 2:
sysout("Expecting: ack <message-id>")
elif not self.transaction_id:
self.conn.ack(headers = { 'message-id' : args[1] })
else:
self.conn.ack(headers = { 'message-id' : args[1] }, transaction=self.transaction_id)
def abort(self, args):
"""
Usage:
abort
Description:
Roll back a transaction in progress.
"""
if not self.transaction_id:
sysout("Not currently in a transaction")
else:
self.conn.abort(transaction = self.transaction_id)
self.transaction_id = None
def begin(self, args):
"""
Usage:
begin
Description:
Start a transaction. Transactions in this case apply to sending and acknowledging -
any messages sent or acknowledged during a transaction will be handled atomically based on the
transaction.
"""
if self.transaction_id:
sysout("Currently in a transaction (%s)" % self.transaction_id)
else:
self.transaction_id = self.conn.begin()
sysout('Transaction id: %s' % self.transaction_id)
def commit(self, args):
"""
Usage:
commit
Description:
Commit a transaction in progress.
"""
if not self.transaction_id:
sysout("Not currently in a transaction")
else:
sysout('Committing %s' % self.transaction_id)
self.conn.commit(transaction=self.transaction_id)
self.transaction_id = None
def disconnect(self, args):
"""
Usage:
disconnect
Description:
Gracefully disconnect from the server.
"""
try:
self.conn.disconnect()
except NotConnectedException:
pass # ignore if no longer connected
def send(self, args):
"""
Usage:
send <destination> <message>
Required Parameters:
destination - where to send the message
message - the content to send
Description:
Sends a message to a destination in the messaging system.
"""
if len(args) < 3:
sysout('Expecting: send <destination> <message>')
elif not self.transaction_id:
self.conn.send(destination=args[1], message=' '.join(args[2:]))
else:
self.conn.send(destination=args[1], message=' '.join(args[2:]), transaction=self.transaction_id)
def sendreply(self, args):
"""
Usage:
sendreply <destination> <correlation-id> <message>
Required Parameters:
destination - where to send the message
correlation-id - the correlating identifier to send with the response
message - the content to send
Description:
Sends a reply message to a destination in the messaging system.
"""
if len(args) < 4:
sysout('expecting: sendreply <destination> <correlation-id> <message>')
else:
self.conn.send(destination=args[1], message="%s\n" % ' '.join(args[3:]), headers={'correlation-id': args[2]})
def sendfile(self, args):
"""
Usage:
sendfile <destination> <filename>
Required Parameters:
destination - where to send the message
filename - the file to send
Description:
Sends a file to a destination in the messaging system.
"""
if len(args) < 3:
sysout('Expecting: sendfile <destination> <filename>')
elif not os.path.exists(args[2]):
sysout('File %s does not exist' % args[2])
else:
s = open(args[2], mode='rb').read()
msg = base64.b64encode(s).decode()
if not self.transaction_id:
self.conn.send(destination=args[1], message=msg, filename=args[2])
else:
self.conn.send(destination=args[1], message=msg, filename=args[2], transaction=self.transaction_id)
def subscribe(self, args):
"""
Usage:
subscribe <destination> [ack]
Required Parameters:
destination - the name to subscribe to
Optional Parameters:
ack - how to handle acknowledgements for a message; either automatically (auto) or manually (client)
Description:
Register to listen to a given destination. Like send, the subscribe command requires a destination
header indicating which destination to subscribe to. The ack parameter is optional, and defaults to
auto.
"""
if len(args) < 2:
sysout('Expecting: subscribe <destination> [ack]')
elif len(args) > 2:
sysout('Subscribing to "%s" with acknowledge set to "%s"' % (args[1], args[2]))
self.conn.subscribe(destination=args[1], ack=args[2])
else:
sysout('Subscribing to "%s" with auto acknowledge' % args[1])
self.conn.subscribe(destination=args[1], ack='auto')
def unsubscribe(self, args):
"""
Usage:
unsubscribe <destination>
Required Parameters:
destination - the name to unsubscribe from
Description:
Remove an existing subscription - so that the client no longer receive messages from that destination.
"""
if len(args) < 2:
sysout('Expecting: unsubscribe <destination>')
else:
sysout('Unsubscribing from "%s"' % args[1])
self.conn.unsubscribe(destination=args[1])
def stats(self, args):
"""
Usage:
stats [on|off]
Description:
Record statistics on messages sent, received, errors, etc. If no argument (on|off) is specified,
dump the current statistics.
"""
if len(args) < 2:
stats = self.conn.get_listener('stats')
if stats:
sysout(stats)
else:
sysout('No stats available')
elif args[1] == 'on':
self.conn.set_listener('stats', StatsListener())
elif args[1] == 'off':
self.conn.remove_listener('stats')
else:
sysout('Expecting: stats [on|off]')
def run(self, args):
"""
Usage:
run <filename>
Description:
Execute commands in a specified file
"""
if len(args) == 1:
sysout("Expecting: run <filename>")
elif not os.path.exists(args[1]):
sysout("File %s was not found" % args[1])
else:
filecommands = open(args[1]).read().split('\n')
for x in range(len(filecommands)):
split = filecommands[x].split()
if len(split) < 1:
continue
elif split[0] in self.__commands:
getattr(self, split[0])(split)
else:
sysout('Unrecognized command "%s" at line %s' % (split[0], x))
break
def help(self, args):
"""
Usage:
help [command]
Description:
Display info on a specified command, or a list of available commands
"""
if len(args) == 1:
sysout('Usage: help <command>, where command is one of the following:')
sysout(' ')
for f in self.__commands:
sysout('%s ' % f, end='')
sysout('')
return
elif not hasattr(self, args[1]):
sysout('There is no command "%s"' % args[1])
return
func = getattr(self, args[1])
if hasattr(func, '__doc__') and getattr(func, '__doc__') is not None:
sysout(func.__doc__)
else:
sysout('There is no help for command "%s"' % args[1])
man = help
def version(self, args):
sysout('Stomp.py Version %s.%s' % internal.__version__)
ver = version
def quit(self, args):
pass
exit = quit
class StompCLI(ConnectionListener):
"""
A command line interface to the stomp.py client. See \link stomp::internal::connect::Connection \endlink
for more information on establishing a connection to a stomp server.
"""
def __init__(self, host='localhost', port=61613, user='', passcode=''):
self.conn = Connection([(host, port)], user, passcode)
self.conn.set_listener('', self)
self.conn.start()
self.__commands = get_commands()
self.transaction_id = None
def __print_async(self, frame_type, headers, body):
"""
Utility function to print a message and setup the command prompt
for the next input
"""
sysout("\r \r", end='')
sysout(frame_type)
for header_key in headers.keys():
sysout('%s: %s' % (header_key, headers[header_key]))
sysout('')
sysout(body)
sysout('> ', end='')
sys.stdout.flush()
def on_connecting(self, host_and_port):
"""
\see ConnectionListener::on_connecting
"""
self.conn.connect(wait=True)
def on_disconnected(self):
"""
\see ConnectionListener::on_disconnected
"""
sysout("lost connection")
def on_message(self, headers, body):
"""
\see ConnectionListener::on_message
Special case: if the header 'filename' is present, the content is written out
as a file
"""
if 'filename' in headers:
content = base64.b64decode(body.encode())
if os.path.exists(headers['filename']):
fname = '%s.%s' % (headers['filename'], int(time.time()))
else:
fname = headers['filename']
f = open(fname, 'wb')
f.write(content)
f.close()
self.__print_async("MESSAGE", headers, "Saved file: %s" % fname)
else:
self.__print_async("MESSAGE", headers, body)
def on_error(self, headers, body):
"""
\see ConnectionListener::on_error
"""
self.__print_async("ERROR", headers, body)
def on_receipt(self, headers, body):
"""
\see ConnectionListener::on_receipt
"""
self.__print_async("RECEIPT", headers, body)
def on_connected(self, headers, body):
"""
\see ConnectionListener::on_connected
"""
self.__print_async("CONNECTED", headers, body)
def ack(self, args):
"""
Usage:
ack <message-id>
Required Parameters:
message-id - the id of the message being acknowledged
Description:
The command 'ack' is used to acknowledge consumption of a message from a subscription using client
acknowledgment. When a client has issued a 'subscribe' with the ack flag set to client, any messages
received from that destination will not be considered to have been consumed (by the server) until
the message has been acknowledged.
"""
if len(args) < 2:
sysout("Expecting: ack <message-id>")
elif not self.transaction_id:
self.conn.ack(headers={'message-id': args[1]})
else:
self.conn.ack(headers={'message-id': args[1]},
transaction=self.transaction_id)
def abort(self, args):
"""
Usage:
abort
Description:
Roll back a transaction in progress.
"""
if not self.transaction_id:
sysout("Not currently in a transaction")
else:
self.conn.abort(transaction=self.transaction_id)
self.transaction_id = None
def begin(self, args):
"""
Usage:
begin
Description:
Start a transaction. Transactions in this case apply to sending and acknowledging -
any messages sent or acknowledged during a transaction will be handled atomically based on the
transaction.
"""
if self.transaction_id:
sysout("Currently in a transaction (%s)" % self.transaction_id)
else:
self.transaction_id = self.conn.begin()
sysout('Transaction id: %s' % self.transaction_id)
def commit(self, args):
"""
Usage:
commit
Description:
Commit a transaction in progress.
"""
if not self.transaction_id:
sysout("Not currently in a transaction")
else:
sysout('Committing %s' % self.transaction_id)
self.conn.commit(transaction=self.transaction_id)
self.transaction_id = None
def disconnect(self, args):
"""
Usage:
disconnect
Description:
Gracefully disconnect from the server.
"""
try:
self.conn.disconnect()
except NotConnectedException:
pass # ignore if no longer connected
def send(self, args):
"""
Usage:
send <destination> <message>
Required Parameters:
destination - where to send the message
message - the content to send
Description:
Sends a message to a destination in the messaging system.
"""
if len(args) < 3:
sysout('Expecting: send <destination> <message>')
elif not self.transaction_id:
self.conn.send(destination=args[1], message=' '.join(args[2:]))
else:
self.conn.send(destination=args[1],
message=' '.join(args[2:]),
transaction=self.transaction_id)
def sendreply(self, args):
"""
Usage:
sendreply <destination> <correlation-id> <message>
Required Parameters:
destination - where to send the message
correlation-id - the correlating identifier to send with the response
message - the content to send
Description:
Sends a reply message to a destination in the messaging system.
"""
if len(args) < 4:
sysout(
'expecting: sendreply <destination> <correlation-id> <message>'
)
else:
self.conn.send(destination=args[1],
message="%s\n" % ' '.join(args[3:]),
headers={'correlation-id': args[2]})
def sendfile(self, args):
"""
Usage:
sendfile <destination> <filename>
Required Parameters:
destination - where to send the message
filename - the file to send
Description:
Sends a file to a destination in the messaging system.
"""
if len(args) < 3:
sysout('Expecting: sendfile <destination> <filename>')
elif not os.path.exists(args[2]):
sysout('File %s does not exist' % args[2])
else:
s = open(args[2], mode='rb').read()
msg = base64.b64encode(s).decode()
if not self.transaction_id:
self.conn.send(destination=args[1],
message=msg,
filename=args[2])
else:
self.conn.send(destination=args[1],
message=msg,
filename=args[2],
transaction=self.transaction_id)
def subscribe(self, args):
"""
Usage:
subscribe <destination> [ack]
Required Parameters:
destination - the name to subscribe to
Optional Parameters:
ack - how to handle acknowledgements for a message; either automatically (auto) or manually (client)
Description:
Register to listen to a given destination. Like send, the subscribe command requires a destination
header indicating which destination to subscribe to. The ack parameter is optional, and defaults to
auto.
"""
if len(args) < 2:
sysout('Expecting: subscribe <destination> [ack]')
elif len(args) > 2:
sysout('Subscribing to "%s" with acknowledge set to "%s"' %
(args[1], args[2]))
self.conn.subscribe(destination=args[1], ack=args[2])
else:
sysout('Subscribing to "%s" with auto acknowledge' % args[1])
self.conn.subscribe(destination=args[1], ack='auto')
def unsubscribe(self, args):
"""
Usage:
unsubscribe <destination>
Required Parameters:
destination - the name to unsubscribe from
Description:
Remove an existing subscription - so that the client no longer receive messages from that destination.
"""
if len(args) < 2:
sysout('Expecting: unsubscribe <destination>')
else:
sysout('Unsubscribing from "%s"' % args[1])
self.conn.unsubscribe(destination=args[1])
def stats(self, args):
"""
Usage:
stats [on|off]
Description:
Record statistics on messages sent, received, errors, etc. If no argument (on|off) is specified,
dump the current statistics.
"""
if len(args) < 2:
stats = self.conn.get_listener('stats')
if stats:
sysout(stats)
else:
sysout('No stats available')
elif args[1] == 'on':
self.conn.set_listener('stats', StatsListener())
elif args[1] == 'off':
self.conn.remove_listener('stats')
else:
sysout('Expecting: stats [on|off]')
def run(self, args):
"""
Usage:
run <filename>
Description:
Execute commands in a specified file
"""
if len(args) == 1:
sysout("Expecting: run <filename>")
elif not os.path.exists(args[1]):
sysout("File %s was not found" % args[1])
else:
filecommands = open(args[1]).read().split('\n')
for x in range(len(filecommands)):
split = filecommands[x].split()
if len(split) < 1:
continue
elif split[0] in self.__commands:
getattr(self, split[0])(split)
else:
sysout('Unrecognized command "%s" at line %s' %
(split[0], x))
break
def help(self, args):
"""
Usage:
help [command]
Description:
Display info on a specified command, or a list of available commands
"""
if len(args) == 1:
sysout(
'Usage: help <command>, where command is one of the following:'
)
sysout(' ')
for f in self.__commands:
sysout('%s ' % f, end='')
sysout('')
return
elif not hasattr(self, args[1]):
sysout('There is no command "%s"' % args[1])
return
func = getattr(self, args[1])
if hasattr(func, '__doc__') and getattr(func, '__doc__') is not None:
sysout(func.__doc__)
else:
sysout('There is no help for command "%s"' % args[1])
man = help
def version(self, args):
sysout('Stomp.py Version %s.%s' % internal.__version__)
ver = version
def quit(self, args):
pass
exit = quit
class StompCLI(Cmd, ConnectionListener):
"""
A command line interface to the stomp.py client. See \link stomp::internal::connect::Connection \endlink
for more information on establishing a connection to a stomp server.
"""
def __init__(self, host='localhost', port=61613, user='', passcode='', ver=1.0, stdin=sys.stdin, stdout=sys.stdout):
Cmd.__init__(self, 'Tab', stdin, stdout)
ConnectionListener.__init__(self)
self.conn = Connection([(host, port)], user, passcode, wait_on_receipt=True, version=ver)
self.conn.set_listener('', self)
self.conn.start()
self.transaction_id = None
self.version = ver
self.__subscriptions = {}
self.__subscription_id = 1
self.prompt = '> '
def __print_async(self, frame_type, headers, body):
"""
Utility function to print a message and setup the command prompt
for the next input
"""
self.__sysout("\r \r", end='')
self.__sysout(frame_type)
for header_key in headers.keys():
self.__sysout('%s: %s' % (header_key, headers[header_key]))
self.__sysout('')
self.__sysout(body)
self.__sysout('> ', end='')
self.stdout.flush()
def __sysout(self, msg, end="\n"):
self.stdout.write(str(msg) + end)
def __error(self, msg, end="\n"):
self.stdout.write(colors.BOLD + colors.RED + str(msg) + colors.NO_COLOR + end)
def on_connecting(self, host_and_port):
"""
\see ConnectionListener::on_connecting
"""
self.conn.connect(wait=True)
def on_disconnected(self):
"""
\see ConnectionListener::on_disconnected
"""
self.__error("lost connection")
def on_message(self, headers, body):
"""
\see ConnectionListener::on_message
Special case: if the header 'filename' is present, the content is written out
as a file
"""
if 'filename' in headers:
content = base64.b64decode(body.encode())
if os.path.exists(headers['filename']):
fname = '%s.%s' % (headers['filename'], int(time.time()))
else:
fname = headers['filename']
f = open(fname, 'wb')
f.write(content)
f.close()
self.__print_async("MESSAGE", headers, "Saved file: %s" % fname)
else:
self.__print_async("MESSAGE", headers, body)
def on_error(self, headers, body):
"""
\see ConnectionListener::on_error
"""
self.__print_async("ERROR", headers, body)
def on_receipt(self, headers, body):
"""
\see ConnectionListener::on_receipt
"""
self.__print_async("RECEIPT", headers, body)
def on_connected(self, headers, body):
"""
\see ConnectionListener::on_connected
"""
self.__print_async("CONNECTED", headers, body)
def help_help(self):
self.__sysout('Quick help on commands')
def default(self, line):
self.__error('Unknown command: %s' % line.split()[0])
def emptyline(self):
pass
def help(self, usage, description, required = [], optional = []):
required.insert(0, '')
rparams = "\n\t".join(required)
optional.insert(0, '')
oparams = "\n\t".join(optional)
m = {
'hl' : colors.BOLD + colors.GREEN,
'nc' : colors.NO_COLOR,
'usage' : usage,
'description' : description,
'required' : rparams.rstrip(),
'optional' : oparams.rstrip()
}
if rparams.rstrip() != '':
rparams = '''%(hl)sRequired Parameters:%(nc)s%(required)s\n\n''' % m
m['required'] = rparams
if oparams.rstrip() != '':
oparams = '''%(hl)sOptional Parameters:%(nc)s%(optional)s\n\n''' % m
m['optional'] = oparams
self.__sysout('''%(hl)sUsage:%(nc)s
\t%(usage)s
%(required)s%(optional)s%(hl)sDescription:%(nc)s
\t%(description)s
''' % m)
def do_quit(self, args):
self.conn.stop()
sys.exit(0)
do_exit = do_quit
do_EOF = do_quit
def help_quit(self):
self.help('exit', 'Exit the stomp client')
help_exit = help_quit
def help_EOF(self):
self.__sysout('')
def do_subscribe(self, args):
args = args.split()
if len(args) < 1:
self.__error('Expecting: subscribe <destination> [ack]')
return
name = args[0]
if name in self.__subscriptions:
self.__error('Already subscribed to %s' % name)
return
ack_mode = 'auto'
if len(args) >= 2:
ack_mode = args[1]
sid = self.__subscription_id
self.__subscription_id += 1
self.__sysout('Subscribing to "%s" with acknowledge set to "%s", id set to "%s"' % (name, ack_mode, sid))
self.conn.subscribe(destination=name, ack=ack_mode, id=sid)
self.__subscriptions[name] = SubscriptionInfo(sid, ack_mode)
def help_subscribe(self):
self.help('subscribe <destination> [ack]',
'''Register to listen to a given destination. Like send, the subscribe command requires a destination
\theader indicating which destination to subscribe to. The ack parameter is optional, and defaults to
\tauto.''', [ 'destination - the name to subscribe to' ], [ 'ack - how to handle acknowledgements for a message; either automatically (auto) or manually (client)' ])
def do_unsubscribe(self, args):
args = args.split()
if len(args) < 1:
self.__error('Expecting: unsubscribe <destination>')
return
if args[0] not in self.__subscriptions.keys():
self.__sysout('Subscription %s not found' % args[0])
return
self.__sysout('Unsubscribing from "%s"' % args[0])
self.conn.unsubscribe(destination=args[0], id=self.__subscriptions[args[0]].id)
del self.__subscriptions[args[0]]
def help_unsubscribe(self):
self.help('unsubscribe <destination>', 'Remove an existing subscription - so that the client no longer receive messages from that destination.',
[ 'destination - the name to unsubscribe from' ], [ 'ack - how to handle acknowledgements for a message; either automatically (auto) or manually (client)' ])
def do_disconnect(self, args):
try:
self.__sysout("")
self.conn.disconnect()
except NotConnectedException:
pass # ignore if no longer connected
def help_disconnect(self):
self.help('disconnect <destination>', 'Gracefully disconnect from the server.')
def do_send(self, args):
args = args.split()
if len(args) < 2:
self.__error('Expecting: send <destination> <message>')
elif not self.transaction_id:
self.conn.send(destination=args[0], message=' '.join(args[1:]))
else:
self.conn.send(destination=args[0], message=' '.join(args[1:]), transaction=self.transaction_id)
def complete_send(self, text, line, begidx, endidx):
mline = line.split(' ')[1]
offs = len(mline) - len(text)
return [s[offs:] for s in self.__subscriptions if s.startswith(mline)]
complete_unsubscribe = complete_send
complete_sendrec = complete_send
complete_sendreply = complete_send
complete_sendfile = complete_send
def help_send(self):
self.help('send <destination> <message>', 'Sends a message to a destination in the messaging system.',
[ 'destination - where to send the message', 'message - the content to send' ])
def do_sendrec(self, args):
args = args.split()
receipt_id = str(uuid.uuid4())
if len(args) < 2:
self.__error('Expecting: sendrec <destination> <message>')
elif not self.transaction_id:
self.conn.send(destination=args[0], message=' '.join(args[1:]), receipt=receipt_id)
else:
self.conn.send(destination=args[0], message=' '.join(args[1:]), transaction=self.transaction_id, receipt=receipt_id)
def help_sendrec(self):
self.help('sendrec <destination> <message>', 'Sends a message to a destination in the messaging system and blocks for receipt of the message.',
[ 'destination - where to send the message', 'message - the content to send' ])
def do_sendreply(self, args):
args = args.split()
if len(args) < 3:
self.__error('Expecting: sendreply <destination> <correlation-id> <message>')
else:
self.conn.send(destination=args[0], message="%s\n" % ' '.join(args[2:]), headers={'correlation-id': args[1]})
def help_sendreply(self):
self.help('sendreply <destination> <correlation-id> <message>', 'Sends a reply message to a destination in the messaging system.',
[ 'destination - where to send the message', 'correlation-id - the correlating identifier to send with the response', 'message - the content to send' ])
def do_sendfile(self, args):
args = args.split()
if len(args) < 2:
self.__error('Expecting: sendfile <destination> <filename>')
elif not os.path.exists(args[1]):
self.__error('File %s does not exist' % args[1])
else:
s = open(args[1], mode='rb').read()
msg = base64.b64encode(s).decode()
if not self.transaction_id:
self.conn.send(destination=args[0], message=msg, filename=args[1])
else:
self.conn.send(destination=args[0], message=msg, filename=args[1], transaction=self.transaction_id)
def help_sendfile(self):
self.help('sendfile <destination> <filename>', 'Sends a file to a destination in the messaging system.',
[ 'destination - where to send the message', 'filename - the file to send' ])
def do_version(self, args):
self.__sysout('%s%s [Protocol version %s]%s' % (colors.BOLD, stomppy_version, self.conn.version, colors.NO_COLOR))
do_ver = do_version
def help_version(self):
self.help('version', 'Display the version of the client')
help_ver = help_version
def check_ack_nack(self, cmd, args):
if self.version >= 1.1 and len(args) < 2:
self.__error("Expecting: %s <message-id> <subscription-id>" % cmd)
return None
elif len(args) < 1:
self.__error("Expecting: %s <message-id>" % cmd)
return None
hdrs = { 'message-id' : args[0] }
if self.version >= 1.1:
if len(args) < 2:
self.__error("Expecting: %s <message-id> <subscription-id>" % cmd)
return
hdrs['subscription'] = args[1]
return hdrs
def do_ack(self, args):
args = args.split()
hdrs = self.check_ack_nack('ack', args)
if hdrs is None:
return
if not self.transaction_id:
self.conn.ack(headers = hdrs)
else:
self.conn.ack(headers = hdrs, transaction=self.transaction_id)
def help_ack(self):
self.help('ack <message-id> [subscription-id]', '''The command 'ack' is used to acknowledge consumption of a message from a subscription using client
\tacknowledgment. When a client has issued a 'subscribe' with the ack flag set to client, any messages
\treceived from that destination will not be considered to have been consumed (by the server) until
\tthe message has been acknowledged.''', [ 'message-id - the id of the message being acknowledged' ], [ 'subscription-id the id of the subscription (only required for STOMP 1.1)' ] )
def do_nack(self, args):
args = args.split()
hdrs = self.check_ack_nack('nack', args)
if hdrs is None:
return
if not self.transaction_id:
self.conn.nack(headers = hdrs)
else:
self.conn.nack(headers = hdrs, transaction=self.transaction_id)
def help_nack(self):
self.help('nack <message-id> [subscription]', '''The command 'nack' is used to acknowledge the failure of a message from a subscription using client
\tacknowledgment. When a client has issued a 'subscribe' with the ack flag set to client, any messages
\treceived from that destination will not be considered to have been consumed (by the server) until
\tthe message has been acknowledged (ack or nack).''', [ 'message-id - the id of the message being acknowledged' ])
def do_abort(self, args):
if not self.transaction_id:
self.__error("Not currently in a transaction")
else:
self.conn.abort(transaction = self.transaction_id)
self.transaction_id = None
do_rollback = do_abort
def help_abort(self):
self.help('abort', 'Roll back a transaction in progress.')
help_rollback = help_abort
def do_begin(self, args):
if self.transaction_id:
self.__error("Currently in a transaction (%s)" % self.transaction_id)
else:
self.transaction_id = self.conn.begin()
self.__sysout('Transaction id: %s' % self.transaction_id)
def help_begin(self):
self.help('begin', '''Start a transaction. Transactions in this case apply to sending and acknowledging -
\tany messages sent or acknowledged during a transaction will be handled atomically based on the
\ttransaction.''')
def do_commit(self, args):
if not self.transaction_id:
self.__error("Not currently in a transaction")
else:
self.__sysout('Committing %s' % self.transaction_id)
self.conn.commit(transaction=self.transaction_id)
self.transaction_id = None
def help_commit(self):
self.help('commit', 'Commit a transaction in progress.')
def do_stats(self, args):
args = args.split()
if len(args) < 1:
stats = self.conn.get_listener('stats')
if stats:
self.__sysout(stats)
else:
self.__error('No stats available')
elif args[0] == 'on':
self.conn.set_listener('stats', StatsListener())
elif args[0] == 'off':
self.conn.remove_listener('stats')
else:
self.__error('Expecting: stats [on|off]')
def help_stats(self):
self.help('stats [on|off]', '''Record statistics on messages sent, received, errors, etc. If no argument (on|off) is specified,
\tdump the current statistics.''')
def do_run(self, args):
args = args.split()
if len(args) == 0:
self.__error("Expecting: run <filename>")
elif not os.path.exists(args[0]):
self.__error("File %s was not found" % args[0])
else:
lines = open(args[0]).read().split('\n')
for line in lines:
self.onecmd(line)
def help_run(self):
self.help('run <filename>', 'Execute commands in a specified file')