summary refs log tree commit diff stats
path: root/ranger/bookmark.py
blob: 4b931292b17c4f2dd1025da19f1c033425dc7e56 (plain) (blame)
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
from string import ascii_letters, digits
ALLOWED_KEYS = ascii_letters + digits + "`'"

class NonexistantBookmark(Exception):
	pass

class Bookmarks(object):
	def __init__(self, path = None):
		import string, re, os
		self.dct = {}
		if path is None:
			self.path = os.path.expanduser("~/.ranger/bookmarks")
		self.load_pattern = re.compile(r"^[\d\w`']:.")
		self.enter_dir_function = None
		self.last_mtime = None

	def load_dict(self):
		import os
		dct = {}
		if os.access(self.path, os.R_OK):
			f = open(self.path, 'r')
			for line in f:
				if self.load_pattern.match(line):
					key, value = line[0], line[2:-1]
					if key in ALLOWED_KEYS: 
						dct[key] = value
			f.close()
			return dct
		else:
			raise OSError('Cannot read the given path')
	
	def set_dict(self, dct):
		self.dct.clear()
		self.dct.update(dct)
		self.original_dict = self.dct.copy()
		self.last_mtime = self.get_mtime()

	def get_mtime(self):
		import os
		return os.stat(self.path).st_mtime

	def load(self):
		try:
			new_dict = self.load_dict()
		except OSError:
			return

		self.set_dict(new_dict)
	
	def delete(self, key):
		if key in self.dct:
			del self.dct[key]
			self.save()

	def update(self):
		try:
			real_dict = self.load_dict()
		except OSError:
			return

		for key in set(self.dct.keys()) | set(real_dict.keys()):
			if key in self.dct:
				current = self.dct[key]
			else:
				current = None
			
			if key in self.original_dict:
				original = self.original_dict[key]
			else:
				original = None
				
			if key in real_dict:
				real = real_dict[key]
			else:
				real = None

			if current == original and current != real:
				continue

			if key not in self.dct:
				del real_dict[key]
			else:
				real_dict[key] = current

		self.set_dict(real_dict)

	def reload_if_outdated(self):
		if self.last_mtime != self.get_mtime():
			self.update()

	def enter(self, key):
		if self.enter_dir_function is not None:
			self.enter_dir_function(self[key])
		else:
			raise RuntimeError('Not specified how to enter a directory')

	def remember(self, value):
		self["`"] = value
		self["'"] = value

	def __getitem__(self, key):
		if key in self.dct:
			return self.dct[key]
		else:
			raise NonexistantBookmark()

	def __setitem__(self, key, value):
		if key in ALLOWED_KEYS:
			self.dct[key] = value
			self.save()

	def __contains__(self, key):
		return key in self.dct

	def save(self):
		import os
		self.update()
		if os.access(self.path, os.W_OK):
			f = open(self.path, 'w')

			for key, value in self.dct.items():
				if type(key) == str\
						and type(value) == str \
						and key in ALLOWED_KEYS:
					f.write("{0}:{1}\n".format(str(key), str(value)))

			f.close()