PathHelper.php 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2022 Robin Appelman <robin@icewind.nl>
  5. *
  6. * @license GNU AGPL version 3 or any later version
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU Affero General Public License as
  10. * published by the Free Software Foundation, either version 3 of the
  11. * License, or (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU Affero General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU Affero General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. namespace OC\Files\Utils;
  23. class PathHelper {
  24. /**
  25. * Make a path relative to a root path, or return null if the path is outside the root
  26. *
  27. * @param string $root
  28. * @param string $path
  29. * @return ?string
  30. */
  31. public static function getRelativePath(string $root, string $path) {
  32. if ($root === '' or $root === '/') {
  33. return self::normalizePath($path);
  34. }
  35. if ($path === $root) {
  36. return '/';
  37. } elseif (!str_starts_with($path, $root . '/')) {
  38. return null;
  39. } else {
  40. $path = substr($path, strlen($root));
  41. return self::normalizePath($path);
  42. }
  43. }
  44. /**
  45. * @param string $path
  46. * @return string
  47. */
  48. public static function normalizePath(string $path): string {
  49. if ($path === '' or $path === '/') {
  50. return '/';
  51. }
  52. //no windows style slashes
  53. $path = str_replace('\\', '/', $path);
  54. //add leading slash
  55. if ($path[0] !== '/') {
  56. $path = '/' . $path;
  57. }
  58. //remove duplicate slashes
  59. while (str_contains($path, '//')) {
  60. $path = str_replace('//', '/', $path);
  61. }
  62. //remove trailing slash
  63. $path = rtrim($path, '/');
  64. return $path;
  65. }
  66. }