1
0

ChangesCheck.php 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2018 Arthur Schiwon <blizzz@arthur-schiwon.de>
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  7. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  8. * @author Daniel Kesselberg <mail@danielkesselberg.de>
  9. *
  10. * @license GNU AGPL version 3 or any later version
  11. *
  12. * This program is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License as
  14. * published by the Free Software Foundation, either version 3 of the
  15. * License, or (at your option) any later version.
  16. *
  17. * This program is distributed in the hope that it will be useful,
  18. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. * GNU Affero General Public License for more details.
  21. *
  22. * You should have received a copy of the GNU Affero General Public License
  23. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24. *
  25. */
  26. namespace OC\Updater;
  27. use OCP\AppFramework\Db\DoesNotExistException;
  28. use OCP\Http\Client\IClientService;
  29. use OCP\Http\Client\IResponse;
  30. use Psr\Log\LoggerInterface;
  31. class ChangesCheck {
  32. /** @var IClientService */
  33. protected $clientService;
  34. /** @var ChangesMapper */
  35. private $mapper;
  36. private LoggerInterface $logger;
  37. public const RESPONSE_NO_CONTENT = 0;
  38. public const RESPONSE_USE_CACHE = 1;
  39. public const RESPONSE_HAS_CONTENT = 2;
  40. public function __construct(IClientService $clientService, ChangesMapper $mapper, LoggerInterface $logger) {
  41. $this->clientService = $clientService;
  42. $this->mapper = $mapper;
  43. $this->logger = $logger;
  44. }
  45. /**
  46. * @throws DoesNotExistException
  47. * @return array{changelogURL: string, whatsNew: array<string, array{admin: string[], regular: string[]}>}
  48. */
  49. public function getChangesForVersion(string $version): array {
  50. $version = $this->normalizeVersion($version);
  51. $changesInfo = $this->mapper->getChanges($version);
  52. $changesData = json_decode($changesInfo->getData(), true);
  53. if (empty($changesData)) {
  54. throw new DoesNotExistException('Unable to decode changes info');
  55. }
  56. return $changesData;
  57. }
  58. /**
  59. * @throws \Exception
  60. */
  61. public function check(string $uri, string $version): array {
  62. try {
  63. $version = $this->normalizeVersion($version);
  64. $changesInfo = $this->mapper->getChanges($version);
  65. if ($changesInfo->getLastCheck() + 1800 > time()) {
  66. return json_decode($changesInfo->getData(), true);
  67. }
  68. } catch (DoesNotExistException $e) {
  69. $changesInfo = new Changes();
  70. }
  71. $response = $this->queryChangesServer($uri, $changesInfo);
  72. switch ($this->evaluateResponse($response)) {
  73. case self::RESPONSE_NO_CONTENT:
  74. return [];
  75. case self::RESPONSE_USE_CACHE:
  76. return json_decode($changesInfo->getData(), true);
  77. case self::RESPONSE_HAS_CONTENT:
  78. default:
  79. $data = $this->extractData($response->getBody());
  80. $changesInfo->setData(json_encode($data));
  81. $changesInfo->setEtag($response->getHeader('Etag'));
  82. $this->cacheResult($changesInfo, $version);
  83. return $data;
  84. }
  85. }
  86. protected function evaluateResponse(IResponse $response): int {
  87. if ($response->getStatusCode() === 304) {
  88. return self::RESPONSE_USE_CACHE;
  89. } elseif ($response->getStatusCode() === 404) {
  90. return self::RESPONSE_NO_CONTENT;
  91. } elseif ($response->getStatusCode() === 200) {
  92. return self::RESPONSE_HAS_CONTENT;
  93. }
  94. $this->logger->debug('Unexpected return code {code} from changelog server', [
  95. 'app' => 'core',
  96. 'code' => $response->getStatusCode(),
  97. ]);
  98. return self::RESPONSE_NO_CONTENT;
  99. }
  100. protected function cacheResult(Changes $entry, string $version) {
  101. if ($entry->getVersion() === $version) {
  102. $this->mapper->update($entry);
  103. } else {
  104. $entry->setVersion($version);
  105. $this->mapper->insert($entry);
  106. }
  107. }
  108. /**
  109. * @throws \Exception
  110. */
  111. protected function queryChangesServer(string $uri, Changes $entry): IResponse {
  112. $headers = [];
  113. if ($entry->getEtag() !== '') {
  114. $headers['If-None-Match'] = [$entry->getEtag()];
  115. }
  116. $entry->setLastCheck(time());
  117. $client = $this->clientService->newClient();
  118. return $client->get($uri, [
  119. 'headers' => $headers,
  120. ]);
  121. }
  122. protected function extractData($body):array {
  123. $data = [];
  124. if ($body) {
  125. if (\LIBXML_VERSION < 20900) {
  126. $loadEntities = libxml_disable_entity_loader(true);
  127. $xml = @simplexml_load_string($body);
  128. libxml_disable_entity_loader($loadEntities);
  129. } else {
  130. $xml = @simplexml_load_string($body);
  131. }
  132. if ($xml !== false) {
  133. $data['changelogURL'] = (string)$xml->changelog['href'];
  134. $data['whatsNew'] = [];
  135. foreach ($xml->whatsNew as $infoSet) {
  136. $data['whatsNew'][(string)$infoSet['lang']] = [
  137. 'regular' => (array)$infoSet->regular->item,
  138. 'admin' => (array)$infoSet->admin->item,
  139. ];
  140. }
  141. } else {
  142. libxml_clear_errors();
  143. }
  144. }
  145. return $data;
  146. }
  147. /**
  148. * returns a x.y.z form of the provided version. Extra numbers will be
  149. * omitted, missing ones added as zeros.
  150. */
  151. public function normalizeVersion(string $version): string {
  152. $versionNumbers = array_slice(explode('.', $version), 0, 3);
  153. $versionNumbers[0] = $versionNumbers[0] ?: '0'; // deal with empty input
  154. while (count($versionNumbers) < 3) {
  155. // changelog server expects x.y.z, pad 0 if it is too short
  156. $versionNumbers[] = 0;
  157. }
  158. return implode('.', $versionNumbers);
  159. }
  160. }