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
|
# Copyright (C) 2009, 2010 Roman Zimbelmann <romanz@lavabit.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
from collections import deque
from ranger.shared import FileManagerAware
from ranger.gui.widgets import console_mode as cmode
from ranger.ext.command_parser import LazyParser as parse
class Command(FileManagerAware):
"""Abstract command class"""
name = None
allow_abbrev = True
def __init__(self, line, mode):
self.line = line
self.mode = mode
def execute(self):
"""Override this"""
def tab(self):
"""Override this"""
def quick_open(self):
"""Override this"""
def _tab_only_directories(self):
from os.path import dirname, basename, expanduser, join, isdir
line = parse(self.line)
cwd = self.fm.env.cwd.path
try:
rel_dest = line.rest(1)
except IndexError:
rel_dest = ''
# expand the tilde into the user directory
if rel_dest.startswith('~'):
rel_dest = expanduser(rel_dest)
# define some shortcuts
abs_dest = join(cwd, rel_dest)
abs_dirname = dirname(abs_dest)
rel_basename = basename(rel_dest)
rel_dirname = dirname(rel_dest)
try:
# are we after a directory?
if rel_dest.endswith('/') or rel_dest == '':
_, dirnames, _ = os.walk(abs_dest).next()
# are we in the middle of the filename?
else:
_, dirnames, _ = os.walk(abs_dirname).next()
dirnames = [dn for dn in dirnames \
if dn.startswith(rel_basename)]
except (OSError, StopIteration):
# os.walk found nothing
pass
else:
dirnames.sort()
# no results, return None
if len(dirnames) == 0:
return
# one result. since it must be a directory, append a slash.
if len(dirnames) == 1:
return line + join(rel_dirname, dirnames[0]) + '/'
# more than one result. append no slash, so the user can
# manually type in the slash to advance into that directory
return (line + join(rel_dirname, dirname) for dirname in dirnames)
def _tab_directory_content(self):
from os.path import dirname, basename, expanduser, join, isdir
line = parse(self.line)
cwd = self.fm.env.cwd.path
try:
rel_dest = line.rest(1)
except IndexError:
rel_dest = ''
# expand the tilde into the user directory
if rel_dest.startswith('~'):
rel_dest = expanduser(rel_dest)
# define some shortcuts
abs_dest = join(cwd, rel_dest)
abs_dirname = dirname(abs_dest)
rel_basename = basename(rel_dest)
rel_dirname = dirname(rel_dest)
try:
# are we after a directory?
if rel_dest.endswith('/') or rel_dest == '':
_, dirnames, filenames = os.walk(abs_dest).next()
names = dirnames + filenames
# are we in the middle of the filename?
else:
_, dirnames, filenames = os.walk(abs_dirname).next()
names = [name for name in (dirnames + filenames) \
if name.startswith(rel_basename)]
except (OSError, StopIteration):
# os.walk found nothing
pass
else:
names.sort()
# no results, return None
if len(names) == 0:
return
# one result. since it must be a directory, append a slash.
if len(names) == 1:
return line + join(rel_dirname, names[0]) + '/'
# more than one result. append no slash, so the user can
# manually type in the slash to advance into that directory
return (line + join(rel_dirname, name) for name in names)
# -------------------------------- definitions
class cd(Command):
"""
:cd <dirname>
The cd command changes the directory.
The command 'cd -' is equivalent to typing ``.
In the quick console, the directory will be entered without the
need to press enter, as soon as there is one unambiguous match.
"""
def execute(self):
line = parse(self.line)
try:
destination = line.rest(1)
except IndexError:
destination = '~'
if destination == '-':
self.fm.enter_bookmark('`')
else:
self.fm.cd(destination)
def tab(self):
return self._tab_only_directories()
def quick_open(self):
from os.path import isdir, join, normpath
line = parse(self.line)
cwd = self.fm.env.cwd.path
rel_dest = line.rest(1)
if not rel_dest:
return False
abs_dest = normpath(join(cwd, rel_dest))
return rel_dest != '.' and isdir(abs_dest)
class find(Command):
"""
:find <string>
The find command will attempt to find a partial, case insensitive
match in the filenames of the current directory.
In the quick command console, once there is one unambiguous match,
the file will be run automatically.
"""
count = 0
tab = Command._tab_directory_content
def execute(self):
if self.mode != cmode.COMMAND_QUICK:
self._search()
import re
search = parse(self.line).rest(1)
search = re.escape(search)
self.fm.env.last_search = re.compile(search, re.IGNORECASE)
self.fm.search_method = 'search'
if self.count == 1:
self.fm.move_right()
self.fm.block_input(0.5)
def quick_open(self):
self._search()
if self.count == 1:
return True
def _search(self):
self.count = 0
line = parse(self.line)
cwd = self.fm.env.cwd
try:
arg = line.rest(1)
except IndexError:
return False
deq = deque(cwd.files)
deq.rotate(-cwd.pointer)
i = 0
for fsobj in deq:
filename = fsobj.basename_lower
if arg in filename:
self.count += 1
if self.count == 1:
cwd.move(absolute=(cwd.pointer + i) % len(cwd.files))
self.fm.env.cf = cwd.pointed_obj
if self.count > 1:
return False
i += 1
return self.count == 1
class quit(Command):
"""
:quit
Closes the current tab. If there is only one tab, quit the program.
"""
def execute(self):
if len(self.fm.tabs) <= 1:
self.fm.exit()
self.fm.tab_close()
class quit_now(Command):
"""
:quit!
Quits the program immediately.
"""
name = 'quit!'
def execute(self):
self.fm.exit()
class delete(Command):
"""
:delete
Tries to delete the selection.
"Selection" is defined as all the "marked files" (by default, you
can mark files with space or v). If there are no marked files,
use the "current file" (where the cursor is)
When attempting to delete non-empty directories or multiple
marked files, it will require a confirmation: The last word in
the line has to start with a 'y'. This may look like:
:delete yes
:delete seriously? yeah!
"""
allow_abbrev = False
WARNING = 'delete seriously? '
def execute(self):
line = parse(self.line)
lastword = line.chunk(-1)
if lastword.startswith('y'):
# user confirmed deletion!
return self.fm.delete()
elif self.line.startswith(delete.WARNING):
# user did not confirm deletion
return
cwd = self.fm.env.cwd
cf = self.fm.env.cf
if cwd.marked_items or (cf.is_directory and not cf.islink \
and len(os.listdir(cf.path)) > 0):
# better ask for a confirmation, when attempting to
# delete multiple files or a non-empty directory.
return self.fm.open_console(self.mode, delete.WARNING)
# no need for a confirmation, just delete
self.fm.delete()
class mkdir(Command):
"""
:mkdir <dirname>
Creates a directory with the name <dirname>.
"""
def execute(self):
from os.path import join, expanduser, lexists
from os import mkdir
line = parse(self.line)
dirname = join(self.fm.env.cwd.path, expanduser(line.rest(1)))
if not lexists(dirname):
mkdir(dirname)
else:
self.fm.notify("file/directory exists!", bad=True)
class touch(Command):
"""
:touch <fname>
Creates a file with the name <fname>.
"""
def execute(self):
from os.path import join, expanduser, lexists
from os import mkdir
line = parse(self.line)
fname = join(self.fm.env.cwd.path, expanduser(line.rest(1)))
if not lexists(fname):
open(fname, 'a')
else:
self.fm.notify("file/directory exists!", bad=True)
class edit(Command):
"""
:edit <filename>
Opens the specified file in vim
"""
def execute(self):
line = parse(self.line)
self.fm.edit_file(line.rest(1))
def tab(self):
return self._tab_directory_content()
class eval_(Command):
"""
:eval <python code>
Evaluates the python code.
`fm' is a reference to the FM instance.
To display text, use the function `p'.
Examples:
:eval fm
:eval len(fm.env.directories)
:eval p("Hello World!")
"""
name = 'eval'
def execute(self):
code = parse(self.line).rest(1)
fm = self.fm
p = fm.notify
try:
try:
result = eval(code)
except SyntaxError:
exec(code)
else:
if result:
p(result)
except Exception as err:
p(err)
class rename(Command):
"""
:rename <newname>
Changes the name of the currently highlighted file to <newname>
"""
def execute(self):
from ranger.fsobject.file import File
line = parse(self.line)
if not line.rest(1):
return self.fm.notify('Syntax: rename <newname>', bad=True)
self.fm.rename(self.fm.env.cf, line.rest(1))
f = File(line.rest(1))
self.fm.env.cwd.pointed_obj = f
self.fm.env.cf = f
def tab(self):
return self._tab_directory_content()
class chmod(Command):
"""
:chmod <octal number>
Sets the permissions of the selection to the octal number.
The octal number is between 0 and 777. The digits specify the
permissions for the user, the group and others.
A 1 permits execution, a 2 permits writing, a 4 permits reading.
Add those numbers to combine them. So a 7 permits everything.
"""
def execute(self):
line = parse(self.line)
mode = line.rest(1)
try:
mode = int(mode, 8)
if mode < 0 or mode > 511:
raise ValueError
except ValueError:
self.fm.notify("Need an octal number between 0 and 777!", bad=True)
return
for file in self.fm.env.get_selection():
try:
os.chmod(file.path, mode)
except Exception as ex:
self.fm.notify(ex)
try:
# reloading directory. maybe its better to reload the selected
# files only.
self.fm.env.cwd.load_content()
except:
pass
class filter(Command):
"""
:filter <string>
Displays only the files which contain <string> in their basename.
"""
def execute(self):
line = parse(self.line)
self.fm.set_filter(line.rest(1))
class grep(Command):
"""
:grep <string>
Looks for a string in all marked files or directories
"""
def execute(self):
line = parse(self.line)
if line.rest(1):
action = ['grep', '--color=always', '--line-number']
action.extend(['-e', line.rest(1), '-r'])
action.extend(f.path for f in self.fm.env.get_selection())
self.fm.execute_command(action, flags='p')
# -------------------------------- rest
by_name = {}
for varname, var in vars().copy().items():
try:
if issubclass(var, Command) and var != Command:
by_name[var.name or varname] = var
except TypeError:
pass
del varname
del var
def alias(**kw):
"""Create an alias for commands, eg: alias(quit=exit)"""
for key, value in kw.items():
by_name[key] = value
def get_command(name, abbrev=True):
if abbrev:
lst = [cls for cmd, cls in by_name.items() \
if cmd.startswith(name) \
and cls.allow_abbrev \
or cmd == name]
if len(lst) == 0:
raise KeyError
if len(lst) == 1 or by_name[name] in lst:
return lst[0]
raise ValueError("Ambiguous command")
else:
try:
return by_name[name]
except KeyError:
return None
def command_generator(start):
return (cmd + ' ' for cmd in by_name if cmd.startswith(start))
alias(e=edit, q=quit) # for unambiguity
alias(**{'q!':quit_now})
alias(qall=quit_now)
|