Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 1 | """Guess which db package to use to open a db file.""" |
| 2 | |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 3 | import os |
| 4 | |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 5 | def whichdb(filename): |
| 6 | """Guess which db package to use to open a db file. |
| 7 | |
| 8 | Return values: |
| 9 | |
| 10 | - None if the database file can't be read; |
| 11 | - empty string if the file can be read but can't be recognized |
| 12 | - the module name (e.g. "dbm" or "gdbm") if recognized. |
| 13 | |
| 14 | Importing the given module may still fail, and opening the |
| 15 | database using that module may still fail. |
| 16 | """ |
| 17 | |
Skip Montanaro | 58eadba | 2001-03-01 04:13:51 +0000 | [diff] [blame] | 18 | import struct |
| 19 | |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 20 | # Check for dbm first -- this has a .pag and a .dir file |
| 21 | try: |
Guido van Rossum | e2ae77b | 2001-10-24 20:42:55 +0000 | [diff] [blame] | 22 | f = open(filename + os.extsep + "pag", "rb") |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 23 | f.close() |
Guido van Rossum | e2ae77b | 2001-10-24 20:42:55 +0000 | [diff] [blame] | 24 | f = open(filename + os.extsep + "dir", "rb") |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 25 | f.close() |
| 26 | return "dbm" |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 27 | except IOError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 28 | pass |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 29 | |
Moshe Zadka | 7a4409c | 2000-07-29 05:31:40 +0000 | [diff] [blame] | 30 | # Check for dumbdbm next -- this has a .dir and and a .dat file |
Thomas Wouters | 3027b15 | 2000-08-04 08:46:59 +0000 | [diff] [blame] | 31 | try: |
Guido van Rossum | e2ae77b | 2001-10-24 20:42:55 +0000 | [diff] [blame] | 32 | f = open(filename + os.extsep + "dat", "rb") |
Moshe Zadka | 7a4409c | 2000-07-29 05:31:40 +0000 | [diff] [blame] | 33 | f.close() |
Guido van Rossum | e2ae77b | 2001-10-24 20:42:55 +0000 | [diff] [blame] | 34 | f = open(filename + os.extsep + "dir", "rb") |
Moshe Zadka | 7a4409c | 2000-07-29 05:31:40 +0000 | [diff] [blame] | 35 | try: |
| 36 | if f.read(1) in ["'", '"']: |
| 37 | return "dumbdbm" |
| 38 | finally: |
| 39 | f.close() |
| 40 | except IOError: |
| 41 | pass |
| 42 | |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 43 | # See if the file exists, return None if not |
| 44 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 45 | f = open(filename, "rb") |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 46 | except IOError: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 47 | return None |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 48 | |
Guido van Rossum | cf09a39 | 1999-06-08 13:13:16 +0000 | [diff] [blame] | 49 | # Read the start of the file -- the magic number |
| 50 | s16 = f.read(16) |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 51 | f.close() |
Guido van Rossum | cf09a39 | 1999-06-08 13:13:16 +0000 | [diff] [blame] | 52 | s = s16[0:4] |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 53 | |
| 54 | # Return "" if not at least 4 bytes |
| 55 | if len(s) != 4: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 56 | return "" |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 57 | |
| 58 | # Convert to 4-byte int in native byte order -- return "" if impossible |
| 59 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 60 | (magic,) = struct.unpack("=l", s) |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 61 | except struct.error: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 62 | return "" |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 63 | |
| 64 | # Check for GNU dbm |
| 65 | if magic == 0x13579ace: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 66 | return "gdbm" |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 67 | |
| 68 | # Check for BSD hash |
Guido van Rossum | b86ba12 | 1998-04-28 15:41:03 +0000 | [diff] [blame] | 69 | if magic in (0x00061561, 0x61150600): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 70 | return "dbhash" |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 71 | |
Guido van Rossum | cf09a39 | 1999-06-08 13:13:16 +0000 | [diff] [blame] | 72 | # BSD hash v2 has a 12-byte NULL pad in front of the file type |
| 73 | try: |
Fred Drake | 13a2c27 | 2000-02-10 17:17:14 +0000 | [diff] [blame] | 74 | (magic,) = struct.unpack("=l", s16[-4:]) |
Guido van Rossum | cf09a39 | 1999-06-08 13:13:16 +0000 | [diff] [blame] | 75 | except struct.error: |
| 76 | return "" |
| 77 | |
| 78 | # Check for BSD hash |
| 79 | if magic in (0x00061561, 0x61150600): |
| 80 | return "dbhash" |
| 81 | |
Guido van Rossum | 8d12a1b | 1996-07-30 16:30:15 +0000 | [diff] [blame] | 82 | # Unknown |
| 83 | return "" |