mirror of https://github.com/zulip/zulip.git
Improve virtual_fs.py bot.
This commit fixes a bug with deleting directories, prettifies the program's path output, and adds the commands 'cd' (without 'cd ..') , 'rmdir' and 'pwd'.
This commit is contained in:
Robert Hönig
showell
parent
9bb390133b
commit
effaa75625
|
|
@ -12,7 +12,8 @@ class VirtualFsHandler(object):
|
|||
return False
|
||||
|
||||
original_content = message['content']
|
||||
return original_content.startswith('fs ')
|
||||
return (original_content.startswith('fs ') or
|
||||
original_content.startswith('@fs '))
|
||||
|
||||
def handle_message(self, message, client, state_handler):
|
||||
assert self.triage_message(message, client)
|
||||
|
|
@ -21,6 +22,7 @@ class VirtualFsHandler(object):
|
|||
command = original_content[len('fs '):]
|
||||
stream = message['display_recipient']
|
||||
topic = message['subject']
|
||||
sender = message['sender_email']
|
||||
|
||||
state = state_handler.get_state()
|
||||
if state is None:
|
||||
|
|
@ -28,9 +30,12 @@ class VirtualFsHandler(object):
|
|||
|
||||
if stream not in state:
|
||||
state[stream] = fs_new()
|
||||
|
||||
fs = state[stream]
|
||||
fs, msg = fs_command(fs, command)
|
||||
if sender not in fs['user_paths']:
|
||||
fs['user_paths'][sender] = '/'
|
||||
fs, msg = fs_command(fs, sender, command)
|
||||
prependix = '{}:\n'.format(sender)
|
||||
msg = prependix + msg
|
||||
state[stream] = fs
|
||||
state_handler.set_state(state)
|
||||
|
||||
|
|
@ -47,27 +52,30 @@ def get_help():
|
|||
The "fs" commands implement a virtual file system for a stream.
|
||||
The locations of text are persisted for the lifetime of the bot
|
||||
running, and if you rename a stream, you will lose the info.
|
||||
|
||||
Example commands:
|
||||
|
||||
```
|
||||
fs mkdir: create a directory
|
||||
fs ls: list a directory
|
||||
fs cd: change directory
|
||||
fs pwd: show current path
|
||||
fs write: write text
|
||||
fs read: read text
|
||||
fs rm: remove a file
|
||||
fs rmdir: remove a directory
|
||||
```
|
||||
|
||||
Use commands like `fs help write` for more details on specific
|
||||
commands.
|
||||
'''
|
||||
|
||||
def test():
|
||||
fs = fs_new()
|
||||
user = 'test_user'
|
||||
fs['user_paths'][user] = '/'
|
||||
assert is_directory(fs, '/')
|
||||
|
||||
for cmd, expected_response in sample_conversation():
|
||||
fs, msg = fs_command(fs, cmd)
|
||||
fs, msg = fs_command(fs, user, cmd)
|
||||
if msg != expected_response:
|
||||
raise AssertionError('''
|
||||
cmd: %s
|
||||
|
|
@ -77,6 +85,28 @@ def test():
|
|||
|
||||
def sample_conversation():
|
||||
return [
|
||||
('cd /', 'Current path: /'),
|
||||
('cd /home', 'ERROR: invalid path'),
|
||||
('cd .', 'ERROR: invalid path'),
|
||||
('mkdir home', 'directory created'),
|
||||
('cd home', 'Current path: /home/'),
|
||||
('cd /home/', 'Current path: /home/'),
|
||||
('mkdir stuff/', 'ERROR: stuff/ is not a valid name'),
|
||||
('mkdir stuff', 'directory created'),
|
||||
('write stuff/file1 something', 'file written'),
|
||||
('read stuff/file1', 'something'),
|
||||
('read /home/stuff/file1', 'something'),
|
||||
('read home/stuff/file1', 'ERROR: file does not exist'),
|
||||
('pwd ', '/home/'),
|
||||
('pwd bla', 'ERROR: syntax: pwd'),
|
||||
('ls bla foo', 'ERROR: syntax: ls <optional_path>'),
|
||||
('cd /', 'Current path: /'),
|
||||
('rm home', 'ERROR: /home/ is a directory, file required'),
|
||||
('rmdir home', 'removed'),
|
||||
('ls ', 'WARNING: directory is empty'),
|
||||
('cd home', 'ERROR: invalid path'),
|
||||
('read /home/stuff/file1', 'ERROR: file does not exist'),
|
||||
('cd /', 'Current path: /'),
|
||||
('write /foo contents of /foo', 'file written'),
|
||||
('read /foo', 'contents of /foo'),
|
||||
('write /bar Contents: bar bar', 'file written'),
|
||||
|
|
@ -88,7 +118,7 @@ def sample_conversation():
|
|||
('read /bar', 'new bar'),
|
||||
('write /yo/invalid whatever', 'ERROR: /yo is not a directory'),
|
||||
('mkdir /yo', 'directory created'),
|
||||
('read /yo', 'ERROR: /yo is a directory, file required'),
|
||||
('read /yo', 'ERROR: /yo/ is a directory, file required'),
|
||||
('ls /yo', 'WARNING: directory is empty'),
|
||||
('read /yo/nada', 'ERROR: file does not exist'),
|
||||
('write /yo whatever', 'ERROR: file already exists'),
|
||||
|
|
@ -97,45 +127,51 @@ def sample_conversation():
|
|||
('mkdir /yo/apple', 'ERROR: file already exists'),
|
||||
('ls /invalid', 'ERROR: file does not exist'),
|
||||
('ls /foo', 'ERROR: /foo is not a directory'),
|
||||
('ls /', '* /bar\n* /foo\n* /yo'),
|
||||
('ls /', '* /*bar*\n* /*foo*\n* /yo/'),
|
||||
('invalid command', 'ERROR: unrecognized command'),
|
||||
('write', 'ERROR: syntax: write <path> <some_text>'),
|
||||
('help', get_help()),
|
||||
('help ls', 'syntax: ls <path>'),
|
||||
('help ls', 'syntax: ls <optional_path>'),
|
||||
('help invalid_command', get_help()),
|
||||
]
|
||||
|
||||
REGEXES = dict(
|
||||
command='(ls|mkdir|read|rm|write)',
|
||||
command='(cd|ls|mkdir|read|rmdir|rm|write|pwd)',
|
||||
path='(\S+)',
|
||||
optional_path='(\S*)',
|
||||
some_text='(.+)',
|
||||
)
|
||||
|
||||
def get_commands():
|
||||
return {
|
||||
'help': (fs_help, ['command']),
|
||||
'ls': (fs_ls, ['path']),
|
||||
'ls': (fs_ls, ['optional_path']),
|
||||
'mkdir': (fs_mkdir, ['path']),
|
||||
'read': (fs_read, ['path']),
|
||||
'rm': (fs_rm, ['path']),
|
||||
'rmdir': (fs_rmdir, ['path']),
|
||||
'write': (fs_write, ['path', 'some_text']),
|
||||
'cd': (fs_cd, ['path']),
|
||||
'pwd': (fs_pwd, []),
|
||||
}
|
||||
|
||||
def fs_command(fs, cmd):
|
||||
if cmd.strip() == 'help':
|
||||
def fs_command(fs, user, cmd):
|
||||
cmd = cmd.strip()
|
||||
if cmd == 'help':
|
||||
return fs, get_help()
|
||||
|
||||
cmd_name = cmd.split()[0]
|
||||
cmd_args = cmd[len(cmd_name):].strip()
|
||||
commands = get_commands()
|
||||
if cmd_name not in commands:
|
||||
return fs, 'ERROR: unrecognized command'
|
||||
|
||||
f, arg_names = commands[cmd_name]
|
||||
partial_regexes = [cmd_name] + [REGEXES[a] for a in arg_names]
|
||||
partial_regexes = [REGEXES[a] for a in arg_names]
|
||||
regex = ' '.join(partial_regexes)
|
||||
m = re.match(regex, cmd)
|
||||
regex += '$'
|
||||
m = re.match(regex, cmd_args)
|
||||
if m:
|
||||
return f(fs, *m.groups())
|
||||
return f(fs, user, *m.groups())
|
||||
elif cmd_name == 'help':
|
||||
return fs, get_help()
|
||||
else:
|
||||
|
|
@ -145,77 +181,174 @@ def syntax_help(cmd_name):
|
|||
commands = get_commands()
|
||||
f, arg_names = commands[cmd_name]
|
||||
arg_syntax = ' '.join('<' + a + '>' for a in arg_names)
|
||||
return 'syntax: %s %s' % (cmd_name, arg_syntax)
|
||||
if arg_syntax:
|
||||
cmd = cmd_name + ' ' + arg_syntax
|
||||
else:
|
||||
cmd = cmd_name
|
||||
return 'syntax: {}'.format(cmd)
|
||||
|
||||
def fs_new():
|
||||
fs = {
|
||||
'/': directory([])
|
||||
'/': directory([]),
|
||||
'user_paths': dict()
|
||||
}
|
||||
return fs
|
||||
|
||||
def fs_help(fs, cmd_name):
|
||||
def fs_help(fs, user, cmd_name):
|
||||
return fs, syntax_help(cmd_name)
|
||||
|
||||
def fs_mkdir(fs, fn):
|
||||
if fn in fs:
|
||||
def fs_mkdir(fs, user, fn):
|
||||
path, msg = make_path(fs, user, fn)
|
||||
if msg:
|
||||
return fs, msg
|
||||
if path in fs:
|
||||
return fs, 'ERROR: file already exists'
|
||||
dir_path = os.path.dirname(fn)
|
||||
dir_path = os.path.dirname(path)
|
||||
if not is_directory(fs, dir_path):
|
||||
msg = 'ERROR: %s is not a directory' % (dir_path,)
|
||||
msg = 'ERROR: {} is not a directory'.format(dir_path)
|
||||
return fs, msg
|
||||
new_fs = fs.copy()
|
||||
new_dir = directory({fn}.union(fs[dir_path]['fns']))
|
||||
new_dir = directory({path}.union(fs[dir_path]['fns']))
|
||||
new_fs[dir_path] = new_dir
|
||||
new_fs[fn] = directory([])
|
||||
new_fs[path] = directory([])
|
||||
msg = 'directory created'
|
||||
return new_fs, msg
|
||||
|
||||
def fs_ls(fs, fn):
|
||||
if fn not in fs:
|
||||
def fs_ls(fs, user, fn):
|
||||
if fn == '.' or fn == '':
|
||||
path = fs['user_paths'][user]
|
||||
else:
|
||||
path, msg = make_path(fs, user, fn)
|
||||
if msg:
|
||||
return fs, msg
|
||||
if path not in fs:
|
||||
msg = 'ERROR: file does not exist'
|
||||
return fs, msg
|
||||
if not is_directory(fs, fn):
|
||||
return fs, 'ERROR: %s is not a directory' % (fn,)
|
||||
fns = fs[fn]['fns']
|
||||
if not is_directory(fs, path):
|
||||
return fs, 'ERROR: {} is not a directory'.format(path)
|
||||
fns = fs[path]['fns']
|
||||
if not fns:
|
||||
return fs, 'WARNING: directory is empty'
|
||||
msg = '\n'.join('* ' + fn for fn in sorted(fns))
|
||||
msg = '\n'.join('* ' + nice_path(fs, path) for path in sorted(fns))
|
||||
return fs, msg
|
||||
|
||||
def fs_rm(fs, fn):
|
||||
if fn not in fs:
|
||||
def fs_pwd(fs, user):
|
||||
path = fs['user_paths'][user]
|
||||
msg = nice_path(fs, path)
|
||||
return fs, msg
|
||||
|
||||
def fs_rm(fs, user, fn):
|
||||
path, msg = make_path(fs, user, fn)
|
||||
if msg:
|
||||
return fs, msg
|
||||
if path not in fs:
|
||||
msg = 'ERROR: file does not exist'
|
||||
return fs, msg
|
||||
if fs[path]['kind'] == 'dir':
|
||||
msg = 'ERROR: {} is a directory, file required'.format(nice_path(fs, path))
|
||||
return fs, msg
|
||||
new_fs = fs.copy()
|
||||
new_fs.pop(fn)
|
||||
new_fs.pop(path)
|
||||
directory = get_directory(path)
|
||||
new_fs[directory]['fns'].remove(path)
|
||||
msg = 'removed'
|
||||
return new_fs, msg
|
||||
|
||||
def fs_write(fs, fn, content):
|
||||
if fn in fs:
|
||||
msg = 'ERROR: file already exists'
|
||||
def fs_rmdir(fs, user, fn):
|
||||
path, msg = make_path(fs, user, fn)
|
||||
if msg:
|
||||
return fs, msg
|
||||
dir_path = os.path.dirname(fn)
|
||||
if not is_directory(fs, dir_path):
|
||||
msg = 'ERROR: %s is not a directory' % (dir_path,)
|
||||
if path not in fs:
|
||||
msg = 'ERROR: directory does not exist'
|
||||
return fs, msg
|
||||
if fs[path]['kind'] == 'text':
|
||||
msg = 'ERROR: {} is a file, directory required'.format(nice_path(fs, path))
|
||||
return fs, msg
|
||||
new_fs = fs.copy()
|
||||
new_dir = directory({fn}.union(fs[dir_path]['fns']))
|
||||
new_fs.pop(path)
|
||||
directory = get_directory(path)
|
||||
new_fs[directory]['fns'].remove(path)
|
||||
for sub_path in new_fs.keys():
|
||||
if sub_path.startswith(path+'/'):
|
||||
new_fs.pop(sub_path)
|
||||
msg = 'removed'
|
||||
return new_fs, msg
|
||||
|
||||
def fs_write(fs, user, fn, content):
|
||||
path, msg = make_path(fs, user, fn)
|
||||
if msg:
|
||||
return fs, msg
|
||||
if path in fs:
|
||||
msg = 'ERROR: file already exists'
|
||||
return fs, msg
|
||||
dir_path = os.path.dirname(path)
|
||||
if not is_directory(fs, dir_path):
|
||||
msg = 'ERROR: {} is not a directory'.format(dir_path)
|
||||
return fs, msg
|
||||
new_fs = fs.copy()
|
||||
new_dir = directory({path}.union(fs[dir_path]['fns']))
|
||||
new_fs[dir_path] = new_dir
|
||||
new_fs[fn] = text_file(content)
|
||||
new_fs[path] = text_file(content)
|
||||
msg = 'file written'
|
||||
return new_fs, msg
|
||||
|
||||
def fs_read(fs, fn):
|
||||
if fn not in fs:
|
||||
def fs_read(fs, user, fn):
|
||||
path, msg = make_path(fs, user, fn)
|
||||
if msg:
|
||||
return fs, msg
|
||||
if path not in fs:
|
||||
msg = 'ERROR: file does not exist'
|
||||
return fs, msg
|
||||
if fs[fn]['kind'] == 'dir':
|
||||
msg = 'ERROR: {} is a directory, file required'.format(fn)
|
||||
if fs[path]['kind'] == 'dir':
|
||||
msg = 'ERROR: {} is a directory, file required'.format(nice_path(fs, path))
|
||||
return fs, msg
|
||||
val = fs[fn]['content']
|
||||
val = fs[path]['content']
|
||||
return fs, val
|
||||
|
||||
def fs_cd(fs, user, fn):
|
||||
if len(fn) > 1 and fn[-1] == '/':
|
||||
fn = fn[:-1]
|
||||
path = fn if len(fn) > 0 and fn[0] == '/' else make_path(fs, user, fn)[0]
|
||||
if path not in fs:
|
||||
msg = 'ERROR: invalid path'
|
||||
return fs, msg
|
||||
if fs[path]['kind'] == 'text':
|
||||
msg = 'ERROR: {} is a file, directory required'.format(nice_path(fs, path))
|
||||
return fs, msg
|
||||
fs['user_paths'][user] = path
|
||||
return fs, "Current path: {}".format(nice_path(fs, path))
|
||||
|
||||
def make_path(fs, user, leaf):
|
||||
if leaf == '/':
|
||||
return ['/', '']
|
||||
if leaf.endswith('/'):
|
||||
return ['', 'ERROR: {} is not a valid name'.format(leaf)]
|
||||
if leaf.startswith('/'):
|
||||
return [leaf, '']
|
||||
path = fs['user_paths'][user]
|
||||
if not path.endswith('/'):
|
||||
path += '/'
|
||||
path += leaf
|
||||
return path, ''
|
||||
|
||||
def nice_path(fs, path):
|
||||
path_nice = path
|
||||
slash = path.rfind('/')
|
||||
if path not in fs:
|
||||
return 'ERROR: the current directory does not exist'
|
||||
if fs[path]['kind'] == 'text':
|
||||
path_nice = '{}*{}*'.format(path[:slash+1], path[slash+1:])
|
||||
elif path != '/':
|
||||
path_nice = '{}/'.format(path)
|
||||
return path_nice
|
||||
|
||||
def get_directory(path):
|
||||
slash = path.rfind('/')
|
||||
if slash == 0:
|
||||
return '/'
|
||||
else:
|
||||
return path[:slash]
|
||||
|
||||
def directory(fns):
|
||||
return dict(kind='dir', fns=set(fns))
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue