@@ -37,55 +37,55 @@ |
||
37 | 37 | * @since 8.1.0 |
38 | 38 | */ |
39 | 39 | interface IMemcache extends ICache { |
40 | - /** |
|
41 | - * Set a value in the cache if it's not already stored |
|
42 | - * |
|
43 | - * @param string $key |
|
44 | - * @param mixed $value |
|
45 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
46 | - * @return bool |
|
47 | - * @since 8.1.0 |
|
48 | - */ |
|
49 | - public function add($key, $value, $ttl = 0); |
|
40 | + /** |
|
41 | + * Set a value in the cache if it's not already stored |
|
42 | + * |
|
43 | + * @param string $key |
|
44 | + * @param mixed $value |
|
45 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
46 | + * @return bool |
|
47 | + * @since 8.1.0 |
|
48 | + */ |
|
49 | + public function add($key, $value, $ttl = 0); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Increase a stored number |
|
53 | - * |
|
54 | - * @param string $key |
|
55 | - * @param int $step |
|
56 | - * @return int | bool |
|
57 | - * @since 8.1.0 |
|
58 | - */ |
|
59 | - public function inc($key, $step = 1); |
|
51 | + /** |
|
52 | + * Increase a stored number |
|
53 | + * |
|
54 | + * @param string $key |
|
55 | + * @param int $step |
|
56 | + * @return int | bool |
|
57 | + * @since 8.1.0 |
|
58 | + */ |
|
59 | + public function inc($key, $step = 1); |
|
60 | 60 | |
61 | - /** |
|
62 | - * Decrease a stored number |
|
63 | - * |
|
64 | - * @param string $key |
|
65 | - * @param int $step |
|
66 | - * @return int | bool |
|
67 | - * @since 8.1.0 |
|
68 | - */ |
|
69 | - public function dec($key, $step = 1); |
|
61 | + /** |
|
62 | + * Decrease a stored number |
|
63 | + * |
|
64 | + * @param string $key |
|
65 | + * @param int $step |
|
66 | + * @return int | bool |
|
67 | + * @since 8.1.0 |
|
68 | + */ |
|
69 | + public function dec($key, $step = 1); |
|
70 | 70 | |
71 | - /** |
|
72 | - * Compare and set |
|
73 | - * |
|
74 | - * @param string $key |
|
75 | - * @param mixed $old |
|
76 | - * @param mixed $new |
|
77 | - * @return bool |
|
78 | - * @since 8.1.0 |
|
79 | - */ |
|
80 | - public function cas($key, $old, $new); |
|
71 | + /** |
|
72 | + * Compare and set |
|
73 | + * |
|
74 | + * @param string $key |
|
75 | + * @param mixed $old |
|
76 | + * @param mixed $new |
|
77 | + * @return bool |
|
78 | + * @since 8.1.0 |
|
79 | + */ |
|
80 | + public function cas($key, $old, $new); |
|
81 | 81 | |
82 | - /** |
|
83 | - * Compare and delete |
|
84 | - * |
|
85 | - * @param string $key |
|
86 | - * @param mixed $old |
|
87 | - * @return bool |
|
88 | - * @since 8.1.0 |
|
89 | - */ |
|
90 | - public function cad($key, $old); |
|
82 | + /** |
|
83 | + * Compare and delete |
|
84 | + * |
|
85 | + * @param string $key |
|
86 | + * @param mixed $old |
|
87 | + * @return bool |
|
88 | + * @since 8.1.0 |
|
89 | + */ |
|
90 | + public function cad($key, $old); |
|
91 | 91 | } |
@@ -32,13 +32,13 @@ |
||
32 | 32 | */ |
33 | 33 | interface IFile { |
34 | 34 | |
35 | - /** |
|
36 | - * get list of users with access to the file |
|
37 | - * |
|
38 | - * @param string $path to the file |
|
39 | - * @return array |
|
40 | - * @since 8.1.0 |
|
41 | - */ |
|
42 | - public function getAccessList($path); |
|
35 | + /** |
|
36 | + * get list of users with access to the file |
|
37 | + * |
|
38 | + * @param string $path to the file |
|
39 | + * @return array |
|
40 | + * @since 8.1.0 |
|
41 | + */ |
|
42 | + public function getAccessList($path); |
|
43 | 43 | |
44 | 44 | } |
@@ -34,67 +34,67 @@ |
||
34 | 34 | */ |
35 | 35 | interface IManager { |
36 | 36 | |
37 | - /** |
|
38 | - * Check if encryption is available (at least one encryption module needs to be enabled) |
|
39 | - * |
|
40 | - * @return bool true if enabled, false if not |
|
41 | - * @since 8.1.0 |
|
42 | - */ |
|
43 | - public function isEnabled(); |
|
37 | + /** |
|
38 | + * Check if encryption is available (at least one encryption module needs to be enabled) |
|
39 | + * |
|
40 | + * @return bool true if enabled, false if not |
|
41 | + * @since 8.1.0 |
|
42 | + */ |
|
43 | + public function isEnabled(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * Registers an callback function which must return an encryption module instance |
|
47 | - * |
|
48 | - * @param string $id |
|
49 | - * @param string $displayName |
|
50 | - * @param callable $callback |
|
51 | - * @throws ModuleAlreadyExistsException |
|
52 | - * @since 8.1.0 |
|
53 | - */ |
|
54 | - public function registerEncryptionModule($id, $displayName, callable $callback); |
|
45 | + /** |
|
46 | + * Registers an callback function which must return an encryption module instance |
|
47 | + * |
|
48 | + * @param string $id |
|
49 | + * @param string $displayName |
|
50 | + * @param callable $callback |
|
51 | + * @throws ModuleAlreadyExistsException |
|
52 | + * @since 8.1.0 |
|
53 | + */ |
|
54 | + public function registerEncryptionModule($id, $displayName, callable $callback); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Unregisters an encryption module |
|
58 | - * |
|
59 | - * @param string $moduleId |
|
60 | - * @since 8.1.0 |
|
61 | - */ |
|
62 | - public function unregisterEncryptionModule($moduleId); |
|
56 | + /** |
|
57 | + * Unregisters an encryption module |
|
58 | + * |
|
59 | + * @param string $moduleId |
|
60 | + * @since 8.1.0 |
|
61 | + */ |
|
62 | + public function unregisterEncryptionModule($moduleId); |
|
63 | 63 | |
64 | - /** |
|
65 | - * get a list of all encryption modules |
|
66 | - * |
|
67 | - * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
68 | - * @since 8.1.0 |
|
69 | - */ |
|
70 | - public function getEncryptionModules(); |
|
64 | + /** |
|
65 | + * get a list of all encryption modules |
|
66 | + * |
|
67 | + * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
68 | + * @since 8.1.0 |
|
69 | + */ |
|
70 | + public function getEncryptionModules(); |
|
71 | 71 | |
72 | 72 | |
73 | - /** |
|
74 | - * get a specific encryption module |
|
75 | - * |
|
76 | - * @param string $moduleId Empty to get the default module |
|
77 | - * @return IEncryptionModule |
|
78 | - * @throws ModuleDoesNotExistsException |
|
79 | - * @since 8.1.0 |
|
80 | - */ |
|
81 | - public function getEncryptionModule($moduleId = ''); |
|
73 | + /** |
|
74 | + * get a specific encryption module |
|
75 | + * |
|
76 | + * @param string $moduleId Empty to get the default module |
|
77 | + * @return IEncryptionModule |
|
78 | + * @throws ModuleDoesNotExistsException |
|
79 | + * @since 8.1.0 |
|
80 | + */ |
|
81 | + public function getEncryptionModule($moduleId = ''); |
|
82 | 82 | |
83 | - /** |
|
84 | - * get default encryption module Id |
|
85 | - * |
|
86 | - * @return string |
|
87 | - * @since 8.1.0 |
|
88 | - */ |
|
89 | - public function getDefaultEncryptionModuleId(); |
|
83 | + /** |
|
84 | + * get default encryption module Id |
|
85 | + * |
|
86 | + * @return string |
|
87 | + * @since 8.1.0 |
|
88 | + */ |
|
89 | + public function getDefaultEncryptionModuleId(); |
|
90 | 90 | |
91 | - /** |
|
92 | - * set default encryption module Id |
|
93 | - * |
|
94 | - * @param string $moduleId |
|
95 | - * @return string |
|
96 | - * @since 8.1.0 |
|
97 | - */ |
|
98 | - public function setDefaultEncryptionModule($moduleId); |
|
91 | + /** |
|
92 | + * set default encryption module Id |
|
93 | + * |
|
94 | + * @param string $moduleId |
|
95 | + * @return string |
|
96 | + * @since 8.1.0 |
|
97 | + */ |
|
98 | + public function setDefaultEncryptionModule($moduleId); |
|
99 | 99 | |
100 | 100 | } |
@@ -33,151 +33,151 @@ |
||
33 | 33 | */ |
34 | 34 | interface IStorage { |
35 | 35 | |
36 | - /** |
|
37 | - * get user specific key |
|
38 | - * |
|
39 | - * @param string $uid ID if the user for whom we want the key |
|
40 | - * @param string $keyId id of the key |
|
41 | - * @param string $encryptionModuleId |
|
42 | - * |
|
43 | - * @return mixed key |
|
44 | - * @since 8.1.0 |
|
45 | - */ |
|
46 | - public function getUserKey($uid, $keyId, $encryptionModuleId); |
|
36 | + /** |
|
37 | + * get user specific key |
|
38 | + * |
|
39 | + * @param string $uid ID if the user for whom we want the key |
|
40 | + * @param string $keyId id of the key |
|
41 | + * @param string $encryptionModuleId |
|
42 | + * |
|
43 | + * @return mixed key |
|
44 | + * @since 8.1.0 |
|
45 | + */ |
|
46 | + public function getUserKey($uid, $keyId, $encryptionModuleId); |
|
47 | 47 | |
48 | - /** |
|
49 | - * get file specific key |
|
50 | - * |
|
51 | - * @param string $path path to file |
|
52 | - * @param string $keyId id of the key |
|
53 | - * @param string $encryptionModuleId |
|
54 | - * |
|
55 | - * @return mixed key |
|
56 | - * @since 8.1.0 |
|
57 | - */ |
|
58 | - public function getFileKey($path, $keyId, $encryptionModuleId); |
|
48 | + /** |
|
49 | + * get file specific key |
|
50 | + * |
|
51 | + * @param string $path path to file |
|
52 | + * @param string $keyId id of the key |
|
53 | + * @param string $encryptionModuleId |
|
54 | + * |
|
55 | + * @return mixed key |
|
56 | + * @since 8.1.0 |
|
57 | + */ |
|
58 | + public function getFileKey($path, $keyId, $encryptionModuleId); |
|
59 | 59 | |
60 | - /** |
|
61 | - * get system-wide encryption keys not related to a specific user, |
|
62 | - * e.g something like a key for public link shares |
|
63 | - * |
|
64 | - * @param string $keyId id of the key |
|
65 | - * @param string $encryptionModuleId |
|
66 | - * |
|
67 | - * @return mixed key |
|
68 | - * @since 8.1.0 |
|
69 | - */ |
|
70 | - public function getSystemUserKey($keyId, $encryptionModuleId); |
|
60 | + /** |
|
61 | + * get system-wide encryption keys not related to a specific user, |
|
62 | + * e.g something like a key for public link shares |
|
63 | + * |
|
64 | + * @param string $keyId id of the key |
|
65 | + * @param string $encryptionModuleId |
|
66 | + * |
|
67 | + * @return mixed key |
|
68 | + * @since 8.1.0 |
|
69 | + */ |
|
70 | + public function getSystemUserKey($keyId, $encryptionModuleId); |
|
71 | 71 | |
72 | - /** |
|
73 | - * set user specific key |
|
74 | - * |
|
75 | - * @param string $uid ID if the user for whom we want the key |
|
76 | - * @param string $keyId id of the key |
|
77 | - * @param mixed $key |
|
78 | - * @param string $encryptionModuleId |
|
79 | - * @since 8.1.0 |
|
80 | - */ |
|
81 | - public function setUserKey($uid, $keyId, $key, $encryptionModuleId); |
|
72 | + /** |
|
73 | + * set user specific key |
|
74 | + * |
|
75 | + * @param string $uid ID if the user for whom we want the key |
|
76 | + * @param string $keyId id of the key |
|
77 | + * @param mixed $key |
|
78 | + * @param string $encryptionModuleId |
|
79 | + * @since 8.1.0 |
|
80 | + */ |
|
81 | + public function setUserKey($uid, $keyId, $key, $encryptionModuleId); |
|
82 | 82 | |
83 | - /** |
|
84 | - * set file specific key |
|
85 | - * |
|
86 | - * @param string $path path to file |
|
87 | - * @param string $keyId id of the key |
|
88 | - * @param mixed $key |
|
89 | - * @param string $encryptionModuleId |
|
90 | - * @since 8.1.0 |
|
91 | - */ |
|
92 | - public function setFileKey($path, $keyId, $key, $encryptionModuleId); |
|
83 | + /** |
|
84 | + * set file specific key |
|
85 | + * |
|
86 | + * @param string $path path to file |
|
87 | + * @param string $keyId id of the key |
|
88 | + * @param mixed $key |
|
89 | + * @param string $encryptionModuleId |
|
90 | + * @since 8.1.0 |
|
91 | + */ |
|
92 | + public function setFileKey($path, $keyId, $key, $encryptionModuleId); |
|
93 | 93 | |
94 | - /** |
|
95 | - * set system-wide encryption keys not related to a specific user, |
|
96 | - * e.g something like a key for public link shares |
|
97 | - * |
|
98 | - * @param string $keyId id of the key |
|
99 | - * @param mixed $key |
|
100 | - * @param string $encryptionModuleId |
|
101 | - * |
|
102 | - * @return mixed key |
|
103 | - * @since 8.1.0 |
|
104 | - */ |
|
105 | - public function setSystemUserKey($keyId, $key, $encryptionModuleId); |
|
94 | + /** |
|
95 | + * set system-wide encryption keys not related to a specific user, |
|
96 | + * e.g something like a key for public link shares |
|
97 | + * |
|
98 | + * @param string $keyId id of the key |
|
99 | + * @param mixed $key |
|
100 | + * @param string $encryptionModuleId |
|
101 | + * |
|
102 | + * @return mixed key |
|
103 | + * @since 8.1.0 |
|
104 | + */ |
|
105 | + public function setSystemUserKey($keyId, $key, $encryptionModuleId); |
|
106 | 106 | |
107 | - /** |
|
108 | - * delete user specific key |
|
109 | - * |
|
110 | - * @param string $uid ID if the user for whom we want to delete the key |
|
111 | - * @param string $keyId id of the key |
|
112 | - * @param string $encryptionModuleId |
|
113 | - * |
|
114 | - * @return boolean False when the key could not be deleted |
|
115 | - * @since 8.1.0 |
|
116 | - */ |
|
117 | - public function deleteUserKey($uid, $keyId, $encryptionModuleId); |
|
107 | + /** |
|
108 | + * delete user specific key |
|
109 | + * |
|
110 | + * @param string $uid ID if the user for whom we want to delete the key |
|
111 | + * @param string $keyId id of the key |
|
112 | + * @param string $encryptionModuleId |
|
113 | + * |
|
114 | + * @return boolean False when the key could not be deleted |
|
115 | + * @since 8.1.0 |
|
116 | + */ |
|
117 | + public function deleteUserKey($uid, $keyId, $encryptionModuleId); |
|
118 | 118 | |
119 | - /** |
|
120 | - * delete file specific key |
|
121 | - * |
|
122 | - * @param string $path path to file |
|
123 | - * @param string $keyId id of the key |
|
124 | - * @param string $encryptionModuleId |
|
125 | - * |
|
126 | - * @return boolean False when the key could not be deleted |
|
127 | - * @since 8.1.0 |
|
128 | - */ |
|
129 | - public function deleteFileKey($path, $keyId, $encryptionModuleId); |
|
119 | + /** |
|
120 | + * delete file specific key |
|
121 | + * |
|
122 | + * @param string $path path to file |
|
123 | + * @param string $keyId id of the key |
|
124 | + * @param string $encryptionModuleId |
|
125 | + * |
|
126 | + * @return boolean False when the key could not be deleted |
|
127 | + * @since 8.1.0 |
|
128 | + */ |
|
129 | + public function deleteFileKey($path, $keyId, $encryptionModuleId); |
|
130 | 130 | |
131 | - /** |
|
132 | - * delete all file keys for a given file |
|
133 | - * |
|
134 | - * @param string $path to the file |
|
135 | - * |
|
136 | - * @return boolean False when the keys could not be deleted |
|
137 | - * @since 8.1.0 |
|
138 | - */ |
|
139 | - public function deleteAllFileKeys($path); |
|
131 | + /** |
|
132 | + * delete all file keys for a given file |
|
133 | + * |
|
134 | + * @param string $path to the file |
|
135 | + * |
|
136 | + * @return boolean False when the keys could not be deleted |
|
137 | + * @since 8.1.0 |
|
138 | + */ |
|
139 | + public function deleteAllFileKeys($path); |
|
140 | 140 | |
141 | - /** |
|
142 | - * delete system-wide encryption keys not related to a specific user, |
|
143 | - * e.g something like a key for public link shares |
|
144 | - * |
|
145 | - * @param string $keyId id of the key |
|
146 | - * @param string $encryptionModuleId |
|
147 | - * |
|
148 | - * @return boolean False when the key could not be deleted |
|
149 | - * @since 8.1.0 |
|
150 | - */ |
|
151 | - public function deleteSystemUserKey($keyId, $encryptionModuleId); |
|
141 | + /** |
|
142 | + * delete system-wide encryption keys not related to a specific user, |
|
143 | + * e.g something like a key for public link shares |
|
144 | + * |
|
145 | + * @param string $keyId id of the key |
|
146 | + * @param string $encryptionModuleId |
|
147 | + * |
|
148 | + * @return boolean False when the key could not be deleted |
|
149 | + * @since 8.1.0 |
|
150 | + */ |
|
151 | + public function deleteSystemUserKey($keyId, $encryptionModuleId); |
|
152 | 152 | |
153 | - /** |
|
154 | - * copy keys if a file was renamed |
|
155 | - * |
|
156 | - * @param string $source |
|
157 | - * @param string $target |
|
158 | - * @return boolean |
|
159 | - * @since 8.1.0 |
|
160 | - */ |
|
161 | - public function renameKeys($source, $target); |
|
153 | + /** |
|
154 | + * copy keys if a file was renamed |
|
155 | + * |
|
156 | + * @param string $source |
|
157 | + * @param string $target |
|
158 | + * @return boolean |
|
159 | + * @since 8.1.0 |
|
160 | + */ |
|
161 | + public function renameKeys($source, $target); |
|
162 | 162 | |
163 | - /** |
|
164 | - * move keys if a file was renamed |
|
165 | - * |
|
166 | - * @param string $source |
|
167 | - * @param string $target |
|
168 | - * @return boolean |
|
169 | - * @since 8.1.0 |
|
170 | - */ |
|
171 | - public function copyKeys($source, $target); |
|
163 | + /** |
|
164 | + * move keys if a file was renamed |
|
165 | + * |
|
166 | + * @param string $source |
|
167 | + * @param string $target |
|
168 | + * @return boolean |
|
169 | + * @since 8.1.0 |
|
170 | + */ |
|
171 | + public function copyKeys($source, $target); |
|
172 | 172 | |
173 | - /** |
|
174 | - * backup keys of a given encryption module |
|
175 | - * |
|
176 | - * @param string $encryptionModuleId |
|
177 | - * @param string $purpose |
|
178 | - * @param string $uid |
|
179 | - * @return bool |
|
180 | - * @since 12.0.0 |
|
181 | - */ |
|
182 | - public function backupUserKeys($encryptionModuleId, $purpose, $uid); |
|
173 | + /** |
|
174 | + * backup keys of a given encryption module |
|
175 | + * |
|
176 | + * @param string $encryptionModuleId |
|
177 | + * @param string $purpose |
|
178 | + * @param string $uid |
|
179 | + * @return bool |
|
180 | + * @since 12.0.0 |
|
181 | + */ |
|
182 | + public function backupUserKeys($encryptionModuleId, $purpose, $uid); |
|
183 | 183 | } |
@@ -46,7 +46,7 @@ |
||
46 | 46 | /** |
47 | 47 | * @since 9.2.0 |
48 | 48 | */ |
49 | - const EVENT = self::class . ':' . 'PreviewRequested'; |
|
49 | + const EVENT = self::class.':'.'PreviewRequested'; |
|
50 | 50 | |
51 | 51 | const MODE_FILL = 'fill'; |
52 | 52 | const MODE_COVER = 'cover'; |
@@ -43,86 +43,86 @@ |
||
43 | 43 | */ |
44 | 44 | interface IPreview { |
45 | 45 | |
46 | - /** |
|
47 | - * @since 9.2.0 |
|
48 | - */ |
|
49 | - const EVENT = self::class . ':' . 'PreviewRequested'; |
|
46 | + /** |
|
47 | + * @since 9.2.0 |
|
48 | + */ |
|
49 | + const EVENT = self::class . ':' . 'PreviewRequested'; |
|
50 | 50 | |
51 | - const MODE_FILL = 'fill'; |
|
52 | - const MODE_COVER = 'cover'; |
|
51 | + const MODE_FILL = 'fill'; |
|
52 | + const MODE_COVER = 'cover'; |
|
53 | 53 | |
54 | - /** |
|
55 | - * In order to improve lazy loading a closure can be registered which will be |
|
56 | - * called in case preview providers are actually requested |
|
57 | - * |
|
58 | - * $callable has to return an instance of \OCP\Preview\IProvider |
|
59 | - * |
|
60 | - * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider |
|
61 | - * @param \Closure $callable |
|
62 | - * @return void |
|
63 | - * @since 8.1.0 |
|
64 | - */ |
|
65 | - public function registerProvider($mimeTypeRegex, \Closure $callable); |
|
54 | + /** |
|
55 | + * In order to improve lazy loading a closure can be registered which will be |
|
56 | + * called in case preview providers are actually requested |
|
57 | + * |
|
58 | + * $callable has to return an instance of \OCP\Preview\IProvider |
|
59 | + * |
|
60 | + * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider |
|
61 | + * @param \Closure $callable |
|
62 | + * @return void |
|
63 | + * @since 8.1.0 |
|
64 | + */ |
|
65 | + public function registerProvider($mimeTypeRegex, \Closure $callable); |
|
66 | 66 | |
67 | - /** |
|
68 | - * Get all providers |
|
69 | - * @return array |
|
70 | - * @since 8.1.0 |
|
71 | - */ |
|
72 | - public function getProviders(); |
|
67 | + /** |
|
68 | + * Get all providers |
|
69 | + * @return array |
|
70 | + * @since 8.1.0 |
|
71 | + */ |
|
72 | + public function getProviders(); |
|
73 | 73 | |
74 | - /** |
|
75 | - * Does the manager have any providers |
|
76 | - * @return bool |
|
77 | - * @since 8.1.0 |
|
78 | - */ |
|
79 | - public function hasProviders(); |
|
74 | + /** |
|
75 | + * Does the manager have any providers |
|
76 | + * @return bool |
|
77 | + * @since 8.1.0 |
|
78 | + */ |
|
79 | + public function hasProviders(); |
|
80 | 80 | |
81 | - /** |
|
82 | - * Return a preview of a file |
|
83 | - * @param string $file The path to the file where you want a thumbnail from |
|
84 | - * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image |
|
85 | - * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image |
|
86 | - * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly |
|
87 | - * @return \OCP\IImage |
|
88 | - * @since 6.0.0 |
|
89 | - * @deprecated 11 Use getPreview |
|
90 | - */ |
|
91 | - public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false); |
|
81 | + /** |
|
82 | + * Return a preview of a file |
|
83 | + * @param string $file The path to the file where you want a thumbnail from |
|
84 | + * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image |
|
85 | + * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image |
|
86 | + * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly |
|
87 | + * @return \OCP\IImage |
|
88 | + * @since 6.0.0 |
|
89 | + * @deprecated 11 Use getPreview |
|
90 | + */ |
|
91 | + public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false); |
|
92 | 92 | |
93 | - /** |
|
94 | - * Returns a preview of a file |
|
95 | - * |
|
96 | - * The cache is searched first and if nothing usable was found then a preview is |
|
97 | - * generated by one of the providers |
|
98 | - * |
|
99 | - * @param File $file |
|
100 | - * @param int $width |
|
101 | - * @param int $height |
|
102 | - * @param bool $crop |
|
103 | - * @param string $mode |
|
104 | - * @param string $mimeType To force a given mimetype for the file (files_versions needs this) |
|
105 | - * @return ISimpleFile |
|
106 | - * @throws NotFoundException |
|
107 | - * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid) |
|
108 | - * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0 |
|
109 | - */ |
|
110 | - public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null); |
|
93 | + /** |
|
94 | + * Returns a preview of a file |
|
95 | + * |
|
96 | + * The cache is searched first and if nothing usable was found then a preview is |
|
97 | + * generated by one of the providers |
|
98 | + * |
|
99 | + * @param File $file |
|
100 | + * @param int $width |
|
101 | + * @param int $height |
|
102 | + * @param bool $crop |
|
103 | + * @param string $mode |
|
104 | + * @param string $mimeType To force a given mimetype for the file (files_versions needs this) |
|
105 | + * @return ISimpleFile |
|
106 | + * @throws NotFoundException |
|
107 | + * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid) |
|
108 | + * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0 |
|
109 | + */ |
|
110 | + public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null); |
|
111 | 111 | |
112 | - /** |
|
113 | - * Returns true if the passed mime type is supported |
|
114 | - * @param string $mimeType |
|
115 | - * @return boolean |
|
116 | - * @since 6.0.0 |
|
117 | - */ |
|
118 | - public function isMimeSupported($mimeType = '*'); |
|
112 | + /** |
|
113 | + * Returns true if the passed mime type is supported |
|
114 | + * @param string $mimeType |
|
115 | + * @return boolean |
|
116 | + * @since 6.0.0 |
|
117 | + */ |
|
118 | + public function isMimeSupported($mimeType = '*'); |
|
119 | 119 | |
120 | - /** |
|
121 | - * Check if a preview can be generated for a file |
|
122 | - * |
|
123 | - * @param \OCP\Files\FileInfo $file |
|
124 | - * @return bool |
|
125 | - * @since 8.0.0 |
|
126 | - */ |
|
127 | - public function isAvailable(\OCP\Files\FileInfo $file); |
|
120 | + /** |
|
121 | + * Check if a preview can be generated for a file |
|
122 | + * |
|
123 | + * @param \OCP\Files\FileInfo $file |
|
124 | + * @return bool |
|
125 | + * @since 8.0.0 |
|
126 | + */ |
|
127 | + public function isAvailable(\OCP\Files\FileInfo $file); |
|
128 | 128 | } |
@@ -28,45 +28,45 @@ |
||
28 | 28 | |
29 | 29 | class Credentials implements ICredentials { |
30 | 30 | |
31 | - /** @var string */ |
|
32 | - private $uid; |
|
31 | + /** @var string */ |
|
32 | + private $uid; |
|
33 | 33 | |
34 | - /** @var string */ |
|
35 | - private $loginName; |
|
34 | + /** @var string */ |
|
35 | + private $loginName; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - private $password; |
|
37 | + /** @var string */ |
|
38 | + private $password; |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param string $uid |
|
42 | - * @param string $loginName |
|
43 | - * @param string $password |
|
44 | - */ |
|
45 | - public function __construct($uid, $loginName, $password) { |
|
46 | - $this->uid = $uid; |
|
47 | - $this->loginName = $loginName; |
|
48 | - $this->password = $password; |
|
49 | - } |
|
40 | + /** |
|
41 | + * @param string $uid |
|
42 | + * @param string $loginName |
|
43 | + * @param string $password |
|
44 | + */ |
|
45 | + public function __construct($uid, $loginName, $password) { |
|
46 | + $this->uid = $uid; |
|
47 | + $this->loginName = $loginName; |
|
48 | + $this->password = $password; |
|
49 | + } |
|
50 | 50 | |
51 | - /** |
|
52 | - * @return string |
|
53 | - */ |
|
54 | - public function getUID() { |
|
55 | - return $this->uid; |
|
56 | - } |
|
51 | + /** |
|
52 | + * @return string |
|
53 | + */ |
|
54 | + public function getUID() { |
|
55 | + return $this->uid; |
|
56 | + } |
|
57 | 57 | |
58 | - /** |
|
59 | - * @return string |
|
60 | - */ |
|
61 | - public function getLoginName() { |
|
62 | - return $this->loginName; |
|
63 | - } |
|
58 | + /** |
|
59 | + * @return string |
|
60 | + */ |
|
61 | + public function getLoginName() { |
|
62 | + return $this->loginName; |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * @return string |
|
67 | - */ |
|
68 | - public function getPassword() { |
|
69 | - return $this->password; |
|
70 | - } |
|
65 | + /** |
|
66 | + * @return string |
|
67 | + */ |
|
68 | + public function getPassword() { |
|
69 | + return $this->password; |
|
70 | + } |
|
71 | 71 | |
72 | 72 | } |
@@ -37,84 +37,84 @@ |
||
37 | 37 | |
38 | 38 | class Store implements IStore { |
39 | 39 | |
40 | - /** @var ISession */ |
|
41 | - private $session; |
|
42 | - |
|
43 | - /** @var ILogger */ |
|
44 | - private $logger; |
|
45 | - |
|
46 | - /** @var IProvider|null */ |
|
47 | - private $tokenProvider; |
|
48 | - |
|
49 | - /** |
|
50 | - * @param ISession $session |
|
51 | - * @param ILogger $logger |
|
52 | - * @param IProvider $tokenProvider |
|
53 | - */ |
|
54 | - public function __construct(ISession $session, ILogger $logger, IProvider $tokenProvider = null) { |
|
55 | - $this->session = $session; |
|
56 | - $this->logger = $logger; |
|
57 | - $this->tokenProvider = $tokenProvider; |
|
58 | - |
|
59 | - Util::connectHook('OC_User', 'post_login', $this, 'authenticate'); |
|
60 | - } |
|
61 | - |
|
62 | - /** |
|
63 | - * Hook listener on post login |
|
64 | - * |
|
65 | - * @param array $params |
|
66 | - */ |
|
67 | - public function authenticate(array $params) { |
|
68 | - $this->session->set('login_credentials', json_encode($params)); |
|
69 | - } |
|
70 | - |
|
71 | - /** |
|
72 | - * Replace the session implementation |
|
73 | - * |
|
74 | - * @param ISession $session |
|
75 | - */ |
|
76 | - public function setSession(ISession $session) { |
|
77 | - $this->session = $session; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * @since 12 |
|
82 | - * |
|
83 | - * @return ICredentials the login credentials of the current user |
|
84 | - * @throws CredentialsUnavailableException |
|
85 | - */ |
|
86 | - public function getLoginCredentials() { |
|
87 | - if (is_null($this->tokenProvider)) { |
|
88 | - throw new CredentialsUnavailableException(); |
|
89 | - } |
|
90 | - |
|
91 | - $trySession = false; |
|
92 | - try { |
|
93 | - $sessionId = $this->session->getId(); |
|
94 | - $token = $this->tokenProvider->getToken($sessionId); |
|
95 | - |
|
96 | - $uid = $token->getUID(); |
|
97 | - $user = $token->getLoginName(); |
|
98 | - $password = $this->tokenProvider->getPassword($token, $sessionId); |
|
99 | - |
|
100 | - return new Credentials($uid, $user, $password); |
|
101 | - } catch (SessionNotAvailableException $ex) { |
|
102 | - $this->logger->debug('could not get login credentials because session is unavailable', ['app' => 'core']); |
|
103 | - } catch (InvalidTokenException $ex) { |
|
104 | - $this->logger->debug('could not get login credentials because the token is invalid', ['app' => 'core']); |
|
105 | - $trySession = true; |
|
106 | - } catch (PasswordlessTokenException $ex) { |
|
107 | - $this->logger->debug('could not get login credentials because the token has no password', ['app' => 'core']); |
|
108 | - $trySession = true; |
|
109 | - } |
|
110 | - |
|
111 | - if ($trySession && $this->session->exists('login_credentials')) { |
|
112 | - $creds = json_decode($this->session->get('login_credentials')); |
|
113 | - return new Credentials($creds->uid, $creds->uid, $creds->password); |
|
114 | - } |
|
115 | - |
|
116 | - // If we reach this line, an exception was thrown. |
|
117 | - throw new CredentialsUnavailableException(); |
|
118 | - } |
|
40 | + /** @var ISession */ |
|
41 | + private $session; |
|
42 | + |
|
43 | + /** @var ILogger */ |
|
44 | + private $logger; |
|
45 | + |
|
46 | + /** @var IProvider|null */ |
|
47 | + private $tokenProvider; |
|
48 | + |
|
49 | + /** |
|
50 | + * @param ISession $session |
|
51 | + * @param ILogger $logger |
|
52 | + * @param IProvider $tokenProvider |
|
53 | + */ |
|
54 | + public function __construct(ISession $session, ILogger $logger, IProvider $tokenProvider = null) { |
|
55 | + $this->session = $session; |
|
56 | + $this->logger = $logger; |
|
57 | + $this->tokenProvider = $tokenProvider; |
|
58 | + |
|
59 | + Util::connectHook('OC_User', 'post_login', $this, 'authenticate'); |
|
60 | + } |
|
61 | + |
|
62 | + /** |
|
63 | + * Hook listener on post login |
|
64 | + * |
|
65 | + * @param array $params |
|
66 | + */ |
|
67 | + public function authenticate(array $params) { |
|
68 | + $this->session->set('login_credentials', json_encode($params)); |
|
69 | + } |
|
70 | + |
|
71 | + /** |
|
72 | + * Replace the session implementation |
|
73 | + * |
|
74 | + * @param ISession $session |
|
75 | + */ |
|
76 | + public function setSession(ISession $session) { |
|
77 | + $this->session = $session; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * @since 12 |
|
82 | + * |
|
83 | + * @return ICredentials the login credentials of the current user |
|
84 | + * @throws CredentialsUnavailableException |
|
85 | + */ |
|
86 | + public function getLoginCredentials() { |
|
87 | + if (is_null($this->tokenProvider)) { |
|
88 | + throw new CredentialsUnavailableException(); |
|
89 | + } |
|
90 | + |
|
91 | + $trySession = false; |
|
92 | + try { |
|
93 | + $sessionId = $this->session->getId(); |
|
94 | + $token = $this->tokenProvider->getToken($sessionId); |
|
95 | + |
|
96 | + $uid = $token->getUID(); |
|
97 | + $user = $token->getLoginName(); |
|
98 | + $password = $this->tokenProvider->getPassword($token, $sessionId); |
|
99 | + |
|
100 | + return new Credentials($uid, $user, $password); |
|
101 | + } catch (SessionNotAvailableException $ex) { |
|
102 | + $this->logger->debug('could not get login credentials because session is unavailable', ['app' => 'core']); |
|
103 | + } catch (InvalidTokenException $ex) { |
|
104 | + $this->logger->debug('could not get login credentials because the token is invalid', ['app' => 'core']); |
|
105 | + $trySession = true; |
|
106 | + } catch (PasswordlessTokenException $ex) { |
|
107 | + $this->logger->debug('could not get login credentials because the token has no password', ['app' => 'core']); |
|
108 | + $trySession = true; |
|
109 | + } |
|
110 | + |
|
111 | + if ($trySession && $this->session->exists('login_credentials')) { |
|
112 | + $creds = json_decode($this->session->get('login_credentials')); |
|
113 | + return new Credentials($creds->uid, $creds->uid, $creds->password); |
|
114 | + } |
|
115 | + |
|
116 | + // If we reach this line, an exception was thrown. |
|
117 | + throw new CredentialsUnavailableException(); |
|
118 | + } |
|
119 | 119 | |
120 | 120 | } |
@@ -129,7 +129,7 @@ |
||
129 | 129 | $data = $result->fetchAll(); |
130 | 130 | $result->closeCursor(); |
131 | 131 | |
132 | - $entities = array_map(function ($row) { |
|
132 | + $entities = array_map(function($row) { |
|
133 | 133 | return DefaultToken::fromRow($row); |
134 | 134 | }, $data); |
135 | 135 |
@@ -36,136 +36,136 @@ |
||
36 | 36 | |
37 | 37 | class DefaultTokenMapper extends QBMapper { |
38 | 38 | |
39 | - public function __construct(IDBConnection $db) { |
|
40 | - parent::__construct($db, 'authtoken'); |
|
41 | - } |
|
42 | - |
|
43 | - /** |
|
44 | - * Invalidate (delete) a given token |
|
45 | - * |
|
46 | - * @param string $token |
|
47 | - */ |
|
48 | - public function invalidate(string $token) { |
|
49 | - /* @var $qb IQueryBuilder */ |
|
50 | - $qb = $this->db->getQueryBuilder(); |
|
51 | - $qb->delete('authtoken') |
|
52 | - ->where($qb->expr()->eq('token', $qb->createNamedParameter($token, IQueryBuilder::PARAM_STR))) |
|
53 | - ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
54 | - ->execute(); |
|
55 | - } |
|
56 | - |
|
57 | - /** |
|
58 | - * @param int $olderThan |
|
59 | - * @param int $remember |
|
60 | - */ |
|
61 | - public function invalidateOld(int $olderThan, int $remember = IToken::DO_NOT_REMEMBER) { |
|
62 | - /* @var $qb IQueryBuilder */ |
|
63 | - $qb = $this->db->getQueryBuilder(); |
|
64 | - $qb->delete('authtoken') |
|
65 | - ->where($qb->expr()->lt('last_activity', $qb->createNamedParameter($olderThan, IQueryBuilder::PARAM_INT))) |
|
66 | - ->andWhere($qb->expr()->eq('type', $qb->createNamedParameter(IToken::TEMPORARY_TOKEN, IQueryBuilder::PARAM_INT))) |
|
67 | - ->andWhere($qb->expr()->eq('remember', $qb->createNamedParameter($remember, IQueryBuilder::PARAM_INT))) |
|
68 | - ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
69 | - ->execute(); |
|
70 | - } |
|
71 | - |
|
72 | - /** |
|
73 | - * Get the user UID for the given token |
|
74 | - * |
|
75 | - * @param string $token |
|
76 | - * @throws DoesNotExistException |
|
77 | - * @return DefaultToken |
|
78 | - */ |
|
79 | - public function getToken(string $token): DefaultToken { |
|
80 | - /* @var $qb IQueryBuilder */ |
|
81 | - $qb = $this->db->getQueryBuilder(); |
|
82 | - $result = $qb->select('id', 'uid', 'login_name', 'password', 'name', 'token', 'type', 'remember', 'last_activity', 'last_check', 'scope', 'expires', 'version') |
|
83 | - ->from('authtoken') |
|
84 | - ->where($qb->expr()->eq('token', $qb->createNamedParameter($token))) |
|
85 | - ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
86 | - ->execute(); |
|
87 | - |
|
88 | - $data = $result->fetch(); |
|
89 | - $result->closeCursor(); |
|
90 | - if ($data === false) { |
|
91 | - throw new DoesNotExistException('token does not exist'); |
|
92 | - } |
|
93 | - return DefaultToken::fromRow($data); |
|
94 | - } |
|
95 | - |
|
96 | - /** |
|
97 | - * Get the token for $id |
|
98 | - * |
|
99 | - * @param int $id |
|
100 | - * @throws DoesNotExistException |
|
101 | - * @return DefaultToken |
|
102 | - */ |
|
103 | - public function getTokenById(int $id): DefaultToken { |
|
104 | - /* @var $qb IQueryBuilder */ |
|
105 | - $qb = $this->db->getQueryBuilder(); |
|
106 | - $result = $qb->select('id', 'uid', 'login_name', 'password', 'name', 'token', 'type', 'remember', 'last_activity', 'last_check', 'scope', 'expires', 'version') |
|
107 | - ->from('authtoken') |
|
108 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
109 | - ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
110 | - ->execute(); |
|
111 | - |
|
112 | - $data = $result->fetch(); |
|
113 | - $result->closeCursor(); |
|
114 | - if ($data === false) { |
|
115 | - throw new DoesNotExistException('token does not exist'); |
|
116 | - } |
|
117 | - return DefaultToken::fromRow($data); |
|
118 | - } |
|
119 | - |
|
120 | - /** |
|
121 | - * Get all tokens of a user |
|
122 | - * |
|
123 | - * The provider may limit the number of result rows in case of an abuse |
|
124 | - * where a high number of (session) tokens is generated |
|
125 | - * |
|
126 | - * @param string $uid |
|
127 | - * @return DefaultToken[] |
|
128 | - */ |
|
129 | - public function getTokenByUser(string $uid): array { |
|
130 | - /* @var $qb IQueryBuilder */ |
|
131 | - $qb = $this->db->getQueryBuilder(); |
|
132 | - $qb->select('id', 'uid', 'login_name', 'password', 'name', 'token', 'type', 'remember', 'last_activity', 'last_check', 'scope', 'expires', 'version') |
|
133 | - ->from('authtoken') |
|
134 | - ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid))) |
|
135 | - ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
136 | - ->setMaxResults(1000); |
|
137 | - $result = $qb->execute(); |
|
138 | - $data = $result->fetchAll(); |
|
139 | - $result->closeCursor(); |
|
140 | - |
|
141 | - $entities = array_map(function ($row) { |
|
142 | - return DefaultToken::fromRow($row); |
|
143 | - }, $data); |
|
144 | - |
|
145 | - return $entities; |
|
146 | - } |
|
147 | - |
|
148 | - public function deleteById(string $uid, int $id) { |
|
149 | - /* @var $qb IQueryBuilder */ |
|
150 | - $qb = $this->db->getQueryBuilder(); |
|
151 | - $qb->delete('authtoken') |
|
152 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
153 | - ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid))) |
|
154 | - ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))); |
|
155 | - $qb->execute(); |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * delete all auth token which belong to a specific client if the client was deleted |
|
160 | - * |
|
161 | - * @param string $name |
|
162 | - */ |
|
163 | - public function deleteByName(string $name) { |
|
164 | - $qb = $this->db->getQueryBuilder(); |
|
165 | - $qb->delete('authtoken') |
|
166 | - ->where($qb->expr()->eq('name', $qb->createNamedParameter($name), IQueryBuilder::PARAM_STR)) |
|
167 | - ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))); |
|
168 | - $qb->execute(); |
|
169 | - } |
|
39 | + public function __construct(IDBConnection $db) { |
|
40 | + parent::__construct($db, 'authtoken'); |
|
41 | + } |
|
42 | + |
|
43 | + /** |
|
44 | + * Invalidate (delete) a given token |
|
45 | + * |
|
46 | + * @param string $token |
|
47 | + */ |
|
48 | + public function invalidate(string $token) { |
|
49 | + /* @var $qb IQueryBuilder */ |
|
50 | + $qb = $this->db->getQueryBuilder(); |
|
51 | + $qb->delete('authtoken') |
|
52 | + ->where($qb->expr()->eq('token', $qb->createNamedParameter($token, IQueryBuilder::PARAM_STR))) |
|
53 | + ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
54 | + ->execute(); |
|
55 | + } |
|
56 | + |
|
57 | + /** |
|
58 | + * @param int $olderThan |
|
59 | + * @param int $remember |
|
60 | + */ |
|
61 | + public function invalidateOld(int $olderThan, int $remember = IToken::DO_NOT_REMEMBER) { |
|
62 | + /* @var $qb IQueryBuilder */ |
|
63 | + $qb = $this->db->getQueryBuilder(); |
|
64 | + $qb->delete('authtoken') |
|
65 | + ->where($qb->expr()->lt('last_activity', $qb->createNamedParameter($olderThan, IQueryBuilder::PARAM_INT))) |
|
66 | + ->andWhere($qb->expr()->eq('type', $qb->createNamedParameter(IToken::TEMPORARY_TOKEN, IQueryBuilder::PARAM_INT))) |
|
67 | + ->andWhere($qb->expr()->eq('remember', $qb->createNamedParameter($remember, IQueryBuilder::PARAM_INT))) |
|
68 | + ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
69 | + ->execute(); |
|
70 | + } |
|
71 | + |
|
72 | + /** |
|
73 | + * Get the user UID for the given token |
|
74 | + * |
|
75 | + * @param string $token |
|
76 | + * @throws DoesNotExistException |
|
77 | + * @return DefaultToken |
|
78 | + */ |
|
79 | + public function getToken(string $token): DefaultToken { |
|
80 | + /* @var $qb IQueryBuilder */ |
|
81 | + $qb = $this->db->getQueryBuilder(); |
|
82 | + $result = $qb->select('id', 'uid', 'login_name', 'password', 'name', 'token', 'type', 'remember', 'last_activity', 'last_check', 'scope', 'expires', 'version') |
|
83 | + ->from('authtoken') |
|
84 | + ->where($qb->expr()->eq('token', $qb->createNamedParameter($token))) |
|
85 | + ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
86 | + ->execute(); |
|
87 | + |
|
88 | + $data = $result->fetch(); |
|
89 | + $result->closeCursor(); |
|
90 | + if ($data === false) { |
|
91 | + throw new DoesNotExistException('token does not exist'); |
|
92 | + } |
|
93 | + return DefaultToken::fromRow($data); |
|
94 | + } |
|
95 | + |
|
96 | + /** |
|
97 | + * Get the token for $id |
|
98 | + * |
|
99 | + * @param int $id |
|
100 | + * @throws DoesNotExistException |
|
101 | + * @return DefaultToken |
|
102 | + */ |
|
103 | + public function getTokenById(int $id): DefaultToken { |
|
104 | + /* @var $qb IQueryBuilder */ |
|
105 | + $qb = $this->db->getQueryBuilder(); |
|
106 | + $result = $qb->select('id', 'uid', 'login_name', 'password', 'name', 'token', 'type', 'remember', 'last_activity', 'last_check', 'scope', 'expires', 'version') |
|
107 | + ->from('authtoken') |
|
108 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
109 | + ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
110 | + ->execute(); |
|
111 | + |
|
112 | + $data = $result->fetch(); |
|
113 | + $result->closeCursor(); |
|
114 | + if ($data === false) { |
|
115 | + throw new DoesNotExistException('token does not exist'); |
|
116 | + } |
|
117 | + return DefaultToken::fromRow($data); |
|
118 | + } |
|
119 | + |
|
120 | + /** |
|
121 | + * Get all tokens of a user |
|
122 | + * |
|
123 | + * The provider may limit the number of result rows in case of an abuse |
|
124 | + * where a high number of (session) tokens is generated |
|
125 | + * |
|
126 | + * @param string $uid |
|
127 | + * @return DefaultToken[] |
|
128 | + */ |
|
129 | + public function getTokenByUser(string $uid): array { |
|
130 | + /* @var $qb IQueryBuilder */ |
|
131 | + $qb = $this->db->getQueryBuilder(); |
|
132 | + $qb->select('id', 'uid', 'login_name', 'password', 'name', 'token', 'type', 'remember', 'last_activity', 'last_check', 'scope', 'expires', 'version') |
|
133 | + ->from('authtoken') |
|
134 | + ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid))) |
|
135 | + ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))) |
|
136 | + ->setMaxResults(1000); |
|
137 | + $result = $qb->execute(); |
|
138 | + $data = $result->fetchAll(); |
|
139 | + $result->closeCursor(); |
|
140 | + |
|
141 | + $entities = array_map(function ($row) { |
|
142 | + return DefaultToken::fromRow($row); |
|
143 | + }, $data); |
|
144 | + |
|
145 | + return $entities; |
|
146 | + } |
|
147 | + |
|
148 | + public function deleteById(string $uid, int $id) { |
|
149 | + /* @var $qb IQueryBuilder */ |
|
150 | + $qb = $this->db->getQueryBuilder(); |
|
151 | + $qb->delete('authtoken') |
|
152 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
153 | + ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid))) |
|
154 | + ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))); |
|
155 | + $qb->execute(); |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * delete all auth token which belong to a specific client if the client was deleted |
|
160 | + * |
|
161 | + * @param string $name |
|
162 | + */ |
|
163 | + public function deleteByName(string $name) { |
|
164 | + $qb = $this->db->getQueryBuilder(); |
|
165 | + $qb->delete('authtoken') |
|
166 | + ->where($qb->expr()->eq('name', $qb->createNamedParameter($name), IQueryBuilder::PARAM_STR)) |
|
167 | + ->andWhere($qb->expr()->eq('version', $qb->createNamedParameter(DefaultToken::VERSION, IQueryBuilder::PARAM_INT))); |
|
168 | + $qb->execute(); |
|
169 | + } |
|
170 | 170 | |
171 | 171 | } |
@@ -103,6 +103,6 @@ |
||
103 | 103 | $time = new \DateTime('now', $timeZone); |
104 | 104 | $timestampInfo = $time->format($this->config->getSystemValue('logdateformat', \DateTime::ATOM)); |
105 | 105 | |
106 | - return $timestampInfo . ' ' . $this->formatter->format($message); |
|
106 | + return $timestampInfo.' '.$this->formatter->format($message); |
|
107 | 107 | } |
108 | 108 | } |
@@ -28,85 +28,85 @@ |
||
28 | 28 | use Symfony\Component\Console\Formatter\OutputFormatterStyleInterface; |
29 | 29 | |
30 | 30 | class TimestampFormatter implements OutputFormatterInterface { |
31 | - /** @var IConfig */ |
|
32 | - protected $config; |
|
31 | + /** @var IConfig */ |
|
32 | + protected $config; |
|
33 | 33 | |
34 | - /** @var OutputFormatterInterface */ |
|
35 | - protected $formatter; |
|
34 | + /** @var OutputFormatterInterface */ |
|
35 | + protected $formatter; |
|
36 | 36 | |
37 | - /** |
|
38 | - * @param IConfig $config |
|
39 | - * @param OutputFormatterInterface $formatter |
|
40 | - */ |
|
41 | - public function __construct(IConfig $config, OutputFormatterInterface $formatter) { |
|
42 | - $this->config = $config; |
|
43 | - $this->formatter = $formatter; |
|
44 | - } |
|
37 | + /** |
|
38 | + * @param IConfig $config |
|
39 | + * @param OutputFormatterInterface $formatter |
|
40 | + */ |
|
41 | + public function __construct(IConfig $config, OutputFormatterInterface $formatter) { |
|
42 | + $this->config = $config; |
|
43 | + $this->formatter = $formatter; |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * Sets the decorated flag. |
|
48 | - * |
|
49 | - * @param bool $decorated Whether to decorate the messages or not |
|
50 | - */ |
|
51 | - public function setDecorated($decorated) { |
|
52 | - $this->formatter->setDecorated($decorated); |
|
53 | - } |
|
46 | + /** |
|
47 | + * Sets the decorated flag. |
|
48 | + * |
|
49 | + * @param bool $decorated Whether to decorate the messages or not |
|
50 | + */ |
|
51 | + public function setDecorated($decorated) { |
|
52 | + $this->formatter->setDecorated($decorated); |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * Gets the decorated flag. |
|
57 | - * |
|
58 | - * @return bool true if the output will decorate messages, false otherwise |
|
59 | - */ |
|
60 | - public function isDecorated() { |
|
61 | - return $this->formatter->isDecorated(); |
|
62 | - } |
|
55 | + /** |
|
56 | + * Gets the decorated flag. |
|
57 | + * |
|
58 | + * @return bool true if the output will decorate messages, false otherwise |
|
59 | + */ |
|
60 | + public function isDecorated() { |
|
61 | + return $this->formatter->isDecorated(); |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * Sets a new style. |
|
66 | - * |
|
67 | - * @param string $name The style name |
|
68 | - * @param OutputFormatterStyleInterface $style The style instance |
|
69 | - */ |
|
70 | - public function setStyle($name, OutputFormatterStyleInterface $style) { |
|
71 | - $this->formatter->setStyle($name, $style); |
|
72 | - } |
|
64 | + /** |
|
65 | + * Sets a new style. |
|
66 | + * |
|
67 | + * @param string $name The style name |
|
68 | + * @param OutputFormatterStyleInterface $style The style instance |
|
69 | + */ |
|
70 | + public function setStyle($name, OutputFormatterStyleInterface $style) { |
|
71 | + $this->formatter->setStyle($name, $style); |
|
72 | + } |
|
73 | 73 | |
74 | - /** |
|
75 | - * Checks if output formatter has style with specified name. |
|
76 | - * |
|
77 | - * @param string $name |
|
78 | - * @return bool |
|
79 | - */ |
|
80 | - public function hasStyle($name) { |
|
81 | - return $this->formatter->hasStyle($name); |
|
82 | - } |
|
74 | + /** |
|
75 | + * Checks if output formatter has style with specified name. |
|
76 | + * |
|
77 | + * @param string $name |
|
78 | + * @return bool |
|
79 | + */ |
|
80 | + public function hasStyle($name) { |
|
81 | + return $this->formatter->hasStyle($name); |
|
82 | + } |
|
83 | 83 | |
84 | - /** |
|
85 | - * Gets style options from style with specified name. |
|
86 | - * |
|
87 | - * @param string $name |
|
88 | - * @return OutputFormatterStyleInterface |
|
89 | - * @throws \InvalidArgumentException When style isn't defined |
|
90 | - */ |
|
91 | - public function getStyle($name) { |
|
92 | - return $this->formatter->getStyle($name); |
|
93 | - } |
|
84 | + /** |
|
85 | + * Gets style options from style with specified name. |
|
86 | + * |
|
87 | + * @param string $name |
|
88 | + * @return OutputFormatterStyleInterface |
|
89 | + * @throws \InvalidArgumentException When style isn't defined |
|
90 | + */ |
|
91 | + public function getStyle($name) { |
|
92 | + return $this->formatter->getStyle($name); |
|
93 | + } |
|
94 | 94 | |
95 | - /** |
|
96 | - * Formats a message according to the given styles. |
|
97 | - * |
|
98 | - * @param string $message The message to style |
|
99 | - * @return string The styled message, prepended with a timestamp using the |
|
100 | - * log timezone and dateformat, e.g. "2015-06-23T17:24:37+02:00" |
|
101 | - */ |
|
102 | - public function format($message) { |
|
95 | + /** |
|
96 | + * Formats a message according to the given styles. |
|
97 | + * |
|
98 | + * @param string $message The message to style |
|
99 | + * @return string The styled message, prepended with a timestamp using the |
|
100 | + * log timezone and dateformat, e.g. "2015-06-23T17:24:37+02:00" |
|
101 | + */ |
|
102 | + public function format($message) { |
|
103 | 103 | |
104 | - $timeZone = $this->config->getSystemValue('logtimezone', 'UTC'); |
|
105 | - $timeZone = $timeZone !== null ? new \DateTimeZone($timeZone) : null; |
|
104 | + $timeZone = $this->config->getSystemValue('logtimezone', 'UTC'); |
|
105 | + $timeZone = $timeZone !== null ? new \DateTimeZone($timeZone) : null; |
|
106 | 106 | |
107 | - $time = new \DateTime('now', $timeZone); |
|
108 | - $timestampInfo = $time->format($this->config->getSystemValue('logdateformat', \DateTime::ATOM)); |
|
107 | + $time = new \DateTime('now', $timeZone); |
|
108 | + $timestampInfo = $time->format($this->config->getSystemValue('logdateformat', \DateTime::ATOM)); |
|
109 | 109 | |
110 | - return $timestampInfo . ' ' . $this->formatter->format($message); |
|
111 | - } |
|
110 | + return $timestampInfo . ' ' . $this->formatter->format($message); |
|
111 | + } |
|
112 | 112 | } |