File: file.py

package info (click to toggle)
gjots2 2.1.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 476 kB
  • ctags: 291
  • sloc: python: 3,284; sh: 463; makefile: 46
file content (676 lines) | stat: -rw-r--r-- 18,819 bytes parent folder | download
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
import gtk, os, re
import tempfile, fcntl
import inspect

import gui
from general import *
from common import *

class PasswordError(Exception):
	def __init__(self):
		pass

class LockingError(Exception):
	def __init__(self):
		pass
	
class gjotsfile:

	def _make_lockfile_name(self, filename):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()
		dirname, basename = os.path.split(filename)

		if dirname and len(dirname) and dirname[-1] != "/":
			dirname = dirname + "/"
		name = dirname + ".#" + basename
		return name
	
	def lock_file(self, filename):
		"""

		Returns (reason, pid) where reason is:
		0: OK
		1: no permission to create lockfile
		2: already locked by another process
		
		pid is the pid of the locking process or 0 on success

		"""
		
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()
			
		if not filename or len(filename) == 0:
			filename = self.filename

		lockfile = self._make_lockfile_name(filename)

		if self.gui.trace:
			print "lock_file: lockfile name =", lockfile
		pid = 0
		
		if os.access(lockfile, os.F_OK):
			# file already exists - see if it was ours
			if not os.access(lockfile, os.W_OK):
				return (1, 0)
			try:
				fd = file(lockfile, "r", 0644)
			except IOError:
				return (1, 0)

			# fcntl.flock() returns None!! Error through exception? IOError?
			fcntl.flock(fd, fcntl.LOCK_EX)
			try:
				line = fd.readline()
				m = re.match(r"(\d+)", line)
				if m and m.group:
					pid = long(m.group(1))
			except:
				pass
			
			if self.gui.trace:
				print "lock: pid = %d\n" % pid
			if pid > 0:
				if pid == os.getpid():
					# we already own this lock:
					fcntl.flock(fd, fcntl.LOCK_UN)
					fd.close()
					return (0, pid)
				
				# hmmm - there's no getpgid() call in python
				if os.system("ps -ef |awk '{print $2}'|grep %d >/dev/null 2>&1" % pid) == 0:
					# locking process still exists:
					fcntl.flock(fd, fcntl.LOCK_UN)
					fd.close()
					return (2, pid)

		# nothing read from lockfile or process no longer exists:
		if self.gui.trace:
			print "lock_file: locking to pid", os.getpid()
		fd = file(lockfile, "w")
		fd.write("%d\n" % os.getpid())
		fcntl.flock(fd, fcntl.LOCK_UN)
		fd.close()
		return (0, 0)
		
	def unlock_file(self, filename):
		"""
		Returns 0 on success, 1 on fail
		"""
		
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()

		if not filename or len(filename) == 0:
			return 1

		# make sure we locked this file:
		lockfile = self._make_lockfile_name(filename)
		try:
			fd = file(lockfile, "r")
		except IOError:
			return 0

		fcntl.flock(fd, fcntl.LOCK_EX)
		pid = 0
		try:
			line = fd.readline()
			m = re.match(r"(\d+)", line)
			if m and m.group:
				pid = long(m.group(1))
		except:
			# nothing read - harmless
			pass
		
		retval = 1
		if pid == 0 or pid == os.getpid():
			# yes - it's ours - or it's corrupt
			os.unlink(lockfile)
			retval = 0

		fcntl.flock(fd, fcntl.LOCK_UN)
		fd.close()
		return retval
	
	def wrapItem(self, sibling, parent, title, body):
		"""
		
		Make new node after sibling. sibling=None means insert at end.
		"title" goes into the tree (left panel). "body" goes into the
		right panel.

		parent=None is a special case - it is creating the root of the tree
		
		"""

		# Too verbose to trace this
		#if self.gui.trace:
		#	print inspect.getframeinfo(inspect.currentframe())[2], vars()

		newNode = None
		if title or body:
			if title and title[-1] == '\n':
				title = title[0:-1]
			newNode = self.gui.new_node(parent, sibling, title, ''.join(body))
		return newNode

	def readItem(self, f, start, parent, title = ""):
		"""
		
		Read lines from f, populating parent, starting after "start"
		or at the end of parent if null. "title" is used to override
		the title of the first item - generally because it's the
		filename.

		If parent=None then we're creating the root item - further
		items are inserted there.

		Return the last item inserted.

		"""
		
		# Too verbose to trace this
		#if self.gui.trace:
		#	print inspect.getframeinfo(inspect.currentframe())[2], vars()

		body = []
		while 1:
			line = f.readline()
			if not line or line == "": # ie EOF
				break

			if line.find(r"\NewEntry") == 0:
				if title or body:
					start = self.wrapItem(start, parent, title, body)
					if parent == None: # we created the root item - put everything else inside there
						parent = start
						start = None
				title = ""
				body = []
				continue

			if line.find(r"\NewFolder") == 0:
				if title or body:
					start = self.wrapItem(start, parent, title, body)
					if parent == None:
						parent = start
						start = None
				title = ""
				body = []
				self.readItem(f, start=None, parent=start)
				continue

			if line.find(r"\EndFolder") == 0:
				break

			# Normal (non-special) lines:
			if not title:
				title = line
			body.append(line)
		if title or body:
			start = self.wrapItem(start, parent, title, body)
		return start

	def writeItem(self, f, treeiter, first):
		"""
		Write node to file f recursively.
		first=suppress printing first level \NewEntry and \NewFolder - we're doing root
		"""
		# Too verbose to trace this
		#if self.gui.trace:
		#	print inspect.getframeinfo(inspect.currentframe())[2], vars()

		if not first:
			f.write("\\NewEntry\n")
		body = self.gui.get_node_value(treeiter)
		f.write(body)
		if body and not body[-1] == '\n':
			f.write('\n')
		treeiter = self.gui.get_first_child(treeiter)
		if treeiter:
			if not first:
				f.write("\\NewFolder\n")
			while treeiter:
				self.writeItem(f, treeiter, 0)
				treeiter = self.gui.get_next(treeiter)
			if not first:
				f.write("\\EndFolder\n")

	def get_password(self, num_fields, filename, mode, password):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()
		secretp = 1
		feedback = " "
		confirm = password
		dirname, basename = os.path.split(filename)
		prompt = "Enter password for " + basename
		while 1:
			general = general_dialog(self.gui, "gjots: Enter Password", prompt, OK|CANCEL,
									 num_fields, secretp, feedback,
									 "Password: ", password,
									 "Confirm: ",  confirm)
			if not general.get_value() == OK:
				raise PasswordError
			
			password = general.get_field1()
			confirm = general.get_field2()
			if mode == "r" or password == confirm:
				break
			feedback = "Password was not confirmed"
		return password
	
	def ccrypt_open(self, filename, mode = "r"):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()
		if os.system("type ccdecrypt >/dev/null 2>&1") != 0:
			self.gui.err_msg("Could not find the ccrypt program - please install it and try again")
			raise PasswordError
		
		# get a password:
		if mode == "w":
			num_fields = 2
		else:
			num_fields = 1

		self.gui.password = self.get_password(num_fields, filename, mode, self.gui.password)
		envname = "DH665" # or anything you like!
		os.environ[envname] = self.gui.password
		if mode == "r":
			f = os.popen("ccdecrypt -c -E " + envname + " " + filename, "r")
		else:
			f = os.popen("ccencrypt -E " + envname + ">" + filename, "w")

		# Note - I don't think the following actually scrubs the memory for local variables - need something mutable...
		blank = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
		os.environ[envname] = blank
		if self.gui.purge_password:
			self.gui.password = blank
			self.gui.password = ""
		return f
	
	def gpg_open(self, filename, mode = "r"):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()
		if os.system("type gpg >/dev/null 2>&1") != 0:
			self.gui.err_msg("Could not find the gpg program - please install it and try again")
			raise PasswordError
		
		# get a password:
		if mode == "w":
			num_fields = 2
		else:
			num_fields = 1

		self.gui.password = self.get_password(num_fields, filename, mode, self.gui.password)
		if mode == "r":
			f = os.popen("echo " + self.gui.password + " | gpg --cipher-algo 3DES --decrypt --passphrase-fd 0 " + filename + " 2>&1", "r")
		else:
			scratch = tempfile.mktemp()
			f = os.popen("cat > " + scratch + "; echo " + self.gui.password + " | gpg --cipher-algo 3DES -o - --symmetric --passphrase-fd 0 " + scratch + "> " + filename + " 2>/dev/null; rm " + scratch, "w")
		blank = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
		if self.gui.purge_password:
			self.gui.password = blank
			self.gui.password = ""
		return f
	
	def ssl_open(self, filename, mode = "r"):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()
		if os.system("type openssl >/dev/null 2>&1") != 0:
			self.gui.err_msg("Could not find the openssl program - please install it and try again")
			raise PasswordError
		
		# get a password:
		if mode == "w":
			num_fields = 2
		else:
			num_fields = 1

		self.gui.password = self.get_password(num_fields, filename, mode, self.gui.password)
		if mode == "r":
			f = os.popen("echo " + self.gui.password + " | openssl des3 -d -pass stdin -in " + filename + " 2>&1", "r")
		else:
			scratch = tempfile.mktemp()
			f = os.popen("cat > " + scratch + "; echo " + self.gui.password + " | openssl des3 -pass stdin -in " + scratch + " -out " + filename + " 2>&2; rm " + scratch, "w")
		blank = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
		if self.gui.purge_password:
			self.gui.password = blank
			self.gui.password = ""
		return f

	def close(self):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2]

		if self.filename:
			self.unlock_file(self.filename)
		
	def _general_open(self, filename, mode):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()
		
		if mode == "w":
			try:
				f = open(filename)
				f.close()
				os.rename(filename, filename + "~")

			except IOError:
				pass
			
		exti = filename.rfind(".cpt")
		if not exti == -1:
			return self.ccrypt_open(filename, mode)
		exti = filename.rfind(".gpg")
		if not exti == -1:
			return self.gpg_open(filename, mode)
		exti = filename.rfind(".ssl")
		if not exti == -1:
			return self.ssl_open(filename, mode)
		return open(filename, mode)
		
	def _do_load(self, filename, import_after):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()

		dirname, basename = os.path.split(filename)
			
		try:
			f = self._general_open(filename, "r")
		except IOError:
			self.gui.msg('Can\'t open "' + basename + '"')
			return ""
		except PasswordselectionError:
			self.gui.msg("Bad password")
			return ""
		except LockingError:
			self.gui.err_msg("File cannot be locked")
			return ""

		if import_after:
			self.readItem(f, None, import_after, None)
		else:
			self.gui.flush_tree()
			# needs a try/except:
			self.readItem(f, None, None, basename)
			self.filename = filename
			self.gui.show_tree(basename)
			
		f.close()
		return self.filename
	
	def _do_store(self, filename, selection):
		"""

		Internal storage routine - no prompting, locking or other
		checking. Save entire tree unless selection is set - in which
		we are "exporting".

		Return filename on success, "" on error

		"""
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()

		if not filename:
			return ""
		dirname, basename = os.path.split(filename)

		try:
			f = self._general_open(filename, "w")
		except IOError:
			dirname, basename = os.path.split(filename)
			self.gui.msg("Not saved.")
			self.gui.err_msg("Can't write to " + basename)
			return ""
		except LockingError:
			self.gui.err_msg("Can't lock file")
			return ""

		if selection:
			first_selected = self.gui.get_first_selected_iter()
			if not first_selected:
				self.gui.msg("Nothing selected")
				return ""

			last_selected = self.gui.get_last_selected_iter()
			if not last_selected:
				self.gui.msg("Nothing selected")
				return ""

			this = first_selected
			count = 0
			while this:
				count = count + 1
				next = self.gui.treestore.iter_next(this)
				if self.gui.same_iter(this, last_selected):
					next = None
				self.writeItem(f, this, 0)
				this = next
		else:
			treeiter = self.gui.get_root()
			# needs a try/except: for IO errors, eg. out of space, network failed ...
			self.writeItem(f, treeiter, 1)
		
		f.close()
		return filename
	
	def destroy(self):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2]
		self.xml.get_widget(self.name).destroy()

	def on_fileselection_key_press_event(self, widget, event):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2]
		# Nothing is needed here - return & escape work as expected
		pass
	
	def on_fileselectionCancelButton_clicked(self, widget):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2]
		self.prompt_filename = None
		self.fileselectionValue = CANCEL
		
	def on_fileselectionOkButton_clicked(self, widget):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2]
		self.prompt_filename = self.xml.get_widget("fileselection").get_filename()
		self.fileselectionValue = OK

	def get_value(self):
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2]
		return self.prompt_filename
	
	def file_dialog(self, title):
		"""
		File selection dialog
		"""
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()

		callbacks = {
			# File selector popup:
			"on_fileselection_key_press_event":			self.on_fileselection_key_press_event,
			"on_fileselectionCancelButton_clicked":		self.on_fileselectionCancelButton_clicked,
			"on_fileselectionOkButton_clicked":			self.on_fileselectionOkButton_clicked,
		}

		self.name = "fileselection"
		self.xml = gtk.glade.XML(self.gui.gui_filename, self.name)
		self.xml.signal_autoconnect(callbacks)
		
		self.xml.get_widget(self.name).set_title(title)
		self.fileselectionValue = WAITING
		while self.fileselectionValue == WAITING:
			gtk.main_iteration()

		self.xml.get_widget(self.name).destroy()

	def read_file(self, prompt, filename, readonly, import_after):
		"""

		Top level file reading - with prompting and locking of files.
		Reads items in after "import_after" if set, otherwise to root.

		Returns filename read in or ""

		"""
		
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()

		if prompt:
			self.file_dialog(prompt)
			if self.fileselectionValue != OK or not self.prompt_filename:
				return ""
		else:
			if not filename:
				filename = os.environ["HOME"]+"/.gjotsfile"
			self.prompt_filename = filename

		dirname, basename = os.path.split(self.prompt_filename)
		if import_after:
			readonly = 1
			
		if not os.access(self.prompt_filename, os.R_OK):
			self.gui.err_msg("%s is not readable" % basename)
			return ""
		
		# lock the file
		while not readonly:
			reason, pid = self.lock_file(self.prompt_filename)
			if reason == 0:
				# it's locked, all in order...
				break
			if reason == 1:
				msg = "%s: no permission" % basename
			else:
				msg = "%s: locked by process number %d" % (basename, pid)
			general = general_dialog(self.gui,
									 title = "gjots: can't lock file.",
									 prompt = msg,
									 buttons = TRYAGAIN | CANCEL | READONLY,
									 secretp = 0,
									 feedback = "",
									 field1_label = "",
									 field1_default = "",
									 field2_label = "",
									 field2_default = "")
			if general.get_value() == CANCEL:
				raise LockingError
			if general.get_value() == READONLY:
				self.gui.set_readonly(1, quietly=1)
				readonly = 1
				
		retval = self._do_load(self.prompt_filename, import_after)
		if retval:
			if not import_after:
				self.filename = self.prompt_filename
		else:
			self.unlock_file(self.prompt_filename)
			self.filename = ""
			self.gui.set_readonly(0, quietly=1)
		return retval
	
	def write_file(self, prompt = "", exporting=0):
		"""
		
		Top level file writing - with prompting if necessary. If no
		prompt just use the default file and don't check about
		overwriting it.

		Always lock the file before writing - leave it locked (and
		remove any other locks) unless exporting.
		
		If exporting then only write the current selection - no need
		to change the default filename to this one; otherwise, write
		the root item and change the default filename to this one.
		
		Return filename on success, "" on error
		
		"""
		
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2], vars()

		if self.gui.readonly or not self.filename:
			if not prompt or len(prompt) == 0:
				prompt = "Save as ..."

		retval = ""
		while 1: # use while simply so that we can use break:
			if prompt:
				self.file_dialog(prompt)
				if self.fileselectionValue == OK and self.prompt_filename:
					dirname, basename = os.path.split(self.prompt_filename)

					# we may need to use "fully expanded name" here:
					if self.filename == self.prompt_filename:
						if exporting:
							self.gui.err_msg("That file is already open!")
							return ""
						retval = self._do_store(self.filename, exporting)
						break

					reason, pid = self.lock_file(self.prompt_filename)

					if reason == 2:
						self.gui.err_msg("%s is locked by pid %d" % (basename, pid))
						return ""
					if reason == 1:
						self.gui.err_msg("Can't make a lockfile in " + dirname)
						return ""

					# We know that the directory is writable, so we can
					# create a file here See if it already exists, if so,
					# is it writable, if so should we overwrite it?:
					try:
						f = open(self.prompt_filename)
						f.close()

						if not os.access(self.prompt_filename, os.W_OK):
							self.unlock_file(self.prompt_filename)
							self.gui.err_msg("%s is not writable" % basename)
							return ""
						general = general_dialog(self.gui, "gjots: %s already exists." % basename,
												 "overwrite %s?" % basename, YES|CANCEL,
												 0, 0, "",
												 "", "",
												 "",  "")
						if not general.get_value() == YES:
							self.unlock_file(self.prompt_filename)
							return ""
					except IOError:
						pass

					retval = self._do_store(self.prompt_filename, exporting)
					if exporting:
						self.unlock_file(self.prompt_filename)
					else:
						if retval:
							self.close()
							self.filename = self.prompt_filename
							self.gui.set_title(basename)
					break
				
			else: # just save the sucker
				# assert exporting == 0
				retval = self._do_store(self.filename, exporting)
				break
			
		return retval
			
	def __init__(self, gui):
		self.gui = gui
		if self.gui.trace:
			print inspect.getframeinfo(inspect.currentframe())[2]
		self.prompt_filename = ""
		self.filename = ""
		self.fileselectionValue = OK

# Local variables:
# eval:(setq compile-command "cd ..; ./gjots2 j")
# End: