open-dsi
/
nextcloud-server
mirror of https://github.com/nextcloud/server
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Refactors controllers by using PHP8's constructor property promotion.

Browse Source 
Signed-off-by: Faraz Samapoor <f.samapoor@gmail.com>
pull/38636/head
Faraz Samapoor 3 years ago
parent cf75c2eaae
commit 450bf5c99e
11 changed files with 81 additions and 187 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 22
      core/Controller/AppPasswordController.php
  2. 14
      core/Controller/AutoCompleteController.php
  3. 88
      core/Controller/AvatarController.php
  4. 8
      core/Controller/CSRFTokenController.php
  5. 45
      core/Controller/ClientFlowLoginController.php
  6. 33
      core/Controller/ClientFlowLoginV2Controller.php
  7. 21
      core/Controller/CollaborationResourcesController.php
  8. 9
      core/Controller/ContactsMenuController.php
  9. 4
      core/Controller/CssController.php
  10. 15
      core/Controller/GuestAvatarController.php
  11. 9
      core/Controller/HoverCardController.php

22
core/Controller/AppPasswordController.php
Unescape View File

@ -42,26 +42,14 @@ use OCP\ISession;
use OCP\Security\ISecureRandom;
class AppPasswordController extends \OCP\AppFramework\OCSController {
private ISession $session;
private ISecureRandom $random;
private IProvider $tokenProvider;
private IStore $credentialStore;
private IEventDispatcher $eventDispatcher;
public function __construct(string $appName,
IRequest $request,
ISession $session,
ISecureRandom $random,
IProvider $tokenProvider,
IStore $credentialStore,
IEventDispatcher $eventDispatcher) {
private ISession $session,
private ISecureRandom $random,
private IProvider $tokenProvider,
private IStore $credentialStore,
private IEventDispatcher $eventDispatcher) {
parent::__construct($appName, $request);
$this->session = $session;
$this->random = $random;
$this->tokenProvider = $tokenProvider;
$this->credentialStore = $credentialStore;
$this->eventDispatcher = $eventDispatcher;
}
/**

14
core/Controller/AutoCompleteController.php
Unescape View File

@ -40,20 +40,12 @@ use OCP\IRequest;
use OCP\Share\IShare;
class AutoCompleteController extends OCSController {
private ISearch $collaboratorSearch;
private IManager $autoCompleteManager;
private IEventDispatcher $dispatcher;
public function __construct(string $appName,
IRequest $request,
ISearch $collaboratorSearch,
IManager $autoCompleteManager,
IEventDispatcher $dispatcher) {
private ISearch $collaboratorSearch,
private IManager $autoCompleteManager,
private IEventDispatcher $dispatcher) {
parent::__construct($appName, $request);
$this->collaboratorSearch = $collaboratorSearch;
$this->autoCompleteManager = $autoCompleteManager;
$this->dispatcher = $dispatcher;
}
/**

88
core/Controller/AvatarController.php
Unescape View File

@ -43,7 +43,6 @@ use OCP\ICache;
use OCP\IL10N;
use OCP\IRequest;
use OCP\IUserManager;
use OCP\IUserSession;
use Psr\Log\LoggerInterface;
/**
@ -52,36 +51,17 @@ use Psr\Log\LoggerInterface;
* @package OC\Core\Controller
*/
class AvatarController extends Controller {
protected IAvatarManager $avatarManager;
protected ICache $cache;
protected IL10N $l;
protected IUserManager $userManager;
protected IUserSession $userSession;
protected IRootFolder $rootFolder;
protected LoggerInterface $logger;
protected ?string $userId;
protected TimeFactory $timeFactory;
public function __construct(string $appName,
IRequest $request,
IAvatarManager $avatarManager,
ICache $cache,
IL10N $l10n,
IUserManager $userManager,
IRootFolder $rootFolder,
LoggerInterface $logger,
?string $userId,
TimeFactory $timeFactory) {
protected IAvatarManager $avatarManager,
protected ICache $cache,
protected IL10N $l10n,
protected IUserManager $userManager,
protected IRootFolder $rootFolder,
protected LoggerInterface $logger,
protected ?string $userId,
protected TimeFactory $timeFactory) {
parent::__construct($appName, $request);
$this->avatarManager = $avatarManager;
$this->cache = $cache;
$this->l = $l10n;
$this->userManager = $userManager;
$this->rootFolder = $rootFolder;
$this->logger = $logger;
$this->userId = $userId;
$this->timeFactory = $timeFactory;
}
/**
@ -173,18 +153,18 @@ class AvatarController extends Controller {
/** @var File $node */
$node = $userFolder->get($path);
if (!($node instanceof File)) {
return new JSONResponse(['data' => ['message' => $this->l->t('Please select a file.')]]);
return new JSONResponse(['data' => ['message' => $this->l10n->t('Please select a file.')]]);
}
if ($node->getSize() > 20 * 1024 * 1024) {
return new JSONResponse(
['data' => ['message' => $this->l->t('File is too big')]],
['data' => ['message' => $this->l10n->t('File is too big')]],
Http::STATUS_BAD_REQUEST
);
}
if ($node->getMimeType() !== 'image/jpeg' && $node->getMimeType() !== 'image/png') {
return new JSONResponse(
['data' => ['message' => $this->l->t('The selected file is not an image.')]],
['data' => ['message' => $this->l10n->t('The selected file is not an image.')]],
Http::STATUS_BAD_REQUEST
);
}
@ -193,7 +173,7 @@ class AvatarController extends Controller {
$content = $node->getContent();
} catch (\OCP\Files\NotPermittedException $e) {
return new JSONResponse(
['data' => ['message' => $this->l->t('The selected file cannot be read.')]],
['data' => ['message' => $this->l10n->t('The selected file cannot be read.')]],
Http::STATUS_BAD_REQUEST
);
}
@ -205,7 +185,7 @@ class AvatarController extends Controller {
) {
if ($files['size'][0] > 20 * 1024 * 1024) {
return new JSONResponse(
['data' => ['message' => $this->l->t('File is too big')]],
['data' => ['message' => $this->l10n->t('File is too big')]],
Http::STATUS_BAD_REQUEST
);
}
@ -214,16 +194,16 @@ class AvatarController extends Controller {
unlink($files['tmp_name'][0]);
} else {
$phpFileUploadErrors = [
UPLOAD_ERR_OK => $this->l->t('The file was uploaded'),
UPLOAD_ERR_INI_SIZE => $this->l->t('The uploaded file exceeds the upload_max_filesize directive in php.ini'),
UPLOAD_ERR_FORM_SIZE => $this->l->t('The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form'),
UPLOAD_ERR_PARTIAL => $this->l->t('The file was only partially uploaded'),
UPLOAD_ERR_NO_FILE => $this->l->t('No file was uploaded'),
UPLOAD_ERR_NO_TMP_DIR => $this->l->t('Missing a temporary folder'),
UPLOAD_ERR_CANT_WRITE => $this->l->t('Could not write file to disk'),
UPLOAD_ERR_EXTENSION => $this->l->t('A PHP extension stopped the file upload'),
UPLOAD_ERR_OK => $this->l10n->t('The file was uploaded'),
UPLOAD_ERR_INI_SIZE => $this->l10n->t('The uploaded file exceeds the upload_max_filesize directive in php.ini'),
UPLOAD_ERR_FORM_SIZE => $this->l10n->t('The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form'),
UPLOAD_ERR_PARTIAL => $this->l10n->t('The file was only partially uploaded'),
UPLOAD_ERR_NO_FILE => $this->l10n->t('No file was uploaded'),
UPLOAD_ERR_NO_TMP_DIR => $this->l10n->t('Missing a temporary folder'),
UPLOAD_ERR_CANT_WRITE => $this->l10n->t('Could not write file to disk'),
UPLOAD_ERR_EXTENSION => $this->l10n->t('A PHP extension stopped the file upload'),
];
$message = $phpFileUploadErrors[$files['error'][0]] ?? $this->l->t('Invalid file provided');
$message = $phpFileUploadErrors[$files['error'][0]] ?? $this->l10n->t('Invalid file provided');
$this->logger->warning($message, ['app' => 'core']);
return new JSONResponse(
['data' => ['message' => $message]],
@ -233,7 +213,7 @@ class AvatarController extends Controller {
} else {
//Add imgfile
return new JSONResponse(
['data' => ['message' => $this->l->t('No image or file provided')]],
['data' => ['message' => $this->l10n->t('No image or file provided')]],
Http::STATUS_BAD_REQUEST
);
}
@ -248,7 +228,7 @@ class AvatarController extends Controller {
$mimeType = $image->mimeType();
if ($mimeType !== 'image/jpeg' && $mimeType !== 'image/png') {
return new JSONResponse(
['data' => ['message' => $this->l->t('Unknown filetype')]],
['data' => ['message' => $this->l10n->t('Unknown filetype')]],
Http::STATUS_OK
);
}
@ -262,7 +242,7 @@ class AvatarController extends Controller {
return new JSONResponse(['status' => 'success']);
} catch (\Throwable $e) {
$this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'core']);
return new JSONResponse(['data' => ['message' => $this->l->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
return new JSONResponse(['data' => ['message' => $this->l10n->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
}
}
@ -273,13 +253,13 @@ class AvatarController extends Controller {
);
} else {
return new JSONResponse(
['data' => ['message' => $this->l->t('Invalid image')]],
['data' => ['message' => $this->l10n->t('Invalid image')]],
Http::STATUS_OK
);
}
} catch (\Exception $e) {
$this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'core']);
return new JSONResponse(['data' => ['message' => $this->l->t('An error occurred. Please contact your admin.')]], Http::STATUS_OK);
return new JSONResponse(['data' => ['message' => $this->l10n->t('An error occurred. Please contact your admin.')]], Http::STATUS_OK);
}
}
@ -293,7 +273,7 @@ class AvatarController extends Controller {
return new JSONResponse();
} catch (\Exception $e) {
$this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'core']);
return new JSONResponse(['data' => ['message' => $this->l->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
return new JSONResponse(['data' => ['message' => $this->l10n->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
}
}
@ -306,7 +286,7 @@ class AvatarController extends Controller {
$tmpAvatar = $this->cache->get('tmpAvatar');
if (is_null($tmpAvatar)) {
return new JSONResponse(['data' => [
'message' => $this->l->t("No temporary profile picture available, try again")
'message' => $this->l10n->t("No temporary profile picture available, try again")
]],
Http::STATUS_NOT_FOUND);
}
@ -330,19 +310,19 @@ class AvatarController extends Controller {
*/
public function postCroppedAvatar(?array $crop = null): JSONResponse {
if (is_null($crop)) {
return new JSONResponse(['data' => ['message' => $this->l->t("No crop data provided")]],
return new JSONResponse(['data' => ['message' => $this->l10n->t("No crop data provided")]],
Http::STATUS_BAD_REQUEST);
}
if (!isset($crop['x'], $crop['y'], $crop['w'], $crop['h'])) {
return new JSONResponse(['data' => ['message' => $this->l->t("No valid crop data provided")]],
return new JSONResponse(['data' => ['message' => $this->l10n->t("No valid crop data provided")]],
Http::STATUS_BAD_REQUEST);
}
$tmpAvatar = $this->cache->get('tmpAvatar');
if (is_null($tmpAvatar)) {
return new JSONResponse(['data' => [
'message' => $this->l->t("No temporary profile picture available, try again")
'message' => $this->l10n->t("No temporary profile picture available, try again")
]],
Http::STATUS_BAD_REQUEST);
}
@ -357,11 +337,11 @@ class AvatarController extends Controller {
$this->cache->remove('tmpAvatar');
return new JSONResponse(['status' => 'success']);
} catch (\OC\NotSquareException $e) {
return new JSONResponse(['data' => ['message' => $this->l->t('Crop is not square')]],
return new JSONResponse(['data' => ['message' => $this->l10n->t('Crop is not square')]],
Http::STATUS_BAD_REQUEST);
} catch (\Exception $e) {
$this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'core']);
return new JSONResponse(['data' => ['message' => $this->l->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
return new JSONResponse(['data' => ['message' => $this->l10n->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
}
}
}

8
core/Controller/CSRFTokenController.php
Unescape View File

@ -33,12 +33,10 @@ use OCP\AppFramework\Http\JSONResponse;
use OCP\IRequest;
class CSRFTokenController extends Controller {
private CsrfTokenManager $tokenManager;
public function __construct(string $appName, IRequest $request,
CsrfTokenManager $tokenManager) {
public function __construct(string $appName,
IRequest $request,
private CsrfTokenManager $tokenManager) {
parent::__construct($appName, $request);
$this->tokenManager = $tokenManager;
}
/**

45
core/Controller/ClientFlowLoginController.php
Unescape View File

@ -57,45 +57,22 @@ use OCP\Security\ISecureRandom;
use OCP\Session\Exceptions\SessionNotAvailableException;
class ClientFlowLoginController extends Controller {
private IUserSession $userSession;
private IL10N $l10n;
private Defaults $defaults;
private ISession $session;
private IProvider $tokenProvider;
private ISecureRandom $random;
private IURLGenerator $urlGenerator;
private ClientMapper $clientMapper;
private AccessTokenMapper $accessTokenMapper;
private ICrypto $crypto;
private IEventDispatcher $eventDispatcher;
public const STATE_NAME = 'client.flow.state.token';
public function __construct(string $appName,
IRequest $request,
IUserSession $userSession,
IL10N $l10n,
Defaults $defaults,
ISession $session,
IProvider $tokenProvider,
ISecureRandom $random,
IURLGenerator $urlGenerator,
ClientMapper $clientMapper,
AccessTokenMapper $accessTokenMapper,
ICrypto $crypto,
IEventDispatcher $eventDispatcher) {
private IUserSession $userSession,
private IL10N $l10n,
private Defaults $defaults,
private ISession $session,
private IProvider $tokenProvider,
private ISecureRandom $random,
private IURLGenerator $urlGenerator,
private ClientMapper $clientMapper,
private AccessTokenMapper $accessTokenMapper,
private ICrypto $crypto,
private IEventDispatcher $eventDispatcher) {
parent::__construct($appName, $request);
$this->userSession = $userSession;
$this->l10n = $l10n;
$this->defaults = $defaults;
$this->session = $session;
$this->tokenProvider = $tokenProvider;
$this->random = $random;
$this->urlGenerator = $urlGenerator;
$this->clientMapper = $clientMapper;
$this->accessTokenMapper = $accessTokenMapper;
$this->crypto = $crypto;
$this->eventDispatcher = $eventDispatcher;
}
private function getClientName(): string {

33
core/Controller/ClientFlowLoginV2Controller.php
Unescape View File

@ -51,34 +51,17 @@ class ClientFlowLoginV2Controller extends Controller {
public const TOKEN_NAME = 'client.flow.v2.login.token';
public const STATE_NAME = 'client.flow.v2.state.token';
private LoginFlowV2Service $loginFlowV2Service;
private IURLGenerator $urlGenerator;
private IUserSession $userSession;
private ISession $session;
private ISecureRandom $random;
private Defaults $defaults;
private ?string $userId;
private IL10N $l10n;
public function __construct(string $appName,
IRequest $request,
LoginFlowV2Service $loginFlowV2Service,
IURLGenerator $urlGenerator,
ISession $session,
IUserSession $userSession,
ISecureRandom $random,
Defaults $defaults,
?string $userId,
IL10N $l10n) {
private LoginFlowV2Service $loginFlowV2Service,
private IURLGenerator $urlGenerator,
private ISession $session,
private IUserSession $userSession,
private ISecureRandom $random,
private Defaults $defaults,
private ?string $userId,
private IL10N $l10n) {
parent::__construct($appName, $request);
$this->loginFlowV2Service = $loginFlowV2Service;
$this->urlGenerator = $urlGenerator;
$this->session = $session;
$this->userSession = $userSession;
$this->random = $random;
$this->defaults = $defaults;
$this->userId = $userId;
$this->l10n = $l10n;
}
/**

21
core/Controller/CollaborationResourcesController.php
Unescape View File

@ -25,6 +25,7 @@ declare(strict_types=1);
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Core\Controller;
use Exception;
@ -41,22 +42,12 @@ use OCP\IUserSession;
use Psr\Log\LoggerInterface;
class CollaborationResourcesController extends OCSController {
private IManager $manager;
private IUserSession $userSession;
private LoggerInterface $logger;
public function __construct(
string $appName,
IRequest $request,
IManager $manager,
IUserSession $userSession,
LoggerInterface $logger
) {
public function __construct(string $appName,
IRequest $request,
private IManager $manager,
private IUserSession $userSession,
private LoggerInterface $logger) {
parent::__construct($appName, $request);
$this->manager = $manager;
$this->userSession = $userSession;
$this->logger = $logger;
}
/**

9
core/Controller/ContactsMenuController.php
Unescape View File

@ -33,13 +33,10 @@ use OCP\IRequest;
use OCP\IUserSession;
class ContactsMenuController extends Controller {
private Manager $manager;
private IUserSession $userSession;
public function __construct(IRequest $request, IUserSession $userSession, Manager $manager) {
public function __construct(IRequest $request,
private IUserSession $userSession,
private Manager $manager) {
parent::__construct('core', $request);
$this->userSession = $userSession;
$this->manager = $manager;
}
/**

4
core/Controller/CssController.php
Unescape View File

@ -45,16 +45,14 @@ use OCP\IRequest;
class CssController extends Controller {
protected IAppData $appData;
protected ITimeFactory $timeFactory;
public function __construct(string $appName,
IRequest $request,
Factory $appDataFactory,
ITimeFactory $timeFactory) {
protected ITimeFactory $timeFactory) {
parent::__construct($appName, $request);
$this->appData = $appDataFactory->get('css');
$this->timeFactory = $timeFactory;
}
/**

15
core/Controller/GuestAvatarController.php
Unescape View File

@ -33,21 +33,14 @@ use Psr\Log\LoggerInterface;
* This controller handles guest avatar requests.
*/
class GuestAvatarController extends Controller {
private LoggerInterface $logger;
private IAvatarManager $avatarManager;
/**
* GuestAvatarController constructor.
*/
public function __construct(
string $appName,
IRequest $request,
IAvatarManager $avatarManager,
LoggerInterface $logger
) {
public function __construct(string $appName,
IRequest $request,
private IAvatarManager $avatarManager,
private LoggerInterface $logger) {
parent::__construct($appName, $request);
$this->avatarManager = $avatarManager;
$this->logger = $logger;
}
/**

9
core/Controller/HoverCardController.php
Unescape View File

@ -33,13 +33,10 @@ use OCP\IUserSession;
use OCP\Share\IShare;
class HoverCardController extends \OCP\AppFramework\OCSController {
private Manager $manager;
private IUserSession $userSession;
public function __construct(IRequest $request, IUserSession $userSession, Manager $manager) {
public function __construct(IRequest $request,
private IUserSession $userSession,
private Manager $manager) {
parent::__construct('core', $request);
$this->userSession = $userSession;
$this->manager = $manager;
}
/**

Write Preview
Loading…
Cancel
Save