. split instance initialisation into two steps, allowing config changes

[roundup.git] / roundup / install_util.py

diff --git a/roundup/install_util.py b/roundup/install_util.py
index bbf1edf52cf3b326906cb866b7d6d21a4a2da42d..69fc0490a93e74339250c48709ce3146507e1abf 100644 (file)
--- a/roundup/install_util.py
+++ b/roundup/install_util.py
@@ -15,9 +15,20 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: install_util.py,v 1.2 2001-11-12 22:37:13 richard Exp $
+# $Id: install_util.py,v 1.7 2001-11-24 01:00:13 jhermann Exp $
 
-import os, sha
+__doc__ = """
+Support module to generate and check fingerprints of installed files.
+"""
+
+import os, sha, shutil
+
+# ".filter", ".index", ".item", ".newitem" are roundup-specific
+sgml_file_types = [".xml", ".ent", ".html", ".filter", ".index", ".item", ".newitem"]
+hash_file_types = [".py", ".sh", ".conf", ".cgi", '']
+slast_file_types = [".css"]
+
+digested_file_types = sgml_file_types + hash_file_types + slast_file_types
 
 
 def checkDigest(filename):
@@ -37,6 +48,7 @@ def checkDigest(filename):
         fingerprint = fingerprint.replace('-->', '')
         fingerprint = fingerprint.strip()
     elif lines[-1][:8] == "/* SHA: ":
+        # handle css files
         fingerprint = lines[-1][8:]
         fingerprint = fingerprint.replace('*/', '')
         fingerprint = fingerprint.strip()
@@ -70,37 +82,66 @@ class DigestFile:
     def close(self):
         file, ext = os.path.splitext(self.filename)
 
-        # ".filter", ".index", ".item" are roundup-specific
-        if ext in [".xml", ".ent", ".html", ".filter", ".index", ".item"]:
+        if ext in sgml_file_types:
             self.file.write("<!-- SHA: %s -->\n" % (self.digest.hexdigest(),))
-        elif ext in [".py", ".sh", ".conf", ".cgi", '']:
+        elif ext in hash_file_types:
             self.file.write("#SHA: %s\n" % (self.digest.hexdigest(),))
-        elif ext in [".css"]:
-            self.file.write("/* SHA: %s %/\n" % (self.digest.hexdigest(),))
+        elif ext in slast_file_types:
+            self.file.write("/* SHA: %s */\n" % (self.digest.hexdigest(),))
 
         self.file.close()
 
 
+def copyDigestedFile(src, dst, copystat=1):
+    """ Copy data from `src` to `dst`, adding a fingerprint to `dst`.
+        If `copystat` is true, the file status is copied, too
+        (like shutil.copy2).
+    """
+    if os.path.isdir(dst):
+        dst = os.path.join(dst, os.path.basename(src))
+
+    dummy, ext = os.path.splitext(src)
+    if ext not in digested_file_types:
+        if copystat:
+            return shutil.copy2(src, dst)
+        else:
+            return shutil.copyfile(src, dst)
+
+    fsrc = None
+    fdst = None
+    try:
+        fsrc = open(src, 'r')
+        fdst = DigestFile(dst)
+        shutil.copyfileobj(fsrc, fdst)
+    finally:
+        if fdst: fdst.close()
+        if fsrc: fsrc.close()
+
+    if copystat: shutil.copystat(src, dst)
+
+
 def test():
     import sys
 
     testdata = open(sys.argv[0], 'r').read()
-    testfile = "digest_test.py"
 
-    out = DigestFile(testfile)
-    out.write(testdata)
-    out.close()
+    for ext in digested_file_types:
+        testfile = "__digest_test" + ext
+
+        out = DigestFile(testfile)
+        out.write(testdata)
+        out.close()
 
-    assert checkDigest(testfile), "digest ok w/o modification"
+        assert checkDigest(testfile), "digest ok w/o modification"
 
-    mod = open(testfile, 'r+')
-    mod.seek(0)
-    mod.write('# changed!')
-    mod.close()
+        mod = open(testfile, 'r+')
+        mod.seek(0)
+        mod.write('# changed!')
+        mod.close()
 
-    assert not checkDigest(testfile), "digest fails after modification"
+        assert not checkDigest(testfile), "digest fails after modification"
 
-    os.remove(testfile)
+        os.remove(testfile)
 
 
 if __name__ == '__main__':
@@ -108,6 +149,21 @@ if __name__ == '__main__':
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.6  2001/11/22 15:46:42  jhermann
+# Added module docstrings to all modules.
+#
+# Revision 1.5  2001/11/12 23:17:38  jhermann
+# Code using copyDigestedFile() that passes unit tests
+#
+# Revision 1.4  2001/11/12 23:14:40  jhermann
+# Copy function, and proper handling of unknown file types
+#
+# Revision 1.3  2001/11/12 22:38:48  richard
+# bleah typo
+#
+# Revision 1.2  2001/11/12 22:37:13  richard
+# Handle all the various file formats in roundup
+#
 # Revision 1.1  2001/11/12 22:26:32  jhermann
 # Added install utils (digest calculation)
 #