ecommun / owncloud_ynh

Blame view

sources/lib/private/fileproxy.php 3.45 KB
edit raw normal view history
03e52840d   Kload   Init 
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
 
  <?php
  
  /**
  * ownCloud
  *
  * @author Robin Appelman
  * @copyright 2011 Robin Appelman icewind1991@gmail.com
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
  * License as published by the Free Software Foundation; either
  * version 3 of the License, or any later version.
  *
  * This library 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 along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *
  */
  
  /**
   * Class for manipulating filesystem requests
   *
   * Manipulation happens by using 2 kind of proxy operations, pre and post proxies
   * that manipulate the filesystem call and the result of the call respectively
   *
   * A pre-proxy recieves the filepath as arugments (or 2 filespaths in case of
   * operations like copy or move) and return a boolean
   * If a pre-proxy returns false the file operation will be canceled
   * All filesystem operations have a pre-proxy
   *
   * A post-proxy recieves 2 arguments, the filepath and the result of the operation.
   * The return value of the post-proxy will be used as the new result of the operation
   * The operations that have a post-proxy are:
   * file_get_contents, is_file, is_dir, file_exists, stat, is_readable,
   * is_writable, filemtime, filectime, file_get_contents,
   * getMimeType, hash, fopen, free_space and search
   */
  
  class OC_FileProxy{
  	private static $proxies=array();
  	public static $enabled=true;
  
  	/**
  	 * fallback function when a proxy operation is not implemented
  	 * @param string $function the name of the proxy operation
6d9380f96   Cédric Dupont   Update sources OC... 
50
 
  	 * @param mixed $arguments
03e52840d   Kload   Init 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
  	 *
  	 * this implements a dummy proxy for all operations
  	 */
  	public function __call($function, $arguments) {
  		if(substr($function, 0, 3)=='pre') {
  			return true;
  		}else{
  			return $arguments[1];
  		}
  	}
  
  	/**
  	 * register a proxy to be used
  	 * @param OC_FileProxy $proxy
  	 */
  	public static function register($proxy) {
  		self::$proxies[]=$proxy;
  	}
6d9380f96   Cédric Dupont   Update sources OC... 
69
70
71
72
73
74
75
76
 
  	/**
  	 * @param string $operation
  	 */
  	public static function getProxies($operation = null) {
  		if ($operation === null) {
  			// return all
  			return self::$proxies;
  		}
03e52840d   Kload   Init 
77
78
79
80
81
82
83
84
 
  		$proxies=array();
  		foreach(self::$proxies as $proxy) {
  			if(method_exists($proxy, $operation)) {
  				$proxies[]=$proxy;
  			}
  		}
  		return $proxies;
  	}
6d9380f96   Cédric Dupont   Update sources OC... 
85
86
87
88
 
  	/**
  	 * @param string $operation
  	 * @param string|boolean $filepath
  	 */
03e52840d   Kload   Init 
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
  	public static function runPreProxies($operation,&$filepath,&$filepath2=null) {
  		if(!self::$enabled) {
  			return true;
  		}
  		$operation='pre'.$operation;
  		$proxies=self::getProxies($operation);
  		foreach($proxies as $proxy) {
  			if(!is_null($filepath2)) {
  				if($proxy->$operation($filepath, $filepath2)===false) {
  					return false;
  				}
  			}else{
  				if($proxy->$operation($filepath)===false) {
  					return false;
  				}
  			}
  		}
  		return true;
  	}
6d9380f96   Cédric Dupont   Update sources OC... 
108
109
110
111
112
113
 
  	/**
  	 * @param string $operation
  	 * @param string|boolean $path
  	 *
  	 * @return string
  	 */
03e52840d   Kload   Init 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
  	public static function runPostProxies($operation, $path, $result) {
  		if(!self::$enabled) {
  			return $result;
  		}
  		$operation='post'.$operation;
  		$proxies=self::getProxies($operation);
  		foreach($proxies as $proxy) {
  			$result=$proxy->$operation($path, $result);
  		}
  		return $result;
  	}
  
  	public static function clearProxies() {
  		self::$proxies=array();
  	}
  }