@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | |
79 | 79 | // default responders |
80 | 80 | $this->responders = [ |
81 | - 'json' => function ($data) { |
|
81 | + 'json' => function($data) { |
|
82 | 82 | if ($data instanceof DataResponse) { |
83 | 83 | $response = new JSONResponse( |
84 | 84 | $data->getData(), |
@@ -153,6 +153,6 @@ discard block |
||
153 | 153 | return $responder($response); |
154 | 154 | } |
155 | 155 | throw new \DomainException('No responder registered for format '. |
156 | - $format . '!'); |
|
156 | + $format.'!'); |
|
157 | 157 | } |
158 | 158 | } |
@@ -45,122 +45,122 @@ |
||
45 | 45 | */ |
46 | 46 | abstract class Controller { |
47 | 47 | |
48 | - /** |
|
49 | - * app name |
|
50 | - * @var string |
|
51 | - * @since 7.0.0 |
|
52 | - */ |
|
53 | - protected $appName; |
|
54 | - |
|
55 | - /** |
|
56 | - * current request |
|
57 | - * @var \OCP\IRequest |
|
58 | - * @since 6.0.0 |
|
59 | - */ |
|
60 | - protected $request; |
|
61 | - |
|
62 | - /** |
|
63 | - * @var array |
|
64 | - * @since 7.0.0 |
|
65 | - */ |
|
66 | - private $responders; |
|
67 | - |
|
68 | - /** |
|
69 | - * constructor of the controller |
|
70 | - * @param string $appName the name of the app |
|
71 | - * @param IRequest $request an instance of the request |
|
72 | - * @since 6.0.0 - parameter $appName was added in 7.0.0 - parameter $app was removed in 7.0.0 |
|
73 | - */ |
|
74 | - public function __construct($appName, |
|
75 | - IRequest $request) { |
|
76 | - $this->appName = $appName; |
|
77 | - $this->request = $request; |
|
78 | - |
|
79 | - // default responders |
|
80 | - $this->responders = [ |
|
81 | - 'json' => function ($data) { |
|
82 | - if ($data instanceof DataResponse) { |
|
83 | - $response = new JSONResponse( |
|
84 | - $data->getData(), |
|
85 | - $data->getStatus() |
|
86 | - ); |
|
87 | - $dataHeaders = $data->getHeaders(); |
|
88 | - $headers = $response->getHeaders(); |
|
89 | - // do not overwrite Content-Type if it already exists |
|
90 | - if (isset($dataHeaders['Content-Type'])) { |
|
91 | - unset($headers['Content-Type']); |
|
92 | - } |
|
93 | - $response->setHeaders(array_merge($dataHeaders, $headers)); |
|
94 | - |
|
95 | - if ($data->getETag() !== null) { |
|
96 | - $response->setETag($data->getETag()); |
|
97 | - } |
|
98 | - if ($data->getLastModified() !== null) { |
|
99 | - $response->setLastModified($data->getLastModified()); |
|
100 | - } |
|
101 | - |
|
102 | - return $response; |
|
103 | - } |
|
104 | - return new JSONResponse($data); |
|
105 | - } |
|
106 | - ]; |
|
107 | - } |
|
108 | - |
|
109 | - |
|
110 | - /** |
|
111 | - * Parses an HTTP accept header and returns the supported responder type |
|
112 | - * @param string $acceptHeader |
|
113 | - * @param string $default |
|
114 | - * @return string the responder type |
|
115 | - * @since 7.0.0 |
|
116 | - * @since 9.1.0 Added default parameter |
|
117 | - */ |
|
118 | - public function getResponderByHTTPHeader($acceptHeader, $default = 'json') { |
|
119 | - $headers = explode(',', $acceptHeader); |
|
120 | - |
|
121 | - // return the first matching responder |
|
122 | - foreach ($headers as $header) { |
|
123 | - $header = strtolower(trim($header)); |
|
124 | - |
|
125 | - $responder = str_replace('application/', '', $header); |
|
126 | - |
|
127 | - if (array_key_exists($responder, $this->responders)) { |
|
128 | - return $responder; |
|
129 | - } |
|
130 | - } |
|
131 | - |
|
132 | - // no matching header return default |
|
133 | - return $default; |
|
134 | - } |
|
135 | - |
|
136 | - |
|
137 | - /** |
|
138 | - * Registers a formatter for a type |
|
139 | - * @param string $format |
|
140 | - * @param \Closure $responder |
|
141 | - * @since 7.0.0 |
|
142 | - */ |
|
143 | - protected function registerResponder($format, \Closure $responder) { |
|
144 | - $this->responders[$format] = $responder; |
|
145 | - } |
|
146 | - |
|
147 | - |
|
148 | - /** |
|
149 | - * Serializes and formats a response |
|
150 | - * @param mixed $response the value that was returned from a controller and |
|
151 | - * is not a Response instance |
|
152 | - * @param string $format the format for which a formatter has been registered |
|
153 | - * @throws \DomainException if format does not match a registered formatter |
|
154 | - * @return Response |
|
155 | - * @since 7.0.0 |
|
156 | - */ |
|
157 | - public function buildResponse($response, $format = 'json') { |
|
158 | - if (array_key_exists($format, $this->responders)) { |
|
159 | - $responder = $this->responders[$format]; |
|
160 | - |
|
161 | - return $responder($response); |
|
162 | - } |
|
163 | - throw new \DomainException('No responder registered for format '. |
|
164 | - $format . '!'); |
|
165 | - } |
|
48 | + /** |
|
49 | + * app name |
|
50 | + * @var string |
|
51 | + * @since 7.0.0 |
|
52 | + */ |
|
53 | + protected $appName; |
|
54 | + |
|
55 | + /** |
|
56 | + * current request |
|
57 | + * @var \OCP\IRequest |
|
58 | + * @since 6.0.0 |
|
59 | + */ |
|
60 | + protected $request; |
|
61 | + |
|
62 | + /** |
|
63 | + * @var array |
|
64 | + * @since 7.0.0 |
|
65 | + */ |
|
66 | + private $responders; |
|
67 | + |
|
68 | + /** |
|
69 | + * constructor of the controller |
|
70 | + * @param string $appName the name of the app |
|
71 | + * @param IRequest $request an instance of the request |
|
72 | + * @since 6.0.0 - parameter $appName was added in 7.0.0 - parameter $app was removed in 7.0.0 |
|
73 | + */ |
|
74 | + public function __construct($appName, |
|
75 | + IRequest $request) { |
|
76 | + $this->appName = $appName; |
|
77 | + $this->request = $request; |
|
78 | + |
|
79 | + // default responders |
|
80 | + $this->responders = [ |
|
81 | + 'json' => function ($data) { |
|
82 | + if ($data instanceof DataResponse) { |
|
83 | + $response = new JSONResponse( |
|
84 | + $data->getData(), |
|
85 | + $data->getStatus() |
|
86 | + ); |
|
87 | + $dataHeaders = $data->getHeaders(); |
|
88 | + $headers = $response->getHeaders(); |
|
89 | + // do not overwrite Content-Type if it already exists |
|
90 | + if (isset($dataHeaders['Content-Type'])) { |
|
91 | + unset($headers['Content-Type']); |
|
92 | + } |
|
93 | + $response->setHeaders(array_merge($dataHeaders, $headers)); |
|
94 | + |
|
95 | + if ($data->getETag() !== null) { |
|
96 | + $response->setETag($data->getETag()); |
|
97 | + } |
|
98 | + if ($data->getLastModified() !== null) { |
|
99 | + $response->setLastModified($data->getLastModified()); |
|
100 | + } |
|
101 | + |
|
102 | + return $response; |
|
103 | + } |
|
104 | + return new JSONResponse($data); |
|
105 | + } |
|
106 | + ]; |
|
107 | + } |
|
108 | + |
|
109 | + |
|
110 | + /** |
|
111 | + * Parses an HTTP accept header and returns the supported responder type |
|
112 | + * @param string $acceptHeader |
|
113 | + * @param string $default |
|
114 | + * @return string the responder type |
|
115 | + * @since 7.0.0 |
|
116 | + * @since 9.1.0 Added default parameter |
|
117 | + */ |
|
118 | + public function getResponderByHTTPHeader($acceptHeader, $default = 'json') { |
|
119 | + $headers = explode(',', $acceptHeader); |
|
120 | + |
|
121 | + // return the first matching responder |
|
122 | + foreach ($headers as $header) { |
|
123 | + $header = strtolower(trim($header)); |
|
124 | + |
|
125 | + $responder = str_replace('application/', '', $header); |
|
126 | + |
|
127 | + if (array_key_exists($responder, $this->responders)) { |
|
128 | + return $responder; |
|
129 | + } |
|
130 | + } |
|
131 | + |
|
132 | + // no matching header return default |
|
133 | + return $default; |
|
134 | + } |
|
135 | + |
|
136 | + |
|
137 | + /** |
|
138 | + * Registers a formatter for a type |
|
139 | + * @param string $format |
|
140 | + * @param \Closure $responder |
|
141 | + * @since 7.0.0 |
|
142 | + */ |
|
143 | + protected function registerResponder($format, \Closure $responder) { |
|
144 | + $this->responders[$format] = $responder; |
|
145 | + } |
|
146 | + |
|
147 | + |
|
148 | + /** |
|
149 | + * Serializes and formats a response |
|
150 | + * @param mixed $response the value that was returned from a controller and |
|
151 | + * is not a Response instance |
|
152 | + * @param string $format the format for which a formatter has been registered |
|
153 | + * @throws \DomainException if format does not match a registered formatter |
|
154 | + * @return Response |
|
155 | + * @since 7.0.0 |
|
156 | + */ |
|
157 | + public function buildResponse($response, $format = 'json') { |
|
158 | + if (array_key_exists($format, $this->responders)) { |
|
159 | + $responder = $this->responders[$format]; |
|
160 | + |
|
161 | + return $responder($response); |
|
162 | + } |
|
163 | + throw new \DomainException('No responder registered for format '. |
|
164 | + $format . '!'); |
|
165 | + } |
|
166 | 166 | } |
@@ -42,67 +42,67 @@ |
||
42 | 42 | abstract class Middleware { |
43 | 43 | |
44 | 44 | |
45 | - /** |
|
46 | - * This is being run in normal order before the controller is being |
|
47 | - * called which allows several modifications and checks |
|
48 | - * |
|
49 | - * @param Controller $controller the controller that is being called |
|
50 | - * @param string $methodName the name of the method that will be called on |
|
51 | - * the controller |
|
52 | - * @since 6.0.0 |
|
53 | - */ |
|
54 | - public function beforeController($controller, $methodName) { |
|
55 | - } |
|
45 | + /** |
|
46 | + * This is being run in normal order before the controller is being |
|
47 | + * called which allows several modifications and checks |
|
48 | + * |
|
49 | + * @param Controller $controller the controller that is being called |
|
50 | + * @param string $methodName the name of the method that will be called on |
|
51 | + * the controller |
|
52 | + * @since 6.0.0 |
|
53 | + */ |
|
54 | + public function beforeController($controller, $methodName) { |
|
55 | + } |
|
56 | 56 | |
57 | 57 | |
58 | - /** |
|
59 | - * This is being run when either the beforeController method or the |
|
60 | - * controller method itself is throwing an exception. The middleware is |
|
61 | - * asked in reverse order to handle the exception and to return a response. |
|
62 | - * If the response is null, it is assumed that the exception could not be |
|
63 | - * handled and the error will be thrown again |
|
64 | - * |
|
65 | - * @param Controller $controller the controller that is being called |
|
66 | - * @param string $methodName the name of the method that will be called on |
|
67 | - * the controller |
|
68 | - * @param \Exception $exception the thrown exception |
|
69 | - * @throws \Exception the passed in exception if it can't handle it |
|
70 | - * @return Response a Response object in case that the exception was handled |
|
71 | - * @since 6.0.0 |
|
72 | - */ |
|
73 | - public function afterException($controller, $methodName, \Exception $exception) { |
|
74 | - throw $exception; |
|
75 | - } |
|
58 | + /** |
|
59 | + * This is being run when either the beforeController method or the |
|
60 | + * controller method itself is throwing an exception. The middleware is |
|
61 | + * asked in reverse order to handle the exception and to return a response. |
|
62 | + * If the response is null, it is assumed that the exception could not be |
|
63 | + * handled and the error will be thrown again |
|
64 | + * |
|
65 | + * @param Controller $controller the controller that is being called |
|
66 | + * @param string $methodName the name of the method that will be called on |
|
67 | + * the controller |
|
68 | + * @param \Exception $exception the thrown exception |
|
69 | + * @throws \Exception the passed in exception if it can't handle it |
|
70 | + * @return Response a Response object in case that the exception was handled |
|
71 | + * @since 6.0.0 |
|
72 | + */ |
|
73 | + public function afterException($controller, $methodName, \Exception $exception) { |
|
74 | + throw $exception; |
|
75 | + } |
|
76 | 76 | |
77 | 77 | |
78 | - /** |
|
79 | - * This is being run after a successful controllermethod call and allows |
|
80 | - * the manipulation of a Response object. The middleware is run in reverse order |
|
81 | - * |
|
82 | - * @param Controller $controller the controller that is being called |
|
83 | - * @param string $methodName the name of the method that will be called on |
|
84 | - * the controller |
|
85 | - * @param Response $response the generated response from the controller |
|
86 | - * @return Response a Response object |
|
87 | - * @since 6.0.0 |
|
88 | - */ |
|
89 | - public function afterController($controller, $methodName, Response $response) { |
|
90 | - return $response; |
|
91 | - } |
|
78 | + /** |
|
79 | + * This is being run after a successful controllermethod call and allows |
|
80 | + * the manipulation of a Response object. The middleware is run in reverse order |
|
81 | + * |
|
82 | + * @param Controller $controller the controller that is being called |
|
83 | + * @param string $methodName the name of the method that will be called on |
|
84 | + * the controller |
|
85 | + * @param Response $response the generated response from the controller |
|
86 | + * @return Response a Response object |
|
87 | + * @since 6.0.0 |
|
88 | + */ |
|
89 | + public function afterController($controller, $methodName, Response $response) { |
|
90 | + return $response; |
|
91 | + } |
|
92 | 92 | |
93 | 93 | |
94 | - /** |
|
95 | - * This is being run after the response object has been rendered and |
|
96 | - * allows the manipulation of the output. The middleware is run in reverse order |
|
97 | - * |
|
98 | - * @param Controller $controller the controller that is being called |
|
99 | - * @param string $methodName the name of the method that will be called on |
|
100 | - * the controller |
|
101 | - * @param string $output the generated output from a response |
|
102 | - * @return string the output that should be printed |
|
103 | - * @since 6.0.0 |
|
104 | - */ |
|
105 | - public function beforeOutput($controller, $methodName, $output) { |
|
106 | - return $output; |
|
107 | - } |
|
94 | + /** |
|
95 | + * This is being run after the response object has been rendered and |
|
96 | + * allows the manipulation of the output. The middleware is run in reverse order |
|
97 | + * |
|
98 | + * @param Controller $controller the controller that is being called |
|
99 | + * @param string $methodName the name of the method that will be called on |
|
100 | + * the controller |
|
101 | + * @param string $output the generated output from a response |
|
102 | + * @return string the output that should be printed |
|
103 | + * @since 6.0.0 |
|
104 | + */ |
|
105 | + public function beforeOutput($controller, $methodName, $output) { |
|
106 | + return $output; |
|
107 | + } |
|
108 | 108 | } |
@@ -32,14 +32,14 @@ |
||
32 | 32 | * @since 9.1.0 |
33 | 33 | */ |
34 | 34 | class OCSNotFoundException extends OCSException { |
35 | - /** |
|
36 | - * OCSNotFoundException constructor. |
|
37 | - * |
|
38 | - * @param string $message |
|
39 | - * @param Exception|null $previous |
|
40 | - * @since 9.1.0 |
|
41 | - */ |
|
42 | - public function __construct($message = '', Exception $previous = null) { |
|
43 | - parent::__construct($message, Http::STATUS_NOT_FOUND, $previous); |
|
44 | - } |
|
35 | + /** |
|
36 | + * OCSNotFoundException constructor. |
|
37 | + * |
|
38 | + * @param string $message |
|
39 | + * @param Exception|null $previous |
|
40 | + * @since 9.1.0 |
|
41 | + */ |
|
42 | + public function __construct($message = '', Exception $previous = null) { |
|
43 | + parent::__construct($message, Http::STATUS_NOT_FOUND, $previous); |
|
44 | + } |
|
45 | 45 | } |
@@ -32,14 +32,14 @@ |
||
32 | 32 | * @since 9.1.0 |
33 | 33 | */ |
34 | 34 | class OCSForbiddenException extends OCSException { |
35 | - /** |
|
36 | - * OCSForbiddenException constructor. |
|
37 | - * |
|
38 | - * @param string $message |
|
39 | - * @param Exception|null $previous |
|
40 | - * @since 9.1.0 |
|
41 | - */ |
|
42 | - public function __construct($message = '', Exception $previous = null) { |
|
43 | - parent::__construct($message, Http::STATUS_FORBIDDEN, $previous); |
|
44 | - } |
|
35 | + /** |
|
36 | + * OCSForbiddenException constructor. |
|
37 | + * |
|
38 | + * @param string $message |
|
39 | + * @param Exception|null $previous |
|
40 | + * @since 9.1.0 |
|
41 | + */ |
|
42 | + public function __construct($message = '', Exception $previous = null) { |
|
43 | + parent::__construct($message, Http::STATUS_FORBIDDEN, $previous); |
|
44 | + } |
|
45 | 45 | } |
@@ -32,14 +32,14 @@ |
||
32 | 32 | * @since 9.1.0 |
33 | 33 | */ |
34 | 34 | class OCSBadRequestException extends OCSException { |
35 | - /** |
|
36 | - * OCSBadRequestException constructor. |
|
37 | - * |
|
38 | - * @param string $message |
|
39 | - * @param Exception|null $previous |
|
40 | - * @since 9.1.0 |
|
41 | - */ |
|
42 | - public function __construct($message = '', Exception $previous = null) { |
|
43 | - parent::__construct($message, Http::STATUS_BAD_REQUEST, $previous); |
|
44 | - } |
|
35 | + /** |
|
36 | + * OCSBadRequestException constructor. |
|
37 | + * |
|
38 | + * @param string $message |
|
39 | + * @param Exception|null $previous |
|
40 | + * @since 9.1.0 |
|
41 | + */ |
|
42 | + public function __construct($message = '', Exception $previous = null) { |
|
43 | + parent::__construct($message, Http::STATUS_BAD_REQUEST, $previous); |
|
44 | + } |
|
45 | 45 | } |
@@ -51,7 +51,7 @@ discard block |
||
51 | 51 | $this->file = $file; |
52 | 52 | $this->setStatus($statusCode); |
53 | 53 | $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
54 | - $this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"'); |
|
54 | + $this->addHeader('Content-Disposition', 'inline; filename="'.rawurldecode($file->getName()).'"'); |
|
55 | 55 | |
56 | 56 | $this->setETag($file->getEtag()); |
57 | 57 | $lastModified = new \DateTime(); |
@@ -65,7 +65,7 @@ discard block |
||
65 | 65 | */ |
66 | 66 | public function callback(IOutput $output) { |
67 | 67 | if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) { |
68 | - $output->setHeader('Content-Length: ' . $this->file->getSize()); |
|
68 | + $output->setHeader('Content-Length: '.$this->file->getSize()); |
|
69 | 69 | $output->setOutput($this->file->getContent()); |
70 | 70 | } |
71 | 71 | } |
@@ -32,40 +32,40 @@ |
||
32 | 32 | */ |
33 | 33 | class FileDisplayResponse extends Response implements ICallbackResponse { |
34 | 34 | |
35 | - /** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */ |
|
36 | - private $file; |
|
35 | + /** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */ |
|
36 | + private $file; |
|
37 | 37 | |
38 | - /** |
|
39 | - * FileDisplayResponse constructor. |
|
40 | - * |
|
41 | - * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file |
|
42 | - * @param int $statusCode |
|
43 | - * @param array $headers |
|
44 | - * @since 11.0.0 |
|
45 | - */ |
|
46 | - public function __construct($file, $statusCode = Http::STATUS_OK, |
|
47 | - $headers = []) { |
|
48 | - parent::__construct(); |
|
38 | + /** |
|
39 | + * FileDisplayResponse constructor. |
|
40 | + * |
|
41 | + * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file |
|
42 | + * @param int $statusCode |
|
43 | + * @param array $headers |
|
44 | + * @since 11.0.0 |
|
45 | + */ |
|
46 | + public function __construct($file, $statusCode = Http::STATUS_OK, |
|
47 | + $headers = []) { |
|
48 | + parent::__construct(); |
|
49 | 49 | |
50 | - $this->file = $file; |
|
51 | - $this->setStatus($statusCode); |
|
52 | - $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
|
53 | - $this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"'); |
|
50 | + $this->file = $file; |
|
51 | + $this->setStatus($statusCode); |
|
52 | + $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
|
53 | + $this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"'); |
|
54 | 54 | |
55 | - $this->setETag($file->getEtag()); |
|
56 | - $lastModified = new \DateTime(); |
|
57 | - $lastModified->setTimestamp($file->getMTime()); |
|
58 | - $this->setLastModified($lastModified); |
|
59 | - } |
|
55 | + $this->setETag($file->getEtag()); |
|
56 | + $lastModified = new \DateTime(); |
|
57 | + $lastModified->setTimestamp($file->getMTime()); |
|
58 | + $this->setLastModified($lastModified); |
|
59 | + } |
|
60 | 60 | |
61 | - /** |
|
62 | - * @param IOutput $output |
|
63 | - * @since 11.0.0 |
|
64 | - */ |
|
65 | - public function callback(IOutput $output) { |
|
66 | - if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) { |
|
67 | - $output->setHeader('Content-Length: ' . $this->file->getSize()); |
|
68 | - $output->setOutput($this->file->getContent()); |
|
69 | - } |
|
70 | - } |
|
61 | + /** |
|
62 | + * @param IOutput $output |
|
63 | + * @since 11.0.0 |
|
64 | + */ |
|
65 | + public function callback(IOutput $output) { |
|
66 | + if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) { |
|
67 | + $output->setHeader('Content-Length: ' . $this->file->getSize()); |
|
68 | + $output->setOutput($this->file->getContent()); |
|
69 | + } |
|
70 | + } |
|
71 | 71 | } |
@@ -43,7 +43,7 @@ |
||
43 | 43 | $this->filename = $filename; |
44 | 44 | $this->contentType = $contentType; |
45 | 45 | |
46 | - $this->addHeader('Content-Disposition', 'attachment; filename="' . $filename . '"'); |
|
46 | + $this->addHeader('Content-Disposition', 'attachment; filename="'.$filename.'"'); |
|
47 | 47 | $this->addHeader('Content-Type', $contentType); |
48 | 48 | } |
49 | 49 | } |
@@ -30,22 +30,22 @@ |
||
30 | 30 | * @since 7.0.0 |
31 | 31 | */ |
32 | 32 | class DownloadResponse extends Response { |
33 | - private $filename; |
|
34 | - private $contentType; |
|
33 | + private $filename; |
|
34 | + private $contentType; |
|
35 | 35 | |
36 | - /** |
|
37 | - * Creates a response that prompts the user to download the file |
|
38 | - * @param string $filename the name that the downloaded file should have |
|
39 | - * @param string $contentType the mimetype that the downloaded file should have |
|
40 | - * @since 7.0.0 |
|
41 | - */ |
|
42 | - public function __construct($filename, $contentType) { |
|
43 | - parent::__construct(); |
|
36 | + /** |
|
37 | + * Creates a response that prompts the user to download the file |
|
38 | + * @param string $filename the name that the downloaded file should have |
|
39 | + * @param string $contentType the mimetype that the downloaded file should have |
|
40 | + * @since 7.0.0 |
|
41 | + */ |
|
42 | + public function __construct($filename, $contentType) { |
|
43 | + parent::__construct(); |
|
44 | 44 | |
45 | - $this->filename = $filename; |
|
46 | - $this->contentType = $contentType; |
|
45 | + $this->filename = $filename; |
|
46 | + $this->contentType = $contentType; |
|
47 | 47 | |
48 | - $this->addHeader('Content-Disposition', 'attachment; filename="' . $filename . '"'); |
|
49 | - $this->addHeader('Content-Type', $contentType); |
|
50 | - } |
|
48 | + $this->addHeader('Content-Disposition', 'attachment; filename="' . $filename . '"'); |
|
49 | + $this->addHeader('Content-Type', $contentType); |
|
50 | + } |
|
51 | 51 | } |
@@ -68,7 +68,7 @@ |
||
68 | 68 | public function render() { |
69 | 69 | $response = json_encode($this->data, JSON_HEX_TAG); |
70 | 70 | if ($response === false) { |
71 | - throw new \Exception(sprintf('Could not json_encode due to invalid ' . |
|
71 | + throw new \Exception(sprintf('Could not json_encode due to invalid '. |
|
72 | 72 | 'non UTF-8 characters in the array: %s', var_export($this->data, true))); |
73 | 73 | } |
74 | 74 |
@@ -41,64 +41,64 @@ |
||
41 | 41 | */ |
42 | 42 | class JSONResponse extends Response { |
43 | 43 | |
44 | - /** |
|
45 | - * response data |
|
46 | - * @var array|object |
|
47 | - */ |
|
48 | - protected $data; |
|
44 | + /** |
|
45 | + * response data |
|
46 | + * @var array|object |
|
47 | + */ |
|
48 | + protected $data; |
|
49 | 49 | |
50 | 50 | |
51 | - /** |
|
52 | - * constructor of JSONResponse |
|
53 | - * @param array|object $data the object or array that should be transformed |
|
54 | - * @param int $statusCode the Http status code, defaults to 200 |
|
55 | - * @since 6.0.0 |
|
56 | - */ |
|
57 | - public function __construct($data = [], $statusCode = Http::STATUS_OK) { |
|
58 | - parent::__construct(); |
|
51 | + /** |
|
52 | + * constructor of JSONResponse |
|
53 | + * @param array|object $data the object or array that should be transformed |
|
54 | + * @param int $statusCode the Http status code, defaults to 200 |
|
55 | + * @since 6.0.0 |
|
56 | + */ |
|
57 | + public function __construct($data = [], $statusCode = Http::STATUS_OK) { |
|
58 | + parent::__construct(); |
|
59 | 59 | |
60 | - $this->data = $data; |
|
61 | - $this->setStatus($statusCode); |
|
62 | - $this->addHeader('Content-Type', 'application/json; charset=utf-8'); |
|
63 | - } |
|
60 | + $this->data = $data; |
|
61 | + $this->setStatus($statusCode); |
|
62 | + $this->addHeader('Content-Type', 'application/json; charset=utf-8'); |
|
63 | + } |
|
64 | 64 | |
65 | 65 | |
66 | - /** |
|
67 | - * Returns the rendered json |
|
68 | - * @return string the rendered json |
|
69 | - * @since 6.0.0 |
|
70 | - * @throws \Exception If data could not get encoded |
|
71 | - */ |
|
72 | - public function render() { |
|
73 | - $response = json_encode($this->data, JSON_HEX_TAG); |
|
74 | - if ($response === false) { |
|
75 | - throw new \Exception(sprintf('Could not json_encode due to invalid ' . |
|
76 | - 'non UTF-8 characters in the array: %s', var_export($this->data, true))); |
|
77 | - } |
|
66 | + /** |
|
67 | + * Returns the rendered json |
|
68 | + * @return string the rendered json |
|
69 | + * @since 6.0.0 |
|
70 | + * @throws \Exception If data could not get encoded |
|
71 | + */ |
|
72 | + public function render() { |
|
73 | + $response = json_encode($this->data, JSON_HEX_TAG); |
|
74 | + if ($response === false) { |
|
75 | + throw new \Exception(sprintf('Could not json_encode due to invalid ' . |
|
76 | + 'non UTF-8 characters in the array: %s', var_export($this->data, true))); |
|
77 | + } |
|
78 | 78 | |
79 | - return $response; |
|
80 | - } |
|
79 | + return $response; |
|
80 | + } |
|
81 | 81 | |
82 | - /** |
|
83 | - * Sets values in the data json array |
|
84 | - * @param array|object $data an array or object which will be transformed |
|
85 | - * to JSON |
|
86 | - * @return JSONResponse Reference to this object |
|
87 | - * @since 6.0.0 - return value was added in 7.0.0 |
|
88 | - */ |
|
89 | - public function setData($data) { |
|
90 | - $this->data = $data; |
|
82 | + /** |
|
83 | + * Sets values in the data json array |
|
84 | + * @param array|object $data an array or object which will be transformed |
|
85 | + * to JSON |
|
86 | + * @return JSONResponse Reference to this object |
|
87 | + * @since 6.0.0 - return value was added in 7.0.0 |
|
88 | + */ |
|
89 | + public function setData($data) { |
|
90 | + $this->data = $data; |
|
91 | 91 | |
92 | - return $this; |
|
93 | - } |
|
92 | + return $this; |
|
93 | + } |
|
94 | 94 | |
95 | 95 | |
96 | - /** |
|
97 | - * Used to get the set parameters |
|
98 | - * @return array the data |
|
99 | - * @since 6.0.0 |
|
100 | - */ |
|
101 | - public function getData() { |
|
102 | - return $this->data; |
|
103 | - } |
|
96 | + /** |
|
97 | + * Used to get the set parameters |
|
98 | + * @return array the data |
|
99 | + * @since 6.0.0 |
|
100 | + */ |
|
101 | + public function getData() { |
|
102 | + return $this->data; |
|
103 | + } |
|
104 | 104 | } |
@@ -72,7 +72,7 @@ discard block |
||
72 | 72 | $result = $this->zip->addFromString($path, $source); |
73 | 73 | } |
74 | 74 | if ($result) { |
75 | - $this->zip->close();//close and reopen to save the zip |
|
75 | + $this->zip->close(); //close and reopen to save the zip |
|
76 | 76 | $this->zip->open($this->path); |
77 | 77 | } |
78 | 78 | return $result; |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | public function getFiles() { |
131 | 131 | $fileCount = $this->zip->numFiles; |
132 | 132 | $files = []; |
133 | - for ($i = 0;$i < $fileCount;$i++) { |
|
133 | + for ($i = 0; $i < $fileCount; $i++) { |
|
134 | 134 | $files[] = $this->zip->getNameIndex($i); |
135 | 135 | } |
136 | 136 | return $files; |
@@ -204,7 +204,7 @@ discard block |
||
204 | 204 | $this->extractFile($path, $tmpFile); |
205 | 205 | } |
206 | 206 | $handle = fopen($tmpFile, $mode); |
207 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
207 | + return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
208 | 208 | $this->writeBack($tmpFile, $path); |
209 | 209 | }); |
210 | 210 | } |
@@ -36,199 +36,199 @@ |
||
36 | 36 | use OCP\ILogger; |
37 | 37 | |
38 | 38 | class ZIP extends Archive { |
39 | - /** |
|
40 | - * @var \ZipArchive zip |
|
41 | - */ |
|
42 | - private $zip = null; |
|
43 | - private $path; |
|
39 | + /** |
|
40 | + * @var \ZipArchive zip |
|
41 | + */ |
|
42 | + private $zip = null; |
|
43 | + private $path; |
|
44 | 44 | |
45 | - /** |
|
46 | - * @param string $source |
|
47 | - */ |
|
48 | - public function __construct($source) { |
|
49 | - $this->path = $source; |
|
50 | - $this->zip = new \ZipArchive(); |
|
51 | - if ($this->zip->open($source, \ZipArchive::CREATE)) { |
|
52 | - } else { |
|
53 | - \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, ILogger::WARN); |
|
54 | - } |
|
55 | - } |
|
56 | - /** |
|
57 | - * add an empty folder to the archive |
|
58 | - * @param string $path |
|
59 | - * @return bool |
|
60 | - */ |
|
61 | - public function addFolder($path) { |
|
62 | - return $this->zip->addEmptyDir($path); |
|
63 | - } |
|
64 | - /** |
|
65 | - * add a file to the archive |
|
66 | - * @param string $path |
|
67 | - * @param string $source either a local file or string data |
|
68 | - * @return bool |
|
69 | - */ |
|
70 | - public function addFile($path, $source = '') { |
|
71 | - if ($source and $source[0] == '/' and file_exists($source)) { |
|
72 | - $result = $this->zip->addFile($source, $path); |
|
73 | - } else { |
|
74 | - $result = $this->zip->addFromString($path, $source); |
|
75 | - } |
|
76 | - if ($result) { |
|
77 | - $this->zip->close();//close and reopen to save the zip |
|
78 | - $this->zip->open($this->path); |
|
79 | - } |
|
80 | - return $result; |
|
81 | - } |
|
82 | - /** |
|
83 | - * rename a file or folder in the archive |
|
84 | - * @param string $source |
|
85 | - * @param string $dest |
|
86 | - * @return boolean|null |
|
87 | - */ |
|
88 | - public function rename($source, $dest) { |
|
89 | - $source = $this->stripPath($source); |
|
90 | - $dest = $this->stripPath($dest); |
|
91 | - $this->zip->renameName($source, $dest); |
|
92 | - } |
|
93 | - /** |
|
94 | - * get the uncompressed size of a file in the archive |
|
95 | - * @param string $path |
|
96 | - * @return int |
|
97 | - */ |
|
98 | - public function filesize($path) { |
|
99 | - $stat = $this->zip->statName($path); |
|
100 | - return $stat['size']; |
|
101 | - } |
|
102 | - /** |
|
103 | - * get the last modified time of a file in the archive |
|
104 | - * @param string $path |
|
105 | - * @return int |
|
106 | - */ |
|
107 | - public function mtime($path) { |
|
108 | - return filemtime($this->path); |
|
109 | - } |
|
110 | - /** |
|
111 | - * get the files in a folder |
|
112 | - * @param string $path |
|
113 | - * @return array |
|
114 | - */ |
|
115 | - public function getFolder($path) { |
|
116 | - $files = $this->getFiles(); |
|
117 | - $folderContent = []; |
|
118 | - $pathLength = strlen($path); |
|
119 | - foreach ($files as $file) { |
|
120 | - if (substr($file, 0, $pathLength) == $path and $file != $path) { |
|
121 | - if (strrpos(substr($file, 0, -1), '/') <= $pathLength) { |
|
122 | - $folderContent[] = substr($file, $pathLength); |
|
123 | - } |
|
124 | - } |
|
125 | - } |
|
126 | - return $folderContent; |
|
127 | - } |
|
128 | - /** |
|
129 | - * get all files in the archive |
|
130 | - * @return array |
|
131 | - */ |
|
132 | - public function getFiles() { |
|
133 | - $fileCount = $this->zip->numFiles; |
|
134 | - $files = []; |
|
135 | - for ($i = 0;$i < $fileCount;$i++) { |
|
136 | - $files[] = $this->zip->getNameIndex($i); |
|
137 | - } |
|
138 | - return $files; |
|
139 | - } |
|
140 | - /** |
|
141 | - * get the content of a file |
|
142 | - * @param string $path |
|
143 | - * @return string |
|
144 | - */ |
|
145 | - public function getFile($path) { |
|
146 | - return $this->zip->getFromName($path); |
|
147 | - } |
|
148 | - /** |
|
149 | - * extract a single file from the archive |
|
150 | - * @param string $path |
|
151 | - * @param string $dest |
|
152 | - * @return boolean|null |
|
153 | - */ |
|
154 | - public function extractFile($path, $dest) { |
|
155 | - $fp = $this->zip->getStream($path); |
|
156 | - file_put_contents($dest, $fp); |
|
157 | - } |
|
158 | - /** |
|
159 | - * extract the archive |
|
160 | - * @param string $dest |
|
161 | - * @return bool |
|
162 | - */ |
|
163 | - public function extract($dest) { |
|
164 | - return $this->zip->extractTo($dest); |
|
165 | - } |
|
166 | - /** |
|
167 | - * check if a file or folder exists in the archive |
|
168 | - * @param string $path |
|
169 | - * @return bool |
|
170 | - */ |
|
171 | - public function fileExists($path) { |
|
172 | - return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false); |
|
173 | - } |
|
174 | - /** |
|
175 | - * remove a file or folder from the archive |
|
176 | - * @param string $path |
|
177 | - * @return bool |
|
178 | - */ |
|
179 | - public function remove($path) { |
|
180 | - if ($this->fileExists($path.'/')) { |
|
181 | - return $this->zip->deleteName($path.'/'); |
|
182 | - } else { |
|
183 | - return $this->zip->deleteName($path); |
|
184 | - } |
|
185 | - } |
|
186 | - /** |
|
187 | - * get a file handler |
|
188 | - * @param string $path |
|
189 | - * @param string $mode |
|
190 | - * @return bool|resource |
|
191 | - */ |
|
192 | - public function getStream($path, $mode) { |
|
193 | - if ($mode == 'r' or $mode == 'rb') { |
|
194 | - return $this->zip->getStream($path); |
|
195 | - } else { |
|
196 | - //since we can't directly get a writable stream, |
|
197 | - //make a temp copy of the file and put it back |
|
198 | - //in the archive when the stream is closed |
|
199 | - if (strrpos($path, '.') !== false) { |
|
200 | - $ext = substr($path, strrpos($path, '.')); |
|
201 | - } else { |
|
202 | - $ext = ''; |
|
203 | - } |
|
204 | - $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); |
|
205 | - if ($this->fileExists($path)) { |
|
206 | - $this->extractFile($path, $tmpFile); |
|
207 | - } |
|
208 | - $handle = fopen($tmpFile, $mode); |
|
209 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
210 | - $this->writeBack($tmpFile, $path); |
|
211 | - }); |
|
212 | - } |
|
213 | - } |
|
45 | + /** |
|
46 | + * @param string $source |
|
47 | + */ |
|
48 | + public function __construct($source) { |
|
49 | + $this->path = $source; |
|
50 | + $this->zip = new \ZipArchive(); |
|
51 | + if ($this->zip->open($source, \ZipArchive::CREATE)) { |
|
52 | + } else { |
|
53 | + \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, ILogger::WARN); |
|
54 | + } |
|
55 | + } |
|
56 | + /** |
|
57 | + * add an empty folder to the archive |
|
58 | + * @param string $path |
|
59 | + * @return bool |
|
60 | + */ |
|
61 | + public function addFolder($path) { |
|
62 | + return $this->zip->addEmptyDir($path); |
|
63 | + } |
|
64 | + /** |
|
65 | + * add a file to the archive |
|
66 | + * @param string $path |
|
67 | + * @param string $source either a local file or string data |
|
68 | + * @return bool |
|
69 | + */ |
|
70 | + public function addFile($path, $source = '') { |
|
71 | + if ($source and $source[0] == '/' and file_exists($source)) { |
|
72 | + $result = $this->zip->addFile($source, $path); |
|
73 | + } else { |
|
74 | + $result = $this->zip->addFromString($path, $source); |
|
75 | + } |
|
76 | + if ($result) { |
|
77 | + $this->zip->close();//close and reopen to save the zip |
|
78 | + $this->zip->open($this->path); |
|
79 | + } |
|
80 | + return $result; |
|
81 | + } |
|
82 | + /** |
|
83 | + * rename a file or folder in the archive |
|
84 | + * @param string $source |
|
85 | + * @param string $dest |
|
86 | + * @return boolean|null |
|
87 | + */ |
|
88 | + public function rename($source, $dest) { |
|
89 | + $source = $this->stripPath($source); |
|
90 | + $dest = $this->stripPath($dest); |
|
91 | + $this->zip->renameName($source, $dest); |
|
92 | + } |
|
93 | + /** |
|
94 | + * get the uncompressed size of a file in the archive |
|
95 | + * @param string $path |
|
96 | + * @return int |
|
97 | + */ |
|
98 | + public function filesize($path) { |
|
99 | + $stat = $this->zip->statName($path); |
|
100 | + return $stat['size']; |
|
101 | + } |
|
102 | + /** |
|
103 | + * get the last modified time of a file in the archive |
|
104 | + * @param string $path |
|
105 | + * @return int |
|
106 | + */ |
|
107 | + public function mtime($path) { |
|
108 | + return filemtime($this->path); |
|
109 | + } |
|
110 | + /** |
|
111 | + * get the files in a folder |
|
112 | + * @param string $path |
|
113 | + * @return array |
|
114 | + */ |
|
115 | + public function getFolder($path) { |
|
116 | + $files = $this->getFiles(); |
|
117 | + $folderContent = []; |
|
118 | + $pathLength = strlen($path); |
|
119 | + foreach ($files as $file) { |
|
120 | + if (substr($file, 0, $pathLength) == $path and $file != $path) { |
|
121 | + if (strrpos(substr($file, 0, -1), '/') <= $pathLength) { |
|
122 | + $folderContent[] = substr($file, $pathLength); |
|
123 | + } |
|
124 | + } |
|
125 | + } |
|
126 | + return $folderContent; |
|
127 | + } |
|
128 | + /** |
|
129 | + * get all files in the archive |
|
130 | + * @return array |
|
131 | + */ |
|
132 | + public function getFiles() { |
|
133 | + $fileCount = $this->zip->numFiles; |
|
134 | + $files = []; |
|
135 | + for ($i = 0;$i < $fileCount;$i++) { |
|
136 | + $files[] = $this->zip->getNameIndex($i); |
|
137 | + } |
|
138 | + return $files; |
|
139 | + } |
|
140 | + /** |
|
141 | + * get the content of a file |
|
142 | + * @param string $path |
|
143 | + * @return string |
|
144 | + */ |
|
145 | + public function getFile($path) { |
|
146 | + return $this->zip->getFromName($path); |
|
147 | + } |
|
148 | + /** |
|
149 | + * extract a single file from the archive |
|
150 | + * @param string $path |
|
151 | + * @param string $dest |
|
152 | + * @return boolean|null |
|
153 | + */ |
|
154 | + public function extractFile($path, $dest) { |
|
155 | + $fp = $this->zip->getStream($path); |
|
156 | + file_put_contents($dest, $fp); |
|
157 | + } |
|
158 | + /** |
|
159 | + * extract the archive |
|
160 | + * @param string $dest |
|
161 | + * @return bool |
|
162 | + */ |
|
163 | + public function extract($dest) { |
|
164 | + return $this->zip->extractTo($dest); |
|
165 | + } |
|
166 | + /** |
|
167 | + * check if a file or folder exists in the archive |
|
168 | + * @param string $path |
|
169 | + * @return bool |
|
170 | + */ |
|
171 | + public function fileExists($path) { |
|
172 | + return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false); |
|
173 | + } |
|
174 | + /** |
|
175 | + * remove a file or folder from the archive |
|
176 | + * @param string $path |
|
177 | + * @return bool |
|
178 | + */ |
|
179 | + public function remove($path) { |
|
180 | + if ($this->fileExists($path.'/')) { |
|
181 | + return $this->zip->deleteName($path.'/'); |
|
182 | + } else { |
|
183 | + return $this->zip->deleteName($path); |
|
184 | + } |
|
185 | + } |
|
186 | + /** |
|
187 | + * get a file handler |
|
188 | + * @param string $path |
|
189 | + * @param string $mode |
|
190 | + * @return bool|resource |
|
191 | + */ |
|
192 | + public function getStream($path, $mode) { |
|
193 | + if ($mode == 'r' or $mode == 'rb') { |
|
194 | + return $this->zip->getStream($path); |
|
195 | + } else { |
|
196 | + //since we can't directly get a writable stream, |
|
197 | + //make a temp copy of the file and put it back |
|
198 | + //in the archive when the stream is closed |
|
199 | + if (strrpos($path, '.') !== false) { |
|
200 | + $ext = substr($path, strrpos($path, '.')); |
|
201 | + } else { |
|
202 | + $ext = ''; |
|
203 | + } |
|
204 | + $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); |
|
205 | + if ($this->fileExists($path)) { |
|
206 | + $this->extractFile($path, $tmpFile); |
|
207 | + } |
|
208 | + $handle = fopen($tmpFile, $mode); |
|
209 | + return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
210 | + $this->writeBack($tmpFile, $path); |
|
211 | + }); |
|
212 | + } |
|
213 | + } |
|
214 | 214 | |
215 | - /** |
|
216 | - * write back temporary files |
|
217 | - */ |
|
218 | - public function writeBack($tmpFile, $path) { |
|
219 | - $this->addFile($path, $tmpFile); |
|
220 | - unlink($tmpFile); |
|
221 | - } |
|
215 | + /** |
|
216 | + * write back temporary files |
|
217 | + */ |
|
218 | + public function writeBack($tmpFile, $path) { |
|
219 | + $this->addFile($path, $tmpFile); |
|
220 | + unlink($tmpFile); |
|
221 | + } |
|
222 | 222 | |
223 | - /** |
|
224 | - * @param string $path |
|
225 | - * @return string |
|
226 | - */ |
|
227 | - private function stripPath($path) { |
|
228 | - if (!$path || $path[0] == '/') { |
|
229 | - return substr($path, 1); |
|
230 | - } else { |
|
231 | - return $path; |
|
232 | - } |
|
233 | - } |
|
223 | + /** |
|
224 | + * @param string $path |
|
225 | + * @return string |
|
226 | + */ |
|
227 | + private function stripPath($path) { |
|
228 | + if (!$path || $path[0] == '/') { |
|
229 | + return substr($path, 1); |
|
230 | + } else { |
|
231 | + return $path; |
|
232 | + } |
|
233 | + } |
|
234 | 234 | } |