Mirrors
/
nextcloud-server
mirror of https://github.com/nextcloud/server
3
0
Fork 0
Code Releases Activity
Browse Source

refactor: migrate from OC to OCP in public interfaces 

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
pull/52846/head
Ferdinand Thiessen 7 months ago
parent
b6515f9402
commit
74bded74a3
No known key found for this signature in database GPG Key ID: 45FAE7268762B400
16 changed files with 34 additions and 117 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 60
      build/psalm-baseline-ocp.xml
  2. 24
      build/psalm-baseline.xml
  3. 5
      lib/public/AppFramework/ApiController.php
  4. 6
      lib/public/AppFramework/App.php
  5. 3
      lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php
  6. 7
      lib/public/AppFramework/Http/Response.php
  7. 2
      lib/public/Defaults.php
  8. 2
      lib/public/Diagnostics/IQueryLogger.php
  9. 4
      lib/public/Files.php
  10. 2
      lib/public/Files_FullTextSearch/Model/AFilesDocument.php
  11. 2
      lib/public/Mail/IMailer.php
  12. 2
      lib/public/Profiler/IProfile.php
  13. 4
      lib/public/Security/ICrypto.php
  14. 4
      lib/public/Security/IHasher.php
  15. 2
      lib/public/Security/ISecureRandom.php
  16. 22
      lib/public/Util.php

60
build/psalm-baseline-ocp.xml
View File

@ -1,68 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<files psalm-version="5.26.1@d747f6500b38ac4f7dfc5edbcae6e4b637d7add0">
<file src="lib/public/AppFramework/ApiController.php">
<NoInterfaceProperties>
<code><![CDATA[$this->request->server]]></code>
</NoInterfaceProperties>
</file>
<file src="lib/public/AppFramework/App.php">
<UndefinedClass>
<code><![CDATA[\OC]]></code>
</UndefinedClass>
</file>
<file src="lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php">
<UndefinedClass>
<code><![CDATA[\OC]]></code>
</UndefinedClass>
</file>
<file src="lib/public/AppFramework/Http/Response.php">
<UndefinedClass>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
</UndefinedClass>
</file>
<file src="lib/public/Defaults.php">
<UndefinedClass>
<code><![CDATA[\OC]]></code>
</UndefinedClass>
</file>
<file src="lib/public/Diagnostics/IQueryLogger.php">
<LessSpecificImplementedReturnType>
<code><![CDATA[mixed]]></code>
</LessSpecificImplementedReturnType>
</file>
<file src="lib/public/EventDispatcher/GenericEvent.php">
<MissingTemplateParam>
<code><![CDATA[ArrayAccess]]></code>
<code><![CDATA[IteratorAggregate]]></code>
</MissingTemplateParam>
</file>
<file src="lib/public/Files.php">
<UndefinedClass>
<code><![CDATA[\OC]]></code>
</UndefinedClass>
</file>
<file src="lib/public/L10N/ILanguageIterator.php">
<MissingTemplateParam>
<code><![CDATA[\Iterator]]></code>
</MissingTemplateParam>
</file>
<file src="lib/public/Util.php">
<UndefinedClass>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
<code><![CDATA[\OC]]></code>
</UndefinedClass>
</file>
</files>

24
build/psalm-baseline.xml
View File

@ -3780,9 +3780,6 @@
<InvalidArgument>
<code><![CDATA[microtime(true)]]></code>
</InvalidArgument>
<InvalidReturnType>
<code><![CDATA[stopQuery]]></code>
</InvalidReturnType>
</file>
<file src="lib/private/DirectEditing/Manager.php">
<InvalidReturnType>
@ -4679,11 +4676,6 @@
<code><![CDATA[\Test\Util\User\Dummy]]></code>
</UndefinedClass>
</file>
<file src="lib/public/AppFramework/ApiController.php">
<NoInterfaceProperties>
<code><![CDATA[$this->request->server]]></code>
</NoInterfaceProperties>
</file>
<file src="lib/public/AppFramework/Http/Response.php">
<LessSpecificReturnStatement>
<code><![CDATA[array_merge($mergeWith, $this->headers)]]></code>
@ -4700,22 +4692,6 @@
<code><![CDATA[array{0: int, 1: int, 2: int}]]></code>
</MoreSpecificReturnType>
</file>
<file src="lib/public/Diagnostics/IQueryLogger.php">
<LessSpecificImplementedReturnType>
<code><![CDATA[mixed]]></code>
</LessSpecificImplementedReturnType>
</file>
<file src="lib/public/EventDispatcher/GenericEvent.php">
<MissingTemplateParam>
<code><![CDATA[ArrayAccess]]></code>
<code><![CDATA[IteratorAggregate]]></code>
</MissingTemplateParam>
</file>
<file src="lib/public/L10N/ILanguageIterator.php">
<MissingTemplateParam>
<code><![CDATA[\Iterator]]></code>
</MissingTemplateParam>
</file>
<file src="lib/public/Preview/BeforePreviewFetchedEvent.php">
<LessSpecificReturnStatement>
<code><![CDATA[$this->mode]]></code>

5
lib/public/AppFramework/ApiController.php
View File

@ -58,9 +58,8 @@ abstract class ApiController extends Controller {
#[PublicPage]
#[NoAdminRequired]
public function preflightedCors() {
if (isset($this->request->server['HTTP_ORIGIN'])) {
$origin = $this->request->server['HTTP_ORIGIN'];
} else {
$origin = $this->request->getHeader('origin');
if ($origin === '') {
$origin = '*';
}

6
lib/public/AppFramework/App.php
View File

@ -10,6 +10,8 @@ declare(strict_types=1);
namespace OCP\AppFramework;
use OC\ServerContainer;
use OCP\IConfig;
use OCP\Server;
use Psr\Log\LoggerInterface;
/**
@ -44,7 +46,7 @@ class App {
* @since 6.0.0
*/
public function __construct(string $appName, array $urlParams = []) {
$runIsSetupDirectly = \OC::$server->getConfig()->getSystemValueBool('debug')
$runIsSetupDirectly = Server::get(IConfig::class)->getSystemValueBool('debug')
&& !ini_get('zend.exception_ignore_args');
if ($runIsSetupDirectly) {
@ -71,7 +73,7 @@ class App {
}
if (!$setUpViaQuery && $applicationClassName !== \OCP\AppFramework\App::class) {
\OCP\Server::get(LoggerInterface::class)->error($e->getMessage(), [
Server::get(LoggerInterface::class)->error($e->getMessage(), [
'app' => $appName,
'exception' => $e,
]);

3
lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php
View File

@ -30,8 +30,7 @@ class RedirectToDefaultAppResponse extends RedirectResponse {
* @deprecated 23.0.0 Use RedirectResponse() with IURLGenerator::linkToDefaultPageUrl() instead
*/
public function __construct(int $status = Http::STATUS_SEE_OTHER, array $headers = []) {
/** @var IURLGenerator $urlGenerator */
$urlGenerator = \OC::$server->get(IURLGenerator::class);
$urlGenerator = \OCP\Server::get(IURLGenerator::class);
parent::__construct($urlGenerator->linkToDefaultPageUrl(), $status, $headers);
}
}

7
lib/public/AppFramework/Http/Response.php
View File

@ -93,7 +93,6 @@ class Response {
// Set expires header
$expires = new \DateTime();
/** @var ITimeFactory $time */
$time = \OCP\Server::get(ITimeFactory::class);
$expires->setTimestamp($time->getTime());
$expires->add(new \DateInterval('PT' . $cacheSeconds . 'S'));
@ -184,10 +183,10 @@ class Response {
if ($this->status === Http::STATUS_NOT_MODIFIED
&& stripos($name, 'x-') === 0) {
/** @var IConfig $config */
$config = \OC::$server->get(IConfig::class);
$config = \OCP\Server::get(IConfig::class);
if ($config->getSystemValueBool('debug', false)) {
\OC::$server->get(LoggerInterface::class)->error('Setting custom header on a 304 is not supported (Header: {header})', [
\OCP\Server::get(LoggerInterface::class)->error('Setting custom header on a 304 is not supported (Header: {header})', [
'header' => $name,
]);
}
@ -229,7 +228,7 @@ class Response {
/**
* @psalm-suppress UndefinedClass
*/
$request = \OC::$server->get(IRequest::class);
$request = \OCP\Server::get(IRequest::class);
$mergeWith = [
'X-Request-Id' => $request->getId(),
'Cache-Control' => 'no-cache, no-store, must-revalidate',

2
lib/public/Defaults.php
View File

@ -29,7 +29,7 @@ class Defaults {
*/
public function __construct(?\OC_Defaults $defaults = null) {
if ($defaults === null) {
$defaults = \OC::$server->get('ThemingDefaults');
$defaults = \OCP\Server::get('ThemingDefaults');
}
$this->defaults = $defaults;
}

2
lib/public/Diagnostics/IQueryLogger.php
View File

@ -31,7 +31,7 @@ interface IQueryLogger extends SQLLogger {
* Mark the end of the current active query. Ending query should store \OCP\Diagnostics\IQuery to
* be returned with getQueries() method.
*
* @return mixed
* @return void
* @since 8.0.0
*/
public function stopQuery();

4
lib/public/Files.php
View File

@ -9,6 +9,8 @@
namespace OCP;
use OCP\Files\IMimeTypeDetector;
/**
* This class provides access to the internal filesystem abstraction layer. Use
* this class exclusively if you want to access files
@ -67,7 +69,7 @@ class Files {
* @deprecated 14.0.0
*/
public static function getMimeType($path) {
return \OC::$server->getMimeTypeDetector()->detect($path);
return Server::get(IMimeTypeDetector::class)->detect($path);
}
/**

2
lib/public/Files_FullTextSearch/Model/AFilesDocument.php
View File

@ -16,7 +16,7 @@ use OCP\FullTextSearch\Model\IIndexDocument;
* This is mostly used by 3rd party apps that want to complete the IIndexDocument
* with more information about a file before its index:
*
* \OC::$server->getEventDispatcher()->addListener(
* \OCP\Server::get(IEventDispatcher::class)->addListener(
* '\OCA\Files_FullTextSearch::onFileIndexing',
* function(GenericEvent $e) {
* //@var \OCP\Files\Node $file

2
lib/public/Mail/IMailer.php
View File

@ -14,7 +14,7 @@ namespace OCP\Mail;
*
* Example usage:
*
* $mailer = \OC::$server->get(\OCP\Mail\IMailer::class);
* $mailer = \OCP\Server::get(\OCP\Mail\IMailer::class);
* $message = $mailer->createMessage();
* $message->setSubject('Your Subject');
* $message->setFrom(['cloud@domain.org' => 'Nextcloud Notifier']);

2
lib/public/Profiler/IProfile.php
View File

@ -17,7 +17,7 @@ use OCP\DataCollector\IDataCollector;
*
* ```php
* <?php
* $profiler = \OC::$server->get(IProfiler::class);
* $profiler = \OCP\Server::get(IProfiler::class);
* $profiles = $profiler->find('/settings/users', 10);
* ```
*

4
lib/public/Security/ICrypto.php
View File

@ -13,8 +13,8 @@ namespace OCP\Security;
* it will use the secret defined in config.php as key. Additionally the message will be HMAC'd.
*
* Usage:
* $encryptWithDefaultPassword = \OC::$server->getCrypto()->encrypt('EncryptedText');
* $encryptWithCustomPassword = \OC::$server->getCrypto()->encrypt('EncryptedText', 'password');
* $encryptWithDefaultPassword = \OCP\Server::get(ICrypto::class)->encrypt('EncryptedText');
* $encryptWithCustomPassword = \OCP\Server::get(ICrypto::class)->encrypt('EncryptedText', 'password');
*
* @since 8.0.0
*/

4
lib/public/Security/IHasher.php
View File

@ -19,10 +19,10 @@ namespace OCP\Security;
*
* Usage:
* // Hashing a message
* $hash = \OC::$server->get(\OCP\Security\IHasher::class)->hash('MessageToHash');
* $hash = \OCP\Server::get(\OCP\Security\IHasher::class)->hash('MessageToHash');
* // Verifying a message - $newHash will contain the newly calculated hash
* $newHash = null;
* var_dump(\OC::$server->get(\OCP\Security\IHasher::class)->verify('a', '86f7e437faa5a7fce15d1ddcb9eaeaea377667b8', $newHash));
* var_dump(\OCP\Server::get(\OCP\Security\IHasher::class)->verify('a', '86f7e437faa5a7fce15d1ddcb9eaeaea377667b8', $newHash));
* var_dump($newHash);
*
* @since 8.0.0

2
lib/public/Security/ISecureRandom.php
View File

@ -14,7 +14,7 @@ namespace OCP\Security;
* use a fallback.
*
* Usage:
* \OC::$server->get(ISecureRandom::class)->generate(10);
* \OCP\Server::get(ISecureRandom::class)->generate(10);
*
* @since 8.0.0
*/

22
lib/public/Util.php
View File

@ -51,7 +51,7 @@ class Util {
return $subscriptionRegistry->delegateHasExtendedSupport();
} catch (ContainerExceptionInterface $e) {
}
return \OC::$server->getConfig()->getSystemValueBool('extendedSupport', false);
return \OCP\Server::get(IConfig::class)->getSystemValueBool('extendedSupport', false);
}
/**
@ -60,7 +60,7 @@ class Util {
* @since 8.1.0
*/
public static function setChannel($channel) {
\OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
\OCP\Server::get(IConfig::class)->setSystemValue('updater.release.channel', $channel);
}
/**
@ -182,7 +182,7 @@ class Util {
*/
public static function getScripts(): array {
// Sort scriptDeps into sortedScriptDeps
$scriptSort = \OC::$server->get(AppScriptSort::class);
$scriptSort = \OCP\Server::get(AppScriptSort::class);
$sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
// Flatten array and remove duplicates
@ -209,7 +209,7 @@ class Util {
*/
public static function addTranslations($application, $languageCode = null, $init = false) {
if (is_null($languageCode)) {
$languageCode = \OC::$server->get(IFactory::class)->findLanguage($application);
$languageCode = \OCP\Server::get(IFactory::class)->findLanguage($application);
}
if (!empty($application)) {
$path = "$application/l10n/$languageCode";
@ -247,7 +247,7 @@ class Util {
* @since 4.0.0 - parameter $args was added in 4.5.0
*/
public static function linkToAbsolute($app, $file, $args = []) {
$urlGenerator = \OC::$server->getURLGenerator();
$urlGenerator = \OCP\Server::get(IURLGenerator::class);
return $urlGenerator->getAbsoluteURL(
$urlGenerator->linkTo($app, $file, $args)
);
@ -260,7 +260,7 @@ class Util {
* @since 4.0.0
*/
public static function linkToRemote($service) {
$urlGenerator = \OC::$server->getURLGenerator();
$urlGenerator = \OCP\Server::get(IURLGenerator::class);
$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
return $urlGenerator->getAbsoluteURL(
$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
@ -273,7 +273,7 @@ class Util {
* @since 5.0.0
*/
public static function getServerHostName() {
$host_name = \OC::$server->getRequest()->getServerHost();
$host_name = \OCP\Server::get(IRequest::class)->getServerHost();
// strip away port number (if existing)
$colon_pos = strpos($host_name, ':');
if ($colon_pos != false) {
@ -299,13 +299,13 @@ class Util {
* @since 5.0.0
*/
public static function getDefaultEmailAddress(string $user_part): string {
$config = \OC::$server->getConfig();
$config = \OCP\Server::get(IConfig::class);
$user_part = $config->getSystemValueString('mail_from_address', $user_part);
$host_name = self::getServerHostName();
$host_name = $config->getSystemValueString('mail_domain', $host_name);
$defaultEmailAddress = $user_part . '@' . $host_name;
$mailer = \OC::$server->get(IMailer::class);
$mailer = \OCP\Server::get(IMailer::class);
if ($mailer->validateMailAddress($defaultEmailAddress)) {
return $defaultEmailAddress;
}
@ -447,7 +447,7 @@ class Util {
*/
public static function callRegister() {
if (self::$token === '') {
self::$token = \OC::$server->get(CsrfTokenManager::class)->getToken()->getEncryptedValue();
self::$token = \OCP\Server::get(CsrfTokenManager::class)->getToken()->getEncryptedValue();
}
return self::$token;
}
@ -582,7 +582,7 @@ class Util {
*/
public static function needUpgrade() {
if (!isset(self::$needUpgradeCache)) {
self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
self::$needUpgradeCache = \OC_Util::needUpgrade(\OCP\Server::get(\OC\SystemConfig::class));
}
return self::$needUpgradeCache;
}

Write Preview
Loading…
Cancel
Save