]> arthur.barton.de Git - bup.git/blob - lib/bup/cmd/ftp.py
ftp: fix tab completion
[bup.git] / lib / bup / cmd / ftp.py
1
2 # For now, this completely relies on the assumption that the current
3 # encoding (LC_CTYPE, etc.) is ASCII compatible, and that it returns
4 # the exact same bytes from a decode/encode round-trip (or the reverse
5 # (e.g. ISO-8859-1).
6
7 from __future__ import absolute_import, print_function
8 import os, fnmatch, stat, sys
9
10 from bup import _helpers, options, git, shquote, ls, vfs
11 from bup.compat import argv_bytes, fsdecode
12 from bup.helpers import chunkyreader, handle_ctrl_c, log
13 from bup.io import byte_stream, path_msg
14 from bup.repo import LocalRepo
15
16
17 repo = None
18
19 class OptionError(Exception):
20     pass
21
22
23 def do_ls(repo, args, out):
24     try:
25         opt = ls.opts_from_cmdline(args, onabort=OptionError)
26     except OptionError as e:
27         log('error: %s' % e)
28         return
29     return ls.within_repo(repo, opt, out)
30
31
32 def write_to_file(inf, outf):
33     for blob in chunkyreader(inf):
34         outf.write(blob)
35
36
37 def inputiter(f):
38     if os.isatty(f.fileno()):
39         while 1:
40             if hasattr(_helpers, 'readline'):
41                 try:
42                     yield _helpers.readline(b'bup> ')
43                 except EOFError:
44                     print()  # Clear the line for the terminal's next prompt
45                     break
46             else:
47                 out.write(b'bup> ')
48                 out.flush()
49                 read_line = f.readline()
50                 if not read_line:
51                     print('')
52                     break
53                 yield read_line
54     else:
55         for line in f:
56             yield line
57
58
59 def _completer_get_subs(repo, line):
60     (qtype, lastword) = shquote.unfinished_word(line)
61     dir, name = os.path.split(lastword)
62     dir_path = vfs.resolve(repo, dir or b'/')
63     _, dir_item = dir_path[-1]
64     if not dir_item:
65         subs = tuple()
66     else:
67         subs = tuple(dir_path + (entry,)
68                      for entry in vfs.contents(repo, dir_item)
69                      if (entry[0] != b'.' and entry[0].startswith(name)))
70     return qtype, lastword, subs
71
72
73 _attempt_start = None
74 _attempt_end = None
75 def attempt_completion(text, start, end):
76     global _attempt_start, _attempt_end
77     _attempt_start = start
78     _attempt_end = end
79     return None
80
81 _last_line = None
82 _last_res = None
83 def enter_completion(text, iteration):
84     global repo
85     global _attempt_end
86     global _last_line
87     global _last_res
88     try:
89         line = _helpers.get_line_buffer()[:_attempt_end]
90         if _last_line != line:
91             _last_res = _completer_get_subs(repo, line)
92             _last_line = line
93         qtype, lastword, subs = _last_res
94         if iteration < len(subs):
95             path = subs[iteration]
96             leaf_name, leaf_item = path[-1]
97             res = vfs.try_resolve(repo, leaf_name, parent=path[:-1])
98             leaf_name, leaf_item = res[-1]
99             fullname = os.path.join(*(name for name, item in res))
100             if stat.S_ISDIR(vfs.item_mode(leaf_item)):
101                 ret = shquote.what_to_add(qtype, lastword, fullname + b'/',
102                                           terminate=False)
103             else:
104                 ret = shquote.what_to_add(qtype, lastword, fullname,
105                                           terminate=True) + b' '
106             return text + ret
107     except Exception as e:
108         log('\n')
109         try:
110             import traceback
111             traceback.print_tb(sys.exc_traceback)
112         except Exception as e2:
113             log('Error printing traceback: %s\n' % e2)
114         log('\nError in completion: %s\n' % e)
115
116
117 optspec = """
118 bup ftp [commands...]
119 """
120
121 def main(argv):
122     o = options.Options(optspec)
123     opt, flags, extra = o.parse_bytes(argv[1:])
124
125     git.check_repo_or_die()
126
127     global repo
128
129     sys.stdout.flush()
130     out = byte_stream(sys.stdout)
131     stdin = byte_stream(sys.stdin)
132     repo = LocalRepo()
133     pwd = vfs.resolve(repo, b'/')
134     rv = 0
135
136     if extra:
137         lines = (argv_bytes(arg) for arg in extra)
138     else:
139         if hasattr(_helpers, 'readline'):
140             _helpers.set_completer_word_break_characters(b' \t\n\r/')
141             _helpers.set_attempted_completion_function(attempt_completion)
142             _helpers.set_completion_entry_function(enter_completion)
143             if sys.platform.startswith('darwin'):
144                 # MacOS uses a slightly incompatible clone of libreadline
145                 _helpers.parse_and_bind(b'bind ^I rl_complete')
146             _helpers.parse_and_bind(b'tab: complete')
147         lines = inputiter(stdin)
148
149     for line in lines:
150         if not line.strip():
151             continue
152         words = [word for (wordstart,word) in shquote.quotesplit(line)]
153         cmd = words[0].lower()
154         #log('execute: %r %r\n' % (cmd, parm))
155         try:
156             if cmd == b'ls':
157                 # FIXME: respect pwd (perhaps via ls accepting resolve path/parent)
158                 do_ls(repo, words[1:], out)
159                 out.flush()
160             elif cmd == b'cd':
161                 np = pwd
162                 for parm in words[1:]:
163                     res = vfs.resolve(repo, parm, parent=np)
164                     _, leaf_item = res[-1]
165                     if not leaf_item:
166                         raise Exception('%s does not exist'
167                                         % path_msg(b'/'.join(name for name, item
168                                                              in res)))
169                     if not stat.S_ISDIR(vfs.item_mode(leaf_item)):
170                         raise Exception('%s is not a directory' % path_msg(parm))
171                     np = res
172                 pwd = np
173             elif cmd == b'pwd':
174                 if len(pwd) == 1:
175                     out.write(b'/')
176                 out.write(b'/'.join(name for name, item in pwd) + b'\n')
177                 out.flush()
178             elif cmd == b'cat':
179                 for parm in words[1:]:
180                     res = vfs.resolve(repo, parm, parent=pwd)
181                     _, leaf_item = res[-1]
182                     if not leaf_item:
183                         raise Exception('%s does not exist' %
184                                         path_msg(b'/'.join(name for name, item
185                                                            in res)))
186                     with vfs.fopen(repo, leaf_item) as srcfile:
187                         write_to_file(srcfile, out)
188                 out.flush()
189             elif cmd == b'get':
190                 if len(words) not in [2,3]:
191                     rv = 1
192                     raise Exception('Usage: get <filename> [localname]')
193                 rname = words[1]
194                 (dir,base) = os.path.split(rname)
195                 lname = len(words) > 2 and words[2] or base
196                 res = vfs.resolve(repo, rname, parent=pwd)
197                 _, leaf_item = res[-1]
198                 if not leaf_item:
199                     raise Exception('%s does not exist' %
200                                     path_msg(b'/'.join(name for name, item in res)))
201                 with vfs.fopen(repo, leaf_item) as srcfile:
202                     with open(lname, 'wb') as destfile:
203                         log('Saving %s\n' % path_msg(lname))
204                         write_to_file(srcfile, destfile)
205             elif cmd == b'mget':
206                 for parm in words[1:]:
207                     dir, base = os.path.split(parm)
208
209                     res = vfs.resolve(repo, dir, parent=pwd)
210                     _, dir_item = res[-1]
211                     if not dir_item:
212                         raise Exception('%s does not exist' % path_msg(dir))
213                     for name, item in vfs.contents(repo, dir_item):
214                         if name == b'.':
215                             continue
216                         if fnmatch.fnmatch(name, base):
217                             if stat.S_ISLNK(vfs.item_mode(item)):
218                                 deref = vfs.resolve(repo, name, parent=res)
219                                 deref_name, deref_item = deref[-1]
220                                 if not deref_item:
221                                     raise Exception('%s does not exist' %
222                                                     path_msg('/'.join(name for name, item
223                                                                       in deref)))
224                                 item = deref_item
225                             with vfs.fopen(repo, item) as srcfile:
226                                 with open(name, 'wb') as destfile:
227                                     log('Saving %s\n' % path_msg(name))
228                                     write_to_file(srcfile, destfile)
229             elif cmd == b'help' or cmd == b'?':
230                 out.write(b'Commands: ls cd pwd cat get mget help quit\n')
231                 out.flush()
232             elif cmd in (b'quit', b'exit', b'bye'):
233                 break
234             else:
235                 rv = 1
236                 raise Exception('no such command %r' % cmd)
237         except Exception as e:
238             rv = 1
239             log('error: %s\n' % e)
240             raise
241
242     sys.exit(rv)