Completed
Pull Request — master (#7462)
by Björn
15:09
created
lib/private/Template/Base.php 4 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -103,7 +103,7 @@
 block discarded – undo
103 103
 	/**
104 104
 	 * Appends a variable
105 105
 	 * @param string $key key
106
-	 * @param mixed $value value
106
+	 * @param string $value value
107 107
 	 * @return boolean|null
108 108
 	 *
109 109
 	 * This function assigns a variable in an array context. If the key already
Please login to merge, or discard this patch.
Braces   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -114,8 +114,7 @@  discard block
 block discarded – undo
114 114
 	public function append( $key, $value ) {
115 115
 		if( array_key_exists( $key, $this->vars )) {
116 116
 			$this->vars[$key][] = $value;
117
-		}
118
-		else{
117
+		} else{
119 118
 			$this->vars[$key] = array( $value );
120 119
 		}
121 120
 	}
@@ -130,8 +129,7 @@  discard block
 block discarded – undo
130 129
 		$data = $this->fetchPage();
131 130
 		if( $data === false ) {
132 131
 			return false;
133
-		}
134
-		else{
132
+		} else{
135 133
 			print $data;
136 134
 			return true;
137 135
 		}
Please login to merge, or discard this patch.
Indentation   +153 added lines, -153 removed lines patch added patch discarded remove patch
@@ -31,158 +31,158 @@
 block discarded – undo
31 31
 use OCP\Defaults;
32 32
 
33 33
 class Base {
34
-	private $template; // The template
35
-	private $vars; // Vars
36
-
37
-	/** @var \OCP\IL10N */
38
-	private $l10n;
39
-
40
-	/** @var Defaults */
41
-	private $theme;
42
-
43
-	/**
44
-	 * @param string $template
45
-	 * @param string $requestToken
46
-	 * @param \OCP\IL10N $l10n
47
-	 * @param Defaults $theme
48
-	 */
49
-	public function __construct($template, $requestToken, $l10n, $theme ) {
50
-		$this->vars = array();
51
-		$this->vars['requesttoken'] = $requestToken;
52
-		$this->l10n = $l10n;
53
-		$this->template = $template;
54
-		$this->theme = $theme;
55
-	}
56
-
57
-	/**
58
-	 * @param string $serverRoot
59
-	 * @param string|false $app_dir
60
-	 * @param string $theme
61
-	 * @param string $app
62
-	 * @return string[]
63
-	 */
64
-	protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
65
-		// Check if the app is in the app folder or in the root
66
-		if( file_exists($app_dir.'/templates/' )) {
67
-			return [
68
-				$serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
69
-				$app_dir.'/templates/',
70
-			];
71
-		}
72
-		return [
73
-			$serverRoot.'/themes/'.$theme.'/'.$app.'/templates/',
74
-			$serverRoot.'/'.$app.'/templates/',
75
-		];
76
-	}
77
-
78
-	/**
79
-	 * @param string $serverRoot
80
-	 * @param string $theme
81
-	 * @return string[]
82
-	 */
83
-	protected function getCoreTemplateDirs($theme, $serverRoot) {
84
-		return [
85
-			$serverRoot.'/themes/'.$theme.'/core/templates/',
86
-			$serverRoot.'/core/templates/',
87
-		];
88
-	}
89
-
90
-	/**
91
-	 * Assign variables
92
-	 * @param string $key key
93
-	 * @param array|bool|integer|string $value value
94
-	 * @return bool
95
-	 *
96
-	 * This function assigns a variable. It can be accessed via $_[$key] in
97
-	 * the template.
98
-	 *
99
-	 * If the key existed before, it will be overwritten
100
-	 */
101
-	public function assign( $key, $value) {
102
-		$this->vars[$key] = $value;
103
-		return true;
104
-	}
105
-
106
-	/**
107
-	 * Appends a variable
108
-	 * @param string $key key
109
-	 * @param mixed $value value
110
-	 * @return boolean|null
111
-	 *
112
-	 * This function assigns a variable in an array context. If the key already
113
-	 * exists, the value will be appended. It can be accessed via
114
-	 * $_[$key][$position] in the template.
115
-	 */
116
-	public function append( $key, $value ) {
117
-		if( array_key_exists( $key, $this->vars )) {
118
-			$this->vars[$key][] = $value;
119
-		}
120
-		else{
121
-			$this->vars[$key] = array( $value );
122
-		}
123
-	}
124
-
125
-	/**
126
-	 * Prints the proceeded template
127
-	 * @return bool
128
-	 *
129
-	 * This function proceeds the template and prints its output.
130
-	 */
131
-	public function printPage() {
132
-		$data = $this->fetchPage();
133
-		if( $data === false ) {
134
-			return false;
135
-		}
136
-		else{
137
-			print $data;
138
-			return true;
139
-		}
140
-	}
141
-
142
-	/**
143
-	 * Process the template
144
-	 *
145
-	 * @param array|null $additionalParams
146
-	 * @return string This function processes the template.
147
-	 *
148
-	 * This function processes the template.
149
-	 */
150
-	public function fetchPage($additionalParams = null) {
151
-		return $this->load($this->template, $additionalParams);
152
-	}
153
-
154
-	/**
155
-	 * doing the actual work
156
-	 *
157
-	 * @param string $file
158
-	 * @param array|null $additionalParams
159
-	 * @return string content
160
-	 *
161
-	 * Includes the template file, fetches its output
162
-	 */
163
-	protected function load($file, $additionalParams = null) {
164
-		// Register the variables
165
-		$_ = $this->vars;
166
-		$l = $this->l10n;
167
-		$theme = $this->theme;
168
-
169
-		if( !is_null($additionalParams)) {
170
-			$_ = array_merge( $additionalParams, $this->vars );
171
-		}
172
-
173
-		// Include
174
-		ob_start();
175
-		try {
176
-			include $file;
177
-			$data = ob_get_contents();
178
-		} catch (\Exception $e) {
179
-			@ob_end_clean();
180
-			throw $e;
181
-		}
182
-		@ob_end_clean();
183
-
184
-		// Return data
185
-		return $data;
186
-	}
34
+    private $template; // The template
35
+    private $vars; // Vars
36
+
37
+    /** @var \OCP\IL10N */
38
+    private $l10n;
39
+
40
+    /** @var Defaults */
41
+    private $theme;
42
+
43
+    /**
44
+     * @param string $template
45
+     * @param string $requestToken
46
+     * @param \OCP\IL10N $l10n
47
+     * @param Defaults $theme
48
+     */
49
+    public function __construct($template, $requestToken, $l10n, $theme ) {
50
+        $this->vars = array();
51
+        $this->vars['requesttoken'] = $requestToken;
52
+        $this->l10n = $l10n;
53
+        $this->template = $template;
54
+        $this->theme = $theme;
55
+    }
56
+
57
+    /**
58
+     * @param string $serverRoot
59
+     * @param string|false $app_dir
60
+     * @param string $theme
61
+     * @param string $app
62
+     * @return string[]
63
+     */
64
+    protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
65
+        // Check if the app is in the app folder or in the root
66
+        if( file_exists($app_dir.'/templates/' )) {
67
+            return [
68
+                $serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
69
+                $app_dir.'/templates/',
70
+            ];
71
+        }
72
+        return [
73
+            $serverRoot.'/themes/'.$theme.'/'.$app.'/templates/',
74
+            $serverRoot.'/'.$app.'/templates/',
75
+        ];
76
+    }
77
+
78
+    /**
79
+     * @param string $serverRoot
80
+     * @param string $theme
81
+     * @return string[]
82
+     */
83
+    protected function getCoreTemplateDirs($theme, $serverRoot) {
84
+        return [
85
+            $serverRoot.'/themes/'.$theme.'/core/templates/',
86
+            $serverRoot.'/core/templates/',
87
+        ];
88
+    }
89
+
90
+    /**
91
+     * Assign variables
92
+     * @param string $key key
93
+     * @param array|bool|integer|string $value value
94
+     * @return bool
95
+     *
96
+     * This function assigns a variable. It can be accessed via $_[$key] in
97
+     * the template.
98
+     *
99
+     * If the key existed before, it will be overwritten
100
+     */
101
+    public function assign( $key, $value) {
102
+        $this->vars[$key] = $value;
103
+        return true;
104
+    }
105
+
106
+    /**
107
+     * Appends a variable
108
+     * @param string $key key
109
+     * @param mixed $value value
110
+     * @return boolean|null
111
+     *
112
+     * This function assigns a variable in an array context. If the key already
113
+     * exists, the value will be appended. It can be accessed via
114
+     * $_[$key][$position] in the template.
115
+     */
116
+    public function append( $key, $value ) {
117
+        if( array_key_exists( $key, $this->vars )) {
118
+            $this->vars[$key][] = $value;
119
+        }
120
+        else{
121
+            $this->vars[$key] = array( $value );
122
+        }
123
+    }
124
+
125
+    /**
126
+     * Prints the proceeded template
127
+     * @return bool
128
+     *
129
+     * This function proceeds the template and prints its output.
130
+     */
131
+    public function printPage() {
132
+        $data = $this->fetchPage();
133
+        if( $data === false ) {
134
+            return false;
135
+        }
136
+        else{
137
+            print $data;
138
+            return true;
139
+        }
140
+    }
141
+
142
+    /**
143
+     * Process the template
144
+     *
145
+     * @param array|null $additionalParams
146
+     * @return string This function processes the template.
147
+     *
148
+     * This function processes the template.
149
+     */
150
+    public function fetchPage($additionalParams = null) {
151
+        return $this->load($this->template, $additionalParams);
152
+    }
153
+
154
+    /**
155
+     * doing the actual work
156
+     *
157
+     * @param string $file
158
+     * @param array|null $additionalParams
159
+     * @return string content
160
+     *
161
+     * Includes the template file, fetches its output
162
+     */
163
+    protected function load($file, $additionalParams = null) {
164
+        // Register the variables
165
+        $_ = $this->vars;
166
+        $l = $this->l10n;
167
+        $theme = $this->theme;
168
+
169
+        if( !is_null($additionalParams)) {
170
+            $_ = array_merge( $additionalParams, $this->vars );
171
+        }
172
+
173
+        // Include
174
+        ob_start();
175
+        try {
176
+            include $file;
177
+            $data = ob_get_contents();
178
+        } catch (\Exception $e) {
179
+            @ob_end_clean();
180
+            throw $e;
181
+        }
182
+        @ob_end_clean();
183
+
184
+        // Return data
185
+        return $data;
186
+    }
187 187
 
188 188
 }
Please login to merge, or discard this patch.
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -46,7 +46,7 @@  discard block
 block discarded – undo
46 46
 	 * @param \OCP\IL10N $l10n
47 47
 	 * @param Defaults $theme
48 48
 	 */
49
-	public function __construct($template, $requestToken, $l10n, $theme ) {
49
+	public function __construct($template, $requestToken, $l10n, $theme) {
50 50
 		$this->vars = array();
51 51
 		$this->vars['requesttoken'] = $requestToken;
52 52
 		$this->l10n = $l10n;
@@ -63,7 +63,7 @@  discard block
 block discarded – undo
63 63
 	 */
64 64
 	protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
65 65
 		// Check if the app is in the app folder or in the root
66
-		if( file_exists($app_dir.'/templates/' )) {
66
+		if (file_exists($app_dir.'/templates/')) {
67 67
 			return [
68 68
 				$serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
69 69
 				$app_dir.'/templates/',
@@ -98,7 +98,7 @@  discard block
 block discarded – undo
98 98
 	 *
99 99
 	 * If the key existed before, it will be overwritten
100 100
 	 */
101
-	public function assign( $key, $value) {
101
+	public function assign($key, $value) {
102 102
 		$this->vars[$key] = $value;
103 103
 		return true;
104 104
 	}
@@ -113,12 +113,12 @@  discard block
 block discarded – undo
113 113
 	 * exists, the value will be appended. It can be accessed via
114 114
 	 * $_[$key][$position] in the template.
115 115
 	 */
116
-	public function append( $key, $value ) {
117
-		if( array_key_exists( $key, $this->vars )) {
116
+	public function append($key, $value) {
117
+		if (array_key_exists($key, $this->vars)) {
118 118
 			$this->vars[$key][] = $value;
119 119
 		}
120
-		else{
121
-			$this->vars[$key] = array( $value );
120
+		else {
121
+			$this->vars[$key] = array($value);
122 122
 		}
123 123
 	}
124 124
 
@@ -130,10 +130,10 @@  discard block
 block discarded – undo
130 130
 	 */
131 131
 	public function printPage() {
132 132
 		$data = $this->fetchPage();
133
-		if( $data === false ) {
133
+		if ($data === false) {
134 134
 			return false;
135 135
 		}
136
-		else{
136
+		else {
137 137
 			print $data;
138 138
 			return true;
139 139
 		}
@@ -166,8 +166,8 @@  discard block
 block discarded – undo
166 166
 		$l = $this->l10n;
167 167
 		$theme = $this->theme;
168 168
 
169
-		if( !is_null($additionalParams)) {
170
-			$_ = array_merge( $additionalParams, $this->vars );
169
+		if (!is_null($additionalParams)) {
170
+			$_ = array_merge($additionalParams, $this->vars);
171 171
 		}
172 172
 
173 173
 		// Include
Please login to merge, or discard this patch.
lib/public/Migration/IOutput.php 2 patches
Doc Comments   +5 added lines, -1 removed lines patch added patch discarded remove patch
@@ -32,18 +32,21 @@  discard block
 block discarded – undo
32 32
 	/**
33 33
 	 * @param string $message
34 34
 	 * @since 9.1.0
35
+	 * @return void
35 36
 	 */
36 37
 	public function info($message);
37 38
 
38 39
 	/**
39 40
 	 * @param string $message
40 41
 	 * @since 9.1.0
42
+	 * @return void
41 43
 	 */
42 44
 	public function warning($message);
43 45
 
44 46
 	/**
45 47
 	 * @param int $max
46 48
 	 * @since 9.1.0
49
+	 * @return void
47 50
 	 */
48 51
 	public function startProgress($max = 0);
49 52
 
@@ -51,12 +54,13 @@  discard block
 block discarded – undo
51 54
 	 * @param int $step
52 55
 	 * @param string $description
53 56
 	 * @since 9.1.0
57
+	 * @return void
54 58
 	 */
55 59
 	public function advance($step = 1, $description = '');
56 60
 
57 61
 	/**
58
-	 * @param int $max
59 62
 	 * @since 9.1.0
63
+	 * @return void
60 64
 	 */
61 65
 	public function finishProgress();
62 66
 
Please login to merge, or discard this patch.
Indentation   +26 added lines, -26 removed lines patch added patch discarded remove patch
@@ -30,35 +30,35 @@
 block discarded – undo
30 30
  */
31 31
 interface IOutput {
32 32
 
33
-	/**
34
-	 * @param string $message
35
-	 * @since 9.1.0
36
-	 */
37
-	public function info($message);
33
+    /**
34
+     * @param string $message
35
+     * @since 9.1.0
36
+     */
37
+    public function info($message);
38 38
 
39
-	/**
40
-	 * @param string $message
41
-	 * @since 9.1.0
42
-	 */
43
-	public function warning($message);
39
+    /**
40
+     * @param string $message
41
+     * @since 9.1.0
42
+     */
43
+    public function warning($message);
44 44
 
45
-	/**
46
-	 * @param int $max
47
-	 * @since 9.1.0
48
-	 */
49
-	public function startProgress($max = 0);
45
+    /**
46
+     * @param int $max
47
+     * @since 9.1.0
48
+     */
49
+    public function startProgress($max = 0);
50 50
 
51
-	/**
52
-	 * @param int $step
53
-	 * @param string $description
54
-	 * @since 9.1.0
55
-	 */
56
-	public function advance($step = 1, $description = '');
51
+    /**
52
+     * @param int $step
53
+     * @param string $description
54
+     * @since 9.1.0
55
+     */
56
+    public function advance($step = 1, $description = '');
57 57
 
58
-	/**
59
-	 * @param int $max
60
-	 * @since 9.1.0
61
-	 */
62
-	public function finishProgress();
58
+    /**
59
+     * @param int $max
60
+     * @since 9.1.0
61
+     */
62
+    public function finishProgress();
63 63
 
64 64
 }
Please login to merge, or discard this patch.
lib/public/SystemTag/ISystemTagManager.php 2 patches
Doc Comments   +7 added lines, -4 removed lines patch added patch discarded remove patch
@@ -102,17 +102,19 @@  discard block
 block discarded – undo
102 102
 	 * with the same attributes
103 103
 	 *
104 104
 	 * @since 9.0.0
105
+	 * @return void
105 106
 	 */
106 107
 	public function updateTag($tagId, $newName, $userVisible, $userAssignable);
107 108
 
108 109
 	/**
109 110
 	 * Delete the given tags from the database and all their relationships.
110 111
 	 *
111
-	 * @param string|array $tagIds array of tag ids
112
+	 * @param string $tagIds array of tag ids
112 113
 	 *
113 114
 	 * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
114 115
 	 *
115 116
 	 * @since 9.0.0
117
+	 * @return void
116 118
 	 */
117 119
 	public function deleteTags($tagIds);
118 120
 
@@ -123,7 +125,7 @@  discard block
 block discarded – undo
123 125
 	 * @param ISystemTag $tag tag to check permission for
124 126
 	 * @param IUser $user user to check permission for
125 127
 	 *
126
-	 * @return true if the user is allowed to assign/unassign the tag, false otherwise
128
+	 * @return boolean if the user is allowed to assign/unassign the tag, false otherwise
127 129
 	 *
128 130
 	 * @since 9.1.0
129 131
 	 */
@@ -133,9 +135,9 @@  discard block
 block discarded – undo
133 135
 	 * Checks whether the given user is allowed to see the tag with the given id.
134 136
 	 *
135 137
 	 * @param ISystemTag $tag tag to check permission for
136
-	 * @param IUser $user user to check permission for
138
+	 * @param IUser $userId user to check permission for
137 139
 	 *
138
-	 * @return true if the user can see the tag, false otherwise
140
+	 * @return boolean if the user can see the tag, false otherwise
139 141
 	 *
140 142
 	 * @since 9.1.0
141 143
 	 */
@@ -148,6 +150,7 @@  discard block
 block discarded – undo
148 150
 	 * @param string[] $groupIds group ids of groups that can assign/unassign the tag
149 151
 	 *
150 152
 	 * @since 9.1.0
153
+	 * @return void
151 154
 	 */
152 155
 	public function setTagGroups(ISystemTag $tag, $groupIds);
153 156
 
Please login to merge, or discard this patch.
Indentation   +120 added lines, -120 removed lines patch added patch discarded remove patch
@@ -33,133 +33,133 @@
 block discarded – undo
33 33
  */
34 34
 interface ISystemTagManager {
35 35
 
36
-	/**
37
-	 * Returns the tag objects matching the given tag ids.
38
-	 *
39
-	 * @param array|string $tagIds id or array of unique ids of the tag to retrieve
40
-	 *
41
-	 * @return \OCP\SystemTag\ISystemTag[] array of system tags with tag id as key
42
-	 *
43
-	 * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.)
44
-	 * @throws \OCP\SystemTag\TagNotFoundException if at least one given tag ids did no exist
45
-	 * 			The message contains a json_encoded array of the ids that could not be found
46
-	 *
47
-	 * @since 9.0.0
48
-	 */
49
-	public function getTagsByIds($tagIds);
36
+    /**
37
+     * Returns the tag objects matching the given tag ids.
38
+     *
39
+     * @param array|string $tagIds id or array of unique ids of the tag to retrieve
40
+     *
41
+     * @return \OCP\SystemTag\ISystemTag[] array of system tags with tag id as key
42
+     *
43
+     * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.)
44
+     * @throws \OCP\SystemTag\TagNotFoundException if at least one given tag ids did no exist
45
+     * 			The message contains a json_encoded array of the ids that could not be found
46
+     *
47
+     * @since 9.0.0
48
+     */
49
+    public function getTagsByIds($tagIds);
50 50
 
51
-	/**
52
-	 * Returns the tag object matching the given attributes.
53
-	 *
54
-	 * @param string $tagName tag name
55
-	 * @param bool $userVisible whether the tag is visible by users
56
-	 * @param bool $userAssignable whether the tag is assignable by users
57
-	 *
58
-	 * @return \OCP\SystemTag\ISystemTag system tag
59
-	 *
60
-	 * @throws \OCP\SystemTag\TagNotFoundException if tag does not exist
61
-	 *
62
-	 * @since 9.0.0
63
-	 */
64
-	public function getTag($tagName, $userVisible, $userAssignable);
51
+    /**
52
+     * Returns the tag object matching the given attributes.
53
+     *
54
+     * @param string $tagName tag name
55
+     * @param bool $userVisible whether the tag is visible by users
56
+     * @param bool $userAssignable whether the tag is assignable by users
57
+     *
58
+     * @return \OCP\SystemTag\ISystemTag system tag
59
+     *
60
+     * @throws \OCP\SystemTag\TagNotFoundException if tag does not exist
61
+     *
62
+     * @since 9.0.0
63
+     */
64
+    public function getTag($tagName, $userVisible, $userAssignable);
65 65
 
66
-	/**
67
-	 * Creates the tag object using the given attributes.
68
-	 *
69
-	 * @param string $tagName tag name
70
-	 * @param bool $userVisible whether the tag is visible by users
71
-	 * @param bool $userAssignable whether the tag is assignable by users
72
-	 *
73
-	 * @return \OCP\SystemTag\ISystemTag system tag
74
-	 *
75
-	 * @throws \OCP\SystemTag\TagAlreadyExistsException if tag already exists
76
-	 *
77
-	 * @since 9.0.0
78
-	 */
79
-	public function createTag($tagName, $userVisible, $userAssignable);
66
+    /**
67
+     * Creates the tag object using the given attributes.
68
+     *
69
+     * @param string $tagName tag name
70
+     * @param bool $userVisible whether the tag is visible by users
71
+     * @param bool $userAssignable whether the tag is assignable by users
72
+     *
73
+     * @return \OCP\SystemTag\ISystemTag system tag
74
+     *
75
+     * @throws \OCP\SystemTag\TagAlreadyExistsException if tag already exists
76
+     *
77
+     * @since 9.0.0
78
+     */
79
+    public function createTag($tagName, $userVisible, $userAssignable);
80 80
 
81
-	/**
82
-	 * Returns all known tags, optionally filtered by visibility.
83
-	 *
84
-	 * @param bool|null $visibilityFilter filter by visibility if non-null
85
-	 * @param string $nameSearchPattern optional search pattern for the tag name
86
-	 *
87
-	 * @return \OCP\SystemTag\ISystemTag[] array of system tags or empty array if none found
88
-	 *
89
-	 * @since 9.0.0
90
-	 */
91
-	public function getAllTags($visibilityFilter = null, $nameSearchPattern = null);
81
+    /**
82
+     * Returns all known tags, optionally filtered by visibility.
83
+     *
84
+     * @param bool|null $visibilityFilter filter by visibility if non-null
85
+     * @param string $nameSearchPattern optional search pattern for the tag name
86
+     *
87
+     * @return \OCP\SystemTag\ISystemTag[] array of system tags or empty array if none found
88
+     *
89
+     * @since 9.0.0
90
+     */
91
+    public function getAllTags($visibilityFilter = null, $nameSearchPattern = null);
92 92
 
93
-	/**
94
-	 * Updates the given tag
95
-	 *
96
-	 * @param string $tagId tag id
97
-	 * @param string $newName the new tag name
98
-	 * @param bool $userVisible whether the tag is visible by users
99
-	 * @param bool $userAssignable whether the tag is assignable by users
100
-	 *
101
-	 * @throws \OCP\SystemTag\TagNotFoundException if tag with the given id does not exist
102
-	 * @throws \OCP\SystemTag\TagAlreadyExistsException if there is already another tag
103
-	 * with the same attributes
104
-	 *
105
-	 * @since 9.0.0
106
-	 */
107
-	public function updateTag($tagId, $newName, $userVisible, $userAssignable);
93
+    /**
94
+     * Updates the given tag
95
+     *
96
+     * @param string $tagId tag id
97
+     * @param string $newName the new tag name
98
+     * @param bool $userVisible whether the tag is visible by users
99
+     * @param bool $userAssignable whether the tag is assignable by users
100
+     *
101
+     * @throws \OCP\SystemTag\TagNotFoundException if tag with the given id does not exist
102
+     * @throws \OCP\SystemTag\TagAlreadyExistsException if there is already another tag
103
+     * with the same attributes
104
+     *
105
+     * @since 9.0.0
106
+     */
107
+    public function updateTag($tagId, $newName, $userVisible, $userAssignable);
108 108
 
109
-	/**
110
-	 * Delete the given tags from the database and all their relationships.
111
-	 *
112
-	 * @param string|array $tagIds array of tag ids
113
-	 *
114
-	 * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
115
-	 *
116
-	 * @since 9.0.0
117
-	 */
118
-	public function deleteTags($tagIds);
109
+    /**
110
+     * Delete the given tags from the database and all their relationships.
111
+     *
112
+     * @param string|array $tagIds array of tag ids
113
+     *
114
+     * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
115
+     *
116
+     * @since 9.0.0
117
+     */
118
+    public function deleteTags($tagIds);
119 119
 
120
-	/**
121
-	 * Checks whether the given user is allowed to assign/unassign the tag with the
122
-	 * given id.
123
-	 *
124
-	 * @param ISystemTag $tag tag to check permission for
125
-	 * @param IUser $user user to check permission for
126
-	 *
127
-	 * @return true if the user is allowed to assign/unassign the tag, false otherwise
128
-	 *
129
-	 * @since 9.1.0
130
-	 */
131
-	public function canUserAssignTag(ISystemTag $tag, IUser $user);
120
+    /**
121
+     * Checks whether the given user is allowed to assign/unassign the tag with the
122
+     * given id.
123
+     *
124
+     * @param ISystemTag $tag tag to check permission for
125
+     * @param IUser $user user to check permission for
126
+     *
127
+     * @return true if the user is allowed to assign/unassign the tag, false otherwise
128
+     *
129
+     * @since 9.1.0
130
+     */
131
+    public function canUserAssignTag(ISystemTag $tag, IUser $user);
132 132
 
133
-	/**
134
-	 * Checks whether the given user is allowed to see the tag with the given id.
135
-	 *
136
-	 * @param ISystemTag $tag tag to check permission for
137
-	 * @param IUser $user user to check permission for
138
-	 *
139
-	 * @return true if the user can see the tag, false otherwise
140
-	 *
141
-	 * @since 9.1.0
142
-	 */
143
-	public function canUserSeeTag(ISystemTag $tag, IUser $userId);
133
+    /**
134
+     * Checks whether the given user is allowed to see the tag with the given id.
135
+     *
136
+     * @param ISystemTag $tag tag to check permission for
137
+     * @param IUser $user user to check permission for
138
+     *
139
+     * @return true if the user can see the tag, false otherwise
140
+     *
141
+     * @since 9.1.0
142
+     */
143
+    public function canUserSeeTag(ISystemTag $tag, IUser $userId);
144 144
 
145
-	/**
146
-	 * Set groups that can assign a given tag.
147
-	 *
148
-	 * @param ISystemTag $tag tag for group assignment
149
-	 * @param string[] $groupIds group ids of groups that can assign/unassign the tag
150
-	 *
151
-	 * @since 9.1.0
152
-	 */
153
-	public function setTagGroups(ISystemTag $tag, $groupIds);
145
+    /**
146
+     * Set groups that can assign a given tag.
147
+     *
148
+     * @param ISystemTag $tag tag for group assignment
149
+     * @param string[] $groupIds group ids of groups that can assign/unassign the tag
150
+     *
151
+     * @since 9.1.0
152
+     */
153
+    public function setTagGroups(ISystemTag $tag, $groupIds);
154 154
 
155
-	/**
156
-	 * Get groups that can assign a given tag.
157
-	 *
158
-	 * @param ISystemTag $tag tag for group assignment
159
-	 *
160
-	 * @return string[] group ids of groups that can assign/unassign the tag
161
-	 *
162
-	 * @since 9.1.0
163
-	 */
164
-	public function getTagGroups(ISystemTag $tag);
155
+    /**
156
+     * Get groups that can assign a given tag.
157
+     *
158
+     * @param ISystemTag $tag tag for group assignment
159
+     *
160
+     * @return string[] group ids of groups that can assign/unassign the tag
161
+     *
162
+     * @since 9.1.0
163
+     */
164
+    public function getTagGroups(ISystemTag $tag);
165 165
 }
Please login to merge, or discard this patch.
lib/public/Util.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -544,7 +544,7 @@
 block discarded – undo
544 544
 	 * @param array $input The array to work on
545 545
 	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
546 546
 	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
547
-	 * @return array
547
+	 * @return string
548 548
 	 * @since 4.5.0
549 549
 	 */
550 550
 	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
Please login to merge, or discard this patch.
Spacing   +28 added lines, -28 removed lines patch added patch discarded remove patch
@@ -58,11 +58,11 @@  discard block
 block discarded – undo
58 58
  */
59 59
 class Util {
60 60
 	// consts for Logging
61
-	const DEBUG=0;
62
-	const INFO=1;
63
-	const WARN=2;
64
-	const ERROR=3;
65
-	const FATAL=4;
61
+	const DEBUG = 0;
62
+	const INFO = 1;
63
+	const WARN = 2;
64
+	const ERROR = 3;
65
+	const FATAL = 4;
66 66
 
67 67
 	/** \OCP\Share\IManager */
68 68
 	private static $shareManager;
@@ -118,11 +118,11 @@  discard block
 block discarded – undo
118 118
 		$message->setSubject($subject);
119 119
 		$message->setPlainBody($mailtext);
120 120
 		$message->setFrom([$fromaddress => $fromname]);
121
-		if($html === 1) {
121
+		if ($html === 1) {
122 122
 			$message->setHtmlBody($altbody);
123 123
 		}
124 124
 
125
-		if($altbody === '') {
125
+		if ($altbody === '') {
126 126
 			$message->setHtmlBody($mailtext);
127 127
 			$message->setPlainBody('');
128 128
 		} else {
@@ -130,14 +130,14 @@  discard block
 block discarded – undo
130 130
 			$message->setPlainBody($altbody);
131 131
 		}
132 132
 
133
-		if(!empty($ccaddress)) {
134
-			if(!empty($ccname)) {
133
+		if (!empty($ccaddress)) {
134
+			if (!empty($ccname)) {
135 135
 				$message->setCc([$ccaddress => $ccname]);
136 136
 			} else {
137 137
 				$message->setCc([$ccaddress]);
138 138
 			}
139 139
 		}
140
-		if(!empty($bcc)) {
140
+		if (!empty($bcc)) {
141 141
 			$message->setBcc([$bcc]);
142 142
 		}
143 143
 
@@ -152,7 +152,7 @@  discard block
 block discarded – undo
152 152
 	 * @since 4.0.0
153 153
 	 * @deprecated 13.0.0 use log of \OCP\ILogger
154 154
 	 */
155
-	public static function writeLog( $app, $message, $level ) {
155
+	public static function writeLog($app, $message, $level) {
156 156
 		$context = ['app' => $app];
157 157
 		\OC::$server->getLogger()->log($level, $message, $context);
158 158
 	}
@@ -165,7 +165,7 @@  discard block
 block discarded – undo
165 165
 	 * @since ....0.0 - parameter $level was added in 7.0.0
166 166
 	 * @deprecated 8.2.0 use logException of \OCP\ILogger
167 167
 	 */
168
-	public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
168
+	public static function logException($app, \Exception $ex, $level = \OCP\Util::FATAL) {
169 169
 		\OC::$server->getLogger()->logException($ex, ['app' => $app]);
170 170
 	}
171 171
 
@@ -206,8 +206,8 @@  discard block
 block discarded – undo
206 206
 	 * @param string $file
207 207
 	 * @since 4.0.0
208 208
 	 */
209
-	public static function addStyle( $application, $file = null ) {
210
-		\OC_Util::addStyle( $application, $file );
209
+	public static function addStyle($application, $file = null) {
210
+		\OC_Util::addStyle($application, $file);
211 211
 	}
212 212
 
213 213
 	/**
@@ -216,8 +216,8 @@  discard block
 block discarded – undo
216 216
 	 * @param string $file
217 217
 	 * @since 4.0.0
218 218
 	 */
219
-	public static function addScript( $application, $file = null ) {
220
-		\OC_Util::addScript( $application, $file );
219
+	public static function addScript($application, $file = null) {
220
+		\OC_Util::addScript($application, $file);
221 221
 	}
222 222
 
223 223
 	/**
@@ -239,7 +239,7 @@  discard block
 block discarded – undo
239 239
 	 * @param string $text the text content for the element
240 240
 	 * @since 4.0.0
241 241
 	 */
242
-	public static function addHeader($tag, $attributes, $text=null) {
242
+	public static function addHeader($tag, $attributes, $text = null) {
243 243
 		\OC_Util::addHeader($tag, $attributes, $text);
244 244
 	}
245 245
 
@@ -254,7 +254,7 @@  discard block
 block discarded – undo
254 254
 	 * @since 4.0.0
255 255
 	 * @suppress PhanDeprecatedFunction
256 256
 	 */
257
-	public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
257
+	public static function formatDate($timestamp, $dateOnly = false, $timeZone = null) {
258 258
 		return \OC_Util::formatDate($timestamp, $dateOnly, $timeZone);
259 259
 	}
260 260
 
@@ -278,7 +278,7 @@  discard block
 block discarded – undo
278 278
 	 * @return string the url
279 279
 	 * @since 4.0.0 - parameter $args was added in 4.5.0
280 280
 	 */
281
-	public static function linkToAbsolute( $app, $file, $args = array() ) {
281
+	public static function linkToAbsolute($app, $file, $args = array()) {
282 282
 		$urlGenerator = \OC::$server->getURLGenerator();
283 283
 		return $urlGenerator->getAbsoluteURL(
284 284
 			$urlGenerator->linkTo($app, $file, $args)
@@ -291,11 +291,11 @@  discard block
 block discarded – undo
291 291
 	 * @return string the url
292 292
 	 * @since 4.0.0
293 293
 	 */
294
-	public static function linkToRemote( $service ) {
294
+	public static function linkToRemote($service) {
295 295
 		$urlGenerator = \OC::$server->getURLGenerator();
296
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
296
+		$remoteBase = $urlGenerator->linkTo('', 'remote.php').'/'.$service;
297 297
 		return $urlGenerator->getAbsoluteURL(
298
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
298
+			$remoteBase.(($service[strlen($service) - 1] != '/') ? '/' : '')
299 299
 		);
300 300
 	}
301 301
 
@@ -318,7 +318,7 @@  discard block
 block discarded – undo
318 318
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
319 319
 	 * @since 5.0.0
320 320
 	 */
321
-	public static function linkToRoute( $route, $parameters = array() ) {
321
+	public static function linkToRoute($route, $parameters = array()) {
322 322
 		return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
323 323
 	}
324 324
 
@@ -332,7 +332,7 @@  discard block
 block discarded – undo
332 332
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
333 333
 	 * @since 4.0.0 - parameter $args was added in 4.5.0
334 334
 	 */
335
-	public static function linkTo( $app, $file, $args = array() ) {
335
+	public static function linkTo($app, $file, $args = array()) {
336 336
 		return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
337 337
 	}
338 338
 
@@ -431,7 +431,7 @@  discard block
 block discarded – undo
431 431
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
432 432
 	 * @since 4.0.0
433 433
 	 */
434
-	public static function imagePath( $app, $image ) {
434
+	public static function imagePath($app, $image) {
435 435
 		return \OC::$server->getURLGenerator()->imagePath($app, $image);
436 436
 	}
437 437
 
@@ -502,7 +502,7 @@  discard block
 block discarded – undo
502 502
 	 * @since 4.5.0
503 503
 	 */
504 504
 	public static function callRegister() {
505
-		if(self::$token === '') {
505
+		if (self::$token === '') {
506 506
 			self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
507 507
 		}
508 508
 		return self::$token;
@@ -514,7 +514,7 @@  discard block
 block discarded – undo
514 514
 	 * @deprecated 9.0.0 Use annotations based on the app framework.
515 515
 	 */
516 516
 	public static function callCheck() {
517
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
517
+		if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
518 518
 			header('Location: '.\OC::$WEBROOT);
519 519
 			exit();
520 520
 		}
@@ -706,7 +706,7 @@  discard block
 block discarded – undo
706 706
 	 */
707 707
 	public static function needUpgrade() {
708 708
 		if (!isset(self::$needUpgradeCache)) {
709
-			self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getSystemConfig());
709
+			self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
710 710
 		}		
711 711
 		return self::$needUpgradeCache;
712 712
 	}
Please login to merge, or discard this patch.
Indentation   +651 added lines, -651 removed lines patch added patch discarded remove patch
@@ -57,657 +57,657 @@
 block discarded – undo
57 57
  * @since 4.0.0
58 58
  */
59 59
 class Util {
60
-	// consts for Logging
61
-	const DEBUG=0;
62
-	const INFO=1;
63
-	const WARN=2;
64
-	const ERROR=3;
65
-	const FATAL=4;
66
-
67
-	/** \OCP\Share\IManager */
68
-	private static $shareManager;
69
-
70
-	/**
71
-	 * get the current installed version of ownCloud
72
-	 * @return array
73
-	 * @since 4.0.0
74
-	 */
75
-	public static function getVersion() {
76
-		return \OC_Util::getVersion();
77
-	}
60
+    // consts for Logging
61
+    const DEBUG=0;
62
+    const INFO=1;
63
+    const WARN=2;
64
+    const ERROR=3;
65
+    const FATAL=4;
66
+
67
+    /** \OCP\Share\IManager */
68
+    private static $shareManager;
69
+
70
+    /**
71
+     * get the current installed version of ownCloud
72
+     * @return array
73
+     * @since 4.0.0
74
+     */
75
+    public static function getVersion() {
76
+        return \OC_Util::getVersion();
77
+    }
78 78
 	
79
-	/**
80
-	 * Set current update channel
81
-	 * @param string $channel
82
-	 * @since 8.1.0
83
-	 */
84
-	public static function setChannel($channel) {
85
-		\OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
86
-	}
79
+    /**
80
+     * Set current update channel
81
+     * @param string $channel
82
+     * @since 8.1.0
83
+     */
84
+    public static function setChannel($channel) {
85
+        \OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
86
+    }
87 87
 	
88
-	/**
89
-	 * Get current update channel
90
-	 * @return string
91
-	 * @since 8.1.0
92
-	 */
93
-	public static function getChannel() {
94
-		return \OC_Util::getChannel();
95
-	}
96
-
97
-	/**
98
-	 * send an email
99
-	 * @param string $toaddress
100
-	 * @param string $toname
101
-	 * @param string $subject
102
-	 * @param string $mailtext
103
-	 * @param string $fromaddress
104
-	 * @param string $fromname
105
-	 * @param int $html
106
-	 * @param string $altbody
107
-	 * @param string $ccaddress
108
-	 * @param string $ccname
109
-	 * @param string $bcc
110
-	 * @deprecated 8.1.0 Use \OCP\Mail\IMailer instead
111
-	 * @since 4.0.0
112
-	 */
113
-	public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
114
-		$html = 0, $altbody = '', $ccaddress = '', $ccname = '', $bcc = '') {
115
-		$mailer = \OC::$server->getMailer();
116
-		$message = $mailer->createMessage();
117
-		$message->setTo([$toaddress => $toname]);
118
-		$message->setSubject($subject);
119
-		$message->setPlainBody($mailtext);
120
-		$message->setFrom([$fromaddress => $fromname]);
121
-		if($html === 1) {
122
-			$message->setHtmlBody($altbody);
123
-		}
124
-
125
-		if($altbody === '') {
126
-			$message->setHtmlBody($mailtext);
127
-			$message->setPlainBody('');
128
-		} else {
129
-			$message->setHtmlBody($mailtext);
130
-			$message->setPlainBody($altbody);
131
-		}
132
-
133
-		if(!empty($ccaddress)) {
134
-			if(!empty($ccname)) {
135
-				$message->setCc([$ccaddress => $ccname]);
136
-			} else {
137
-				$message->setCc([$ccaddress]);
138
-			}
139
-		}
140
-		if(!empty($bcc)) {
141
-			$message->setBcc([$bcc]);
142
-		}
143
-
144
-		$mailer->send($message);
145
-	}
146
-
147
-	/**
148
-	 * write a message in the log
149
-	 * @param string $app
150
-	 * @param string $message
151
-	 * @param int $level
152
-	 * @since 4.0.0
153
-	 * @deprecated 13.0.0 use log of \OCP\ILogger
154
-	 */
155
-	public static function writeLog( $app, $message, $level ) {
156
-		$context = ['app' => $app];
157
-		\OC::$server->getLogger()->log($level, $message, $context);
158
-	}
159
-
160
-	/**
161
-	 * write exception into the log
162
-	 * @param string $app app name
163
-	 * @param \Exception $ex exception to log
164
-	 * @param int $level log level, defaults to \OCP\Util::FATAL
165
-	 * @since ....0.0 - parameter $level was added in 7.0.0
166
-	 * @deprecated 8.2.0 use logException of \OCP\ILogger
167
-	 */
168
-	public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
169
-		\OC::$server->getLogger()->logException($ex, ['app' => $app]);
170
-	}
171
-
172
-	/**
173
-	 * check if sharing is disabled for the current user
174
-	 *
175
-	 * @return boolean
176
-	 * @since 7.0.0
177
-	 * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
178
-	 */
179
-	public static function isSharingDisabledForUser() {
180
-		if (self::$shareManager === null) {
181
-			self::$shareManager = \OC::$server->getShareManager();
182
-		}
183
-
184
-		$user = \OC::$server->getUserSession()->getUser();
185
-		if ($user !== null) {
186
-			$user = $user->getUID();
187
-		}
188
-
189
-		return self::$shareManager->sharingDisabledForUser($user);
190
-	}
191
-
192
-	/**
193
-	 * get l10n object
194
-	 * @param string $application
195
-	 * @param string|null $language
196
-	 * @return \OCP\IL10N
197
-	 * @since 6.0.0 - parameter $language was added in 8.0.0
198
-	 */
199
-	public static function getL10N($application, $language = null) {
200
-		return \OC::$server->getL10N($application, $language);
201
-	}
202
-
203
-	/**
204
-	 * add a css file
205
-	 * @param string $application
206
-	 * @param string $file
207
-	 * @since 4.0.0
208
-	 */
209
-	public static function addStyle( $application, $file = null ) {
210
-		\OC_Util::addStyle( $application, $file );
211
-	}
212
-
213
-	/**
214
-	 * add a javascript file
215
-	 * @param string $application
216
-	 * @param string $file
217
-	 * @since 4.0.0
218
-	 */
219
-	public static function addScript( $application, $file = null ) {
220
-		\OC_Util::addScript( $application, $file );
221
-	}
222
-
223
-	/**
224
-	 * Add a translation JS file
225
-	 * @param string $application application id
226
-	 * @param string $languageCode language code, defaults to the current locale
227
-	 * @since 8.0.0
228
-	 */
229
-	public static function addTranslations($application, $languageCode = null) {
230
-		\OC_Util::addTranslations($application, $languageCode);
231
-	}
232
-
233
-	/**
234
-	 * Add a custom element to the header
235
-	 * If $text is null then the element will be written as empty element.
236
-	 * So use "" to get a closing tag.
237
-	 * @param string $tag tag name of the element
238
-	 * @param array $attributes array of attributes for the element
239
-	 * @param string $text the text content for the element
240
-	 * @since 4.0.0
241
-	 */
242
-	public static function addHeader($tag, $attributes, $text=null) {
243
-		\OC_Util::addHeader($tag, $attributes, $text);
244
-	}
245
-
246
-	/**
247
-	 * formats a timestamp in the "right" way
248
-	 * @param int $timestamp $timestamp
249
-	 * @param bool $dateOnly option to omit time from the result
250
-	 * @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
251
-	 * @return string timestamp
252
-	 *
253
-	 * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
254
-	 * @since 4.0.0
255
-	 * @suppress PhanDeprecatedFunction
256
-	 */
257
-	public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
258
-		return \OC_Util::formatDate($timestamp, $dateOnly, $timeZone);
259
-	}
260
-
261
-	/**
262
-	 * check if some encrypted files are stored
263
-	 * @return bool
264
-	 *
265
-	 * @deprecated 8.1.0 No longer required
266
-	 * @since 6.0.0
267
-	 */
268
-	public static function encryptedFiles() {
269
-		return false;
270
-	}
271
-
272
-	/**
273
-	 * Creates an absolute url to the given app and file.
274
-	 * @param string $app app
275
-	 * @param string $file file
276
-	 * @param array $args array with param=>value, will be appended to the returned url
277
-	 * 	The value of $args will be urlencoded
278
-	 * @return string the url
279
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
280
-	 */
281
-	public static function linkToAbsolute( $app, $file, $args = array() ) {
282
-		$urlGenerator = \OC::$server->getURLGenerator();
283
-		return $urlGenerator->getAbsoluteURL(
284
-			$urlGenerator->linkTo($app, $file, $args)
285
-		);
286
-	}
287
-
288
-	/**
289
-	 * Creates an absolute url for remote use.
290
-	 * @param string $service id
291
-	 * @return string the url
292
-	 * @since 4.0.0
293
-	 */
294
-	public static function linkToRemote( $service ) {
295
-		$urlGenerator = \OC::$server->getURLGenerator();
296
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
297
-		return $urlGenerator->getAbsoluteURL(
298
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
299
-		);
300
-	}
301
-
302
-	/**
303
-	 * Creates an absolute url for public use
304
-	 * @param string $service id
305
-	 * @return string the url
306
-	 * @since 4.5.0
307
-	 */
308
-	public static function linkToPublic($service) {
309
-		return \OC_Helper::linkToPublic($service);
310
-	}
311
-
312
-	/**
313
-	 * Creates an url using a defined route
314
-	 * @param string $route
315
-	 * @param array $parameters
316
-	 * @internal param array $args with param=>value, will be appended to the returned url
317
-	 * @return string the url
318
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
319
-	 * @since 5.0.0
320
-	 */
321
-	public static function linkToRoute( $route, $parameters = array() ) {
322
-		return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
323
-	}
324
-
325
-	/**
326
-	 * Creates an url to the given app and file
327
-	 * @param string $app app
328
-	 * @param string $file file
329
-	 * @param array $args array with param=>value, will be appended to the returned url
330
-	 * 	The value of $args will be urlencoded
331
-	 * @return string the url
332
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
333
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
334
-	 */
335
-	public static function linkTo( $app, $file, $args = array() ) {
336
-		return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
337
-	}
338
-
339
-	/**
340
-	 * Returns the server host, even if the website uses one or more reverse proxy
341
-	 * @return string the server host
342
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getServerHost
343
-	 * @since 4.0.0
344
-	 */
345
-	public static function getServerHost() {
346
-		return \OC::$server->getRequest()->getServerHost();
347
-	}
348
-
349
-	/**
350
-	 * Returns the server host name without an eventual port number
351
-	 * @return string the server hostname
352
-	 * @since 5.0.0
353
-	 */
354
-	public static function getServerHostName() {
355
-		$host_name = \OC::$server->getRequest()->getServerHost();
356
-		// strip away port number (if existing)
357
-		$colon_pos = strpos($host_name, ':');
358
-		if ($colon_pos != FALSE) {
359
-			$host_name = substr($host_name, 0, $colon_pos);
360
-		}
361
-		return $host_name;
362
-	}
363
-
364
-	/**
365
-	 * Returns the default email address
366
-	 * @param string $user_part the user part of the address
367
-	 * @return string the default email address
368
-	 *
369
-	 * Assembles a default email address (using the server hostname
370
-	 * and the given user part, and returns it
371
-	 * Example: when given lostpassword-noreply as $user_part param,
372
-	 *     and is currently accessed via http(s)://example.com/,
373
-	 *     it would return '[email protected]'
374
-	 *
375
-	 * If the configuration value 'mail_from_address' is set in
376
-	 * config.php, this value will override the $user_part that
377
-	 * is passed to this function
378
-	 * @since 5.0.0
379
-	 */
380
-	public static function getDefaultEmailAddress($user_part) {
381
-		$config = \OC::$server->getConfig();
382
-		$user_part = $config->getSystemValue('mail_from_address', $user_part);
383
-		$host_name = self::getServerHostName();
384
-		$host_name = $config->getSystemValue('mail_domain', $host_name);
385
-		$defaultEmailAddress = $user_part.'@'.$host_name;
386
-
387
-		$mailer = \OC::$server->getMailer();
388
-		if ($mailer->validateMailAddress($defaultEmailAddress)) {
389
-			return $defaultEmailAddress;
390
-		}
391
-
392
-		// in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
393
-		return $user_part.'@localhost.localdomain';
394
-	}
395
-
396
-	/**
397
-	 * Returns the server protocol. It respects reverse proxy servers and load balancers
398
-	 * @return string the server protocol
399
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getServerProtocol
400
-	 * @since 4.5.0
401
-	 */
402
-	public static function getServerProtocol() {
403
-		return \OC::$server->getRequest()->getServerProtocol();
404
-	}
405
-
406
-	/**
407
-	 * Returns the request uri, even if the website uses one or more reverse proxies
408
-	 * @return string the request uri
409
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getRequestUri
410
-	 * @since 5.0.0
411
-	 */
412
-	public static function getRequestUri() {
413
-		return \OC::$server->getRequest()->getRequestUri();
414
-	}
415
-
416
-	/**
417
-	 * Returns the script name, even if the website uses one or more reverse proxies
418
-	 * @return string the script name
419
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getScriptName
420
-	 * @since 5.0.0
421
-	 */
422
-	public static function getScriptName() {
423
-		return \OC::$server->getRequest()->getScriptName();
424
-	}
425
-
426
-	/**
427
-	 * Creates path to an image
428
-	 * @param string $app app
429
-	 * @param string $image image name
430
-	 * @return string the url
431
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
432
-	 * @since 4.0.0
433
-	 */
434
-	public static function imagePath( $app, $image ) {
435
-		return \OC::$server->getURLGenerator()->imagePath($app, $image);
436
-	}
437
-
438
-	/**
439
-	 * Make a human file size (2048 to 2 kB)
440
-	 * @param int $bytes file size in bytes
441
-	 * @return string a human readable file size
442
-	 * @since 4.0.0
443
-	 */
444
-	public static function humanFileSize($bytes) {
445
-		return \OC_Helper::humanFileSize($bytes);
446
-	}
447
-
448
-	/**
449
-	 * Make a computer file size (2 kB to 2048)
450
-	 * @param string $str file size in a fancy format
451
-	 * @return float a file size in bytes
452
-	 *
453
-	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
454
-	 * @since 4.0.0
455
-	 */
456
-	public static function computerFileSize($str) {
457
-		return \OC_Helper::computerFileSize($str);
458
-	}
459
-
460
-	/**
461
-	 * connects a function to a hook
462
-	 *
463
-	 * @param string $signalClass class name of emitter
464
-	 * @param string $signalName name of signal
465
-	 * @param string|object $slotClass class name of slot
466
-	 * @param string $slotName name of slot
467
-	 * @return bool
468
-	 *
469
-	 * This function makes it very easy to connect to use hooks.
470
-	 *
471
-	 * TODO: write example
472
-	 * @since 4.0.0
473
-	 */
474
-	static public function connectHook($signalClass, $signalName, $slotClass, $slotName) {
475
-		return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
476
-	}
477
-
478
-	/**
479
-	 * Emits a signal. To get data from the slot use references!
480
-	 * @param string $signalclass class name of emitter
481
-	 * @param string $signalname name of signal
482
-	 * @param array $params default: array() array with additional data
483
-	 * @return bool true if slots exists or false if not
484
-	 *
485
-	 * TODO: write example
486
-	 * @since 4.0.0
487
-	 */
488
-	static public function emitHook($signalclass, $signalname, $params = array()) {
489
-		return \OC_Hook::emit($signalclass, $signalname, $params);
490
-	}
491
-
492
-	/**
493
-	 * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
494
-	 * multiple OC_Template elements which invoke `callRegister`. If the value
495
-	 * would not be cached these unit-tests would fail.
496
-	 * @var string
497
-	 */
498
-	private static $token = '';
499
-
500
-	/**
501
-	 * Register an get/post call. This is important to prevent CSRF attacks
502
-	 * @since 4.5.0
503
-	 */
504
-	public static function callRegister() {
505
-		if(self::$token === '') {
506
-			self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
507
-		}
508
-		return self::$token;
509
-	}
510
-
511
-	/**
512
-	 * Check an ajax get/post call if the request token is valid. exit if not.
513
-	 * @since 4.5.0
514
-	 * @deprecated 9.0.0 Use annotations based on the app framework.
515
-	 */
516
-	public static function callCheck() {
517
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
518
-			header('Location: '.\OC::$WEBROOT);
519
-			exit();
520
-		}
521
-
522
-		if (!\OC::$server->getRequest()->passesCSRFCheck()) {
523
-			exit();
524
-		}
525
-	}
526
-
527
-	/**
528
-	 * Used to sanitize HTML
529
-	 *
530
-	 * This function is used to sanitize HTML and should be applied on any
531
-	 * string or array of strings before displaying it on a web page.
532
-	 *
533
-	 * @param string|array $value
534
-	 * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
535
-	 * @since 4.5.0
536
-	 */
537
-	public static function sanitizeHTML($value) {
538
-		return \OC_Util::sanitizeHTML($value);
539
-	}
540
-
541
-	/**
542
-	 * Public function to encode url parameters
543
-	 *
544
-	 * This function is used to encode path to file before output.
545
-	 * Encoding is done according to RFC 3986 with one exception:
546
-	 * Character '/' is preserved as is.
547
-	 *
548
-	 * @param string $component part of URI to encode
549
-	 * @return string
550
-	 * @since 6.0.0
551
-	 */
552
-	public static function encodePath($component) {
553
-		return \OC_Util::encodePath($component);
554
-	}
555
-
556
-	/**
557
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
558
-	 *
559
-	 * @param array $input The array to work on
560
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
561
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
562
-	 * @return array
563
-	 * @since 4.5.0
564
-	 */
565
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
566
-		return \OC_Helper::mb_array_change_key_case($input, $case, $encoding);
567
-	}
568
-
569
-	/**
570
-	 * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
571
-	 *
572
-	 * @param string $string The input string. Opposite to the PHP build-in function does not accept an array.
573
-	 * @param string $replacement The replacement string.
574
-	 * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
575
-	 * @param int $length Length of the part to be replaced
576
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
577
-	 * @return string
578
-	 * @since 4.5.0
579
-	 * @deprecated 8.2.0 Use substr_replace() instead.
580
-	 */
581
-	public static function mb_substr_replace($string, $replacement, $start, $length = null, $encoding = 'UTF-8') {
582
-		return substr_replace($string, $replacement, $start, $length);
583
-	}
584
-
585
-	/**
586
-	 * Replace all occurrences of the search string with the replacement string
587
-	 *
588
-	 * @param string $search The value being searched for, otherwise known as the needle. String.
589
-	 * @param string $replace The replacement string.
590
-	 * @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
591
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
592
-	 * @param int $count If passed, this will be set to the number of replacements performed.
593
-	 * @return string
594
-	 * @since 4.5.0
595
-	 * @deprecated 8.2.0 Use str_replace() instead.
596
-	 */
597
-	public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
598
-		return str_replace($search, $replace, $subject, $count);
599
-	}
600
-
601
-	/**
602
-	 * performs a search in a nested array
603
-	 *
604
-	 * @param array $haystack the array to be searched
605
-	 * @param string $needle the search string
606
-	 * @param mixed $index optional, only search this key name
607
-	 * @return mixed the key of the matching field, otherwise false
608
-	 * @since 4.5.0
609
-	 */
610
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
611
-		return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
612
-	}
613
-
614
-	/**
615
-	 * calculates the maximum upload size respecting system settings, free space and user quota
616
-	 *
617
-	 * @param string $dir the current folder where the user currently operates
618
-	 * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
619
-	 * @return int number of bytes representing
620
-	 * @since 5.0.0
621
-	 */
622
-	public static function maxUploadFilesize($dir, $free = null) {
623
-		return \OC_Helper::maxUploadFilesize($dir, $free);
624
-	}
625
-
626
-	/**
627
-	 * Calculate free space left within user quota
628
-	 * @param string $dir the current folder where the user currently operates
629
-	 * @return int number of bytes representing
630
-	 * @since 7.0.0
631
-	 */
632
-	public static function freeSpace($dir) {
633
-		return \OC_Helper::freeSpace($dir);
634
-	}
635
-
636
-	/**
637
-	 * Calculate PHP upload limit
638
-	 *
639
-	 * @return int number of bytes representing
640
-	 * @since 7.0.0
641
-	 */
642
-	public static function uploadLimit() {
643
-		return \OC_Helper::uploadLimit();
644
-	}
645
-
646
-	/**
647
-	 * Returns whether the given file name is valid
648
-	 * @param string $file file name to check
649
-	 * @return bool true if the file name is valid, false otherwise
650
-	 * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
651
-	 * @since 7.0.0
652
-	 * @suppress PhanDeprecatedFunction
653
-	 */
654
-	public static function isValidFileName($file) {
655
-		return \OC_Util::isValidFileName($file);
656
-	}
657
-
658
-	/**
659
-	 * Generates a cryptographic secure pseudo-random string
660
-	 * @param int $length of the random string
661
-	 * @return string
662
-	 * @deprecated 8.0.0 Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
663
-	 * @since 7.0.0
664
-	 */
665
-	public static function generateRandomBytes($length = 30) {
666
-		return \OC::$server->getSecureRandom()->generate($length, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
667
-	}
668
-
669
-	/**
670
-	 * Compare two strings to provide a natural sort
671
-	 * @param string $a first string to compare
672
-	 * @param string $b second string to compare
673
-	 * @return int -1 if $b comes before $a, 1 if $a comes before $b
674
-	 * or 0 if the strings are identical
675
-	 * @since 7.0.0
676
-	 */
677
-	public static function naturalSortCompare($a, $b) {
678
-		return \OC\NaturalSort::getInstance()->compare($a, $b);
679
-	}
680
-
681
-	/**
682
-	 * check if a password is required for each public link
683
-	 * @return boolean
684
-	 * @since 7.0.0
685
-	 */
686
-	public static function isPublicLinkPasswordRequired() {
687
-		return \OC_Util::isPublicLinkPasswordRequired();
688
-	}
689
-
690
-	/**
691
-	 * check if share API enforces a default expire date
692
-	 * @return boolean
693
-	 * @since 8.0.0
694
-	 */
695
-	public static function isDefaultExpireDateEnforced() {
696
-		return \OC_Util::isDefaultExpireDateEnforced();
697
-	}
698
-
699
-	protected static $needUpgradeCache = null;
700
-
701
-	/**
702
-	 * Checks whether the current version needs upgrade.
703
-	 *
704
-	 * @return bool true if upgrade is needed, false otherwise
705
-	 * @since 7.0.0
706
-	 */
707
-	public static function needUpgrade() {
708
-		if (!isset(self::$needUpgradeCache)) {
709
-			self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getSystemConfig());
710
-		}		
711
-		return self::$needUpgradeCache;
712
-	}
88
+    /**
89
+     * Get current update channel
90
+     * @return string
91
+     * @since 8.1.0
92
+     */
93
+    public static function getChannel() {
94
+        return \OC_Util::getChannel();
95
+    }
96
+
97
+    /**
98
+     * send an email
99
+     * @param string $toaddress
100
+     * @param string $toname
101
+     * @param string $subject
102
+     * @param string $mailtext
103
+     * @param string $fromaddress
104
+     * @param string $fromname
105
+     * @param int $html
106
+     * @param string $altbody
107
+     * @param string $ccaddress
108
+     * @param string $ccname
109
+     * @param string $bcc
110
+     * @deprecated 8.1.0 Use \OCP\Mail\IMailer instead
111
+     * @since 4.0.0
112
+     */
113
+    public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
114
+        $html = 0, $altbody = '', $ccaddress = '', $ccname = '', $bcc = '') {
115
+        $mailer = \OC::$server->getMailer();
116
+        $message = $mailer->createMessage();
117
+        $message->setTo([$toaddress => $toname]);
118
+        $message->setSubject($subject);
119
+        $message->setPlainBody($mailtext);
120
+        $message->setFrom([$fromaddress => $fromname]);
121
+        if($html === 1) {
122
+            $message->setHtmlBody($altbody);
123
+        }
124
+
125
+        if($altbody === '') {
126
+            $message->setHtmlBody($mailtext);
127
+            $message->setPlainBody('');
128
+        } else {
129
+            $message->setHtmlBody($mailtext);
130
+            $message->setPlainBody($altbody);
131
+        }
132
+
133
+        if(!empty($ccaddress)) {
134
+            if(!empty($ccname)) {
135
+                $message->setCc([$ccaddress => $ccname]);
136
+            } else {
137
+                $message->setCc([$ccaddress]);
138
+            }
139
+        }
140
+        if(!empty($bcc)) {
141
+            $message->setBcc([$bcc]);
142
+        }
143
+
144
+        $mailer->send($message);
145
+    }
146
+
147
+    /**
148
+     * write a message in the log
149
+     * @param string $app
150
+     * @param string $message
151
+     * @param int $level
152
+     * @since 4.0.0
153
+     * @deprecated 13.0.0 use log of \OCP\ILogger
154
+     */
155
+    public static function writeLog( $app, $message, $level ) {
156
+        $context = ['app' => $app];
157
+        \OC::$server->getLogger()->log($level, $message, $context);
158
+    }
159
+
160
+    /**
161
+     * write exception into the log
162
+     * @param string $app app name
163
+     * @param \Exception $ex exception to log
164
+     * @param int $level log level, defaults to \OCP\Util::FATAL
165
+     * @since ....0.0 - parameter $level was added in 7.0.0
166
+     * @deprecated 8.2.0 use logException of \OCP\ILogger
167
+     */
168
+    public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
169
+        \OC::$server->getLogger()->logException($ex, ['app' => $app]);
170
+    }
171
+
172
+    /**
173
+     * check if sharing is disabled for the current user
174
+     *
175
+     * @return boolean
176
+     * @since 7.0.0
177
+     * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
178
+     */
179
+    public static function isSharingDisabledForUser() {
180
+        if (self::$shareManager === null) {
181
+            self::$shareManager = \OC::$server->getShareManager();
182
+        }
183
+
184
+        $user = \OC::$server->getUserSession()->getUser();
185
+        if ($user !== null) {
186
+            $user = $user->getUID();
187
+        }
188
+
189
+        return self::$shareManager->sharingDisabledForUser($user);
190
+    }
191
+
192
+    /**
193
+     * get l10n object
194
+     * @param string $application
195
+     * @param string|null $language
196
+     * @return \OCP\IL10N
197
+     * @since 6.0.0 - parameter $language was added in 8.0.0
198
+     */
199
+    public static function getL10N($application, $language = null) {
200
+        return \OC::$server->getL10N($application, $language);
201
+    }
202
+
203
+    /**
204
+     * add a css file
205
+     * @param string $application
206
+     * @param string $file
207
+     * @since 4.0.0
208
+     */
209
+    public static function addStyle( $application, $file = null ) {
210
+        \OC_Util::addStyle( $application, $file );
211
+    }
212
+
213
+    /**
214
+     * add a javascript file
215
+     * @param string $application
216
+     * @param string $file
217
+     * @since 4.0.0
218
+     */
219
+    public static function addScript( $application, $file = null ) {
220
+        \OC_Util::addScript( $application, $file );
221
+    }
222
+
223
+    /**
224
+     * Add a translation JS file
225
+     * @param string $application application id
226
+     * @param string $languageCode language code, defaults to the current locale
227
+     * @since 8.0.0
228
+     */
229
+    public static function addTranslations($application, $languageCode = null) {
230
+        \OC_Util::addTranslations($application, $languageCode);
231
+    }
232
+
233
+    /**
234
+     * Add a custom element to the header
235
+     * If $text is null then the element will be written as empty element.
236
+     * So use "" to get a closing tag.
237
+     * @param string $tag tag name of the element
238
+     * @param array $attributes array of attributes for the element
239
+     * @param string $text the text content for the element
240
+     * @since 4.0.0
241
+     */
242
+    public static function addHeader($tag, $attributes, $text=null) {
243
+        \OC_Util::addHeader($tag, $attributes, $text);
244
+    }
245
+
246
+    /**
247
+     * formats a timestamp in the "right" way
248
+     * @param int $timestamp $timestamp
249
+     * @param bool $dateOnly option to omit time from the result
250
+     * @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
251
+     * @return string timestamp
252
+     *
253
+     * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
254
+     * @since 4.0.0
255
+     * @suppress PhanDeprecatedFunction
256
+     */
257
+    public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
258
+        return \OC_Util::formatDate($timestamp, $dateOnly, $timeZone);
259
+    }
260
+
261
+    /**
262
+     * check if some encrypted files are stored
263
+     * @return bool
264
+     *
265
+     * @deprecated 8.1.0 No longer required
266
+     * @since 6.0.0
267
+     */
268
+    public static function encryptedFiles() {
269
+        return false;
270
+    }
271
+
272
+    /**
273
+     * Creates an absolute url to the given app and file.
274
+     * @param string $app app
275
+     * @param string $file file
276
+     * @param array $args array with param=>value, will be appended to the returned url
277
+     * 	The value of $args will be urlencoded
278
+     * @return string the url
279
+     * @since 4.0.0 - parameter $args was added in 4.5.0
280
+     */
281
+    public static function linkToAbsolute( $app, $file, $args = array() ) {
282
+        $urlGenerator = \OC::$server->getURLGenerator();
283
+        return $urlGenerator->getAbsoluteURL(
284
+            $urlGenerator->linkTo($app, $file, $args)
285
+        );
286
+    }
287
+
288
+    /**
289
+     * Creates an absolute url for remote use.
290
+     * @param string $service id
291
+     * @return string the url
292
+     * @since 4.0.0
293
+     */
294
+    public static function linkToRemote( $service ) {
295
+        $urlGenerator = \OC::$server->getURLGenerator();
296
+        $remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
297
+        return $urlGenerator->getAbsoluteURL(
298
+            $remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
299
+        );
300
+    }
301
+
302
+    /**
303
+     * Creates an absolute url for public use
304
+     * @param string $service id
305
+     * @return string the url
306
+     * @since 4.5.0
307
+     */
308
+    public static function linkToPublic($service) {
309
+        return \OC_Helper::linkToPublic($service);
310
+    }
311
+
312
+    /**
313
+     * Creates an url using a defined route
314
+     * @param string $route
315
+     * @param array $parameters
316
+     * @internal param array $args with param=>value, will be appended to the returned url
317
+     * @return string the url
318
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
319
+     * @since 5.0.0
320
+     */
321
+    public static function linkToRoute( $route, $parameters = array() ) {
322
+        return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
323
+    }
324
+
325
+    /**
326
+     * Creates an url to the given app and file
327
+     * @param string $app app
328
+     * @param string $file file
329
+     * @param array $args array with param=>value, will be appended to the returned url
330
+     * 	The value of $args will be urlencoded
331
+     * @return string the url
332
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
333
+     * @since 4.0.0 - parameter $args was added in 4.5.0
334
+     */
335
+    public static function linkTo( $app, $file, $args = array() ) {
336
+        return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
337
+    }
338
+
339
+    /**
340
+     * Returns the server host, even if the website uses one or more reverse proxy
341
+     * @return string the server host
342
+     * @deprecated 8.1.0 Use \OCP\IRequest::getServerHost
343
+     * @since 4.0.0
344
+     */
345
+    public static function getServerHost() {
346
+        return \OC::$server->getRequest()->getServerHost();
347
+    }
348
+
349
+    /**
350
+     * Returns the server host name without an eventual port number
351
+     * @return string the server hostname
352
+     * @since 5.0.0
353
+     */
354
+    public static function getServerHostName() {
355
+        $host_name = \OC::$server->getRequest()->getServerHost();
356
+        // strip away port number (if existing)
357
+        $colon_pos = strpos($host_name, ':');
358
+        if ($colon_pos != FALSE) {
359
+            $host_name = substr($host_name, 0, $colon_pos);
360
+        }
361
+        return $host_name;
362
+    }
363
+
364
+    /**
365
+     * Returns the default email address
366
+     * @param string $user_part the user part of the address
367
+     * @return string the default email address
368
+     *
369
+     * Assembles a default email address (using the server hostname
370
+     * and the given user part, and returns it
371
+     * Example: when given lostpassword-noreply as $user_part param,
372
+     *     and is currently accessed via http(s)://example.com/,
373
+     *     it would return '[email protected]'
374
+     *
375
+     * If the configuration value 'mail_from_address' is set in
376
+     * config.php, this value will override the $user_part that
377
+     * is passed to this function
378
+     * @since 5.0.0
379
+     */
380
+    public static function getDefaultEmailAddress($user_part) {
381
+        $config = \OC::$server->getConfig();
382
+        $user_part = $config->getSystemValue('mail_from_address', $user_part);
383
+        $host_name = self::getServerHostName();
384
+        $host_name = $config->getSystemValue('mail_domain', $host_name);
385
+        $defaultEmailAddress = $user_part.'@'.$host_name;
386
+
387
+        $mailer = \OC::$server->getMailer();
388
+        if ($mailer->validateMailAddress($defaultEmailAddress)) {
389
+            return $defaultEmailAddress;
390
+        }
391
+
392
+        // in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
393
+        return $user_part.'@localhost.localdomain';
394
+    }
395
+
396
+    /**
397
+     * Returns the server protocol. It respects reverse proxy servers and load balancers
398
+     * @return string the server protocol
399
+     * @deprecated 8.1.0 Use \OCP\IRequest::getServerProtocol
400
+     * @since 4.5.0
401
+     */
402
+    public static function getServerProtocol() {
403
+        return \OC::$server->getRequest()->getServerProtocol();
404
+    }
405
+
406
+    /**
407
+     * Returns the request uri, even if the website uses one or more reverse proxies
408
+     * @return string the request uri
409
+     * @deprecated 8.1.0 Use \OCP\IRequest::getRequestUri
410
+     * @since 5.0.0
411
+     */
412
+    public static function getRequestUri() {
413
+        return \OC::$server->getRequest()->getRequestUri();
414
+    }
415
+
416
+    /**
417
+     * Returns the script name, even if the website uses one or more reverse proxies
418
+     * @return string the script name
419
+     * @deprecated 8.1.0 Use \OCP\IRequest::getScriptName
420
+     * @since 5.0.0
421
+     */
422
+    public static function getScriptName() {
423
+        return \OC::$server->getRequest()->getScriptName();
424
+    }
425
+
426
+    /**
427
+     * Creates path to an image
428
+     * @param string $app app
429
+     * @param string $image image name
430
+     * @return string the url
431
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
432
+     * @since 4.0.0
433
+     */
434
+    public static function imagePath( $app, $image ) {
435
+        return \OC::$server->getURLGenerator()->imagePath($app, $image);
436
+    }
437
+
438
+    /**
439
+     * Make a human file size (2048 to 2 kB)
440
+     * @param int $bytes file size in bytes
441
+     * @return string a human readable file size
442
+     * @since 4.0.0
443
+     */
444
+    public static function humanFileSize($bytes) {
445
+        return \OC_Helper::humanFileSize($bytes);
446
+    }
447
+
448
+    /**
449
+     * Make a computer file size (2 kB to 2048)
450
+     * @param string $str file size in a fancy format
451
+     * @return float a file size in bytes
452
+     *
453
+     * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
454
+     * @since 4.0.0
455
+     */
456
+    public static function computerFileSize($str) {
457
+        return \OC_Helper::computerFileSize($str);
458
+    }
459
+
460
+    /**
461
+     * connects a function to a hook
462
+     *
463
+     * @param string $signalClass class name of emitter
464
+     * @param string $signalName name of signal
465
+     * @param string|object $slotClass class name of slot
466
+     * @param string $slotName name of slot
467
+     * @return bool
468
+     *
469
+     * This function makes it very easy to connect to use hooks.
470
+     *
471
+     * TODO: write example
472
+     * @since 4.0.0
473
+     */
474
+    static public function connectHook($signalClass, $signalName, $slotClass, $slotName) {
475
+        return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
476
+    }
477
+
478
+    /**
479
+     * Emits a signal. To get data from the slot use references!
480
+     * @param string $signalclass class name of emitter
481
+     * @param string $signalname name of signal
482
+     * @param array $params default: array() array with additional data
483
+     * @return bool true if slots exists or false if not
484
+     *
485
+     * TODO: write example
486
+     * @since 4.0.0
487
+     */
488
+    static public function emitHook($signalclass, $signalname, $params = array()) {
489
+        return \OC_Hook::emit($signalclass, $signalname, $params);
490
+    }
491
+
492
+    /**
493
+     * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
494
+     * multiple OC_Template elements which invoke `callRegister`. If the value
495
+     * would not be cached these unit-tests would fail.
496
+     * @var string
497
+     */
498
+    private static $token = '';
499
+
500
+    /**
501
+     * Register an get/post call. This is important to prevent CSRF attacks
502
+     * @since 4.5.0
503
+     */
504
+    public static function callRegister() {
505
+        if(self::$token === '') {
506
+            self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
507
+        }
508
+        return self::$token;
509
+    }
510
+
511
+    /**
512
+     * Check an ajax get/post call if the request token is valid. exit if not.
513
+     * @since 4.5.0
514
+     * @deprecated 9.0.0 Use annotations based on the app framework.
515
+     */
516
+    public static function callCheck() {
517
+        if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
518
+            header('Location: '.\OC::$WEBROOT);
519
+            exit();
520
+        }
521
+
522
+        if (!\OC::$server->getRequest()->passesCSRFCheck()) {
523
+            exit();
524
+        }
525
+    }
526
+
527
+    /**
528
+     * Used to sanitize HTML
529
+     *
530
+     * This function is used to sanitize HTML and should be applied on any
531
+     * string or array of strings before displaying it on a web page.
532
+     *
533
+     * @param string|array $value
534
+     * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
535
+     * @since 4.5.0
536
+     */
537
+    public static function sanitizeHTML($value) {
538
+        return \OC_Util::sanitizeHTML($value);
539
+    }
540
+
541
+    /**
542
+     * Public function to encode url parameters
543
+     *
544
+     * This function is used to encode path to file before output.
545
+     * Encoding is done according to RFC 3986 with one exception:
546
+     * Character '/' is preserved as is.
547
+     *
548
+     * @param string $component part of URI to encode
549
+     * @return string
550
+     * @since 6.0.0
551
+     */
552
+    public static function encodePath($component) {
553
+        return \OC_Util::encodePath($component);
554
+    }
555
+
556
+    /**
557
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
558
+     *
559
+     * @param array $input The array to work on
560
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
561
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
562
+     * @return array
563
+     * @since 4.5.0
564
+     */
565
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
566
+        return \OC_Helper::mb_array_change_key_case($input, $case, $encoding);
567
+    }
568
+
569
+    /**
570
+     * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
571
+     *
572
+     * @param string $string The input string. Opposite to the PHP build-in function does not accept an array.
573
+     * @param string $replacement The replacement string.
574
+     * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
575
+     * @param int $length Length of the part to be replaced
576
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
577
+     * @return string
578
+     * @since 4.5.0
579
+     * @deprecated 8.2.0 Use substr_replace() instead.
580
+     */
581
+    public static function mb_substr_replace($string, $replacement, $start, $length = null, $encoding = 'UTF-8') {
582
+        return substr_replace($string, $replacement, $start, $length);
583
+    }
584
+
585
+    /**
586
+     * Replace all occurrences of the search string with the replacement string
587
+     *
588
+     * @param string $search The value being searched for, otherwise known as the needle. String.
589
+     * @param string $replace The replacement string.
590
+     * @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
591
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
592
+     * @param int $count If passed, this will be set to the number of replacements performed.
593
+     * @return string
594
+     * @since 4.5.0
595
+     * @deprecated 8.2.0 Use str_replace() instead.
596
+     */
597
+    public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
598
+        return str_replace($search, $replace, $subject, $count);
599
+    }
600
+
601
+    /**
602
+     * performs a search in a nested array
603
+     *
604
+     * @param array $haystack the array to be searched
605
+     * @param string $needle the search string
606
+     * @param mixed $index optional, only search this key name
607
+     * @return mixed the key of the matching field, otherwise false
608
+     * @since 4.5.0
609
+     */
610
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
611
+        return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
612
+    }
613
+
614
+    /**
615
+     * calculates the maximum upload size respecting system settings, free space and user quota
616
+     *
617
+     * @param string $dir the current folder where the user currently operates
618
+     * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
619
+     * @return int number of bytes representing
620
+     * @since 5.0.0
621
+     */
622
+    public static function maxUploadFilesize($dir, $free = null) {
623
+        return \OC_Helper::maxUploadFilesize($dir, $free);
624
+    }
625
+
626
+    /**
627
+     * Calculate free space left within user quota
628
+     * @param string $dir the current folder where the user currently operates
629
+     * @return int number of bytes representing
630
+     * @since 7.0.0
631
+     */
632
+    public static function freeSpace($dir) {
633
+        return \OC_Helper::freeSpace($dir);
634
+    }
635
+
636
+    /**
637
+     * Calculate PHP upload limit
638
+     *
639
+     * @return int number of bytes representing
640
+     * @since 7.0.0
641
+     */
642
+    public static function uploadLimit() {
643
+        return \OC_Helper::uploadLimit();
644
+    }
645
+
646
+    /**
647
+     * Returns whether the given file name is valid
648
+     * @param string $file file name to check
649
+     * @return bool true if the file name is valid, false otherwise
650
+     * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
651
+     * @since 7.0.0
652
+     * @suppress PhanDeprecatedFunction
653
+     */
654
+    public static function isValidFileName($file) {
655
+        return \OC_Util::isValidFileName($file);
656
+    }
657
+
658
+    /**
659
+     * Generates a cryptographic secure pseudo-random string
660
+     * @param int $length of the random string
661
+     * @return string
662
+     * @deprecated 8.0.0 Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
663
+     * @since 7.0.0
664
+     */
665
+    public static function generateRandomBytes($length = 30) {
666
+        return \OC::$server->getSecureRandom()->generate($length, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
667
+    }
668
+
669
+    /**
670
+     * Compare two strings to provide a natural sort
671
+     * @param string $a first string to compare
672
+     * @param string $b second string to compare
673
+     * @return int -1 if $b comes before $a, 1 if $a comes before $b
674
+     * or 0 if the strings are identical
675
+     * @since 7.0.0
676
+     */
677
+    public static function naturalSortCompare($a, $b) {
678
+        return \OC\NaturalSort::getInstance()->compare($a, $b);
679
+    }
680
+
681
+    /**
682
+     * check if a password is required for each public link
683
+     * @return boolean
684
+     * @since 7.0.0
685
+     */
686
+    public static function isPublicLinkPasswordRequired() {
687
+        return \OC_Util::isPublicLinkPasswordRequired();
688
+    }
689
+
690
+    /**
691
+     * check if share API enforces a default expire date
692
+     * @return boolean
693
+     * @since 8.0.0
694
+     */
695
+    public static function isDefaultExpireDateEnforced() {
696
+        return \OC_Util::isDefaultExpireDateEnforced();
697
+    }
698
+
699
+    protected static $needUpgradeCache = null;
700
+
701
+    /**
702
+     * Checks whether the current version needs upgrade.
703
+     *
704
+     * @return bool true if upgrade is needed, false otherwise
705
+     * @since 7.0.0
706
+     */
707
+    public static function needUpgrade() {
708
+        if (!isset(self::$needUpgradeCache)) {
709
+            self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getSystemConfig());
710
+        }		
711
+        return self::$needUpgradeCache;
712
+    }
713 713
 }
Please login to merge, or discard this patch.
lib/private/Files/View.php 3 patches
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -200,7 +200,7 @@  discard block
 block discarded – undo
200 200
 	 * and does not take the chroot into account )
201 201
 	 *
202 202
 	 * @param string $path
203
-	 * @return \OCP\Files\Mount\IMountPoint
203
+	 * @return Mount\MountPoint|null
204 204
 	 */
205 205
 	public function getMount($path) {
206 206
 		return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
@@ -963,7 +963,7 @@  discard block
 block discarded – undo
963 963
 
964 964
 	/**
965 965
 	 * @param string $path
966
-	 * @return bool|string
966
+	 * @return string|false
967 967
 	 * @throws \OCP\Files\InvalidPathException
968 968
 	 */
969 969
 	public function toTmpFile($path) {
@@ -1078,7 +1078,7 @@  discard block
 block discarded – undo
1078 1078
 	 * @param string $path
1079 1079
 	 * @param array $hooks (optional)
1080 1080
 	 * @param mixed $extraParam (optional)
1081
-	 * @return mixed
1081
+	 * @return string
1082 1082
 	 * @throws \Exception
1083 1083
 	 *
1084 1084
 	 * This method takes requests for basic filesystem functions (e.g. reading & writing
@@ -2086,7 +2086,7 @@  discard block
 block discarded – undo
2086 2086
 
2087 2087
 	/**
2088 2088
 	 * @param string $filename
2089
-	 * @return array
2089
+	 * @return string[]
2090 2090
 	 * @throws \OC\User\NoUserException
2091 2091
 	 * @throws NotFoundException
2092 2092
 	 */
Please login to merge, or discard this patch.
Indentation   +2084 added lines, -2084 removed lines patch added patch discarded remove patch
@@ -80,2088 +80,2088 @@
 block discarded – undo
80 80
  * \OC\Files\Storage\Storage object
81 81
  */
82 82
 class View {
83
-	/** @var string */
84
-	private $fakeRoot = '';
85
-
86
-	/**
87
-	 * @var \OCP\Lock\ILockingProvider
88
-	 */
89
-	protected $lockingProvider;
90
-
91
-	private $lockingEnabled;
92
-
93
-	private $updaterEnabled = true;
94
-
95
-	/** @var \OC\User\Manager */
96
-	private $userManager;
97
-
98
-	/** @var \OCP\ILogger */
99
-	private $logger;
100
-
101
-	/**
102
-	 * @param string $root
103
-	 * @throws \Exception If $root contains an invalid path
104
-	 */
105
-	public function __construct($root = '') {
106
-		if (is_null($root)) {
107
-			throw new \InvalidArgumentException('Root can\'t be null');
108
-		}
109
-		if (!Filesystem::isValidPath($root)) {
110
-			throw new \Exception();
111
-		}
112
-
113
-		$this->fakeRoot = $root;
114
-		$this->lockingProvider = \OC::$server->getLockingProvider();
115
-		$this->lockingEnabled = !($this->lockingProvider instanceof \OC\Lock\NoopLockingProvider);
116
-		$this->userManager = \OC::$server->getUserManager();
117
-		$this->logger = \OC::$server->getLogger();
118
-	}
119
-
120
-	public function getAbsolutePath($path = '/') {
121
-		if ($path === null) {
122
-			return null;
123
-		}
124
-		$this->assertPathLength($path);
125
-		if ($path === '') {
126
-			$path = '/';
127
-		}
128
-		if ($path[0] !== '/') {
129
-			$path = '/' . $path;
130
-		}
131
-		return $this->fakeRoot . $path;
132
-	}
133
-
134
-	/**
135
-	 * change the root to a fake root
136
-	 *
137
-	 * @param string $fakeRoot
138
-	 * @return boolean|null
139
-	 */
140
-	public function chroot($fakeRoot) {
141
-		if (!$fakeRoot == '') {
142
-			if ($fakeRoot[0] !== '/') {
143
-				$fakeRoot = '/' . $fakeRoot;
144
-			}
145
-		}
146
-		$this->fakeRoot = $fakeRoot;
147
-	}
148
-
149
-	/**
150
-	 * get the fake root
151
-	 *
152
-	 * @return string
153
-	 */
154
-	public function getRoot() {
155
-		return $this->fakeRoot;
156
-	}
157
-
158
-	/**
159
-	 * get path relative to the root of the view
160
-	 *
161
-	 * @param string $path
162
-	 * @return string
163
-	 */
164
-	public function getRelativePath($path) {
165
-		$this->assertPathLength($path);
166
-		if ($this->fakeRoot == '') {
167
-			return $path;
168
-		}
169
-
170
-		if (rtrim($path, '/') === rtrim($this->fakeRoot, '/')) {
171
-			return '/';
172
-		}
173
-
174
-		// missing slashes can cause wrong matches!
175
-		$root = rtrim($this->fakeRoot, '/') . '/';
176
-
177
-		if (strpos($path, $root) !== 0) {
178
-			return null;
179
-		} else {
180
-			$path = substr($path, strlen($this->fakeRoot));
181
-			if (strlen($path) === 0) {
182
-				return '/';
183
-			} else {
184
-				return $path;
185
-			}
186
-		}
187
-	}
188
-
189
-	/**
190
-	 * get the mountpoint of the storage object for a path
191
-	 * ( note: because a storage is not always mounted inside the fakeroot, the
192
-	 * returned mountpoint is relative to the absolute root of the filesystem
193
-	 * and does not take the chroot into account )
194
-	 *
195
-	 * @param string $path
196
-	 * @return string
197
-	 */
198
-	public function getMountPoint($path) {
199
-		return Filesystem::getMountPoint($this->getAbsolutePath($path));
200
-	}
201
-
202
-	/**
203
-	 * get the mountpoint of the storage object for a path
204
-	 * ( note: because a storage is not always mounted inside the fakeroot, the
205
-	 * returned mountpoint is relative to the absolute root of the filesystem
206
-	 * and does not take the chroot into account )
207
-	 *
208
-	 * @param string $path
209
-	 * @return \OCP\Files\Mount\IMountPoint
210
-	 */
211
-	public function getMount($path) {
212
-		return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
213
-	}
214
-
215
-	/**
216
-	 * resolve a path to a storage and internal path
217
-	 *
218
-	 * @param string $path
219
-	 * @return array an array consisting of the storage and the internal path
220
-	 */
221
-	public function resolvePath($path) {
222
-		$a = $this->getAbsolutePath($path);
223
-		$p = Filesystem::normalizePath($a);
224
-		return Filesystem::resolvePath($p);
225
-	}
226
-
227
-	/**
228
-	 * return the path to a local version of the file
229
-	 * we need this because we can't know if a file is stored local or not from
230
-	 * outside the filestorage and for some purposes a local file is needed
231
-	 *
232
-	 * @param string $path
233
-	 * @return string
234
-	 */
235
-	public function getLocalFile($path) {
236
-		$parent = substr($path, 0, strrpos($path, '/'));
237
-		$path = $this->getAbsolutePath($path);
238
-		list($storage, $internalPath) = Filesystem::resolvePath($path);
239
-		if (Filesystem::isValidPath($parent) and $storage) {
240
-			return $storage->getLocalFile($internalPath);
241
-		} else {
242
-			return null;
243
-		}
244
-	}
245
-
246
-	/**
247
-	 * @param string $path
248
-	 * @return string
249
-	 */
250
-	public function getLocalFolder($path) {
251
-		$parent = substr($path, 0, strrpos($path, '/'));
252
-		$path = $this->getAbsolutePath($path);
253
-		list($storage, $internalPath) = Filesystem::resolvePath($path);
254
-		if (Filesystem::isValidPath($parent) and $storage) {
255
-			return $storage->getLocalFolder($internalPath);
256
-		} else {
257
-			return null;
258
-		}
259
-	}
260
-
261
-	/**
262
-	 * the following functions operate with arguments and return values identical
263
-	 * to those of their PHP built-in equivalents. Mostly they are merely wrappers
264
-	 * for \OC\Files\Storage\Storage via basicOperation().
265
-	 */
266
-	public function mkdir($path) {
267
-		return $this->basicOperation('mkdir', $path, array('create', 'write'));
268
-	}
269
-
270
-	/**
271
-	 * remove mount point
272
-	 *
273
-	 * @param \OC\Files\Mount\MoveableMount $mount
274
-	 * @param string $path relative to data/
275
-	 * @return boolean
276
-	 */
277
-	protected function removeMount($mount, $path) {
278
-		if ($mount instanceof MoveableMount) {
279
-			// cut of /user/files to get the relative path to data/user/files
280
-			$pathParts = explode('/', $path, 4);
281
-			$relPath = '/' . $pathParts[3];
282
-			$this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true);
283
-			\OC_Hook::emit(
284
-				Filesystem::CLASSNAME, "umount",
285
-				array(Filesystem::signal_param_path => $relPath)
286
-			);
287
-			$this->changeLock($relPath, ILockingProvider::LOCK_EXCLUSIVE, true);
288
-			$result = $mount->removeMount();
289
-			$this->changeLock($relPath, ILockingProvider::LOCK_SHARED, true);
290
-			if ($result) {
291
-				\OC_Hook::emit(
292
-					Filesystem::CLASSNAME, "post_umount",
293
-					array(Filesystem::signal_param_path => $relPath)
294
-				);
295
-			}
296
-			$this->unlockFile($relPath, ILockingProvider::LOCK_SHARED, true);
297
-			return $result;
298
-		} else {
299
-			// do not allow deleting the storage's root / the mount point
300
-			// because for some storages it might delete the whole contents
301
-			// but isn't supposed to work that way
302
-			return false;
303
-		}
304
-	}
305
-
306
-	public function disableCacheUpdate() {
307
-		$this->updaterEnabled = false;
308
-	}
309
-
310
-	public function enableCacheUpdate() {
311
-		$this->updaterEnabled = true;
312
-	}
313
-
314
-	protected function writeUpdate(Storage $storage, $internalPath, $time = null) {
315
-		if ($this->updaterEnabled) {
316
-			if (is_null($time)) {
317
-				$time = time();
318
-			}
319
-			$storage->getUpdater()->update($internalPath, $time);
320
-		}
321
-	}
322
-
323
-	protected function removeUpdate(Storage $storage, $internalPath) {
324
-		if ($this->updaterEnabled) {
325
-			$storage->getUpdater()->remove($internalPath);
326
-		}
327
-	}
328
-
329
-	protected function renameUpdate(Storage $sourceStorage, Storage $targetStorage, $sourceInternalPath, $targetInternalPath) {
330
-		if ($this->updaterEnabled) {
331
-			$targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
332
-		}
333
-	}
334
-
335
-	/**
336
-	 * @param string $path
337
-	 * @return bool|mixed
338
-	 */
339
-	public function rmdir($path) {
340
-		$absolutePath = $this->getAbsolutePath($path);
341
-		$mount = Filesystem::getMountManager()->find($absolutePath);
342
-		if ($mount->getInternalPath($absolutePath) === '') {
343
-			return $this->removeMount($mount, $absolutePath);
344
-		}
345
-		if ($this->is_dir($path)) {
346
-			$result = $this->basicOperation('rmdir', $path, array('delete'));
347
-		} else {
348
-			$result = false;
349
-		}
350
-
351
-		if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
352
-			$storage = $mount->getStorage();
353
-			$internalPath = $mount->getInternalPath($absolutePath);
354
-			$storage->getUpdater()->remove($internalPath);
355
-		}
356
-		return $result;
357
-	}
358
-
359
-	/**
360
-	 * @param string $path
361
-	 * @return resource
362
-	 */
363
-	public function opendir($path) {
364
-		return $this->basicOperation('opendir', $path, array('read'));
365
-	}
366
-
367
-	/**
368
-	 * @param string $path
369
-	 * @return bool|mixed
370
-	 */
371
-	public function is_dir($path) {
372
-		if ($path == '/') {
373
-			return true;
374
-		}
375
-		return $this->basicOperation('is_dir', $path);
376
-	}
377
-
378
-	/**
379
-	 * @param string $path
380
-	 * @return bool|mixed
381
-	 */
382
-	public function is_file($path) {
383
-		if ($path == '/') {
384
-			return false;
385
-		}
386
-		return $this->basicOperation('is_file', $path);
387
-	}
388
-
389
-	/**
390
-	 * @param string $path
391
-	 * @return mixed
392
-	 */
393
-	public function stat($path) {
394
-		return $this->basicOperation('stat', $path);
395
-	}
396
-
397
-	/**
398
-	 * @param string $path
399
-	 * @return mixed
400
-	 */
401
-	public function filetype($path) {
402
-		return $this->basicOperation('filetype', $path);
403
-	}
404
-
405
-	/**
406
-	 * @param string $path
407
-	 * @return mixed
408
-	 */
409
-	public function filesize($path) {
410
-		return $this->basicOperation('filesize', $path);
411
-	}
412
-
413
-	/**
414
-	 * @param string $path
415
-	 * @return bool|mixed
416
-	 * @throws \OCP\Files\InvalidPathException
417
-	 */
418
-	public function readfile($path) {
419
-		$this->assertPathLength($path);
420
-		@ob_end_clean();
421
-		$handle = $this->fopen($path, 'rb');
422
-		if ($handle) {
423
-			$chunkSize = 8192; // 8 kB chunks
424
-			while (!feof($handle)) {
425
-				echo fread($handle, $chunkSize);
426
-				flush();
427
-			}
428
-			fclose($handle);
429
-			$size = $this->filesize($path);
430
-			return $size;
431
-		}
432
-		return false;
433
-	}
434
-
435
-	/**
436
-	 * @param string $path
437
-	 * @param int $from
438
-	 * @param int $to
439
-	 * @return bool|mixed
440
-	 * @throws \OCP\Files\InvalidPathException
441
-	 * @throws \OCP\Files\UnseekableException
442
-	 */
443
-	public function readfilePart($path, $from, $to) {
444
-		$this->assertPathLength($path);
445
-		@ob_end_clean();
446
-		$handle = $this->fopen($path, 'rb');
447
-		if ($handle) {
448
-			$chunkSize = 8192; // 8 kB chunks
449
-			$startReading = true;
450
-
451
-			if ($from !== 0 && $from !== '0' && fseek($handle, $from) !== 0) {
452
-				// forward file handle via chunked fread because fseek seem to have failed
453
-
454
-				$end = $from + 1;
455
-				while (!feof($handle) && ftell($handle) < $end) {
456
-					$len = $from - ftell($handle);
457
-					if ($len > $chunkSize) {
458
-						$len = $chunkSize;
459
-					}
460
-					$result = fread($handle, $len);
461
-
462
-					if ($result === false) {
463
-						$startReading = false;
464
-						break;
465
-					}
466
-				}
467
-			}
468
-
469
-			if ($startReading) {
470
-				$end = $to + 1;
471
-				while (!feof($handle) && ftell($handle) < $end) {
472
-					$len = $end - ftell($handle);
473
-					if ($len > $chunkSize) {
474
-						$len = $chunkSize;
475
-					}
476
-					echo fread($handle, $len);
477
-					flush();
478
-				}
479
-				$size = ftell($handle) - $from;
480
-				return $size;
481
-			}
482
-
483
-			throw new \OCP\Files\UnseekableException('fseek error');
484
-		}
485
-		return false;
486
-	}
487
-
488
-	/**
489
-	 * @param string $path
490
-	 * @return mixed
491
-	 */
492
-	public function isCreatable($path) {
493
-		return $this->basicOperation('isCreatable', $path);
494
-	}
495
-
496
-	/**
497
-	 * @param string $path
498
-	 * @return mixed
499
-	 */
500
-	public function isReadable($path) {
501
-		return $this->basicOperation('isReadable', $path);
502
-	}
503
-
504
-	/**
505
-	 * @param string $path
506
-	 * @return mixed
507
-	 */
508
-	public function isUpdatable($path) {
509
-		return $this->basicOperation('isUpdatable', $path);
510
-	}
511
-
512
-	/**
513
-	 * @param string $path
514
-	 * @return bool|mixed
515
-	 */
516
-	public function isDeletable($path) {
517
-		$absolutePath = $this->getAbsolutePath($path);
518
-		$mount = Filesystem::getMountManager()->find($absolutePath);
519
-		if ($mount->getInternalPath($absolutePath) === '') {
520
-			return $mount instanceof MoveableMount;
521
-		}
522
-		return $this->basicOperation('isDeletable', $path);
523
-	}
524
-
525
-	/**
526
-	 * @param string $path
527
-	 * @return mixed
528
-	 */
529
-	public function isSharable($path) {
530
-		return $this->basicOperation('isSharable', $path);
531
-	}
532
-
533
-	/**
534
-	 * @param string $path
535
-	 * @return bool|mixed
536
-	 */
537
-	public function file_exists($path) {
538
-		if ($path == '/') {
539
-			return true;
540
-		}
541
-		return $this->basicOperation('file_exists', $path);
542
-	}
543
-
544
-	/**
545
-	 * @param string $path
546
-	 * @return mixed
547
-	 */
548
-	public function filemtime($path) {
549
-		return $this->basicOperation('filemtime', $path);
550
-	}
551
-
552
-	/**
553
-	 * @param string $path
554
-	 * @param int|string $mtime
555
-	 * @return bool
556
-	 */
557
-	public function touch($path, $mtime = null) {
558
-		if (!is_null($mtime) and !is_numeric($mtime)) {
559
-			$mtime = strtotime($mtime);
560
-		}
561
-
562
-		$hooks = array('touch');
563
-
564
-		if (!$this->file_exists($path)) {
565
-			$hooks[] = 'create';
566
-			$hooks[] = 'write';
567
-		}
568
-		$result = $this->basicOperation('touch', $path, $hooks, $mtime);
569
-		if (!$result) {
570
-			// If create file fails because of permissions on external storage like SMB folders,
571
-			// check file exists and return false if not.
572
-			if (!$this->file_exists($path)) {
573
-				return false;
574
-			}
575
-			if (is_null($mtime)) {
576
-				$mtime = time();
577
-			}
578
-			//if native touch fails, we emulate it by changing the mtime in the cache
579
-			$this->putFileInfo($path, array('mtime' => floor($mtime)));
580
-		}
581
-		return true;
582
-	}
583
-
584
-	/**
585
-	 * @param string $path
586
-	 * @return mixed
587
-	 */
588
-	public function file_get_contents($path) {
589
-		return $this->basicOperation('file_get_contents', $path, array('read'));
590
-	}
591
-
592
-	/**
593
-	 * @param bool $exists
594
-	 * @param string $path
595
-	 * @param bool $run
596
-	 */
597
-	protected function emit_file_hooks_pre($exists, $path, &$run) {
598
-		if (!$exists) {
599
-			\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, array(
600
-				Filesystem::signal_param_path => $this->getHookPath($path),
601
-				Filesystem::signal_param_run => &$run,
602
-			));
603
-		} else {
604
-			\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, array(
605
-				Filesystem::signal_param_path => $this->getHookPath($path),
606
-				Filesystem::signal_param_run => &$run,
607
-			));
608
-		}
609
-		\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, array(
610
-			Filesystem::signal_param_path => $this->getHookPath($path),
611
-			Filesystem::signal_param_run => &$run,
612
-		));
613
-	}
614
-
615
-	/**
616
-	 * @param bool $exists
617
-	 * @param string $path
618
-	 */
619
-	protected function emit_file_hooks_post($exists, $path) {
620
-		if (!$exists) {
621
-			\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, array(
622
-				Filesystem::signal_param_path => $this->getHookPath($path),
623
-			));
624
-		} else {
625
-			\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_update, array(
626
-				Filesystem::signal_param_path => $this->getHookPath($path),
627
-			));
628
-		}
629
-		\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_write, array(
630
-			Filesystem::signal_param_path => $this->getHookPath($path),
631
-		));
632
-	}
633
-
634
-	/**
635
-	 * @param string $path
636
-	 * @param mixed $data
637
-	 * @return bool|mixed
638
-	 * @throws \Exception
639
-	 */
640
-	public function file_put_contents($path, $data) {
641
-		if (is_resource($data)) { //not having to deal with streams in file_put_contents makes life easier
642
-			$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
643
-			if (Filesystem::isValidPath($path)
644
-				and !Filesystem::isFileBlacklisted($path)
645
-			) {
646
-				$path = $this->getRelativePath($absolutePath);
647
-
648
-				$this->lockFile($path, ILockingProvider::LOCK_SHARED);
649
-
650
-				$exists = $this->file_exists($path);
651
-				$run = true;
652
-				if ($this->shouldEmitHooks($path)) {
653
-					$this->emit_file_hooks_pre($exists, $path, $run);
654
-				}
655
-				if (!$run) {
656
-					$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
657
-					return false;
658
-				}
659
-
660
-				$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
661
-
662
-				/** @var \OC\Files\Storage\Storage $storage */
663
-				list($storage, $internalPath) = $this->resolvePath($path);
664
-				$target = $storage->fopen($internalPath, 'w');
665
-				if ($target) {
666
-					list (, $result) = \OC_Helper::streamCopy($data, $target);
667
-					fclose($target);
668
-					fclose($data);
669
-
670
-					$this->writeUpdate($storage, $internalPath);
671
-
672
-					$this->changeLock($path, ILockingProvider::LOCK_SHARED);
673
-
674
-					if ($this->shouldEmitHooks($path) && $result !== false) {
675
-						$this->emit_file_hooks_post($exists, $path);
676
-					}
677
-					$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
678
-					return $result;
679
-				} else {
680
-					$this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
681
-					return false;
682
-				}
683
-			} else {
684
-				return false;
685
-			}
686
-		} else {
687
-			$hooks = ($this->file_exists($path)) ? array('update', 'write') : array('create', 'write');
688
-			return $this->basicOperation('file_put_contents', $path, $hooks, $data);
689
-		}
690
-	}
691
-
692
-	/**
693
-	 * @param string $path
694
-	 * @return bool|mixed
695
-	 */
696
-	public function unlink($path) {
697
-		if ($path === '' || $path === '/') {
698
-			// do not allow deleting the root
699
-			return false;
700
-		}
701
-		$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
702
-		$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
703
-		$mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
704
-		if ($mount and $mount->getInternalPath($absolutePath) === '') {
705
-			return $this->removeMount($mount, $absolutePath);
706
-		}
707
-		if ($this->is_dir($path)) {
708
-			$result = $this->basicOperation('rmdir', $path, ['delete']);
709
-		} else {
710
-			$result = $this->basicOperation('unlink', $path, ['delete']);
711
-		}
712
-		if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
713
-			$storage = $mount->getStorage();
714
-			$internalPath = $mount->getInternalPath($absolutePath);
715
-			$storage->getUpdater()->remove($internalPath);
716
-			return true;
717
-		} else {
718
-			return $result;
719
-		}
720
-	}
721
-
722
-	/**
723
-	 * @param string $directory
724
-	 * @return bool|mixed
725
-	 */
726
-	public function deleteAll($directory) {
727
-		return $this->rmdir($directory);
728
-	}
729
-
730
-	/**
731
-	 * Rename/move a file or folder from the source path to target path.
732
-	 *
733
-	 * @param string $path1 source path
734
-	 * @param string $path2 target path
735
-	 *
736
-	 * @return bool|mixed
737
-	 */
738
-	public function rename($path1, $path2) {
739
-		$absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
740
-		$absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
741
-		$result = false;
742
-		if (
743
-			Filesystem::isValidPath($path2)
744
-			and Filesystem::isValidPath($path1)
745
-			and !Filesystem::isFileBlacklisted($path2)
746
-		) {
747
-			$path1 = $this->getRelativePath($absolutePath1);
748
-			$path2 = $this->getRelativePath($absolutePath2);
749
-			$exists = $this->file_exists($path2);
750
-
751
-			if ($path1 == null or $path2 == null) {
752
-				return false;
753
-			}
754
-
755
-			$this->lockFile($path1, ILockingProvider::LOCK_SHARED, true);
756
-			try {
757
-				$this->lockFile($path2, ILockingProvider::LOCK_SHARED, true);
758
-
759
-				$run = true;
760
-				if ($this->shouldEmitHooks($path1) && (Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2))) {
761
-					// if it was a rename from a part file to a regular file it was a write and not a rename operation
762
-					$this->emit_file_hooks_pre($exists, $path2, $run);
763
-				} elseif ($this->shouldEmitHooks($path1)) {
764
-					\OC_Hook::emit(
765
-						Filesystem::CLASSNAME, Filesystem::signal_rename,
766
-						array(
767
-							Filesystem::signal_param_oldpath => $this->getHookPath($path1),
768
-							Filesystem::signal_param_newpath => $this->getHookPath($path2),
769
-							Filesystem::signal_param_run => &$run
770
-						)
771
-					);
772
-				}
773
-				if ($run) {
774
-					$this->verifyPath(dirname($path2), basename($path2));
775
-
776
-					$manager = Filesystem::getMountManager();
777
-					$mount1 = $this->getMount($path1);
778
-					$mount2 = $this->getMount($path2);
779
-					$storage1 = $mount1->getStorage();
780
-					$storage2 = $mount2->getStorage();
781
-					$internalPath1 = $mount1->getInternalPath($absolutePath1);
782
-					$internalPath2 = $mount2->getInternalPath($absolutePath2);
783
-
784
-					$this->changeLock($path1, ILockingProvider::LOCK_EXCLUSIVE, true);
785
-					try {
786
-						$this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE, true);
787
-
788
-						if ($internalPath1 === '') {
789
-							if ($mount1 instanceof MoveableMount) {
790
-								if ($this->isTargetAllowed($absolutePath2)) {
791
-									/**
792
-									 * @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount1
793
-									 */
794
-									$sourceMountPoint = $mount1->getMountPoint();
795
-									$result = $mount1->moveMount($absolutePath2);
796
-									$manager->moveMount($sourceMountPoint, $mount1->getMountPoint());
797
-								} else {
798
-									$result = false;
799
-								}
800
-							} else {
801
-								$result = false;
802
-							}
803
-							// moving a file/folder within the same mount point
804
-						} elseif ($storage1 === $storage2) {
805
-							if ($storage1) {
806
-								$result = $storage1->rename($internalPath1, $internalPath2);
807
-							} else {
808
-								$result = false;
809
-							}
810
-							// moving a file/folder between storages (from $storage1 to $storage2)
811
-						} else {
812
-							$result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
813
-						}
814
-
815
-						if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
816
-							// if it was a rename from a part file to a regular file it was a write and not a rename operation
817
-							$this->writeUpdate($storage2, $internalPath2);
818
-						} else if ($result) {
819
-							if ($internalPath1 !== '') { // don't do a cache update for moved mounts
820
-								$this->renameUpdate($storage1, $storage2, $internalPath1, $internalPath2);
821
-							}
822
-						}
823
-					} catch(\Exception $e) {
824
-						throw $e;
825
-					} finally {
826
-						$this->changeLock($path1, ILockingProvider::LOCK_SHARED, true);
827
-						$this->changeLock($path2, ILockingProvider::LOCK_SHARED, true);
828
-					}
829
-
830
-					if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
831
-						if ($this->shouldEmitHooks()) {
832
-							$this->emit_file_hooks_post($exists, $path2);
833
-						}
834
-					} elseif ($result) {
835
-						if ($this->shouldEmitHooks($path1) and $this->shouldEmitHooks($path2)) {
836
-							\OC_Hook::emit(
837
-								Filesystem::CLASSNAME,
838
-								Filesystem::signal_post_rename,
839
-								array(
840
-									Filesystem::signal_param_oldpath => $this->getHookPath($path1),
841
-									Filesystem::signal_param_newpath => $this->getHookPath($path2)
842
-								)
843
-							);
844
-						}
845
-					}
846
-				}
847
-			} catch(\Exception $e) {
848
-				throw $e;
849
-			} finally {
850
-				$this->unlockFile($path1, ILockingProvider::LOCK_SHARED, true);
851
-				$this->unlockFile($path2, ILockingProvider::LOCK_SHARED, true);
852
-			}
853
-		}
854
-		return $result;
855
-	}
856
-
857
-	/**
858
-	 * Copy a file/folder from the source path to target path
859
-	 *
860
-	 * @param string $path1 source path
861
-	 * @param string $path2 target path
862
-	 * @param bool $preserveMtime whether to preserve mtime on the copy
863
-	 *
864
-	 * @return bool|mixed
865
-	 */
866
-	public function copy($path1, $path2, $preserveMtime = false) {
867
-		$absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
868
-		$absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
869
-		$result = false;
870
-		if (
871
-			Filesystem::isValidPath($path2)
872
-			and Filesystem::isValidPath($path1)
873
-			and !Filesystem::isFileBlacklisted($path2)
874
-		) {
875
-			$path1 = $this->getRelativePath($absolutePath1);
876
-			$path2 = $this->getRelativePath($absolutePath2);
877
-
878
-			if ($path1 == null or $path2 == null) {
879
-				return false;
880
-			}
881
-			$run = true;
882
-
883
-			$this->lockFile($path2, ILockingProvider::LOCK_SHARED);
884
-			$this->lockFile($path1, ILockingProvider::LOCK_SHARED);
885
-			$lockTypePath1 = ILockingProvider::LOCK_SHARED;
886
-			$lockTypePath2 = ILockingProvider::LOCK_SHARED;
887
-
888
-			try {
889
-
890
-				$exists = $this->file_exists($path2);
891
-				if ($this->shouldEmitHooks()) {
892
-					\OC_Hook::emit(
893
-						Filesystem::CLASSNAME,
894
-						Filesystem::signal_copy,
895
-						array(
896
-							Filesystem::signal_param_oldpath => $this->getHookPath($path1),
897
-							Filesystem::signal_param_newpath => $this->getHookPath($path2),
898
-							Filesystem::signal_param_run => &$run
899
-						)
900
-					);
901
-					$this->emit_file_hooks_pre($exists, $path2, $run);
902
-				}
903
-				if ($run) {
904
-					$mount1 = $this->getMount($path1);
905
-					$mount2 = $this->getMount($path2);
906
-					$storage1 = $mount1->getStorage();
907
-					$internalPath1 = $mount1->getInternalPath($absolutePath1);
908
-					$storage2 = $mount2->getStorage();
909
-					$internalPath2 = $mount2->getInternalPath($absolutePath2);
910
-
911
-					$this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE);
912
-					$lockTypePath2 = ILockingProvider::LOCK_EXCLUSIVE;
913
-
914
-					if ($mount1->getMountPoint() == $mount2->getMountPoint()) {
915
-						if ($storage1) {
916
-							$result = $storage1->copy($internalPath1, $internalPath2);
917
-						} else {
918
-							$result = false;
919
-						}
920
-					} else {
921
-						$result = $storage2->copyFromStorage($storage1, $internalPath1, $internalPath2);
922
-					}
923
-
924
-					$this->writeUpdate($storage2, $internalPath2);
925
-
926
-					$this->changeLock($path2, ILockingProvider::LOCK_SHARED);
927
-					$lockTypePath2 = ILockingProvider::LOCK_SHARED;
928
-
929
-					if ($this->shouldEmitHooks() && $result !== false) {
930
-						\OC_Hook::emit(
931
-							Filesystem::CLASSNAME,
932
-							Filesystem::signal_post_copy,
933
-							array(
934
-								Filesystem::signal_param_oldpath => $this->getHookPath($path1),
935
-								Filesystem::signal_param_newpath => $this->getHookPath($path2)
936
-							)
937
-						);
938
-						$this->emit_file_hooks_post($exists, $path2);
939
-					}
940
-
941
-				}
942
-			} catch (\Exception $e) {
943
-				$this->unlockFile($path2, $lockTypePath2);
944
-				$this->unlockFile($path1, $lockTypePath1);
945
-				throw $e;
946
-			}
947
-
948
-			$this->unlockFile($path2, $lockTypePath2);
949
-			$this->unlockFile($path1, $lockTypePath1);
950
-
951
-		}
952
-		return $result;
953
-	}
954
-
955
-	/**
956
-	 * @param string $path
957
-	 * @param string $mode 'r' or 'w'
958
-	 * @return resource
959
-	 */
960
-	public function fopen($path, $mode) {
961
-		$mode = str_replace('b', '', $mode); // the binary flag is a windows only feature which we do not support
962
-		$hooks = array();
963
-		switch ($mode) {
964
-			case 'r':
965
-				$hooks[] = 'read';
966
-				break;
967
-			case 'r+':
968
-			case 'w+':
969
-			case 'x+':
970
-			case 'a+':
971
-				$hooks[] = 'read';
972
-				$hooks[] = 'write';
973
-				break;
974
-			case 'w':
975
-			case 'x':
976
-			case 'a':
977
-				$hooks[] = 'write';
978
-				break;
979
-			default:
980
-				\OCP\Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, \OCP\Util::ERROR);
981
-		}
982
-
983
-		if ($mode !== 'r' && $mode !== 'w') {
984
-			\OC::$server->getLogger()->info('Trying to open a file with a mode other than "r" or "w" can cause severe performance issues with some backends');
985
-		}
986
-
987
-		return $this->basicOperation('fopen', $path, $hooks, $mode);
988
-	}
989
-
990
-	/**
991
-	 * @param string $path
992
-	 * @return bool|string
993
-	 * @throws \OCP\Files\InvalidPathException
994
-	 */
995
-	public function toTmpFile($path) {
996
-		$this->assertPathLength($path);
997
-		if (Filesystem::isValidPath($path)) {
998
-			$source = $this->fopen($path, 'r');
999
-			if ($source) {
1000
-				$extension = pathinfo($path, PATHINFO_EXTENSION);
1001
-				$tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension);
1002
-				file_put_contents($tmpFile, $source);
1003
-				return $tmpFile;
1004
-			} else {
1005
-				return false;
1006
-			}
1007
-		} else {
1008
-			return false;
1009
-		}
1010
-	}
1011
-
1012
-	/**
1013
-	 * @param string $tmpFile
1014
-	 * @param string $path
1015
-	 * @return bool|mixed
1016
-	 * @throws \OCP\Files\InvalidPathException
1017
-	 */
1018
-	public function fromTmpFile($tmpFile, $path) {
1019
-		$this->assertPathLength($path);
1020
-		if (Filesystem::isValidPath($path)) {
1021
-
1022
-			// Get directory that the file is going into
1023
-			$filePath = dirname($path);
1024
-
1025
-			// Create the directories if any
1026
-			if (!$this->file_exists($filePath)) {
1027
-				$result = $this->createParentDirectories($filePath);
1028
-				if ($result === false) {
1029
-					return false;
1030
-				}
1031
-			}
1032
-
1033
-			$source = fopen($tmpFile, 'r');
1034
-			if ($source) {
1035
-				$result = $this->file_put_contents($path, $source);
1036
-				// $this->file_put_contents() might have already closed
1037
-				// the resource, so we check it, before trying to close it
1038
-				// to avoid messages in the error log.
1039
-				if (is_resource($source)) {
1040
-					fclose($source);
1041
-				}
1042
-				unlink($tmpFile);
1043
-				return $result;
1044
-			} else {
1045
-				return false;
1046
-			}
1047
-		} else {
1048
-			return false;
1049
-		}
1050
-	}
1051
-
1052
-
1053
-	/**
1054
-	 * @param string $path
1055
-	 * @return mixed
1056
-	 * @throws \OCP\Files\InvalidPathException
1057
-	 */
1058
-	public function getMimeType($path) {
1059
-		$this->assertPathLength($path);
1060
-		return $this->basicOperation('getMimeType', $path);
1061
-	}
1062
-
1063
-	/**
1064
-	 * @param string $type
1065
-	 * @param string $path
1066
-	 * @param bool $raw
1067
-	 * @return bool|null|string
1068
-	 */
1069
-	public function hash($type, $path, $raw = false) {
1070
-		$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
1071
-		$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
1072
-		if (Filesystem::isValidPath($path)) {
1073
-			$path = $this->getRelativePath($absolutePath);
1074
-			if ($path == null) {
1075
-				return false;
1076
-			}
1077
-			if ($this->shouldEmitHooks($path)) {
1078
-				\OC_Hook::emit(
1079
-					Filesystem::CLASSNAME,
1080
-					Filesystem::signal_read,
1081
-					array(Filesystem::signal_param_path => $this->getHookPath($path))
1082
-				);
1083
-			}
1084
-			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
1085
-			if ($storage) {
1086
-				$result = $storage->hash($type, $internalPath, $raw);
1087
-				return $result;
1088
-			}
1089
-		}
1090
-		return null;
1091
-	}
1092
-
1093
-	/**
1094
-	 * @param string $path
1095
-	 * @return mixed
1096
-	 * @throws \OCP\Files\InvalidPathException
1097
-	 */
1098
-	public function free_space($path = '/') {
1099
-		$this->assertPathLength($path);
1100
-		$result = $this->basicOperation('free_space', $path);
1101
-		if ($result === null) {
1102
-			throw new InvalidPathException();
1103
-		}
1104
-		return $result;
1105
-	}
1106
-
1107
-	/**
1108
-	 * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
1109
-	 *
1110
-	 * @param string $operation
1111
-	 * @param string $path
1112
-	 * @param array $hooks (optional)
1113
-	 * @param mixed $extraParam (optional)
1114
-	 * @return mixed
1115
-	 * @throws \Exception
1116
-	 *
1117
-	 * This method takes requests for basic filesystem functions (e.g. reading & writing
1118
-	 * files), processes hooks and proxies, sanitises paths, and finally passes them on to
1119
-	 * \OC\Files\Storage\Storage for delegation to a storage backend for execution
1120
-	 */
1121
-	private function basicOperation($operation, $path, $hooks = [], $extraParam = null) {
1122
-		$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
1123
-		$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
1124
-		if (Filesystem::isValidPath($path)
1125
-			and !Filesystem::isFileBlacklisted($path)
1126
-		) {
1127
-			$path = $this->getRelativePath($absolutePath);
1128
-			if ($path == null) {
1129
-				return false;
1130
-			}
1131
-
1132
-			if (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks)) {
1133
-				// always a shared lock during pre-hooks so the hook can read the file
1134
-				$this->lockFile($path, ILockingProvider::LOCK_SHARED);
1135
-			}
1136
-
1137
-			$run = $this->runHooks($hooks, $path);
1138
-			/** @var \OC\Files\Storage\Storage $storage */
1139
-			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
1140
-			if ($run and $storage) {
1141
-				if (in_array('write', $hooks) || in_array('delete', $hooks)) {
1142
-					$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
1143
-				}
1144
-				try {
1145
-					if (!is_null($extraParam)) {
1146
-						$result = $storage->$operation($internalPath, $extraParam);
1147
-					} else {
1148
-						$result = $storage->$operation($internalPath);
1149
-					}
1150
-				} catch (\Exception $e) {
1151
-					if (in_array('write', $hooks) || in_array('delete', $hooks)) {
1152
-						$this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
1153
-					} else if (in_array('read', $hooks)) {
1154
-						$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
1155
-					}
1156
-					throw $e;
1157
-				}
1158
-
1159
-				if ($result && in_array('delete', $hooks) and $result) {
1160
-					$this->removeUpdate($storage, $internalPath);
1161
-				}
1162
-				if ($result && in_array('write', $hooks) and $operation !== 'fopen') {
1163
-					$this->writeUpdate($storage, $internalPath);
1164
-				}
1165
-				if ($result && in_array('touch', $hooks)) {
1166
-					$this->writeUpdate($storage, $internalPath, $extraParam);
1167
-				}
1168
-
1169
-				if ((in_array('write', $hooks) || in_array('delete', $hooks)) && ($operation !== 'fopen' || $result === false)) {
1170
-					$this->changeLock($path, ILockingProvider::LOCK_SHARED);
1171
-				}
1172
-
1173
-				$unlockLater = false;
1174
-				if ($this->lockingEnabled && $operation === 'fopen' && is_resource($result)) {
1175
-					$unlockLater = true;
1176
-					// make sure our unlocking callback will still be called if connection is aborted
1177
-					ignore_user_abort(true);
1178
-					$result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) {
1179
-						if (in_array('write', $hooks)) {
1180
-							$this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
1181
-						} else if (in_array('read', $hooks)) {
1182
-							$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
1183
-						}
1184
-					});
1185
-				}
1186
-
1187
-				if ($this->shouldEmitHooks($path) && $result !== false) {
1188
-					if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open
1189
-						$this->runHooks($hooks, $path, true);
1190
-					}
1191
-				}
1192
-
1193
-				if (!$unlockLater
1194
-					&& (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks))
1195
-				) {
1196
-					$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
1197
-				}
1198
-				return $result;
1199
-			} else {
1200
-				$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
1201
-			}
1202
-		}
1203
-		return null;
1204
-	}
1205
-
1206
-	/**
1207
-	 * get the path relative to the default root for hook usage
1208
-	 *
1209
-	 * @param string $path
1210
-	 * @return string
1211
-	 */
1212
-	private function getHookPath($path) {
1213
-		if (!Filesystem::getView()) {
1214
-			return $path;
1215
-		}
1216
-		return Filesystem::getView()->getRelativePath($this->getAbsolutePath($path));
1217
-	}
1218
-
1219
-	private function shouldEmitHooks($path = '') {
1220
-		if ($path && Cache\Scanner::isPartialFile($path)) {
1221
-			return false;
1222
-		}
1223
-		if (!Filesystem::$loaded) {
1224
-			return false;
1225
-		}
1226
-		$defaultRoot = Filesystem::getRoot();
1227
-		if ($defaultRoot === null) {
1228
-			return false;
1229
-		}
1230
-		if ($this->fakeRoot === $defaultRoot) {
1231
-			return true;
1232
-		}
1233
-		$fullPath = $this->getAbsolutePath($path);
1234
-
1235
-		if ($fullPath === $defaultRoot) {
1236
-			return true;
1237
-		}
1238
-
1239
-		return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
1240
-	}
1241
-
1242
-	/**
1243
-	 * @param string[] $hooks
1244
-	 * @param string $path
1245
-	 * @param bool $post
1246
-	 * @return bool
1247
-	 */
1248
-	private function runHooks($hooks, $path, $post = false) {
1249
-		$relativePath = $path;
1250
-		$path = $this->getHookPath($path);
1251
-		$prefix = ($post) ? 'post_' : '';
1252
-		$run = true;
1253
-		if ($this->shouldEmitHooks($relativePath)) {
1254
-			foreach ($hooks as $hook) {
1255
-				if ($hook != 'read') {
1256
-					\OC_Hook::emit(
1257
-						Filesystem::CLASSNAME,
1258
-						$prefix . $hook,
1259
-						array(
1260
-							Filesystem::signal_param_run => &$run,
1261
-							Filesystem::signal_param_path => $path
1262
-						)
1263
-					);
1264
-				} elseif (!$post) {
1265
-					\OC_Hook::emit(
1266
-						Filesystem::CLASSNAME,
1267
-						$prefix . $hook,
1268
-						array(
1269
-							Filesystem::signal_param_path => $path
1270
-						)
1271
-					);
1272
-				}
1273
-			}
1274
-		}
1275
-		return $run;
1276
-	}
1277
-
1278
-	/**
1279
-	 * check if a file or folder has been updated since $time
1280
-	 *
1281
-	 * @param string $path
1282
-	 * @param int $time
1283
-	 * @return bool
1284
-	 */
1285
-	public function hasUpdated($path, $time) {
1286
-		return $this->basicOperation('hasUpdated', $path, array(), $time);
1287
-	}
1288
-
1289
-	/**
1290
-	 * @param string $ownerId
1291
-	 * @return \OC\User\User
1292
-	 */
1293
-	private function getUserObjectForOwner($ownerId) {
1294
-		$owner = $this->userManager->get($ownerId);
1295
-		if ($owner instanceof IUser) {
1296
-			return $owner;
1297
-		} else {
1298
-			return new User($ownerId, null);
1299
-		}
1300
-	}
1301
-
1302
-	/**
1303
-	 * Get file info from cache
1304
-	 *
1305
-	 * If the file is not in cached it will be scanned
1306
-	 * If the file has changed on storage the cache will be updated
1307
-	 *
1308
-	 * @param \OC\Files\Storage\Storage $storage
1309
-	 * @param string $internalPath
1310
-	 * @param string $relativePath
1311
-	 * @return ICacheEntry|bool
1312
-	 */
1313
-	private function getCacheEntry($storage, $internalPath, $relativePath) {
1314
-		$cache = $storage->getCache($internalPath);
1315
-		$data = $cache->get($internalPath);
1316
-		$watcher = $storage->getWatcher($internalPath);
1317
-
1318
-		try {
1319
-			// if the file is not in the cache or needs to be updated, trigger the scanner and reload the data
1320
-			if (!$data || $data['size'] === -1) {
1321
-				$this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
1322
-				if (!$storage->file_exists($internalPath)) {
1323
-					$this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
1324
-					return false;
1325
-				}
1326
-				$scanner = $storage->getScanner($internalPath);
1327
-				$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
1328
-				$data = $cache->get($internalPath);
1329
-				$this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
1330
-			} else if (!Cache\Scanner::isPartialFile($internalPath) && $watcher->needsUpdate($internalPath, $data)) {
1331
-				$this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
1332
-				$watcher->update($internalPath, $data);
1333
-				$storage->getPropagator()->propagateChange($internalPath, time());
1334
-				$data = $cache->get($internalPath);
1335
-				$this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
1336
-			}
1337
-		} catch (LockedException $e) {
1338
-			// if the file is locked we just use the old cache info
1339
-		}
1340
-
1341
-		return $data;
1342
-	}
1343
-
1344
-	/**
1345
-	 * get the filesystem info
1346
-	 *
1347
-	 * @param string $path
1348
-	 * @param boolean|string $includeMountPoints true to add mountpoint sizes,
1349
-	 * 'ext' to add only ext storage mount point sizes. Defaults to true.
1350
-	 * defaults to true
1351
-	 * @return \OC\Files\FileInfo|false False if file does not exist
1352
-	 */
1353
-	public function getFileInfo($path, $includeMountPoints = true) {
1354
-		$this->assertPathLength($path);
1355
-		if (!Filesystem::isValidPath($path)) {
1356
-			return false;
1357
-		}
1358
-		if (Cache\Scanner::isPartialFile($path)) {
1359
-			return $this->getPartFileInfo($path);
1360
-		}
1361
-		$relativePath = $path;
1362
-		$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
1363
-
1364
-		$mount = Filesystem::getMountManager()->find($path);
1365
-		if (!$mount) {
1366
-			return false;
1367
-		}
1368
-		$storage = $mount->getStorage();
1369
-		$internalPath = $mount->getInternalPath($path);
1370
-		if ($storage) {
1371
-			$data = $this->getCacheEntry($storage, $internalPath, $relativePath);
1372
-
1373
-			if (!$data instanceof ICacheEntry) {
1374
-				return false;
1375
-			}
1376
-
1377
-			if ($mount instanceof MoveableMount && $internalPath === '') {
1378
-				$data['permissions'] |= \OCP\Constants::PERMISSION_DELETE;
1379
-			}
1380
-
1381
-			$owner = $this->getUserObjectForOwner($storage->getOwner($internalPath));
1382
-			$info = new FileInfo($path, $storage, $internalPath, $data, $mount, $owner);
1383
-
1384
-			if ($data and isset($data['fileid'])) {
1385
-				if ($includeMountPoints and $data['mimetype'] === 'httpd/unix-directory') {
1386
-					//add the sizes of other mount points to the folder
1387
-					$extOnly = ($includeMountPoints === 'ext');
1388
-					$mounts = Filesystem::getMountManager()->findIn($path);
1389
-					$info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) {
1390
-						$subStorage = $mount->getStorage();
1391
-						return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage);
1392
-					}));
1393
-				}
1394
-			}
1395
-
1396
-			return $info;
1397
-		}
1398
-
1399
-		return false;
1400
-	}
1401
-
1402
-	/**
1403
-	 * get the content of a directory
1404
-	 *
1405
-	 * @param string $directory path under datadirectory
1406
-	 * @param string $mimetype_filter limit returned content to this mimetype or mimepart
1407
-	 * @return FileInfo[]
1408
-	 */
1409
-	public function getDirectoryContent($directory, $mimetype_filter = '') {
1410
-		$this->assertPathLength($directory);
1411
-		if (!Filesystem::isValidPath($directory)) {
1412
-			return [];
1413
-		}
1414
-		$path = $this->getAbsolutePath($directory);
1415
-		$path = Filesystem::normalizePath($path);
1416
-		$mount = $this->getMount($directory);
1417
-		if (!$mount) {
1418
-			return [];
1419
-		}
1420
-		$storage = $mount->getStorage();
1421
-		$internalPath = $mount->getInternalPath($path);
1422
-		if ($storage) {
1423
-			$cache = $storage->getCache($internalPath);
1424
-			$user = \OC_User::getUser();
1425
-
1426
-			$data = $this->getCacheEntry($storage, $internalPath, $directory);
1427
-
1428
-			if (!$data instanceof ICacheEntry || !isset($data['fileid']) || !($data->getPermissions() && Constants::PERMISSION_READ)) {
1429
-				return [];
1430
-			}
1431
-
1432
-			$folderId = $data['fileid'];
1433
-			$contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
1434
-
1435
-			$sharingDisabled = \OCP\Util::isSharingDisabledForUser();
1436
-			/**
1437
-			 * @var \OC\Files\FileInfo[] $files
1438
-			 */
1439
-			$files = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
1440
-				if ($sharingDisabled) {
1441
-					$content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
1442
-				}
1443
-				$owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
1444
-				return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
1445
-			}, $contents);
1446
-
1447
-			//add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
1448
-			$mounts = Filesystem::getMountManager()->findIn($path);
1449
-			$dirLength = strlen($path);
1450
-			foreach ($mounts as $mount) {
1451
-				$mountPoint = $mount->getMountPoint();
1452
-				$subStorage = $mount->getStorage();
1453
-				if ($subStorage) {
1454
-					$subCache = $subStorage->getCache('');
1455
-
1456
-					$rootEntry = $subCache->get('');
1457
-					if (!$rootEntry) {
1458
-						$subScanner = $subStorage->getScanner('');
1459
-						try {
1460
-							$subScanner->scanFile('');
1461
-						} catch (\OCP\Files\StorageNotAvailableException $e) {
1462
-							continue;
1463
-						} catch (\OCP\Files\StorageInvalidException $e) {
1464
-							continue;
1465
-						} catch (\Exception $e) {
1466
-							// sometimes when the storage is not available it can be any exception
1467
-							\OCP\Util::writeLog(
1468
-								'core',
1469
-								'Exception while scanning storage "' . $subStorage->getId() . '": ' .
1470
-								get_class($e) . ': ' . $e->getMessage(),
1471
-								\OCP\Util::ERROR
1472
-							);
1473
-							continue;
1474
-						}
1475
-						$rootEntry = $subCache->get('');
1476
-					}
1477
-
1478
-					if ($rootEntry && ($rootEntry->getPermissions() && Constants::PERMISSION_READ)) {
1479
-						$relativePath = trim(substr($mountPoint, $dirLength), '/');
1480
-						if ($pos = strpos($relativePath, '/')) {
1481
-							//mountpoint inside subfolder add size to the correct folder
1482
-							$entryName = substr($relativePath, 0, $pos);
1483
-							foreach ($files as &$entry) {
1484
-								if ($entry->getName() === $entryName) {
1485
-									$entry->addSubEntry($rootEntry, $mountPoint);
1486
-								}
1487
-							}
1488
-						} else { //mountpoint in this folder, add an entry for it
1489
-							$rootEntry['name'] = $relativePath;
1490
-							$rootEntry['type'] = $rootEntry['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file';
1491
-							$permissions = $rootEntry['permissions'];
1492
-							// do not allow renaming/deleting the mount point if they are not shared files/folders
1493
-							// for shared files/folders we use the permissions given by the owner
1494
-							if ($mount instanceof MoveableMount) {
1495
-								$rootEntry['permissions'] = $permissions | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE;
1496
-							} else {
1497
-								$rootEntry['permissions'] = $permissions & (\OCP\Constants::PERMISSION_ALL - (\OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE));
1498
-							}
1499
-
1500
-							//remove any existing entry with the same name
1501
-							foreach ($files as $i => $file) {
1502
-								if ($file['name'] === $rootEntry['name']) {
1503
-									unset($files[$i]);
1504
-									break;
1505
-								}
1506
-							}
1507
-							$rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
1508
-
1509
-							// if sharing was disabled for the user we remove the share permissions
1510
-							if (\OCP\Util::isSharingDisabledForUser()) {
1511
-								$rootEntry['permissions'] = $rootEntry['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
1512
-							}
1513
-
1514
-							$owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
1515
-							$files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
1516
-						}
1517
-					}
1518
-				}
1519
-			}
1520
-
1521
-			if ($mimetype_filter) {
1522
-				$files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) {
1523
-					if (strpos($mimetype_filter, '/')) {
1524
-						return $file->getMimetype() === $mimetype_filter;
1525
-					} else {
1526
-						return $file->getMimePart() === $mimetype_filter;
1527
-					}
1528
-				});
1529
-			}
1530
-
1531
-			return $files;
1532
-		} else {
1533
-			return [];
1534
-		}
1535
-	}
1536
-
1537
-	/**
1538
-	 * change file metadata
1539
-	 *
1540
-	 * @param string $path
1541
-	 * @param array|\OCP\Files\FileInfo $data
1542
-	 * @return int
1543
-	 *
1544
-	 * returns the fileid of the updated file
1545
-	 */
1546
-	public function putFileInfo($path, $data) {
1547
-		$this->assertPathLength($path);
1548
-		if ($data instanceof FileInfo) {
1549
-			$data = $data->getData();
1550
-		}
1551
-		$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
1552
-		/**
1553
-		 * @var \OC\Files\Storage\Storage $storage
1554
-		 * @var string $internalPath
1555
-		 */
1556
-		list($storage, $internalPath) = Filesystem::resolvePath($path);
1557
-		if ($storage) {
1558
-			$cache = $storage->getCache($path);
1559
-
1560
-			if (!$cache->inCache($internalPath)) {
1561
-				$scanner = $storage->getScanner($internalPath);
1562
-				$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
1563
-			}
1564
-
1565
-			return $cache->put($internalPath, $data);
1566
-		} else {
1567
-			return -1;
1568
-		}
1569
-	}
1570
-
1571
-	/**
1572
-	 * search for files with the name matching $query
1573
-	 *
1574
-	 * @param string $query
1575
-	 * @return FileInfo[]
1576
-	 */
1577
-	public function search($query) {
1578
-		return $this->searchCommon('search', array('%' . $query . '%'));
1579
-	}
1580
-
1581
-	/**
1582
-	 * search for files with the name matching $query
1583
-	 *
1584
-	 * @param string $query
1585
-	 * @return FileInfo[]
1586
-	 */
1587
-	public function searchRaw($query) {
1588
-		return $this->searchCommon('search', array($query));
1589
-	}
1590
-
1591
-	/**
1592
-	 * search for files by mimetype
1593
-	 *
1594
-	 * @param string $mimetype
1595
-	 * @return FileInfo[]
1596
-	 */
1597
-	public function searchByMime($mimetype) {
1598
-		return $this->searchCommon('searchByMime', array($mimetype));
1599
-	}
1600
-
1601
-	/**
1602
-	 * search for files by tag
1603
-	 *
1604
-	 * @param string|int $tag name or tag id
1605
-	 * @param string $userId owner of the tags
1606
-	 * @return FileInfo[]
1607
-	 */
1608
-	public function searchByTag($tag, $userId) {
1609
-		return $this->searchCommon('searchByTag', array($tag, $userId));
1610
-	}
1611
-
1612
-	/**
1613
-	 * @param string $method cache method
1614
-	 * @param array $args
1615
-	 * @return FileInfo[]
1616
-	 */
1617
-	private function searchCommon($method, $args) {
1618
-		$files = array();
1619
-		$rootLength = strlen($this->fakeRoot);
1620
-
1621
-		$mount = $this->getMount('');
1622
-		$mountPoint = $mount->getMountPoint();
1623
-		$storage = $mount->getStorage();
1624
-		if ($storage) {
1625
-			$cache = $storage->getCache('');
1626
-
1627
-			$results = call_user_func_array(array($cache, $method), $args);
1628
-			foreach ($results as $result) {
1629
-				if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
1630
-					$internalPath = $result['path'];
1631
-					$path = $mountPoint . $result['path'];
1632
-					$result['path'] = substr($mountPoint . $result['path'], $rootLength);
1633
-					$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
1634
-					$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
1635
-				}
1636
-			}
1637
-
1638
-			$mounts = Filesystem::getMountManager()->findIn($this->fakeRoot);
1639
-			foreach ($mounts as $mount) {
1640
-				$mountPoint = $mount->getMountPoint();
1641
-				$storage = $mount->getStorage();
1642
-				if ($storage) {
1643
-					$cache = $storage->getCache('');
1644
-
1645
-					$relativeMountPoint = substr($mountPoint, $rootLength);
1646
-					$results = call_user_func_array(array($cache, $method), $args);
1647
-					if ($results) {
1648
-						foreach ($results as $result) {
1649
-							$internalPath = $result['path'];
1650
-							$result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
1651
-							$path = rtrim($mountPoint . $internalPath, '/');
1652
-							$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
1653
-							$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
1654
-						}
1655
-					}
1656
-				}
1657
-			}
1658
-		}
1659
-		return $files;
1660
-	}
1661
-
1662
-	/**
1663
-	 * Get the owner for a file or folder
1664
-	 *
1665
-	 * @param string $path
1666
-	 * @return string the user id of the owner
1667
-	 * @throws NotFoundException
1668
-	 */
1669
-	public function getOwner($path) {
1670
-		$info = $this->getFileInfo($path);
1671
-		if (!$info) {
1672
-			throw new NotFoundException($path . ' not found while trying to get owner');
1673
-		}
1674
-		return $info->getOwner()->getUID();
1675
-	}
1676
-
1677
-	/**
1678
-	 * get the ETag for a file or folder
1679
-	 *
1680
-	 * @param string $path
1681
-	 * @return string
1682
-	 */
1683
-	public function getETag($path) {
1684
-		/**
1685
-		 * @var Storage\Storage $storage
1686
-		 * @var string $internalPath
1687
-		 */
1688
-		list($storage, $internalPath) = $this->resolvePath($path);
1689
-		if ($storage) {
1690
-			return $storage->getETag($internalPath);
1691
-		} else {
1692
-			return null;
1693
-		}
1694
-	}
1695
-
1696
-	/**
1697
-	 * Get the path of a file by id, relative to the view
1698
-	 *
1699
-	 * Note that the resulting path is not guarantied to be unique for the id, multiple paths can point to the same file
1700
-	 *
1701
-	 * @param int $id
1702
-	 * @throws NotFoundException
1703
-	 * @return string
1704
-	 */
1705
-	public function getPath($id) {
1706
-		$id = (int)$id;
1707
-		$manager = Filesystem::getMountManager();
1708
-		$mounts = $manager->findIn($this->fakeRoot);
1709
-		$mounts[] = $manager->find($this->fakeRoot);
1710
-		// reverse the array so we start with the storage this view is in
1711
-		// which is the most likely to contain the file we're looking for
1712
-		$mounts = array_reverse($mounts);
1713
-		foreach ($mounts as $mount) {
1714
-			/**
1715
-			 * @var \OC\Files\Mount\MountPoint $mount
1716
-			 */
1717
-			if ($mount->getStorage()) {
1718
-				$cache = $mount->getStorage()->getCache();
1719
-				$internalPath = $cache->getPathById($id);
1720
-				if (is_string($internalPath)) {
1721
-					$fullPath = $mount->getMountPoint() . $internalPath;
1722
-					if (!is_null($path = $this->getRelativePath($fullPath))) {
1723
-						return $path;
1724
-					}
1725
-				}
1726
-			}
1727
-		}
1728
-		throw new NotFoundException(sprintf('File with id "%s" has not been found.', $id));
1729
-	}
1730
-
1731
-	/**
1732
-	 * @param string $path
1733
-	 * @throws InvalidPathException
1734
-	 */
1735
-	private function assertPathLength($path) {
1736
-		$maxLen = min(PHP_MAXPATHLEN, 4000);
1737
-		// Check for the string length - performed using isset() instead of strlen()
1738
-		// because isset() is about 5x-40x faster.
1739
-		if (isset($path[$maxLen])) {
1740
-			$pathLen = strlen($path);
1741
-			throw new \OCP\Files\InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
1742
-		}
1743
-	}
1744
-
1745
-	/**
1746
-	 * check if it is allowed to move a mount point to a given target.
1747
-	 * It is not allowed to move a mount point into a different mount point or
1748
-	 * into an already shared folder
1749
-	 *
1750
-	 * @param string $target path
1751
-	 * @return boolean
1752
-	 */
1753
-	private function isTargetAllowed($target) {
1754
-
1755
-		list($targetStorage, $targetInternalPath) = \OC\Files\Filesystem::resolvePath($target);
1756
-		if (!$targetStorage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
1757
-			\OCP\Util::writeLog('files',
1758
-				'It is not allowed to move one mount point into another one',
1759
-				\OCP\Util::DEBUG);
1760
-			return false;
1761
-		}
1762
-
1763
-		// note: cannot use the view because the target is already locked
1764
-		$fileId = (int)$targetStorage->getCache()->getId($targetInternalPath);
1765
-		if ($fileId === -1) {
1766
-			// target might not exist, need to check parent instead
1767
-			$fileId = (int)$targetStorage->getCache()->getId(dirname($targetInternalPath));
1768
-		}
1769
-
1770
-		// check if any of the parents were shared by the current owner (include collections)
1771
-		$shares = \OCP\Share::getItemShared(
1772
-			'folder',
1773
-			$fileId,
1774
-			\OCP\Share::FORMAT_NONE,
1775
-			null,
1776
-			true
1777
-		);
1778
-
1779
-		if (count($shares) > 0) {
1780
-			\OCP\Util::writeLog('files',
1781
-				'It is not allowed to move one mount point into a shared folder',
1782
-				\OCP\Util::DEBUG);
1783
-			return false;
1784
-		}
1785
-
1786
-		return true;
1787
-	}
1788
-
1789
-	/**
1790
-	 * Get a fileinfo object for files that are ignored in the cache (part files)
1791
-	 *
1792
-	 * @param string $path
1793
-	 * @return \OCP\Files\FileInfo
1794
-	 */
1795
-	private function getPartFileInfo($path) {
1796
-		$mount = $this->getMount($path);
1797
-		$storage = $mount->getStorage();
1798
-		$internalPath = $mount->getInternalPath($this->getAbsolutePath($path));
1799
-		$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
1800
-		return new FileInfo(
1801
-			$this->getAbsolutePath($path),
1802
-			$storage,
1803
-			$internalPath,
1804
-			[
1805
-				'fileid' => null,
1806
-				'mimetype' => $storage->getMimeType($internalPath),
1807
-				'name' => basename($path),
1808
-				'etag' => null,
1809
-				'size' => $storage->filesize($internalPath),
1810
-				'mtime' => $storage->filemtime($internalPath),
1811
-				'encrypted' => false,
1812
-				'permissions' => \OCP\Constants::PERMISSION_ALL
1813
-			],
1814
-			$mount,
1815
-			$owner
1816
-		);
1817
-	}
1818
-
1819
-	/**
1820
-	 * @param string $path
1821
-	 * @param string $fileName
1822
-	 * @throws InvalidPathException
1823
-	 */
1824
-	public function verifyPath($path, $fileName) {
1825
-		try {
1826
-			/** @type \OCP\Files\Storage $storage */
1827
-			list($storage, $internalPath) = $this->resolvePath($path);
1828
-			$storage->verifyPath($internalPath, $fileName);
1829
-		} catch (ReservedWordException $ex) {
1830
-			$l = \OC::$server->getL10N('lib');
1831
-			throw new InvalidPathException($l->t('File name is a reserved word'));
1832
-		} catch (InvalidCharacterInPathException $ex) {
1833
-			$l = \OC::$server->getL10N('lib');
1834
-			throw new InvalidPathException($l->t('File name contains at least one invalid character'));
1835
-		} catch (FileNameTooLongException $ex) {
1836
-			$l = \OC::$server->getL10N('lib');
1837
-			throw new InvalidPathException($l->t('File name is too long'));
1838
-		} catch (InvalidDirectoryException $ex) {
1839
-			$l = \OC::$server->getL10N('lib');
1840
-			throw new InvalidPathException($l->t('Dot files are not allowed'));
1841
-		} catch (EmptyFileNameException $ex) {
1842
-			$l = \OC::$server->getL10N('lib');
1843
-			throw new InvalidPathException($l->t('Empty filename is not allowed'));
1844
-		}
1845
-	}
1846
-
1847
-	/**
1848
-	 * get all parent folders of $path
1849
-	 *
1850
-	 * @param string $path
1851
-	 * @return string[]
1852
-	 */
1853
-	private function getParents($path) {
1854
-		$path = trim($path, '/');
1855
-		if (!$path) {
1856
-			return [];
1857
-		}
1858
-
1859
-		$parts = explode('/', $path);
1860
-
1861
-		// remove the single file
1862
-		array_pop($parts);
1863
-		$result = array('/');
1864
-		$resultPath = '';
1865
-		foreach ($parts as $part) {
1866
-			if ($part) {
1867
-				$resultPath .= '/' . $part;
1868
-				$result[] = $resultPath;
1869
-			}
1870
-		}
1871
-		return $result;
1872
-	}
1873
-
1874
-	/**
1875
-	 * Returns the mount point for which to lock
1876
-	 *
1877
-	 * @param string $absolutePath absolute path
1878
-	 * @param bool $useParentMount true to return parent mount instead of whatever
1879
-	 * is mounted directly on the given path, false otherwise
1880
-	 * @return \OC\Files\Mount\MountPoint mount point for which to apply locks
1881
-	 */
1882
-	private function getMountForLock($absolutePath, $useParentMount = false) {
1883
-		$results = [];
1884
-		$mount = Filesystem::getMountManager()->find($absolutePath);
1885
-		if (!$mount) {
1886
-			return $results;
1887
-		}
1888
-
1889
-		if ($useParentMount) {
1890
-			// find out if something is mounted directly on the path
1891
-			$internalPath = $mount->getInternalPath($absolutePath);
1892
-			if ($internalPath === '') {
1893
-				// resolve the parent mount instead
1894
-				$mount = Filesystem::getMountManager()->find(dirname($absolutePath));
1895
-			}
1896
-		}
1897
-
1898
-		return $mount;
1899
-	}
1900
-
1901
-	/**
1902
-	 * Lock the given path
1903
-	 *
1904
-	 * @param string $path the path of the file to lock, relative to the view
1905
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
1906
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
1907
-	 *
1908
-	 * @return bool False if the path is excluded from locking, true otherwise
1909
-	 * @throws \OCP\Lock\LockedException if the path is already locked
1910
-	 */
1911
-	private function lockPath($path, $type, $lockMountPoint = false) {
1912
-		$absolutePath = $this->getAbsolutePath($path);
1913
-		$absolutePath = Filesystem::normalizePath($absolutePath);
1914
-		if (!$this->shouldLockFile($absolutePath)) {
1915
-			return false;
1916
-		}
1917
-
1918
-		$mount = $this->getMountForLock($absolutePath, $lockMountPoint);
1919
-		if ($mount) {
1920
-			try {
1921
-				$storage = $mount->getStorage();
1922
-				if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
1923
-					$storage->acquireLock(
1924
-						$mount->getInternalPath($absolutePath),
1925
-						$type,
1926
-						$this->lockingProvider
1927
-					);
1928
-				}
1929
-			} catch (\OCP\Lock\LockedException $e) {
1930
-				// rethrow with the a human-readable path
1931
-				throw new \OCP\Lock\LockedException(
1932
-					$this->getPathRelativeToFiles($absolutePath),
1933
-					$e
1934
-				);
1935
-			}
1936
-		}
1937
-
1938
-		return true;
1939
-	}
1940
-
1941
-	/**
1942
-	 * Change the lock type
1943
-	 *
1944
-	 * @param string $path the path of the file to lock, relative to the view
1945
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
1946
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
1947
-	 *
1948
-	 * @return bool False if the path is excluded from locking, true otherwise
1949
-	 * @throws \OCP\Lock\LockedException if the path is already locked
1950
-	 */
1951
-	public function changeLock($path, $type, $lockMountPoint = false) {
1952
-		$path = Filesystem::normalizePath($path);
1953
-		$absolutePath = $this->getAbsolutePath($path);
1954
-		$absolutePath = Filesystem::normalizePath($absolutePath);
1955
-		if (!$this->shouldLockFile($absolutePath)) {
1956
-			return false;
1957
-		}
1958
-
1959
-		$mount = $this->getMountForLock($absolutePath, $lockMountPoint);
1960
-		if ($mount) {
1961
-			try {
1962
-				$storage = $mount->getStorage();
1963
-				if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
1964
-					$storage->changeLock(
1965
-						$mount->getInternalPath($absolutePath),
1966
-						$type,
1967
-						$this->lockingProvider
1968
-					);
1969
-				}
1970
-			} catch (\OCP\Lock\LockedException $e) {
1971
-				try {
1972
-					// rethrow with the a human-readable path
1973
-					throw new \OCP\Lock\LockedException(
1974
-						$this->getPathRelativeToFiles($absolutePath),
1975
-						$e
1976
-					);
1977
-				} catch (\InvalidArgumentException $e) {
1978
-					throw new \OCP\Lock\LockedException(
1979
-						$absolutePath,
1980
-						$e
1981
-					);
1982
-				}
1983
-			}
1984
-		}
1985
-
1986
-		return true;
1987
-	}
1988
-
1989
-	/**
1990
-	 * Unlock the given path
1991
-	 *
1992
-	 * @param string $path the path of the file to unlock, relative to the view
1993
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
1994
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
1995
-	 *
1996
-	 * @return bool False if the path is excluded from locking, true otherwise
1997
-	 */
1998
-	private function unlockPath($path, $type, $lockMountPoint = false) {
1999
-		$absolutePath = $this->getAbsolutePath($path);
2000
-		$absolutePath = Filesystem::normalizePath($absolutePath);
2001
-		if (!$this->shouldLockFile($absolutePath)) {
2002
-			return false;
2003
-		}
2004
-
2005
-		$mount = $this->getMountForLock($absolutePath, $lockMountPoint);
2006
-		if ($mount) {
2007
-			$storage = $mount->getStorage();
2008
-			if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
2009
-				$storage->releaseLock(
2010
-					$mount->getInternalPath($absolutePath),
2011
-					$type,
2012
-					$this->lockingProvider
2013
-				);
2014
-			}
2015
-		}
2016
-
2017
-		return true;
2018
-	}
2019
-
2020
-	/**
2021
-	 * Lock a path and all its parents up to the root of the view
2022
-	 *
2023
-	 * @param string $path the path of the file to lock relative to the view
2024
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
2025
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
2026
-	 *
2027
-	 * @return bool False if the path is excluded from locking, true otherwise
2028
-	 */
2029
-	public function lockFile($path, $type, $lockMountPoint = false) {
2030
-		$absolutePath = $this->getAbsolutePath($path);
2031
-		$absolutePath = Filesystem::normalizePath($absolutePath);
2032
-		if (!$this->shouldLockFile($absolutePath)) {
2033
-			return false;
2034
-		}
2035
-
2036
-		$this->lockPath($path, $type, $lockMountPoint);
2037
-
2038
-		$parents = $this->getParents($path);
2039
-		foreach ($parents as $parent) {
2040
-			$this->lockPath($parent, ILockingProvider::LOCK_SHARED);
2041
-		}
2042
-
2043
-		return true;
2044
-	}
2045
-
2046
-	/**
2047
-	 * Unlock a path and all its parents up to the root of the view
2048
-	 *
2049
-	 * @param string $path the path of the file to lock relative to the view
2050
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
2051
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
2052
-	 *
2053
-	 * @return bool False if the path is excluded from locking, true otherwise
2054
-	 */
2055
-	public function unlockFile($path, $type, $lockMountPoint = false) {
2056
-		$absolutePath = $this->getAbsolutePath($path);
2057
-		$absolutePath = Filesystem::normalizePath($absolutePath);
2058
-		if (!$this->shouldLockFile($absolutePath)) {
2059
-			return false;
2060
-		}
2061
-
2062
-		$this->unlockPath($path, $type, $lockMountPoint);
2063
-
2064
-		$parents = $this->getParents($path);
2065
-		foreach ($parents as $parent) {
2066
-			$this->unlockPath($parent, ILockingProvider::LOCK_SHARED);
2067
-		}
2068
-
2069
-		return true;
2070
-	}
2071
-
2072
-	/**
2073
-	 * Only lock files in data/user/files/
2074
-	 *
2075
-	 * @param string $path Absolute path to the file/folder we try to (un)lock
2076
-	 * @return bool
2077
-	 */
2078
-	protected function shouldLockFile($path) {
2079
-		$path = Filesystem::normalizePath($path);
2080
-
2081
-		$pathSegments = explode('/', $path);
2082
-		if (isset($pathSegments[2])) {
2083
-			// E.g.: /username/files/path-to-file
2084
-			return ($pathSegments[2] === 'files') && (count($pathSegments) > 3);
2085
-		}
2086
-
2087
-		return strpos($path, '/appdata_') !== 0;
2088
-	}
2089
-
2090
-	/**
2091
-	 * Shortens the given absolute path to be relative to
2092
-	 * "$user/files".
2093
-	 *
2094
-	 * @param string $absolutePath absolute path which is under "files"
2095
-	 *
2096
-	 * @return string path relative to "files" with trimmed slashes or null
2097
-	 * if the path was NOT relative to files
2098
-	 *
2099
-	 * @throws \InvalidArgumentException if the given path was not under "files"
2100
-	 * @since 8.1.0
2101
-	 */
2102
-	public function getPathRelativeToFiles($absolutePath) {
2103
-		$path = Filesystem::normalizePath($absolutePath);
2104
-		$parts = explode('/', trim($path, '/'), 3);
2105
-		// "$user", "files", "path/to/dir"
2106
-		if (!isset($parts[1]) || $parts[1] !== 'files') {
2107
-			$this->logger->error(
2108
-				'$absolutePath must be relative to "files", value is "%s"',
2109
-				[
2110
-					$absolutePath
2111
-				]
2112
-			);
2113
-			throw new \InvalidArgumentException('$absolutePath must be relative to "files"');
2114
-		}
2115
-		if (isset($parts[2])) {
2116
-			return $parts[2];
2117
-		}
2118
-		return '';
2119
-	}
2120
-
2121
-	/**
2122
-	 * @param string $filename
2123
-	 * @return array
2124
-	 * @throws \OC\User\NoUserException
2125
-	 * @throws NotFoundException
2126
-	 */
2127
-	public function getUidAndFilename($filename) {
2128
-		$info = $this->getFileInfo($filename);
2129
-		if (!$info instanceof \OCP\Files\FileInfo) {
2130
-			throw new NotFoundException($this->getAbsolutePath($filename) . ' not found');
2131
-		}
2132
-		$uid = $info->getOwner()->getUID();
2133
-		if ($uid != \OCP\User::getUser()) {
2134
-			Filesystem::initMountPoints($uid);
2135
-			$ownerView = new View('/' . $uid . '/files');
2136
-			try {
2137
-				$filename = $ownerView->getPath($info['fileid']);
2138
-			} catch (NotFoundException $e) {
2139
-				throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid);
2140
-			}
2141
-		}
2142
-		return [$uid, $filename];
2143
-	}
2144
-
2145
-	/**
2146
-	 * Creates parent non-existing folders
2147
-	 *
2148
-	 * @param string $filePath
2149
-	 * @return bool
2150
-	 */
2151
-	private function createParentDirectories($filePath) {
2152
-		$directoryParts = explode('/', $filePath);
2153
-		$directoryParts = array_filter($directoryParts);
2154
-		foreach ($directoryParts as $key => $part) {
2155
-			$currentPathElements = array_slice($directoryParts, 0, $key);
2156
-			$currentPath = '/' . implode('/', $currentPathElements);
2157
-			if ($this->is_file($currentPath)) {
2158
-				return false;
2159
-			}
2160
-			if (!$this->file_exists($currentPath)) {
2161
-				$this->mkdir($currentPath);
2162
-			}
2163
-		}
2164
-
2165
-		return true;
2166
-	}
83
+    /** @var string */
84
+    private $fakeRoot = '';
85
+
86
+    /**
87
+     * @var \OCP\Lock\ILockingProvider
88
+     */
89
+    protected $lockingProvider;
90
+
91
+    private $lockingEnabled;
92
+
93
+    private $updaterEnabled = true;
94
+
95
+    /** @var \OC\User\Manager */
96
+    private $userManager;
97
+
98
+    /** @var \OCP\ILogger */
99
+    private $logger;
100
+
101
+    /**
102
+     * @param string $root
103
+     * @throws \Exception If $root contains an invalid path
104
+     */
105
+    public function __construct($root = '') {
106
+        if (is_null($root)) {
107
+            throw new \InvalidArgumentException('Root can\'t be null');
108
+        }
109
+        if (!Filesystem::isValidPath($root)) {
110
+            throw new \Exception();
111
+        }
112
+
113
+        $this->fakeRoot = $root;
114
+        $this->lockingProvider = \OC::$server->getLockingProvider();
115
+        $this->lockingEnabled = !($this->lockingProvider instanceof \OC\Lock\NoopLockingProvider);
116
+        $this->userManager = \OC::$server->getUserManager();
117
+        $this->logger = \OC::$server->getLogger();
118
+    }
119
+
120
+    public function getAbsolutePath($path = '/') {
121
+        if ($path === null) {
122
+            return null;
123
+        }
124
+        $this->assertPathLength($path);
125
+        if ($path === '') {
126
+            $path = '/';
127
+        }
128
+        if ($path[0] !== '/') {
129
+            $path = '/' . $path;
130
+        }
131
+        return $this->fakeRoot . $path;
132
+    }
133
+
134
+    /**
135
+     * change the root to a fake root
136
+     *
137
+     * @param string $fakeRoot
138
+     * @return boolean|null
139
+     */
140
+    public function chroot($fakeRoot) {
141
+        if (!$fakeRoot == '') {
142
+            if ($fakeRoot[0] !== '/') {
143
+                $fakeRoot = '/' . $fakeRoot;
144
+            }
145
+        }
146
+        $this->fakeRoot = $fakeRoot;
147
+    }
148
+
149
+    /**
150
+     * get the fake root
151
+     *
152
+     * @return string
153
+     */
154
+    public function getRoot() {
155
+        return $this->fakeRoot;
156
+    }
157
+
158
+    /**
159
+     * get path relative to the root of the view
160
+     *
161
+     * @param string $path
162
+     * @return string
163
+     */
164
+    public function getRelativePath($path) {
165
+        $this->assertPathLength($path);
166
+        if ($this->fakeRoot == '') {
167
+            return $path;
168
+        }
169
+
170
+        if (rtrim($path, '/') === rtrim($this->fakeRoot, '/')) {
171
+            return '/';
172
+        }
173
+
174
+        // missing slashes can cause wrong matches!
175
+        $root = rtrim($this->fakeRoot, '/') . '/';
176
+
177
+        if (strpos($path, $root) !== 0) {
178
+            return null;
179
+        } else {
180
+            $path = substr($path, strlen($this->fakeRoot));
181
+            if (strlen($path) === 0) {
182
+                return '/';
183
+            } else {
184
+                return $path;
185
+            }
186
+        }
187
+    }
188
+
189
+    /**
190
+     * get the mountpoint of the storage object for a path
191
+     * ( note: because a storage is not always mounted inside the fakeroot, the
192
+     * returned mountpoint is relative to the absolute root of the filesystem
193
+     * and does not take the chroot into account )
194
+     *
195
+     * @param string $path
196
+     * @return string
197
+     */
198
+    public function getMountPoint($path) {
199
+        return Filesystem::getMountPoint($this->getAbsolutePath($path));
200
+    }
201
+
202
+    /**
203
+     * get the mountpoint of the storage object for a path
204
+     * ( note: because a storage is not always mounted inside the fakeroot, the
205
+     * returned mountpoint is relative to the absolute root of the filesystem
206
+     * and does not take the chroot into account )
207
+     *
208
+     * @param string $path
209
+     * @return \OCP\Files\Mount\IMountPoint
210
+     */
211
+    public function getMount($path) {
212
+        return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
213
+    }
214
+
215
+    /**
216
+     * resolve a path to a storage and internal path
217
+     *
218
+     * @param string $path
219
+     * @return array an array consisting of the storage and the internal path
220
+     */
221
+    public function resolvePath($path) {
222
+        $a = $this->getAbsolutePath($path);
223
+        $p = Filesystem::normalizePath($a);
224
+        return Filesystem::resolvePath($p);
225
+    }
226
+
227
+    /**
228
+     * return the path to a local version of the file
229
+     * we need this because we can't know if a file is stored local or not from
230
+     * outside the filestorage and for some purposes a local file is needed
231
+     *
232
+     * @param string $path
233
+     * @return string
234
+     */
235
+    public function getLocalFile($path) {
236
+        $parent = substr($path, 0, strrpos($path, '/'));
237
+        $path = $this->getAbsolutePath($path);
238
+        list($storage, $internalPath) = Filesystem::resolvePath($path);
239
+        if (Filesystem::isValidPath($parent) and $storage) {
240
+            return $storage->getLocalFile($internalPath);
241
+        } else {
242
+            return null;
243
+        }
244
+    }
245
+
246
+    /**
247
+     * @param string $path
248
+     * @return string
249
+     */
250
+    public function getLocalFolder($path) {
251
+        $parent = substr($path, 0, strrpos($path, '/'));
252
+        $path = $this->getAbsolutePath($path);
253
+        list($storage, $internalPath) = Filesystem::resolvePath($path);
254
+        if (Filesystem::isValidPath($parent) and $storage) {
255
+            return $storage->getLocalFolder($internalPath);
256
+        } else {
257
+            return null;
258
+        }
259
+    }
260
+
261
+    /**
262
+     * the following functions operate with arguments and return values identical
263
+     * to those of their PHP built-in equivalents. Mostly they are merely wrappers
264
+     * for \OC\Files\Storage\Storage via basicOperation().
265
+     */
266
+    public function mkdir($path) {
267
+        return $this->basicOperation('mkdir', $path, array('create', 'write'));
268
+    }
269
+
270
+    /**
271
+     * remove mount point
272
+     *
273
+     * @param \OC\Files\Mount\MoveableMount $mount
274
+     * @param string $path relative to data/
275
+     * @return boolean
276
+     */
277
+    protected function removeMount($mount, $path) {
278
+        if ($mount instanceof MoveableMount) {
279
+            // cut of /user/files to get the relative path to data/user/files
280
+            $pathParts = explode('/', $path, 4);
281
+            $relPath = '/' . $pathParts[3];
282
+            $this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true);
283
+            \OC_Hook::emit(
284
+                Filesystem::CLASSNAME, "umount",
285
+                array(Filesystem::signal_param_path => $relPath)
286
+            );
287
+            $this->changeLock($relPath, ILockingProvider::LOCK_EXCLUSIVE, true);
288
+            $result = $mount->removeMount();
289
+            $this->changeLock($relPath, ILockingProvider::LOCK_SHARED, true);
290
+            if ($result) {
291
+                \OC_Hook::emit(
292
+                    Filesystem::CLASSNAME, "post_umount",
293
+                    array(Filesystem::signal_param_path => $relPath)
294
+                );
295
+            }
296
+            $this->unlockFile($relPath, ILockingProvider::LOCK_SHARED, true);
297
+            return $result;
298
+        } else {
299
+            // do not allow deleting the storage's root / the mount point
300
+            // because for some storages it might delete the whole contents
301
+            // but isn't supposed to work that way
302
+            return false;
303
+        }
304
+    }
305
+
306
+    public function disableCacheUpdate() {
307
+        $this->updaterEnabled = false;
308
+    }
309
+
310
+    public function enableCacheUpdate() {
311
+        $this->updaterEnabled = true;
312
+    }
313
+
314
+    protected function writeUpdate(Storage $storage, $internalPath, $time = null) {
315
+        if ($this->updaterEnabled) {
316
+            if (is_null($time)) {
317
+                $time = time();
318
+            }
319
+            $storage->getUpdater()->update($internalPath, $time);
320
+        }
321
+    }
322
+
323
+    protected function removeUpdate(Storage $storage, $internalPath) {
324
+        if ($this->updaterEnabled) {
325
+            $storage->getUpdater()->remove($internalPath);
326
+        }
327
+    }
328
+
329
+    protected function renameUpdate(Storage $sourceStorage, Storage $targetStorage, $sourceInternalPath, $targetInternalPath) {
330
+        if ($this->updaterEnabled) {
331
+            $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
332
+        }
333
+    }
334
+
335
+    /**
336
+     * @param string $path
337
+     * @return bool|mixed
338
+     */
339
+    public function rmdir($path) {
340
+        $absolutePath = $this->getAbsolutePath($path);
341
+        $mount = Filesystem::getMountManager()->find($absolutePath);
342
+        if ($mount->getInternalPath($absolutePath) === '') {
343
+            return $this->removeMount($mount, $absolutePath);
344
+        }
345
+        if ($this->is_dir($path)) {
346
+            $result = $this->basicOperation('rmdir', $path, array('delete'));
347
+        } else {
348
+            $result = false;
349
+        }
350
+
351
+        if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
352
+            $storage = $mount->getStorage();
353
+            $internalPath = $mount->getInternalPath($absolutePath);
354
+            $storage->getUpdater()->remove($internalPath);
355
+        }
356
+        return $result;
357
+    }
358
+
359
+    /**
360
+     * @param string $path
361
+     * @return resource
362
+     */
363
+    public function opendir($path) {
364
+        return $this->basicOperation('opendir', $path, array('read'));
365
+    }
366
+
367
+    /**
368
+     * @param string $path
369
+     * @return bool|mixed
370
+     */
371
+    public function is_dir($path) {
372
+        if ($path == '/') {
373
+            return true;
374
+        }
375
+        return $this->basicOperation('is_dir', $path);
376
+    }
377
+
378
+    /**
379
+     * @param string $path
380
+     * @return bool|mixed
381
+     */
382
+    public function is_file($path) {
383
+        if ($path == '/') {
384
+            return false;
385
+        }
386
+        return $this->basicOperation('is_file', $path);
387
+    }
388
+
389
+    /**
390
+     * @param string $path
391
+     * @return mixed
392
+     */
393
+    public function stat($path) {
394
+        return $this->basicOperation('stat', $path);
395
+    }
396
+
397
+    /**
398
+     * @param string $path
399
+     * @return mixed
400
+     */
401
+    public function filetype($path) {
402
+        return $this->basicOperation('filetype', $path);
403
+    }
404
+
405
+    /**
406
+     * @param string $path
407
+     * @return mixed
408
+     */
409
+    public function filesize($path) {
410
+        return $this->basicOperation('filesize', $path);
411
+    }
412
+
413
+    /**
414
+     * @param string $path
415
+     * @return bool|mixed
416
+     * @throws \OCP\Files\InvalidPathException
417
+     */
418
+    public function readfile($path) {
419
+        $this->assertPathLength($path);
420
+        @ob_end_clean();
421
+        $handle = $this->fopen($path, 'rb');
422
+        if ($handle) {
423
+            $chunkSize = 8192; // 8 kB chunks
424
+            while (!feof($handle)) {
425
+                echo fread($handle, $chunkSize);
426
+                flush();
427
+            }
428
+            fclose($handle);
429
+            $size = $this->filesize($path);
430
+            return $size;
431
+        }
432
+        return false;
433
+    }
434
+
435
+    /**
436
+     * @param string $path
437
+     * @param int $from
438
+     * @param int $to
439
+     * @return bool|mixed
440
+     * @throws \OCP\Files\InvalidPathException
441
+     * @throws \OCP\Files\UnseekableException
442
+     */
443
+    public function readfilePart($path, $from, $to) {
444
+        $this->assertPathLength($path);
445
+        @ob_end_clean();
446
+        $handle = $this->fopen($path, 'rb');
447
+        if ($handle) {
448
+            $chunkSize = 8192; // 8 kB chunks
449
+            $startReading = true;
450
+
451
+            if ($from !== 0 && $from !== '0' && fseek($handle, $from) !== 0) {
452
+                // forward file handle via chunked fread because fseek seem to have failed
453
+
454
+                $end = $from + 1;
455
+                while (!feof($handle) && ftell($handle) < $end) {
456
+                    $len = $from - ftell($handle);
457
+                    if ($len > $chunkSize) {
458
+                        $len = $chunkSize;
459
+                    }
460
+                    $result = fread($handle, $len);
461
+
462
+                    if ($result === false) {
463
+                        $startReading = false;
464
+                        break;
465
+                    }
466
+                }
467
+            }
468
+
469
+            if ($startReading) {
470
+                $end = $to + 1;
471
+                while (!feof($handle) && ftell($handle) < $end) {
472
+                    $len = $end - ftell($handle);
473
+                    if ($len > $chunkSize) {
474
+                        $len = $chunkSize;
475
+                    }
476
+                    echo fread($handle, $len);
477
+                    flush();
478
+                }
479
+                $size = ftell($handle) - $from;
480
+                return $size;
481
+            }
482
+
483
+            throw new \OCP\Files\UnseekableException('fseek error');
484
+        }
485
+        return false;
486
+    }
487
+
488
+    /**
489
+     * @param string $path
490
+     * @return mixed
491
+     */
492
+    public function isCreatable($path) {
493
+        return $this->basicOperation('isCreatable', $path);
494
+    }
495
+
496
+    /**
497
+     * @param string $path
498
+     * @return mixed
499
+     */
500
+    public function isReadable($path) {
501
+        return $this->basicOperation('isReadable', $path);
502
+    }
503
+
504
+    /**
505
+     * @param string $path
506
+     * @return mixed
507
+     */
508
+    public function isUpdatable($path) {
509
+        return $this->basicOperation('isUpdatable', $path);
510
+    }
511
+
512
+    /**
513
+     * @param string $path
514
+     * @return bool|mixed
515
+     */
516
+    public function isDeletable($path) {
517
+        $absolutePath = $this->getAbsolutePath($path);
518
+        $mount = Filesystem::getMountManager()->find($absolutePath);
519
+        if ($mount->getInternalPath($absolutePath) === '') {
520
+            return $mount instanceof MoveableMount;
521
+        }
522
+        return $this->basicOperation('isDeletable', $path);
523
+    }
524
+
525
+    /**
526
+     * @param string $path
527
+     * @return mixed
528
+     */
529
+    public function isSharable($path) {
530
+        return $this->basicOperation('isSharable', $path);
531
+    }
532
+
533
+    /**
534
+     * @param string $path
535
+     * @return bool|mixed
536
+     */
537
+    public function file_exists($path) {
538
+        if ($path == '/') {
539
+            return true;
540
+        }
541
+        return $this->basicOperation('file_exists', $path);
542
+    }
543
+
544
+    /**
545
+     * @param string $path
546
+     * @return mixed
547
+     */
548
+    public function filemtime($path) {
549
+        return $this->basicOperation('filemtime', $path);
550
+    }
551
+
552
+    /**
553
+     * @param string $path
554
+     * @param int|string $mtime
555
+     * @return bool
556
+     */
557
+    public function touch($path, $mtime = null) {
558
+        if (!is_null($mtime) and !is_numeric($mtime)) {
559
+            $mtime = strtotime($mtime);
560
+        }
561
+
562
+        $hooks = array('touch');
563
+
564
+        if (!$this->file_exists($path)) {
565
+            $hooks[] = 'create';
566
+            $hooks[] = 'write';
567
+        }
568
+        $result = $this->basicOperation('touch', $path, $hooks, $mtime);
569
+        if (!$result) {
570
+            // If create file fails because of permissions on external storage like SMB folders,
571
+            // check file exists and return false if not.
572
+            if (!$this->file_exists($path)) {
573
+                return false;
574
+            }
575
+            if (is_null($mtime)) {
576
+                $mtime = time();
577
+            }
578
+            //if native touch fails, we emulate it by changing the mtime in the cache
579
+            $this->putFileInfo($path, array('mtime' => floor($mtime)));
580
+        }
581
+        return true;
582
+    }
583
+
584
+    /**
585
+     * @param string $path
586
+     * @return mixed
587
+     */
588
+    public function file_get_contents($path) {
589
+        return $this->basicOperation('file_get_contents', $path, array('read'));
590
+    }
591
+
592
+    /**
593
+     * @param bool $exists
594
+     * @param string $path
595
+     * @param bool $run
596
+     */
597
+    protected function emit_file_hooks_pre($exists, $path, &$run) {
598
+        if (!$exists) {
599
+            \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, array(
600
+                Filesystem::signal_param_path => $this->getHookPath($path),
601
+                Filesystem::signal_param_run => &$run,
602
+            ));
603
+        } else {
604
+            \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, array(
605
+                Filesystem::signal_param_path => $this->getHookPath($path),
606
+                Filesystem::signal_param_run => &$run,
607
+            ));
608
+        }
609
+        \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, array(
610
+            Filesystem::signal_param_path => $this->getHookPath($path),
611
+            Filesystem::signal_param_run => &$run,
612
+        ));
613
+    }
614
+
615
+    /**
616
+     * @param bool $exists
617
+     * @param string $path
618
+     */
619
+    protected function emit_file_hooks_post($exists, $path) {
620
+        if (!$exists) {
621
+            \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, array(
622
+                Filesystem::signal_param_path => $this->getHookPath($path),
623
+            ));
624
+        } else {
625
+            \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_update, array(
626
+                Filesystem::signal_param_path => $this->getHookPath($path),
627
+            ));
628
+        }
629
+        \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_write, array(
630
+            Filesystem::signal_param_path => $this->getHookPath($path),
631
+        ));
632
+    }
633
+
634
+    /**
635
+     * @param string $path
636
+     * @param mixed $data
637
+     * @return bool|mixed
638
+     * @throws \Exception
639
+     */
640
+    public function file_put_contents($path, $data) {
641
+        if (is_resource($data)) { //not having to deal with streams in file_put_contents makes life easier
642
+            $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
643
+            if (Filesystem::isValidPath($path)
644
+                and !Filesystem::isFileBlacklisted($path)
645
+            ) {
646
+                $path = $this->getRelativePath($absolutePath);
647
+
648
+                $this->lockFile($path, ILockingProvider::LOCK_SHARED);
649
+
650
+                $exists = $this->file_exists($path);
651
+                $run = true;
652
+                if ($this->shouldEmitHooks($path)) {
653
+                    $this->emit_file_hooks_pre($exists, $path, $run);
654
+                }
655
+                if (!$run) {
656
+                    $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
657
+                    return false;
658
+                }
659
+
660
+                $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
661
+
662
+                /** @var \OC\Files\Storage\Storage $storage */
663
+                list($storage, $internalPath) = $this->resolvePath($path);
664
+                $target = $storage->fopen($internalPath, 'w');
665
+                if ($target) {
666
+                    list (, $result) = \OC_Helper::streamCopy($data, $target);
667
+                    fclose($target);
668
+                    fclose($data);
669
+
670
+                    $this->writeUpdate($storage, $internalPath);
671
+
672
+                    $this->changeLock($path, ILockingProvider::LOCK_SHARED);
673
+
674
+                    if ($this->shouldEmitHooks($path) && $result !== false) {
675
+                        $this->emit_file_hooks_post($exists, $path);
676
+                    }
677
+                    $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
678
+                    return $result;
679
+                } else {
680
+                    $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
681
+                    return false;
682
+                }
683
+            } else {
684
+                return false;
685
+            }
686
+        } else {
687
+            $hooks = ($this->file_exists($path)) ? array('update', 'write') : array('create', 'write');
688
+            return $this->basicOperation('file_put_contents', $path, $hooks, $data);
689
+        }
690
+    }
691
+
692
+    /**
693
+     * @param string $path
694
+     * @return bool|mixed
695
+     */
696
+    public function unlink($path) {
697
+        if ($path === '' || $path === '/') {
698
+            // do not allow deleting the root
699
+            return false;
700
+        }
701
+        $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
702
+        $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
703
+        $mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
704
+        if ($mount and $mount->getInternalPath($absolutePath) === '') {
705
+            return $this->removeMount($mount, $absolutePath);
706
+        }
707
+        if ($this->is_dir($path)) {
708
+            $result = $this->basicOperation('rmdir', $path, ['delete']);
709
+        } else {
710
+            $result = $this->basicOperation('unlink', $path, ['delete']);
711
+        }
712
+        if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
713
+            $storage = $mount->getStorage();
714
+            $internalPath = $mount->getInternalPath($absolutePath);
715
+            $storage->getUpdater()->remove($internalPath);
716
+            return true;
717
+        } else {
718
+            return $result;
719
+        }
720
+    }
721
+
722
+    /**
723
+     * @param string $directory
724
+     * @return bool|mixed
725
+     */
726
+    public function deleteAll($directory) {
727
+        return $this->rmdir($directory);
728
+    }
729
+
730
+    /**
731
+     * Rename/move a file or folder from the source path to target path.
732
+     *
733
+     * @param string $path1 source path
734
+     * @param string $path2 target path
735
+     *
736
+     * @return bool|mixed
737
+     */
738
+    public function rename($path1, $path2) {
739
+        $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
740
+        $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
741
+        $result = false;
742
+        if (
743
+            Filesystem::isValidPath($path2)
744
+            and Filesystem::isValidPath($path1)
745
+            and !Filesystem::isFileBlacklisted($path2)
746
+        ) {
747
+            $path1 = $this->getRelativePath($absolutePath1);
748
+            $path2 = $this->getRelativePath($absolutePath2);
749
+            $exists = $this->file_exists($path2);
750
+
751
+            if ($path1 == null or $path2 == null) {
752
+                return false;
753
+            }
754
+
755
+            $this->lockFile($path1, ILockingProvider::LOCK_SHARED, true);
756
+            try {
757
+                $this->lockFile($path2, ILockingProvider::LOCK_SHARED, true);
758
+
759
+                $run = true;
760
+                if ($this->shouldEmitHooks($path1) && (Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2))) {
761
+                    // if it was a rename from a part file to a regular file it was a write and not a rename operation
762
+                    $this->emit_file_hooks_pre($exists, $path2, $run);
763
+                } elseif ($this->shouldEmitHooks($path1)) {
764
+                    \OC_Hook::emit(
765
+                        Filesystem::CLASSNAME, Filesystem::signal_rename,
766
+                        array(
767
+                            Filesystem::signal_param_oldpath => $this->getHookPath($path1),
768
+                            Filesystem::signal_param_newpath => $this->getHookPath($path2),
769
+                            Filesystem::signal_param_run => &$run
770
+                        )
771
+                    );
772
+                }
773
+                if ($run) {
774
+                    $this->verifyPath(dirname($path2), basename($path2));
775
+
776
+                    $manager = Filesystem::getMountManager();
777
+                    $mount1 = $this->getMount($path1);
778
+                    $mount2 = $this->getMount($path2);
779
+                    $storage1 = $mount1->getStorage();
780
+                    $storage2 = $mount2->getStorage();
781
+                    $internalPath1 = $mount1->getInternalPath($absolutePath1);
782
+                    $internalPath2 = $mount2->getInternalPath($absolutePath2);
783
+
784
+                    $this->changeLock($path1, ILockingProvider::LOCK_EXCLUSIVE, true);
785
+                    try {
786
+                        $this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE, true);
787
+
788
+                        if ($internalPath1 === '') {
789
+                            if ($mount1 instanceof MoveableMount) {
790
+                                if ($this->isTargetAllowed($absolutePath2)) {
791
+                                    /**
792
+                                     * @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount1
793
+                                     */
794
+                                    $sourceMountPoint = $mount1->getMountPoint();
795
+                                    $result = $mount1->moveMount($absolutePath2);
796
+                                    $manager->moveMount($sourceMountPoint, $mount1->getMountPoint());
797
+                                } else {
798
+                                    $result = false;
799
+                                }
800
+                            } else {
801
+                                $result = false;
802
+                            }
803
+                            // moving a file/folder within the same mount point
804
+                        } elseif ($storage1 === $storage2) {
805
+                            if ($storage1) {
806
+                                $result = $storage1->rename($internalPath1, $internalPath2);
807
+                            } else {
808
+                                $result = false;
809
+                            }
810
+                            // moving a file/folder between storages (from $storage1 to $storage2)
811
+                        } else {
812
+                            $result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
813
+                        }
814
+
815
+                        if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
816
+                            // if it was a rename from a part file to a regular file it was a write and not a rename operation
817
+                            $this->writeUpdate($storage2, $internalPath2);
818
+                        } else if ($result) {
819
+                            if ($internalPath1 !== '') { // don't do a cache update for moved mounts
820
+                                $this->renameUpdate($storage1, $storage2, $internalPath1, $internalPath2);
821
+                            }
822
+                        }
823
+                    } catch(\Exception $e) {
824
+                        throw $e;
825
+                    } finally {
826
+                        $this->changeLock($path1, ILockingProvider::LOCK_SHARED, true);
827
+                        $this->changeLock($path2, ILockingProvider::LOCK_SHARED, true);
828
+                    }
829
+
830
+                    if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
831
+                        if ($this->shouldEmitHooks()) {
832
+                            $this->emit_file_hooks_post($exists, $path2);
833
+                        }
834
+                    } elseif ($result) {
835
+                        if ($this->shouldEmitHooks($path1) and $this->shouldEmitHooks($path2)) {
836
+                            \OC_Hook::emit(
837
+                                Filesystem::CLASSNAME,
838
+                                Filesystem::signal_post_rename,
839
+                                array(
840
+                                    Filesystem::signal_param_oldpath => $this->getHookPath($path1),
841
+                                    Filesystem::signal_param_newpath => $this->getHookPath($path2)
842
+                                )
843
+                            );
844
+                        }
845
+                    }
846
+                }
847
+            } catch(\Exception $e) {
848
+                throw $e;
849
+            } finally {
850
+                $this->unlockFile($path1, ILockingProvider::LOCK_SHARED, true);
851
+                $this->unlockFile($path2, ILockingProvider::LOCK_SHARED, true);
852
+            }
853
+        }
854
+        return $result;
855
+    }
856
+
857
+    /**
858
+     * Copy a file/folder from the source path to target path
859
+     *
860
+     * @param string $path1 source path
861
+     * @param string $path2 target path
862
+     * @param bool $preserveMtime whether to preserve mtime on the copy
863
+     *
864
+     * @return bool|mixed
865
+     */
866
+    public function copy($path1, $path2, $preserveMtime = false) {
867
+        $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
868
+        $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
869
+        $result = false;
870
+        if (
871
+            Filesystem::isValidPath($path2)
872
+            and Filesystem::isValidPath($path1)
873
+            and !Filesystem::isFileBlacklisted($path2)
874
+        ) {
875
+            $path1 = $this->getRelativePath($absolutePath1);
876
+            $path2 = $this->getRelativePath($absolutePath2);
877
+
878
+            if ($path1 == null or $path2 == null) {
879
+                return false;
880
+            }
881
+            $run = true;
882
+
883
+            $this->lockFile($path2, ILockingProvider::LOCK_SHARED);
884
+            $this->lockFile($path1, ILockingProvider::LOCK_SHARED);
885
+            $lockTypePath1 = ILockingProvider::LOCK_SHARED;
886
+            $lockTypePath2 = ILockingProvider::LOCK_SHARED;
887
+
888
+            try {
889
+
890
+                $exists = $this->file_exists($path2);
891
+                if ($this->shouldEmitHooks()) {
892
+                    \OC_Hook::emit(
893
+                        Filesystem::CLASSNAME,
894
+                        Filesystem::signal_copy,
895
+                        array(
896
+                            Filesystem::signal_param_oldpath => $this->getHookPath($path1),
897
+                            Filesystem::signal_param_newpath => $this->getHookPath($path2),
898
+                            Filesystem::signal_param_run => &$run
899
+                        )
900
+                    );
901
+                    $this->emit_file_hooks_pre($exists, $path2, $run);
902
+                }
903
+                if ($run) {
904
+                    $mount1 = $this->getMount($path1);
905
+                    $mount2 = $this->getMount($path2);
906
+                    $storage1 = $mount1->getStorage();
907
+                    $internalPath1 = $mount1->getInternalPath($absolutePath1);
908
+                    $storage2 = $mount2->getStorage();
909
+                    $internalPath2 = $mount2->getInternalPath($absolutePath2);
910
+
911
+                    $this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE);
912
+                    $lockTypePath2 = ILockingProvider::LOCK_EXCLUSIVE;
913
+
914
+                    if ($mount1->getMountPoint() == $mount2->getMountPoint()) {
915
+                        if ($storage1) {
916
+                            $result = $storage1->copy($internalPath1, $internalPath2);
917
+                        } else {
918
+                            $result = false;
919
+                        }
920
+                    } else {
921
+                        $result = $storage2->copyFromStorage($storage1, $internalPath1, $internalPath2);
922
+                    }
923
+
924
+                    $this->writeUpdate($storage2, $internalPath2);
925
+
926
+                    $this->changeLock($path2, ILockingProvider::LOCK_SHARED);
927
+                    $lockTypePath2 = ILockingProvider::LOCK_SHARED;
928
+
929
+                    if ($this->shouldEmitHooks() && $result !== false) {
930
+                        \OC_Hook::emit(
931
+                            Filesystem::CLASSNAME,
932
+                            Filesystem::signal_post_copy,
933
+                            array(
934
+                                Filesystem::signal_param_oldpath => $this->getHookPath($path1),
935
+                                Filesystem::signal_param_newpath => $this->getHookPath($path2)
936
+                            )
937
+                        );
938
+                        $this->emit_file_hooks_post($exists, $path2);
939
+                    }
940
+
941
+                }
942
+            } catch (\Exception $e) {
943
+                $this->unlockFile($path2, $lockTypePath2);
944
+                $this->unlockFile($path1, $lockTypePath1);
945
+                throw $e;
946
+            }
947
+
948
+            $this->unlockFile($path2, $lockTypePath2);
949
+            $this->unlockFile($path1, $lockTypePath1);
950
+
951
+        }
952
+        return $result;
953
+    }
954
+
955
+    /**
956
+     * @param string $path
957
+     * @param string $mode 'r' or 'w'
958
+     * @return resource
959
+     */
960
+    public function fopen($path, $mode) {
961
+        $mode = str_replace('b', '', $mode); // the binary flag is a windows only feature which we do not support
962
+        $hooks = array();
963
+        switch ($mode) {
964
+            case 'r':
965
+                $hooks[] = 'read';
966
+                break;
967
+            case 'r+':
968
+            case 'w+':
969
+            case 'x+':
970
+            case 'a+':
971
+                $hooks[] = 'read';
972
+                $hooks[] = 'write';
973
+                break;
974
+            case 'w':
975
+            case 'x':
976
+            case 'a':
977
+                $hooks[] = 'write';
978
+                break;
979
+            default:
980
+                \OCP\Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, \OCP\Util::ERROR);
981
+        }
982
+
983
+        if ($mode !== 'r' && $mode !== 'w') {
984
+            \OC::$server->getLogger()->info('Trying to open a file with a mode other than "r" or "w" can cause severe performance issues with some backends');
985
+        }
986
+
987
+        return $this->basicOperation('fopen', $path, $hooks, $mode);
988
+    }
989
+
990
+    /**
991
+     * @param string $path
992
+     * @return bool|string
993
+     * @throws \OCP\Files\InvalidPathException
994
+     */
995
+    public function toTmpFile($path) {
996
+        $this->assertPathLength($path);
997
+        if (Filesystem::isValidPath($path)) {
998
+            $source = $this->fopen($path, 'r');
999
+            if ($source) {
1000
+                $extension = pathinfo($path, PATHINFO_EXTENSION);
1001
+                $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension);
1002
+                file_put_contents($tmpFile, $source);
1003
+                return $tmpFile;
1004
+            } else {
1005
+                return false;
1006
+            }
1007
+        } else {
1008
+            return false;
1009
+        }
1010
+    }
1011
+
1012
+    /**
1013
+     * @param string $tmpFile
1014
+     * @param string $path
1015
+     * @return bool|mixed
1016
+     * @throws \OCP\Files\InvalidPathException
1017
+     */
1018
+    public function fromTmpFile($tmpFile, $path) {
1019
+        $this->assertPathLength($path);
1020
+        if (Filesystem::isValidPath($path)) {
1021
+
1022
+            // Get directory that the file is going into
1023
+            $filePath = dirname($path);
1024
+
1025
+            // Create the directories if any
1026
+            if (!$this->file_exists($filePath)) {
1027
+                $result = $this->createParentDirectories($filePath);
1028
+                if ($result === false) {
1029
+                    return false;
1030
+                }
1031
+            }
1032
+
1033
+            $source = fopen($tmpFile, 'r');
1034
+            if ($source) {
1035
+                $result = $this->file_put_contents($path, $source);
1036
+                // $this->file_put_contents() might have already closed
1037
+                // the resource, so we check it, before trying to close it
1038
+                // to avoid messages in the error log.
1039
+                if (is_resource($source)) {
1040
+                    fclose($source);
1041
+                }
1042
+                unlink($tmpFile);
1043
+                return $result;
1044
+            } else {
1045
+                return false;
1046
+            }
1047
+        } else {
1048
+            return false;
1049
+        }
1050
+    }
1051
+
1052
+
1053
+    /**
1054
+     * @param string $path
1055
+     * @return mixed
1056
+     * @throws \OCP\Files\InvalidPathException
1057
+     */
1058
+    public function getMimeType($path) {
1059
+        $this->assertPathLength($path);
1060
+        return $this->basicOperation('getMimeType', $path);
1061
+    }
1062
+
1063
+    /**
1064
+     * @param string $type
1065
+     * @param string $path
1066
+     * @param bool $raw
1067
+     * @return bool|null|string
1068
+     */
1069
+    public function hash($type, $path, $raw = false) {
1070
+        $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
1071
+        $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
1072
+        if (Filesystem::isValidPath($path)) {
1073
+            $path = $this->getRelativePath($absolutePath);
1074
+            if ($path == null) {
1075
+                return false;
1076
+            }
1077
+            if ($this->shouldEmitHooks($path)) {
1078
+                \OC_Hook::emit(
1079
+                    Filesystem::CLASSNAME,
1080
+                    Filesystem::signal_read,
1081
+                    array(Filesystem::signal_param_path => $this->getHookPath($path))
1082
+                );
1083
+            }
1084
+            list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
1085
+            if ($storage) {
1086
+                $result = $storage->hash($type, $internalPath, $raw);
1087
+                return $result;
1088
+            }
1089
+        }
1090
+        return null;
1091
+    }
1092
+
1093
+    /**
1094
+     * @param string $path
1095
+     * @return mixed
1096
+     * @throws \OCP\Files\InvalidPathException
1097
+     */
1098
+    public function free_space($path = '/') {
1099
+        $this->assertPathLength($path);
1100
+        $result = $this->basicOperation('free_space', $path);
1101
+        if ($result === null) {
1102
+            throw new InvalidPathException();
1103
+        }
1104
+        return $result;
1105
+    }
1106
+
1107
+    /**
1108
+     * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
1109
+     *
1110
+     * @param string $operation
1111
+     * @param string $path
1112
+     * @param array $hooks (optional)
1113
+     * @param mixed $extraParam (optional)
1114
+     * @return mixed
1115
+     * @throws \Exception
1116
+     *
1117
+     * This method takes requests for basic filesystem functions (e.g. reading & writing
1118
+     * files), processes hooks and proxies, sanitises paths, and finally passes them on to
1119
+     * \OC\Files\Storage\Storage for delegation to a storage backend for execution
1120
+     */
1121
+    private function basicOperation($operation, $path, $hooks = [], $extraParam = null) {
1122
+        $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
1123
+        $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
1124
+        if (Filesystem::isValidPath($path)
1125
+            and !Filesystem::isFileBlacklisted($path)
1126
+        ) {
1127
+            $path = $this->getRelativePath($absolutePath);
1128
+            if ($path == null) {
1129
+                return false;
1130
+            }
1131
+
1132
+            if (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks)) {
1133
+                // always a shared lock during pre-hooks so the hook can read the file
1134
+                $this->lockFile($path, ILockingProvider::LOCK_SHARED);
1135
+            }
1136
+
1137
+            $run = $this->runHooks($hooks, $path);
1138
+            /** @var \OC\Files\Storage\Storage $storage */
1139
+            list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
1140
+            if ($run and $storage) {
1141
+                if (in_array('write', $hooks) || in_array('delete', $hooks)) {
1142
+                    $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
1143
+                }
1144
+                try {
1145
+                    if (!is_null($extraParam)) {
1146
+                        $result = $storage->$operation($internalPath, $extraParam);
1147
+                    } else {
1148
+                        $result = $storage->$operation($internalPath);
1149
+                    }
1150
+                } catch (\Exception $e) {
1151
+                    if (in_array('write', $hooks) || in_array('delete', $hooks)) {
1152
+                        $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
1153
+                    } else if (in_array('read', $hooks)) {
1154
+                        $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
1155
+                    }
1156
+                    throw $e;
1157
+                }
1158
+
1159
+                if ($result && in_array('delete', $hooks) and $result) {
1160
+                    $this->removeUpdate($storage, $internalPath);
1161
+                }
1162
+                if ($result && in_array('write', $hooks) and $operation !== 'fopen') {
1163
+                    $this->writeUpdate($storage, $internalPath);
1164
+                }
1165
+                if ($result && in_array('touch', $hooks)) {
1166
+                    $this->writeUpdate($storage, $internalPath, $extraParam);
1167
+                }
1168
+
1169
+                if ((in_array('write', $hooks) || in_array('delete', $hooks)) && ($operation !== 'fopen' || $result === false)) {
1170
+                    $this->changeLock($path, ILockingProvider::LOCK_SHARED);
1171
+                }
1172
+
1173
+                $unlockLater = false;
1174
+                if ($this->lockingEnabled && $operation === 'fopen' && is_resource($result)) {
1175
+                    $unlockLater = true;
1176
+                    // make sure our unlocking callback will still be called if connection is aborted
1177
+                    ignore_user_abort(true);
1178
+                    $result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) {
1179
+                        if (in_array('write', $hooks)) {
1180
+                            $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
1181
+                        } else if (in_array('read', $hooks)) {
1182
+                            $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
1183
+                        }
1184
+                    });
1185
+                }
1186
+
1187
+                if ($this->shouldEmitHooks($path) && $result !== false) {
1188
+                    if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open
1189
+                        $this->runHooks($hooks, $path, true);
1190
+                    }
1191
+                }
1192
+
1193
+                if (!$unlockLater
1194
+                    && (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks))
1195
+                ) {
1196
+                    $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
1197
+                }
1198
+                return $result;
1199
+            } else {
1200
+                $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
1201
+            }
1202
+        }
1203
+        return null;
1204
+    }
1205
+
1206
+    /**
1207
+     * get the path relative to the default root for hook usage
1208
+     *
1209
+     * @param string $path
1210
+     * @return string
1211
+     */
1212
+    private function getHookPath($path) {
1213
+        if (!Filesystem::getView()) {
1214
+            return $path;
1215
+        }
1216
+        return Filesystem::getView()->getRelativePath($this->getAbsolutePath($path));
1217
+    }
1218
+
1219
+    private function shouldEmitHooks($path = '') {
1220
+        if ($path && Cache\Scanner::isPartialFile($path)) {
1221
+            return false;
1222
+        }
1223
+        if (!Filesystem::$loaded) {
1224
+            return false;
1225
+        }
1226
+        $defaultRoot = Filesystem::getRoot();
1227
+        if ($defaultRoot === null) {
1228
+            return false;
1229
+        }
1230
+        if ($this->fakeRoot === $defaultRoot) {
1231
+            return true;
1232
+        }
1233
+        $fullPath = $this->getAbsolutePath($path);
1234
+
1235
+        if ($fullPath === $defaultRoot) {
1236
+            return true;
1237
+        }
1238
+
1239
+        return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
1240
+    }
1241
+
1242
+    /**
1243
+     * @param string[] $hooks
1244
+     * @param string $path
1245
+     * @param bool $post
1246
+     * @return bool
1247
+     */
1248
+    private function runHooks($hooks, $path, $post = false) {
1249
+        $relativePath = $path;
1250
+        $path = $this->getHookPath($path);
1251
+        $prefix = ($post) ? 'post_' : '';
1252
+        $run = true;
1253
+        if ($this->shouldEmitHooks($relativePath)) {
1254
+            foreach ($hooks as $hook) {
1255
+                if ($hook != 'read') {
1256
+                    \OC_Hook::emit(
1257
+                        Filesystem::CLASSNAME,
1258
+                        $prefix . $hook,
1259
+                        array(
1260
+                            Filesystem::signal_param_run => &$run,
1261
+                            Filesystem::signal_param_path => $path
1262
+                        )
1263
+                    );
1264
+                } elseif (!$post) {
1265
+                    \OC_Hook::emit(
1266
+                        Filesystem::CLASSNAME,
1267
+                        $prefix . $hook,
1268
+                        array(
1269
+                            Filesystem::signal_param_path => $path
1270
+                        )
1271
+                    );
1272
+                }
1273
+            }
1274
+        }
1275
+        return $run;
1276
+    }
1277
+
1278
+    /**
1279
+     * check if a file or folder has been updated since $time
1280
+     *
1281
+     * @param string $path
1282
+     * @param int $time
1283
+     * @return bool
1284
+     */
1285
+    public function hasUpdated($path, $time) {
1286
+        return $this->basicOperation('hasUpdated', $path, array(), $time);
1287
+    }
1288
+
1289
+    /**
1290
+     * @param string $ownerId
1291
+     * @return \OC\User\User
1292
+     */
1293
+    private function getUserObjectForOwner($ownerId) {
1294
+        $owner = $this->userManager->get($ownerId);
1295
+        if ($owner instanceof IUser) {
1296
+            return $owner;
1297
+        } else {
1298
+            return new User($ownerId, null);
1299
+        }
1300
+    }
1301
+
1302
+    /**
1303
+     * Get file info from cache
1304
+     *
1305
+     * If the file is not in cached it will be scanned
1306
+     * If the file has changed on storage the cache will be updated
1307
+     *
1308
+     * @param \OC\Files\Storage\Storage $storage
1309
+     * @param string $internalPath
1310
+     * @param string $relativePath
1311
+     * @return ICacheEntry|bool
1312
+     */
1313
+    private function getCacheEntry($storage, $internalPath, $relativePath) {
1314
+        $cache = $storage->getCache($internalPath);
1315
+        $data = $cache->get($internalPath);
1316
+        $watcher = $storage->getWatcher($internalPath);
1317
+
1318
+        try {
1319
+            // if the file is not in the cache or needs to be updated, trigger the scanner and reload the data
1320
+            if (!$data || $data['size'] === -1) {
1321
+                $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
1322
+                if (!$storage->file_exists($internalPath)) {
1323
+                    $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
1324
+                    return false;
1325
+                }
1326
+                $scanner = $storage->getScanner($internalPath);
1327
+                $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
1328
+                $data = $cache->get($internalPath);
1329
+                $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
1330
+            } else if (!Cache\Scanner::isPartialFile($internalPath) && $watcher->needsUpdate($internalPath, $data)) {
1331
+                $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
1332
+                $watcher->update($internalPath, $data);
1333
+                $storage->getPropagator()->propagateChange($internalPath, time());
1334
+                $data = $cache->get($internalPath);
1335
+                $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
1336
+            }
1337
+        } catch (LockedException $e) {
1338
+            // if the file is locked we just use the old cache info
1339
+        }
1340
+
1341
+        return $data;
1342
+    }
1343
+
1344
+    /**
1345
+     * get the filesystem info
1346
+     *
1347
+     * @param string $path
1348
+     * @param boolean|string $includeMountPoints true to add mountpoint sizes,
1349
+     * 'ext' to add only ext storage mount point sizes. Defaults to true.
1350
+     * defaults to true
1351
+     * @return \OC\Files\FileInfo|false False if file does not exist
1352
+     */
1353
+    public function getFileInfo($path, $includeMountPoints = true) {
1354
+        $this->assertPathLength($path);
1355
+        if (!Filesystem::isValidPath($path)) {
1356
+            return false;
1357
+        }
1358
+        if (Cache\Scanner::isPartialFile($path)) {
1359
+            return $this->getPartFileInfo($path);
1360
+        }
1361
+        $relativePath = $path;
1362
+        $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
1363
+
1364
+        $mount = Filesystem::getMountManager()->find($path);
1365
+        if (!$mount) {
1366
+            return false;
1367
+        }
1368
+        $storage = $mount->getStorage();
1369
+        $internalPath = $mount->getInternalPath($path);
1370
+        if ($storage) {
1371
+            $data = $this->getCacheEntry($storage, $internalPath, $relativePath);
1372
+
1373
+            if (!$data instanceof ICacheEntry) {
1374
+                return false;
1375
+            }
1376
+
1377
+            if ($mount instanceof MoveableMount && $internalPath === '') {
1378
+                $data['permissions'] |= \OCP\Constants::PERMISSION_DELETE;
1379
+            }
1380
+
1381
+            $owner = $this->getUserObjectForOwner($storage->getOwner($internalPath));
1382
+            $info = new FileInfo($path, $storage, $internalPath, $data, $mount, $owner);
1383
+
1384
+            if ($data and isset($data['fileid'])) {
1385
+                if ($includeMountPoints and $data['mimetype'] === 'httpd/unix-directory') {
1386
+                    //add the sizes of other mount points to the folder
1387
+                    $extOnly = ($includeMountPoints === 'ext');
1388
+                    $mounts = Filesystem::getMountManager()->findIn($path);
1389
+                    $info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) {
1390
+                        $subStorage = $mount->getStorage();
1391
+                        return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage);
1392
+                    }));
1393
+                }
1394
+            }
1395
+
1396
+            return $info;
1397
+        }
1398
+
1399
+        return false;
1400
+    }
1401
+
1402
+    /**
1403
+     * get the content of a directory
1404
+     *
1405
+     * @param string $directory path under datadirectory
1406
+     * @param string $mimetype_filter limit returned content to this mimetype or mimepart
1407
+     * @return FileInfo[]
1408
+     */
1409
+    public function getDirectoryContent($directory, $mimetype_filter = '') {
1410
+        $this->assertPathLength($directory);
1411
+        if (!Filesystem::isValidPath($directory)) {
1412
+            return [];
1413
+        }
1414
+        $path = $this->getAbsolutePath($directory);
1415
+        $path = Filesystem::normalizePath($path);
1416
+        $mount = $this->getMount($directory);
1417
+        if (!$mount) {
1418
+            return [];
1419
+        }
1420
+        $storage = $mount->getStorage();
1421
+        $internalPath = $mount->getInternalPath($path);
1422
+        if ($storage) {
1423
+            $cache = $storage->getCache($internalPath);
1424
+            $user = \OC_User::getUser();
1425
+
1426
+            $data = $this->getCacheEntry($storage, $internalPath, $directory);
1427
+
1428
+            if (!$data instanceof ICacheEntry || !isset($data['fileid']) || !($data->getPermissions() && Constants::PERMISSION_READ)) {
1429
+                return [];
1430
+            }
1431
+
1432
+            $folderId = $data['fileid'];
1433
+            $contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
1434
+
1435
+            $sharingDisabled = \OCP\Util::isSharingDisabledForUser();
1436
+            /**
1437
+             * @var \OC\Files\FileInfo[] $files
1438
+             */
1439
+            $files = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
1440
+                if ($sharingDisabled) {
1441
+                    $content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
1442
+                }
1443
+                $owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
1444
+                return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
1445
+            }, $contents);
1446
+
1447
+            //add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
1448
+            $mounts = Filesystem::getMountManager()->findIn($path);
1449
+            $dirLength = strlen($path);
1450
+            foreach ($mounts as $mount) {
1451
+                $mountPoint = $mount->getMountPoint();
1452
+                $subStorage = $mount->getStorage();
1453
+                if ($subStorage) {
1454
+                    $subCache = $subStorage->getCache('');
1455
+
1456
+                    $rootEntry = $subCache->get('');
1457
+                    if (!$rootEntry) {
1458
+                        $subScanner = $subStorage->getScanner('');
1459
+                        try {
1460
+                            $subScanner->scanFile('');
1461
+                        } catch (\OCP\Files\StorageNotAvailableException $e) {
1462
+                            continue;
1463
+                        } catch (\OCP\Files\StorageInvalidException $e) {
1464
+                            continue;
1465
+                        } catch (\Exception $e) {
1466
+                            // sometimes when the storage is not available it can be any exception
1467
+                            \OCP\Util::writeLog(
1468
+                                'core',
1469
+                                'Exception while scanning storage "' . $subStorage->getId() . '": ' .
1470
+                                get_class($e) . ': ' . $e->getMessage(),
1471
+                                \OCP\Util::ERROR
1472
+                            );
1473
+                            continue;
1474
+                        }
1475
+                        $rootEntry = $subCache->get('');
1476
+                    }
1477
+
1478
+                    if ($rootEntry && ($rootEntry->getPermissions() && Constants::PERMISSION_READ)) {
1479
+                        $relativePath = trim(substr($mountPoint, $dirLength), '/');
1480
+                        if ($pos = strpos($relativePath, '/')) {
1481
+                            //mountpoint inside subfolder add size to the correct folder
1482
+                            $entryName = substr($relativePath, 0, $pos);
1483
+                            foreach ($files as &$entry) {
1484
+                                if ($entry->getName() === $entryName) {
1485
+                                    $entry->addSubEntry($rootEntry, $mountPoint);
1486
+                                }
1487
+                            }
1488
+                        } else { //mountpoint in this folder, add an entry for it
1489
+                            $rootEntry['name'] = $relativePath;
1490
+                            $rootEntry['type'] = $rootEntry['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file';
1491
+                            $permissions = $rootEntry['permissions'];
1492
+                            // do not allow renaming/deleting the mount point if they are not shared files/folders
1493
+                            // for shared files/folders we use the permissions given by the owner
1494
+                            if ($mount instanceof MoveableMount) {
1495
+                                $rootEntry['permissions'] = $permissions | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE;
1496
+                            } else {
1497
+                                $rootEntry['permissions'] = $permissions & (\OCP\Constants::PERMISSION_ALL - (\OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE));
1498
+                            }
1499
+
1500
+                            //remove any existing entry with the same name
1501
+                            foreach ($files as $i => $file) {
1502
+                                if ($file['name'] === $rootEntry['name']) {
1503
+                                    unset($files[$i]);
1504
+                                    break;
1505
+                                }
1506
+                            }
1507
+                            $rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
1508
+
1509
+                            // if sharing was disabled for the user we remove the share permissions
1510
+                            if (\OCP\Util::isSharingDisabledForUser()) {
1511
+                                $rootEntry['permissions'] = $rootEntry['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
1512
+                            }
1513
+
1514
+                            $owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
1515
+                            $files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
1516
+                        }
1517
+                    }
1518
+                }
1519
+            }
1520
+
1521
+            if ($mimetype_filter) {
1522
+                $files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) {
1523
+                    if (strpos($mimetype_filter, '/')) {
1524
+                        return $file->getMimetype() === $mimetype_filter;
1525
+                    } else {
1526
+                        return $file->getMimePart() === $mimetype_filter;
1527
+                    }
1528
+                });
1529
+            }
1530
+
1531
+            return $files;
1532
+        } else {
1533
+            return [];
1534
+        }
1535
+    }
1536
+
1537
+    /**
1538
+     * change file metadata
1539
+     *
1540
+     * @param string $path
1541
+     * @param array|\OCP\Files\FileInfo $data
1542
+     * @return int
1543
+     *
1544
+     * returns the fileid of the updated file
1545
+     */
1546
+    public function putFileInfo($path, $data) {
1547
+        $this->assertPathLength($path);
1548
+        if ($data instanceof FileInfo) {
1549
+            $data = $data->getData();
1550
+        }
1551
+        $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
1552
+        /**
1553
+         * @var \OC\Files\Storage\Storage $storage
1554
+         * @var string $internalPath
1555
+         */
1556
+        list($storage, $internalPath) = Filesystem::resolvePath($path);
1557
+        if ($storage) {
1558
+            $cache = $storage->getCache($path);
1559
+
1560
+            if (!$cache->inCache($internalPath)) {
1561
+                $scanner = $storage->getScanner($internalPath);
1562
+                $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
1563
+            }
1564
+
1565
+            return $cache->put($internalPath, $data);
1566
+        } else {
1567
+            return -1;
1568
+        }
1569
+    }
1570
+
1571
+    /**
1572
+     * search for files with the name matching $query
1573
+     *
1574
+     * @param string $query
1575
+     * @return FileInfo[]
1576
+     */
1577
+    public function search($query) {
1578
+        return $this->searchCommon('search', array('%' . $query . '%'));
1579
+    }
1580
+
1581
+    /**
1582
+     * search for files with the name matching $query
1583
+     *
1584
+     * @param string $query
1585
+     * @return FileInfo[]
1586
+     */
1587
+    public function searchRaw($query) {
1588
+        return $this->searchCommon('search', array($query));
1589
+    }
1590
+
1591
+    /**
1592
+     * search for files by mimetype
1593
+     *
1594
+     * @param string $mimetype
1595
+     * @return FileInfo[]
1596
+     */
1597
+    public function searchByMime($mimetype) {
1598
+        return $this->searchCommon('searchByMime', array($mimetype));
1599
+    }
1600
+
1601
+    /**
1602
+     * search for files by tag
1603
+     *
1604
+     * @param string|int $tag name or tag id
1605
+     * @param string $userId owner of the tags
1606
+     * @return FileInfo[]
1607
+     */
1608
+    public function searchByTag($tag, $userId) {
1609
+        return $this->searchCommon('searchByTag', array($tag, $userId));
1610
+    }
1611
+
1612
+    /**
1613
+     * @param string $method cache method
1614
+     * @param array $args
1615
+     * @return FileInfo[]
1616
+     */
1617
+    private function searchCommon($method, $args) {
1618
+        $files = array();
1619
+        $rootLength = strlen($this->fakeRoot);
1620
+
1621
+        $mount = $this->getMount('');
1622
+        $mountPoint = $mount->getMountPoint();
1623
+        $storage = $mount->getStorage();
1624
+        if ($storage) {
1625
+            $cache = $storage->getCache('');
1626
+
1627
+            $results = call_user_func_array(array($cache, $method), $args);
1628
+            foreach ($results as $result) {
1629
+                if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
1630
+                    $internalPath = $result['path'];
1631
+                    $path = $mountPoint . $result['path'];
1632
+                    $result['path'] = substr($mountPoint . $result['path'], $rootLength);
1633
+                    $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
1634
+                    $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
1635
+                }
1636
+            }
1637
+
1638
+            $mounts = Filesystem::getMountManager()->findIn($this->fakeRoot);
1639
+            foreach ($mounts as $mount) {
1640
+                $mountPoint = $mount->getMountPoint();
1641
+                $storage = $mount->getStorage();
1642
+                if ($storage) {
1643
+                    $cache = $storage->getCache('');
1644
+
1645
+                    $relativeMountPoint = substr($mountPoint, $rootLength);
1646
+                    $results = call_user_func_array(array($cache, $method), $args);
1647
+                    if ($results) {
1648
+                        foreach ($results as $result) {
1649
+                            $internalPath = $result['path'];
1650
+                            $result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
1651
+                            $path = rtrim($mountPoint . $internalPath, '/');
1652
+                            $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
1653
+                            $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
1654
+                        }
1655
+                    }
1656
+                }
1657
+            }
1658
+        }
1659
+        return $files;
1660
+    }
1661
+
1662
+    /**
1663
+     * Get the owner for a file or folder
1664
+     *
1665
+     * @param string $path
1666
+     * @return string the user id of the owner
1667
+     * @throws NotFoundException
1668
+     */
1669
+    public function getOwner($path) {
1670
+        $info = $this->getFileInfo($path);
1671
+        if (!$info) {
1672
+            throw new NotFoundException($path . ' not found while trying to get owner');
1673
+        }
1674
+        return $info->getOwner()->getUID();
1675
+    }
1676
+
1677
+    /**
1678
+     * get the ETag for a file or folder
1679
+     *
1680
+     * @param string $path
1681
+     * @return string
1682
+     */
1683
+    public function getETag($path) {
1684
+        /**
1685
+         * @var Storage\Storage $storage
1686
+         * @var string $internalPath
1687
+         */
1688
+        list($storage, $internalPath) = $this->resolvePath($path);
1689
+        if ($storage) {
1690
+            return $storage->getETag($internalPath);
1691
+        } else {
1692
+            return null;
1693
+        }
1694
+    }
1695
+
1696
+    /**
1697
+     * Get the path of a file by id, relative to the view
1698
+     *
1699
+     * Note that the resulting path is not guarantied to be unique for the id, multiple paths can point to the same file
1700
+     *
1701
+     * @param int $id
1702
+     * @throws NotFoundException
1703
+     * @return string
1704
+     */
1705
+    public function getPath($id) {
1706
+        $id = (int)$id;
1707
+        $manager = Filesystem::getMountManager();
1708
+        $mounts = $manager->findIn($this->fakeRoot);
1709
+        $mounts[] = $manager->find($this->fakeRoot);
1710
+        // reverse the array so we start with the storage this view is in
1711
+        // which is the most likely to contain the file we're looking for
1712
+        $mounts = array_reverse($mounts);
1713
+        foreach ($mounts as $mount) {
1714
+            /**
1715
+             * @var \OC\Files\Mount\MountPoint $mount
1716
+             */
1717
+            if ($mount->getStorage()) {
1718
+                $cache = $mount->getStorage()->getCache();
1719
+                $internalPath = $cache->getPathById($id);
1720
+                if (is_string($internalPath)) {
1721
+                    $fullPath = $mount->getMountPoint() . $internalPath;
1722
+                    if (!is_null($path = $this->getRelativePath($fullPath))) {
1723
+                        return $path;
1724
+                    }
1725
+                }
1726
+            }
1727
+        }
1728
+        throw new NotFoundException(sprintf('File with id "%s" has not been found.', $id));
1729
+    }
1730
+
1731
+    /**
1732
+     * @param string $path
1733
+     * @throws InvalidPathException
1734
+     */
1735
+    private function assertPathLength($path) {
1736
+        $maxLen = min(PHP_MAXPATHLEN, 4000);
1737
+        // Check for the string length - performed using isset() instead of strlen()
1738
+        // because isset() is about 5x-40x faster.
1739
+        if (isset($path[$maxLen])) {
1740
+            $pathLen = strlen($path);
1741
+            throw new \OCP\Files\InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
1742
+        }
1743
+    }
1744
+
1745
+    /**
1746
+     * check if it is allowed to move a mount point to a given target.
1747
+     * It is not allowed to move a mount point into a different mount point or
1748
+     * into an already shared folder
1749
+     *
1750
+     * @param string $target path
1751
+     * @return boolean
1752
+     */
1753
+    private function isTargetAllowed($target) {
1754
+
1755
+        list($targetStorage, $targetInternalPath) = \OC\Files\Filesystem::resolvePath($target);
1756
+        if (!$targetStorage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
1757
+            \OCP\Util::writeLog('files',
1758
+                'It is not allowed to move one mount point into another one',
1759
+                \OCP\Util::DEBUG);
1760
+            return false;
1761
+        }
1762
+
1763
+        // note: cannot use the view because the target is already locked
1764
+        $fileId = (int)$targetStorage->getCache()->getId($targetInternalPath);
1765
+        if ($fileId === -1) {
1766
+            // target might not exist, need to check parent instead
1767
+            $fileId = (int)$targetStorage->getCache()->getId(dirname($targetInternalPath));
1768
+        }
1769
+
1770
+        // check if any of the parents were shared by the current owner (include collections)
1771
+        $shares = \OCP\Share::getItemShared(
1772
+            'folder',
1773
+            $fileId,
1774
+            \OCP\Share::FORMAT_NONE,
1775
+            null,
1776
+            true
1777
+        );
1778
+
1779
+        if (count($shares) > 0) {
1780
+            \OCP\Util::writeLog('files',
1781
+                'It is not allowed to move one mount point into a shared folder',
1782
+                \OCP\Util::DEBUG);
1783
+            return false;
1784
+        }
1785
+
1786
+        return true;
1787
+    }
1788
+
1789
+    /**
1790
+     * Get a fileinfo object for files that are ignored in the cache (part files)
1791
+     *
1792
+     * @param string $path
1793
+     * @return \OCP\Files\FileInfo
1794
+     */
1795
+    private function getPartFileInfo($path) {
1796
+        $mount = $this->getMount($path);
1797
+        $storage = $mount->getStorage();
1798
+        $internalPath = $mount->getInternalPath($this->getAbsolutePath($path));
1799
+        $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
1800
+        return new FileInfo(
1801
+            $this->getAbsolutePath($path),
1802
+            $storage,
1803
+            $internalPath,
1804
+            [
1805
+                'fileid' => null,
1806
+                'mimetype' => $storage->getMimeType($internalPath),
1807
+                'name' => basename($path),
1808
+                'etag' => null,
1809
+                'size' => $storage->filesize($internalPath),
1810
+                'mtime' => $storage->filemtime($internalPath),
1811
+                'encrypted' => false,
1812
+                'permissions' => \OCP\Constants::PERMISSION_ALL
1813
+            ],
1814
+            $mount,
1815
+            $owner
1816
+        );
1817
+    }
1818
+
1819
+    /**
1820
+     * @param string $path
1821
+     * @param string $fileName
1822
+     * @throws InvalidPathException
1823
+     */
1824
+    public function verifyPath($path, $fileName) {
1825
+        try {
1826
+            /** @type \OCP\Files\Storage $storage */
1827
+            list($storage, $internalPath) = $this->resolvePath($path);
1828
+            $storage->verifyPath($internalPath, $fileName);
1829
+        } catch (ReservedWordException $ex) {
1830
+            $l = \OC::$server->getL10N('lib');
1831
+            throw new InvalidPathException($l->t('File name is a reserved word'));
1832
+        } catch (InvalidCharacterInPathException $ex) {
1833
+            $l = \OC::$server->getL10N('lib');
1834
+            throw new InvalidPathException($l->t('File name contains at least one invalid character'));
1835
+        } catch (FileNameTooLongException $ex) {
1836
+            $l = \OC::$server->getL10N('lib');
1837
+            throw new InvalidPathException($l->t('File name is too long'));
1838
+        } catch (InvalidDirectoryException $ex) {
1839
+            $l = \OC::$server->getL10N('lib');
1840
+            throw new InvalidPathException($l->t('Dot files are not allowed'));
1841
+        } catch (EmptyFileNameException $ex) {
1842
+            $l = \OC::$server->getL10N('lib');
1843
+            throw new InvalidPathException($l->t('Empty filename is not allowed'));
1844
+        }
1845
+    }
1846
+
1847
+    /**
1848
+     * get all parent folders of $path
1849
+     *
1850
+     * @param string $path
1851
+     * @return string[]
1852
+     */
1853
+    private function getParents($path) {
1854
+        $path = trim($path, '/');
1855
+        if (!$path) {
1856
+            return [];
1857
+        }
1858
+
1859
+        $parts = explode('/', $path);
1860
+
1861
+        // remove the single file
1862
+        array_pop($parts);
1863
+        $result = array('/');
1864
+        $resultPath = '';
1865
+        foreach ($parts as $part) {
1866
+            if ($part) {
1867
+                $resultPath .= '/' . $part;
1868
+                $result[] = $resultPath;
1869
+            }
1870
+        }
1871
+        return $result;
1872
+    }
1873
+
1874
+    /**
1875
+     * Returns the mount point for which to lock
1876
+     *
1877
+     * @param string $absolutePath absolute path
1878
+     * @param bool $useParentMount true to return parent mount instead of whatever
1879
+     * is mounted directly on the given path, false otherwise
1880
+     * @return \OC\Files\Mount\MountPoint mount point for which to apply locks
1881
+     */
1882
+    private function getMountForLock($absolutePath, $useParentMount = false) {
1883
+        $results = [];
1884
+        $mount = Filesystem::getMountManager()->find($absolutePath);
1885
+        if (!$mount) {
1886
+            return $results;
1887
+        }
1888
+
1889
+        if ($useParentMount) {
1890
+            // find out if something is mounted directly on the path
1891
+            $internalPath = $mount->getInternalPath($absolutePath);
1892
+            if ($internalPath === '') {
1893
+                // resolve the parent mount instead
1894
+                $mount = Filesystem::getMountManager()->find(dirname($absolutePath));
1895
+            }
1896
+        }
1897
+
1898
+        return $mount;
1899
+    }
1900
+
1901
+    /**
1902
+     * Lock the given path
1903
+     *
1904
+     * @param string $path the path of the file to lock, relative to the view
1905
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
1906
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
1907
+     *
1908
+     * @return bool False if the path is excluded from locking, true otherwise
1909
+     * @throws \OCP\Lock\LockedException if the path is already locked
1910
+     */
1911
+    private function lockPath($path, $type, $lockMountPoint = false) {
1912
+        $absolutePath = $this->getAbsolutePath($path);
1913
+        $absolutePath = Filesystem::normalizePath($absolutePath);
1914
+        if (!$this->shouldLockFile($absolutePath)) {
1915
+            return false;
1916
+        }
1917
+
1918
+        $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
1919
+        if ($mount) {
1920
+            try {
1921
+                $storage = $mount->getStorage();
1922
+                if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
1923
+                    $storage->acquireLock(
1924
+                        $mount->getInternalPath($absolutePath),
1925
+                        $type,
1926
+                        $this->lockingProvider
1927
+                    );
1928
+                }
1929
+            } catch (\OCP\Lock\LockedException $e) {
1930
+                // rethrow with the a human-readable path
1931
+                throw new \OCP\Lock\LockedException(
1932
+                    $this->getPathRelativeToFiles($absolutePath),
1933
+                    $e
1934
+                );
1935
+            }
1936
+        }
1937
+
1938
+        return true;
1939
+    }
1940
+
1941
+    /**
1942
+     * Change the lock type
1943
+     *
1944
+     * @param string $path the path of the file to lock, relative to the view
1945
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
1946
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
1947
+     *
1948
+     * @return bool False if the path is excluded from locking, true otherwise
1949
+     * @throws \OCP\Lock\LockedException if the path is already locked
1950
+     */
1951
+    public function changeLock($path, $type, $lockMountPoint = false) {
1952
+        $path = Filesystem::normalizePath($path);
1953
+        $absolutePath = $this->getAbsolutePath($path);
1954
+        $absolutePath = Filesystem::normalizePath($absolutePath);
1955
+        if (!$this->shouldLockFile($absolutePath)) {
1956
+            return false;
1957
+        }
1958
+
1959
+        $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
1960
+        if ($mount) {
1961
+            try {
1962
+                $storage = $mount->getStorage();
1963
+                if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
1964
+                    $storage->changeLock(
1965
+                        $mount->getInternalPath($absolutePath),
1966
+                        $type,
1967
+                        $this->lockingProvider
1968
+                    );
1969
+                }
1970
+            } catch (\OCP\Lock\LockedException $e) {
1971
+                try {
1972
+                    // rethrow with the a human-readable path
1973
+                    throw new \OCP\Lock\LockedException(
1974
+                        $this->getPathRelativeToFiles($absolutePath),
1975
+                        $e
1976
+                    );
1977
+                } catch (\InvalidArgumentException $e) {
1978
+                    throw new \OCP\Lock\LockedException(
1979
+                        $absolutePath,
1980
+                        $e
1981
+                    );
1982
+                }
1983
+            }
1984
+        }
1985
+
1986
+        return true;
1987
+    }
1988
+
1989
+    /**
1990
+     * Unlock the given path
1991
+     *
1992
+     * @param string $path the path of the file to unlock, relative to the view
1993
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
1994
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
1995
+     *
1996
+     * @return bool False if the path is excluded from locking, true otherwise
1997
+     */
1998
+    private function unlockPath($path, $type, $lockMountPoint = false) {
1999
+        $absolutePath = $this->getAbsolutePath($path);
2000
+        $absolutePath = Filesystem::normalizePath($absolutePath);
2001
+        if (!$this->shouldLockFile($absolutePath)) {
2002
+            return false;
2003
+        }
2004
+
2005
+        $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
2006
+        if ($mount) {
2007
+            $storage = $mount->getStorage();
2008
+            if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
2009
+                $storage->releaseLock(
2010
+                    $mount->getInternalPath($absolutePath),
2011
+                    $type,
2012
+                    $this->lockingProvider
2013
+                );
2014
+            }
2015
+        }
2016
+
2017
+        return true;
2018
+    }
2019
+
2020
+    /**
2021
+     * Lock a path and all its parents up to the root of the view
2022
+     *
2023
+     * @param string $path the path of the file to lock relative to the view
2024
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
2025
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
2026
+     *
2027
+     * @return bool False if the path is excluded from locking, true otherwise
2028
+     */
2029
+    public function lockFile($path, $type, $lockMountPoint = false) {
2030
+        $absolutePath = $this->getAbsolutePath($path);
2031
+        $absolutePath = Filesystem::normalizePath($absolutePath);
2032
+        if (!$this->shouldLockFile($absolutePath)) {
2033
+            return false;
2034
+        }
2035
+
2036
+        $this->lockPath($path, $type, $lockMountPoint);
2037
+
2038
+        $parents = $this->getParents($path);
2039
+        foreach ($parents as $parent) {
2040
+            $this->lockPath($parent, ILockingProvider::LOCK_SHARED);
2041
+        }
2042
+
2043
+        return true;
2044
+    }
2045
+
2046
+    /**
2047
+     * Unlock a path and all its parents up to the root of the view
2048
+     *
2049
+     * @param string $path the path of the file to lock relative to the view
2050
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
2051
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
2052
+     *
2053
+     * @return bool False if the path is excluded from locking, true otherwise
2054
+     */
2055
+    public function unlockFile($path, $type, $lockMountPoint = false) {
2056
+        $absolutePath = $this->getAbsolutePath($path);
2057
+        $absolutePath = Filesystem::normalizePath($absolutePath);
2058
+        if (!$this->shouldLockFile($absolutePath)) {
2059
+            return false;
2060
+        }
2061
+
2062
+        $this->unlockPath($path, $type, $lockMountPoint);
2063
+
2064
+        $parents = $this->getParents($path);
2065
+        foreach ($parents as $parent) {
2066
+            $this->unlockPath($parent, ILockingProvider::LOCK_SHARED);
2067
+        }
2068
+
2069
+        return true;
2070
+    }
2071
+
2072
+    /**
2073
+     * Only lock files in data/user/files/
2074
+     *
2075
+     * @param string $path Absolute path to the file/folder we try to (un)lock
2076
+     * @return bool
2077
+     */
2078
+    protected function shouldLockFile($path) {
2079
+        $path = Filesystem::normalizePath($path);
2080
+
2081
+        $pathSegments = explode('/', $path);
2082
+        if (isset($pathSegments[2])) {
2083
+            // E.g.: /username/files/path-to-file
2084
+            return ($pathSegments[2] === 'files') && (count($pathSegments) > 3);
2085
+        }
2086
+
2087
+        return strpos($path, '/appdata_') !== 0;
2088
+    }
2089
+
2090
+    /**
2091
+     * Shortens the given absolute path to be relative to
2092
+     * "$user/files".
2093
+     *
2094
+     * @param string $absolutePath absolute path which is under "files"
2095
+     *
2096
+     * @return string path relative to "files" with trimmed slashes or null
2097
+     * if the path was NOT relative to files
2098
+     *
2099
+     * @throws \InvalidArgumentException if the given path was not under "files"
2100
+     * @since 8.1.0
2101
+     */
2102
+    public function getPathRelativeToFiles($absolutePath) {
2103
+        $path = Filesystem::normalizePath($absolutePath);
2104
+        $parts = explode('/', trim($path, '/'), 3);
2105
+        // "$user", "files", "path/to/dir"
2106
+        if (!isset($parts[1]) || $parts[1] !== 'files') {
2107
+            $this->logger->error(
2108
+                '$absolutePath must be relative to "files", value is "%s"',
2109
+                [
2110
+                    $absolutePath
2111
+                ]
2112
+            );
2113
+            throw new \InvalidArgumentException('$absolutePath must be relative to "files"');
2114
+        }
2115
+        if (isset($parts[2])) {
2116
+            return $parts[2];
2117
+        }
2118
+        return '';
2119
+    }
2120
+
2121
+    /**
2122
+     * @param string $filename
2123
+     * @return array
2124
+     * @throws \OC\User\NoUserException
2125
+     * @throws NotFoundException
2126
+     */
2127
+    public function getUidAndFilename($filename) {
2128
+        $info = $this->getFileInfo($filename);
2129
+        if (!$info instanceof \OCP\Files\FileInfo) {
2130
+            throw new NotFoundException($this->getAbsolutePath($filename) . ' not found');
2131
+        }
2132
+        $uid = $info->getOwner()->getUID();
2133
+        if ($uid != \OCP\User::getUser()) {
2134
+            Filesystem::initMountPoints($uid);
2135
+            $ownerView = new View('/' . $uid . '/files');
2136
+            try {
2137
+                $filename = $ownerView->getPath($info['fileid']);
2138
+            } catch (NotFoundException $e) {
2139
+                throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid);
2140
+            }
2141
+        }
2142
+        return [$uid, $filename];
2143
+    }
2144
+
2145
+    /**
2146
+     * Creates parent non-existing folders
2147
+     *
2148
+     * @param string $filePath
2149
+     * @return bool
2150
+     */
2151
+    private function createParentDirectories($filePath) {
2152
+        $directoryParts = explode('/', $filePath);
2153
+        $directoryParts = array_filter($directoryParts);
2154
+        foreach ($directoryParts as $key => $part) {
2155
+            $currentPathElements = array_slice($directoryParts, 0, $key);
2156
+            $currentPath = '/' . implode('/', $currentPathElements);
2157
+            if ($this->is_file($currentPath)) {
2158
+                return false;
2159
+            }
2160
+            if (!$this->file_exists($currentPath)) {
2161
+                $this->mkdir($currentPath);
2162
+            }
2163
+        }
2164
+
2165
+        return true;
2166
+    }
2167 2167
 }
Please login to merge, or discard this patch.
Spacing   +41 added lines, -41 removed lines patch added patch discarded remove patch
@@ -126,9 +126,9 @@  discard block
 block discarded – undo
126 126
 			$path = '/';
127 127
 		}
128 128
 		if ($path[0] !== '/') {
129
-			$path = '/' . $path;
129
+			$path = '/'.$path;
130 130
 		}
131
-		return $this->fakeRoot . $path;
131
+		return $this->fakeRoot.$path;
132 132
 	}
133 133
 
134 134
 	/**
@@ -140,7 +140,7 @@  discard block
 block discarded – undo
140 140
 	public function chroot($fakeRoot) {
141 141
 		if (!$fakeRoot == '') {
142 142
 			if ($fakeRoot[0] !== '/') {
143
-				$fakeRoot = '/' . $fakeRoot;
143
+				$fakeRoot = '/'.$fakeRoot;
144 144
 			}
145 145
 		}
146 146
 		$this->fakeRoot = $fakeRoot;
@@ -172,7 +172,7 @@  discard block
 block discarded – undo
172 172
 		}
173 173
 
174 174
 		// missing slashes can cause wrong matches!
175
-		$root = rtrim($this->fakeRoot, '/') . '/';
175
+		$root = rtrim($this->fakeRoot, '/').'/';
176 176
 
177 177
 		if (strpos($path, $root) !== 0) {
178 178
 			return null;
@@ -278,7 +278,7 @@  discard block
 block discarded – undo
278 278
 		if ($mount instanceof MoveableMount) {
279 279
 			// cut of /user/files to get the relative path to data/user/files
280 280
 			$pathParts = explode('/', $path, 4);
281
-			$relPath = '/' . $pathParts[3];
281
+			$relPath = '/'.$pathParts[3];
282 282
 			$this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true);
283 283
 			\OC_Hook::emit(
284 284
 				Filesystem::CLASSNAME, "umount",
@@ -700,7 +700,7 @@  discard block
 block discarded – undo
700 700
 		}
701 701
 		$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
702 702
 		$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
703
-		$mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
703
+		$mount = Filesystem::getMountManager()->find($absolutePath.$postFix);
704 704
 		if ($mount and $mount->getInternalPath($absolutePath) === '') {
705 705
 			return $this->removeMount($mount, $absolutePath);
706 706
 		}
@@ -820,7 +820,7 @@  discard block
 block discarded – undo
820 820
 								$this->renameUpdate($storage1, $storage2, $internalPath1, $internalPath2);
821 821
 							}
822 822
 						}
823
-					} catch(\Exception $e) {
823
+					} catch (\Exception $e) {
824 824
 						throw $e;
825 825
 					} finally {
826 826
 						$this->changeLock($path1, ILockingProvider::LOCK_SHARED, true);
@@ -844,7 +844,7 @@  discard block
 block discarded – undo
844 844
 						}
845 845
 					}
846 846
 				}
847
-			} catch(\Exception $e) {
847
+			} catch (\Exception $e) {
848 848
 				throw $e;
849 849
 			} finally {
850 850
 				$this->unlockFile($path1, ILockingProvider::LOCK_SHARED, true);
@@ -977,7 +977,7 @@  discard block
 block discarded – undo
977 977
 				$hooks[] = 'write';
978 978
 				break;
979 979
 			default:
980
-				\OCP\Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, \OCP\Util::ERROR);
980
+				\OCP\Util::writeLog('core', 'invalid mode ('.$mode.') for '.$path, \OCP\Util::ERROR);
981 981
 		}
982 982
 
983 983
 		if ($mode !== 'r' && $mode !== 'w') {
@@ -1081,7 +1081,7 @@  discard block
 block discarded – undo
1081 1081
 					array(Filesystem::signal_param_path => $this->getHookPath($path))
1082 1082
 				);
1083 1083
 			}
1084
-			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
1084
+			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath.$postFix);
1085 1085
 			if ($storage) {
1086 1086
 				$result = $storage->hash($type, $internalPath, $raw);
1087 1087
 				return $result;
@@ -1136,7 +1136,7 @@  discard block
 block discarded – undo
1136 1136
 
1137 1137
 			$run = $this->runHooks($hooks, $path);
1138 1138
 			/** @var \OC\Files\Storage\Storage $storage */
1139
-			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
1139
+			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath.$postFix);
1140 1140
 			if ($run and $storage) {
1141 1141
 				if (in_array('write', $hooks) || in_array('delete', $hooks)) {
1142 1142
 					$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
@@ -1175,7 +1175,7 @@  discard block
 block discarded – undo
1175 1175
 					$unlockLater = true;
1176 1176
 					// make sure our unlocking callback will still be called if connection is aborted
1177 1177
 					ignore_user_abort(true);
1178
-					$result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) {
1178
+					$result = CallbackWrapper::wrap($result, null, null, function() use ($hooks, $path) {
1179 1179
 						if (in_array('write', $hooks)) {
1180 1180
 							$this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
1181 1181
 						} else if (in_array('read', $hooks)) {
@@ -1236,7 +1236,7 @@  discard block
 block discarded – undo
1236 1236
 			return true;
1237 1237
 		}
1238 1238
 
1239
-		return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
1239
+		return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot.'/');
1240 1240
 	}
1241 1241
 
1242 1242
 	/**
@@ -1255,7 +1255,7 @@  discard block
 block discarded – undo
1255 1255
 				if ($hook != 'read') {
1256 1256
 					\OC_Hook::emit(
1257 1257
 						Filesystem::CLASSNAME,
1258
-						$prefix . $hook,
1258
+						$prefix.$hook,
1259 1259
 						array(
1260 1260
 							Filesystem::signal_param_run => &$run,
1261 1261
 							Filesystem::signal_param_path => $path
@@ -1264,7 +1264,7 @@  discard block
 block discarded – undo
1264 1264
 				} elseif (!$post) {
1265 1265
 					\OC_Hook::emit(
1266 1266
 						Filesystem::CLASSNAME,
1267
-						$prefix . $hook,
1267
+						$prefix.$hook,
1268 1268
 						array(
1269 1269
 							Filesystem::signal_param_path => $path
1270 1270
 						)
@@ -1359,7 +1359,7 @@  discard block
 block discarded – undo
1359 1359
 			return $this->getPartFileInfo($path);
1360 1360
 		}
1361 1361
 		$relativePath = $path;
1362
-		$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
1362
+		$path = Filesystem::normalizePath($this->fakeRoot.'/'.$path);
1363 1363
 
1364 1364
 		$mount = Filesystem::getMountManager()->find($path);
1365 1365
 		if (!$mount) {
@@ -1386,7 +1386,7 @@  discard block
 block discarded – undo
1386 1386
 					//add the sizes of other mount points to the folder
1387 1387
 					$extOnly = ($includeMountPoints === 'ext');
1388 1388
 					$mounts = Filesystem::getMountManager()->findIn($path);
1389
-					$info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) {
1389
+					$info->setSubMounts(array_filter($mounts, function(IMountPoint $mount) use ($extOnly) {
1390 1390
 						$subStorage = $mount->getStorage();
1391 1391
 						return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage);
1392 1392
 					}));
@@ -1436,12 +1436,12 @@  discard block
 block discarded – undo
1436 1436
 			/**
1437 1437
 			 * @var \OC\Files\FileInfo[] $files
1438 1438
 			 */
1439
-			$files = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
1439
+			$files = array_map(function(ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
1440 1440
 				if ($sharingDisabled) {
1441 1441
 					$content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
1442 1442
 				}
1443 1443
 				$owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
1444
-				return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
1444
+				return new FileInfo($path.'/'.$content['name'], $storage, $content['path'], $content, $mount, $owner);
1445 1445
 			}, $contents);
1446 1446
 
1447 1447
 			//add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
@@ -1466,8 +1466,8 @@  discard block
 block discarded – undo
1466 1466
 							// sometimes when the storage is not available it can be any exception
1467 1467
 							\OCP\Util::writeLog(
1468 1468
 								'core',
1469
-								'Exception while scanning storage "' . $subStorage->getId() . '": ' .
1470
-								get_class($e) . ': ' . $e->getMessage(),
1469
+								'Exception while scanning storage "'.$subStorage->getId().'": '.
1470
+								get_class($e).': '.$e->getMessage(),
1471 1471
 								\OCP\Util::ERROR
1472 1472
 							);
1473 1473
 							continue;
@@ -1504,7 +1504,7 @@  discard block
 block discarded – undo
1504 1504
 									break;
1505 1505
 								}
1506 1506
 							}
1507
-							$rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
1507
+							$rootEntry['path'] = substr(Filesystem::normalizePath($path.'/'.$rootEntry['name']), strlen($user) + 2); // full path without /$user/
1508 1508
 
1509 1509
 							// if sharing was disabled for the user we remove the share permissions
1510 1510
 							if (\OCP\Util::isSharingDisabledForUser()) {
@@ -1512,14 +1512,14 @@  discard block
 block discarded – undo
1512 1512
 							}
1513 1513
 
1514 1514
 							$owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
1515
-							$files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
1515
+							$files[] = new FileInfo($path.'/'.$rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
1516 1516
 						}
1517 1517
 					}
1518 1518
 				}
1519 1519
 			}
1520 1520
 
1521 1521
 			if ($mimetype_filter) {
1522
-				$files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) {
1522
+				$files = array_filter($files, function(FileInfo $file) use ($mimetype_filter) {
1523 1523
 					if (strpos($mimetype_filter, '/')) {
1524 1524
 						return $file->getMimetype() === $mimetype_filter;
1525 1525
 					} else {
@@ -1548,7 +1548,7 @@  discard block
 block discarded – undo
1548 1548
 		if ($data instanceof FileInfo) {
1549 1549
 			$data = $data->getData();
1550 1550
 		}
1551
-		$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
1551
+		$path = Filesystem::normalizePath($this->fakeRoot.'/'.$path);
1552 1552
 		/**
1553 1553
 		 * @var \OC\Files\Storage\Storage $storage
1554 1554
 		 * @var string $internalPath
@@ -1575,7 +1575,7 @@  discard block
 block discarded – undo
1575 1575
 	 * @return FileInfo[]
1576 1576
 	 */
1577 1577
 	public function search($query) {
1578
-		return $this->searchCommon('search', array('%' . $query . '%'));
1578
+		return $this->searchCommon('search', array('%'.$query.'%'));
1579 1579
 	}
1580 1580
 
1581 1581
 	/**
@@ -1626,10 +1626,10 @@  discard block
 block discarded – undo
1626 1626
 
1627 1627
 			$results = call_user_func_array(array($cache, $method), $args);
1628 1628
 			foreach ($results as $result) {
1629
-				if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
1629
+				if (substr($mountPoint.$result['path'], 0, $rootLength + 1) === $this->fakeRoot.'/') {
1630 1630
 					$internalPath = $result['path'];
1631
-					$path = $mountPoint . $result['path'];
1632
-					$result['path'] = substr($mountPoint . $result['path'], $rootLength);
1631
+					$path = $mountPoint.$result['path'];
1632
+					$result['path'] = substr($mountPoint.$result['path'], $rootLength);
1633 1633
 					$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
1634 1634
 					$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
1635 1635
 				}
@@ -1647,8 +1647,8 @@  discard block
 block discarded – undo
1647 1647
 					if ($results) {
1648 1648
 						foreach ($results as $result) {
1649 1649
 							$internalPath = $result['path'];
1650
-							$result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
1651
-							$path = rtrim($mountPoint . $internalPath, '/');
1650
+							$result['path'] = rtrim($relativeMountPoint.$result['path'], '/');
1651
+							$path = rtrim($mountPoint.$internalPath, '/');
1652 1652
 							$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
1653 1653
 							$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
1654 1654
 						}
@@ -1669,7 +1669,7 @@  discard block
 block discarded – undo
1669 1669
 	public function getOwner($path) {
1670 1670
 		$info = $this->getFileInfo($path);
1671 1671
 		if (!$info) {
1672
-			throw new NotFoundException($path . ' not found while trying to get owner');
1672
+			throw new NotFoundException($path.' not found while trying to get owner');
1673 1673
 		}
1674 1674
 		return $info->getOwner()->getUID();
1675 1675
 	}
@@ -1703,7 +1703,7 @@  discard block
 block discarded – undo
1703 1703
 	 * @return string
1704 1704
 	 */
1705 1705
 	public function getPath($id) {
1706
-		$id = (int)$id;
1706
+		$id = (int) $id;
1707 1707
 		$manager = Filesystem::getMountManager();
1708 1708
 		$mounts = $manager->findIn($this->fakeRoot);
1709 1709
 		$mounts[] = $manager->find($this->fakeRoot);
@@ -1718,7 +1718,7 @@  discard block
 block discarded – undo
1718 1718
 				$cache = $mount->getStorage()->getCache();
1719 1719
 				$internalPath = $cache->getPathById($id);
1720 1720
 				if (is_string($internalPath)) {
1721
-					$fullPath = $mount->getMountPoint() . $internalPath;
1721
+					$fullPath = $mount->getMountPoint().$internalPath;
1722 1722
 					if (!is_null($path = $this->getRelativePath($fullPath))) {
1723 1723
 						return $path;
1724 1724
 					}
@@ -1761,10 +1761,10 @@  discard block
 block discarded – undo
1761 1761
 		}
1762 1762
 
1763 1763
 		// note: cannot use the view because the target is already locked
1764
-		$fileId = (int)$targetStorage->getCache()->getId($targetInternalPath);
1764
+		$fileId = (int) $targetStorage->getCache()->getId($targetInternalPath);
1765 1765
 		if ($fileId === -1) {
1766 1766
 			// target might not exist, need to check parent instead
1767
-			$fileId = (int)$targetStorage->getCache()->getId(dirname($targetInternalPath));
1767
+			$fileId = (int) $targetStorage->getCache()->getId(dirname($targetInternalPath));
1768 1768
 		}
1769 1769
 
1770 1770
 		// check if any of the parents were shared by the current owner (include collections)
@@ -1864,7 +1864,7 @@  discard block
 block discarded – undo
1864 1864
 		$resultPath = '';
1865 1865
 		foreach ($parts as $part) {
1866 1866
 			if ($part) {
1867
-				$resultPath .= '/' . $part;
1867
+				$resultPath .= '/'.$part;
1868 1868
 				$result[] = $resultPath;
1869 1869
 			}
1870 1870
 		}
@@ -2127,16 +2127,16 @@  discard block
 block discarded – undo
2127 2127
 	public function getUidAndFilename($filename) {
2128 2128
 		$info = $this->getFileInfo($filename);
2129 2129
 		if (!$info instanceof \OCP\Files\FileInfo) {
2130
-			throw new NotFoundException($this->getAbsolutePath($filename) . ' not found');
2130
+			throw new NotFoundException($this->getAbsolutePath($filename).' not found');
2131 2131
 		}
2132 2132
 		$uid = $info->getOwner()->getUID();
2133 2133
 		if ($uid != \OCP\User::getUser()) {
2134 2134
 			Filesystem::initMountPoints($uid);
2135
-			$ownerView = new View('/' . $uid . '/files');
2135
+			$ownerView = new View('/'.$uid.'/files');
2136 2136
 			try {
2137 2137
 				$filename = $ownerView->getPath($info['fileid']);
2138 2138
 			} catch (NotFoundException $e) {
2139
-				throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid);
2139
+				throw new NotFoundException('File with id '.$info['fileid'].' not found for user '.$uid);
2140 2140
 			}
2141 2141
 		}
2142 2142
 		return [$uid, $filename];
@@ -2153,7 +2153,7 @@  discard block
 block discarded – undo
2153 2153
 		$directoryParts = array_filter($directoryParts);
2154 2154
 		foreach ($directoryParts as $key => $part) {
2155 2155
 			$currentPathElements = array_slice($directoryParts, 0, $key);
2156
-			$currentPath = '/' . implode('/', $currentPathElements);
2156
+			$currentPath = '/'.implode('/', $currentPathElements);
2157 2157
 			if ($this->is_file($currentPath)) {
2158 2158
 				return false;
2159 2159
 			}
Please login to merge, or discard this patch.
apps/files_sharing/lib/Helper.php 3 patches
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -303,6 +303,7 @@
 block discarded – undo
303 303
 	 * get default share folder
304 304
 	 *
305 305
 	 * @param \OC\Files\View
306
+	 * @param View $view
306 307
 	 * @return string
307 308
 	 */
308 309
 	public static function getShareFolder($view = null) {
Please login to merge, or discard this patch.
Indentation   +237 added lines, -237 removed lines patch added patch discarded remove patch
@@ -36,242 +36,242 @@
 block discarded – undo
36 36
 
37 37
 class Helper {
38 38
 
39
-	public static function registerHooks() {
40
-		\OCP\Util::connectHook('OC_Filesystem', 'post_rename', '\OCA\Files_Sharing\Updater', 'renameHook');
41
-		\OCP\Util::connectHook('OC_Filesystem', 'post_delete', '\OCA\Files_Sharing\Hooks', 'unshareChildren');
42
-
43
-		\OCP\Util::connectHook('OC_User', 'post_deleteUser', '\OCA\Files_Sharing\Hooks', 'deleteUser');
44
-	}
45
-
46
-	/**
47
-	 * Sets up the filesystem and user for public sharing
48
-	 * @param string $token string share token
49
-	 * @param string $relativePath optional path relative to the share
50
-	 * @param string $password optional password
51
-	 * @return array
52
-	 */
53
-	public static function setupFromToken($token, $relativePath = null, $password = null) {
54
-		\OC_User::setIncognitoMode(true);
55
-
56
-		$shareManager = \OC::$server->getShareManager();
57
-
58
-		try {
59
-			$share = $shareManager->getShareByToken($token);
60
-		} catch (ShareNotFound $e) {
61
-			\OC_Response::setStatus(404);
62
-			\OCP\Util::writeLog('core-preview', 'Passed token parameter is not valid', \OCP\Util::DEBUG);
63
-			exit;
64
-		}
65
-
66
-		\OCP\JSON::checkUserExists($share->getShareOwner());
67
-		\OC_Util::tearDownFS();
68
-		\OC_Util::setupFS($share->getShareOwner());
69
-
70
-
71
-		try {
72
-			$path = Filesystem::getPath($share->getNodeId());
73
-		} catch (NotFoundException $e) {
74
-			\OCP\Util::writeLog('share', 'could not resolve linkItem', \OCP\Util::DEBUG);
75
-			\OC_Response::setStatus(404);
76
-			\OCP\JSON::error(array('success' => false));
77
-			exit();
78
-		}
79
-
80
-		if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK && $share->getPassword() !== null) {
81
-			if (!self::authenticate($share, $password)) {
82
-				\OC_Response::setStatus(403);
83
-				\OCP\JSON::error(array('success' => false));
84
-				exit();
85
-			}
86
-		}
87
-
88
-		$basePath = $path;
89
-
90
-		if ($relativePath !== null && Filesystem::isReadable($basePath . $relativePath)) {
91
-			$path .= Filesystem::normalizePath($relativePath);
92
-		}
93
-
94
-		return array(
95
-			'share' => $share,
96
-			'basePath' => $basePath,
97
-			'realPath' => $path
98
-		);
99
-	}
100
-
101
-	/**
102
-	 * Authenticate link item with the given password
103
-	 * or with the session if no password was given.
104
-	 * @param \OCP\Share\IShare $share
105
-	 * @param string $password optional password
106
-	 *
107
-	 * @return boolean true if authorized, false otherwise
108
-	 */
109
-	public static function authenticate($share, $password = null) {
110
-		$shareManager = \OC::$server->getShareManager();
111
-
112
-		if ($password !== null) {
113
-			if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
114
-				if ($shareManager->checkPassword($share, $password)) {
115
-					\OC::$server->getSession()->set('public_link_authenticated', (string)$share->getId());
116
-					return true;
117
-				}
118
-			}
119
-		} else {
120
-			// not authenticated ?
121
-			if (\OC::$server->getSession()->exists('public_link_authenticated')
122
-				&& \OC::$server->getSession()->get('public_link_authenticated') !== (string)$share->getId()) {
123
-				return true;
124
-			}
125
-		}
126
-		return false;
127
-	}
128
-
129
-	public static function getSharesFromItem($target) {
130
-		$result = array();
131
-		$owner = Filesystem::getOwner($target);
132
-		Filesystem::initMountPoints($owner);
133
-		$info = Filesystem::getFileInfo($target);
134
-		$ownerView = new View('/'.$owner.'/files');
135
-		if ( $owner !== User::getUser() ) {
136
-			$path = $ownerView->getPath($info['fileid']);
137
-		} else {
138
-			$path = $target;
139
-		}
140
-
141
-
142
-		$ids = array();
143
-		while ($path !== dirname($path)) {
144
-			$info = $ownerView->getFileInfo($path);
145
-			if ($info instanceof \OC\Files\FileInfo) {
146
-				$ids[] = $info['fileid'];
147
-			} else {
148
-				\OCP\Util::writeLog('sharing', 'No fileinfo available for: ' . $path, \OCP\Util::WARN);
149
-			}
150
-			$path = dirname($path);
151
-		}
152
-
153
-		if (!empty($ids)) {
154
-
155
-			$idList = array_chunk($ids, 99, true);
156
-
157
-			foreach ($idList as $subList) {
158
-				$statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (" . implode(',', $subList) . ") AND `share_type` IN (0, 1, 2)";
159
-				$query = \OCP\DB::prepare($statement);
160
-				$r = $query->execute();
161
-				$result = array_merge($result, $r->fetchAll());
162
-			}
163
-		}
164
-
165
-		return $result;
166
-	}
167
-
168
-	/**
169
-	 * get the UID of the owner of the file and the path to the file relative to
170
-	 * owners files folder
171
-	 *
172
-	 * @param $filename
173
-	 * @return array
174
-	 * @throws \OC\User\NoUserException
175
-	 */
176
-	public static function getUidAndFilename($filename) {
177
-		$uid = Filesystem::getOwner($filename);
178
-		$userManager = \OC::$server->getUserManager();
179
-		// if the user with the UID doesn't exists, e.g. because the UID points
180
-		// to a remote user with a federated cloud ID we use the current logged-in
181
-		// user. We need a valid local user to create the share
182
-		if (!$userManager->userExists($uid)) {
183
-			$uid = User::getUser();
184
-		}
185
-		Filesystem::initMountPoints($uid);
186
-		if ( $uid !== User::getUser() ) {
187
-			$info = Filesystem::getFileInfo($filename);
188
-			$ownerView = new View('/'.$uid.'/files');
189
-			try {
190
-				$filename = $ownerView->getPath($info['fileid']);
191
-			} catch (NotFoundException $e) {
192
-				$filename = null;
193
-			}
194
-		}
195
-		return [$uid, $filename];
196
-	}
197
-
198
-	/**
199
-	 * Format a path to be relative to the /user/files/ directory
200
-	 * @param string $path the absolute path
201
-	 * @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
202
-	 */
203
-	public static function stripUserFilesPath($path) {
204
-		$trimmed = ltrim($path, '/');
205
-		$split = explode('/', $trimmed);
206
-
207
-		// it is not a file relative to data/user/files
208
-		if (count($split) < 3 || $split[1] !== 'files') {
209
-			return false;
210
-		}
211
-
212
-		$sliced = array_slice($split, 2);
213
-		$relPath = implode('/', $sliced);
214
-
215
-		return $relPath;
216
-	}
217
-
218
-	/**
219
-	 * check if file name already exists and generate unique target
220
-	 *
221
-	 * @param string $path
222
-	 * @param array $excludeList
223
-	 * @param View $view
224
-	 * @return string $path
225
-	 */
226
-	public static function generateUniqueTarget($path, $excludeList, $view) {
227
-		$pathinfo = pathinfo($path);
228
-		$ext = (isset($pathinfo['extension'])) ? '.'.$pathinfo['extension'] : '';
229
-		$name = $pathinfo['filename'];
230
-		$dir = $pathinfo['dirname'];
231
-		$i = 2;
232
-		while ($view->file_exists($path) || in_array($path, $excludeList)) {
233
-			$path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
234
-			$i++;
235
-		}
236
-
237
-		return $path;
238
-	}
239
-
240
-	/**
241
-	 * get default share folder
242
-	 *
243
-	 * @param \OC\Files\View
244
-	 * @return string
245
-	 */
246
-	public static function getShareFolder($view = null) {
247
-		if ($view === null) {
248
-			$view = Filesystem::getView();
249
-		}
250
-		$shareFolder = \OC::$server->getConfig()->getSystemValue('share_folder', '/');
251
-		$shareFolder = Filesystem::normalizePath($shareFolder);
252
-
253
-		if (!$view->file_exists($shareFolder)) {
254
-			$dir = '';
255
-			$subdirs = explode('/', $shareFolder);
256
-			foreach ($subdirs as $subdir) {
257
-				$dir = $dir . '/' . $subdir;
258
-				if (!$view->is_dir($dir)) {
259
-					$view->mkdir($dir);
260
-				}
261
-			}
262
-		}
263
-
264
-		return $shareFolder;
265
-
266
-	}
267
-
268
-	/**
269
-	 * set default share folder
270
-	 *
271
-	 * @param string $shareFolder
272
-	 */
273
-	public static function setShareFolder($shareFolder) {
274
-		\OC::$server->getConfig()->setSystemValue('share_folder', $shareFolder);
275
-	}
39
+    public static function registerHooks() {
40
+        \OCP\Util::connectHook('OC_Filesystem', 'post_rename', '\OCA\Files_Sharing\Updater', 'renameHook');
41
+        \OCP\Util::connectHook('OC_Filesystem', 'post_delete', '\OCA\Files_Sharing\Hooks', 'unshareChildren');
42
+
43
+        \OCP\Util::connectHook('OC_User', 'post_deleteUser', '\OCA\Files_Sharing\Hooks', 'deleteUser');
44
+    }
45
+
46
+    /**
47
+     * Sets up the filesystem and user for public sharing
48
+     * @param string $token string share token
49
+     * @param string $relativePath optional path relative to the share
50
+     * @param string $password optional password
51
+     * @return array
52
+     */
53
+    public static function setupFromToken($token, $relativePath = null, $password = null) {
54
+        \OC_User::setIncognitoMode(true);
55
+
56
+        $shareManager = \OC::$server->getShareManager();
57
+
58
+        try {
59
+            $share = $shareManager->getShareByToken($token);
60
+        } catch (ShareNotFound $e) {
61
+            \OC_Response::setStatus(404);
62
+            \OCP\Util::writeLog('core-preview', 'Passed token parameter is not valid', \OCP\Util::DEBUG);
63
+            exit;
64
+        }
65
+
66
+        \OCP\JSON::checkUserExists($share->getShareOwner());
67
+        \OC_Util::tearDownFS();
68
+        \OC_Util::setupFS($share->getShareOwner());
69
+
70
+
71
+        try {
72
+            $path = Filesystem::getPath($share->getNodeId());
73
+        } catch (NotFoundException $e) {
74
+            \OCP\Util::writeLog('share', 'could not resolve linkItem', \OCP\Util::DEBUG);
75
+            \OC_Response::setStatus(404);
76
+            \OCP\JSON::error(array('success' => false));
77
+            exit();
78
+        }
79
+
80
+        if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK && $share->getPassword() !== null) {
81
+            if (!self::authenticate($share, $password)) {
82
+                \OC_Response::setStatus(403);
83
+                \OCP\JSON::error(array('success' => false));
84
+                exit();
85
+            }
86
+        }
87
+
88
+        $basePath = $path;
89
+
90
+        if ($relativePath !== null && Filesystem::isReadable($basePath . $relativePath)) {
91
+            $path .= Filesystem::normalizePath($relativePath);
92
+        }
93
+
94
+        return array(
95
+            'share' => $share,
96
+            'basePath' => $basePath,
97
+            'realPath' => $path
98
+        );
99
+    }
100
+
101
+    /**
102
+     * Authenticate link item with the given password
103
+     * or with the session if no password was given.
104
+     * @param \OCP\Share\IShare $share
105
+     * @param string $password optional password
106
+     *
107
+     * @return boolean true if authorized, false otherwise
108
+     */
109
+    public static function authenticate($share, $password = null) {
110
+        $shareManager = \OC::$server->getShareManager();
111
+
112
+        if ($password !== null) {
113
+            if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
114
+                if ($shareManager->checkPassword($share, $password)) {
115
+                    \OC::$server->getSession()->set('public_link_authenticated', (string)$share->getId());
116
+                    return true;
117
+                }
118
+            }
119
+        } else {
120
+            // not authenticated ?
121
+            if (\OC::$server->getSession()->exists('public_link_authenticated')
122
+                && \OC::$server->getSession()->get('public_link_authenticated') !== (string)$share->getId()) {
123
+                return true;
124
+            }
125
+        }
126
+        return false;
127
+    }
128
+
129
+    public static function getSharesFromItem($target) {
130
+        $result = array();
131
+        $owner = Filesystem::getOwner($target);
132
+        Filesystem::initMountPoints($owner);
133
+        $info = Filesystem::getFileInfo($target);
134
+        $ownerView = new View('/'.$owner.'/files');
135
+        if ( $owner !== User::getUser() ) {
136
+            $path = $ownerView->getPath($info['fileid']);
137
+        } else {
138
+            $path = $target;
139
+        }
140
+
141
+
142
+        $ids = array();
143
+        while ($path !== dirname($path)) {
144
+            $info = $ownerView->getFileInfo($path);
145
+            if ($info instanceof \OC\Files\FileInfo) {
146
+                $ids[] = $info['fileid'];
147
+            } else {
148
+                \OCP\Util::writeLog('sharing', 'No fileinfo available for: ' . $path, \OCP\Util::WARN);
149
+            }
150
+            $path = dirname($path);
151
+        }
152
+
153
+        if (!empty($ids)) {
154
+
155
+            $idList = array_chunk($ids, 99, true);
156
+
157
+            foreach ($idList as $subList) {
158
+                $statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (" . implode(',', $subList) . ") AND `share_type` IN (0, 1, 2)";
159
+                $query = \OCP\DB::prepare($statement);
160
+                $r = $query->execute();
161
+                $result = array_merge($result, $r->fetchAll());
162
+            }
163
+        }
164
+
165
+        return $result;
166
+    }
167
+
168
+    /**
169
+     * get the UID of the owner of the file and the path to the file relative to
170
+     * owners files folder
171
+     *
172
+     * @param $filename
173
+     * @return array
174
+     * @throws \OC\User\NoUserException
175
+     */
176
+    public static function getUidAndFilename($filename) {
177
+        $uid = Filesystem::getOwner($filename);
178
+        $userManager = \OC::$server->getUserManager();
179
+        // if the user with the UID doesn't exists, e.g. because the UID points
180
+        // to a remote user with a federated cloud ID we use the current logged-in
181
+        // user. We need a valid local user to create the share
182
+        if (!$userManager->userExists($uid)) {
183
+            $uid = User::getUser();
184
+        }
185
+        Filesystem::initMountPoints($uid);
186
+        if ( $uid !== User::getUser() ) {
187
+            $info = Filesystem::getFileInfo($filename);
188
+            $ownerView = new View('/'.$uid.'/files');
189
+            try {
190
+                $filename = $ownerView->getPath($info['fileid']);
191
+            } catch (NotFoundException $e) {
192
+                $filename = null;
193
+            }
194
+        }
195
+        return [$uid, $filename];
196
+    }
197
+
198
+    /**
199
+     * Format a path to be relative to the /user/files/ directory
200
+     * @param string $path the absolute path
201
+     * @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
202
+     */
203
+    public static function stripUserFilesPath($path) {
204
+        $trimmed = ltrim($path, '/');
205
+        $split = explode('/', $trimmed);
206
+
207
+        // it is not a file relative to data/user/files
208
+        if (count($split) < 3 || $split[1] !== 'files') {
209
+            return false;
210
+        }
211
+
212
+        $sliced = array_slice($split, 2);
213
+        $relPath = implode('/', $sliced);
214
+
215
+        return $relPath;
216
+    }
217
+
218
+    /**
219
+     * check if file name already exists and generate unique target
220
+     *
221
+     * @param string $path
222
+     * @param array $excludeList
223
+     * @param View $view
224
+     * @return string $path
225
+     */
226
+    public static function generateUniqueTarget($path, $excludeList, $view) {
227
+        $pathinfo = pathinfo($path);
228
+        $ext = (isset($pathinfo['extension'])) ? '.'.$pathinfo['extension'] : '';
229
+        $name = $pathinfo['filename'];
230
+        $dir = $pathinfo['dirname'];
231
+        $i = 2;
232
+        while ($view->file_exists($path) || in_array($path, $excludeList)) {
233
+            $path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
234
+            $i++;
235
+        }
236
+
237
+        return $path;
238
+    }
239
+
240
+    /**
241
+     * get default share folder
242
+     *
243
+     * @param \OC\Files\View
244
+     * @return string
245
+     */
246
+    public static function getShareFolder($view = null) {
247
+        if ($view === null) {
248
+            $view = Filesystem::getView();
249
+        }
250
+        $shareFolder = \OC::$server->getConfig()->getSystemValue('share_folder', '/');
251
+        $shareFolder = Filesystem::normalizePath($shareFolder);
252
+
253
+        if (!$view->file_exists($shareFolder)) {
254
+            $dir = '';
255
+            $subdirs = explode('/', $shareFolder);
256
+            foreach ($subdirs as $subdir) {
257
+                $dir = $dir . '/' . $subdir;
258
+                if (!$view->is_dir($dir)) {
259
+                    $view->mkdir($dir);
260
+                }
261
+            }
262
+        }
263
+
264
+        return $shareFolder;
265
+
266
+    }
267
+
268
+    /**
269
+     * set default share folder
270
+     *
271
+     * @param string $shareFolder
272
+     */
273
+    public static function setShareFolder($shareFolder) {
274
+        \OC::$server->getConfig()->setSystemValue('share_folder', $shareFolder);
275
+    }
276 276
 
277 277
 }
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
87 87
 
88 88
 		$basePath = $path;
89 89
 
90
-		if ($relativePath !== null && Filesystem::isReadable($basePath . $relativePath)) {
90
+		if ($relativePath !== null && Filesystem::isReadable($basePath.$relativePath)) {
91 91
 			$path .= Filesystem::normalizePath($relativePath);
92 92
 		}
93 93
 
@@ -112,14 +112,14 @@  discard block
 block discarded – undo
112 112
 		if ($password !== null) {
113 113
 			if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
114 114
 				if ($shareManager->checkPassword($share, $password)) {
115
-					\OC::$server->getSession()->set('public_link_authenticated', (string)$share->getId());
115
+					\OC::$server->getSession()->set('public_link_authenticated', (string) $share->getId());
116 116
 					return true;
117 117
 				}
118 118
 			}
119 119
 		} else {
120 120
 			// not authenticated ?
121 121
 			if (\OC::$server->getSession()->exists('public_link_authenticated')
122
-				&& \OC::$server->getSession()->get('public_link_authenticated') !== (string)$share->getId()) {
122
+				&& \OC::$server->getSession()->get('public_link_authenticated') !== (string) $share->getId()) {
123 123
 				return true;
124 124
 			}
125 125
 		}
@@ -132,7 +132,7 @@  discard block
 block discarded – undo
132 132
 		Filesystem::initMountPoints($owner);
133 133
 		$info = Filesystem::getFileInfo($target);
134 134
 		$ownerView = new View('/'.$owner.'/files');
135
-		if ( $owner !== User::getUser() ) {
135
+		if ($owner !== User::getUser()) {
136 136
 			$path = $ownerView->getPath($info['fileid']);
137 137
 		} else {
138 138
 			$path = $target;
@@ -145,7 +145,7 @@  discard block
 block discarded – undo
145 145
 			if ($info instanceof \OC\Files\FileInfo) {
146 146
 				$ids[] = $info['fileid'];
147 147
 			} else {
148
-				\OCP\Util::writeLog('sharing', 'No fileinfo available for: ' . $path, \OCP\Util::WARN);
148
+				\OCP\Util::writeLog('sharing', 'No fileinfo available for: '.$path, \OCP\Util::WARN);
149 149
 			}
150 150
 			$path = dirname($path);
151 151
 		}
@@ -155,7 +155,7 @@  discard block
 block discarded – undo
155 155
 			$idList = array_chunk($ids, 99, true);
156 156
 
157 157
 			foreach ($idList as $subList) {
158
-				$statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (" . implode(',', $subList) . ") AND `share_type` IN (0, 1, 2)";
158
+				$statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (".implode(',', $subList).") AND `share_type` IN (0, 1, 2)";
159 159
 				$query = \OCP\DB::prepare($statement);
160 160
 				$r = $query->execute();
161 161
 				$result = array_merge($result, $r->fetchAll());
@@ -183,7 +183,7 @@  discard block
 block discarded – undo
183 183
 			$uid = User::getUser();
184 184
 		}
185 185
 		Filesystem::initMountPoints($uid);
186
-		if ( $uid !== User::getUser() ) {
186
+		if ($uid !== User::getUser()) {
187 187
 			$info = Filesystem::getFileInfo($filename);
188 188
 			$ownerView = new View('/'.$uid.'/files');
189 189
 			try {
@@ -230,7 +230,7 @@  discard block
 block discarded – undo
230 230
 		$dir = $pathinfo['dirname'];
231 231
 		$i = 2;
232 232
 		while ($view->file_exists($path) || in_array($path, $excludeList)) {
233
-			$path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
233
+			$path = Filesystem::normalizePath($dir.'/'.$name.' ('.$i.')'.$ext);
234 234
 			$i++;
235 235
 		}
236 236
 
@@ -254,7 +254,7 @@  discard block
 block discarded – undo
254 254
 			$dir = '';
255 255
 			$subdirs = explode('/', $shareFolder);
256 256
 			foreach ($subdirs as $subdir) {
257
-				$dir = $dir . '/' . $subdir;
257
+				$dir = $dir.'/'.$subdir;
258 258
 				if (!$view->is_dir($dir)) {
259 259
 					$view->mkdir($dir);
260 260
 				}
Please login to merge, or discard this patch.
apps/dav/lib/SystemTag/SystemTagsObjectMappingCollection.php 3 patches
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -89,6 +89,9 @@
 block discarded – undo
89 89
 		$this->user = $user;
90 90
 	}
91 91
 
92
+	/**
93
+	 * @param string $tagId
94
+	 */
92 95
 	function createFile($tagId, $data = null) {
93 96
 		try {
94 97
 			$tags = $this->tagManager->getTagsByIds([$tagId]);
Please login to merge, or discard this patch.
Indentation   +165 added lines, -165 removed lines patch added patch discarded remove patch
@@ -39,169 +39,169 @@
 block discarded – undo
39 39
  */
40 40
 class SystemTagsObjectMappingCollection implements ICollection {
41 41
 
42
-	/**
43
-	 * @var string
44
-	 */
45
-	private $objectId;
46
-
47
-	/**
48
-	 * @var string
49
-	 */
50
-	private $objectType;
51
-
52
-	/**
53
-	 * @var ISystemTagManager
54
-	 */
55
-	private $tagManager;
56
-
57
-	/**
58
-	 * @var ISystemTagObjectMapper
59
-	 */
60
-	private $tagMapper;
61
-
62
-	/**
63
-	 * User
64
-	 *
65
-	 * @var IUser
66
-	 */
67
-	private $user;
68
-
69
-
70
-	/**
71
-	 * Constructor
72
-	 *
73
-	 * @param string $objectId object id
74
-	 * @param string $objectType object type
75
-	 * @param IUser $user user
76
-	 * @param ISystemTagManager $tagManager tag manager
77
-	 * @param ISystemTagObjectMapper $tagMapper tag mapper
78
-	 */
79
-	public function __construct(
80
-		$objectId,
81
-		$objectType,
82
-		IUser $user,
83
-		ISystemTagManager $tagManager,
84
-		ISystemTagObjectMapper $tagMapper
85
-	) {
86
-		$this->tagManager = $tagManager;
87
-		$this->tagMapper = $tagMapper;
88
-		$this->objectId = $objectId;
89
-		$this->objectType = $objectType;
90
-		$this->user = $user;
91
-	}
92
-
93
-	function createFile($tagId, $data = null) {
94
-		try {
95
-			$tags = $this->tagManager->getTagsByIds([$tagId]);
96
-			$tag = current($tags);
97
-			if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
98
-				throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
99
-			}
100
-			if (!$this->tagManager->canUserAssignTag($tag, $this->user)) {
101
-				throw new Forbidden('No permission to assign tag ' . $tagId);
102
-			}
103
-
104
-			$this->tagMapper->assignTags($this->objectId, $this->objectType, $tagId);
105
-		} catch (TagNotFoundException $e) {
106
-			throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
107
-		}
108
-	}
109
-
110
-	function createDirectory($name) {
111
-		throw new Forbidden('Permission denied to create collections');
112
-	}
113
-
114
-	function getChild($tagId) {
115
-		try {
116
-			if ($this->tagMapper->haveTag([$this->objectId], $this->objectType, $tagId, true)) {
117
-				$tag = $this->tagManager->getTagsByIds([$tagId]);
118
-				$tag = current($tag);
119
-				if ($this->tagManager->canUserSeeTag($tag, $this->user)) {
120
-					return $this->makeNode($tag);
121
-				}
122
-			}
123
-			throw new NotFound('Tag with id ' . $tagId . ' not present for object ' . $this->objectId);
124
-		} catch (\InvalidArgumentException $e) {
125
-			throw new BadRequest('Invalid tag id', 0, $e);
126
-		} catch (TagNotFoundException $e) {
127
-			throw new NotFound('Tag with id ' . $tagId . ' not found', 0, $e);
128
-		}
129
-	}
130
-
131
-	function getChildren() {
132
-		$tagIds = current($this->tagMapper->getTagIdsForObjects([$this->objectId], $this->objectType));
133
-		if (empty($tagIds)) {
134
-			return [];
135
-		}
136
-		$tags = $this->tagManager->getTagsByIds($tagIds);
137
-
138
-		// filter out non-visible tags
139
-		$tags = array_filter($tags, function($tag) {
140
-			return $this->tagManager->canUserSeeTag($tag, $this->user);
141
-		});
142
-
143
-		return array_values(array_map(function($tag) {
144
-			return $this->makeNode($tag);
145
-		}, $tags));
146
-	}
147
-
148
-	function childExists($tagId) {
149
-		try {
150
-			$result = ($this->tagMapper->haveTag([$this->objectId], $this->objectType, $tagId, true));
151
-
152
-			if ($result) {
153
-				$tags = $this->tagManager->getTagsByIds([$tagId]);
154
-				$tag = current($tags);
155
-				if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
156
-					return false;
157
-				}
158
-			}
159
-
160
-			return $result;
161
-		} catch (\InvalidArgumentException $e) {
162
-			throw new BadRequest('Invalid tag id', 0, $e);
163
-		} catch (TagNotFoundException $e) {
164
-			return false;
165
-		}
166
-	}
167
-
168
-	function delete() {
169
-		throw new Forbidden('Permission denied to delete this collection');
170
-	}
171
-
172
-	function getName() {
173
-		return $this->objectId;
174
-	}
175
-
176
-	function setName($name) {
177
-		throw new Forbidden('Permission denied to rename this collection');
178
-	}
179
-
180
-	/**
181
-	 * Returns the last modification time, as a unix timestamp
182
-	 *
183
-	 * @return int
184
-	 */
185
-	function getLastModified() {
186
-		return null;
187
-	}
188
-
189
-	/**
190
-	 * Create a sabre node for the mapping of the 
191
-	 * given system tag to the collection's object
192
-	 *
193
-	 * @param ISystemTag $tag
194
-	 *
195
-	 * @return SystemTagMappingNode
196
-	 */
197
-	private function makeNode(ISystemTag $tag) {
198
-		return new SystemTagMappingNode(
199
-			$tag,
200
-			$this->objectId,
201
-			$this->objectType,
202
-			$this->user,
203
-			$this->tagManager,
204
-			$this->tagMapper
205
-		);
206
-	}
42
+    /**
43
+     * @var string
44
+     */
45
+    private $objectId;
46
+
47
+    /**
48
+     * @var string
49
+     */
50
+    private $objectType;
51
+
52
+    /**
53
+     * @var ISystemTagManager
54
+     */
55
+    private $tagManager;
56
+
57
+    /**
58
+     * @var ISystemTagObjectMapper
59
+     */
60
+    private $tagMapper;
61
+
62
+    /**
63
+     * User
64
+     *
65
+     * @var IUser
66
+     */
67
+    private $user;
68
+
69
+
70
+    /**
71
+     * Constructor
72
+     *
73
+     * @param string $objectId object id
74
+     * @param string $objectType object type
75
+     * @param IUser $user user
76
+     * @param ISystemTagManager $tagManager tag manager
77
+     * @param ISystemTagObjectMapper $tagMapper tag mapper
78
+     */
79
+    public function __construct(
80
+        $objectId,
81
+        $objectType,
82
+        IUser $user,
83
+        ISystemTagManager $tagManager,
84
+        ISystemTagObjectMapper $tagMapper
85
+    ) {
86
+        $this->tagManager = $tagManager;
87
+        $this->tagMapper = $tagMapper;
88
+        $this->objectId = $objectId;
89
+        $this->objectType = $objectType;
90
+        $this->user = $user;
91
+    }
92
+
93
+    function createFile($tagId, $data = null) {
94
+        try {
95
+            $tags = $this->tagManager->getTagsByIds([$tagId]);
96
+            $tag = current($tags);
97
+            if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
98
+                throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
99
+            }
100
+            if (!$this->tagManager->canUserAssignTag($tag, $this->user)) {
101
+                throw new Forbidden('No permission to assign tag ' . $tagId);
102
+            }
103
+
104
+            $this->tagMapper->assignTags($this->objectId, $this->objectType, $tagId);
105
+        } catch (TagNotFoundException $e) {
106
+            throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
107
+        }
108
+    }
109
+
110
+    function createDirectory($name) {
111
+        throw new Forbidden('Permission denied to create collections');
112
+    }
113
+
114
+    function getChild($tagId) {
115
+        try {
116
+            if ($this->tagMapper->haveTag([$this->objectId], $this->objectType, $tagId, true)) {
117
+                $tag = $this->tagManager->getTagsByIds([$tagId]);
118
+                $tag = current($tag);
119
+                if ($this->tagManager->canUserSeeTag($tag, $this->user)) {
120
+                    return $this->makeNode($tag);
121
+                }
122
+            }
123
+            throw new NotFound('Tag with id ' . $tagId . ' not present for object ' . $this->objectId);
124
+        } catch (\InvalidArgumentException $e) {
125
+            throw new BadRequest('Invalid tag id', 0, $e);
126
+        } catch (TagNotFoundException $e) {
127
+            throw new NotFound('Tag with id ' . $tagId . ' not found', 0, $e);
128
+        }
129
+    }
130
+
131
+    function getChildren() {
132
+        $tagIds = current($this->tagMapper->getTagIdsForObjects([$this->objectId], $this->objectType));
133
+        if (empty($tagIds)) {
134
+            return [];
135
+        }
136
+        $tags = $this->tagManager->getTagsByIds($tagIds);
137
+
138
+        // filter out non-visible tags
139
+        $tags = array_filter($tags, function($tag) {
140
+            return $this->tagManager->canUserSeeTag($tag, $this->user);
141
+        });
142
+
143
+        return array_values(array_map(function($tag) {
144
+            return $this->makeNode($tag);
145
+        }, $tags));
146
+    }
147
+
148
+    function childExists($tagId) {
149
+        try {
150
+            $result = ($this->tagMapper->haveTag([$this->objectId], $this->objectType, $tagId, true));
151
+
152
+            if ($result) {
153
+                $tags = $this->tagManager->getTagsByIds([$tagId]);
154
+                $tag = current($tags);
155
+                if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
156
+                    return false;
157
+                }
158
+            }
159
+
160
+            return $result;
161
+        } catch (\InvalidArgumentException $e) {
162
+            throw new BadRequest('Invalid tag id', 0, $e);
163
+        } catch (TagNotFoundException $e) {
164
+            return false;
165
+        }
166
+    }
167
+
168
+    function delete() {
169
+        throw new Forbidden('Permission denied to delete this collection');
170
+    }
171
+
172
+    function getName() {
173
+        return $this->objectId;
174
+    }
175
+
176
+    function setName($name) {
177
+        throw new Forbidden('Permission denied to rename this collection');
178
+    }
179
+
180
+    /**
181
+     * Returns the last modification time, as a unix timestamp
182
+     *
183
+     * @return int
184
+     */
185
+    function getLastModified() {
186
+        return null;
187
+    }
188
+
189
+    /**
190
+     * Create a sabre node for the mapping of the 
191
+     * given system tag to the collection's object
192
+     *
193
+     * @param ISystemTag $tag
194
+     *
195
+     * @return SystemTagMappingNode
196
+     */
197
+    private function makeNode(ISystemTag $tag) {
198
+        return new SystemTagMappingNode(
199
+            $tag,
200
+            $this->objectId,
201
+            $this->objectType,
202
+            $this->user,
203
+            $this->tagManager,
204
+            $this->tagMapper
205
+        );
206
+    }
207 207
 }
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -95,15 +95,15 @@  discard block
 block discarded – undo
95 95
 			$tags = $this->tagManager->getTagsByIds([$tagId]);
96 96
 			$tag = current($tags);
97 97
 			if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
98
-				throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
98
+				throw new PreconditionFailed('Tag with id '.$tagId.' does not exist, cannot assign');
99 99
 			}
100 100
 			if (!$this->tagManager->canUserAssignTag($tag, $this->user)) {
101
-				throw new Forbidden('No permission to assign tag ' . $tagId);
101
+				throw new Forbidden('No permission to assign tag '.$tagId);
102 102
 			}
103 103
 
104 104
 			$this->tagMapper->assignTags($this->objectId, $this->objectType, $tagId);
105 105
 		} catch (TagNotFoundException $e) {
106
-			throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
106
+			throw new PreconditionFailed('Tag with id '.$tagId.' does not exist, cannot assign');
107 107
 		}
108 108
 	}
109 109
 
@@ -120,11 +120,11 @@  discard block
 block discarded – undo
120 120
 					return $this->makeNode($tag);
121 121
 				}
122 122
 			}
123
-			throw new NotFound('Tag with id ' . $tagId . ' not present for object ' . $this->objectId);
123
+			throw new NotFound('Tag with id '.$tagId.' not present for object '.$this->objectId);
124 124
 		} catch (\InvalidArgumentException $e) {
125 125
 			throw new BadRequest('Invalid tag id', 0, $e);
126 126
 		} catch (TagNotFoundException $e) {
127
-			throw new NotFound('Tag with id ' . $tagId . ' not found', 0, $e);
127
+			throw new NotFound('Tag with id '.$tagId.' not found', 0, $e);
128 128
 		}
129 129
 	}
130 130
 
Please login to merge, or discard this patch.
lib/private/DB/Migrator.php 3 patches
Doc Comments   +8 added lines patch added patch discarded remove patch
@@ -273,6 +273,10 @@  discard block
 block discarded – undo
273 273
 		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
274 274
 	}
275 275
 
276
+	/**
277
+	 * @param integer $step
278
+	 * @param integer $max
279
+	 */
276 280
 	protected function emit($sql, $step, $max) {
277 281
 		if ($this->noEmit) {
278 282
 			return;
@@ -283,6 +287,10 @@  discard block
 block discarded – undo
283 287
 		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
284 288
 	}
285 289
 
290
+	/**
291
+	 * @param integer $step
292
+	 * @param integer $max
293
+	 */
286 294
 	private function emitCheckStep($tableName, $step, $max) {
287 295
 		if(is_null($this->dispatcher)) {
288 296
 			return;
Please login to merge, or discard this patch.
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -137,7 +137,7 @@  discard block
 block discarded – undo
137 137
 	 * @return string
138 138
 	 */
139 139
 	protected function generateTemporaryTableName($name) {
140
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
140
+		return $this->config->getSystemValue('dbtableprefix', 'oc_').$name.'_'.$this->random->generate(13, ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
141 141
 	}
142 142
 
143 143
 	/**
@@ -188,7 +188,7 @@  discard block
 block discarded – undo
188 188
 				$indexName = $index->getName();
189 189
 			} else {
190 190
 				// avoid conflicts in index names
191
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
191
+				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_').$this->random->generate(13, ISecureRandom::CHAR_LOWER);
192 192
 			}
193 193
 			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
194 194
 		}
@@ -268,15 +268,15 @@  discard block
 block discarded – undo
268 268
 		$quotedSource = $this->connection->quoteIdentifier($sourceName);
269 269
 		$quotedTarget = $this->connection->quoteIdentifier($targetName);
270 270
 
271
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
272
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
271
+		$this->connection->exec('CREATE TABLE '.$quotedTarget.' (LIKE '.$quotedSource.')');
272
+		$this->connection->exec('INSERT INTO '.$quotedTarget.' SELECT * FROM '.$quotedSource);
273 273
 	}
274 274
 
275 275
 	/**
276 276
 	 * @param string $name
277 277
 	 */
278 278
 	protected function dropTable($name) {
279
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
279
+		$this->connection->exec('DROP TABLE '.$this->connection->quoteIdentifier($name));
280 280
 	}
281 281
 
282 282
 	/**
@@ -284,30 +284,30 @@  discard block
 block discarded – undo
284 284
 	 * @return string
285 285
 	 */
286 286
 	protected function convertStatementToScript($statement) {
287
-		$script = $statement . ';';
287
+		$script = $statement.';';
288 288
 		$script .= PHP_EOL;
289 289
 		$script .= PHP_EOL;
290 290
 		return $script;
291 291
 	}
292 292
 
293 293
 	protected function getFilterExpression() {
294
-		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
294
+		return '/^'.preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')).'/';
295 295
 	}
296 296
 
297 297
 	protected function emit($sql, $step, $max) {
298 298
 		if ($this->noEmit) {
299 299
 			return;
300 300
 		}
301
-		if(is_null($this->dispatcher)) {
301
+		if (is_null($this->dispatcher)) {
302 302
 			return;
303 303
 		}
304
-		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
304
+		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
305 305
 	}
306 306
 
307 307
 	private function emitCheckStep($tableName, $step, $max) {
308
-		if(is_null($this->dispatcher)) {
308
+		if (is_null($this->dispatcher)) {
309 309
 			return;
310 310
 		}
311
-		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step+1, $max]));
311
+		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step + 1, $max]));
312 312
 	}
313 313
 }
Please login to merge, or discard this patch.
Indentation   +268 added lines, -268 removed lines patch added patch discarded remove patch
@@ -43,272 +43,272 @@
 block discarded – undo
43 43
 
44 44
 class Migrator {
45 45
 
46
-	/** @var \Doctrine\DBAL\Connection */
47
-	protected $connection;
48
-
49
-	/** @var ISecureRandom */
50
-	private $random;
51
-
52
-	/** @var IConfig */
53
-	protected $config;
54
-
55
-	/** @var EventDispatcher  */
56
-	private $dispatcher;
57
-
58
-	/** @var bool */
59
-	private $noEmit = false;
60
-
61
-	/**
62
-	 * @param \Doctrine\DBAL\Connection|Connection $connection
63
-	 * @param ISecureRandom $random
64
-	 * @param IConfig $config
65
-	 * @param EventDispatcher $dispatcher
66
-	 */
67
-	public function __construct(\Doctrine\DBAL\Connection $connection,
68
-								ISecureRandom $random,
69
-								IConfig $config,
70
-								EventDispatcher $dispatcher = null) {
71
-		$this->connection = $connection;
72
-		$this->random = $random;
73
-		$this->config = $config;
74
-		$this->dispatcher = $dispatcher;
75
-	}
76
-
77
-	/**
78
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
79
-	 */
80
-	public function migrate(Schema $targetSchema) {
81
-		$this->noEmit = true;
82
-		$this->applySchema($targetSchema);
83
-	}
84
-
85
-	/**
86
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
87
-	 * @return string
88
-	 */
89
-	public function generateChangeScript(Schema $targetSchema) {
90
-		$schemaDiff = $this->getDiff($targetSchema, $this->connection);
91
-
92
-		$script = '';
93
-		$sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
94
-		foreach ($sqls as $sql) {
95
-			$script .= $this->convertStatementToScript($sql);
96
-		}
97
-
98
-		return $script;
99
-	}
100
-
101
-	/**
102
-	 * @param Schema $targetSchema
103
-	 * @throws \OC\DB\MigrationException
104
-	 */
105
-	public function checkMigrate(Schema $targetSchema) {
106
-		$this->noEmit = true;
107
-		/**@var \Doctrine\DBAL\Schema\Table[] $tables */
108
-		$tables = $targetSchema->getTables();
109
-		$filterExpression = $this->getFilterExpression();
110
-		$this->connection->getConfiguration()->
111
-			setFilterSchemaAssetsExpression($filterExpression);
112
-		$existingTables = $this->connection->getSchemaManager()->listTableNames();
113
-
114
-		$step = 0;
115
-		foreach ($tables as $table) {
116
-			if (strpos($table->getName(), '.')) {
117
-				list(, $tableName) = explode('.', $table->getName());
118
-			} else {
119
-				$tableName = $table->getName();
120
-			}
121
-			$this->emitCheckStep($tableName, $step++, count($tables));
122
-			// don't need to check for new tables
123
-			if (array_search($tableName, $existingTables) !== false) {
124
-				$this->checkTableMigrate($table);
125
-			}
126
-		}
127
-	}
128
-
129
-	/**
130
-	 * Create a unique name for the temporary table
131
-	 *
132
-	 * @param string $name
133
-	 * @return string
134
-	 */
135
-	protected function generateTemporaryTableName($name) {
136
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
137
-	}
138
-
139
-	/**
140
-	 * Check the migration of a table on a copy so we can detect errors before messing with the real table
141
-	 *
142
-	 * @param \Doctrine\DBAL\Schema\Table $table
143
-	 * @throws \OC\DB\MigrationException
144
-	 */
145
-	protected function checkTableMigrate(Table $table) {
146
-		$name = $table->getName();
147
-		$tmpName = $this->generateTemporaryTableName($name);
148
-
149
-		$this->copyTable($name, $tmpName);
150
-
151
-		//create the migration schema for the temporary table
152
-		$tmpTable = $this->renameTableSchema($table, $tmpName);
153
-		$schemaConfig = new SchemaConfig();
154
-		$schemaConfig->setName($this->connection->getDatabase());
155
-		$schema = new Schema(array($tmpTable), array(), $schemaConfig);
156
-
157
-		try {
158
-			$this->applySchema($schema);
159
-			$this->dropTable($tmpName);
160
-		} catch (DBALException $e) {
161
-			// pgsql needs to commit it's failed transaction before doing anything else
162
-			if ($this->connection->isTransactionActive()) {
163
-				$this->connection->commit();
164
-			}
165
-			$this->dropTable($tmpName);
166
-			throw new MigrationException($table->getName(), $e->getMessage());
167
-		}
168
-	}
169
-
170
-	/**
171
-	 * @param \Doctrine\DBAL\Schema\Table $table
172
-	 * @param string $newName
173
-	 * @return \Doctrine\DBAL\Schema\Table
174
-	 */
175
-	protected function renameTableSchema(Table $table, $newName) {
176
-		/**
177
-		 * @var \Doctrine\DBAL\Schema\Index[] $indexes
178
-		 */
179
-		$indexes = $table->getIndexes();
180
-		$newIndexes = array();
181
-		foreach ($indexes as $index) {
182
-			if ($index->isPrimary()) {
183
-				// do not rename primary key
184
-				$indexName = $index->getName();
185
-			} else {
186
-				// avoid conflicts in index names
187
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
188
-			}
189
-			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
190
-		}
191
-
192
-		// foreign keys are not supported so we just set it to an empty array
193
-		return new Table($newName, $table->getColumns(), $newIndexes, array(), 0, $table->getOptions());
194
-	}
195
-
196
-	public function createSchema() {
197
-		$filterExpression = $this->getFilterExpression();
198
-		$this->connection->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
199
-		return $this->connection->getSchemaManager()->createSchema();
200
-	}
201
-
202
-	/**
203
-	 * @param Schema $targetSchema
204
-	 * @param \Doctrine\DBAL\Connection $connection
205
-	 * @return \Doctrine\DBAL\Schema\SchemaDiff
206
-	 * @throws DBALException
207
-	 */
208
-	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
209
-		// adjust varchar columns with a length higher then getVarcharMaxLength to clob
210
-		foreach ($targetSchema->getTables() as $table) {
211
-			foreach ($table->getColumns() as $column) {
212
-				if ($column->getType() instanceof StringType) {
213
-					if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
214
-						$column->setType(Type::getType('text'));
215
-						$column->setLength(null);
216
-					}
217
-				}
218
-			}
219
-		}
220
-
221
-		$filterExpression = $this->getFilterExpression();
222
-		$this->connection->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
223
-		$sourceSchema = $connection->getSchemaManager()->createSchema();
224
-
225
-		// remove tables we don't know about
226
-		/** @var $table \Doctrine\DBAL\Schema\Table */
227
-		foreach ($sourceSchema->getTables() as $table) {
228
-			if (!$targetSchema->hasTable($table->getName())) {
229
-				$sourceSchema->dropTable($table->getName());
230
-			}
231
-		}
232
-		// remove sequences we don't know about
233
-		foreach ($sourceSchema->getSequences() as $table) {
234
-			if (!$targetSchema->hasSequence($table->getName())) {
235
-				$sourceSchema->dropSequence($table->getName());
236
-			}
237
-		}
238
-
239
-		$comparator = new Comparator();
240
-		return $comparator->compare($sourceSchema, $targetSchema);
241
-	}
242
-
243
-	/**
244
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
245
-	 * @param \Doctrine\DBAL\Connection $connection
246
-	 */
247
-	protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
248
-		if (is_null($connection)) {
249
-			$connection = $this->connection;
250
-		}
251
-
252
-		$schemaDiff = $this->getDiff($targetSchema, $connection);
253
-
254
-		$connection->beginTransaction();
255
-		$sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
256
-		$step = 0;
257
-		foreach ($sqls as $sql) {
258
-			$this->emit($sql, $step++, count($sqls));
259
-			$connection->query($sql);
260
-		}
261
-		$connection->commit();
262
-	}
263
-
264
-	/**
265
-	 * @param string $sourceName
266
-	 * @param string $targetName
267
-	 */
268
-	protected function copyTable($sourceName, $targetName) {
269
-		$quotedSource = $this->connection->quoteIdentifier($sourceName);
270
-		$quotedTarget = $this->connection->quoteIdentifier($targetName);
271
-
272
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
273
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
274
-	}
275
-
276
-	/**
277
-	 * @param string $name
278
-	 */
279
-	protected function dropTable($name) {
280
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
281
-	}
282
-
283
-	/**
284
-	 * @param $statement
285
-	 * @return string
286
-	 */
287
-	protected function convertStatementToScript($statement) {
288
-		$script = $statement . ';';
289
-		$script .= PHP_EOL;
290
-		$script .= PHP_EOL;
291
-		return $script;
292
-	}
293
-
294
-	protected function getFilterExpression() {
295
-		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
296
-	}
297
-
298
-	protected function emit($sql, $step, $max) {
299
-		if ($this->noEmit) {
300
-			return;
301
-		}
302
-		if(is_null($this->dispatcher)) {
303
-			return;
304
-		}
305
-		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
306
-	}
307
-
308
-	private function emitCheckStep($tableName, $step, $max) {
309
-		if(is_null($this->dispatcher)) {
310
-			return;
311
-		}
312
-		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step+1, $max]));
313
-	}
46
+    /** @var \Doctrine\DBAL\Connection */
47
+    protected $connection;
48
+
49
+    /** @var ISecureRandom */
50
+    private $random;
51
+
52
+    /** @var IConfig */
53
+    protected $config;
54
+
55
+    /** @var EventDispatcher  */
56
+    private $dispatcher;
57
+
58
+    /** @var bool */
59
+    private $noEmit = false;
60
+
61
+    /**
62
+     * @param \Doctrine\DBAL\Connection|Connection $connection
63
+     * @param ISecureRandom $random
64
+     * @param IConfig $config
65
+     * @param EventDispatcher $dispatcher
66
+     */
67
+    public function __construct(\Doctrine\DBAL\Connection $connection,
68
+                                ISecureRandom $random,
69
+                                IConfig $config,
70
+                                EventDispatcher $dispatcher = null) {
71
+        $this->connection = $connection;
72
+        $this->random = $random;
73
+        $this->config = $config;
74
+        $this->dispatcher = $dispatcher;
75
+    }
76
+
77
+    /**
78
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
79
+     */
80
+    public function migrate(Schema $targetSchema) {
81
+        $this->noEmit = true;
82
+        $this->applySchema($targetSchema);
83
+    }
84
+
85
+    /**
86
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
87
+     * @return string
88
+     */
89
+    public function generateChangeScript(Schema $targetSchema) {
90
+        $schemaDiff = $this->getDiff($targetSchema, $this->connection);
91
+
92
+        $script = '';
93
+        $sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
94
+        foreach ($sqls as $sql) {
95
+            $script .= $this->convertStatementToScript($sql);
96
+        }
97
+
98
+        return $script;
99
+    }
100
+
101
+    /**
102
+     * @param Schema $targetSchema
103
+     * @throws \OC\DB\MigrationException
104
+     */
105
+    public function checkMigrate(Schema $targetSchema) {
106
+        $this->noEmit = true;
107
+        /**@var \Doctrine\DBAL\Schema\Table[] $tables */
108
+        $tables = $targetSchema->getTables();
109
+        $filterExpression = $this->getFilterExpression();
110
+        $this->connection->getConfiguration()->
111
+            setFilterSchemaAssetsExpression($filterExpression);
112
+        $existingTables = $this->connection->getSchemaManager()->listTableNames();
113
+
114
+        $step = 0;
115
+        foreach ($tables as $table) {
116
+            if (strpos($table->getName(), '.')) {
117
+                list(, $tableName) = explode('.', $table->getName());
118
+            } else {
119
+                $tableName = $table->getName();
120
+            }
121
+            $this->emitCheckStep($tableName, $step++, count($tables));
122
+            // don't need to check for new tables
123
+            if (array_search($tableName, $existingTables) !== false) {
124
+                $this->checkTableMigrate($table);
125
+            }
126
+        }
127
+    }
128
+
129
+    /**
130
+     * Create a unique name for the temporary table
131
+     *
132
+     * @param string $name
133
+     * @return string
134
+     */
135
+    protected function generateTemporaryTableName($name) {
136
+        return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
137
+    }
138
+
139
+    /**
140
+     * Check the migration of a table on a copy so we can detect errors before messing with the real table
141
+     *
142
+     * @param \Doctrine\DBAL\Schema\Table $table
143
+     * @throws \OC\DB\MigrationException
144
+     */
145
+    protected function checkTableMigrate(Table $table) {
146
+        $name = $table->getName();
147
+        $tmpName = $this->generateTemporaryTableName($name);
148
+
149
+        $this->copyTable($name, $tmpName);
150
+
151
+        //create the migration schema for the temporary table
152
+        $tmpTable = $this->renameTableSchema($table, $tmpName);
153
+        $schemaConfig = new SchemaConfig();
154
+        $schemaConfig->setName($this->connection->getDatabase());
155
+        $schema = new Schema(array($tmpTable), array(), $schemaConfig);
156
+
157
+        try {
158
+            $this->applySchema($schema);
159
+            $this->dropTable($tmpName);
160
+        } catch (DBALException $e) {
161
+            // pgsql needs to commit it's failed transaction before doing anything else
162
+            if ($this->connection->isTransactionActive()) {
163
+                $this->connection->commit();
164
+            }
165
+            $this->dropTable($tmpName);
166
+            throw new MigrationException($table->getName(), $e->getMessage());
167
+        }
168
+    }
169
+
170
+    /**
171
+     * @param \Doctrine\DBAL\Schema\Table $table
172
+     * @param string $newName
173
+     * @return \Doctrine\DBAL\Schema\Table
174
+     */
175
+    protected function renameTableSchema(Table $table, $newName) {
176
+        /**
177
+         * @var \Doctrine\DBAL\Schema\Index[] $indexes
178
+         */
179
+        $indexes = $table->getIndexes();
180
+        $newIndexes = array();
181
+        foreach ($indexes as $index) {
182
+            if ($index->isPrimary()) {
183
+                // do not rename primary key
184
+                $indexName = $index->getName();
185
+            } else {
186
+                // avoid conflicts in index names
187
+                $indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
188
+            }
189
+            $newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
190
+        }
191
+
192
+        // foreign keys are not supported so we just set it to an empty array
193
+        return new Table($newName, $table->getColumns(), $newIndexes, array(), 0, $table->getOptions());
194
+    }
195
+
196
+    public function createSchema() {
197
+        $filterExpression = $this->getFilterExpression();
198
+        $this->connection->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
199
+        return $this->connection->getSchemaManager()->createSchema();
200
+    }
201
+
202
+    /**
203
+     * @param Schema $targetSchema
204
+     * @param \Doctrine\DBAL\Connection $connection
205
+     * @return \Doctrine\DBAL\Schema\SchemaDiff
206
+     * @throws DBALException
207
+     */
208
+    protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
209
+        // adjust varchar columns with a length higher then getVarcharMaxLength to clob
210
+        foreach ($targetSchema->getTables() as $table) {
211
+            foreach ($table->getColumns() as $column) {
212
+                if ($column->getType() instanceof StringType) {
213
+                    if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
214
+                        $column->setType(Type::getType('text'));
215
+                        $column->setLength(null);
216
+                    }
217
+                }
218
+            }
219
+        }
220
+
221
+        $filterExpression = $this->getFilterExpression();
222
+        $this->connection->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
223
+        $sourceSchema = $connection->getSchemaManager()->createSchema();
224
+
225
+        // remove tables we don't know about
226
+        /** @var $table \Doctrine\DBAL\Schema\Table */
227
+        foreach ($sourceSchema->getTables() as $table) {
228
+            if (!$targetSchema->hasTable($table->getName())) {
229
+                $sourceSchema->dropTable($table->getName());
230
+            }
231
+        }
232
+        // remove sequences we don't know about
233
+        foreach ($sourceSchema->getSequences() as $table) {
234
+            if (!$targetSchema->hasSequence($table->getName())) {
235
+                $sourceSchema->dropSequence($table->getName());
236
+            }
237
+        }
238
+
239
+        $comparator = new Comparator();
240
+        return $comparator->compare($sourceSchema, $targetSchema);
241
+    }
242
+
243
+    /**
244
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
245
+     * @param \Doctrine\DBAL\Connection $connection
246
+     */
247
+    protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
248
+        if (is_null($connection)) {
249
+            $connection = $this->connection;
250
+        }
251
+
252
+        $schemaDiff = $this->getDiff($targetSchema, $connection);
253
+
254
+        $connection->beginTransaction();
255
+        $sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
256
+        $step = 0;
257
+        foreach ($sqls as $sql) {
258
+            $this->emit($sql, $step++, count($sqls));
259
+            $connection->query($sql);
260
+        }
261
+        $connection->commit();
262
+    }
263
+
264
+    /**
265
+     * @param string $sourceName
266
+     * @param string $targetName
267
+     */
268
+    protected function copyTable($sourceName, $targetName) {
269
+        $quotedSource = $this->connection->quoteIdentifier($sourceName);
270
+        $quotedTarget = $this->connection->quoteIdentifier($targetName);
271
+
272
+        $this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
273
+        $this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
274
+    }
275
+
276
+    /**
277
+     * @param string $name
278
+     */
279
+    protected function dropTable($name) {
280
+        $this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
281
+    }
282
+
283
+    /**
284
+     * @param $statement
285
+     * @return string
286
+     */
287
+    protected function convertStatementToScript($statement) {
288
+        $script = $statement . ';';
289
+        $script .= PHP_EOL;
290
+        $script .= PHP_EOL;
291
+        return $script;
292
+    }
293
+
294
+    protected function getFilterExpression() {
295
+        return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
296
+    }
297
+
298
+    protected function emit($sql, $step, $max) {
299
+        if ($this->noEmit) {
300
+            return;
301
+        }
302
+        if(is_null($this->dispatcher)) {
303
+            return;
304
+        }
305
+        $this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
306
+    }
307
+
308
+    private function emitCheckStep($tableName, $step, $max) {
309
+        if(is_null($this->dispatcher)) {
310
+            return;
311
+        }
312
+        $this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step+1, $max]));
313
+    }
314 314
 }
Please login to merge, or discard this patch.
settings/Controller/CheckSetupController.php 3 patches
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -103,6 +103,7 @@  discard block
 block discarded – undo
103 103
 
104 104
 	/**
105 105
 	* Chceks if the ownCloud server can connect to a specific URL using both HTTPS and HTTP
106
+	* @param string $sitename
106 107
 	* @return bool
107 108
 	*/
108 109
 	private function isSiteReachable($sitename) {
@@ -285,7 +286,7 @@  discard block
 block discarded – undo
285 286
 
286 287
 	/**
287 288
 	 * @NoCSRFRequired
288
-	 * @return DataResponse
289
+	 * @return DataDisplayResponse
289 290
 	 */
290 291
 	public function getFailedIntegrityCheckFiles() {
291 292
 		if(!$this->checker->isCodeCheckEnforced()) {
Please login to merge, or discard this patch.
Spacing   +26 added lines, -26 removed lines patch added patch discarded remove patch
@@ -104,7 +104,7 @@  discard block
 block discarded – undo
104 104
 						'www.google.com',
105 105
 						'www.github.com'];
106 106
 
107
-		foreach($siteArray as $site) {
107
+		foreach ($siteArray as $site) {
108 108
 			if ($this->isSiteReachable($site)) {
109 109
 				return true;
110 110
 			}
@@ -117,8 +117,8 @@  discard block
 block discarded – undo
117 117
 	* @return bool
118 118
 	*/
119 119
 	private function isSiteReachable($sitename) {
120
-		$httpSiteName = 'http://' . $sitename . '/';
121
-		$httpsSiteName = 'https://' . $sitename . '/';
120
+		$httpSiteName = 'http://'.$sitename.'/';
121
+		$httpsSiteName = 'https://'.$sitename.'/';
122 122
 
123 123
 		try {
124 124
 			$client = $this->clientService->newClient();
@@ -145,9 +145,9 @@  discard block
 block discarded – undo
145 145
 	 * @return bool
146 146
 	 */
147 147
 	private function isUrandomAvailable() {
148
-		if(@file_exists('/dev/urandom')) {
148
+		if (@file_exists('/dev/urandom')) {
149 149
 			$file = fopen('/dev/urandom', 'rb');
150
-			if($file) {
150
+			if ($file) {
151 151
 				fclose($file);
152 152
 				return true;
153 153
 			}
@@ -178,40 +178,40 @@  discard block
 block discarded – undo
178 178
 		// Don't run check when:
179 179
 		// 1. Server has `has_internet_connection` set to false
180 180
 		// 2. AppStore AND S2S is disabled
181
-		if(!$this->config->getSystemValue('has_internet_connection', true)) {
181
+		if (!$this->config->getSystemValue('has_internet_connection', true)) {
182 182
 			return '';
183 183
 		}
184
-		if(!$this->config->getSystemValue('appstoreenabled', true)
184
+		if (!$this->config->getSystemValue('appstoreenabled', true)
185 185
 			&& $this->config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes') === 'no'
186 186
 			&& $this->config->getAppValue('files_sharing', 'incoming_server2server_share_enabled', 'yes') === 'no') {
187 187
 			return '';
188 188
 		}
189 189
 
190 190
 		$versionString = $this->getCurlVersion();
191
-		if(isset($versionString['ssl_version'])) {
191
+		if (isset($versionString['ssl_version'])) {
192 192
 			$versionString = $versionString['ssl_version'];
193 193
 		} else {
194 194
 			return '';
195 195
 		}
196 196
 
197
-		$features = (string)$this->l10n->t('installing and updating apps via the app store or Federated Cloud Sharing');
198
-		if(!$this->config->getSystemValue('appstoreenabled', true)) {
199
-			$features = (string)$this->l10n->t('Federated Cloud Sharing');
197
+		$features = (string) $this->l10n->t('installing and updating apps via the app store or Federated Cloud Sharing');
198
+		if (!$this->config->getSystemValue('appstoreenabled', true)) {
199
+			$features = (string) $this->l10n->t('Federated Cloud Sharing');
200 200
 		}
201 201
 
202 202
 		// Check if at least OpenSSL after 1.01d or 1.0.2b
203
-		if(strpos($versionString, 'OpenSSL/') === 0) {
203
+		if (strpos($versionString, 'OpenSSL/') === 0) {
204 204
 			$majorVersion = substr($versionString, 8, 5);
205 205
 			$patchRelease = substr($versionString, 13, 6);
206 206
 
207
-			if(($majorVersion === '1.0.1' && ord($patchRelease) < ord('d')) ||
207
+			if (($majorVersion === '1.0.1' && ord($patchRelease) < ord('d')) ||
208 208
 				($majorVersion === '1.0.2' && ord($patchRelease) < ord('b'))) {
209 209
 				return (string) $this->l10n->t('cURL is using an outdated %s version (%s). Please update your operating system or features such as %s will not work reliably.', ['OpenSSL', $versionString, $features]);
210 210
 			}
211 211
 		}
212 212
 
213 213
 		// Check if NSS and perform heuristic check
214
-		if(strpos($versionString, 'NSS/') === 0) {
214
+		if (strpos($versionString, 'NSS/') === 0) {
215 215
 			try {
216 216
 				$firstClient = $this->clientService->newClient();
217 217
 				$firstClient->get('https://nextcloud.com/');
@@ -219,7 +219,7 @@  discard block
 block discarded – undo
219 219
 				$secondClient = $this->clientService->newClient();
220 220
 				$secondClient->get('https://nextcloud.com/');
221 221
 			} catch (ClientException $e) {
222
-				if($e->getResponse()->getStatusCode() === 400) {
222
+				if ($e->getResponse()->getStatusCode() === 400) {
223 223
 					return (string) $this->l10n->t('cURL is using an outdated %s version (%s). Please update your operating system or features such as %s will not work reliably.', ['NSS', $versionString, $features]);
224 224
 				}
225 225
 			}
@@ -314,13 +314,13 @@  discard block
 block discarded – undo
314 314
 	 * @return DataResponse
315 315
 	 */
316 316
 	public function getFailedIntegrityCheckFiles() {
317
-		if(!$this->checker->isCodeCheckEnforced()) {
317
+		if (!$this->checker->isCodeCheckEnforced()) {
318 318
 			return new DataDisplayResponse('Integrity checker has been disabled. Integrity cannot be verified.');
319 319
 		}
320 320
 
321 321
 		$completeResults = $this->checker->getResults();
322 322
 
323
-		if(!empty($completeResults)) {
323
+		if (!empty($completeResults)) {
324 324
 			$formattedTextResponse = 'Technical information
325 325
 =====================
326 326
 The following list covers which files have failed the integrity check. Please read
@@ -330,12 +330,12 @@  discard block
 block discarded – undo
330 330
 Results
331 331
 =======
332 332
 ';
333
-			foreach($completeResults as $context => $contextResult) {
333
+			foreach ($completeResults as $context => $contextResult) {
334 334
 				$formattedTextResponse .= "- $context\n";
335 335
 
336
-				foreach($contextResult as $category => $result) {
336
+				foreach ($contextResult as $category => $result) {
337 337
 					$formattedTextResponse .= "\t- $category\n";
338
-					if($category !== 'EXCEPTION') {
338
+					if ($category !== 'EXCEPTION') {
339 339
 						foreach ($result as $key => $results) {
340 340
 							$formattedTextResponse .= "\t\t- $key\n";
341 341
 						}
@@ -378,27 +378,27 @@  discard block
 block discarded – undo
378 378
 
379 379
 		$isOpcacheProperlySetUp = true;
380 380
 
381
-		if(!$iniWrapper->getBool('opcache.enable')) {
381
+		if (!$iniWrapper->getBool('opcache.enable')) {
382 382
 			$isOpcacheProperlySetUp = false;
383 383
 		}
384 384
 
385
-		if(!$iniWrapper->getBool('opcache.save_comments')) {
385
+		if (!$iniWrapper->getBool('opcache.save_comments')) {
386 386
 			$isOpcacheProperlySetUp = false;
387 387
 		}
388 388
 
389
-		if(!$iniWrapper->getBool('opcache.enable_cli')) {
389
+		if (!$iniWrapper->getBool('opcache.enable_cli')) {
390 390
 			$isOpcacheProperlySetUp = false;
391 391
 		}
392 392
 
393
-		if($iniWrapper->getNumeric('opcache.max_accelerated_files') < 10000) {
393
+		if ($iniWrapper->getNumeric('opcache.max_accelerated_files') < 10000) {
394 394
 			$isOpcacheProperlySetUp = false;
395 395
 		}
396 396
 
397
-		if($iniWrapper->getNumeric('opcache.memory_consumption') < 128) {
397
+		if ($iniWrapper->getNumeric('opcache.memory_consumption') < 128) {
398 398
 			$isOpcacheProperlySetUp = false;
399 399
 		}
400 400
 
401
-		if($iniWrapper->getNumeric('opcache.interned_strings_buffer') < 8) {
401
+		if ($iniWrapper->getNumeric('opcache.interned_strings_buffer') < 8) {
402 402
 			$isOpcacheProperlySetUp = false;
403 403
 		}
404 404
 
Please login to merge, or discard this patch.
Indentation   +372 added lines, -372 removed lines patch added patch discarded remove patch
@@ -50,282 +50,282 @@  discard block
 block discarded – undo
50 50
  * @package OC\Settings\Controller
51 51
  */
52 52
 class CheckSetupController extends Controller {
53
-	/** @var IConfig */
54
-	private $config;
55
-	/** @var IClientService */
56
-	private $clientService;
57
-	/** @var \OC_Util */
58
-	private $util;
59
-	/** @var IURLGenerator */
60
-	private $urlGenerator;
61
-	/** @var IL10N */
62
-	private $l10n;
63
-	/** @var Checker */
64
-	private $checker;
65
-	/** @var ILogger */
66
-	private $logger;
67
-
68
-	/**
69
-	 * @param string $AppName
70
-	 * @param IRequest $request
71
-	 * @param IConfig $config
72
-	 * @param IClientService $clientService
73
-	 * @param IURLGenerator $urlGenerator
74
-	 * @param \OC_Util $util
75
-	 * @param IL10N $l10n
76
-	 * @param Checker $checker
77
-	 * @param ILogger $logger
78
-	 */
79
-	public function __construct($AppName,
80
-								IRequest $request,
81
-								IConfig $config,
82
-								IClientService $clientService,
83
-								IURLGenerator $urlGenerator,
84
-								\OC_Util $util,
85
-								IL10N $l10n,
86
-								Checker $checker,
87
-								ILogger $logger) {
88
-		parent::__construct($AppName, $request);
89
-		$this->config = $config;
90
-		$this->clientService = $clientService;
91
-		$this->util = $util;
92
-		$this->urlGenerator = $urlGenerator;
93
-		$this->l10n = $l10n;
94
-		$this->checker = $checker;
95
-		$this->logger = $logger;
96
-	}
97
-
98
-	/**
99
-	 * Checks if the ownCloud server can connect to the internet using HTTPS and HTTP
100
-	 * @return bool
101
-	 */
102
-	private function isInternetConnectionWorking() {
103
-		if ($this->config->getSystemValue('has_internet_connection', true) === false) {
104
-			return false;
105
-		}
106
-
107
-		$siteArray = ['www.nextcloud.com',
108
-						'www.google.com',
109
-						'www.github.com'];
110
-
111
-		foreach($siteArray as $site) {
112
-			if ($this->isSiteReachable($site)) {
113
-				return true;
114
-			}
115
-		}
116
-		return false;
117
-	}
118
-
119
-	/**
120
-	* Chceks if the ownCloud server can connect to a specific URL using both HTTPS and HTTP
121
-	* @return bool
122
-	*/
123
-	private function isSiteReachable($sitename) {
124
-		$httpSiteName = 'http://' . $sitename . '/';
125
-		$httpsSiteName = 'https://' . $sitename . '/';
126
-
127
-		try {
128
-			$client = $this->clientService->newClient();
129
-			$client->get($httpSiteName);
130
-			$client->get($httpsSiteName);
131
-		} catch (\Exception $e) {
132
-			$this->logger->logException($e, ['app' => 'internet_connection_check']);
133
-			return false;
134
-		}
135
-		return true;
136
-	}
137
-
138
-	/**
139
-	 * Checks whether a local memcache is installed or not
140
-	 * @return bool
141
-	 */
142
-	private function isMemcacheConfigured() {
143
-		return $this->config->getSystemValue('memcache.local', null) !== null;
144
-	}
145
-
146
-	/**
147
-	 * Whether /dev/urandom is available to the PHP controller
148
-	 *
149
-	 * @return bool
150
-	 */
151
-	private function isUrandomAvailable() {
152
-		if(@file_exists('/dev/urandom')) {
153
-			$file = fopen('/dev/urandom', 'rb');
154
-			if($file) {
155
-				fclose($file);
156
-				return true;
157
-			}
158
-		}
159
-
160
-		return false;
161
-	}
162
-
163
-	/**
164
-	 * Public for the sake of unit-testing
165
-	 *
166
-	 * @return array
167
-	 */
168
-	protected function getCurlVersion() {
169
-		return curl_version();
170
-	}
171
-
172
-	/**
173
-	 * Check if the used  SSL lib is outdated. Older OpenSSL and NSS versions do
174
-	 * have multiple bugs which likely lead to problems in combination with
175
-	 * functionality required by ownCloud such as SNI.
176
-	 *
177
-	 * @link https://github.com/owncloud/core/issues/17446#issuecomment-122877546
178
-	 * @link https://bugzilla.redhat.com/show_bug.cgi?id=1241172
179
-	 * @return string
180
-	 */
181
-	private function isUsedTlsLibOutdated() {
182
-		// Don't run check when:
183
-		// 1. Server has `has_internet_connection` set to false
184
-		// 2. AppStore AND S2S is disabled
185
-		if(!$this->config->getSystemValue('has_internet_connection', true)) {
186
-			return '';
187
-		}
188
-		if(!$this->config->getSystemValue('appstoreenabled', true)
189
-			&& $this->config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes') === 'no'
190
-			&& $this->config->getAppValue('files_sharing', 'incoming_server2server_share_enabled', 'yes') === 'no') {
191
-			return '';
192
-		}
193
-
194
-		$versionString = $this->getCurlVersion();
195
-		if(isset($versionString['ssl_version'])) {
196
-			$versionString = $versionString['ssl_version'];
197
-		} else {
198
-			return '';
199
-		}
200
-
201
-		$features = (string)$this->l10n->t('installing and updating apps via the app store or Federated Cloud Sharing');
202
-		if(!$this->config->getSystemValue('appstoreenabled', true)) {
203
-			$features = (string)$this->l10n->t('Federated Cloud Sharing');
204
-		}
205
-
206
-		// Check if at least OpenSSL after 1.01d or 1.0.2b
207
-		if(strpos($versionString, 'OpenSSL/') === 0) {
208
-			$majorVersion = substr($versionString, 8, 5);
209
-			$patchRelease = substr($versionString, 13, 6);
210
-
211
-			if(($majorVersion === '1.0.1' && ord($patchRelease) < ord('d')) ||
212
-				($majorVersion === '1.0.2' && ord($patchRelease) < ord('b'))) {
213
-				return (string) $this->l10n->t('cURL is using an outdated %s version (%s). Please update your operating system or features such as %s will not work reliably.', ['OpenSSL', $versionString, $features]);
214
-			}
215
-		}
216
-
217
-		// Check if NSS and perform heuristic check
218
-		if(strpos($versionString, 'NSS/') === 0) {
219
-			try {
220
-				$firstClient = $this->clientService->newClient();
221
-				$firstClient->get('https://nextcloud.com/');
222
-
223
-				$secondClient = $this->clientService->newClient();
224
-				$secondClient->get('https://nextcloud.com/');
225
-			} catch (ClientException $e) {
226
-				if($e->getResponse()->getStatusCode() === 400) {
227
-					return (string) $this->l10n->t('cURL is using an outdated %s version (%s). Please update your operating system or features such as %s will not work reliably.', ['NSS', $versionString, $features]);
228
-				}
229
-			}
230
-		}
231
-
232
-		return '';
233
-	}
234
-
235
-	/**
236
-	 * Whether the version is outdated
237
-	 *
238
-	 * @return bool
239
-	 */
240
-	protected function isPhpOutdated() {
241
-		if (version_compare(PHP_VERSION, '7.0.0', '<')) {
242
-			return true;
243
-		}
244
-
245
-		return false;
246
-	}
247
-
248
-	/**
249
-	 * Whether the php version is still supported (at time of release)
250
-	 * according to: https://secure.php.net/supported-versions.php
251
-	 *
252
-	 * @return array
253
-	 */
254
-	private function isPhpSupported() {
255
-		return ['eol' => $this->isPhpOutdated(), 'version' => PHP_VERSION];
256
-	}
257
-
258
-	/**
259
-	 * Check if the reverse proxy configuration is working as expected
260
-	 *
261
-	 * @return bool
262
-	 */
263
-	private function forwardedForHeadersWorking() {
264
-		$trustedProxies = $this->config->getSystemValue('trusted_proxies', []);
265
-		$remoteAddress = $this->request->getRemoteAddress();
266
-
267
-		if (is_array($trustedProxies) && in_array($remoteAddress, $trustedProxies)) {
268
-			return false;
269
-		}
270
-
271
-		// either not enabled or working correctly
272
-		return true;
273
-	}
274
-
275
-	/**
276
-	 * Checks if the correct memcache module for PHP is installed. Only
277
-	 * fails if memcached is configured and the working module is not installed.
278
-	 *
279
-	 * @return bool
280
-	 */
281
-	private function isCorrectMemcachedPHPModuleInstalled() {
282
-		if ($this->config->getSystemValue('memcache.distributed', null) !== '\OC\Memcache\Memcached') {
283
-			return true;
284
-		}
285
-
286
-		// there are two different memcached modules for PHP
287
-		// we only support memcached and not memcache
288
-		// https://code.google.com/p/memcached/wiki/PHPClientComparison
289
-		return !(!extension_loaded('memcached') && extension_loaded('memcache'));
290
-	}
291
-
292
-	/**
293
-	 * Checks if set_time_limit is not disabled.
294
-	 *
295
-	 * @return bool
296
-	 */
297
-	private function isSettimelimitAvailable() {
298
-		if (function_exists('set_time_limit')
299
-			&& strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
300
-			return true;
301
-		}
302
-
303
-		return false;
304
-	}
305
-
306
-	/**
307
-	 * @return RedirectResponse
308
-	 */
309
-	public function rescanFailedIntegrityCheck() {
310
-		$this->checker->runInstanceVerification();
311
-		return new RedirectResponse(
312
-			$this->urlGenerator->linkToRoute('settings.AdminSettings.index')
313
-		);
314
-	}
315
-
316
-	/**
317
-	 * @NoCSRFRequired
318
-	 * @return DataResponse
319
-	 */
320
-	public function getFailedIntegrityCheckFiles() {
321
-		if(!$this->checker->isCodeCheckEnforced()) {
322
-			return new DataDisplayResponse('Integrity checker has been disabled. Integrity cannot be verified.');
323
-		}
324
-
325
-		$completeResults = $this->checker->getResults();
326
-
327
-		if(!empty($completeResults)) {
328
-			$formattedTextResponse = 'Technical information
53
+    /** @var IConfig */
54
+    private $config;
55
+    /** @var IClientService */
56
+    private $clientService;
57
+    /** @var \OC_Util */
58
+    private $util;
59
+    /** @var IURLGenerator */
60
+    private $urlGenerator;
61
+    /** @var IL10N */
62
+    private $l10n;
63
+    /** @var Checker */
64
+    private $checker;
65
+    /** @var ILogger */
66
+    private $logger;
67
+
68
+    /**
69
+     * @param string $AppName
70
+     * @param IRequest $request
71
+     * @param IConfig $config
72
+     * @param IClientService $clientService
73
+     * @param IURLGenerator $urlGenerator
74
+     * @param \OC_Util $util
75
+     * @param IL10N $l10n
76
+     * @param Checker $checker
77
+     * @param ILogger $logger
78
+     */
79
+    public function __construct($AppName,
80
+                                IRequest $request,
81
+                                IConfig $config,
82
+                                IClientService $clientService,
83
+                                IURLGenerator $urlGenerator,
84
+                                \OC_Util $util,
85
+                                IL10N $l10n,
86
+                                Checker $checker,
87
+                                ILogger $logger) {
88
+        parent::__construct($AppName, $request);
89
+        $this->config = $config;
90
+        $this->clientService = $clientService;
91
+        $this->util = $util;
92
+        $this->urlGenerator = $urlGenerator;
93
+        $this->l10n = $l10n;
94
+        $this->checker = $checker;
95
+        $this->logger = $logger;
96
+    }
97
+
98
+    /**
99
+     * Checks if the ownCloud server can connect to the internet using HTTPS and HTTP
100
+     * @return bool
101
+     */
102
+    private function isInternetConnectionWorking() {
103
+        if ($this->config->getSystemValue('has_internet_connection', true) === false) {
104
+            return false;
105
+        }
106
+
107
+        $siteArray = ['www.nextcloud.com',
108
+                        'www.google.com',
109
+                        'www.github.com'];
110
+
111
+        foreach($siteArray as $site) {
112
+            if ($this->isSiteReachable($site)) {
113
+                return true;
114
+            }
115
+        }
116
+        return false;
117
+    }
118
+
119
+    /**
120
+     * Chceks if the ownCloud server can connect to a specific URL using both HTTPS and HTTP
121
+     * @return bool
122
+     */
123
+    private function isSiteReachable($sitename) {
124
+        $httpSiteName = 'http://' . $sitename . '/';
125
+        $httpsSiteName = 'https://' . $sitename . '/';
126
+
127
+        try {
128
+            $client = $this->clientService->newClient();
129
+            $client->get($httpSiteName);
130
+            $client->get($httpsSiteName);
131
+        } catch (\Exception $e) {
132
+            $this->logger->logException($e, ['app' => 'internet_connection_check']);
133
+            return false;
134
+        }
135
+        return true;
136
+    }
137
+
138
+    /**
139
+     * Checks whether a local memcache is installed or not
140
+     * @return bool
141
+     */
142
+    private function isMemcacheConfigured() {
143
+        return $this->config->getSystemValue('memcache.local', null) !== null;
144
+    }
145
+
146
+    /**
147
+     * Whether /dev/urandom is available to the PHP controller
148
+     *
149
+     * @return bool
150
+     */
151
+    private function isUrandomAvailable() {
152
+        if(@file_exists('/dev/urandom')) {
153
+            $file = fopen('/dev/urandom', 'rb');
154
+            if($file) {
155
+                fclose($file);
156
+                return true;
157
+            }
158
+        }
159
+
160
+        return false;
161
+    }
162
+
163
+    /**
164
+     * Public for the sake of unit-testing
165
+     *
166
+     * @return array
167
+     */
168
+    protected function getCurlVersion() {
169
+        return curl_version();
170
+    }
171
+
172
+    /**
173
+     * Check if the used  SSL lib is outdated. Older OpenSSL and NSS versions do
174
+     * have multiple bugs which likely lead to problems in combination with
175
+     * functionality required by ownCloud such as SNI.
176
+     *
177
+     * @link https://github.com/owncloud/core/issues/17446#issuecomment-122877546
178
+     * @link https://bugzilla.redhat.com/show_bug.cgi?id=1241172
179
+     * @return string
180
+     */
181
+    private function isUsedTlsLibOutdated() {
182
+        // Don't run check when:
183
+        // 1. Server has `has_internet_connection` set to false
184
+        // 2. AppStore AND S2S is disabled
185
+        if(!$this->config->getSystemValue('has_internet_connection', true)) {
186
+            return '';
187
+        }
188
+        if(!$this->config->getSystemValue('appstoreenabled', true)
189
+            && $this->config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes') === 'no'
190
+            && $this->config->getAppValue('files_sharing', 'incoming_server2server_share_enabled', 'yes') === 'no') {
191
+            return '';
192
+        }
193
+
194
+        $versionString = $this->getCurlVersion();
195
+        if(isset($versionString['ssl_version'])) {
196
+            $versionString = $versionString['ssl_version'];
197
+        } else {
198
+            return '';
199
+        }
200
+
201
+        $features = (string)$this->l10n->t('installing and updating apps via the app store or Federated Cloud Sharing');
202
+        if(!$this->config->getSystemValue('appstoreenabled', true)) {
203
+            $features = (string)$this->l10n->t('Federated Cloud Sharing');
204
+        }
205
+
206
+        // Check if at least OpenSSL after 1.01d or 1.0.2b
207
+        if(strpos($versionString, 'OpenSSL/') === 0) {
208
+            $majorVersion = substr($versionString, 8, 5);
209
+            $patchRelease = substr($versionString, 13, 6);
210
+
211
+            if(($majorVersion === '1.0.1' && ord($patchRelease) < ord('d')) ||
212
+                ($majorVersion === '1.0.2' && ord($patchRelease) < ord('b'))) {
213
+                return (string) $this->l10n->t('cURL is using an outdated %s version (%s). Please update your operating system or features such as %s will not work reliably.', ['OpenSSL', $versionString, $features]);
214
+            }
215
+        }
216
+
217
+        // Check if NSS and perform heuristic check
218
+        if(strpos($versionString, 'NSS/') === 0) {
219
+            try {
220
+                $firstClient = $this->clientService->newClient();
221
+                $firstClient->get('https://nextcloud.com/');
222
+
223
+                $secondClient = $this->clientService->newClient();
224
+                $secondClient->get('https://nextcloud.com/');
225
+            } catch (ClientException $e) {
226
+                if($e->getResponse()->getStatusCode() === 400) {
227
+                    return (string) $this->l10n->t('cURL is using an outdated %s version (%s). Please update your operating system or features such as %s will not work reliably.', ['NSS', $versionString, $features]);
228
+                }
229
+            }
230
+        }
231
+
232
+        return '';
233
+    }
234
+
235
+    /**
236
+     * Whether the version is outdated
237
+     *
238
+     * @return bool
239
+     */
240
+    protected function isPhpOutdated() {
241
+        if (version_compare(PHP_VERSION, '7.0.0', '<')) {
242
+            return true;
243
+        }
244
+
245
+        return false;
246
+    }
247
+
248
+    /**
249
+     * Whether the php version is still supported (at time of release)
250
+     * according to: https://secure.php.net/supported-versions.php
251
+     *
252
+     * @return array
253
+     */
254
+    private function isPhpSupported() {
255
+        return ['eol' => $this->isPhpOutdated(), 'version' => PHP_VERSION];
256
+    }
257
+
258
+    /**
259
+     * Check if the reverse proxy configuration is working as expected
260
+     *
261
+     * @return bool
262
+     */
263
+    private function forwardedForHeadersWorking() {
264
+        $trustedProxies = $this->config->getSystemValue('trusted_proxies', []);
265
+        $remoteAddress = $this->request->getRemoteAddress();
266
+
267
+        if (is_array($trustedProxies) && in_array($remoteAddress, $trustedProxies)) {
268
+            return false;
269
+        }
270
+
271
+        // either not enabled or working correctly
272
+        return true;
273
+    }
274
+
275
+    /**
276
+     * Checks if the correct memcache module for PHP is installed. Only
277
+     * fails if memcached is configured and the working module is not installed.
278
+     *
279
+     * @return bool
280
+     */
281
+    private function isCorrectMemcachedPHPModuleInstalled() {
282
+        if ($this->config->getSystemValue('memcache.distributed', null) !== '\OC\Memcache\Memcached') {
283
+            return true;
284
+        }
285
+
286
+        // there are two different memcached modules for PHP
287
+        // we only support memcached and not memcache
288
+        // https://code.google.com/p/memcached/wiki/PHPClientComparison
289
+        return !(!extension_loaded('memcached') && extension_loaded('memcache'));
290
+    }
291
+
292
+    /**
293
+     * Checks if set_time_limit is not disabled.
294
+     *
295
+     * @return bool
296
+     */
297
+    private function isSettimelimitAvailable() {
298
+        if (function_exists('set_time_limit')
299
+            && strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
300
+            return true;
301
+        }
302
+
303
+        return false;
304
+    }
305
+
306
+    /**
307
+     * @return RedirectResponse
308
+     */
309
+    public function rescanFailedIntegrityCheck() {
310
+        $this->checker->runInstanceVerification();
311
+        return new RedirectResponse(
312
+            $this->urlGenerator->linkToRoute('settings.AdminSettings.index')
313
+        );
314
+    }
315
+
316
+    /**
317
+     * @NoCSRFRequired
318
+     * @return DataResponse
319
+     */
320
+    public function getFailedIntegrityCheckFiles() {
321
+        if(!$this->checker->isCodeCheckEnforced()) {
322
+            return new DataDisplayResponse('Integrity checker has been disabled. Integrity cannot be verified.');
323
+        }
324
+
325
+        $completeResults = $this->checker->getResults();
326
+
327
+        if(!empty($completeResults)) {
328
+            $formattedTextResponse = 'Technical information
329 329
 =====================
330 330
 The following list covers which files have failed the integrity check. Please read
331 331
 the previous linked documentation to learn more about the errors and how to fix
@@ -334,103 +334,103 @@  discard block
 block discarded – undo
334 334
 Results
335 335
 =======
336 336
 ';
337
-			foreach($completeResults as $context => $contextResult) {
338
-				$formattedTextResponse .= "- $context\n";
339
-
340
-				foreach($contextResult as $category => $result) {
341
-					$formattedTextResponse .= "\t- $category\n";
342
-					if($category !== 'EXCEPTION') {
343
-						foreach ($result as $key => $results) {
344
-							$formattedTextResponse .= "\t\t- $key\n";
345
-						}
346
-					} else {
347
-						foreach ($result as $key => $results) {
348
-							$formattedTextResponse .= "\t\t- $results\n";
349
-						}
350
-					}
351
-
352
-				}
353
-			}
354
-
355
-			$formattedTextResponse .= '
337
+            foreach($completeResults as $context => $contextResult) {
338
+                $formattedTextResponse .= "- $context\n";
339
+
340
+                foreach($contextResult as $category => $result) {
341
+                    $formattedTextResponse .= "\t- $category\n";
342
+                    if($category !== 'EXCEPTION') {
343
+                        foreach ($result as $key => $results) {
344
+                            $formattedTextResponse .= "\t\t- $key\n";
345
+                        }
346
+                    } else {
347
+                        foreach ($result as $key => $results) {
348
+                            $formattedTextResponse .= "\t\t- $results\n";
349
+                        }
350
+                    }
351
+
352
+                }
353
+            }
354
+
355
+            $formattedTextResponse .= '
356 356
 Raw output
357 357
 ==========
358 358
 ';
359
-			$formattedTextResponse .= print_r($completeResults, true);
360
-		} else {
361
-			$formattedTextResponse = 'No errors have been found.';
362
-		}
363
-
364
-
365
-		$response = new DataDisplayResponse(
366
-			$formattedTextResponse,
367
-			Http::STATUS_OK,
368
-			[
369
-				'Content-Type' => 'text/plain',
370
-			]
371
-		);
372
-
373
-		return $response;
374
-	}
375
-
376
-	/**
377
-	 * Checks whether a PHP opcache is properly set up
378
-	 * @return bool
379
-	 */
380
-	protected function isOpcacheProperlySetup() {
381
-		$iniWrapper = new IniGetWrapper();
382
-
383
-		$isOpcacheProperlySetUp = true;
384
-
385
-		if(!$iniWrapper->getBool('opcache.enable')) {
386
-			$isOpcacheProperlySetUp = false;
387
-		}
388
-
389
-		if(!$iniWrapper->getBool('opcache.save_comments')) {
390
-			$isOpcacheProperlySetUp = false;
391
-		}
392
-
393
-		if(!$iniWrapper->getBool('opcache.enable_cli')) {
394
-			$isOpcacheProperlySetUp = false;
395
-		}
396
-
397
-		if($iniWrapper->getNumeric('opcache.max_accelerated_files') < 10000) {
398
-			$isOpcacheProperlySetUp = false;
399
-		}
400
-
401
-		if($iniWrapper->getNumeric('opcache.memory_consumption') < 128) {
402
-			$isOpcacheProperlySetUp = false;
403
-		}
404
-
405
-		if($iniWrapper->getNumeric('opcache.interned_strings_buffer') < 8) {
406
-			$isOpcacheProperlySetUp = false;
407
-		}
408
-
409
-		return $isOpcacheProperlySetUp;
410
-	}
411
-
412
-	/**
413
-	 * @return DataResponse
414
-	 */
415
-	public function check() {
416
-		return new DataResponse(
417
-			[
418
-				'serverHasInternetConnection' => $this->isInternetConnectionWorking(),
419
-				'isMemcacheConfigured' => $this->isMemcacheConfigured(),
420
-				'memcacheDocs' => $this->urlGenerator->linkToDocs('admin-performance'),
421
-				'isUrandomAvailable' => $this->isUrandomAvailable(),
422
-				'securityDocs' => $this->urlGenerator->linkToDocs('admin-security'),
423
-				'isUsedTlsLibOutdated' => $this->isUsedTlsLibOutdated(),
424
-				'phpSupported' => $this->isPhpSupported(),
425
-				'forwardedForHeadersWorking' => $this->forwardedForHeadersWorking(),
426
-				'reverseProxyDocs' => $this->urlGenerator->linkToDocs('admin-reverse-proxy'),
427
-				'isCorrectMemcachedPHPModuleInstalled' => $this->isCorrectMemcachedPHPModuleInstalled(),
428
-				'hasPassedCodeIntegrityCheck' => $this->checker->hasPassedCheck(),
429
-				'codeIntegrityCheckerDocumentation' => $this->urlGenerator->linkToDocs('admin-code-integrity'),
430
-				'isOpcacheProperlySetup' => $this->isOpcacheProperlySetup(),
431
-				'phpOpcacheDocumentation' => $this->urlGenerator->linkToDocs('admin-php-opcache'),
432
-				'isSettimelimitAvailable' => $this->isSettimelimitAvailable(),
433
-			]
434
-		);
435
-	}
359
+            $formattedTextResponse .= print_r($completeResults, true);
360
+        } else {
361
+            $formattedTextResponse = 'No errors have been found.';
362
+        }
363
+
364
+
365
+        $response = new DataDisplayResponse(
366
+            $formattedTextResponse,
367
+            Http::STATUS_OK,
368
+            [
369
+                'Content-Type' => 'text/plain',
370
+            ]
371
+        );
372
+
373
+        return $response;
374
+    }
375
+
376
+    /**
377
+     * Checks whether a PHP opcache is properly set up
378
+     * @return bool
379
+     */
380
+    protected function isOpcacheProperlySetup() {
381
+        $iniWrapper = new IniGetWrapper();
382
+
383
+        $isOpcacheProperlySetUp = true;
384
+
385
+        if(!$iniWrapper->getBool('opcache.enable')) {
386
+            $isOpcacheProperlySetUp = false;
387
+        }
388
+
389
+        if(!$iniWrapper->getBool('opcache.save_comments')) {
390
+            $isOpcacheProperlySetUp = false;
391
+        }
392
+
393
+        if(!$iniWrapper->getBool('opcache.enable_cli')) {
394
+            $isOpcacheProperlySetUp = false;
395
+        }
396
+
397
+        if($iniWrapper->getNumeric('opcache.max_accelerated_files') < 10000) {
398
+            $isOpcacheProperlySetUp = false;
399
+        }
400
+
401
+        if($iniWrapper->getNumeric('opcache.memory_consumption') < 128) {
402
+            $isOpcacheProperlySetUp = false;
403
+        }
404
+
405
+        if($iniWrapper->getNumeric('opcache.interned_strings_buffer') < 8) {
406
+            $isOpcacheProperlySetUp = false;
407
+        }
408
+
409
+        return $isOpcacheProperlySetUp;
410
+    }
411
+
412
+    /**
413
+     * @return DataResponse
414
+     */
415
+    public function check() {
416
+        return new DataResponse(
417
+            [
418
+                'serverHasInternetConnection' => $this->isInternetConnectionWorking(),
419
+                'isMemcacheConfigured' => $this->isMemcacheConfigured(),
420
+                'memcacheDocs' => $this->urlGenerator->linkToDocs('admin-performance'),
421
+                'isUrandomAvailable' => $this->isUrandomAvailable(),
422
+                'securityDocs' => $this->urlGenerator->linkToDocs('admin-security'),
423
+                'isUsedTlsLibOutdated' => $this->isUsedTlsLibOutdated(),
424
+                'phpSupported' => $this->isPhpSupported(),
425
+                'forwardedForHeadersWorking' => $this->forwardedForHeadersWorking(),
426
+                'reverseProxyDocs' => $this->urlGenerator->linkToDocs('admin-reverse-proxy'),
427
+                'isCorrectMemcachedPHPModuleInstalled' => $this->isCorrectMemcachedPHPModuleInstalled(),
428
+                'hasPassedCodeIntegrityCheck' => $this->checker->hasPassedCheck(),
429
+                'codeIntegrityCheckerDocumentation' => $this->urlGenerator->linkToDocs('admin-code-integrity'),
430
+                'isOpcacheProperlySetup' => $this->isOpcacheProperlySetup(),
431
+                'phpOpcacheDocumentation' => $this->urlGenerator->linkToDocs('admin-php-opcache'),
432
+                'isSettimelimitAvailable' => $this->isSettimelimitAvailable(),
433
+            ]
434
+        );
435
+    }
436 436
 }
Please login to merge, or discard this patch.