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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author J0WI <J0WI@users.noreply.github.com>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Robin Appelman <robin@icewind.nl>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Tigran Mkrtchyan <tigran.mkrtchyan@desy.de>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Files\Storage;
use OCP\Files\Cache\ICache;
use OCP\Files\Cache\IPropagator;
use OCP\Files\Cache\IScanner;
use OCP\Files\Cache\IUpdater;
use OCP\Files\Cache\IWatcher;
use OCP\Files\InvalidPathException;
/**
* Provide a common interface to all different storage options
*
* All paths passed to the storage are relative to the storage and should NOT have a leading slash.
*
* @since 9.0.0
*/
interface IStorage {
/**
* $parameters is a free form array with the configuration options needed to construct the storage
*
* @param array $parameters
* @since 9.0.0
*/
public function __construct($parameters);
/**
* Get the identifier for the storage,
* the returned id should be the same for every storage object that is created with the same parameters
* and two storage objects with the same id should refer to two storages that display the same files.
*
* @return string
* @since 9.0.0
*/
public function getId();
/**
* see https://www.php.net/manual/en/function.mkdir.php
* implementations need to implement a recursive mkdir
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function mkdir($path);
/**
* see https://www.php.net/manual/en/function.rmdir.php
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function rmdir($path);
/**
* see https://www.php.net/manual/en/function.opendir.php
*
* @param string $path
* @return resource|bool
* @since 9.0.0
*/
public function opendir($path);
/**
* see https://www.php.net/manual/en/function.is-dir.php
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function is_dir($path);
/**
* see https://www.php.net/manual/en/function.is-file.php
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function is_file($path);
/**
* see https://www.php.net/manual/en/function.stat.php
* only the following keys are required in the result: size and mtime
*
* @param string $path
* @return array|bool
* @since 9.0.0
*/
public function stat($path);
/**
* see https://www.php.net/manual/en/function.filetype.php
*
* @param string $path
* @return string|bool
* @since 9.0.0
*/
public function filetype($path);
/**
* see https://www.php.net/manual/en/function.filesize.php
* The result for filesize when called on a folder is required to be 0
*
* @param string $path
* @return int|bool
* @since 9.0.0
*/
public function filesize($path);
/**
* check if a file can be created in $path
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function isCreatable($path);
/**
* check if a file can be read
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function isReadable($path);
/**
* check if a file can be written to
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function isUpdatable($path);
/**
* check if a file can be deleted
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function isDeletable($path);
/**
* check if a file can be shared
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function isSharable($path);
/**
* get the full permissions of a path.
* Should return a combination of the PERMISSION_ constants defined in lib/public/constants.php
*
* @param string $path
* @return int
* @since 9.0.0
*/
public function getPermissions($path);
/**
* see https://www.php.net/manual/en/function.file_exists.php
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function file_exists($path);
/**
* see https://www.php.net/manual/en/function.filemtime.php
*
* @param string $path
* @return int|bool
* @since 9.0.0
*/
public function filemtime($path);
/**
* see https://www.php.net/manual/en/function.file_get_contents.php
*
* @param string $path
* @return string|bool
* @since 9.0.0
*/
public function file_get_contents($path);
/**
* see https://www.php.net/manual/en/function.file_put_contents.php
*
* @param string $path
* @param mixed $data
* @return int|false
* @since 9.0.0
*/
public function file_put_contents($path, $data);
/**
* see https://www.php.net/manual/en/function.unlink.php
*
* @param string $path
* @return bool
* @since 9.0.0
*/
public function unlink($path);
/**
* see https://www.php.net/manual/en/function.rename.php
*
* @param string $path1
* @param string $path2
* @return bool
* @since 9.0.0
*/
public function rename($path1, $path2);
/**
* see https://www.php.net/manual/en/function.copy.php
*
* @param string $path1
* @param string $path2
* @return bool
* @since 9.0.0
*/
public function copy($path1, $path2);
/**
* see https://www.php.net/manual/en/function.fopen.php
*
* @param string $path
* @param string $mode
* @return resource|bool
* @since 9.0.0
*/
public function fopen($path, $mode);
/**
* get the mimetype for a file or folder
* The mimetype for a folder is required to be "httpd/unix-directory"
*
* @param string $path
* @return string|bool
* @since 9.0.0
*/
public function getMimeType($path);
/**
* see https://www.php.net/manual/en/function.hash-file.php
*
* @param string $type
* @param string $path
* @param bool $raw
* @return string|bool
* @since 9.0.0
*/
public function hash($type, $path, $raw = false);
/**
* see https://www.php.net/manual/en/function.free_space.php
*
* @param string $path
* @return int|bool
* @since 9.0.0
*/
public function free_space($path);
/**
* see https://www.php.net/manual/en/function.touch.php
* If the backend does not support the operation, false should be returned
*
* @param string $path
* @param int $mtime
* @return bool
* @since 9.0.0
*/
public function touch($path, $mtime = null);
/**
* get the path to a local version of the file.
* The local version of the file can be temporary and doesn't have to be persistent across requests
*
* @param string $path
* @return string|bool
* @since 9.0.0
*/
public function getLocalFile($path);
/**
* check if a file or folder has been updated since $time
*
* @param string $path
* @param int $time
* @return bool
* @since 9.0.0
*
* hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
* returning true for other changes in the folder is optional
*/
public function hasUpdated($path, $time);
/**
* get the ETag for a file or folder
*
* @param string $path
* @return string|bool
* @since 9.0.0
*/
public function getETag($path);
/**
* Returns whether the storage is local, which means that files
* are stored on the local filesystem instead of remotely.
* Calling getLocalFile() for local storages should always
* return the local files, whereas for non-local storages
* it might return a temporary file.
*
* @return bool true if the files are stored locally, false otherwise
* @since 9.0.0
*/
public function isLocal();
/**
* Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
*
* @param string $class
* @return bool
* @since 9.0.0
*/
public function instanceOfStorage($class);
/**
* A custom storage implementation can return an url for direct download of a give file.
*
* For now the returned array can hold the parameter url - in future more attributes might follow.
*
* @param string $path
* @return array|bool
* @since 9.0.0
*/
public function getDirectDownload($path);
/**
* @param string $path the path of the target folder
* @param string $fileName the name of the file itself
* @return void
* @throws InvalidPathException
* @since 9.0.0
*/
public function verifyPath($path, $fileName);
/**
* @param IStorage $sourceStorage
* @param string $sourceInternalPath
* @param string $targetInternalPath
* @return bool
* @since 9.0.0
*/
public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
/**
* @param IStorage $sourceStorage
* @param string $sourceInternalPath
* @param string $targetInternalPath
* @return bool
* @since 9.0.0
*/
public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath);
/**
* Test a storage for availability
*
* @since 9.0.0
* @return bool
*/
public function test();
/**
* @since 9.0.0
* @return array [ available, last_checked ]
*/
public function getAvailability();
/**
* @since 9.0.0
* @param bool $isAvailable
*/
public function setAvailability($isAvailable);
/**
* @param string $path path for which to retrieve the owner
* @since 9.0.0
*/
public function getOwner($path);
/**
* @return ICache
* @since 9.0.0
*/
public function getCache();
/**
* @return IPropagator
* @since 9.0.0
*/
public function getPropagator();
/**
* @return IScanner
* @since 9.0.0
*/
public function getScanner();
/**
* @return IUpdater
* @since 9.0.0
*/
public function getUpdater();
/**
* @return IWatcher
* @since 9.0.0
*/
public function getWatcher();
}
|