Skip to content

Chore(deprecation): Switch from annotations to method attributes #1604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
enjeck merged 1 commit into from
Aug 21, 2025
+82 −54
Merged

Chore(deprecation): Switch from annotations to method attributes #1604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 46 additions & 35 deletions lib/Controller/NotesApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,13 @@

use OCP\AppFramework\ApiController;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\CORS;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
use OCP\AppFramework\Http\JSONResponse;
use OCP\AppFramework\Http\StreamResponse;
use OCP\Files\IMimeTypeDetector;

use OCP\IRequest;

class NotesApiController extends ApiController {
Expand Down Expand Up @@ -48,10 +52,10 @@ public function __construct(


/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function index(
?string $category = null,
string $exclude = '',
Expand Down Expand Up @@ -92,10 +96,11 @@ public function index(


/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
*
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function get(int $id, string $exclude = '') : JSONResponse {
return $this->helper->handleErrorResponse(function () use ($id, $exclude) {
$exclude = explode(',', $exclude);
Expand All @@ -109,10 +114,11 @@ public function get(int $id, string $exclude = '') : JSONResponse {


/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
*
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function create(
string $category = '',
string $title = '',
Expand Down Expand Up @@ -140,11 +146,11 @@ public function create(
}

/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
* @deprecated this was used in API v0.2 only, use #create() instead
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function createAutoTitle(
string $category = '',
string $content = '',
Expand All @@ -158,10 +164,11 @@ public function createAutoTitle(
}

/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
*
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function update(
int $id,
?string $content = null,
Expand Down Expand Up @@ -198,11 +205,11 @@ public function update(
}

/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
* @deprecated this was used in API v0.2 only, use #update() instead
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function updateAutoTitle(
int $id,
?string $content = null,
Expand All @@ -222,10 +229,11 @@ public function updateAutoTitle(
}

/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
*
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function destroy(int $id) : JSONResponse {
return $this->helper->handleErrorResponse(function () use ($id) {
$this->service->delete($this->helper->getUID(), $id);
Expand All @@ -234,10 +242,11 @@ public function destroy(int $id) : JSONResponse {
}

/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
*
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function setSettings() : JSONResponse {
return $this->helper->handleErrorResponse(function () {
$this->settingsService->setPublic($this->helper->getUID(), $this->request->getParams());
Expand All @@ -246,19 +255,20 @@ public function setSettings() : JSONResponse {
}

/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function getSettings() : JSONResponse {
return $this->helper->handleErrorResponse(function () {
return $this->settingsService->getPublic($this->helper->getUID());
});
}
/**
* @NoAdminRequired
* @NoCSRFRequired
*
*/
#[NoAdminRequired]
#[NoCSRFRequired]
public function fail() : JSONResponse {
return $this->helper->handleErrorResponse(function () {
return new JSONResponse([], Http::STATUS_BAD_REQUEST);
Expand All @@ -269,11 +279,11 @@ public function fail() : JSONResponse {

/**
* With help from: https://github.com/nextcloud/cookbook
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
* @return JSONResponse|StreamResponse
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function getAttachment(int $noteid, string $path): Http\Response {
try {
$targetimage = $this->service->getAttachment(
Expand All @@ -297,10 +307,11 @@ public function getAttachment(int $noteid, string $path): Http\Response {
}

/**
* @NoAdminRequired
* @CORS
* @NoCSRFRequired
*
*/
#[NoAdminRequired]
#[CORS]
#[NoCSRFRequired]
public function uploadFile(int $noteid): JSONResponse {
$file = $this->request->getUploadedFile('file');
return $this->helper->handleErrorResponse(function () use ($noteid, $file): array {
Expand Down
37 changes: 25 additions & 12 deletions lib/Controller/NotesController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@

use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
use OCP\AppFramework\Http\JSONResponse;
use OCP\AppFramework\Http\StreamResponse;

use OCP\Files\IMimeTypeDetector;
use OCP\Files\Lock\ILock;
use OCP\Files\Lock\ILockManager;
Expand Down Expand Up @@ -57,8 +60,9 @@ public function __construct(
}

/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function index(int $pruneBefore = 0) : JSONResponse {
return $this->helper->handleErrorResponse(function () use ($pruneBefore) {
$userId = $this->helper->getUID();
Expand Down Expand Up @@ -105,8 +109,9 @@ public function index(int $pruneBefore = 0) : JSONResponse {


/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function dashboard() : JSONResponse {
return $this->helper->handleErrorResponse(function () {
$maxItems = 6;
Expand Down Expand Up @@ -137,8 +142,9 @@ public function dashboard() : JSONResponse {


/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function get(int $id) : JSONResponse {
return $this->helper->handleErrorResponse(function () use ($id) {
$note = $this->notesService->get($this->helper->getUID(), $id);
Expand All @@ -160,8 +166,9 @@ public function get(int $id) : JSONResponse {


/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function create(string $category = '', string $content = '', string $title = '') : JSONResponse {
return $this->helper->handleErrorResponse(function () use ($category, $content, $title) {
$note = $this->notesService->create($this->helper->getUID(), $title, $category);
Expand All @@ -174,8 +181,9 @@ public function create(string $category = '', string $content = '', string $titl


/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function undo(
int $id,
string $title,
Expand Down Expand Up @@ -213,8 +221,9 @@ public function undo(


/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function autotitle(int $id) : JSONResponse {
return $this->helper->handleErrorResponse(function () use ($id) {
$note = $this->notesService->get($this->helper->getUID(), $id);
Expand All @@ -231,8 +240,9 @@ public function autotitle(int $id) : JSONResponse {


/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function update(int $id, string $content) : JSONResponse {
return $this->helper->handleErrorResponse(function () use ($id, $content) {
$note = $this->helper->getNoteWithETagCheck($id, $this->request);
Expand All @@ -243,8 +253,9 @@ public function update(int $id, string $content) : JSONResponse {


/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function updateProperty(
int $id,
string $property,
Expand Down Expand Up @@ -308,8 +319,9 @@ public function updateProperty(


/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function destroy(int $id) : JSONResponse {
return $this->helper->handleErrorResponse(function () use ($id) {
$this->notesService->delete($this->helper->getUID(), $id);
Expand All @@ -319,10 +331,10 @@ public function destroy(int $id) : JSONResponse {

/**
* With help from: https://github.com/nextcloud/cookbook
* @NoAdminRequired
* @NoCSRFRequired
* @return JSONResponse|StreamResponse
*/
#[NoAdminRequired]
#[NoCSRFRequired]
public function getAttachment(int $noteid, string $path): Http\Response {
try {
$targetimage = $this->notesService->getAttachment(
Expand All @@ -348,8 +360,9 @@ public function getAttachment(int $noteid, string $path): Http\Response {
}

/**
* @NoAdminRequired
*
*/
#[NoAdminRequired]
public function uploadFile(int $noteid): JSONResponse {
$file = $this->request->getUploadedFile('file');
return $this->helper->handleErrorResponse(function () use ($noteid, $file) {
Expand Down
11 changes: 7 additions & 4 deletions lib/Controller/PageController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
use OCA\Viewer\Event\LoadViewer;
use OCP\App\IAppManager;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
use OCP\AppFramework\Http\ContentSecurityPolicy;
use OCP\AppFramework\Http\RedirectResponse;
use OCP\AppFramework\Http\TemplateResponse;
Expand Down Expand Up @@ -58,10 +60,10 @@ public function __construct(


/**
* @NoAdminRequired
* @NoCSRFRequired
* @suppress PhanUndeclaredClassReference, PhanTypeMismatchArgument, PhanUndeclaredClassMethod
*/
#[NoAdminRequired]
#[NoCSRFRequired]
public function index() : TemplateResponse {
$devMode = !is_file(dirname(__FILE__) . '/../../js/notes-main.js');
$response = new TemplateResponse(
Expand Down Expand Up @@ -100,9 +102,10 @@ public function index() : TemplateResponse {
}

/**
* @NoAdminRequired
* @NoCSRFRequired
*
*/
#[NoAdminRequired]
#[NoCSRFRequired]
public function create() : RedirectResponse {
$note = $this->notesService->create($this->userSession->getUser()->getUID(), '', '');
$note->setContent('');
Expand Down
7 changes: 4 additions & 3 deletions lib/Controller/SettingsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use OCA\Notes\Service\SettingsService;

use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\JSONResponse;
use OCP\IRequest;
use OCP\IUserSession;
Expand All @@ -36,9 +37,9 @@ private function getUID(): string {
}

/**
* @NoAdminRequired
* @throws \OCP\PreConditionNotMetException
*/
#[NoAdminRequired]
public function set(): JSONResponse {
$this->service->set(
$this->getUID(),
Expand All @@ -48,15 +49,15 @@ public function set(): JSONResponse {
}

/**
* @NoAdminRequired
*/
#[NoAdminRequired]
public function get(): JSONResponse {
return new JSONResponse($this->service->getAll($this->getUID()));
}

/**
* @NoAdminRequired
*/
#[NoAdminRequired]
public function migrate(): JSONResponse {
$this->service->delete($this->getUID(), 'editorHint');
return new JSONResponse();
Expand Down