Skip to content

chore(legacy): Remove deprecated OC_Util::addScript and functions depending on it #51836

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
come-nc merged 1 commit into from
Apr 3, 2025
Merged

chore(legacy): Remove deprecated OC_Util::addScript and functions depending on it #51836

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
18 changes: 1 addition & 17 deletions lib/private/Template/functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,22 +122,6 @@ function script($app, $file = null): void {
}
}

/**
* Shortcut for adding vendor scripts to a page
* @param string $app the appname
* @param string|string[] $file the filename,
* if an array is given it will add all scripts
*/
function vendor_script($app, $file = null): void {
if (is_array($file)) {
foreach ($file as $f) {
OC_Util::addVendorScript($app, $f);
}
} else {
OC_Util::addVendorScript($app, $file);
}
}

/**
* Shortcut for adding styles to a page
* @param string $app the appname
Expand Down Expand Up @@ -176,7 +160,7 @@ function vendor_style($app, $file = null): void {
* if an array is given it will add all styles
*/
function translation($app): void {
OC_Util::addTranslations($app);
Util::addTranslations($app);
}

/**
Expand Down
3 changes: 1 addition & 2 deletions lib/private/TemplateLayout.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,7 @@ public function getPageTemplate(string $renderAs, string $appId): ITemplate {
}

// Add the js files
// TODO: remove deprecated OC_Util injection
$jsFiles = self::findJavascriptFiles(array_merge(\OC_Util::$scripts, Util::getScripts()));
$jsFiles = self::findJavascriptFiles(Util::getScripts());
$page->assign('jsfiles', []);
if ($this->config->getSystemValueBool('installed', false) && $renderAs != TemplateResponse::RENDER_AS_ERROR) {
// this is on purpose outside of the if statement below so that the initial state is prefilled (done in the getConfig() call)
Expand Down
63 changes: 0 additions & 63 deletions lib/private/legacy/OC_Util.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
use Psr\Log\LoggerInterface;

class OC_Util {
public static $scripts = [];
public static $styles = [];
public static $headers = [];

Expand Down Expand Up @@ -235,60 +234,6 @@ private static function generatePath($application, $directory, $file) {
}
}

/**
* add a javascript file
*
* @deprecated 24.0.0 - Use \OCP\Util::addScript
*
* @param string $application application id
* @param string|null $file filename
* @param bool $prepend prepend the Script to the beginning of the list
* @return void
*/
public static function addScript($application, $file = null, $prepend = false) {
$path = OC_Util::generatePath($application, 'js', $file);

// core js files need separate handling
if ($application !== 'core' && $file !== null) {
self::addTranslations($application);
}
self::addExternalResource($application, $prepend, $path, 'script');
}

/**
* add a javascript file from the vendor sub folder
*
* @param string $application application id
* @param string|null $file filename
* @param bool $prepend prepend the Script to the beginning of the list
* @return void
*/
public static function addVendorScript($application, $file = null, $prepend = false) {
$path = OC_Util::generatePath($application, 'vendor', $file);
self::addExternalResource($application, $prepend, $path, 'script');
}

/**
* add a translation JS file
*
* @deprecated 24.0.0
*
* @param string $application application id
* @param string|null $languageCode language code, defaults to the current language
* @param bool|null $prepend prepend the Script to the beginning of the list
*/
public static function addTranslations($application, $languageCode = null, $prepend = false) {
if (is_null($languageCode)) {
$languageCode = \OC::$server->get(IFactory::class)->findLanguage($application);
}
if (!empty($application)) {
$path = "$application/l10n/$languageCode";
} else {
$path = "l10n/$languageCode";
}
self::addExternalResource($application, $prepend, $path, 'script');
}

/**
* add a css file
*
Expand Down Expand Up @@ -333,14 +278,6 @@ private static function addExternalResource($application, $prepend, $path, $type
self::$styles[] = $path;
}
}
} elseif ($type === 'script') {
if (!in_array($path, self::$scripts)) {
if ($prepend === true) {
array_unshift(self::$scripts, $path);
} else {
self::$scripts [] = $path;
}
}
}
}

Expand Down
96 changes: 39 additions & 57 deletions tests/lib/UtilTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
namespace Test;

use OC_Util;
use OCP\Util;

/**
* Class UtilTest
Expand All @@ -17,7 +18,7 @@
*/
class UtilTest extends \Test\TestCase {
public function testGetVersion(): void {
$version = \OCP\Util::getVersion();
$version = Util::getVersion();
$this->assertTrue(is_array($version));
foreach ($version as $num) {
$this->assertTrue(is_int($num));
Expand Down Expand Up @@ -86,7 +87,7 @@ public function testFileInfoLoaded(): void {
* So we check that with strict email verification we fallback to the default
*/
public function testGetDefaultEmailAddressStrict(): void {
$email = \OCP\Util::getDefaultEmailAddress('no-reply');
$email = Util::getDefaultEmailAddress('no-reply');
$this->assertEquals('no-reply@localhost.localdomain', $email);
}

Expand All @@ -96,15 +97,15 @@ public function testGetDefaultEmailAddressStrict(): void {
public function testGetDefaultEmailAddress(): void {
$config = \OC::$server->getConfig();
$config->setAppValue('core', 'enforce_strict_email_check', 'no');
$email = \OCP\Util::getDefaultEmailAddress('no-reply');
$email = Util::getDefaultEmailAddress('no-reply');
$this->assertEquals('no-reply@localhost', $email);
$config->deleteAppValue('core', 'enforce_strict_email_check');
}

public function testGetDefaultEmailAddressFromConfig(): void {
$config = \OC::$server->getConfig();
$config->setSystemValue('mail_domain', 'example.com');
$email = \OCP\Util::getDefaultEmailAddress('no-reply');
$email = Util::getDefaultEmailAddress('no-reply');
$this->assertEquals('no-reply@example.com', $email);
$config->deleteSystemValue('mail_domain');
}
Expand All @@ -113,7 +114,7 @@ public function testGetConfiguredEmailAddressFromConfig(): void {
$config = \OC::$server->getConfig();
$config->setSystemValue('mail_domain', 'example.com');
$config->setSystemValue('mail_from_address', 'owncloud');
$email = \OCP\Util::getDefaultEmailAddress('no-reply');
$email = Util::getDefaultEmailAddress('no-reply');
$this->assertEquals('owncloud@example.com', $email);
$config->deleteSystemValue('mail_domain');
$config->deleteSystemValue('mail_from_address');
Expand All @@ -135,19 +136,19 @@ public function testNeedUpgradeCore(): void {
$oldConfigVersion = $config->getSystemValue('version', '0.0.0');
$oldSessionVersion = \OC::$server->getSession()->get('OC_Version');

$this->assertFalse(\OCP\Util::needUpgrade());
$this->assertFalse(Util::needUpgrade());

$config->setSystemValue('version', '7.0.0.0');
\OC::$server->getSession()->set('OC_Version', [7, 0, 0, 1]);
self::invokePrivate(new \OCP\Util, 'needUpgradeCache', [null]);
self::invokePrivate(new Util, 'needUpgradeCache', [null]);

$this->assertTrue(\OCP\Util::needUpgrade());
$this->assertTrue(Util::needUpgrade());

$config->setSystemValue('version', $oldConfigVersion);
\OC::$server->getSession()->set('OC_Version', $oldSessionVersion);
self::invokePrivate(new \OCP\Util, 'needUpgradeCache', [null]);
self::invokePrivate(new Util, 'needUpgradeCache', [null]);

$this->assertFalse(\OCP\Util::needUpgrade());
$this->assertFalse(Util::needUpgrade());
}

public function testCheckDataDirectoryValidity(): void {
Expand All @@ -170,39 +171,37 @@ public function testCheckDataDirectoryValidity(): void {
protected function setUp(): void {
parent::setUp();

\OC_Util::$scripts = [];
\OC_Util::$styles = [];
self::invokePrivate(\OCP\Util::class, 'scripts', [[]]);
self::invokePrivate(\OCP\Util::class, 'scriptDeps', [[]]);
self::invokePrivate(Util::class, 'scripts', [[]]);
self::invokePrivate(Util::class, 'scriptDeps', [[]]);
}
protected function tearDown(): void {
parent::tearDown();

\OC_Util::$scripts = [];
\OC_Util::$styles = [];
self::invokePrivate(\OCP\Util::class, 'scripts', [[]]);
self::invokePrivate(\OCP\Util::class, 'scriptDeps', [[]]);
self::invokePrivate(Util::class, 'scripts', [[]]);
self::invokePrivate(Util::class, 'scriptDeps', [[]]);
}

public function testAddScript(): void {
\OCP\Util::addScript('first', 'myFirstJSFile');
\OCP\Util::addScript('core', 'myFancyJSFile1');
\OCP\Util::addScript('files', 'myFancyJSFile2', 'core');
\OCP\Util::addScript('myApp5', 'myApp5JSFile', 'myApp2');
\OCP\Util::addScript('myApp', 'myFancyJSFile3');
\OCP\Util::addScript('core', 'myFancyJSFile4');
Util::addScript('first', 'myFirstJSFile');
Util::addScript('core', 'myFancyJSFile1');
Util::addScript('files', 'myFancyJSFile2', 'core');
Util::addScript('myApp5', 'myApp5JSFile', 'myApp2');
Util::addScript('myApp', 'myFancyJSFile3');
Util::addScript('core', 'myFancyJSFile4');
// after itself
\OCP\Util::addScript('core', 'myFancyJSFile5', 'core');
Util::addScript('core', 'myFancyJSFile5', 'core');
// add duplicate
\OCP\Util::addScript('core', 'myFancyJSFile1');
Util::addScript('core', 'myFancyJSFile1');
// dependency chain
\OCP\Util::addScript('myApp4', 'myApp4JSFile', 'myApp3');
\OCP\Util::addScript('myApp3', 'myApp3JSFile', 'myApp2');
\OCP\Util::addScript('myApp2', 'myApp2JSFile', 'myApp');
\OCP\Util::addScript('core', 'common');
\OCP\Util::addScript('core', 'main');
Util::addScript('myApp4', 'myApp4JSFile', 'myApp3');
Util::addScript('myApp3', 'myApp3JSFile', 'myApp2');
Util::addScript('myApp2', 'myApp2JSFile', 'myApp');
Util::addScript('core', 'common');
Util::addScript('core', 'main');

$scripts = \OCP\Util::getScripts();
$scripts = Util::getScripts();

// Core should appear first
$this->assertEquals(
Expand Down Expand Up @@ -278,37 +277,20 @@ public function testAddScript(): void {
}

public function testAddScriptCircularDependency(): void {
\OCP\Util::addScript('circular', 'file1', 'dependency');
\OCP\Util::addScript('dependency', 'file2', 'circular');
Util::addScript('circular', 'file1', 'dependency');
Util::addScript('dependency', 'file2', 'circular');

$scripts = \OCP\Util::getScripts();
$scripts = Util::getScripts();
$this->assertContains('circular/js/file1', $scripts);
$this->assertContains('dependency/js/file2', $scripts);
}

public function testAddVendorScript(): void {
\OC_Util::addVendorScript('core', 'myFancyJSFile1');
\OC_Util::addVendorScript('myApp', 'myFancyJSFile2');
\OC_Util::addVendorScript('core', 'myFancyJSFile0', true);
\OC_Util::addVendorScript('core', 'myFancyJSFile10', true);
// add duplicate
\OC_Util::addVendorScript('core', 'myFancyJSFile1');

$this->assertEquals([
'core/vendor/myFancyJSFile10',
'core/vendor/myFancyJSFile0',
'core/vendor/myFancyJSFile1',
'myApp/vendor/myFancyJSFile2',
], \OC_Util::$scripts);
$this->assertEquals([], \OC_Util::$styles);
}

public function testAddTranslations(): void {
\OC_Util::addTranslations('appId', 'de');
Util::addTranslations('appId', 'de');

$this->assertEquals([
'appId/l10n/de'
], \OC_Util::$scripts);
], Util::getScripts());
$this->assertEquals([], \OC_Util::$styles);
}

Expand All @@ -320,7 +302,7 @@ public function testAddStyle(): void {
// add duplicate
\OC_Util::addStyle('core', 'myFancyCSSFile1');

$this->assertEquals([], \OC_Util::$scripts);
$this->assertEquals([], Util::getScripts());
$this->assertEquals([
'core/css/myFancyCSSFile10',
'core/css/myFancyCSSFile0',
Expand All @@ -337,7 +319,7 @@ public function testAddVendorStyle(): void {
// add duplicate
\OC_Util::addVendorStyle('core', 'myFancyCSSFile1');

$this->assertEquals([], \OC_Util::$scripts);
$this->assertEquals([], Util::getScripts());
$this->assertEquals([
'core/vendor/myFancyCSSFile10',
'core/vendor/myFancyCSSFile0',
Expand All @@ -347,9 +329,9 @@ public function testAddVendorStyle(): void {
}

public function testShortenMultibyteString(): void {
$this->assertEquals('Short nuff', \OCP\Util::shortenMultibyteString('Short nuff', 255));
$this->assertEquals('ABC', \OCP\Util::shortenMultibyteString('ABCDEF', 3));
$this->assertEquals('Short nuff', Util::shortenMultibyteString('Short nuff', 255));
$this->assertEquals('ABC', Util::shortenMultibyteString('ABCDEF', 3));
// each of the characters is 12 bytes
$this->assertEquals('🙈', \OCP\Util::shortenMultibyteString('🙈🙊🙉', 16, 2));
$this->assertEquals('🙈', Util::shortenMultibyteString('🙈🙊🙉', 16, 2));
}
}
Loading