1
0

Util.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. * @author Bart Visscher <bartv@thisnet.nl>
  7. * @author Björn Schießle <bjoern@schiessle.org>
  8. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  9. * @author Frank Karlitschek <frank@karlitschek.de>
  10. * @author Georg Ehrke <oc.list@georgehrke.com>
  11. * @author Individual IT Services <info@individual-it.net>
  12. * @author J0WI <J0WI@users.noreply.github.com>
  13. * @author Jens-Christian Fischer <jens-christian.fischer@switch.ch>
  14. * @author Joas Schilling <coding@schilljs.com>
  15. * @author Jonas Meurer <jonas@freesources.org>
  16. * @author Julius Härtl <jus@bitgrid.net>
  17. * @author Lukas Reschke <lukas@statuscode.ch>
  18. * @author Michael Gapczynski <GapczynskiM@gmail.com>
  19. * @author Morris Jobke <hey@morrisjobke.de>
  20. * @author Pellaeon Lin <nfsmwlin@gmail.com>
  21. * @author Randolph Carter <RandolphCarter@fantasymail.de>
  22. * @author Robin Appelman <robin@icewind.nl>
  23. * @author Robin McCorkell <robin@mccorkell.me.uk>
  24. * @author Roeland Jago Douma <roeland@famdouma.nl>
  25. * @author Thomas Müller <thomas.mueller@tmit.eu>
  26. * @author Victor Dubiniuk <dubiniuk@owncloud.com>
  27. * @author Vincent Petry <vincent@nextcloud.com>
  28. *
  29. * @license AGPL-3.0
  30. *
  31. * This code is free software: you can redistribute it and/or modify
  32. * it under the terms of the GNU Affero General Public License, version 3,
  33. * as published by the Free Software Foundation.
  34. *
  35. * This program is distributed in the hope that it will be useful,
  36. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  37. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  38. * GNU Affero General Public License for more details.
  39. *
  40. * You should have received a copy of the GNU Affero General Public License, version 3,
  41. * along with this program. If not, see <http://www.gnu.org/licenses/>
  42. *
  43. */
  44. // use OCP namespace for all classes that are considered public.
  45. // This means that they should be used by apps instead of the internal ownCloud classes
  46. namespace OCP;
  47. use bantu\IniGetWrapper\IniGetWrapper;
  48. use OC\AppScriptDependency;
  49. use OC\AppScriptSort;
  50. use OCP\Share\IManager;
  51. use Psr\Container\ContainerExceptionInterface;
  52. /**
  53. * This class provides different helper functions to make the life of a developer easier
  54. *
  55. * @since 4.0.0
  56. */
  57. class Util {
  58. private static ?IManager $shareManager = null;
  59. private static array $scriptsInit = [];
  60. private static array $scripts = [];
  61. private static array $scriptDeps = [];
  62. /**
  63. * get the current installed version of Nextcloud
  64. * @return array
  65. * @since 4.0.0
  66. */
  67. public static function getVersion() {
  68. return \OC_Util::getVersion();
  69. }
  70. /**
  71. * @since 17.0.0
  72. */
  73. public static function hasExtendedSupport(): bool {
  74. try {
  75. /** @var \OCP\Support\Subscription\IRegistry */
  76. $subscriptionRegistry = \OCP\Server::get(\OCP\Support\Subscription\IRegistry::class);
  77. return $subscriptionRegistry->delegateHasExtendedSupport();
  78. } catch (ContainerExceptionInterface $e) {
  79. }
  80. return \OC::$server->getConfig()->getSystemValueBool('extendedSupport', false);
  81. }
  82. /**
  83. * Set current update channel
  84. * @param string $channel
  85. * @since 8.1.0
  86. */
  87. public static function setChannel($channel) {
  88. \OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
  89. }
  90. /**
  91. * Get current update channel
  92. * @return string
  93. * @since 8.1.0
  94. */
  95. public static function getChannel() {
  96. return \OC_Util::getChannel();
  97. }
  98. /**
  99. * check if sharing is disabled for the current user
  100. *
  101. * @return boolean
  102. * @since 7.0.0
  103. * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
  104. */
  105. public static function isSharingDisabledForUser() {
  106. if (self::$shareManager === null) {
  107. self::$shareManager = \OC::$server->getShareManager();
  108. }
  109. $user = \OC::$server->getUserSession()->getUser();
  110. if ($user !== null) {
  111. $user = $user->getUID();
  112. }
  113. return self::$shareManager->sharingDisabledForUser($user);
  114. }
  115. /**
  116. * get l10n object
  117. * @param string $application
  118. * @param string|null $language
  119. * @return \OCP\IL10N
  120. * @since 6.0.0 - parameter $language was added in 8.0.0
  121. */
  122. public static function getL10N($application, $language = null) {
  123. return \OC::$server->getL10N($application, $language);
  124. }
  125. /**
  126. * add a css file
  127. * @param string $application
  128. * @param string $file
  129. * @since 4.0.0
  130. */
  131. public static function addStyle($application, $file = null) {
  132. \OC_Util::addStyle($application, $file);
  133. }
  134. /**
  135. * Add a standalone init js file that is loaded for initialization
  136. *
  137. * Be careful loading scripts using this method as they are loaded early
  138. * and block the initial page rendering. They should not have dependencies
  139. * on any other scripts than core-common and core-main.
  140. *
  141. * @since 28.0.0
  142. */
  143. public static function addInitScript(string $application, string $file): void {
  144. if (!empty($application)) {
  145. $path = "$application/js/$file";
  146. } else {
  147. $path = "js/$file";
  148. }
  149. // We need to handle the translation BEFORE the init script
  150. // is loaded, as the init script might use translations
  151. if ($application !== 'core' && !str_contains($file, 'l10n')) {
  152. self::addTranslations($application, null, true);
  153. }
  154. self::$scriptsInit[] = $path;
  155. }
  156. /**
  157. * add a javascript file
  158. *
  159. * @param string $application
  160. * @param string|null $file
  161. * @param string $afterAppId
  162. * @param bool $prepend
  163. * @since 4.0.0
  164. */
  165. public static function addScript(string $application, string $file = null, string $afterAppId = 'core', bool $prepend = false): void {
  166. if (!empty($application)) {
  167. $path = "$application/js/$file";
  168. } else {
  169. $path = "js/$file";
  170. }
  171. // Inject js translations if we load a script for
  172. // a specific app that is not core, as those js files
  173. // need separate handling
  174. if ($application !== 'core'
  175. && $file !== null
  176. && !str_contains($file, 'l10n')) {
  177. self::addTranslations($application);
  178. }
  179. // store app in dependency list
  180. if (!array_key_exists($application, self::$scriptDeps)) {
  181. self::$scriptDeps[$application] = new AppScriptDependency($application, [$afterAppId]);
  182. } else {
  183. self::$scriptDeps[$application]->addDep($afterAppId);
  184. }
  185. if ($prepend) {
  186. array_unshift(self::$scripts[$application], $path);
  187. } else {
  188. self::$scripts[$application][] = $path;
  189. }
  190. }
  191. /**
  192. * Return the list of scripts injected to the page
  193. *
  194. * @return array
  195. * @since 24.0.0
  196. */
  197. public static function getScripts(): array {
  198. // Sort scriptDeps into sortedScriptDeps
  199. $scriptSort = \OC::$server->get(AppScriptSort::class);
  200. $sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
  201. // Flatten array and remove duplicates
  202. $sortedScripts = array_merge([self::$scriptsInit], $sortedScripts);
  203. $sortedScripts = array_merge(...array_values($sortedScripts));
  204. // Override core-common and core-main order
  205. if (in_array('core/js/main', $sortedScripts)) {
  206. array_unshift($sortedScripts, 'core/js/main');
  207. }
  208. if (in_array('core/js/common', $sortedScripts)) {
  209. array_unshift($sortedScripts, 'core/js/common');
  210. }
  211. return array_unique($sortedScripts);
  212. }
  213. /**
  214. * Add a translation JS file
  215. * @param string $application application id
  216. * @param string $languageCode language code, defaults to the current locale
  217. * @param bool $init whether the translations should be loaded early or not
  218. * @since 8.0.0
  219. */
  220. public static function addTranslations($application, $languageCode = null, $init = false) {
  221. if (is_null($languageCode)) {
  222. $languageCode = \OC::$server->getL10NFactory()->findLanguage($application);
  223. }
  224. if (!empty($application)) {
  225. $path = "$application/l10n/$languageCode";
  226. } else {
  227. $path = "l10n/$languageCode";
  228. }
  229. if ($init) {
  230. self::$scriptsInit[] = $path;
  231. } else {
  232. self::$scripts[$application][] = $path;
  233. }
  234. }
  235. /**
  236. * Add a custom element to the header
  237. * If $text is null then the element will be written as empty element.
  238. * So use "" to get a closing tag.
  239. * @param string $tag tag name of the element
  240. * @param array $attributes array of attributes for the element
  241. * @param string $text the text content for the element
  242. * @since 4.0.0
  243. */
  244. public static function addHeader($tag, $attributes, $text = null) {
  245. \OC_Util::addHeader($tag, $attributes, $text);
  246. }
  247. /**
  248. * Creates an absolute url to the given app and file.
  249. * @param string $app app
  250. * @param string $file file
  251. * @param array $args array with param=>value, will be appended to the returned url
  252. * The value of $args will be urlencoded
  253. * @return string the url
  254. * @since 4.0.0 - parameter $args was added in 4.5.0
  255. */
  256. public static function linkToAbsolute($app, $file, $args = []) {
  257. $urlGenerator = \OC::$server->getURLGenerator();
  258. return $urlGenerator->getAbsoluteURL(
  259. $urlGenerator->linkTo($app, $file, $args)
  260. );
  261. }
  262. /**
  263. * Creates an absolute url for remote use.
  264. * @param string $service id
  265. * @return string the url
  266. * @since 4.0.0
  267. */
  268. public static function linkToRemote($service) {
  269. $urlGenerator = \OC::$server->getURLGenerator();
  270. $remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
  271. return $urlGenerator->getAbsoluteURL(
  272. $remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
  273. );
  274. }
  275. /**
  276. * Returns the server host name without an eventual port number
  277. * @return string the server hostname
  278. * @since 5.0.0
  279. */
  280. public static function getServerHostName() {
  281. $host_name = \OC::$server->getRequest()->getServerHost();
  282. // strip away port number (if existing)
  283. $colon_pos = strpos($host_name, ':');
  284. if ($colon_pos != false) {
  285. $host_name = substr($host_name, 0, $colon_pos);
  286. }
  287. return $host_name;
  288. }
  289. /**
  290. * Returns the default email address
  291. * @param string $user_part the user part of the address
  292. * @return string the default email address
  293. *
  294. * Assembles a default email address (using the server hostname
  295. * and the given user part, and returns it
  296. * Example: when given lostpassword-noreply as $user_part param,
  297. * and is currently accessed via http(s)://example.com/,
  298. * it would return 'lostpassword-noreply@example.com'
  299. *
  300. * If the configuration value 'mail_from_address' is set in
  301. * config.php, this value will override the $user_part that
  302. * is passed to this function
  303. * @since 5.0.0
  304. */
  305. public static function getDefaultEmailAddress(string $user_part): string {
  306. $config = \OC::$server->getConfig();
  307. $user_part = $config->getSystemValueString('mail_from_address', $user_part);
  308. $host_name = self::getServerHostName();
  309. $host_name = $config->getSystemValueString('mail_domain', $host_name);
  310. $defaultEmailAddress = $user_part.'@'.$host_name;
  311. $mailer = \OC::$server->getMailer();
  312. if ($mailer->validateMailAddress($defaultEmailAddress)) {
  313. return $defaultEmailAddress;
  314. }
  315. // in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
  316. return $user_part.'@localhost.localdomain';
  317. }
  318. /**
  319. * Converts string to int of float depending if it fits an int
  320. * @param numeric-string|float|int $number numeric string
  321. * @return int|float int if it fits, float if it is too big
  322. * @since 26.0.0
  323. */
  324. public static function numericToNumber(string|float|int $number): int|float {
  325. /* This is a hack to cast to (int|float) */
  326. return 0 + (string)$number;
  327. }
  328. /**
  329. * Make a human file size (2048 to 2 kB)
  330. * @param int|float $bytes file size in bytes
  331. * @return string a human readable file size
  332. * @since 4.0.0
  333. */
  334. public static function humanFileSize(int|float $bytes): string {
  335. return \OC_Helper::humanFileSize($bytes);
  336. }
  337. /**
  338. * Make a computer file size (2 kB to 2048)
  339. * @param string $str file size in a fancy format
  340. * @return false|int|float a file size in bytes
  341. *
  342. * Inspired by: https://www.php.net/manual/en/function.filesize.php#92418
  343. * @since 4.0.0
  344. */
  345. public static function computerFileSize(string $str): false|int|float {
  346. return \OC_Helper::computerFileSize($str);
  347. }
  348. /**
  349. * connects a function to a hook
  350. *
  351. * @param string $signalClass class name of emitter
  352. * @param string $signalName name of signal
  353. * @param string|object $slotClass class name of slot
  354. * @param string $slotName name of slot
  355. * @return bool
  356. *
  357. * This function makes it very easy to connect to use hooks.
  358. *
  359. * TODO: write example
  360. * @since 4.0.0
  361. * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
  362. */
  363. public static function connectHook($signalClass, $signalName, $slotClass, $slotName) {
  364. return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
  365. }
  366. /**
  367. * Emits a signal. To get data from the slot use references!
  368. * @param string $signalclass class name of emitter
  369. * @param string $signalname name of signal
  370. * @param array $params default: array() array with additional data
  371. * @return bool true if slots exists or false if not
  372. *
  373. * TODO: write example
  374. * @since 4.0.0
  375. * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTypedEvent
  376. */
  377. public static function emitHook($signalclass, $signalname, $params = []) {
  378. return \OC_Hook::emit($signalclass, $signalname, $params);
  379. }
  380. /**
  381. * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
  382. * multiple OC_Template elements which invoke `callRegister`. If the value
  383. * would not be cached these unit-tests would fail.
  384. * @var string
  385. */
  386. private static $token = '';
  387. /**
  388. * Register an get/post call. This is important to prevent CSRF attacks
  389. * @since 4.5.0
  390. */
  391. public static function callRegister() {
  392. if (self::$token === '') {
  393. self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
  394. }
  395. return self::$token;
  396. }
  397. /**
  398. * Used to sanitize HTML
  399. *
  400. * This function is used to sanitize HTML and should be applied on any
  401. * string or array of strings before displaying it on a web page.
  402. *
  403. * @param string|string[] $value
  404. * @return string|string[] an array of sanitized strings or a single sanitized string, depends on the input parameter.
  405. * @since 4.5.0
  406. */
  407. public static function sanitizeHTML($value) {
  408. return \OC_Util::sanitizeHTML($value);
  409. }
  410. /**
  411. * Public function to encode url parameters
  412. *
  413. * This function is used to encode path to file before output.
  414. * Encoding is done according to RFC 3986 with one exception:
  415. * Character '/' is preserved as is.
  416. *
  417. * @param string $component part of URI to encode
  418. * @return string
  419. * @since 6.0.0
  420. */
  421. public static function encodePath($component) {
  422. return \OC_Util::encodePath($component);
  423. }
  424. /**
  425. * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
  426. *
  427. * @param array $input The array to work on
  428. * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
  429. * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
  430. * @return array
  431. * @since 4.5.0
  432. */
  433. public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
  434. return \OC_Helper::mb_array_change_key_case($input, $case, $encoding);
  435. }
  436. /**
  437. * performs a search in a nested array
  438. *
  439. * @param array $haystack the array to be searched
  440. * @param string $needle the search string
  441. * @param mixed $index optional, only search this key name
  442. * @return mixed the key of the matching field, otherwise false
  443. * @since 4.5.0
  444. * @deprecated 15.0.0
  445. */
  446. public static function recursiveArraySearch($haystack, $needle, $index = null) {
  447. return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
  448. }
  449. /**
  450. * calculates the maximum upload size respecting system settings, free space and user quota
  451. *
  452. * @param string $dir the current folder where the user currently operates
  453. * @param int|float|null $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
  454. * @return int|float number of bytes representing
  455. * @since 5.0.0
  456. */
  457. public static function maxUploadFilesize(string $dir, int|float|null $free = null): int|float {
  458. return \OC_Helper::maxUploadFilesize($dir, $free);
  459. }
  460. /**
  461. * Calculate free space left within user quota
  462. * @param string $dir the current folder where the user currently operates
  463. * @return int|float number of bytes representing
  464. * @since 7.0.0
  465. */
  466. public static function freeSpace(string $dir): int|float {
  467. return \OC_Helper::freeSpace($dir);
  468. }
  469. /**
  470. * Calculate PHP upload limit
  471. *
  472. * @return int|float number of bytes representing
  473. * @since 7.0.0
  474. */
  475. public static function uploadLimit(): int|float {
  476. return \OC_Helper::uploadLimit();
  477. }
  478. /**
  479. * Returns whether the given file name is valid
  480. * @param string $file file name to check
  481. * @return bool true if the file name is valid, false otherwise
  482. * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
  483. * @since 7.0.0
  484. * @suppress PhanDeprecatedFunction
  485. */
  486. public static function isValidFileName($file) {
  487. return \OC_Util::isValidFileName($file);
  488. }
  489. /**
  490. * Compare two strings to provide a natural sort
  491. * @param string $a first string to compare
  492. * @param string $b second string to compare
  493. * @return int -1 if $b comes before $a, 1 if $a comes before $b
  494. * or 0 if the strings are identical
  495. * @since 7.0.0
  496. */
  497. public static function naturalSortCompare($a, $b) {
  498. return \OC\NaturalSort::getInstance()->compare($a, $b);
  499. }
  500. /**
  501. * Check if a password is required for each public link
  502. *
  503. * @param bool $checkGroupMembership Check group membership exclusion
  504. * @return boolean
  505. * @since 7.0.0
  506. */
  507. public static function isPublicLinkPasswordRequired(bool $checkGroupMembership = true) {
  508. return \OC_Util::isPublicLinkPasswordRequired($checkGroupMembership);
  509. }
  510. /**
  511. * check if share API enforces a default expire date
  512. * @return boolean
  513. * @since 8.0.0
  514. */
  515. public static function isDefaultExpireDateEnforced() {
  516. return \OC_Util::isDefaultExpireDateEnforced();
  517. }
  518. protected static $needUpgradeCache = null;
  519. /**
  520. * Checks whether the current version needs upgrade.
  521. *
  522. * @return bool true if upgrade is needed, false otherwise
  523. * @since 7.0.0
  524. */
  525. public static function needUpgrade() {
  526. if (!isset(self::$needUpgradeCache)) {
  527. self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
  528. }
  529. return self::$needUpgradeCache;
  530. }
  531. /**
  532. * Sometimes a string has to be shortened to fit within a certain maximum
  533. * data length in bytes. substr() you may break multibyte characters,
  534. * because it operates on single byte level. mb_substr() operates on
  535. * characters, so does not ensure that the shortened string satisfies the
  536. * max length in bytes.
  537. *
  538. * For example, json_encode is messing with multibyte characters a lot,
  539. * replacing them with something along "\u1234".
  540. *
  541. * This function shortens the string with by $accuracy (-5) from
  542. * $dataLength characters, until it fits within $dataLength bytes.
  543. *
  544. * @since 23.0.0
  545. */
  546. public static function shortenMultibyteString(string $subject, int $dataLength, int $accuracy = 5): string {
  547. $temp = mb_substr($subject, 0, $dataLength);
  548. // json encodes encapsulates the string in double quotes, they need to be substracted
  549. while ((strlen(json_encode($temp)) - 2) > $dataLength) {
  550. $temp = mb_substr($temp, 0, -$accuracy);
  551. }
  552. return $temp;
  553. }
  554. /**
  555. * Check if a function is enabled in the php configuration
  556. *
  557. * @since 25.0.0
  558. */
  559. public static function isFunctionEnabled(string $functionName): bool {
  560. if (!function_exists($functionName)) {
  561. return false;
  562. }
  563. $ini = \OCP\Server::get(IniGetWrapper::class);
  564. $disabled = explode(',', $ini->get('disable_functions') ?: '');
  565. $disabled = array_map('trim', $disabled);
  566. if (in_array($functionName, $disabled)) {
  567. return false;
  568. }
  569. return true;
  570. }
  571. }