1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
{-# OPTIONS -fallow-overlapping-instances #-}
{- arch-tag: Interface to anydbm.py
Copyright (C) 2005 John Goerzen <jgoerzen@complete.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-}
{- |
Module : MissingPy.AnyDBM
Copyright : Copyright (C) 2005 John Goerzen
License : GNU GPL, version 2 or above
Maintainer : John Goerzen,
Maintainer : jgoerzen\@complete.org
Stability : provisional
Portability: portable
This module interfaces "Database.AnyDBM" to Python's anydbm.py.
Implementations for specific Python *dbm modules are also available.
See and import "Database.AnyDBM" to use these features.
Written by John Goerzen, jgoerzen\@complete.org
-}
module MissingPy.AnyDBM(PyDBMOpenFlags(..),
openAnyDBM,
openSpecificDBM
)
where
import Python.Objects.Dict
import Python.Interpreter
import Python.Utils
import Python.Exceptions
import Python.Objects
import Database.AnyDBM
{- | Flags used to open a dbm-type database -}
data PyDBMOpenFlags =
DBM_ReadOnly -- ^ Open an /existing/ database for read only
| DBM_ReadWrite -- ^ Open an /existing/ database for reading and writing
| DBM_ReadWriteCreate -- ^ Open a database for reading and writing, creating if it doesn't exist
| DBM_ReadWriteNew -- ^ Open a database, creating it anew each time (deleting any existing data)
flag2str :: PyDBMOpenFlags -> String
flag2str DBM_ReadOnly = "r"
flag2str DBM_ReadWrite = "w"
flag2str DBM_ReadWriteCreate = "c"
flag2str DBM_ReadWriteNew = "n"
{- | Opens a persistent storage database using the \"best\" storage mechanism
available to Python on this system. This will usually be one of the *dbm
services, though in rare circumstances, could be \"dumbdbm\", which is
only marginally better than "Database.AnyDBM.StringDBM".
-}
openAnyDBM :: FilePath -> PyDBMOpenFlags -> IO PyDict
openAnyDBM = openSpecificDBM "anydbm"
{- | Open a database using a specific module given by the first parameter. The
module supported are:
* dbhash
* dbm
* dumbdbm
* gdbm
SECURITY NOTE: the string is not validated before being passed to Python.
Do not pass an arbitrary value to this function.
-}
openSpecificDBM :: String -- ^ Python module name to use
-> FilePath -- ^ Path to database files
-> PyDBMOpenFlags -- ^ Flags to use when opening
-> IO PyDict -- ^ Result
openSpecificDBM mod fp flag =
let flagstr = flag2str flag
in handlePy exc2ioerror $
do pyImport mod
fileobj <- toPyObject fp
flagobj <- toPyObject flagstr
obj <- callByName (mod ++ ".open") [fileobj, flagobj] []
return $ mkPyDict obj
|
