mirror of
https://code.mensbeam.com/MensBeam/Arsse.git
synced 2024-12-22 21:22:40 +00:00
Implement NCN API v1-2 folder deleting/renaming
- Fixes #5 - Fixes #6 - Rewrote the NCNv1 dispatcher to better handle URL edge cases
This commit is contained in:
J. King
parent
19abce85c3
commit
9cbfa378bc
2 changed files with 219 additions and 71 deletions
|
|
@ -2,79 +2,133 @@
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
namespace JKingWeb\Arsse\REST\NextCloudNews;
|
namespace JKingWeb\Arsse\REST\NextCloudNews;
|
||||||
use JKingWeb\Arsse\Data;
|
use JKingWeb\Arsse\Data;
|
||||||
use JKingWeb\Arsse\REST\Response;
|
|
||||||
use JKingWeb\Arsse\AbstractException;
|
use JKingWeb\Arsse\AbstractException;
|
||||||
|
use JKingWeb\Arsse\Db\ExceptionInput;
|
||||||
|
use JKingWeb\Arsse\REST\Response;
|
||||||
|
|
||||||
class V1_2 extends \JKingWeb\Arsse\REST\AbstractHandler {
|
class V1_2 extends \JKingWeb\Arsse\REST\AbstractHandler {
|
||||||
function __construct() {
|
function __construct() {
|
||||||
}
|
}
|
||||||
|
|
||||||
function dispatch(\JKingWeb\Arsse\REST\Request $req): \JKingWeb\Arsse\REST\Response {
|
function dispatch(\JKingWeb\Arsse\REST\Request $req): Response {
|
||||||
// try to authenticate
|
// try to authenticate
|
||||||
if(!Data::$user->authHTTP()) return new Response(401, "", "", ['WWW-Authenticate: Basic realm="NextCloud News API"']);
|
if(!Data::$user->authHTTP()) return new Response(401, "", "", ['WWW-Authenticate: Basic realm="NextCloud News API v1-2"']);
|
||||||
// only accept GET, POST, or PUT
|
// only accept GET, POST, PUT, or DELETE
|
||||||
if(!in_array($req->method, ["GET", "POST", "PUT"])) return new Response(405, "", "", ['Allow: GET, POST, PUT']);
|
if(!in_array($req->method, ["GET", "POST", "PUT", "DELETE"])) return new Response(405, "", "", ['Allow: GET, POST, PUT, DELETE']);
|
||||||
// normalize the input
|
// normalize the input
|
||||||
if($req->body) {
|
if($req->body) {
|
||||||
// if the entity body is not JSON according to content type, return "415 Unsupported Media Type"
|
// if the entity body is not JSON according to content type, return "415 Unsupported Media Type"
|
||||||
if(!preg_match("<^application/json\b|^$>", $req->type)) return new Response(415, "", "", ['Accept: application/json']);
|
if(!preg_match("<^application/json\b|^$>", $req->type)) return new Response(415, "", "", ['Accept: application/json']);
|
||||||
try {
|
try {
|
||||||
$data = json_decode($req->body, true);
|
$data = json_decode($req->body, true);
|
||||||
} catch(\Throwable $e) {
|
} catch(\Throwable $e) {
|
||||||
// if the body could not be parsed as JSON, return "400 Bad Request"
|
// if the body could not be parsed as JSON, return "400 Bad Request"
|
||||||
return new Response(400);
|
return new Response(400);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
$data = [];
|
$data = [];
|
||||||
}
|
}
|
||||||
// FIXME: Do query parameters take precedence in NextCloud? Is there a conflict error when values differ?
|
// FIXME: Do query parameters take precedence in NextCloud? Is there a conflict error when values differ?
|
||||||
$data = array_merge($data, $req->query);
|
$data = array_merge($data, $req->query);
|
||||||
// match the path
|
// match the path
|
||||||
if(preg_match("<^/(items|folders|feeds|cleanup|version|status|user)(?:/([^/]+))?(?:/([^/]+))?(?:/([^/]+))?/?$>", $req->path, $match)) {
|
if(preg_match("<^/(items|folders|feeds|cleanup|version|status|user)(?:/([^/]+))?(?:/([^/]+))?(?:/([^/]+))?/?$>", $req->path, $url)) {
|
||||||
// dispatch
|
// clean up the path
|
||||||
try {
|
$scope = $url[1];
|
||||||
switch($match[1]) {
|
unset($url[0]);
|
||||||
case "folders":
|
unset($url[1]);
|
||||||
switch($req->method) {
|
$url = array_filter($url);
|
||||||
case "GET": return $this->folderList();
|
$url = array_values($url);
|
||||||
case "POST": return $this->folderAdd($data);
|
// check to make sure the requested function is implemented
|
||||||
case "PUT":
|
$func = $scope.$req->method;
|
||||||
return $this->folderEdit($match[2], $data);
|
if(!method_exists($this, $func)) return new Response(501);
|
||||||
}
|
// dispatch
|
||||||
default: return new Response(404);
|
try {
|
||||||
}
|
return $this->$func($url, $data);
|
||||||
} catch(Exception $e) {
|
} catch(Exception $e) {
|
||||||
// if there was a REST exception return 400
|
// if there was a REST exception return 400
|
||||||
return new Response(400);
|
return new Response(400);
|
||||||
} catch(AbstractException $e) {
|
} catch(AbstractException $e) {
|
||||||
// if there was any other Arsse exception return 500
|
// if there was any other Arsse exception return 500
|
||||||
return new Response(500);
|
return new Response(500);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
return new Response(404);
|
return new Response(404);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function folderList(): Response {
|
// list folders
|
||||||
$folders = Data::$db->folderList(Data::$user->id, null, false)->getAll();
|
protected function foldersGET(array $url, array $data): Response {
|
||||||
return new Response(200, ['folders' => $folders]);
|
// if URL is more than '/folders' this is an error
|
||||||
}
|
if(sizeof($url)==1) return new Response(405, "", "", ['Allow: PUT, DELETE']);
|
||||||
|
if(sizeof($url) > 1) return new Response(404);
|
||||||
|
$folders = Data::$db->folderList(Data::$user->id, null, false)->getAll();
|
||||||
|
return new Response(200, ['folders' => $folders]);
|
||||||
|
}
|
||||||
|
|
||||||
protected function folderAdd($data): Response {
|
// create a folder
|
||||||
try {
|
protected function foldersPOST(array $url, array $data): Response {
|
||||||
$folder = Data::$db->folderAdd(Data::$user->id, $data);
|
// if URL is more than '/folders' this is an error
|
||||||
} catch(\JKingWeb\Arsse\Db\ExceptionInput $e) {
|
if(sizeof($url)==1) return new Response(405, "", "", ['Allow: PUT, DELETE']);
|
||||||
switch($e->getCode()) {
|
if(sizeof($url) > 1) return new Response(404);
|
||||||
// folder already exists
|
try {
|
||||||
case 10236: return new Response(409);
|
$folder = Data::$db->folderAdd(Data::$user->id, $data);
|
||||||
// folder name not acceptable
|
} catch(ExceptionInput $e) {
|
||||||
case 10231:
|
switch($e->getCode()) {
|
||||||
case 10232: return new Response(422);
|
// folder already exists
|
||||||
// other errors related to input
|
case 10236: return new Response(409);
|
||||||
default: return new Response(400);
|
// folder name not acceptable
|
||||||
}
|
case 10231:
|
||||||
}
|
case 10232: return new Response(422);
|
||||||
$folder = Data::$db->folderPropertiesGet(Data::$user->id, $folder);
|
// other errors related to input
|
||||||
return new Response(200, ['folders' => [$folder]]);
|
default: return new Response(400);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
$folder = Data::$db->folderPropertiesGet(Data::$user->id, $folder);
|
||||||
|
return new Response(200, ['folders' => [$folder]]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// delete a folder
|
||||||
|
protected function foldersDELETE(array $url, array $data): Response {
|
||||||
|
// if URL is more or less than '/folders/$id' this is an error
|
||||||
|
if(sizeof($url) < 1) return new Response(405, "", "", ['Allow: GET, POST']);
|
||||||
|
if(sizeof($url) > 1) return new Response(404);
|
||||||
|
// folder ID must be integer
|
||||||
|
if(strval(intval($url[0])) !== $url[0]) return new Response(404);
|
||||||
|
// perform the deletion
|
||||||
|
try {
|
||||||
|
Data::$db->folderRemove(Data::$user->id, (int) $url[0]);
|
||||||
|
} catch(ExceptionInput $e) {
|
||||||
|
// folder does not exist
|
||||||
|
return new Response(404);
|
||||||
|
}
|
||||||
|
return new Response(204);
|
||||||
|
}
|
||||||
|
|
||||||
|
// rename a folder (also supports moving nesting folders, but this is not a feature of the API)
|
||||||
|
protected function foldersPUT(array $url, array $data): Response {
|
||||||
|
// if URL is more or less than '/folders/$id' this is an error
|
||||||
|
if(sizeof($url) < 1) return new Response(405, "", "", ['Allow: GET, POST']);
|
||||||
|
if(sizeof($url) > 1) return new Response(404);
|
||||||
|
// folder ID must be integer
|
||||||
|
if(strval(intval($url[0])) !== $url[0]) return new Response(404);
|
||||||
|
// there must be some change to be made
|
||||||
|
if(!sizeof($data)) return new Response(422);
|
||||||
|
// perform the edit
|
||||||
|
try {
|
||||||
|
Data::$db->folderPropertiesSet(Data::$user->id, (int) $url[0], $data);
|
||||||
|
} catch(ExceptionInput $e) {
|
||||||
|
switch($e->getCode()) {
|
||||||
|
// folder does not exist
|
||||||
|
case 10235: return new Response(404);
|
||||||
|
// folder already exists
|
||||||
|
case 10236: return new Response(409);
|
||||||
|
// folder name not acceptable
|
||||||
|
case 10231:
|
||||||
|
case 10232: return new Response(422);
|
||||||
|
// other errors related to input
|
||||||
|
default: return new Response(400);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return new Response(204);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -27,6 +27,43 @@ class TestNCNV1_2 extends \PHPUnit\Framework\TestCase {
|
||||||
$this->clearData();
|
$this->clearData();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function testRespondToInvalidPaths() {
|
||||||
|
$errs = [
|
||||||
|
404 => [
|
||||||
|
['GET', "/"],
|
||||||
|
['PUT', "/"],
|
||||||
|
['POST', "/"],
|
||||||
|
['DELETE', "/"],
|
||||||
|
['GET', "/folders/1/invalid"],
|
||||||
|
['PUT', "/folders/1/invalid"],
|
||||||
|
['POST', "/folders/1/invalid"],
|
||||||
|
['DELETE', "/folders/1/invalid"],
|
||||||
|
],
|
||||||
|
405 => [
|
||||||
|
'GET, POST' => [
|
||||||
|
['PUT', "/folders"],
|
||||||
|
['DELETE', "/folders"],
|
||||||
|
],
|
||||||
|
'PUT, DELETE' => [
|
||||||
|
['GET', "/folders/1"],
|
||||||
|
['POST', "/folders/1"],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
];
|
||||||
|
foreach($errs[404] as $req) {
|
||||||
|
$exp = new Response(404);
|
||||||
|
list($method, $path) = $req;
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request($method, $path)), "$method call to $path did not return 404.");
|
||||||
|
}
|
||||||
|
foreach($errs[405] as $allow => $cases) {
|
||||||
|
$exp = new Response(405, "", "", ['Allow: '.$allow]);
|
||||||
|
foreach($cases as $req) {
|
||||||
|
list($method, $path) = $req;
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request($method, $path)), "$method call to $path did not return 405.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function testListFolders() {
|
function testListFolders() {
|
||||||
$list = [
|
$list = [
|
||||||
['id' => 1, 'name' => "Software", 'parent' => null],
|
['id' => 1, 'name' => "Software", 'parent' => null],
|
||||||
|
|
@ -46,10 +83,16 @@ class TestNCNV1_2 extends \PHPUnit\Framework\TestCase {
|
||||||
['id' => 1, 'name' => "Software", 'parent' => null],
|
['id' => 1, 'name' => "Software", 'parent' => null],
|
||||||
['id' => 2, 'name' => "Hardware", 'parent' => null],
|
['id' => 2, 'name' => "Hardware", 'parent' => null],
|
||||||
];
|
];
|
||||||
Phake::when(Data::$db)->folderAdd(Data::$user->id, $in[0])->thenReturn(1);
|
// set of various mocks for testing
|
||||||
Phake::when(Data::$db)->folderAdd(Data::$user->id, $in[1])->thenReturn(2);
|
Phake::when(Data::$db)->folderAdd(Data::$user->id, $in[0])->thenReturn(1)->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("constraintViolation")); // error on the second call
|
||||||
|
Phake::when(Data::$db)->folderAdd(Data::$user->id, $in[1])->thenReturn(2)->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("constraintViolation")); // error on the second call
|
||||||
Phake::when(Data::$db)->folderPropertiesGet(Data::$user->id, 1)->thenReturn($out[0]);
|
Phake::when(Data::$db)->folderPropertiesGet(Data::$user->id, 1)->thenReturn($out[0]);
|
||||||
Phake::when(Data::$db)->folderPropertiesGet(Data::$user->id, 2)->thenReturn($out[1]);
|
Phake::when(Data::$db)->folderPropertiesGet(Data::$user->id, 2)->thenReturn($out[1]);
|
||||||
|
// set up mocks that produce errors
|
||||||
|
Phake::when(Data::$db)->folderAdd(Data::$user->id, [])->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("missing"));
|
||||||
|
Phake::when(Data::$db)->folderAdd(Data::$user->id, ['name' => ""])->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("missing"));
|
||||||
|
Phake::when(Data::$db)->folderAdd(Data::$user->id, ['name' => " "])->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("whitespace"));
|
||||||
|
// correctly add two folders, using different means
|
||||||
$exp = new Response(200, ['folders' => [$out[0]]]);
|
$exp = new Response(200, ['folders' => [$out[0]]]);
|
||||||
$this->assertEquals($exp, $this->h->dispatch(new Request("POST", "/folders", json_encode($in[0]), 'application/json')));
|
$this->assertEquals($exp, $this->h->dispatch(new Request("POST", "/folders", json_encode($in[0]), 'application/json')));
|
||||||
$exp = new Response(200, ['folders' => [$out[1]]]);
|
$exp = new Response(200, ['folders' => [$out[1]]]);
|
||||||
|
|
@ -58,5 +101,56 @@ class TestNCNV1_2 extends \PHPUnit\Framework\TestCase {
|
||||||
Phake::verify(Data::$db)->folderAdd(Data::$user->id, $in[1]);
|
Phake::verify(Data::$db)->folderAdd(Data::$user->id, $in[1]);
|
||||||
Phake::verify(Data::$db)->folderPropertiesGet(Data::$user->id, 1);
|
Phake::verify(Data::$db)->folderPropertiesGet(Data::$user->id, 1);
|
||||||
Phake::verify(Data::$db)->folderPropertiesGet(Data::$user->id, 2);
|
Phake::verify(Data::$db)->folderPropertiesGet(Data::$user->id, 2);
|
||||||
|
// test bad folder names
|
||||||
|
$exp = new Response(422);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("POST", "/folders")));
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("POST", "/folders", '{"name":""}', 'application/json')));
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("POST", "/folders", '{"name":" "}', 'application/json')));
|
||||||
|
// try adding the same two folders again
|
||||||
|
$exp = new Response(409);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("POST", "/folders?name=Software")));
|
||||||
|
$exp = new Response(409);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("POST", "/folders", json_encode($in[1]), 'application/json')));
|
||||||
|
}
|
||||||
|
|
||||||
|
function testRemoveAFolder() {
|
||||||
|
Phake::when(Data::$db)->folderRemove(Data::$user->id, 1)->thenReturn(true)->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("idMissing"));
|
||||||
|
$exp = new Response(204);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("DELETE", "/folders/1")));
|
||||||
|
// fail on the second invocation because it no longer exists
|
||||||
|
$exp = new Response(404);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("DELETE", "/folders/1")));
|
||||||
|
Phake::verify(Data::$db, Phake::times(2))->folderRemove(Data::$user->id, 1);
|
||||||
|
// use a non-integer folder ID
|
||||||
|
$exp = new Response(404);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("DELETE", "/folders/invalid")));
|
||||||
|
}
|
||||||
|
|
||||||
|
function testRenameAFolder() {
|
||||||
|
$in = [
|
||||||
|
["name" => "Software"],
|
||||||
|
["name" => "Software"],
|
||||||
|
["name" => ""],
|
||||||
|
["name" => " "],
|
||||||
|
[],
|
||||||
|
];
|
||||||
|
Phake::when(Data::$db)->folderPropertiesSet(Data::$user->id, 1, $in[0])->thenReturn(true);
|
||||||
|
Phake::when(Data::$db)->folderPropertiesSet(Data::$user->id, 2, $in[1])->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("constraintViolation"));
|
||||||
|
Phake::when(Data::$db)->folderPropertiesSet(Data::$user->id, 1, $in[2])->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("missing"));
|
||||||
|
Phake::when(Data::$db)->folderPropertiesSet(Data::$user->id, 1, $in[3])->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("whitespace"));
|
||||||
|
Phake::when(Data::$db)->folderPropertiesSet(Data::$user->id, 1, $in[4])->thenReturn(true); // this should be stopped by the handler before the request gets to the database
|
||||||
|
Phake::when(Data::$db)->folderPropertiesSet(Data::$user->id, 3, $this->anything())->thenThrow(new \JKingWeb\Arsse\Db\ExceptionInput("idMissing")); // folder ID 3 does not exist
|
||||||
|
$exp = new Response(204);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("PUT", "/folders/1", json_encode($in[0]), 'application/json')));
|
||||||
|
$exp = new Response(409);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("PUT", "/folders/2", json_encode($in[1]), 'application/json')));
|
||||||
|
$exp = new Response(422);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("PUT", "/folders/1", json_encode($in[2]), 'application/json')));
|
||||||
|
$exp = new Response(422);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("PUT", "/folders/1", json_encode($in[3]), 'application/json')));
|
||||||
|
$exp = new Response(422);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("PUT", "/folders/1", json_encode($in[4]), 'application/json')));
|
||||||
|
$exp = new Response(404);
|
||||||
|
$this->assertEquals($exp, $this->h->dispatch(new Request("PUT", "/folders/3", json_encode($in[0]), 'application/json')));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Loading…
Reference in a new issue