@@ -35,36 +35,36 @@ |
||
35 | 35 | |
36 | 36 | class SMB extends Backend { |
37 | 37 | |
38 | - use LegacyDependencyCheckPolyfill; |
|
38 | + use LegacyDependencyCheckPolyfill; |
|
39 | 39 | |
40 | - public function __construct(IL10N $l, Password $legacyAuth) { |
|
41 | - $this |
|
42 | - ->setIdentifier('smb') |
|
43 | - ->addIdentifierAlias('\OC\Files\Storage\SMB') // legacy compat |
|
44 | - ->setStorageClass('\OCA\Files_External\Lib\Storage\SMB') |
|
45 | - ->setText($l->t('SMB / CIFS')) |
|
46 | - ->addParameters([ |
|
47 | - (new DefinitionParameter('host', $l->t('Host'))), |
|
48 | - (new DefinitionParameter('share', $l->t('Share'))), |
|
49 | - (new DefinitionParameter('root', $l->t('Remote subfolder'))) |
|
50 | - ->setFlag(DefinitionParameter::FLAG_OPTIONAL), |
|
51 | - (new DefinitionParameter('domain', $l->t('Domain'))) |
|
52 | - ->setFlag(DefinitionParameter::FLAG_OPTIONAL), |
|
53 | - ]) |
|
54 | - ->addAuthScheme(AuthMechanism::SCHEME_PASSWORD) |
|
55 | - ->setLegacyAuthMechanism($legacyAuth) |
|
56 | - ; |
|
57 | - } |
|
40 | + public function __construct(IL10N $l, Password $legacyAuth) { |
|
41 | + $this |
|
42 | + ->setIdentifier('smb') |
|
43 | + ->addIdentifierAlias('\OC\Files\Storage\SMB') // legacy compat |
|
44 | + ->setStorageClass('\OCA\Files_External\Lib\Storage\SMB') |
|
45 | + ->setText($l->t('SMB / CIFS')) |
|
46 | + ->addParameters([ |
|
47 | + (new DefinitionParameter('host', $l->t('Host'))), |
|
48 | + (new DefinitionParameter('share', $l->t('Share'))), |
|
49 | + (new DefinitionParameter('root', $l->t('Remote subfolder'))) |
|
50 | + ->setFlag(DefinitionParameter::FLAG_OPTIONAL), |
|
51 | + (new DefinitionParameter('domain', $l->t('Domain'))) |
|
52 | + ->setFlag(DefinitionParameter::FLAG_OPTIONAL), |
|
53 | + ]) |
|
54 | + ->addAuthScheme(AuthMechanism::SCHEME_PASSWORD) |
|
55 | + ->setLegacyAuthMechanism($legacyAuth) |
|
56 | + ; |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * @param StorageConfig $storage |
|
61 | - * @param IUser $user |
|
62 | - */ |
|
63 | - public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
64 | - $user = $storage->getBackendOption('user'); |
|
65 | - if ($domain = $storage->getBackendOption('domain')) { |
|
66 | - $storage->setBackendOption('user', $domain.'\\'.$user); |
|
67 | - } |
|
68 | - } |
|
59 | + /** |
|
60 | + * @param StorageConfig $storage |
|
61 | + * @param IUser $user |
|
62 | + */ |
|
63 | + public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
64 | + $user = $storage->getBackendOption('user'); |
|
65 | + if ($domain = $storage->getBackendOption('domain')) { |
|
66 | + $storage->setBackendOption('user', $domain.'\\'.$user); |
|
67 | + } |
|
68 | + } |
|
69 | 69 | |
70 | 70 | } |
@@ -60,7 +60,7 @@ |
||
60 | 60 | * @param StorageConfig $storage |
61 | 61 | * @param IUser $user |
62 | 62 | */ |
63 | - public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
63 | + public function manipulateStorageConfig(StorageConfig & $storage, IUser $user = null) { |
|
64 | 64 | $user = $storage->getBackendOption('user'); |
65 | 65 | if ($domain = $storage->getBackendOption('domain')) { |
66 | 66 | $storage->setBackendOption('user', $domain.'\\'.$user); |
@@ -38,36 +38,36 @@ |
||
38 | 38 | */ |
39 | 39 | class SMB_OC extends Backend { |
40 | 40 | |
41 | - use LegacyDependencyCheckPolyfill; |
|
41 | + use LegacyDependencyCheckPolyfill; |
|
42 | 42 | |
43 | - public function __construct(IL10N $l, SessionCredentials $legacyAuth, SMB $smbBackend) { |
|
44 | - $this |
|
45 | - ->setIdentifier('\OC\Files\Storage\SMB_OC') |
|
46 | - ->setStorageClass('\OCA\Files_External\Lib\Storage\SMB') |
|
47 | - ->setText($l->t('SMB / CIFS using OC login')) |
|
48 | - ->addParameters([ |
|
49 | - (new DefinitionParameter('host', $l->t('Host'))), |
|
50 | - (new DefinitionParameter('username_as_share', $l->t('Username as share'))) |
|
51 | - ->setType(DefinitionParameter::VALUE_BOOLEAN), |
|
52 | - (new DefinitionParameter('share', $l->t('Share'))) |
|
53 | - ->setFlag(DefinitionParameter::FLAG_OPTIONAL), |
|
54 | - (new DefinitionParameter('root', $l->t('Remote subfolder'))) |
|
55 | - ->setFlag(DefinitionParameter::FLAG_OPTIONAL), |
|
56 | - ]) |
|
57 | - ->setPriority(BackendService::PRIORITY_DEFAULT - 10) |
|
58 | - ->addAuthScheme(AuthMechanism::SCHEME_PASSWORD) |
|
59 | - ->setLegacyAuthMechanism($legacyAuth) |
|
60 | - ->deprecateTo($smbBackend) |
|
61 | - ; |
|
62 | - } |
|
43 | + public function __construct(IL10N $l, SessionCredentials $legacyAuth, SMB $smbBackend) { |
|
44 | + $this |
|
45 | + ->setIdentifier('\OC\Files\Storage\SMB_OC') |
|
46 | + ->setStorageClass('\OCA\Files_External\Lib\Storage\SMB') |
|
47 | + ->setText($l->t('SMB / CIFS using OC login')) |
|
48 | + ->addParameters([ |
|
49 | + (new DefinitionParameter('host', $l->t('Host'))), |
|
50 | + (new DefinitionParameter('username_as_share', $l->t('Username as share'))) |
|
51 | + ->setType(DefinitionParameter::VALUE_BOOLEAN), |
|
52 | + (new DefinitionParameter('share', $l->t('Share'))) |
|
53 | + ->setFlag(DefinitionParameter::FLAG_OPTIONAL), |
|
54 | + (new DefinitionParameter('root', $l->t('Remote subfolder'))) |
|
55 | + ->setFlag(DefinitionParameter::FLAG_OPTIONAL), |
|
56 | + ]) |
|
57 | + ->setPriority(BackendService::PRIORITY_DEFAULT - 10) |
|
58 | + ->addAuthScheme(AuthMechanism::SCHEME_PASSWORD) |
|
59 | + ->setLegacyAuthMechanism($legacyAuth) |
|
60 | + ->deprecateTo($smbBackend) |
|
61 | + ; |
|
62 | + } |
|
63 | 63 | |
64 | - public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
65 | - $username_as_share = ($storage->getBackendOption('username_as_share') === true); |
|
64 | + public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
65 | + $username_as_share = ($storage->getBackendOption('username_as_share') === true); |
|
66 | 66 | |
67 | - if ($username_as_share) { |
|
68 | - $share = '/' . $storage->getBackendOption('user'); |
|
69 | - $storage->setBackendOption('share', $share); |
|
70 | - } |
|
71 | - } |
|
67 | + if ($username_as_share) { |
|
68 | + $share = '/' . $storage->getBackendOption('user'); |
|
69 | + $storage->setBackendOption('share', $share); |
|
70 | + } |
|
71 | + } |
|
72 | 72 | |
73 | 73 | } |
@@ -61,11 +61,11 @@ |
||
61 | 61 | ; |
62 | 62 | } |
63 | 63 | |
64 | - public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
64 | + public function manipulateStorageConfig(StorageConfig & $storage, IUser $user = null) { |
|
65 | 65 | $username_as_share = ($storage->getBackendOption('username_as_share') === true); |
66 | 66 | |
67 | 67 | if ($username_as_share) { |
68 | - $share = '/' . $storage->getBackendOption('user'); |
|
68 | + $share = '/'.$storage->getBackendOption('user'); |
|
69 | 69 | $storage->setBackendOption('share', $share); |
70 | 70 | } |
71 | 71 | } |
@@ -57,110 +57,110 @@ |
||
57 | 57 | */ |
58 | 58 | class Backend implements \JsonSerializable { |
59 | 59 | |
60 | - use VisibilityTrait; |
|
61 | - use FrontendDefinitionTrait; |
|
62 | - use PriorityTrait; |
|
63 | - use DependencyTrait; |
|
64 | - use StorageModifierTrait; |
|
65 | - use IdentifierTrait; |
|
66 | - |
|
67 | - /** @var string storage class */ |
|
68 | - private $storageClass; |
|
69 | - |
|
70 | - /** @var array 'scheme' => true, supported authentication schemes */ |
|
71 | - private $authSchemes = []; |
|
72 | - |
|
73 | - /** @var AuthMechanism|callable authentication mechanism fallback */ |
|
74 | - private $legacyAuthMechanism; |
|
75 | - |
|
76 | - /** |
|
77 | - * @return string |
|
78 | - */ |
|
79 | - public function getStorageClass() { |
|
80 | - return $this->storageClass; |
|
81 | - } |
|
82 | - |
|
83 | - /** |
|
84 | - * @param string $class |
|
85 | - * @return self |
|
86 | - */ |
|
87 | - public function setStorageClass($class) { |
|
88 | - $this->storageClass = $class; |
|
89 | - return $this; |
|
90 | - } |
|
91 | - |
|
92 | - /** |
|
93 | - * @return array |
|
94 | - */ |
|
95 | - public function getAuthSchemes() { |
|
96 | - if (empty($this->authSchemes)) { |
|
97 | - return [AuthMechanism::SCHEME_NULL => true]; |
|
98 | - } |
|
99 | - return $this->authSchemes; |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * @param string $scheme |
|
104 | - * @return self |
|
105 | - */ |
|
106 | - public function addAuthScheme($scheme) { |
|
107 | - $this->authSchemes[$scheme] = true; |
|
108 | - return $this; |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * @param array $parameters storage parameters, for dynamic mechanism selection |
|
113 | - * @return AuthMechanism |
|
114 | - */ |
|
115 | - public function getLegacyAuthMechanism(array $parameters = []) { |
|
116 | - if (is_callable($this->legacyAuthMechanism)) { |
|
117 | - return call_user_func($this->legacyAuthMechanism, $parameters); |
|
118 | - } |
|
119 | - return $this->legacyAuthMechanism; |
|
120 | - } |
|
121 | - |
|
122 | - /** |
|
123 | - * @param AuthMechanism $authMechanism |
|
124 | - * @return self |
|
125 | - */ |
|
126 | - public function setLegacyAuthMechanism(AuthMechanism $authMechanism) { |
|
127 | - $this->legacyAuthMechanism = $authMechanism; |
|
128 | - return $this; |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * @param callable $callback dynamic auth mechanism selection |
|
133 | - * @return self |
|
134 | - */ |
|
135 | - public function setLegacyAuthMechanismCallback(callable $callback) { |
|
136 | - $this->legacyAuthMechanism = $callback; |
|
137 | - } |
|
138 | - |
|
139 | - /** |
|
140 | - * Serialize into JSON for client-side JS |
|
141 | - * |
|
142 | - * @return array |
|
143 | - */ |
|
144 | - public function jsonSerialize() { |
|
145 | - $data = $this->jsonSerializeDefinition(); |
|
146 | - $data += $this->jsonSerializeIdentifier(); |
|
147 | - |
|
148 | - $data['backend'] = $data['name']; // legacy compat |
|
149 | - $data['priority'] = $this->getPriority(); |
|
150 | - $data['authSchemes'] = $this->getAuthSchemes(); |
|
151 | - |
|
152 | - return $data; |
|
153 | - } |
|
154 | - |
|
155 | - /** |
|
156 | - * Check if parameters are satisfied in a StorageConfig |
|
157 | - * |
|
158 | - * @param StorageConfig $storage |
|
159 | - * @return bool |
|
160 | - */ |
|
161 | - public function validateStorage(StorageConfig $storage) { |
|
162 | - return $this->validateStorageDefinition($storage); |
|
163 | - } |
|
60 | + use VisibilityTrait; |
|
61 | + use FrontendDefinitionTrait; |
|
62 | + use PriorityTrait; |
|
63 | + use DependencyTrait; |
|
64 | + use StorageModifierTrait; |
|
65 | + use IdentifierTrait; |
|
66 | + |
|
67 | + /** @var string storage class */ |
|
68 | + private $storageClass; |
|
69 | + |
|
70 | + /** @var array 'scheme' => true, supported authentication schemes */ |
|
71 | + private $authSchemes = []; |
|
72 | + |
|
73 | + /** @var AuthMechanism|callable authentication mechanism fallback */ |
|
74 | + private $legacyAuthMechanism; |
|
75 | + |
|
76 | + /** |
|
77 | + * @return string |
|
78 | + */ |
|
79 | + public function getStorageClass() { |
|
80 | + return $this->storageClass; |
|
81 | + } |
|
82 | + |
|
83 | + /** |
|
84 | + * @param string $class |
|
85 | + * @return self |
|
86 | + */ |
|
87 | + public function setStorageClass($class) { |
|
88 | + $this->storageClass = $class; |
|
89 | + return $this; |
|
90 | + } |
|
91 | + |
|
92 | + /** |
|
93 | + * @return array |
|
94 | + */ |
|
95 | + public function getAuthSchemes() { |
|
96 | + if (empty($this->authSchemes)) { |
|
97 | + return [AuthMechanism::SCHEME_NULL => true]; |
|
98 | + } |
|
99 | + return $this->authSchemes; |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * @param string $scheme |
|
104 | + * @return self |
|
105 | + */ |
|
106 | + public function addAuthScheme($scheme) { |
|
107 | + $this->authSchemes[$scheme] = true; |
|
108 | + return $this; |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * @param array $parameters storage parameters, for dynamic mechanism selection |
|
113 | + * @return AuthMechanism |
|
114 | + */ |
|
115 | + public function getLegacyAuthMechanism(array $parameters = []) { |
|
116 | + if (is_callable($this->legacyAuthMechanism)) { |
|
117 | + return call_user_func($this->legacyAuthMechanism, $parameters); |
|
118 | + } |
|
119 | + return $this->legacyAuthMechanism; |
|
120 | + } |
|
121 | + |
|
122 | + /** |
|
123 | + * @param AuthMechanism $authMechanism |
|
124 | + * @return self |
|
125 | + */ |
|
126 | + public function setLegacyAuthMechanism(AuthMechanism $authMechanism) { |
|
127 | + $this->legacyAuthMechanism = $authMechanism; |
|
128 | + return $this; |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * @param callable $callback dynamic auth mechanism selection |
|
133 | + * @return self |
|
134 | + */ |
|
135 | + public function setLegacyAuthMechanismCallback(callable $callback) { |
|
136 | + $this->legacyAuthMechanism = $callback; |
|
137 | + } |
|
138 | + |
|
139 | + /** |
|
140 | + * Serialize into JSON for client-side JS |
|
141 | + * |
|
142 | + * @return array |
|
143 | + */ |
|
144 | + public function jsonSerialize() { |
|
145 | + $data = $this->jsonSerializeDefinition(); |
|
146 | + $data += $this->jsonSerializeIdentifier(); |
|
147 | + |
|
148 | + $data['backend'] = $data['name']; // legacy compat |
|
149 | + $data['priority'] = $this->getPriority(); |
|
150 | + $data['authSchemes'] = $this->getAuthSchemes(); |
|
151 | + |
|
152 | + return $data; |
|
153 | + } |
|
154 | + |
|
155 | + /** |
|
156 | + * Check if parameters are satisfied in a StorageConfig |
|
157 | + * |
|
158 | + * @param StorageConfig $storage |
|
159 | + * @return bool |
|
160 | + */ |
|
161 | + public function validateStorage(StorageConfig $storage) { |
|
162 | + return $this->validateStorageDefinition($storage); |
|
163 | + } |
|
164 | 164 | |
165 | 165 | } |
166 | 166 |
@@ -33,21 +33,21 @@ |
||
33 | 33 | |
34 | 34 | class Dropbox extends Backend { |
35 | 35 | |
36 | - use LegacyDependencyCheckPolyfill; |
|
36 | + use LegacyDependencyCheckPolyfill; |
|
37 | 37 | |
38 | - public function __construct(IL10N $l, OAuth1 $legacyAuth) { |
|
39 | - $this |
|
40 | - ->setIdentifier('dropbox') |
|
41 | - ->addIdentifierAlias('\OC\Files\Storage\Dropbox') // legacy compat |
|
42 | - ->setStorageClass('\OCA\Files_External\Lib\Storage\Dropbox') |
|
43 | - ->setText($l->t('Dropbox')) |
|
44 | - ->addParameters([ |
|
45 | - // all parameters handled in OAuth1 mechanism |
|
46 | - ]) |
|
47 | - ->addAuthScheme(AuthMechanism::SCHEME_OAUTH1) |
|
48 | - ->addCustomJs('dropbox') |
|
49 | - ->setLegacyAuthMechanism($legacyAuth) |
|
50 | - ; |
|
51 | - } |
|
38 | + public function __construct(IL10N $l, OAuth1 $legacyAuth) { |
|
39 | + $this |
|
40 | + ->setIdentifier('dropbox') |
|
41 | + ->addIdentifierAlias('\OC\Files\Storage\Dropbox') // legacy compat |
|
42 | + ->setStorageClass('\OCA\Files_External\Lib\Storage\Dropbox') |
|
43 | + ->setText($l->t('Dropbox')) |
|
44 | + ->addParameters([ |
|
45 | + // all parameters handled in OAuth1 mechanism |
|
46 | + ]) |
|
47 | + ->addAuthScheme(AuthMechanism::SCHEME_OAUTH1) |
|
48 | + ->addCustomJs('dropbox') |
|
49 | + ->setLegacyAuthMechanism($legacyAuth) |
|
50 | + ; |
|
51 | + } |
|
52 | 52 | |
53 | 53 | } |
@@ -31,129 +31,129 @@ |
||
31 | 31 | */ |
32 | 32 | trait FrontendDefinitionTrait { |
33 | 33 | |
34 | - /** @var string human-readable mechanism name */ |
|
35 | - private $text; |
|
36 | - |
|
37 | - /** @var DefinitionParameter[] parameters for mechanism */ |
|
38 | - private $parameters = []; |
|
39 | - |
|
40 | - /** @var string[] custom JS */ |
|
41 | - private $customJs = []; |
|
42 | - |
|
43 | - /** |
|
44 | - * @return string |
|
45 | - */ |
|
46 | - public function getText() { |
|
47 | - return $this->text; |
|
48 | - } |
|
49 | - |
|
50 | - /** |
|
51 | - * @param string $text |
|
52 | - * @return self |
|
53 | - */ |
|
54 | - public function setText($text) { |
|
55 | - $this->text = $text; |
|
56 | - return $this; |
|
57 | - } |
|
58 | - |
|
59 | - /** |
|
60 | - * @param FrontendDefinitionTrait $a |
|
61 | - * @param FrontendDefinitionTrait $b |
|
62 | - * @return int |
|
63 | - */ |
|
64 | - public static function lexicalCompare(FrontendDefinitionTrait $a, FrontendDefinitionTrait $b) { |
|
65 | - return strcmp($a->getText(), $b->getText()); |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * @return DefinitionParameter[] |
|
70 | - */ |
|
71 | - public function getParameters() { |
|
72 | - return $this->parameters; |
|
73 | - } |
|
74 | - |
|
75 | - /** |
|
76 | - * @param DefinitionParameter[] $parameters |
|
77 | - * @return self |
|
78 | - */ |
|
79 | - public function addParameters(array $parameters) { |
|
80 | - foreach ($parameters as $parameter) { |
|
81 | - $this->addParameter($parameter); |
|
82 | - } |
|
83 | - return $this; |
|
84 | - } |
|
85 | - |
|
86 | - /** |
|
87 | - * @param DefinitionParameter $parameter |
|
88 | - * @return self |
|
89 | - */ |
|
90 | - public function addParameter(DefinitionParameter $parameter) { |
|
91 | - $this->parameters[$parameter->getName()] = $parameter; |
|
92 | - return $this; |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * @return string[] |
|
97 | - */ |
|
98 | - public function getCustomJs() { |
|
99 | - return $this->customJs; |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * @param string $custom |
|
104 | - * @return self |
|
105 | - */ |
|
106 | - public function addCustomJs($custom) { |
|
107 | - $this->customJs[] = $custom; |
|
108 | - return $this; |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * @param string $custom |
|
113 | - * @return self |
|
114 | - * @deprecated 9.1.0, use addCustomJs() instead |
|
115 | - */ |
|
116 | - public function setCustomJs($custom) { |
|
117 | - $this->customJs = [$custom]; |
|
118 | - return $this; |
|
119 | - } |
|
120 | - |
|
121 | - /** |
|
122 | - * Serialize into JSON for client-side JS |
|
123 | - * |
|
124 | - * @return array |
|
125 | - */ |
|
126 | - public function jsonSerializeDefinition() { |
|
127 | - $configuration = []; |
|
128 | - foreach ($this->getParameters() as $parameter) { |
|
129 | - $configuration[$parameter->getName()] = $parameter; |
|
130 | - } |
|
131 | - |
|
132 | - $data = [ |
|
133 | - 'name' => $this->getText(), |
|
134 | - 'configuration' => $configuration, |
|
135 | - 'custom' => $this->getCustomJs(), |
|
136 | - ]; |
|
137 | - return $data; |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * Check if parameters are satisfied in a StorageConfig |
|
142 | - * |
|
143 | - * @param StorageConfig $storage |
|
144 | - * @return bool |
|
145 | - */ |
|
146 | - public function validateStorageDefinition(StorageConfig $storage) { |
|
147 | - foreach ($this->getParameters() as $name => $parameter) { |
|
148 | - $value = $storage->getBackendOption($name); |
|
149 | - if (!is_null($value) || !$parameter->isOptional()) { |
|
150 | - if (!$parameter->validateValue($value)) { |
|
151 | - return false; |
|
152 | - } |
|
153 | - $storage->setBackendOption($name, $value); |
|
154 | - } |
|
155 | - } |
|
156 | - return true; |
|
157 | - } |
|
34 | + /** @var string human-readable mechanism name */ |
|
35 | + private $text; |
|
36 | + |
|
37 | + /** @var DefinitionParameter[] parameters for mechanism */ |
|
38 | + private $parameters = []; |
|
39 | + |
|
40 | + /** @var string[] custom JS */ |
|
41 | + private $customJs = []; |
|
42 | + |
|
43 | + /** |
|
44 | + * @return string |
|
45 | + */ |
|
46 | + public function getText() { |
|
47 | + return $this->text; |
|
48 | + } |
|
49 | + |
|
50 | + /** |
|
51 | + * @param string $text |
|
52 | + * @return self |
|
53 | + */ |
|
54 | + public function setText($text) { |
|
55 | + $this->text = $text; |
|
56 | + return $this; |
|
57 | + } |
|
58 | + |
|
59 | + /** |
|
60 | + * @param FrontendDefinitionTrait $a |
|
61 | + * @param FrontendDefinitionTrait $b |
|
62 | + * @return int |
|
63 | + */ |
|
64 | + public static function lexicalCompare(FrontendDefinitionTrait $a, FrontendDefinitionTrait $b) { |
|
65 | + return strcmp($a->getText(), $b->getText()); |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * @return DefinitionParameter[] |
|
70 | + */ |
|
71 | + public function getParameters() { |
|
72 | + return $this->parameters; |
|
73 | + } |
|
74 | + |
|
75 | + /** |
|
76 | + * @param DefinitionParameter[] $parameters |
|
77 | + * @return self |
|
78 | + */ |
|
79 | + public function addParameters(array $parameters) { |
|
80 | + foreach ($parameters as $parameter) { |
|
81 | + $this->addParameter($parameter); |
|
82 | + } |
|
83 | + return $this; |
|
84 | + } |
|
85 | + |
|
86 | + /** |
|
87 | + * @param DefinitionParameter $parameter |
|
88 | + * @return self |
|
89 | + */ |
|
90 | + public function addParameter(DefinitionParameter $parameter) { |
|
91 | + $this->parameters[$parameter->getName()] = $parameter; |
|
92 | + return $this; |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * @return string[] |
|
97 | + */ |
|
98 | + public function getCustomJs() { |
|
99 | + return $this->customJs; |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * @param string $custom |
|
104 | + * @return self |
|
105 | + */ |
|
106 | + public function addCustomJs($custom) { |
|
107 | + $this->customJs[] = $custom; |
|
108 | + return $this; |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * @param string $custom |
|
113 | + * @return self |
|
114 | + * @deprecated 9.1.0, use addCustomJs() instead |
|
115 | + */ |
|
116 | + public function setCustomJs($custom) { |
|
117 | + $this->customJs = [$custom]; |
|
118 | + return $this; |
|
119 | + } |
|
120 | + |
|
121 | + /** |
|
122 | + * Serialize into JSON for client-side JS |
|
123 | + * |
|
124 | + * @return array |
|
125 | + */ |
|
126 | + public function jsonSerializeDefinition() { |
|
127 | + $configuration = []; |
|
128 | + foreach ($this->getParameters() as $parameter) { |
|
129 | + $configuration[$parameter->getName()] = $parameter; |
|
130 | + } |
|
131 | + |
|
132 | + $data = [ |
|
133 | + 'name' => $this->getText(), |
|
134 | + 'configuration' => $configuration, |
|
135 | + 'custom' => $this->getCustomJs(), |
|
136 | + ]; |
|
137 | + return $data; |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * Check if parameters are satisfied in a StorageConfig |
|
142 | + * |
|
143 | + * @param StorageConfig $storage |
|
144 | + * @return bool |
|
145 | + */ |
|
146 | + public function validateStorageDefinition(StorageConfig $storage) { |
|
147 | + foreach ($this->getParameters() as $name => $parameter) { |
|
148 | + $value = $storage->getBackendOption($name); |
|
149 | + if (!is_null($value) || !$parameter->isOptional()) { |
|
150 | + if (!$parameter->validateValue($value)) { |
|
151 | + return false; |
|
152 | + } |
|
153 | + $storage->setBackendOption($name, $value); |
|
154 | + } |
|
155 | + } |
|
156 | + return true; |
|
157 | + } |
|
158 | 158 | |
159 | 159 | } |
@@ -27,39 +27,39 @@ |
||
27 | 27 | */ |
28 | 28 | class MissingDependency { |
29 | 29 | |
30 | - /** @var string */ |
|
31 | - private $dependency; |
|
30 | + /** @var string */ |
|
31 | + private $dependency; |
|
32 | 32 | |
33 | - /** @var string|null Custom message */ |
|
34 | - private $message = null; |
|
33 | + /** @var string|null Custom message */ |
|
34 | + private $message = null; |
|
35 | 35 | |
36 | - /** |
|
37 | - * @param string $dependency |
|
38 | - */ |
|
39 | - public function __construct($dependency) { |
|
40 | - $this->dependency = $dependency; |
|
41 | - } |
|
36 | + /** |
|
37 | + * @param string $dependency |
|
38 | + */ |
|
39 | + public function __construct($dependency) { |
|
40 | + $this->dependency = $dependency; |
|
41 | + } |
|
42 | 42 | |
43 | - /** |
|
44 | - * @return string |
|
45 | - */ |
|
46 | - public function getDependency() { |
|
47 | - return $this->dependency; |
|
48 | - } |
|
43 | + /** |
|
44 | + * @return string |
|
45 | + */ |
|
46 | + public function getDependency() { |
|
47 | + return $this->dependency; |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * @return string|null |
|
52 | - */ |
|
53 | - public function getMessage() { |
|
54 | - return $this->message; |
|
55 | - } |
|
50 | + /** |
|
51 | + * @return string|null |
|
52 | + */ |
|
53 | + public function getMessage() { |
|
54 | + return $this->message; |
|
55 | + } |
|
56 | 56 | |
57 | - /** |
|
58 | - * @param string $message |
|
59 | - * @return self |
|
60 | - */ |
|
61 | - public function setMessage($message) { |
|
62 | - $this->message = $message; |
|
63 | - return $this; |
|
64 | - } |
|
57 | + /** |
|
58 | + * @param string $message |
|
59 | + * @return self |
|
60 | + */ |
|
61 | + public function setMessage($message) { |
|
62 | + $this->message = $message; |
|
63 | + return $this; |
|
64 | + } |
|
65 | 65 | } |
@@ -29,14 +29,14 @@ |
||
29 | 29 | */ |
30 | 30 | trait DependencyTrait { |
31 | 31 | |
32 | - /** |
|
33 | - * Check if object is valid for use |
|
34 | - * |
|
35 | - * @return MissingDependency[] Unsatisfied dependencies |
|
36 | - */ |
|
37 | - public function checkDependencies() { |
|
38 | - return []; // no dependencies by default |
|
39 | - } |
|
32 | + /** |
|
33 | + * Check if object is valid for use |
|
34 | + * |
|
35 | + * @return MissingDependency[] Unsatisfied dependencies |
|
36 | + */ |
|
37 | + public function checkDependencies() { |
|
38 | + return []; // no dependencies by default |
|
39 | + } |
|
40 | 40 | |
41 | 41 | } |
42 | 42 |
@@ -28,61 +28,61 @@ |
||
28 | 28 | |
29 | 29 | class Api { |
30 | 30 | |
31 | - /** |
|
32 | - * Formats the given mount config to a mount entry. |
|
33 | - * |
|
34 | - * @param string $mountPoint mount point name, relative to the data dir |
|
35 | - * @param array $mountConfig mount config to format |
|
36 | - * |
|
37 | - * @return array entry |
|
38 | - */ |
|
39 | - private static function formatMount($mountPoint, $mountConfig) { |
|
40 | - // strip "/$user/files" from mount point |
|
41 | - $mountPoint = explode('/', trim($mountPoint, '/'), 3); |
|
42 | - $mountPoint = $mountPoint[2]; |
|
31 | + /** |
|
32 | + * Formats the given mount config to a mount entry. |
|
33 | + * |
|
34 | + * @param string $mountPoint mount point name, relative to the data dir |
|
35 | + * @param array $mountConfig mount config to format |
|
36 | + * |
|
37 | + * @return array entry |
|
38 | + */ |
|
39 | + private static function formatMount($mountPoint, $mountConfig) { |
|
40 | + // strip "/$user/files" from mount point |
|
41 | + $mountPoint = explode('/', trim($mountPoint, '/'), 3); |
|
42 | + $mountPoint = $mountPoint[2]; |
|
43 | 43 | |
44 | - // split path from mount point |
|
45 | - $path = dirname($mountPoint); |
|
46 | - if ($path === '.') { |
|
47 | - $path = ''; |
|
48 | - } |
|
44 | + // split path from mount point |
|
45 | + $path = dirname($mountPoint); |
|
46 | + if ($path === '.') { |
|
47 | + $path = ''; |
|
48 | + } |
|
49 | 49 | |
50 | - $isSystemMount = !$mountConfig['personal']; |
|
50 | + $isSystemMount = !$mountConfig['personal']; |
|
51 | 51 | |
52 | - $permissions = \OCP\Constants::PERMISSION_READ; |
|
53 | - // personal mounts can be deleted |
|
54 | - if (!$isSystemMount) { |
|
55 | - $permissions |= \OCP\Constants::PERMISSION_DELETE; |
|
56 | - } |
|
52 | + $permissions = \OCP\Constants::PERMISSION_READ; |
|
53 | + // personal mounts can be deleted |
|
54 | + if (!$isSystemMount) { |
|
55 | + $permissions |= \OCP\Constants::PERMISSION_DELETE; |
|
56 | + } |
|
57 | 57 | |
58 | - $entry = array( |
|
59 | - 'name' => basename($mountPoint), |
|
60 | - 'path' => $path, |
|
61 | - 'type' => 'dir', |
|
62 | - 'backend' => $mountConfig['backend'], |
|
63 | - 'scope' => ( $isSystemMount ? 'system' : 'personal' ), |
|
64 | - 'permissions' => $permissions, |
|
65 | - 'id' => $mountConfig['id'], |
|
66 | - 'class' => $mountConfig['class'] |
|
67 | - ); |
|
68 | - return $entry; |
|
69 | - } |
|
58 | + $entry = array( |
|
59 | + 'name' => basename($mountPoint), |
|
60 | + 'path' => $path, |
|
61 | + 'type' => 'dir', |
|
62 | + 'backend' => $mountConfig['backend'], |
|
63 | + 'scope' => ( $isSystemMount ? 'system' : 'personal' ), |
|
64 | + 'permissions' => $permissions, |
|
65 | + 'id' => $mountConfig['id'], |
|
66 | + 'class' => $mountConfig['class'] |
|
67 | + ); |
|
68 | + return $entry; |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * Returns the mount points visible for this user. |
|
73 | - * |
|
74 | - * @param array $params |
|
75 | - * @return \OC_OCS_Result share information |
|
76 | - */ |
|
77 | - public static function getUserMounts($params) { |
|
78 | - $entries = array(); |
|
79 | - $user = \OC::$server->getUserSession()->getUser()->getUID(); |
|
71 | + /** |
|
72 | + * Returns the mount points visible for this user. |
|
73 | + * |
|
74 | + * @param array $params |
|
75 | + * @return \OC_OCS_Result share information |
|
76 | + */ |
|
77 | + public static function getUserMounts($params) { |
|
78 | + $entries = array(); |
|
79 | + $user = \OC::$server->getUserSession()->getUser()->getUID(); |
|
80 | 80 | |
81 | - $mounts = \OC_Mount_Config::getAbsoluteMountPoints($user); |
|
82 | - foreach($mounts as $mountPoint => $mount) { |
|
83 | - $entries[] = self::formatMount($mountPoint, $mount); |
|
84 | - } |
|
81 | + $mounts = \OC_Mount_Config::getAbsoluteMountPoints($user); |
|
82 | + foreach($mounts as $mountPoint => $mount) { |
|
83 | + $entries[] = self::formatMount($mountPoint, $mount); |
|
84 | + } |
|
85 | 85 | |
86 | - return new \OC_OCS_Result($entries); |
|
87 | - } |
|
86 | + return new \OC_OCS_Result($entries); |
|
87 | + } |
|
88 | 88 | } |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | 'path' => $path, |
61 | 61 | 'type' => 'dir', |
62 | 62 | 'backend' => $mountConfig['backend'], |
63 | - 'scope' => ( $isSystemMount ? 'system' : 'personal' ), |
|
63 | + 'scope' => ($isSystemMount ? 'system' : 'personal'), |
|
64 | 64 | 'permissions' => $permissions, |
65 | 65 | 'id' => $mountConfig['id'], |
66 | 66 | 'class' => $mountConfig['class'] |
@@ -79,7 +79,7 @@ discard block |
||
79 | 79 | $user = \OC::$server->getUserSession()->getUser()->getUID(); |
80 | 80 | |
81 | 81 | $mounts = \OC_Mount_Config::getAbsoluteMountPoints($user); |
82 | - foreach($mounts as $mountPoint => $mount) { |
|
82 | + foreach ($mounts as $mountPoint => $mount) { |
|
83 | 83 | $entries[] = self::formatMount($mountPoint, $mount); |
84 | 84 | } |
85 | 85 |
@@ -28,76 +28,76 @@ |
||
28 | 28 | */ |
29 | 29 | trait IdentifierTrait { |
30 | 30 | |
31 | - /** @var string */ |
|
32 | - protected $identifier; |
|
31 | + /** @var string */ |
|
32 | + protected $identifier; |
|
33 | 33 | |
34 | - /** @var string[] */ |
|
35 | - protected $identifierAliases = []; |
|
34 | + /** @var string[] */ |
|
35 | + protected $identifierAliases = []; |
|
36 | 36 | |
37 | - /** @var IdentifierTrait */ |
|
38 | - protected $deprecateTo = null; |
|
37 | + /** @var IdentifierTrait */ |
|
38 | + protected $deprecateTo = null; |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function getIdentifier() { |
|
44 | - return $this->identifier; |
|
45 | - } |
|
40 | + /** |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function getIdentifier() { |
|
44 | + return $this->identifier; |
|
45 | + } |
|
46 | 46 | |
47 | - /** |
|
48 | - * @param string $identifier |
|
49 | - * @return self |
|
50 | - */ |
|
51 | - public function setIdentifier($identifier) { |
|
52 | - $this->identifier = $identifier; |
|
53 | - $this->identifierAliases[] = $identifier; |
|
54 | - return $this; |
|
55 | - } |
|
47 | + /** |
|
48 | + * @param string $identifier |
|
49 | + * @return self |
|
50 | + */ |
|
51 | + public function setIdentifier($identifier) { |
|
52 | + $this->identifier = $identifier; |
|
53 | + $this->identifierAliases[] = $identifier; |
|
54 | + return $this; |
|
55 | + } |
|
56 | 56 | |
57 | - /** |
|
58 | - * @return string[] |
|
59 | - */ |
|
60 | - public function getIdentifierAliases() { |
|
61 | - return $this->identifierAliases; |
|
62 | - } |
|
57 | + /** |
|
58 | + * @return string[] |
|
59 | + */ |
|
60 | + public function getIdentifierAliases() { |
|
61 | + return $this->identifierAliases; |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * @param string $alias |
|
66 | - * @return self |
|
67 | - */ |
|
68 | - public function addIdentifierAlias($alias) { |
|
69 | - $this->identifierAliases[] = $alias; |
|
70 | - return $this; |
|
71 | - } |
|
64 | + /** |
|
65 | + * @param string $alias |
|
66 | + * @return self |
|
67 | + */ |
|
68 | + public function addIdentifierAlias($alias) { |
|
69 | + $this->identifierAliases[] = $alias; |
|
70 | + return $this; |
|
71 | + } |
|
72 | 72 | |
73 | - /** |
|
74 | - * @return object|null |
|
75 | - */ |
|
76 | - public function getDeprecateTo() { |
|
77 | - return $this->deprecateTo; |
|
78 | - } |
|
73 | + /** |
|
74 | + * @return object|null |
|
75 | + */ |
|
76 | + public function getDeprecateTo() { |
|
77 | + return $this->deprecateTo; |
|
78 | + } |
|
79 | 79 | |
80 | - /** |
|
81 | - * @param object $destinationObject |
|
82 | - * @return self |
|
83 | - */ |
|
84 | - public function deprecateTo($destinationObject) { |
|
85 | - $this->deprecateTo = $destinationObject; |
|
86 | - return $this; |
|
87 | - } |
|
80 | + /** |
|
81 | + * @param object $destinationObject |
|
82 | + * @return self |
|
83 | + */ |
|
84 | + public function deprecateTo($destinationObject) { |
|
85 | + $this->deprecateTo = $destinationObject; |
|
86 | + return $this; |
|
87 | + } |
|
88 | 88 | |
89 | - /** |
|
90 | - * @return array |
|
91 | - */ |
|
92 | - public function jsonSerializeIdentifier() { |
|
93 | - $data = [ |
|
94 | - 'identifier' => $this->identifier, |
|
95 | - 'identifierAliases' => $this->identifierAliases, |
|
96 | - ]; |
|
97 | - if ($this->deprecateTo) { |
|
98 | - $data['deprecateTo'] = $this->deprecateTo->getIdentifier(); |
|
99 | - } |
|
100 | - return $data; |
|
101 | - } |
|
89 | + /** |
|
90 | + * @return array |
|
91 | + */ |
|
92 | + public function jsonSerializeIdentifier() { |
|
93 | + $data = [ |
|
94 | + 'identifier' => $this->identifier, |
|
95 | + 'identifierAliases' => $this->identifierAliases, |
|
96 | + ]; |
|
97 | + if ($this->deprecateTo) { |
|
98 | + $data['deprecateTo'] = $this->deprecateTo->getIdentifier(); |
|
99 | + } |
|
100 | + return $data; |
|
101 | + } |
|
102 | 102 | |
103 | 103 | } |