JsController.php 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2017, Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Joas Schilling <coding@schilljs.com>
  8. * @author John Molakvoæ <skjnldsv@protonmail.com>
  9. * @author Morris Jobke <hey@morrisjobke.de>
  10. * @author Roeland Jago Douma <roeland@famdouma.nl>
  11. * @author Thomas Citharel <nextcloud@tcit.fr>
  12. *
  13. * @license GNU AGPL version 3 or any later version
  14. *
  15. * This program is free software: you can redistribute it and/or modify
  16. * it under the terms of the GNU Affero General Public License as
  17. * published by the Free Software Foundation, either version 3 of the
  18. * License, or (at your option) any later version.
  19. *
  20. * This program is distributed in the hope that it will be useful,
  21. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  23. * GNU Affero General Public License for more details.
  24. *
  25. * You should have received a copy of the GNU Affero General Public License
  26. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  27. *
  28. */
  29. namespace OC\Core\Controller;
  30. use OC\Files\AppData\Factory;
  31. use OCP\AppFramework\Controller;
  32. use OCP\AppFramework\Http;
  33. use OCP\AppFramework\Http\FileDisplayResponse;
  34. use OCP\AppFramework\Http\NotFoundResponse;
  35. use OCP\AppFramework\Http\Response;
  36. use OCP\AppFramework\Utility\ITimeFactory;
  37. use OCP\Files\IAppData;
  38. use OCP\Files\NotFoundException;
  39. use OCP\Files\SimpleFS\ISimpleFile;
  40. use OCP\Files\SimpleFS\ISimpleFolder;
  41. use OCP\IRequest;
  42. class JsController extends Controller {
  43. protected IAppData $appData;
  44. protected ITimeFactory $timeFactory;
  45. public function __construct($appName, IRequest $request, Factory $appDataFactory, ITimeFactory $timeFactory) {
  46. parent::__construct($appName, $request);
  47. $this->appData = $appDataFactory->get('js');
  48. $this->timeFactory = $timeFactory;
  49. }
  50. /**
  51. * @PublicPage
  52. * @NoCSRFRequired
  53. * @NoSameSiteCookieRequired
  54. *
  55. * @param string $fileName js filename with extension
  56. * @param string $appName js folder name
  57. * @return FileDisplayResponse|NotFoundResponse
  58. */
  59. public function getJs(string $fileName, string $appName): Response {
  60. try {
  61. $folder = $this->appData->getFolder($appName);
  62. $gzip = false;
  63. $file = $this->getFile($folder, $fileName, $gzip);
  64. } catch (NotFoundException $e) {
  65. return new NotFoundResponse();
  66. }
  67. $response = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'application/javascript']);
  68. if ($gzip) {
  69. $response->addHeader('Content-Encoding', 'gzip');
  70. }
  71. $ttl = 31536000;
  72. $response->addHeader('Cache-Control', 'max-age='.$ttl.', immutable');
  73. $expires = new \DateTime();
  74. $expires->setTimestamp($this->timeFactory->getTime());
  75. $expires->add(new \DateInterval('PT'.$ttl.'S'));
  76. $response->addHeader('Expires', $expires->format(\DateTime::RFC1123));
  77. $response->addHeader('Pragma', 'cache');
  78. return $response;
  79. }
  80. /**
  81. * @param ISimpleFolder $folder
  82. * @param string $fileName
  83. * @param bool $gzip is set to true if we use the gzip file
  84. * @return ISimpleFile
  85. *
  86. * @throws NotFoundException
  87. */
  88. private function getFile(ISimpleFolder $folder, string $fileName, bool &$gzip): ISimpleFile {
  89. $encoding = $this->request->getHeader('Accept-Encoding');
  90. if (strpos($encoding, 'gzip') !== false) {
  91. try {
  92. $gzip = true;
  93. return $folder->getFile($fileName . '.gzip'); # Safari doesn't like .gz
  94. } catch (NotFoundException $e) {
  95. // continue
  96. }
  97. }
  98. $gzip = false;
  99. return $folder->getFile($fileName);
  100. }
  101. }