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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
|
# This file is part of ranger, the console file manager.
# License: GNU GPL version 3, see the file "AUTHORS" for details.
import codecs
import os
import re
import shutil
import string
import tempfile
from os.path import join, isdir, realpath, exists
from os import link, symlink, getcwd, listdir, stat
from inspect import cleandoc
from stat import S_IEXEC
from hashlib import sha1
from sys import version_info
import ranger
from ranger.ext.direction import Direction
from ranger.ext.relative_symlink import relative_symlink
from ranger.ext.keybinding_parser import key_to_string, construct_keybinding
from ranger.ext.shell_escape import shell_quote
from ranger.ext.next_available_filename import next_available_filename
from ranger.ext.rifle import squash_flags, ASK_COMMAND
from ranger.core.shared import FileManagerAware, SettingsAware
from ranger.core.tab import Tab
from ranger.container.directory import Directory
from ranger.container.file import File
from ranger.core.loader import CommandLoader, CopyLoader
from ranger.container.settings import ALLOWED_SETTINGS, ALLOWED_VALUES
from ranger.core.linemode import DEFAULT_LINEMODE
MACRO_FAIL = "<\x01\x01MACRO_HAS_NO_VALUE\x01\01>"
class _MacroTemplate(string.Template):
"""A template for substituting macros in commands"""
delimiter = ranger.MACRO_DELIMITER
idpattern = r"[_a-z0-9]*"
class Actions(FileManagerAware, SettingsAware):
# --------------------------
# -- Basic Commands
# --------------------------
def exit(self):
""":exit
Exit the program.
"""
raise SystemExit()
def reset(self):
""":reset
Reset the filemanager, clearing the directory buffer.
"""
old_path = self.thisdir.path
self.previews = {}
self.garbage_collect(-1)
self.enter_dir(old_path)
self.change_mode('normal')
if self.metadata:
self.metadata.reset()
def change_mode(self, mode):
""":change_mode <mode>
Change mode to "visual" (selection) or "normal" mode.
"""
if mode == self.mode:
return
if mode == 'visual':
self._visual_start = self.thisdir.pointed_obj
self._visual_start_pos = self.thisdir.pointer
self._previous_selection = set(self.thisdir.marked_items)
self.mark_files(val=not self._visual_reverse, movedown=False)
elif mode == 'normal':
if self.mode == 'visual':
self._visual_start = None
self._visual_start_pos = None
self._previous_selection = None
else:
return
self.mode = mode
self.ui.status.request_redraw()
def set_option_from_string(self, option_name, value, localpath=None, tags=None):
if option_name not in ALLOWED_SETTINGS:
raise ValueError("The option named `%s' does not exist" %
option_name)
if not isinstance(value, str):
raise ValueError("The value for an option needs to be a string.")
self.settings.set(option_name, self._parse_option_value(option_name, value), localpath, tags)
def _parse_option_value(self, name, value):
types = self.fm.settings.types_of(name)
if bool in types:
if value.lower() in ('false', 'off', '0'):
return False
elif value.lower() in ('true', 'on', '1'):
return True
if type(None) in types and value.lower() == 'none':
return None
if int in types:
try:
return int(value)
except ValueError:
pass
if str in types:
return value
if list in types:
return value.split(',')
raise ValueError("Invalid value `%s' for option `%s'!" % (name, value))
def toggle_visual_mode(self, reverse=False, narg=None):
""":toggle_visual_mode
Toggle the visual mode (see :change_mode).
"""
if self.mode == 'normal':
self._visual_reverse = reverse
if narg != None:
self.mark_files(val=not reverse, narg=narg)
self.change_mode('visual')
else:
self.change_mode('normal')
def reload_cwd(self):
""":reload_cwd
Reload the current working directory.
"""
try:
cwd = self.thisdir
except:
pass
else:
cwd.unload()
cwd.load_content()
def notify(self, text, duration=4, bad=False):
""":notify <text>
Display the text in the statusbar.
"""
if isinstance(text, Exception):
if ranger.arg.debug:
raise
bad = True
elif bad is True and ranger.arg.debug:
raise Exception(str(text))
text = str(text)
self.log.appendleft(text)
if self.ui and self.ui.is_on:
self.ui.status.notify(" ".join(text.split("\n")),
duration=duration, bad=bad)
else:
print(text)
def abort(self):
""":abort
Empty the first queued action.
"""
try:
item = self.loader.queue[0]
except:
self.notify("Type Q or :quit<Enter> to exit ranger")
else:
self.notify("Aborting: " + item.get_description())
self.loader.remove(index=0)
def get_cumulative_size(self):
for f in self.thistab.get_selection() or ():
f.look_up_cumulative_size()
self.ui.status.request_redraw()
self.ui.redraw_main_column()
def redraw_window(self):
""":redraw
Redraw the window.
"""
self.ui.redraw_window()
def open_console(self, string='', prompt=None, position=None):
""":open_console [string]
Open the console.
"""
self.change_mode('normal')
self.ui.open_console(string, prompt=prompt, position=position)
def execute_console(self, string='', wildcards=[], quantifier=None):
""":execute_console [string]
Execute a command for the console
"""
command_name = string.lstrip().split()[0]
cmd_class = self.commands.get_command(command_name, abbrev=False)
if cmd_class is None:
self.notify("Command not found: `%s'" % command_name, bad=True)
return
cmd = cmd_class(string)
if cmd.resolve_macros and _MacroTemplate.delimiter in string:
macros = dict(('any%d' % i, key_to_string(char)) \
for i, char in enumerate(wildcards))
if 'any0' in macros:
macros['any'] = macros['any0']
try:
string = self.substitute_macros(string, additional=macros,
escape=cmd.escape_macros_for_shell)
except ValueError as e:
if ranger.arg.debug:
raise
else:
return self.notify(e)
try:
cmd_class(string, quantifier=quantifier).execute()
except Exception as e:
if ranger.arg.debug:
raise
else:
self.notify(e)
def substitute_macros(self, string, additional=dict(), escape=False):
macros = self._get_macros()
macros.update(additional)
if escape:
for key, value in macros.items():
if isinstance(value, list):
macros[key] = " ".join(shell_quote(s) for s in value)
elif value != MACRO_FAIL:
macros[key] = shell_quote(value)
else:
for key, value in macros.items():
if isinstance(value, list):
macros[key] = " ".join(value)
result = _MacroTemplate(string).safe_substitute(macros)
if MACRO_FAIL in result:
raise ValueError("Could not apply macros to `%s'" % string)
return result
def _get_macros(self):
macros = {}
macros['rangerdir'] = ranger.RANGERDIR
macros['confdir'] = self.fm.confpath()
macros['space'] = ' '
if self.fm.thisfile:
macros['f'] = self.fm.thisfile.relative_path
else:
macros['f'] = MACRO_FAIL
if self.fm.thistab.get_selection:
macros['p'] = [os.path.join(self.fm.thisdir.path, fl.relative_path)
for fl in self.fm.thistab.get_selection()]
macros['s'] = [fl.relative_path for fl in self.fm.thistab.get_selection()]
else:
macros['p'] = MACRO_FAIL
macros['s'] = MACRO_FAIL
if self.fm.copy_buffer:
macros['c'] = [fl.path for fl in self.fm.copy_buffer]
else:
macros['c'] = MACRO_FAIL
if self.fm.thisdir.files:
macros['t'] = [fl.relative_path for fl in self.fm.thisdir.files
if fl.realpath in (self.fm.tags or [])]
else:
macros['t'] = MACRO_FAIL
if self.fm.thisdir:
macros['d'] = self.fm.thisdir.path
else:
macros['d'] = '.'
# define d/f/p/s macros for each tab
for i in range(1, 10):
try:
tab = self.fm.tabs[i]
except:
continue
tabdir = tab.thisdir
if not tabdir:
continue
i = str(i)
macros[i + 'd'] = tabdir.path
if tabdir.get_selection():
macros[i + 'p'] = [os.path.join(tabdir.path, fl.relative_path)
for fl in tabdir.get_selection()]
macros[i + 's'] = [fl.path for fl in tabdir.get_selection()]
else:
macros[i + 'p'] = MACRO_FAIL
macros[i + 's'] = MACRO_FAIL
if tabdir.pointed_obj:
macros[i + 'f'] = tabdir.pointed_obj.path
else:
macros[i + 'f'] = MACRO_FAIL
# define D/F/P/S for the next tab
found_current_tab = False
next_tab = None
first_tab = None
for tabname in self.fm.tabs:
if not first_tab:
first_tab = tabname
if found_current_tab:
next_tab = self.fm.tabs[tabname]
break
if self.fm.current_tab == tabname:
found_current_tab = True
if found_current_tab and next_tab is None:
next_tab = self.fm.tabs[first_tab]
next_tab_dir = next_tab.thisdir
if next_tab_dir:
macros['D'] = str(next_tab_dir.path)
if next_tab.thisfile:
macros['F'] = next_tab.thisfile.path
else:
macros['F'] = MACRO_FAIL
if next_tab_dir.get_selection():
macros['P'] = [os.path.join(next_tab.path, fl.path)
for fl in next_tab.get_selection()]
macros['S'] = [fl.path for fl in next_tab.get_selection()]
else:
macros['P'] = MACRO_FAIL
macros['S'] = MACRO_FAIL
else:
macros['D'] = MACRO_FAIL
macros['F'] = MACRO_FAIL
macros['S'] = MACRO_FAIL
return macros
def source(self, filename):
""":source <filename>
Load a config file.
"""
filename = os.path.expanduser(filename)
with open(filename, 'r') as f:
for line in f:
line = line.lstrip().rstrip("\r\n")
if line.startswith("#") or not line.strip():
continue
try:
self.execute_console(line)
except Exception as e:
if ranger.arg.debug:
raise
else:
self.notify('Error in line `%s\':\n %s' %
(line, str(e)), bad=True)
def execute_file(self, files, **kw):
"""Uses the "rifle" module to open/execute a file
Arguments are the same as for ranger.ext.rifle.Rifle.execute:
files: a list of file objects (not strings!)
number: a number to select which way to open the file, in case there
are multiple choices
label: a string to select an opening method by its label
flags: a string specifying additional options, see `man rifle`
mimetyle: pass the mimetype to rifle, overriding its own guess
"""
mode = kw['mode'] if 'mode' in kw else 0
# ranger can act as a file chooser when running with --choosefile=...
if mode == 0 and 'label' not in kw:
if ranger.arg.choosefile:
open(ranger.arg.choosefile, 'w').write(self.fm.thisfile.path)
if ranger.arg.choosefiles:
open(ranger.arg.choosefiles, 'w').write("".join(
f.path + "\n" for f in self.fm.thistab.get_selection()))
if ranger.arg.choosefile or ranger.arg.choosefiles:
raise SystemExit()
if isinstance(files, set):
files = list(files)
elif type(files) not in (list, tuple):
files = [files]
flags = kw.get('flags', '')
if 'c' in squash_flags(flags):
files = [self.fm.thisfile]
self.signal_emit('execute.before', keywords=kw)
filenames = [f.path for f in files]
label = kw.get('label', kw.get('app', None))
try:
return self.rifle.execute(filenames, mode, label, flags, None)
finally:
self.signal_emit('execute.after')
# --------------------------
# -- Moving Around
# --------------------------
def move(self, narg=None, **kw):
"""A universal movement method.
Accepts these parameters:
(int) down, (int) up, (int) left, (int) right, (int) to,
(bool) absolute, (bool) relative, (bool) pages,
(bool) percentage
to=X is translated to down=X, absolute=True
Example:
self.move(down=4, pages=True) # moves down by 4 pages.
self.move(to=2, pages=True) # moves to page 2.
self.move(to=1, percentage=True) # moves to 80%
"""
cwd = self.thisdir
direction = Direction(kw)
if 'left' in direction or direction.left() > 0:
steps = direction.left()
if narg is not None:
steps *= narg
try:
directory = os.path.join(*(['..'] * steps))
except:
return
self.thistab.enter_dir(directory)
self.change_mode('normal')
if cwd and cwd.accessible and cwd.content_loaded:
if 'right' in direction:
mode = 0
if narg is not None:
mode = narg
cf = self.thisfile
selection = self.thistab.get_selection()
if not self.thistab.enter_dir(cf) and selection:
result = self.execute_file(selection, mode=mode)
if result in (False, ASK_COMMAND):
self.open_console('open_with ')
elif direction.vertical() and cwd.files:
newpos = direction.move(
direction=direction.down(),
override=narg,
maximum=len(cwd),
current=cwd.pointer,
pagesize=self.ui.browser.hei)
cwd.move(to=newpos)
if self.mode == 'visual':
try:
startpos = cwd.index(self._visual_start)
except:
self._visual_start = None
startpos = min(self._visual_start_pos, len(cwd))
# The files between here and _visual_start_pos
targets = set(cwd.files[min(startpos, newpos):\
max(startpos, newpos) + 1])
# The selection before activating visual mode
old = self._previous_selection
# The current selection
current = set(cwd.marked_items)
# Set theory anyone?
if not self._visual_reverse:
for f in targets - current:
cwd.mark_item(f, True)
for f in current - old - targets:
cwd.mark_item(f, False)
else:
for f in targets & current:
cwd.mark_item(f, False)
for f in old - current - targets:
cwd.mark_item(f, True)
if self.ui.pager.visible:
self.display_file()
def move_parent(self, n, narg=None):
self.change_mode('normal')
if narg is not None:
n *= narg
parent = self.thistab.at_level(-1)
if parent is not None:
if parent.pointer + n < 0:
n = 0 - parent.pointer
try:
self.thistab.enter_dir(parent.files[parent.pointer+n])
except IndexError:
pass
def select_file(self, path):
path = path.strip()
if self.enter_dir(os.path.dirname(path)):
self.thisdir.move_to_obj(path)
def history_go(self, relative):
"""Move back and forth in the history"""
self.thistab.history_go(int(relative))
# TODO: remove this method since it is not used?
def scroll(self, relative):
"""Scroll down by <relative> lines"""
if self.ui.browser and self.ui.browser.main_column:
self.ui.browser.main_column.scroll(relative)
self.thisfile = self.thisdir.pointed_obj
def enter_dir(self, path, remember=False, history=True):
"""Enter the directory at the given path"""
cwd = self.thisdir
# csh variable is lowercase
cdpath = os.environ.get('CDPATH', None) or os.environ.get('cdpath', None)
result = self.thistab.enter_dir(path, history=history)
if result is False and cdpath:
for p in cdpath.split(':'):
curpath = os.path.join(p, path)
if os.path.isdir(curpath):
result = self.thistab.enter_dir(curpath, history=history)
break
if cwd != self.thisdir:
if remember:
self.bookmarks.remember(cwd)
self.change_mode('normal')
return result
def cd(self, path, remember=True):
"""enter the directory at the given path, remember=True"""
self.enter_dir(path, remember=remember)
def traverse(self):
self.change_mode('normal')
cf = self.thisfile
cwd = self.thisdir
if cf is not None and cf.is_directory:
self.enter_dir(cf.path)
elif cwd.pointer >= len(cwd) - 1:
while True:
self.move(left=1)
cwd = self.thisdir
if cwd.pointer < len(cwd) - 1:
break
if cwd.path == '/':
break
self.move(down=1)
self.traverse()
else:
self.move(down=1)
self.traverse()
# --------------------------
# -- Shortcuts / Wrappers
# --------------------------
def pager_move(self, narg=None, **kw):
self.ui.get_pager().move(narg=narg, **kw)
def taskview_move(self, narg=None, **kw):
self.ui.taskview.move(narg=narg, **kw)
def pause_tasks(self):
self.loader.pause(-1)
def pager_close(self):
if self.ui.pager.visible:
self.ui.close_pager()
if hasattr(self.ui.browser, 'pager') and self.ui.browser.pager.visible:
self.ui.close_embedded_pager()
def taskview_open(self):
self.ui.open_taskview()
def taskview_close(self):
self.ui.close_taskview()
def execute_command(self, cmd, **kw):
return self.run(cmd, **kw)
def edit_file(self, file=None):
"""Calls execute_file with the current file and label='editor'"""
if file is None:
file = self.thisfile
elif isinstance(file, str):
file = File(os.path.expanduser(file))
if file is None:
return
self.execute_file(file, label='editor')
def toggle_option(self, string):
""":toggle_option <string>
Toggle a boolean option named <string>.
"""
if isinstance(self.settings[string], bool):
self.settings[string] ^= True
elif string in ALLOWED_VALUES:
current = self.settings[string]
allowed = ALLOWED_VALUES[string]
if len(allowed) > 0:
if current not in allowed and current == "":
current = allowed[0]
if current in allowed:
self.settings[string] = \
allowed[(allowed.index(current) + 1) % len(allowed)]
else:
self.settings[string] = allowed[0]
def set_option(self, optname, value):
""":set_option <optname>
Set the value of an option named <optname>.
"""
self.settings[optname] = value
def sort(self, func=None, reverse=None):
if reverse is not None:
self.settings['sort_reverse'] = bool(reverse)
if func is not None:
self.settings['sort'] = str(func)
def mark_files(self, all=False, toggle=False, val=None, movedown=None, narg=None):
"""A wrapper for the directory.mark_xyz functions.
Arguments:
all - change all files of the current directory at once?
toggle - toggle the marked-status?
val - mark or unmark?
"""
if self.thisdir is None:
return
cwd = self.thisdir
if not cwd.accessible:
return
if movedown is None:
movedown = not all
if val is None and toggle is False:
return
if narg == None:
narg = 1
else:
all = False
if all:
if toggle:
cwd.toggle_all_marks()
else:
cwd.mark_all(val)
if self.mode == 'visual':
self.change_mode('normal')
else:
for i in range(cwd.pointer, min(cwd.pointer + narg, len(cwd))):
item = cwd.files[i]
if item is not None:
if toggle:
cwd.toggle_mark(item)
else:
cwd.mark_item(item, val)
if movedown:
self.move(down=narg)
self.ui.redraw_main_column()
self.ui.status.need_redraw = True
def mark_in_direction(self, val=True, dirarg=None):
cwd = self.thisdir
direction = Direction(dirarg)
pos, selected = direction.select(lst=cwd.files, current=cwd.pointer,
pagesize=self.ui.termsize[0])
cwd.pointer = pos
cwd.correct_pointer()
for item in selected:
cwd.mark_item(item, val)
# --------------------------
# -- Searching
# --------------------------
def search_file(self, text, offset=1, regexp=True):
if isinstance(text, str) and regexp:
try:
text = re.compile(text, re.L | re.U | re.I)
except:
return False
self.thistab.last_search = text
self.search_next(order='search', offset=offset)
def search_next(self, order=None, offset=1, forward=True):
original_order = order
if order is None:
order = self.search_method
else:
self.set_search_method(order=order)
if order in ('search', 'tag'):
if order == 'search':
arg = self.thistab.last_search
if arg is None:
return False
if hasattr(arg, 'search'):
fnc = lambda x: arg.search(x.basename)
else:
fnc = lambda x: arg in x.basename
elif order == 'tag':
fnc = lambda x: x.realpath in self.tags
return self.thisdir.search_fnc(fnc=fnc, offset=offset, forward=forward)
elif order in ('size', 'mimetype', 'ctime', 'mtime', 'atime'):
cwd = self.thisdir
if original_order is not None or not cwd.cycle_list:
lst = list(cwd.files)
if order == 'size':
fnc = lambda item: -item.size
elif order == 'mimetype':
fnc = lambda item: item.mimetype or ''
elif order == 'ctime':
fnc = lambda item: -int(item.stat and item.stat.st_ctime)
elif order == 'atime':
fnc = lambda item: -int(item.stat and item.stat.st_atime)
elif order == 'mtime':
fnc = lambda item: -int(item.stat and item.stat.st_mtime)
lst.sort(key=fnc)
cwd.set_cycle_list(lst)
return cwd.cycle(forward=None)
return cwd.cycle(forward=forward)
def set_search_method(self, order, forward=True):
if order in ('search', 'tag', 'size', 'mimetype', 'ctime',
'mtime', 'atime'):
self.search_method = order
# --------------------------
# -- Tags
# --------------------------
# Tags are saved in ~/.config/ranger/tagged and simply mark if a
# file is important to you in any context.
def tag_toggle(self, paths=None, value=None, movedown=None, tag=None):
""":tag_toggle <character>
Toggle a tag <character>.
"""
if not self.tags:
return
if paths is None:
tags = tuple(x.realpath for x in self.thistab.get_selection())
else:
tags = [realpath(path) for path in paths]
if value is True:
self.tags.add(*tags, tag=tag or self.tags.default_tag)
elif value is False:
self.tags.remove(*tags)
else:
self.tags.toggle(*tags, tag=tag or self.tags.default_tag)
if movedown is None:
movedown = len(tags) == 1 and paths is None
if movedown:
self.move(down=1)
self.ui.redraw_main_column()
def tag_remove(self, paths=None, movedown=None):
self.tag_toggle(paths=paths, value=False, movedown=movedown)
def tag_add(self, paths=None, movedown=None):
self.tag_toggle(paths=paths, value=True, movedown=movedown)
# --------------------------
# -- Bookmarks
# --------------------------
# Using ranger.container.bookmarks.
def enter_bookmark(self, key):
"""Enter the bookmark with the name <key>"""
try:
self.bookmarks.update_if_outdated()
destination = self.bookmarks[str(key)]
cwd = self.thisdir
if destination.path != cwd.path:
self.bookmarks.enter(str(key))
self.bookmarks.remember(cwd)
except KeyError:
pass
def set_bookmark(self, key, val=None):
"""Set the bookmark with the name <key> to the current directory"""
if val is None:
val = self.thisdir
else:
val = Directory(val)
self.bookmarks.update_if_outdated()
self.bookmarks[str(key)] = val
def unset_bookmark(self, key):
"""Delete the bookmark with the name <key>"""
self.bookmarks.update_if_outdated()
del self.bookmarks[str(key)]
def draw_bookmarks(self):
self.ui.browser.draw_bookmarks = True
def hide_bookmarks(self):
self.ui.browser.draw_bookmarks = False
def draw_possible_programs(self):
try:
target = self.thistab.get_selection()[0]
except:
self.ui.browser.draw_info = []
return
programs = [program for program in self.rifle.list_commands([target.path],
None)]
if programs:
num_digits = max((len(str(program[0])) for program in programs))
program_info = ['%s | %s' % (str(program[0]).rjust(num_digits),
program[1]) for program in programs]
self.ui.browser.draw_info = program_info
def hide_console_info(self):
self.ui.browser.draw_info = False
# --------------------------
# -- Pager
# --------------------------
# These commands open the built-in pager and set specific sources.
def display_command_help(self, console_widget):
try:
command = console_widget._get_cmd_class()
except:
self.notify("Feature not available!", bad=True)
return
if not command:
self.notify("Command not found!", bad=True)
return
if not command.__doc__:
self.notify("Command has no docstring. Try using python without -OO",
bad=True)
return
pager = self.ui.open_pager()
lines = cleandoc(command.__doc__).split('\n')
pager.set_source(lines)
def display_help(self):
manualpath = self.relpath('../doc/ranger.1')
if os.path.exists(manualpath):
process = self.run(['man', manualpath])
if process.poll() != 16:
return
process = self.run(['man', 'ranger'])
if process.poll() == 16:
self.notify("Could not find manpage.", bad=True)
def display_log(self):
pager = self.ui.open_pager()
if self.log:
pager.set_source(["Message Log:"] + list(self.log))
else:
pager.set_source(["Message Log:", "No messages!"])
def display_file(self):
if not self.thisfile or not self.thisfile.is_file:
return
pager = self.ui.open_pager()
f = self.thisfile.get_preview_source(pager.wid, pager.hei)
if self.thisfile.is_image_preview():
pager.set_image(f)
else:
pager.set_source(f)
# --------------------------
# -- Previews
# --------------------------
def update_preview(self, path):
try:
del self.previews[path]
self.ui.need_redraw = True
except:
return False
if version_info[0] == 3:
def sha1_encode(self, path):
return os.path.join(ranger.arg.cachedir,
sha1(path.encode('utf-8', 'backslashreplace')) \
.hexdigest()) + '.jpg'
else:
def sha1_encode(self, path):
return os.path.join(ranger.arg.cachedir,
sha1(path).hexdigest()) + '.jpg'
def get_preview(self, file, width, height):
pager = self.ui.get_pager()
path = file.realpath
if not path or not os.path.exists(path):
return None
if self.settings.preview_script and self.settings.use_preview_script:
# self.previews is a 2 dimensional dict:
# self.previews['/tmp/foo.jpg'][(80, 24)] = "the content..."
# self.previews['/tmp/foo.jpg']['loading'] = False
# A -1 in tuples means "any"; (80, -1) = wid. of 80 and any hei.
# The key 'foundpreview' is added later. Values in (True, False)
# XXX: Previews can break when collapse_preview is on and the
# preview column is popping out as you move the cursor on e.g. a
# PDF file.
try:
data = self.previews[path]
except:
data = self.previews[path] = {'loading': False}
else:
if data['loading']:
return None
found = data.get((-1, -1), data.get((width, -1),
data.get((-1, height), data.get((width, height), False))))
if found is False:
try:
stat_ = os.stat(self.settings.preview_script)
except:
self.fm.notify("Preview Script `%s' doesn't exist!" %
self.settings.preview_script, bad=True)
return None
if not stat_.st_mode & S_IEXEC:
self.fm.notify("Preview Script `%s' is not executable!" %
self.settings.preview_script, bad=True)
return None
data['loading'] = True
if 'directimagepreview' in data:
data['foundpreview'] = True
data['imagepreview'] = True
pager.set_image(path)
data['loading'] = False
return path
cacheimg = os.path.join(ranger.arg.cachedir, self.sha1_encode(path))
if (os.path.isfile(cacheimg) and os.path.getmtime(cacheimg) > os.path.getmtime(path)):
data['foundpreview'] = True
data['imagepreview'] = True
pager.set_image(cacheimg)
data['loading'] = False
return cacheimg
loadable = CommandLoader(args=[self.settings.preview_script,
path, str(width), str(height), cacheimg,
str(self.settings.preview_images)], read=True,
silent=True, descr="Getting preview of %s" % path)
def on_after(signal):
exit = signal.process.poll()
content = signal.loader.stdout_buffer
data['foundpreview'] = True
if exit == 0:
data[(width, height)] = content
elif exit == 3:
data[(-1, height)] = content
elif exit == 4:
data[(width, -1)] = content
elif exit == 5:
data[(-1, -1)] = content
elif exit == 6:
data['imagepreview'] = True
elif exit == 7:
data['directimagepreview'] = True
elif exit == 1:
data[(-1, -1)] = None
data['foundpreview'] = False
elif exit == 2:
f = codecs.open(path, 'r', errors='ignore')
try:
data[(-1, -1)] = f.read(1024 * 32)
except UnicodeDecodeError:
f.close()
f = codecs.open(path, 'r', encoding='latin-1',
errors='ignore')
data[(-1, -1)] = f.read(1024 * 32)
f.close()
else:
data[(-1, -1)] = None
if self.thisfile and self.thisfile.realpath == path:
self.ui.browser.need_redraw = True
data['loading'] = False
pager = self.ui.get_pager()
if self.thisfile and self.thisfile.is_file:
if 'imagepreview' in data:
pager.set_image(cacheimg)
return cacheimg
elif 'directimagepreview' in data:
pager.set_image(path)
return path
else:
pager.set_source(self.thisfile.get_preview_source(
pager.wid, pager.hei))
def on_destroy(signal):
try:
del self.previews[path]
except:
pass
loadable.signal_bind('after', on_after)
loadable.signal_bind('destroy', on_destroy)
self.loader.add(loadable)
return None
else:
return found
else:
try:
return codecs.open(path, 'r', errors='ignore')
except:
return None
# --------------------------
# -- Tabs
# --------------------------
def tab_open(self, name, path=None):
tab_has_changed = (name != self.current_tab)
self.current_tab = name
previous_tab = self.thistab
try:
tab = self.tabs[name]
except KeyError:
# create a new tab
tab = Tab(self.thistab.path)
self.tabs[name] = tab
self.thistab = tab
tab.enter_dir(tab.path, history=False)
if path:
tab.enter_dir(path, history=True)
if previous_tab:
tab.inherit_history(previous_tab.history)
else:
self.thistab = tab
if path:
tab.enter_dir(path, history=True)
else:
tab.enter_dir(tab.path, history=False)
if tab_has_changed:
self.change_mode('normal')
self.signal_emit('tab.change', old=previous_tab, new=self.thistab)
self.signal_emit('tab.layoutchange')
def tab_close(self, name=None):
if name is None:
name = self.current_tab
tab = self.tabs[name]
if name == self.current_tab:
direction = -1 if name == self._get_tab_list()[-1] else 1
previous = self.current_tab
self.tab_move(direction)
if previous == self.current_tab:
return # can't close last tab
if name in self.tabs:
del self.tabs[name]
self.restorable_tabs.append(tab)
self.signal_emit('tab.layoutchange')
def tab_restore(self):
# NOTE: The name of the tab is not restored.
previous_tab = self.thistab
if self.restorable_tabs:
tab = self.restorable_tabs.pop()
for name in range(1, len(self.tabs) + 2):
if not name in self.tabs:
self.current_tab = name
self.tabs[name] = tab
tab.enter_dir(tab.path, history=False)
self.thistab = tab
self.change_mode('normal')
self.signal_emit('tab.change', old=previous_tab,
new=self.thistab)
break
def tab_move(self, offset, narg=None):
if narg:
return self.tab_open(narg)
assert isinstance(offset, int)
tablist = self._get_tab_list()
current_index = tablist.index(self.current_tab)
newtab = tablist[(current_index + offset) % len(tablist)]
if newtab != self.current_tab:
self.tab_open(newtab)
def tab_new(self, path=None, narg=None):
if narg:
return self.tab_open(narg, path)
for i in range(1, 10):
if not i in self.tabs:
return self.tab_open(i, path)
def tab_switch(self, path, create_directory=False):
"""Switches to tab of given path, opening a new tab as necessary.
If path does not exist, it is treated as a directory.
"""
path = realpath(path)
if not os.path.exists(path):
file_selection = None
if create_directory:
try:
os.makedirs(path, exist_ok=True)
except OSError as err:
self.fm.notify(err, bad=True)
return
target_directory = path
else:
# Give benefit of the doubt.
potential_parent = os.path.dirname(path)
if os.path.exists(potential_parent) and os.path.isdir(potential_parent):
target_directory = potential_parent
else:
self.fm.notify("Unable to resolve given path.", bad=True)
return
elif os.path.isdir(path):
file_selection = None
target_directory = path
else:
file_selection = path
target_directory = os.path.dirname(path)
for name in self.fm.tabs:
tab = self.fm.tabs[name]
# Is a tab already open?
if tab.path == target_directory:
self.fm.tab_open(name=name)
if file_selection:
self.fm.select_file(file_selection)
return
self.fm.tab_new(path=target_directory)
if file_selection:
self.fm.select_file(file_selection)
def _get_tab_list(self):
assert len(self.tabs) > 0, "There must be >=1 tabs at all times"
return sorted(self.tabs)
# --------------------------
# -- Overview of internals
# --------------------------
def dump_keybindings(self, *contexts):
if not contexts:
contexts = 'browser', 'console', 'pager', 'taskview'
temporary_file = tempfile.NamedTemporaryFile()
def write(string):
temporary_file.write(string.encode('utf-8'))
def recurse(before, pointer):
for key, value in pointer.items():
keys = before + [key]
if isinstance(value, dict):
recurse(keys, value)
else:
write("%12s %s\n" % (construct_keybinding(keys), value))
for context in contexts:
write("Keybindings in `%s'\n" % context)
if context in self.fm.ui.keymaps:
recurse([], self.fm.ui.keymaps[context])
else:
write(" None\n")
write("\n")
temporary_file.flush()
pager = os.environ.get('PAGER', ranger.DEFAULT_PAGER)
self.run([pager, temporary_file.name])
def dump_commands(self):
temporary_file = tempfile.NamedTemporaryFile()
def write(string):
temporary_file.write(string.encode('utf-8'))
undocumented = []
for cmd_name in sorted(self.commands.commands):
cmd = self.commands.commands[cmd_name]
if hasattr(cmd, '__doc__') and cmd.__doc__:
doc = cleandoc(cmd.__doc__)
if doc[0] == ':':
write(doc)
write("\n\n" + "-" * 60 + "\n")
else:
undocumented.append(cmd)
if undocumented:
write("Undocumented commands:\n\n")
for cmd in undocumented:
write(" :%s\n" % cmd.get_name())
temporary_file.flush()
pager = os.environ.get('PAGER', ranger.DEFAULT_PAGER)
self.run([pager, temporary_file.name])
def dump_settings(self):
temporary_file = tempfile.NamedTemporaryFile()
def write(string):
temporary_file.write(string.encode('utf-8'))
for setting in sorted(ALLOWED_SETTINGS):
write("%30s = %s\n" % (setting, getattr(self.settings, setting)))
temporary_file.flush()
pager = os.environ.get('PAGER', ranger.DEFAULT_PAGER)
self.run([pager, temporary_file.name])
# --------------------------
# -- File System Operations
# --------------------------
def uncut(self):
""":uncut
Empty the copy buffer.
"""
self.copy_buffer = set()
self.do_cut = False
self.ui.browser.main_column.request_redraw()
def copy(self, mode='set', narg=None, dirarg=None):
""":copy [mode=set]
Copy the selected items.
Modes are: 'set', 'add', 'remove'.
"""
assert mode in ('set', 'add', 'remove', 'toggle')
cwd = self.thisdir
if not narg and not dirarg:
selected = (f for f in self.thistab.get_selection() if f in cwd.files)
else:
if not dirarg and narg:
direction = Direction(down=1)
offset = 0
else:
direction = Direction(dirarg)
offset = 1
pos, selected = direction.select(
override=narg, lst=cwd.files, current=cwd.pointer,
pagesize=self.ui.termsize[0], offset=offset)
cwd.pointer = pos
cwd.correct_pointer()
if mode == 'set':
self.copy_buffer = set(selected)
elif mode == 'add':
self.copy_buffer.update(set(selected))
elif mode == 'remove':
self.copy_buffer.difference_update(set(selected))
elif mode == 'toggle':
self.copy_buffer.symmetric_difference_update(set(selected))
self.do_cut = False
self.ui.browser.main_column.request_redraw()
def cut(self, mode='set', narg=None, dirarg=None):
""":cut [mode=set]
Cut the selected items.
Modes are: 'set, 'add, 'remove.
"""
self.copy(mode=mode, narg=narg, dirarg=dirarg)
self.do_cut = True
self.ui.browser.main_column.request_redraw()
def paste_symlink(self, relative=False):
copied_files = self.copy_buffer
for f in copied_files:
self.notify(next_available_filename(f.basename))
try:
new_name = next_available_filename(f.basename)
if relative:
relative_symlink(f.path, join(getcwd(), new_name))
else:
symlink(f.path, join(getcwd(), new_name))
except Exception as x:
self.notify(x)
def paste_hardlink(self):
for f in self.copy_buffer:
try:
new_name = next_available_filename(f.basename)
link(f.path, join(getcwd(), new_name))
except Exception as x:
self.notify(x)
def paste_hardlinked_subtree(self):
for f in self.copy_buffer:
try:
target_path = join(getcwd(), f.basename)
self._recurse_hardlinked_tree(f.path, target_path)
except Exception as x:
self.notify(x)
def _recurse_hardlinked_tree(self, source_path, target_path):
if isdir(source_path):
if not exists(target_path):
os.mkdir(target_path, stat(source_path).st_mode)
for item in listdir(source_path):
self._recurse_hardlinked_tree(
join(source_path, item),
join(target_path, item))
else:
if not exists(target_path) \
or stat(source_path).st_ino != stat(target_path).st_ino:
link(source_path,
next_available_filename(target_path))
def paste(self, overwrite=False, append=False):
""":paste
Paste the selected items into the current directory.
"""
loadable = CopyLoader(self.copy_buffer, self.do_cut, overwrite)
self.loader.add(loadable, append=append)
self.do_cut = False
def delete(self, files=None):
# XXX: warn when deleting mount points/unseen marked files?
self.notify("Deleting!")
# COMPAT: old command.py use fm.delete() without arguments
if files is None:
files = (f.path for f in self.thistab.get_selection())
files = [os.path.abspath(f) for f in files]
for f in files:
# Untag the deleted files.
for tag in self.fm.tags.tags:
if str(tag).startswith(f):
self.fm.tags.remove(tag)
self.copy_buffer = set(filter(lambda f: f.path not in files, self.copy_buffer))
for f in files:
if isdir(f) and not os.path.islink(f):
try:
shutil.rmtree(f)
except OSError as err:
self.notify(err)
else:
try:
os.remove(f)
except OSError as err:
self.notify(err)
self.thistab.ensure_correct_pointer()
def mkdir(self, name):
try:
os.makedirs(os.path.join(self.thisdir.path, name))
except OSError as err:
self.notify(err)
def rename(self, src, dest):
if hasattr(src, 'path'):
src = src.path
try:
os.makedirs(os.path.dirname(dest))
except OSError:
pass
try:
os.rename(src, dest)
except OSError as err:
self.notify(err)
return False
return True
|