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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
<?php
/**
* Horde VFS API for abstracted file storage and access.
*
* $Horde: horde/lib/VFS.php,v 1.21.2.3 2003/01/03 13:23:28 jan Exp $
*
* Copyright 2002-2003 Chuck Hagenbuch <chuck@horde.org>
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @version $Revision: 1.21.2.3 $
* @package horde.vfs
* @since Horde 2.2
*/
class Horde_VFS {
/**
* Hash containing connection parameters.
*
* @var $_params array
*/
var $_params = array();
/**
* List of additional credentials required for this VFS backend
* (example: For FTP, we need a username and password to log in to
* the server with).
*
* @var $_credentials array
*/
var $_credentials = array();
/**
* List of permissions and if they can be changed in this VFS
* backend.
*
* @var $_permissions array
*/
var $_permissions = array(
'owner' => array('read' => false, 'write' => false, 'execute' => false),
'group' => array('read' => false, 'write' => false, 'execute' => false),
'all' => array('read' => false, 'write' => false, 'execute' => false));
/**
* Attempts to return a concrete Horde_VFS instance based on $driver.
*
* @param mixed $driver The type of concrete Horde_VFS subclass to return.
* This is based on the storage driver ($driver). The
* code is dynamically included. If $driver is an array,
* then we will look in $driver[0]/lib/VFS/ for
* the subclass implementation named $driver[1].php.
* @param array $params (optional) A hash containing any additional
* configuration or connection parameters a subclass
* might need.
*
* @return object Horde_VFS The newly created concrete Horde_VFS instance,
* or false on an error.
*/
function &factory($driver, $params = array())
{
if (is_array($driver)) {
list($app, $driver) = $driver;
}
/* Return a base Horde_VFS object if no driver is specified. */
$driver = strtolower($driver);
if (empty($driver) || (strcmp($driver, 'none') == 0)) {
return new Horde_VFS($params);
}
if (@file_exists(dirname(__FILE__) . '/VFS/' . $driver . '.php')) {
include_once dirname(__FILE__) . '/VFS/' . $driver . '.php';
} else {
@include_once 'Horde/VFS/' . $driver . '.php';
}
$class = 'Horde_VFS_' . $driver;
if (class_exists($class)) {
return new $class($params);
} else {
return PEAR::raiseError('Class definition of ' . $class . ' not found.');
}
}
/**
* Attempts to return a reference to a concrete Horde_VFS instance
* based on $driver. It will only create a new instance if no
* Horde_VFS instance with the same parameters currently exists.
*
* This should be used if multiple types of file backends (and,
* thus, multiple Horde_VFS instances) are required.
*
* This method must be invoked as: $var = &Horde_VFS::singleton()
*
* @param mixed $driver The type of concrete Horde_VFS subclass to return.
* This is based on the storage driver ($driver). The
* code is dynamically included. If $driver is an array,
* then we will look in $driver[0]/lib/VFS/ for
* the subclass implementation named $driver[1].php.
* @param array $params (optional) A hash containing any additional
* configuration or connection parameters a subclass
* might need.
*
* @return object Horde_VFS The concrete Horde_VFS reference, or false on an
* error.
*/
function &singleton($driver, $params = array())
{
static $instances;
if (!isset($instances)) {
$instances = array();
}
if (is_array($driver)) {
$drivertag = implode(':', $driver);
} else {
$drivertag = $driver;
}
$signature = md5(strtolower($drivertag) . '][' . implode('][', $params));
if (!isset($instances[$signature])) {
$instances[$signature] = &Horde_VFS::factory($driver, $params);
}
return $instances[$signature];
}
/**
* Check the credentials that we have by calling _connect(), to
* see if there is a valid login.
*
* @return mixed True on success, PEAR_Error describing the problem
* if the credentials are invalid.
*/
function checkCredentials()
{
return $this->_connect();
}
/**
* Set configuration parameters.
*
* @param array $params An associative array, parameter name => parameter value.
*/
function setParams($params = array())
{
foreach ($params as $name => $value) {
$this->_params[$name] = $value;
}
}
/**
* Retrieve a file from the VFS.
*
*
* @param string $path The pathname to the file.
* @param string $name The filename to retrieve.
*
* @return string The file data.
*/
function read($path, $name)
{
return PEAR::raiseError('not supported');
}
/**
* Store a file in the VFS.
*
* @param string $path The path to store the file in.
* @param string $name The filename to use.
* @param string $tmpFile The temporary file containing the data to be stored.
* @param boolean $autocreate (optional) Automatically create directories?
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function write($path, $name, $tmpFile, $autocreate = false)
{
return PEAR::raiseError('not supported');
}
/**
* Store a file in the VFS from raw data.
*
* @param string $path The path to store the file in.
* @param string $name The filename to use.
* @param string $data The file data.
* @param boolean $autocreate (optional) Automatically create directories?
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function writeData($path, $name, $data, $autocreate = false)
{
return PEAR::raiseError('not supported');
}
/**
* Delete a file from the VFS.
*
* @param string $path The path to store the file in.
* @param string $name The filename to use.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function deleteFile($path, $name)
{
return PEAR::raiseError('not supported');
}
/**
* Rename a file in the VFS.
*
* @param string $oldpath The old path to the file.
* @param string $oldname The old filename.
* @param string $newpath The new path of the file.
* @param string $newname The new filename.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function rename($oldpath, $oldname, $newpath, $newname)
{
return PEAR::raiseError('not supported');
}
/**
* Create a folder in the VFS.
*
* @param string $path The path to the folder.
* @param string $name The name of the new folder.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function createFolder($path, $name)
{
return PEAR::raiseError('not supported');
}
/**
* Deletes a folder from the VFS.
*
* @param string $path The path of the folder to delete.
* @param string $name The name of the folder to delete.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function deleteFolder($path, $name)
{
return PEAR::raiseError('not supported');
}
/**
* Returns a file list of the directory passed in.
*
* @param string $path The path of the diretory.
*
* @return mixed File list (array) on success or a PEAR_Error
* object on failure.
*/
function listFolder($path)
{
return PEAR::raiseError('not supported');
}
/**
* Changes permissions for an Item on the VFS.
*
* @param string $path Holds the path of directory of the Item.
* @param string $name Holds the name of the Item.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function changePermissions($path, $name, $permission)
{
return PEAR::raiseError('not supported');
}
/**
* Return the list of additional credentials required, if any.
*
* @return array Credential list
*/
function getRequiredCredentials()
{
return $this->_credentials;
}
/**
* Return the array specificying what permissions are
* changeable for this implementation.
*
* @return array Changeable Permisions
*/
function getModifiablePermissions()
{
return $this->_permissions;
}
/**
* Close any resources that need to be closed.
*/
function _disconnect()
{
}
}
|
