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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
<?php
/**
* Native CDB file reader and writer.
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* Read from a CDB file.
* Native and pure PHP implementations are provided.
* http://cr.yp.to/cdb.html
*/
abstract class CdbReader {
/**
* The file handle
*/
protected $handle;
/**
* Open a file and return a subclass instance
*
* @param string $fileName
*
* @return CdbReader
*/
public static function open( $fileName ) {
return self::haveExtension() ?
new CdbReaderDBA( $fileName ) :
new CdbReaderPHP( $fileName );
}
/**
* Returns true if the native extension is available
*
* @return bool
*/
public static function haveExtension() {
if ( !function_exists( 'dba_handlers' ) ) {
return false;
}
$handlers = dba_handlers();
if ( !in_array( 'cdb', $handlers ) || !in_array( 'cdb_make', $handlers ) ) {
return false;
}
return true;
}
/**
* Create the object and open the file
*
* @param string $fileName
*/
abstract public function __construct( $fileName );
/**
* Close the file. Optional, you can just let the variable go out of scope.
*/
abstract public function close();
/**
* Get a value with a given key. Only string values are supported.
*
* @param string $key
*/
abstract public function get( $key );
}
/**
* Write to a CDB file.
* Native and pure PHP implementations are provided.
*/
abstract class CdbWriter {
/**
* The file handle
*/
protected $handle;
/**
* File we'll be writing to when we're done
* @var string
*/
protected $realFileName;
/**
* File we write to temporarily until we're done
* @var string
*/
protected $tmpFileName;
/**
* Open a writer and return a subclass instance.
* The user must have write access to the directory, for temporary file creation.
*
* @param string $fileName
*
* @return CdbWriterDBA|CdbWriterPHP
*/
public static function open( $fileName ) {
return CdbReader::haveExtension() ?
new CdbWriterDBA( $fileName ) :
new CdbWriterPHP( $fileName );
}
/**
* Create the object and open the file
*
* @param string $fileName
*/
abstract public function __construct( $fileName );
/**
* Set a key to a given value. The value will be converted to string.
* @param string $key
* @param string $value
*/
abstract public function set( $key, $value );
/**
* Close the writer object. You should call this function before the object
* goes out of scope, to write out the final hashtables.
*/
abstract public function close();
/**
* If the object goes out of scope, close it for sanity
*/
public function __destruct() {
if ( isset( $this->handle ) ) {
$this->close();
}
}
/**
* Are we running on Windows?
* @return bool
*/
protected function isWindows() {
return substr( php_uname(), 0, 7 ) == 'Windows';
}
}
/**
* Exception for Cdb errors.
* This explicitly doesn't subclass MWException to encourage reuse.
*/
class CdbException extends Exception {
}
|
