Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 1 | /*********************************************************** |
Guido van Rossum | fd71b9e | 2000-06-30 23:50:40 +0000 | [diff] [blame] | 2 | Copyright (c) 2000, BeOpen.com. |
| 3 | Copyright (c) 1995-2000, Corporation for National Research Initiatives. |
| 4 | Copyright (c) 1990-1995, Stichting Mathematisch Centrum. |
| 5 | All rights reserved. |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 6 | |
Guido van Rossum | fd71b9e | 2000-06-30 23:50:40 +0000 | [diff] [blame] | 7 | See the file "Misc/COPYRIGHT" for information on usage and |
| 8 | redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 9 | ******************************************************************/ |
| 10 | |
| 11 | /* DBM module using dictionary interface */ |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 12 | /* Author: Anthony Baxter, after dbmmodule.c */ |
| 13 | /* Doc strings: Mitch Chapman */ |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 14 | |
| 15 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 16 | #include "Python.h" |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 17 | |
| 18 | #include <sys/types.h> |
| 19 | #include <sys/stat.h> |
| 20 | #include <fcntl.h> |
| 21 | #include "gdbm.h" |
| 22 | |
Guido van Rossum | b6e2a99 | 1998-10-03 05:13:27 +0000 | [diff] [blame] | 23 | #ifdef WIN32 |
| 24 | #include "gdbmerrno.h" |
| 25 | extern const char * gdbm_strerror(gdbm_error); |
| 26 | #endif |
| 27 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 28 | static char gdbmmodule__doc__[] = "\ |
| 29 | This module provides an interface to the GNU DBM (GDBM) library.\n\ |
| 30 | \n\ |
| 31 | This module is quite similar to the dbm module, but uses GDBM instead to\n\ |
| 32 | provide some additional functionality. Please note that the file formats\n\ |
| 33 | created by GDBM and dbm are incompatible. \n\ |
| 34 | \n\ |
| 35 | GDBM objects behave like mappings (dictionaries), except that keys and\n\ |
| 36 | values are always strings. Printing a GDBM object doesn't print the\n\ |
| 37 | keys and values, and the items() and values() methods are not\n\ |
| 38 | supported."; |
| 39 | |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 40 | typedef struct { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 41 | PyObject_HEAD |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 42 | int di_size; /* -1 means recompute */ |
| 43 | GDBM_FILE di_dbm; |
| 44 | } dbmobject; |
| 45 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 46 | staticforward PyTypeObject Dbmtype; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 47 | |
| 48 | #define is_dbmobject(v) ((v)->ob_type == &Dbmtype) |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 49 | #define check_dbmobject_open(v) if ((v)->di_dbm == NULL) \ |
| 50 | { PyErr_SetString(DbmError, "GDBM object has already been closed"); \ |
| 51 | return NULL; } |
| 52 | |
| 53 | |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 54 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 55 | static PyObject *DbmError; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 56 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 57 | static char gdbm_object__doc__[] = "\ |
| 58 | This object represents a GDBM database.\n\ |
| 59 | GDBM objects behave like mappings (dictionaries), except that keys and\n\ |
| 60 | values are always strings. Printing a GDBM object doesn't print the\n\ |
| 61 | keys and values, and the items() and values() methods are not\n\ |
| 62 | supported.\n\ |
| 63 | \n\ |
| 64 | GDBM objects also support additional operations such as firstkey,\n\ |
| 65 | nextkey, reorganize, and sync."; |
| 66 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 67 | static PyObject * |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 68 | newdbmobject(file, flags, mode) |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 69 | char *file; |
| 70 | int flags; |
| 71 | int mode; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 72 | { |
| 73 | dbmobject *dp; |
| 74 | |
Guido van Rossum | b18618d | 2000-05-03 23:44:39 +0000 | [diff] [blame] | 75 | dp = PyObject_New(dbmobject, &Dbmtype); |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 76 | if (dp == NULL) |
| 77 | return NULL; |
| 78 | dp->di_size = -1; |
Guido van Rossum | b045afc | 1995-03-14 15:04:40 +0000 | [diff] [blame] | 79 | errno = 0; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 80 | if ( (dp->di_dbm = gdbm_open(file, 0, flags, mode, NULL)) == 0 ) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 81 | if (errno != 0) |
| 82 | PyErr_SetFromErrno(DbmError); |
| 83 | else |
Guido van Rossum | 573788e | 1998-10-03 05:15:07 +0000 | [diff] [blame] | 84 | PyErr_SetString(DbmError, gdbm_strerror(gdbm_errno)); |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 85 | Py_DECREF(dp); |
| 86 | return NULL; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 87 | } |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 88 | return (PyObject *)dp; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | /* Methods */ |
| 92 | |
| 93 | static void |
| 94 | dbm_dealloc(dp) |
| 95 | register dbmobject *dp; |
| 96 | { |
| 97 | if ( dp->di_dbm ) |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 98 | gdbm_close(dp->di_dbm); |
Guido van Rossum | b18618d | 2000-05-03 23:44:39 +0000 | [diff] [blame] | 99 | PyObject_Del(dp); |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | static int |
| 103 | dbm_length(dp) |
| 104 | dbmobject *dp; |
| 105 | { |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 106 | if (dp->di_dbm == NULL) { |
| 107 | PyErr_SetString(DbmError, "GDBM object has already been closed"); |
| 108 | return -1; |
| 109 | } |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 110 | if ( dp->di_size < 0 ) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 111 | datum key,okey; |
| 112 | int size; |
| 113 | okey.dsize=0; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 114 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 115 | size = 0; |
| 116 | for ( key=gdbm_firstkey(dp->di_dbm); key.dptr; |
| 117 | key = gdbm_nextkey(dp->di_dbm,okey)) { |
| 118 | size++; |
| 119 | if(okey.dsize) free(okey.dptr); |
| 120 | okey=key; |
| 121 | } |
| 122 | dp->di_size = size; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 123 | } |
| 124 | return dp->di_size; |
| 125 | } |
| 126 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 127 | static PyObject * |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 128 | dbm_subscript(dp, key) |
| 129 | dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 130 | register PyObject *key; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 131 | { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 132 | PyObject *v; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 133 | datum drec, krec; |
| 134 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 135 | if (!PyArg_Parse(key, "s#", &krec.dptr, &krec.dsize) ) |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 136 | return NULL; |
Fred Drake | da8d216 | 2000-02-07 17:19:41 +0000 | [diff] [blame] | 137 | |
| 138 | if (dp->di_dbm == NULL) { |
| 139 | PyErr_SetString(DbmError, |
| 140 | "GDBM object has already been closed"); |
| 141 | return NULL; |
| 142 | } |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 143 | drec = gdbm_fetch(dp->di_dbm, krec); |
| 144 | if ( drec.dptr == 0 ) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 145 | PyErr_SetString(PyExc_KeyError, |
| 146 | PyString_AS_STRING((PyStringObject *)key)); |
| 147 | return NULL; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 148 | } |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 149 | v = PyString_FromStringAndSize(drec.dptr, drec.dsize); |
Guido van Rossum | b045afc | 1995-03-14 15:04:40 +0000 | [diff] [blame] | 150 | free(drec.dptr); |
| 151 | return v; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 152 | } |
| 153 | |
| 154 | static int |
| 155 | dbm_ass_sub(dp, v, w) |
| 156 | dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 157 | PyObject *v, *w; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 158 | { |
| 159 | datum krec, drec; |
| 160 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 161 | if ( !PyArg_Parse(v, "s#", &krec.dptr, &krec.dsize) ) { |
| 162 | PyErr_SetString(PyExc_TypeError, |
| 163 | "gdbm mappings have string indices only"); |
| 164 | return -1; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 165 | } |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 166 | if (dp->di_dbm == NULL) { |
Fred Drake | da8d216 | 2000-02-07 17:19:41 +0000 | [diff] [blame] | 167 | PyErr_SetString(DbmError, |
| 168 | "GDBM object has already been closed"); |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 169 | return -1; |
| 170 | } |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 171 | dp->di_size = -1; |
| 172 | if (w == NULL) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 173 | if ( gdbm_delete(dp->di_dbm, krec) < 0 ) { |
| 174 | PyErr_SetString(PyExc_KeyError, |
| 175 | PyString_AS_STRING((PyStringObject *)v)); |
| 176 | return -1; |
| 177 | } |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 178 | } else { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 179 | if ( !PyArg_Parse(w, "s#", &drec.dptr, &drec.dsize) ) { |
| 180 | PyErr_SetString(PyExc_TypeError, |
| 181 | "gdbm mappings have string elements only"); |
| 182 | return -1; |
| 183 | } |
| 184 | errno = 0; |
| 185 | if ( gdbm_store(dp->di_dbm, krec, drec, GDBM_REPLACE) < 0 ) { |
| 186 | if (errno != 0) |
| 187 | PyErr_SetFromErrno(DbmError); |
| 188 | else |
| 189 | PyErr_SetString(DbmError, |
Guido van Rossum | 573788e | 1998-10-03 05:15:07 +0000 | [diff] [blame] | 190 | gdbm_strerror(gdbm_errno)); |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 191 | return -1; |
| 192 | } |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 193 | } |
| 194 | return 0; |
| 195 | } |
| 196 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 197 | static PyMappingMethods dbm_as_mapping = { |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 198 | (inquiry)dbm_length, /*mp_length*/ |
| 199 | (binaryfunc)dbm_subscript, /*mp_subscript*/ |
| 200 | (objobjargproc)dbm_ass_sub, /*mp_ass_subscript*/ |
| 201 | }; |
| 202 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 203 | static char dbm_close__doc__[] = "\ |
| 204 | close() -> None\n\ |
Guido van Rossum | cef113c | 1998-04-13 18:11:55 +0000 | [diff] [blame] | 205 | Closes the database."; |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 206 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 207 | static PyObject * |
Guido van Rossum | 807b7be | 1995-07-07 22:37:11 +0000 | [diff] [blame] | 208 | dbm_close(dp, args) |
| 209 | register dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 210 | PyObject *args; |
Guido van Rossum | 807b7be | 1995-07-07 22:37:11 +0000 | [diff] [blame] | 211 | { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 212 | if ( !PyArg_NoArgs(args) ) |
Guido van Rossum | 807b7be | 1995-07-07 22:37:11 +0000 | [diff] [blame] | 213 | return NULL; |
| 214 | if ( dp->di_dbm ) |
| 215 | gdbm_close(dp->di_dbm); |
| 216 | dp->di_dbm = NULL; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 217 | Py_INCREF(Py_None); |
| 218 | return Py_None; |
Guido van Rossum | 807b7be | 1995-07-07 22:37:11 +0000 | [diff] [blame] | 219 | } |
| 220 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 221 | static char dbm_keys__doc__[] = "\ |
| 222 | keys() -> list_of_keys\n\ |
| 223 | Get a list of all keys in the database."; |
| 224 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 225 | static PyObject * |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 226 | dbm_keys(dp, args) |
| 227 | register dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 228 | PyObject *args; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 229 | { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 230 | register PyObject *v, *item; |
Guido van Rossum | 3be7140 | 1996-07-21 02:32:44 +0000 | [diff] [blame] | 231 | datum key, nextkey; |
Guido van Rossum | 66017aa | 1995-08-28 02:58:00 +0000 | [diff] [blame] | 232 | int err; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 233 | |
| 234 | if (dp == NULL || !is_dbmobject(dp)) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 235 | PyErr_BadInternalCall(); |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 236 | return NULL; |
| 237 | } |
Guido van Rossum | 3be7140 | 1996-07-21 02:32:44 +0000 | [diff] [blame] | 238 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 239 | if (!PyArg_NoArgs(args)) |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 240 | return NULL; |
Guido van Rossum | 3be7140 | 1996-07-21 02:32:44 +0000 | [diff] [blame] | 241 | |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 242 | check_dbmobject_open(dp); |
| 243 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 244 | v = PyList_New(0); |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 245 | if (v == NULL) |
| 246 | return NULL; |
Guido van Rossum | 3be7140 | 1996-07-21 02:32:44 +0000 | [diff] [blame] | 247 | |
| 248 | key = gdbm_firstkey(dp->di_dbm); |
| 249 | while (key.dptr) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 250 | item = PyString_FromStringAndSize(key.dptr, key.dsize); |
| 251 | if (item == NULL) { |
| 252 | free(key.dptr); |
| 253 | Py_DECREF(v); |
| 254 | return NULL; |
| 255 | } |
| 256 | err = PyList_Append(v, item); |
| 257 | Py_DECREF(item); |
| 258 | if (err != 0) { |
| 259 | free(key.dptr); |
| 260 | Py_DECREF(v); |
| 261 | return NULL; |
| 262 | } |
| 263 | nextkey = gdbm_nextkey(dp->di_dbm, key); |
Guido van Rossum | 3be7140 | 1996-07-21 02:32:44 +0000 | [diff] [blame] | 264 | free(key.dptr); |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 265 | key = nextkey; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 266 | } |
Guido van Rossum | 3be7140 | 1996-07-21 02:32:44 +0000 | [diff] [blame] | 267 | |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 268 | return v; |
| 269 | } |
| 270 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 271 | static char dbm_has_key__doc__[] = "\ |
| 272 | has_key(key) -> boolean\n\ |
| 273 | Find out whether or not the database contains a given key."; |
| 274 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 275 | static PyObject * |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 276 | dbm_has_key(dp, args) |
| 277 | register dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 278 | PyObject *args; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 279 | { |
Guido van Rossum | b045afc | 1995-03-14 15:04:40 +0000 | [diff] [blame] | 280 | datum key; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 281 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 282 | if (!PyArg_Parse(args, "s#", &key.dptr, &key.dsize)) |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 283 | return NULL; |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 284 | check_dbmobject_open(dp); |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 285 | return PyInt_FromLong((long) gdbm_exists(dp->di_dbm, key)); |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 286 | } |
| 287 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 288 | static char dbm_firstkey__doc__[] = "\ |
| 289 | firstkey() -> key\n\ |
| 290 | It's possible to loop over every key in the database using this method\n\ |
| 291 | and the nextkey() method. The traversal is ordered by GDBM's internal\n\ |
| 292 | hash values, and won't be sorted by the key values. This method\n\ |
| 293 | returns the starting key."; |
| 294 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 295 | static PyObject * |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 296 | dbm_firstkey(dp, args) |
| 297 | register dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 298 | PyObject *args; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 299 | { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 300 | register PyObject *v; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 301 | datum key; |
| 302 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 303 | if (!PyArg_NoArgs(args)) |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 304 | return NULL; |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 305 | check_dbmobject_open(dp); |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 306 | key = gdbm_firstkey(dp->di_dbm); |
| 307 | if (key.dptr) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 308 | v = PyString_FromStringAndSize(key.dptr, key.dsize); |
| 309 | free(key.dptr); |
| 310 | return v; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 311 | } else { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 312 | Py_INCREF(Py_None); |
| 313 | return Py_None; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 314 | } |
| 315 | } |
| 316 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 317 | static char dbm_nextkey__doc__[] = "\ |
| 318 | nextkey(key) -> next_key\n\ |
| 319 | Returns the key that follows key in the traversal.\n\ |
| 320 | The following code prints every key in the database db, without having\n\ |
| 321 | to create a list in memory that contains them all:\n\ |
| 322 | \n\ |
| 323 | k = db.firstkey()\n\ |
| 324 | while k != None:\n\ |
| 325 | print k\n\ |
| 326 | k = db.nextkey(k)"; |
| 327 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 328 | static PyObject * |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 329 | dbm_nextkey(dp, args) |
| 330 | register dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 331 | PyObject *args; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 332 | { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 333 | register PyObject *v; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 334 | datum key, nextkey; |
| 335 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 336 | if (!PyArg_Parse(args, "s#", &key.dptr, &key.dsize)) |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 337 | return NULL; |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 338 | check_dbmobject_open(dp); |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 339 | nextkey = gdbm_nextkey(dp->di_dbm, key); |
| 340 | if (nextkey.dptr) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 341 | v = PyString_FromStringAndSize(nextkey.dptr, nextkey.dsize); |
| 342 | free(nextkey.dptr); |
| 343 | return v; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 344 | } else { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 345 | Py_INCREF(Py_None); |
| 346 | return Py_None; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 347 | } |
| 348 | } |
| 349 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 350 | static char dbm_reorganize__doc__[] = "\ |
| 351 | reorganize() -> None\n\ |
| 352 | If you have carried out a lot of deletions and would like to shrink\n\ |
| 353 | the space used by the GDBM file, this routine will reorganize the\n\ |
| 354 | database. GDBM will not shorten the length of a database file except\n\ |
| 355 | by using this reorganization; otherwise, deleted file space will be\n\ |
| 356 | kept and reused as new (key,value) pairs are added."; |
| 357 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 358 | static PyObject * |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 359 | dbm_reorganize(dp, args) |
| 360 | register dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 361 | PyObject *args; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 362 | { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 363 | if (!PyArg_NoArgs(args)) |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 364 | return NULL; |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 365 | check_dbmobject_open(dp); |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 366 | errno = 0; |
| 367 | if (gdbm_reorganize(dp->di_dbm) < 0) { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 368 | if (errno != 0) |
| 369 | PyErr_SetFromErrno(DbmError); |
| 370 | else |
Guido van Rossum | 573788e | 1998-10-03 05:15:07 +0000 | [diff] [blame] | 371 | PyErr_SetString(DbmError, gdbm_strerror(gdbm_errno)); |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 372 | return NULL; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 373 | } |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 374 | Py_INCREF(Py_None); |
| 375 | return Py_None; |
Guido van Rossum | fbd30e9 | 1995-03-16 16:07:34 +0000 | [diff] [blame] | 376 | } |
| 377 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 378 | static char dbm_sync__doc__[] = "\ |
| 379 | sync() -> None\n\ |
| 380 | When the database has been opened in fast mode, this method forces\n\ |
| 381 | any unwritten data to be written to the disk."; |
| 382 | |
Roger E. Masse | e5a9c8f | 1997-03-25 17:39:56 +0000 | [diff] [blame] | 383 | static PyObject * |
| 384 | dbm_sync(dp, args) |
| 385 | register dbmobject *dp; |
| 386 | PyObject *args; |
| 387 | { |
| 388 | if (!PyArg_NoArgs(args)) |
| 389 | return NULL; |
Guido van Rossum | 77eecfa | 1997-07-17 22:56:01 +0000 | [diff] [blame] | 390 | check_dbmobject_open(dp); |
Roger E. Masse | e5a9c8f | 1997-03-25 17:39:56 +0000 | [diff] [blame] | 391 | gdbm_sync(dp->di_dbm); |
| 392 | Py_INCREF(Py_None); |
| 393 | return Py_None; |
| 394 | } |
| 395 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 396 | static PyMethodDef dbm_methods[] = { |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 397 | {"close", (PyCFunction)dbm_close, 0, dbm_close__doc__}, |
| 398 | {"keys", (PyCFunction)dbm_keys, 0, dbm_keys__doc__}, |
| 399 | {"has_key", (PyCFunction)dbm_has_key, 0, dbm_has_key__doc__}, |
| 400 | {"firstkey", (PyCFunction)dbm_firstkey, 0, dbm_firstkey__doc__}, |
| 401 | {"nextkey", (PyCFunction)dbm_nextkey, 0, dbm_nextkey__doc__}, |
| 402 | {"reorganize", (PyCFunction)dbm_reorganize, 0, dbm_reorganize__doc__}, |
| 403 | {"sync", (PyCFunction)dbm_sync, 0, dbm_sync__doc__}, |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 404 | {NULL, NULL} /* sentinel */ |
| 405 | }; |
| 406 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 407 | static PyObject * |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 408 | dbm_getattr(dp, name) |
| 409 | dbmobject *dp; |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 410 | char *name; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 411 | { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 412 | return Py_FindMethod(dbm_methods, (PyObject *)dp, name); |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 413 | } |
| 414 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 415 | static PyTypeObject Dbmtype = { |
Guido van Rossum | b6e2a99 | 1998-10-03 05:13:27 +0000 | [diff] [blame] | 416 | PyObject_HEAD_INIT(0) |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 417 | 0, |
Guido van Rossum | 807b7be | 1995-07-07 22:37:11 +0000 | [diff] [blame] | 418 | "gdbm", |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 419 | sizeof(dbmobject), |
| 420 | 0, |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 421 | (destructor)dbm_dealloc, /*tp_dealloc*/ |
| 422 | 0, /*tp_print*/ |
| 423 | (getattrfunc)dbm_getattr, /*tp_getattr*/ |
| 424 | 0, /*tp_setattr*/ |
| 425 | 0, /*tp_compare*/ |
| 426 | 0, /*tp_repr*/ |
| 427 | 0, /*tp_as_number*/ |
| 428 | 0, /*tp_as_sequence*/ |
| 429 | &dbm_as_mapping, /*tp_as_mapping*/ |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 430 | 0, /*tp_hash*/ |
| 431 | 0, /*tp_call*/ |
| 432 | 0, /*tp_str*/ |
| 433 | 0, /*tp_getattro*/ |
| 434 | 0, /*tp_setattro*/ |
| 435 | 0, /*tp_as_buffer*/ |
| 436 | 0, /*tp_xxx4*/ |
| 437 | gdbm_object__doc__, /*tp_doc*/ |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 438 | }; |
| 439 | |
| 440 | /* ----------------------------------------------------------------- */ |
| 441 | |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 442 | static char dbmopen__doc__[] = "\ |
| 443 | open(filename, [flag, [mode]]) -> dbm_object\n\ |
| 444 | Open a dbm database and return a dbm object. The filename argument is\n\ |
| 445 | the name of the database file.\n\ |
| 446 | \n\ |
| 447 | The optional flag argument can be 'r' (to open an existing database\n\ |
| 448 | for reading only -- default), 'w' (to open an existing database for\n\ |
| 449 | reading and writing), 'c' (which creates the database if it doesn't\n\ |
| 450 | exist), or 'n' (which always creates a new empty database).\n\ |
| 451 | \n\ |
| 452 | Appending f to the flag opens the database in fast mode; altered\n\ |
| 453 | data will not automatically be written to the disk after every\n\ |
| 454 | change. This results in faster writes to the database, but may\n\ |
| 455 | result in an inconsistent database if the program crashes while the\n\ |
| 456 | database is still open. Use the sync() method to force any\n\ |
| 457 | unwritten data to be written to the disk.\n\ |
| 458 | \n\ |
| 459 | The optional mode argument is the Unix mode of the file, used only\n\ |
| 460 | when the database has to be created. It defaults to octal 0666. "; |
| 461 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 462 | static PyObject * |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 463 | dbmopen(self, args) |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 464 | PyObject *self; |
| 465 | PyObject *args; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 466 | { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 467 | char *name; |
| 468 | char *flags = "r "; |
| 469 | int iflags; |
| 470 | int mode = 0666; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 471 | |
Guido van Rossum | 43713e5 | 2000-02-29 13:59:29 +0000 | [diff] [blame] | 472 | if ( !PyArg_ParseTuple(args, "s|si:open", &name, &flags, &mode) ) |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 473 | return NULL; |
Guido van Rossum | e36e1fe | 1996-01-26 21:08:01 +0000 | [diff] [blame] | 474 | switch (flags[0]) { |
| 475 | case 'r': |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 476 | iflags = GDBM_READER; |
| 477 | break; |
Guido van Rossum | e36e1fe | 1996-01-26 21:08:01 +0000 | [diff] [blame] | 478 | case 'w': |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 479 | iflags = GDBM_WRITER; |
| 480 | break; |
Guido van Rossum | e36e1fe | 1996-01-26 21:08:01 +0000 | [diff] [blame] | 481 | case 'c': |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 482 | iflags = GDBM_WRCREAT; |
| 483 | break; |
Guido van Rossum | e36e1fe | 1996-01-26 21:08:01 +0000 | [diff] [blame] | 484 | case 'n': |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 485 | iflags = GDBM_NEWDB; |
| 486 | break; |
| 487 | default: |
| 488 | PyErr_SetString(DbmError, |
| 489 | "Flags should be one of 'r', 'w', 'c' or 'n'"); |
| 490 | return NULL; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 491 | } |
Guido van Rossum | e36e1fe | 1996-01-26 21:08:01 +0000 | [diff] [blame] | 492 | if (flags[1] == 'f') |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 493 | iflags |= GDBM_FAST; |
| 494 | return newdbmobject(name, iflags, mode); |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 495 | } |
| 496 | |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 497 | static PyMethodDef dbmmodule_methods[] = { |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 498 | { "open", (PyCFunction)dbmopen, 1, dbmopen__doc__}, |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 499 | { 0, 0 }, |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 500 | }; |
| 501 | |
Guido van Rossum | 3886bb6 | 1998-12-04 18:50:17 +0000 | [diff] [blame] | 502 | DL_EXPORT(void) |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 503 | initgdbm() { |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 504 | PyObject *m, *d; |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 505 | |
Guido van Rossum | b6e2a99 | 1998-10-03 05:13:27 +0000 | [diff] [blame] | 506 | Dbmtype.ob_type = &PyType_Type; |
Guido van Rossum | bfc49e8 | 1998-03-03 22:02:24 +0000 | [diff] [blame] | 507 | m = Py_InitModule4("gdbm", dbmmodule_methods, |
| 508 | gdbmmodule__doc__, (PyObject *)NULL, |
| 509 | PYTHON_API_VERSION); |
Roger E. Masse | b15bef8 | 1996-12-17 19:55:33 +0000 | [diff] [blame] | 510 | d = PyModule_GetDict(m); |
Guido van Rossum | 0cb96de | 1997-10-01 04:29:29 +0000 | [diff] [blame] | 511 | DbmError = PyErr_NewException("gdbm.error", NULL, NULL); |
| 512 | if (DbmError != NULL) |
| 513 | PyDict_SetItemString(d, "error", DbmError); |
Guido van Rossum | 4b4c664 | 1994-08-08 08:06:37 +0000 | [diff] [blame] | 514 | } |