X-Git-Url: https://git.cweiske.de/grauphel.git/blobdiff_plain/db2f09d46ce2f3a46be1b6f6e031492966242025..ace226e665fa77d04a61dfd61818f6cce5df6861:/controller/apicontroller.php?ds=inline diff --git a/controller/apicontroller.php b/controller/apicontroller.php index 8ce8997..688d0b0 100644 --- a/controller/apicontroller.php +++ b/controller/apicontroller.php @@ -16,8 +16,12 @@ namespace OCA\Grauphel\Controller; use \OCP\AppFramework\Controller; use \OCP\AppFramework\Http\JSONResponse; +use \OCA\Grauphel\Lib\Client; +use \OCA\Grauphel\Lib\NoteStorage; use \OCA\Grauphel\Lib\OAuth; +use \OCA\Grauphel\Lib\OAuthException; use \OCA\Grauphel\Lib\Dependencies; +use \OCA\Grauphel\Lib\Response\ErrorResponse; /** * Tomboy's REST API @@ -32,6 +36,23 @@ use \OCA\Grauphel\Lib\Dependencies; */ class ApiController extends Controller { + /** + * constructor of the controller + * + * @param string $appName Name of the app + * @param IRequest $request Instance of the request + */ + public function __construct($appName, \OCP\IRequest $request, $user) + { + parent::__construct($appName, $request); + $this->user = $user; + $this->deps = Dependencies::get(); + $this->notes = new NoteStorage($this->deps->urlGen); + + //default http header: we assume something is broken + header('HTTP/1.0 500 Internal Server Error'); + } + /** * /api/1.0 * @@ -39,7 +60,7 @@ class ApiController extends Controller * @NoCSRFRequired * @PublicPage */ - public function index() + public function index($route = 'grauphel.api.index') { $deps = Dependencies::get(); $authenticated = false; @@ -48,24 +69,28 @@ class ApiController extends Controller $urlGen = $deps->urlGen; try { - $provider = new \OAuthProvider(); + $provider = OAuth::getProvider(); $oauth->registerHandler($provider) ->registerAccessTokenHandler($provider); $provider->checkOAuthRequest( $urlGen->getAbsoluteURL( - $urlGen->linkToRoute('grauphel.api.index') + $urlGen->linkToRoute($route) ) ); $authenticated = true; $token = $deps->tokens->load('access', $provider->token); $username = $token->user; - } catch (\OAuth_Exception $e) { - $deps->renderer->errorOut($e->getMessage()); + } catch (OAuthException $e) { + return new ErrorResponse($e->getMessage()); } catch (\OAuthException $e) { if ($e->getCode() != OAUTH_PARAMETER_ABSENT) { $oauth->error($e); } + if ($this->user !== null) { + $username = $this->user->getUID(); + $authenticated = true; + } } $data = array( @@ -81,11 +106,17 @@ class ApiController extends Controller 'api-version' => '1.0', ); + $cl = new Client(); + $client = $cl->getClient(); + if ($client !== false) { + $data['oauth_authorize_url'] .= '?client=' . urlencode($client); + } + if ($authenticated) { $data['user-ref'] = array( 'api-ref' => $urlGen->getAbsoluteURL( $urlGen->linkToRoute( - 'grauphel.api.user', array('user' => $username) + 'grauphel.api.user', array('username' => $username) ) ), 'href' => null,//FIXME @@ -93,65 +124,116 @@ class ApiController extends Controller } return new JSONResponse($data); - $deps->renderer->sendJson($data); } /** - * GET /api/1.0/$user/notes/$noteguid + * /api/1.0/ * * @NoAdminRequired * @NoCSRFRequired * @PublicPage */ - public function note() + public function indexSlash() { - $deps = Dependencies::get(); - $username = $deps->urlGen->loadUsername(); - $guid = $deps->urlGen->loadGuid(); - $oauth = new \OAuth(); - $oauth->setDeps($deps); - $oauth->verifyOAuthUser($username, $deps->urlGen->note($username, $guid)); + return $this->index('grauphel.api.indexSlash'); + } - $note = $deps->notes->load($username, $guid, false); - if ($note === null) { - header('HTTP/1.0 404 Not Found'); - header('Content-type: text/plain'); - echo "Note does not exist\n"; - exit(1); - } + /** + * GET /api/1.0/$user + * + * @NoAdminRequired + * @NoCSRFRequired + * @PublicPage + */ + public function user($username) + { + $this->verifyUser( + $username, + $this->deps->urlGen->getAbsoluteURL( + $this->deps->urlGen->linkToRoute( + 'grauphel.api.user', array('username' => $username) + ) + ) + ); + $syncdata = $this->notes->loadSyncData(); - $data = array('note' => array($note)); - $deps->renderer->sendJson($data); + $data = array( + 'user-name' => $username, + 'first-name' => null, + 'last-name' => null, + 'notes-ref' => array( + 'api-ref' => $this->deps->urlGen->getAbsoluteURL( + $this->deps->urlGen->linkToRoute( + 'grauphel.api.notes', array('username' => $username) + ) + ), + 'href' => null, + ), + 'latest-sync-revision' => $syncdata->latestSyncRevision, + 'current-sync-guid' => $syncdata->currentSyncGuid, + ); + return new JSONResponse($data); } /** - * GET|PUT /api/1.0/$user/notes + * GET /api/1.0/$user/notes * * @NoAdminRequired * @NoCSRFRequired * @PublicPage */ - public function notes() + public function notes($username) { - $deps = Dependencies::get(); - $username = $deps->urlGen->loadUsername(); - $oauth = new \OAuth(); - $oauth->setDeps($deps); - $oauth->verifyOAuthUser($username, $deps->urlGen->notes($username)); + $this->verifyUser( + $username, + $this->deps->urlGen->getAbsoluteURL( + $this->deps->urlGen->linkToRoute( + 'grauphel.api.notes', array('username' => $username) + ) + ) + ); + $syncdata = $this->notes->loadSyncData(); + return $this->fetchNotes($syncdata); + } - $syncdata = $deps->notes->loadSyncData($username); + /** + * PUT /api/1.0/$user/notes + * + * @NoAdminRequired + * @NoCSRFRequired + * @PublicPage + */ + public function notesSave($username) + { + $this->verifyUser( + $username, + $this->deps->urlGen->getAbsoluteURL( + $this->deps->urlGen->linkToRoute( + 'grauphel.api.notesSave', array('username' => $username) + ) + ) + ); + $syncdata = $this->notes->loadSyncData(); + + $res = $this->handleNoteSave($username, $syncdata); + if ($res instanceof \OCP\AppFramework\Http\Response) { + return $res; + } - $this->handleNoteSave($username, $syncdata); + return $this->fetchNotes($syncdata); + } + protected function fetchNotes($syncdata) + { $since = null; if (isset($_GET['since'])) { $since = (int) $_GET['since']; } if (isset($_GET['include_notes']) && $_GET['include_notes']) { - $notes = $deps->notes->loadNotesFull($username, $since); + $notes = $this->notes->loadNotesFull($since); } else { - $notes = $deps->notes->loadNotesOverview($username, $since); + $notes = $this->notes->loadNotesOverview($since); } //work around bug https://bugzilla.gnome.org/show_bug.cgi?id=734313 @@ -165,7 +247,7 @@ class ApiController extends Controller 'latest-sync-revision' => $syncdata->latestSyncRevision, 'notes' => $notes, ); - $deps->renderer->sendJson($data); + return new JSONResponse($data); } protected function handleNoteSave($username, $syncdata) @@ -174,80 +256,104 @@ class ApiController extends Controller return; } - $data = file_get_contents('php://input'); - $putObj = json_decode($data); - if ($putObj === NULL) { - errorOut('Invalid JSON data in PUT request'); - } + //note that we have more data in $arPut than just our JSON + // request object merges it with other data + $arPut = $this->request->put; //structural validation - if (!isset($putObj->{'latest-sync-revision'})) { - errorOut('Missing "latest-sync-revision"'); + if (!isset($arPut['latest-sync-revision'])) { + return new ErrorResponse('Missing "latest-sync-revision"'); } - if (!isset($putObj->{'note-changes'})) { - errorOut('Missing "note-changes"'); + if (!isset($arPut['note-changes'])) { + return new ErrorResponse('Missing "note-changes"'); } - foreach ($putObj->{'note-changes'} as $note) { + foreach ($arPut['note-changes'] as $note) { + //owncloud converts object to array, so we reverse + $note = (object) $note; if (!isset($note->guid) || $note->guid == '') { - errorOut('Missing "guid" on note'); + return new ErrorResponse('Missing "guid" on note'); } } //content validation - if ($putObj->{'latest-sync-revision'} != $syncdata->latestSyncRevision +1 + if ($arPut['latest-sync-revision'] != $syncdata->latestSyncRevision +1 && $syncdata->latestSyncRevision != -1 ) { - errorOut('Wrong "latest-sync-revision". You are not up to date.'); + return new ErrorResponse( + 'Wrong "latest-sync-revision". You are not up to date.' + ); } //update - $deps = Dependencies::get(); ++$syncdata->latestSyncRevision; - foreach ($putObj->{'note-changes'} as $noteUpdate) { - $note = $deps->notes->load($username, $noteUpdate->guid); + foreach ($arPut['note-changes'] as $noteUpdate) { + //owncloud converts object to array, so we reverse + $noteUpdate = (object) $noteUpdate; + + $note = $this->notes->load($noteUpdate->guid); if (isset($noteUpdate->command) && $noteUpdate->command == 'delete') { - $deps->notes->delete($username, $noteUpdate->guid); + $this->notes->delete($noteUpdate->guid); } else { - $deps->notes->update( + $this->notes->update( $note, $noteUpdate, $syncdata->latestSyncRevision ); - $deps->notes->save($username, $note); + $this->notes->save($note); } } - $deps->notes->saveSyncData($username, $syncdata); + $this->notes->saveSyncData($syncdata); } /** - * GET /api/1.0/$user + * GET /api/1.0/$user/notes/$noteguid * * @NoAdminRequired * @NoCSRFRequired * @PublicPage */ - public function user() + public function note($username, $guid) { - $deps = Dependencies::get(); - $username = $deps->urlGen->loadUsername(); + $this->verifyUser( + $username, + $this->deps->urlGen->getAbsoluteURL( + $this->deps->urlGen->linkToRoute( + 'grauphel.api.note', + array('username' => $username, 'guid' => $guid) + ) + ) + ); - $oauth = new \OAuth(); - $oauth->setDeps($deps); - $oauth->verifyOAuthUser($username, $deps->urlGen->user($username)); + $note = $this->notes->load($guid, false); + if ($note === null) { + header('HTTP/1.0 404 Not Found'); + header('Content-type: text/plain'); + echo "Note does not exist\n"; + exit(1); + } - $syncdata = $deps->notes->loadSyncData($username); + return new JSONResponse($note); + } - $data = array( - 'user-name' => $username, - 'first-name' => null, - 'last-name' => null, - 'notes-ref' => array( - 'api-ref' => $deps->urlGen->notes($username), - 'href' => null, - ), - 'latest-sync-revision' => $syncdata->latestSyncRevision, - 'current-sync-guid' => $syncdata->currentSyncGuid, - ); - $deps->renderer->sendJson($data); + /** + * Checks if the given user is authorized (by oauth token or normal login) + * + * @param string $username Username to verify + * + * @return boolean True if all is fine, Response in case of an error + */ + protected function verifyUser($username, $curUrl) + { + if ($this->user !== null && $this->user->getUid() == $username) { + $this->notes->setUsername($username); + return true; + } + + $oauth = new OAuth(); + $oauth->setDeps($this->deps); + $oauth->verifyOAuthUser($username, $curUrl); + + $this->notes->setUsername($username); + return true; } } ?>