Mercurial > p > roundup > code

annotate roundup/install_util.py @ 384:a72ad731b2cb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Handle all the various file formats in roundup
author Richard Jones <richard@users.sourceforge.net>
date Mon, 12 Nov 2001 22:37:13 +0000
parents a213e2a90364
children 66e18fd9f5a2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
383
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
1 #
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
3 # This module is free software, and you may redistribute it and/or modify
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
4 # under the same terms as Python, so long as this copyright message and
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
5 # disclaimer are retained in their original form.
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
6 #
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
10 # POSSIBILITY OF SUCH DAMAGE.
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
11 #
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
17 #
384
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
18 # $Id: install_util.py,v 1.2 2001-11-12 22:37:13 richard Exp $
383
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
19
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
20 import os, sha
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
21
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
22
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
23 def checkDigest(filename):
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
24 """Read file, check for valid fingerprint, return TRUE if ok"""
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
25 # open and read file
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
26 inp = open(filename, "r")
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
27 lines = inp.readlines()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
28 inp.close()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
29
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
30 # get fingerprint from last line
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
31 if lines[-1][:6] == "#SHA: ":
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
32 # handle .py/.sh comment
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
33 fingerprint = lines[-1][6:].strip()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
34 elif lines[-1][:10] == "<!-- SHA: ":
384
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
35 # handle xml/html files
383
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
36 fingerprint = lines[-1][10:]
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
37 fingerprint = fingerprint.replace('-->', '')
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
38 fingerprint = fingerprint.strip()
384
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
39 elif lines[-1][:8] == "/* SHA: ":
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
40 fingerprint = lines[-1][8:]
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
41 fingerprint = fingerprint.replace('*/', '')
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
42 fingerprint = fingerprint.strip()
383
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
43 else:
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
44 return 0
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
45 del lines[-1]
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
46
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
47 # calculate current digest
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
48 digest = sha.new()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
49 for line in lines:
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
50 digest.update(line)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
51
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
52 # compare current to stored digest
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
53 return fingerprint == digest.hexdigest()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
54
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
55
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
56 class DigestFile:
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
57 """ A class that you can use like open() and that calculates
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
58 and writes a SHA digest to the target file.
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
59 """
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
60
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
61 def __init__(self, filename):
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
62 self.filename = filename
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
63 self.digest = sha.new()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
64 self.file = open(self.filename, "w")
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
65
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
66 def write(self, data):
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
67 self.file.write(data)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
68 self.digest.update(data)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
69
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
70 def close(self):
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
71 file, ext = os.path.splitext(self.filename)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
72
384
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
73 # ".filter", ".index", ".item" are roundup-specific
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
74 if ext in [".xml", ".ent", ".html", ".filter", ".index", ".item"]:
383
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
75 self.file.write("<!-- SHA: %s -->\n" % (self.digest.hexdigest(),))
384
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
76 elif ext in [".py", ".sh", ".conf", ".cgi", '']:
383
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
77 self.file.write("#SHA: %s\n" % (self.digest.hexdigest(),))
384
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
78 elif ext in [".css"]:
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
79 self.file.write("/* SHA: %s %/\n" % (self.digest.hexdigest(),))
383
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
80
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
81 self.file.close()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
82
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
83
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
84 def test():
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
85 import sys
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
86
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
87 testdata = open(sys.argv[0], 'r').read()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
88 testfile = "digest_test.py"
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
89
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
90 out = DigestFile(testfile)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
91 out.write(testdata)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
92 out.close()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
93
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
94 assert checkDigest(testfile), "digest ok w/o modification"
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
95
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
96 mod = open(testfile, 'r+')
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
97 mod.seek(0)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
98 mod.write('# changed!')
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
99 mod.close()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
100
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
101 assert not checkDigest(testfile), "digest fails after modification"
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
102
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
103 os.remove(testfile)
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
104
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
105
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
106 if __name__ == '__main__':
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
107 test()
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
108
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
109 #
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
110 # $Log: not supported by cvs2svn $
384
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
111 # Revision 1.1 2001/11/12 22:26:32 jhermann
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
112 # Added install utils (digest calculation)
a72ad731b2cb Handle all the various file formats in roundup
Richard Jones <richard@users.sourceforge.net>
parents: 383
diff changeset
113 #
383
a213e2a90364 Added install utils (digest calculation)
Jürgen Hermann <jhermann@users.sourceforge.net>
parents:
diff changeset
114
Roundup Issue Tracker: http://roundup-tracker.org/