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
|
#!/usr/bin/python
# This file is part of ranger, the console file manager.
# License: GNU GPL version 3, see the file "AUTHORS" for details.
"""rifle, the file executor/opener of ranger
This can be used as a standalone program or can be embedded in python code.
When used together with ranger, it doesn't have to be installed to $PATH.
Example usage:
rifle = Rifle("rifle.conf")
rifle.reload_config()
rifle.execute(["file1", "file2"])
"""
import os.path
import re
from subprocess import Popen, PIPE
import sys
__version__ = 'rifle 1.7.1'
# Options and constants that a user might want to change:
DEFAULT_PAGER = 'less'
DEFAULT_EDITOR = 'vim'
ASK_COMMAND = 'ask'
ENCODING = 'utf-8'
# Imports from ranger library, plus reimplementations in case ranger is not
# installed so rifle can be run as a standalone program.
try:
from ranger.ext.get_executables import get_executables
except ImportError:
_cached_executables = None
def get_executables():
"""Return all executable files in $PATH + Cache them."""
global _cached_executables
if _cached_executables is not None:
return _cached_executables
if 'PATH' in os.environ:
paths = os.environ['PATH'].split(':')
else:
paths = ['/usr/bin', '/bin']
from stat import S_IXOTH, S_IFREG
paths_seen = set()
_cached_executables = set()
for path in paths:
if path in paths_seen:
continue
paths_seen.add(path)
try:
content = os.listdir(path)
except OSError:
continue
for item in content:
abspath = path + '/' + item
try:
filestat = os.stat(abspath)
except OSError:
continue
if filestat.st_mode & (S_IXOTH | S_IFREG):
_cached_executables.add(item)
return _cached_executables
try:
from ranger.ext.popen_forked import Popen_forked
except ImportError:
def Popen_forked(*args, **kwargs):
"""Forks process and runs Popen with the given args and kwargs."""
try:
pid = os.fork()
except OSError:
return False
if pid == 0:
os.setsid()
kwargs['stdin'] = open(os.devnull, 'r')
kwargs['stdout'] = kwargs['stderr'] = open(os.devnull, 'w')
Popen(*args, **kwargs)
os._exit(0)
return True
def _is_terminal():
# Check if stdin (file descriptor 0), stdout (fd 1) and
# stderr (fd 2) are connected to a terminal
try:
os.ttyname(0)
os.ttyname(1)
os.ttyname(2)
except:
return False
return True
def squash_flags(flags):
"""Remove lowercase flags if the respective uppercase flag exists
>>> squash_flags('abc')
'abc'
>>> squash_flags('abcC')
'ab'
>>> squash_flags('CabcAd')
'bd'
"""
exclude = ''.join(f.upper() + f.lower() for f in flags if f == f.upper())
return ''.join(f for f in flags if f not in exclude)
class Rifle(object):
delimiter1 = '='
delimiter2 = ','
# TODO: Test all of the hooks properly
def hook_before_executing(self, command, mimetype, flags):
pass
def hook_after_executing(self, command, mimetype, flags):
pass
def hook_command_preprocessing(self, command):
return command
def hook_command_postprocessing(self, command):
return command
def hook_environment(self, env):
return env
def hook_logger(self, string):
sys.stderr.write(string + "\n")
def __init__(self, config_file):
self.config_file = config_file
self._app_flags = ''
self._app_label = None
self._initialized_mimetypes = False
# get paths for mimetype files
self._mimetype_known_files = [
os.path.expanduser("~/.mime.types")]
if __file__.endswith("ranger/ext/rifle.py"):
# Add ranger's default mimetypes when run from ranger directory
self._mimetype_known_files.append(
__file__.replace("ext/rifle.py", "data/mime.types"))
def reload_config(self, config_file=None):
"""Replace the current configuration with the one in config_file"""
if config_file is None:
config_file = self.config_file
f = open(config_file, 'r')
self.rules = []
lineno = 1
for line in f:
if line.startswith('#') or line == '\n':
continue
line = line.strip()
try:
if self.delimiter1 not in line:
raise Exception("Line without delimiter")
tests, command = line.split(self.delimiter1, 1)
tests = tests.split(self.delimiter2)
tests = tuple(tuple(f.strip().split(None, 1)) for f in tests)
command = command.strip()
self.rules.append((command, tests))
except Exception as e:
self.hook_logger("Syntax error in %s line %d (%s)" % \
(config_file, lineno, str(e)))
lineno += 1
f.close()
def _eval_condition(self, condition, files, label):
# Handle the negation of conditions starting with an exclamation mark,
# then pass on the arguments to _eval_condition2().
if not condition:
return True
if condition[0].startswith('!'):
new_condition = tuple([condition[0][1:]]) + tuple(condition[1:])
return not self._eval_condition2(new_condition, files, label)
return self._eval_condition2(condition, files, label)
def _eval_condition2(self, rule, files, label):
# This function evaluates the condition, after _eval_condition() handled
# negation of conditions starting with a "!".
if not files:
return False
function = rule[0]
argument = rule[1] if len(rule) > 1 else ''
if function == 'ext':
extension = os.path.basename(files[0]).rsplit('.', 1)[-1].lower()
return bool(re.search('^(' + argument + ')$', extension))
elif function == 'name':
return bool(re.search(argument, os.path.basename(files[0])))
elif function == 'match':
return bool(re.search(argument, files[0]))
elif function == 'file':
return os.path.isfile(files[0])
elif function == 'directory':
return os.path.isdir(files[0])
elif function == 'path':
return bool(re.search(argument, os.path.abspath(files[0])))
elif function == 'mime':
return bool(re.search(argument, self._get_mimetype(files[0])))
elif function == 'has':
if argument.startswith("$"):
if argument[1:] in os.environ:
return os.environ[argument[1:]] in get_executables()
return False
else:
return argument in get_executables()
elif function == 'terminal':
return _is_terminal()
elif function == 'number':
if argument.isdigit():
self._skip = int(argument)
return True
elif function == 'label':
self._app_label = argument
if label:
return argument == label
return True
elif function == 'flag':
self._app_flags = argument
return True
elif function == 'X':
return 'DISPLAY' in os.environ
elif function == 'env':
return bool(os.environ.get(argument))
elif function == 'else':
return True
def _get_mimetype(self, fname):
# Spawn "file" to determine the mime-type of the given file.
if self._mimetype:
return self._mimetype
import mimetypes
for path in self._mimetype_known_files:
if path not in mimetypes.knownfiles:
mimetypes.knownfiles.append(path)
self._mimetype, encoding = mimetypes.guess_type(fname)
if not self._mimetype:
process = Popen(["file", "--mime-type", "-Lb", fname],
stdout=PIPE, stderr=PIPE)
mimetype, _ = process.communicate()
self._mimetype = mimetype.decode(ENCODING).strip()
return self._mimetype
def _build_command(self, files, action, flags):
# Get the flags
if isinstance(flags, str):
self._app_flags += flags
self._app_flags = squash_flags(self._app_flags)
filenames = "' '".join(f.replace("'", "'\\\''") for f in files
if "\x00" not in f)
return "set -- '%s'; %s" % (filenames, action)
def list_commands(self, files, mimetype=None):
"""List all commands that are applicable for the given files
Returns one 4-tuple for all currently applicable commands
The 4-tuple contains (count, command, label, flags).
count is the index, counted from 0 upwards,
command is the command that will be executed.
label and flags are the label and flags specified in the rule.
"""
self._mimetype = mimetype
count = -1
for cmd, tests in self.rules:
self._skip = None
self._app_flags = ''
self._app_label = None
for test in tests:
if not self._eval_condition(test, files, None):
break
else:
if self._skip is None:
count += 1
else:
count = self._skip
yield (count, cmd, self._app_label, self._app_flags)
def execute(self, files, number=0, label=None, flags="", mimetype=None):
"""Executes the given list of files.
By default, this executes the first command where all conditions apply,
but by specifying number=N you can run the 1+Nth command.
If a label is specified, only rules with this label will be considered.
If you specify the mimetype, rifle will not try to determine it itself.
By specifying a flag, you extend the flag that is defined in the rule.
Uppercase flags negate the respective lowercase flags.
For example: if the flag in the rule is "pw" and you specify "Pf", then
the "p" flag is negated and the "f" flag is added, resulting in "wf".
"""
command = None
found_at_least_one = None
# Determine command
for count, cmd, lbl, flgs in self.list_commands(files, mimetype):
if label and label == lbl or not label and count == number:
cmd = self.hook_command_preprocessing(cmd)
if cmd == ASK_COMMAND:
return ASK_COMMAND
command = self._build_command(files, cmd, flags + flgs)
flags = self._app_flags
break
else:
found_at_least_one = True
else:
if label and label in get_executables():
cmd = '%s "$@"' % label
command = self._build_command(files, cmd, flags)
# Execute command
if command is None:
if found_at_least_one:
if label:
self.hook_logger("Label '%s' is undefined" % label)
else:
self.hook_logger("Method number %d is undefined." % number)
else:
self.hook_logger("No action found.")
else:
if 'PAGER' not in os.environ:
os.environ['PAGER'] = DEFAULT_PAGER
if 'EDITOR' not in os.environ:
os.environ['EDITOR'] = DEFAULT_EDITOR
command = self.hook_command_postprocessing(command)
self.hook_before_executing(command, self._mimetype, self._app_flags)
try:
if 'r' in flags:
prefix = ['sudo', '-E', 'su', '-mc']
else:
prefix = ['/bin/sh', '-c']
cmd = prefix + [command]
if 't' in flags:
if 'TERMCMD' not in os.environ:
term = os.environ['TERM']
if term.startswith('rxvt-unicode'):
term = 'urxvt'
if term not in get_executables():
self.hook_logger("Can not determine terminal command. "
"Please set $TERMCMD manually.")
# A fallback terminal that is likely installed:
term = 'xterm'
os.environ['TERMCMD'] = term
cmd = [os.environ['TERMCMD'], '-e'] + cmd
if 'f' in flags or 't' in flags:
Popen_forked(cmd, env=self.hook_environment(os.environ))
else:
p = Popen(cmd, env=self.hook_environment(os.environ))
p.wait()
finally:
self.hook_after_executing(command, self._mimetype, self._app_flags)
def main():
"""The main function which is run when you start this program direectly."""
import sys
# Find configuration file path
if 'XDG_CONFIG_HOME' in os.environ and os.environ['XDG_CONFIG_HOME']:
conf_path = os.environ['XDG_CONFIG_HOME'] + '/ranger/rifle.conf'
else:
conf_path = os.path.expanduser('~/.config/ranger/rifle.conf')
default_conf_path = conf_path
if not os.path.isfile(conf_path):
conf_path = os.path.normpath(os.path.join(os.path.dirname(__file__),
'../config/rifle.conf'))
if not os.path.isfile(conf_path):
try:
# if ranger is installed, get the configuration from ranger
import ranger
except ImportError:
pass
else:
conf_path = os.path.join(ranger.__path__[0], "config", "rifle.conf")
# Evaluate arguments
from optparse import OptionParser
parser = OptionParser(usage="%prog [-fhlpw] [files]", version=__version__)
parser.add_option('-f', type="string", default="", metavar="FLAGS",
help="use additional flags: f=fork, r=root, t=terminal. "
"Uppercase flag negates respective lowercase flags.")
parser.add_option('-l', action="store_true",
help="list possible ways to open the files (id:label:flags:command)")
parser.add_option('-p', type='string', default='0', metavar="KEYWORD",
help="pick a method to open the files. KEYWORD is either the "
"number listed by 'rifle -l' or a string that matches a label in "
"the configuration file")
parser.add_option('-w', type='string', default=None, metavar="PROGRAM",
help="open the files with PROGRAM")
options, positional = parser.parse_args()
if not positional:
parser.print_help()
raise SystemExit(1)
if not os.path.isfile(conf_path):
sys.stderr.write("Could not find a configuration file.\n"
"Please create one at %s.\n" % default_conf_path)
raise SystemExit(1)
if options.p.isdigit():
number = int(options.p)
label = None
else:
number = 0
label = options.p
if options.w is not None and not options.l:
p = Popen([options.w] + list(positional))
p.wait()
else:
# Start up rifle
rifle = Rifle(conf_path)
rifle.reload_config()
#print(rifle.list_commands(sys.argv[1:]))
if options.l:
for count, cmd, label, flags in rifle.list_commands(positional):
print("%d:%s:%s:%s" % (count, label or '', flags, cmd))
else:
result = rifle.execute(positional, number=number, label=label,
flags=options.f)
if result == ASK_COMMAND:
# TODO: implement interactive asking for file type?
print("Unknown file type: %s" % rifle._get_mimetype(positional[0]))
if __name__ == '__main__':
if 'RANGER_DOCTEST' in os.environ:
import doctest
doctest.testmod()
else:
main()
|