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
/**
* Copyright (c) 2012 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OC\Files\Storage;
/**
* Storage backend class for providing common filesystem operation methods
* which are not storage-backend specific.
*
* \OC\Files\Storage\Common is never used directly; it is extended by all other
* storage backends, where its methods may be overridden, and additional
* (backend-specific) methods are defined.
*
* Some \OC\Files\Storage\Common methods call functions which are first defined
* in classes which extend it, e.g. $this->stat() .
*/
abstract class Common implements \OC\Files\Storage\Storage {
public function __construct($parameters) {}
public function is_dir($path) {
return $this->filetype($path)=='dir';
}
public function is_file($path) {
return $this->filetype($path)=='file';
}
public function filesize($path) {
if($this->is_dir($path)) {
return 0;//by definition
}else{
$stat = $this->stat($path);
return $stat['size'];
}
}
public function isCreatable($path) {
if ($this->is_dir($path) && $this->isUpdatable($path)) {
return true;
}
return false;
}
public function isDeletable($path) {
return $this->isUpdatable($path);
}
public function isSharable($path) {
return $this->isReadable($path);
}
public function getPermissions($path){
$permissions = 0;
if($this->isCreatable($path)) {
$permissions |= \OCP\PERMISSION_CREATE;
}
if($this->isReadable($path)) {
$permissions |= \OCP\PERMISSION_READ;
}
if($this->isUpdatable($path)) {
$permissions |= \OCP\PERMISSION_UPDATE;
}
if($this->isDeletable($path)) {
$permissions |= \OCP\PERMISSION_DELETE;
}
if($this->isSharable($path)) {
$permissions |= \OCP\PERMISSION_SHARE;
}
return $permissions;
}
public function filemtime($path) {
$stat = $this->stat($path);
return $stat['mtime'];
}
public function file_get_contents($path) {
$handle = $this->fopen($path, "r");
if(!$handle) {
return false;
}
$size=$this->filesize($path);
if($size==0) {
return '';
}
return fread($handle, $size);
}
public function file_put_contents($path, $data) {
$handle = $this->fopen($path, "w");
return fwrite($handle, $data);
}
public function rename($path1, $path2) {
if($this->copy($path1, $path2)) {
return $this->unlink($path1);
}else{
return false;
}
}
public function copy($path1, $path2) {
$source=$this->fopen($path1, 'r');
$target=$this->fopen($path2, 'w');
$count=\OC_Helper::streamCopy($source, $target);
return $count>0;
}
/**
* @brief Deletes all files and folders recursively within a directory
* @param string $directory The directory whose contents will be deleted
* @param bool $empty Flag indicating whether directory will be emptied
* @returns bool
*
* @note By default the directory specified by $directory will be
* deleted together with its contents. To avoid this set $empty to true
*/
public function deleteAll( $directory, $empty = false ) {
$directory = trim($directory, '/');
if ( !$this->file_exists( \OCP\USER::getUser() . '/' . $directory )
|| !$this->is_dir( \OCP\USER::getUser() . '/' . $directory ) ) {
return false;
} elseif( !$this->isReadable( \OCP\USER::getUser() . '/' . $directory ) ) {
return false;
} else {
$directoryHandle = $this->opendir( \OCP\USER::getUser() . '/' . $directory );
while ( $contents = readdir( $directoryHandle ) ) {
if ( $contents != '.' && $contents != '..') {
$path = $directory . "/" . $contents;
if ( $this->is_dir( $path ) ) {
$this->deleteAll( $path );
} else {
$this->unlink( \OCP\USER::getUser() .'/' . $path ); // TODO: make unlink use same system path as is_dir
}
}
}
//$this->closedir( $directoryHandle ); // TODO: implement closedir in OC_FSV
if ( $empty == false ) {
if ( !$this->rmdir( $directory ) ) {
return false;
}
}
return true;
}
}
public function getMimeType($path) {
if(!$this->file_exists($path)) {
return false;
}
if($this->is_dir($path)) {
return 'httpd/unix-directory';
}
$source=$this->fopen($path, 'r');
if(!$source) {
return false;
}
$head=fread($source, 8192);//8kb should suffice to determine a mimetype
if($pos=strrpos($path, '.')) {
$extension=substr($path, $pos);
}else{
$extension='';
}
$tmpFile=\OC_Helper::tmpFile($extension);
file_put_contents($tmpFile, $head);
$mime=\OC_Helper::getMimeType($tmpFile);
unlink($tmpFile);
return $mime;
}
public function hash($type, $path, $raw = false) {
$tmpFile=$this->getLocalFile($path);
$hash=hash($type, $tmpFile, $raw);
unlink($tmpFile);
return $hash;
}
public function search($query) {
return $this->searchInDir($query);
}
public function getLocalFile($path) {
return $this->toTmpFile($path);
}
private function toTmpFile($path) {//no longer in the storage api, still useful here
$source=$this->fopen($path, 'r');
if(!$source) {
return false;
}
if($pos=strrpos($path, '.')) {
$extension=substr($path, $pos);
}else{
$extension='';
}
$tmpFile=\OC_Helper::tmpFile($extension);
$target=fopen($tmpFile, 'w');
\OC_Helper::streamCopy($source, $target);
return $tmpFile;
}
public function getLocalFolder($path) {
$baseDir=\OC_Helper::tmpFolder();
$this->addLocalFolder($path, $baseDir);
return $baseDir;
}
private function addLocalFolder($path, $target) {
if($dh=$this->opendir($path)) {
while($file=readdir($dh)) {
if($file!=='.' and $file!=='..') {
if($this->is_dir($path.'/'.$file)) {
mkdir($target.'/'.$file);
$this->addLocalFolder($path.'/'.$file, $target.'/'.$file);
}else{
$tmp=$this->toTmpFile($path.'/'.$file);
rename($tmp, $target.'/'.$file);
}
}
}
}
}
protected function searchInDir($query, $dir='') {
$files=array();
$dh=$this->opendir($dir);
if($dh) {
while($item=readdir($dh)) {
if ($item == '.' || $item == '..') continue;
if(strstr(strtolower($item), strtolower($query))!==false) {
$files[]=$dir.'/'.$item;
}
if($this->is_dir($dir.'/'.$item)) {
$files=array_merge($files, $this->searchInDir($query, $dir.'/'.$item));
}
}
}
return $files;
}
/**
* check if a file or folder has been updated since $time
* @param string $path
* @param int $time
* @return bool
*/
public function hasUpdated($path, $time) {
return $this->filemtime($path)>$time;
}
public function getCache($path=''){
return new \OC\Files\Cache\Cache($this);
}
public function getScanner($path=''){
return new \OC\Files\Cache\Scanner($this);
}
public function getPermissionsCache($path=''){
return new \OC\Files\Cache\Permissions($this);
}
public function getWatcher($path=''){
return new \OC\Files\Cache\Watcher($this);
}
/**
* get the owner of a path
* @param string $path The path to get the owner
* @return string uid or false
*/
public function getOwner($path) {
return \OC_User::getUser();
}
/**
* get the ETag for a file or folder
*
* @param string $path
* @return string
*/
public function getETag($path){
$ETagFunction = \OC_Connector_Sabre_Node::$ETagFunction;
if($ETagFunction) {
$hash = call_user_func($ETagFunction, $path);
return $hash;
}else{
return uniqid();
}
}
/**
* clean a path, i.e. remove all redundant '.' and '..'
* making sure that it can't point to higher than '/'
* @param $path The path to clean
* @return string cleaned path
*/
public function cleanPath($path) {
if (strlen($path) == 0 or $path[0] != '/') {
$path = '/' . $path;
}
$output = array();
foreach (explode('/', $path) as $chunk) {
if ($chunk == '..') {
array_pop($output);
} else if ($chunk == '.') {
} else {
$output[] = $chunk;
}
}
return implode('/', $output);
}
}
|