-
Notifications
You must be signed in to change notification settings - Fork 329
/
execution.py
581 lines (477 loc) · 19.7 KB
/
execution.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
import io
import json
import re
import os
import sys
from urllib.parse import urlparse, urljoin
import click
from subprocess import CalledProcessError, Popen, PIPE
from httpie.context import Environment
from httpie.core import main as httpie_main
from parsimonious.exceptions import ParseError, VisitationError
from parsimonious.grammar import Grammar
from parsimonious.nodes import NodeVisitor
from parsimonious.nodes import Node
from pygments.token import String, Name
from .completion import ROOT_COMMANDS, ACTIONS, OPTION_NAMES, HEADER_NAMES
from .context import Context
from .context.transform import (
extract_args_for_httpie_main,
format_to_curl,
format_to_httpie,
format_to_http_prompt)
from .output import Printer, TextWriter
from .utils import unescape, unquote, colformat
HTTPIE_PROGRAM_NAME = 'http'
grammar = r"""
command = mutation / immutation
mutation = concat_mut+ / nonconcat_mut
immutation = preview / action / ls / env / help / exit / exec / source / clear / _
concat_mut = option_mut / full_quoted_mut / value_quoted_mut / unquoted_mut
nonconcat_mut = cd / rm
preview = _ tool _ (method _)? (urlpath _)? concat_mut* redir_out? _
action = _ method _ (urlpath _)? concat_mut* redir_out? _
urlpath = (~r"https?://" unquoted_string) /
(!concat_mut !redir_out string)
clear = _ "clear" _
help = _ "help" _
exit = _ "exit" _
ls = _ "ls" _ (urlpath _)? (redir_out)?
env = _ "env" _ (redir_out)?
source = _ "source" _ filepath _
exec = _ "exec" _ filepath _
redir_out = redir_append / redir_write / pipe
redir_append = _ ">>" _ filepath _
redir_write = _ ">" _ filepath _
pipe = _ "|" _ (shell_subs / shell_code) _
unquoted_mut = _ unquoted_mutkey mutop unquoted_mutval _
full_quoted_mut = full_squoted_mut / full_dquoted_mut
value_quoted_mut = value_squoted_mut / value_dquoted_mut
full_squoted_mut = _ "'" squoted_mutkey mutop squoted_mutval "'" _
full_dquoted_mut = _ '"' dquoted_mutkey mutop dquoted_mutval '"' _
value_squoted_mut = _ unquoted_mutkey mutop "'" squoted_mutval "'" _
value_dquoted_mut = _ unquoted_mutkey mutop '"' dquoted_mutval '"' _
mutop = ":=" / ":" / "==" / "="
unquoted_mutkey = unquoted_mutkey_item+
unquoted_mutval = unquoted_stringitem*
unquoted_mutkey_item = shell_subs / unquoted_mutkey_char / escapeseq
unquoted_mutkey_char = ~r"[^\s'\"\\=:>]"
squoted_mutkey = squoted_mutkey_item+
squoted_mutval = squoted_stringitem*
squoted_mutkey_item = shell_subs / squoted_mutkey_char / escapeseq
squoted_mutkey_char = ~r"[^\r\n'\\=:]"
dquoted_mutkey = dquoted_mutkey_item+
dquoted_mutval = dquoted_stringitem*
dquoted_mutkey_item = shell_subs / dquoted_mutkey_char / escapeseq
dquoted_mutkey_char = ~r'[^\r\n"\\=:]'
option_mut = flag_option_mut / value_option_mut
flag_option_mut = _ flag_optname _
flag_optname = "--json" / "-j" / "--form" / "-f" / "--verbose" / "-v" /
"--headers" / "-h" / "--body" / "-b" / "--stream" / "-S" /
"--download" / "-d" / "--continue" / "-c" / "--follow" /
"--check-status" / "--ignore-stdin" / "--help" /
"--version" / "--traceback" / "--debug"
value_option_mut = _ value_optname ~r"(\s+|=)" string _
value_optname = "--pretty" / "--style" / "-s" / "--print" / "-p" /
"--output" / "-o" / "--session-read-only" / "--session" /
"--auth-type" / "--auth" / "-a" / "--proxy" / "--verify" /
"--cert" / "--cert-key" / "--timeout"
cd = _ "cd" _ string? _
rm = (_ "rm" _ "*" _) / (_ "rm" _ ~r"\-(h|q|b|o)" _ mutkey _)
tool = "httpie" / "curl"
method = ~r"get"i / ~r"head"i / ~r"post"i / ~r"put"i / ~r"delete"i /
~r"patch"i / ~r"options"i / ~r"connect"i
mutkey = unquoted_mutkey / ("'" squoted_mutkey "'") /
('"' dquoted_mutkey '"') / flag_optname / value_optname
string = quoted_string / unquoted_string
quoted_string = ('"' dquoted_stringitem* '"') /
("'" squoted_stringitem* "'")
unquoted_string = unquoted_stringitem+
dquoted_stringitem = shell_subs / dquoted_stringchar / escapeseq
squoted_stringitem = shell_subs / squoted_stringchar / escapeseq
unquoted_stringitem = shell_subs / unquoted_stringchar / escapeseq
dquoted_stringchar = ~r'[^\r\n"\\]'
squoted_stringchar = ~r"[^\r\n'\\]"
unquoted_stringchar = ~r"[^\s'\\]"
escapeseq = ~r"\\."
_ = ~r"\s*"
shell_subs = "`" shell_code "`"
shell_code = ~r"[^`]*"
"""
if sys.platform == 'win32':
# XXX: Windows use backslashes as separators in its filesystem path, so we
# have to avoid using backslashes to escape chars here.
grammar += r"""
filepath = quoted_filepath / unquoted_filepath
quoted_filepath = ('"' dquoted_filepath_char+ '"') /
("'" squoted_filepath_char+ "'")
dquoted_filepath_char = ~r'[^\r\n"]'
squoted_filepath_char = ~r"[^\r\n']"
unquoted_filepath = unquoted_filepath_char+
unquoted_filepath_char = ~r"[^\s\"]"
"""
else:
grammar += r"""
filepath = string
"""
grammar = Grammar(grammar)
if Environment.colors == 256:
from pygments.formatters.terminal256 import (
Terminal256Formatter as TerminalFormatter)
else:
from pygments.formatters.terminal import TerminalFormatter
def urljoin2(base, path, **kwargs):
if not base.endswith('/'):
base += '/'
url = urljoin(base, path, **kwargs)
if url.endswith('/') and not path.endswith('/'):
url = url[:-1]
return url
def generate_help_text():
"""Return a formatted string listing commands, HTTPie options, and HTTP
actions.
"""
def generate_cmds_with_explanations(summary, cmds):
text = '{0}:\n'.format(summary)
for cmd, explanation in cmds:
text += '\t{0:<10}\t{1:<20}\n'.format(cmd, explanation)
return text + '\n'
text = generate_cmds_with_explanations('Commands', ROOT_COMMANDS.items())
text += generate_cmds_with_explanations('Options', OPTION_NAMES.items())
text += generate_cmds_with_explanations('Actions', ACTIONS.items())
text += generate_cmds_with_explanations('Headers', HEADER_NAMES.items())
return text
if sys.platform == 'win32': # nocover
def normalize_filepath(path):
return unquote(path)
else:
def normalize_filepath(path):
return unescape(unquote(path))
class DummyExecutionListener(object):
def context_changed(self, context):
pass
def response_returned(self, context, response):
pass
class ExecutionVisitor(NodeVisitor):
unwrapped_exceptions = (CalledProcessError,)
def __init__(self, context, listener=None, style=None):
super(ExecutionVisitor, self).__init__()
self.context = context
self.context_override = Context(context.url)
self.method = None
self.tool = None
self._output = Printer()
# If there's a pipe, as in "httpie post | sed s/POST/GET/", this
# variable points to the "sed" Popen object. The variable is necessary
# because the we need to redirect Popen.stdout to Printer, which does
# output pagination.
self.pipe_proc = None
self.listener = listener or DummyExecutionListener()
# Last response object returned by HTTPie
self.last_response = None
# Pygments formatter, used to render output with colors in some cases
if style:
self.formatter = TerminalFormatter(style=style)
else:
self.formatter = None
@property
def output(self):
return self._output
@output.setter
def output(self, new_output):
if self._output:
self._output.close()
self._output = new_output
def visit_method(self, node, children):
self.method = node.text
return node
def visit_urlpath(self, node, children):
path = node.text
self.context_override.url = urljoin2(self.context_override.url, path)
return node
def visit_cd(self, node, children):
_, _, _, path, _ = children
if isinstance(path, Node):
seg = urlparse(self.context_override.url)
self.context_override.url = seg.scheme + "://" + seg.netloc
else:
self.context_override.url = urljoin2(
self.context_override.url, path)
return node
def visit_rm(self, node, children):
children = children[0]
kind = children[3].text
if kind == '*':
# Clear context
for target in [self.context.headers,
self.context.querystring_params,
self.context.body_params,
self.context.body_json_params,
self.context.options]:
target.clear()
return node
name = children[5]
if kind == '-h':
target = self.context.headers
elif kind == '-q':
target = self.context.querystring_params
elif kind == '-o':
target = self.context.options
else:
assert kind == '-b'
# TODO: This is kind of ugly, will fix it
if name == '*':
self.context.body_params.clear()
self.context.body_json_params.clear()
else:
try:
del self.context.body_params[name]
except KeyError:
del self.context.body_json_params[name]
return node
if name == '*':
target.clear()
else:
del target[name]
return node
def visit_help(self, node, children):
self.output.write(generate_help_text())
return node
def _redirect_output(self, filepath, mode):
filepath = normalize_filepath(filepath)
self.output = TextWriter(open(os.path.expandvars(filepath), mode))
def visit_redir_append(self, node, children):
self._redirect_output(children[3], 'ab')
return node
def visit_redir_write(self, node, children):
self._redirect_output(children[3], 'wb')
return node
def visit_pipe(self, node, children):
cmd = children[3]
self.pipe_proc = Popen(cmd, shell=True, stdin=PIPE, stdout=PIPE)
self.output = TextWriter(self.pipe_proc.stdin)
return node
def visit_exec(self, node, children):
path = normalize_filepath(children[3])
with io.open(path, encoding='utf-8') as f:
# Wipe out context first
execute('rm *', self.context, self.listener)
for line in f:
execute(line, self.context, self.listener)
return node
def visit_source(self, node, children):
path = normalize_filepath(children[3])
with io.open(path, encoding='utf-8') as f:
for line in f:
execute(line, self.context, self.listener)
return node
def _colorize(self, text, token_type):
if not self.formatter:
return text
out = io.StringIO()
self.formatter.format([(token_type, text)], out)
return out.getvalue()
def visit_ls(self, node, children):
path = urlparse(self.context_override.url).path
path = filter(None, path.split('/'))
nodes = self.context.root.ls(*path)
if self.output.isatty():
names = []
for node in nodes:
token_type = String if node.data.get('type') == 'dir' else Name
name = self._colorize(node.name, token_type)
names.append(name)
lines = list(colformat(list(names)))
else:
lines = [n.name for n in nodes]
if lines:
self.output.write('\n'.join(lines))
return node
def visit_env(self, node, children):
text = format_to_http_prompt(self.context)
self.output.write(text)
return node
def visit_exit(self, node, children):
self.context.should_exit = True
return node
def visit_clear(self, node, children):
self.output.clear()
return node
def visit_mutkey(self, node, children):
if isinstance(children[0], list):
return children[0][1]
return children[0]
def _mutate(self, node, key, op, val):
if op == ':=':
self.context_override.body_json_params[key] = json.loads(val)
elif op == ':':
self.context_override.headers[key] = val
elif op == '=':
self.context_override.body_params[key] = val
elif op == '==':
# You can have multiple querystring params with the same name,
# so we use a list to store multiple values (#20)
params = self.context_override.querystring_params
if key not in params:
params[key] = [val]
else:
params[key].append(val)
return node
def visit_unquoted_mut(self, node, children):
_, key, op, val, _ = children
return self._mutate(node, key, op, val)
def visit_full_squoted_mut(self, node, children):
_, _, key, op, val, _, _ = children
return self._mutate(node, key, op, val)
def visit_full_dquoted_mut(self, node, children):
_, _, key, op, val, _, _ = children
return self._mutate(node, key, op, val)
def visit_value_squoted_mut(self, node, children):
_, key, op, _, val, _, _ = children
return self._mutate(node, key, op, val)
def visit_value_dquoted_mut(self, node, children):
_, key, op, _, val, _, _ = children
return self._mutate(node, key, op, val)
def _visit_mut_key_or_val(self, node, children):
return unescape(''.join([c for c in children]), exclude=':=')
visit_unquoted_mutkey = _visit_mut_key_or_val
visit_unquoted_mutval = _visit_mut_key_or_val
visit_squoted_mutkey = _visit_mut_key_or_val
visit_squoted_mutval = _visit_mut_key_or_val
visit_dquoted_mutkey = _visit_mut_key_or_val
visit_dquoted_mutval = _visit_mut_key_or_val
def visit_mutop(self, node, children):
return node.text
def visit_flag_option_mut(self, node, children):
_, key, _ = children
self.context_override.options[key] = None
return node
def visit_flag_optname(self, node, children):
return node.text
def visit_value_option_mut(self, node, children):
_, key, _, val, _ = children
self.context_override.options[key] = val
return node
def visit_value_optname(self, node, children):
return node.text
def visit_filepath(self, node, children):
return children[0]
def visit_string(self, node, children):
return children[0]
def visit_quoted_filepath(self, node, children):
return node.text[1:-1]
def visit_unquoted_filepath(self, node, children):
return node.text
def visit_unquoted_string(self, node, children):
return unescape(''.join(children))
def visit_quoted_string(self, node, children):
return self._visit_mut_key_or_val(node, children[0][1])
def _visit_stringitem(self, node, children):
child = children[0]
if hasattr(child, 'text'):
return child.text
return child
visit_unquoted_mutkey_item = _visit_stringitem
visit_unquoted_stringitem = _visit_stringitem
visit_squoted_mutkey_item = _visit_stringitem
visit_squoted_stringitem = _visit_stringitem
visit_dquoted_mutkey_item = _visit_stringitem
visit_dquoted_stringitem = _visit_stringitem
def visit_tool(self, node, children):
self.tool = node.text
return node
def visit_mutation(self, node, children):
self.context.update(self.context_override)
self.listener.context_changed(self.context)
return node
def _final_context(self):
context = self.context.copy()
context.update(self.context_override)
return context
def _trace_get_response(self, frame, event, arg):
func_name = frame.f_code.co_name
if func_name == 'get_response':
if event == 'call':
return self._trace_get_response
elif event == 'return':
self.last_response = arg
def _call_httpie_main(self):
context = self._final_context()
args = extract_args_for_httpie_main(context, self.method)
env = Environment(stdout=self.output, stdin=sys.stdin,
is_windows=False)
env.stdout_isatty = self.output.isatty()
env.stdin_isatty = sys.stdin.isatty()
# XXX: httpie_main() doesn't provide an API for us to get the
# HTTP response object, so we use this super dirty hack -
# sys.settrace() to intercept get_response() that is called in
# httpie_main() internally. The HTTP response intercepted is
# assigned to self.last_response, which self.listener may be
# interested in.
sys.settrace(self._trace_get_response)
try:
httpie_main([HTTPIE_PROGRAM_NAME, *args], env=env)
finally:
sys.settrace(None)
def visit_immutation(self, node, children):
self.output.close()
if self.pipe_proc:
Printer().write(self.pipe_proc.stdout.read())
return node
def visit_preview(self, node, children):
context = self._final_context()
if self.tool == 'httpie':
command = format_to_httpie(context, self.method)
else:
assert self.tool == 'curl'
command = format_to_curl(context, self.method)
self.output.write(command)
return node
def visit_action(self, node, children):
self._call_httpie_main()
if self.last_response:
self.listener.response_returned(self.context, self.last_response)
return node
def visit_shell_subs(self, node, children):
cmd = children[1]
p = Popen(cmd, shell=True, stdout=PIPE)
return p.stdout.read().decode('utf-8').rstrip()
def visit_shell_code(self, node, children):
return node.text
def generic_visit(self, node, children):
if not node.expr_name and node.children:
if len(children) == 1:
return children[0]
return children
return node
def execute(command, context, listener=None, style=None):
try:
root = grammar.parse(command)
except ParseError as err:
# TODO: Better error message
part = command[err.pos:err.pos + 10]
click.secho('Syntax error near "%s"' % part, err=True, fg='red')
else:
visitor = ExecutionVisitor(context, listener=listener, style=style)
try:
visitor.visit(root)
except VisitationError as err:
exc_class = err.original_class
if exc_class is KeyError:
# XXX: Need to parse VisitationError error message to get the
# original error message as VisitationError doesn't hold the
# original exception object
key = re.search(r"KeyError: u?'(.*)'", str(err)).group(1)
click.secho("Key '%s' not found" % key, err=True,
fg='red')
elif issubclass(exc_class, IOError):
msg = str(err).splitlines()[0]
# Remove the exception class name at the beginning
msg = msg[msg.find(':') + 2:]
click.secho(msg, err=True, fg='red')
else:
# TODO: Better error message
click.secho(str(err), err=True, fg='red')
except CalledProcessError as err:
click.secho(err.output + ' (exit status %d)' % err.returncode,
fg='red')