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