* * @author Daniel Kesselberg * @author Joas Schilling * @author Lukas Reschke * @author Morris Jobke * @author Roeland Jago Douma * @author Steffen Lindner * * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * */ namespace OC\App\AppStore\Fetcher; use GuzzleHttp\Exception\ConnectException; use OC\Files\AppData\Factory; use OCP\AppFramework\Http; use OCP\AppFramework\Utility\ITimeFactory; use OCP\Files\IAppData; use OCP\Files\NotFoundException; use OCP\Http\Client\IClientService; use OCP\IConfig; use OCP\ILogger; use OCP\Util; abstract class Fetcher { const INVALIDATE_AFTER_SECONDS = 300; /** @var IAppData */ protected $appData; /** @var IClientService */ protected $clientService; /** @var ITimeFactory */ protected $timeFactory; /** @var IConfig */ protected $config; /** @var Ilogger */ protected $logger; /** @var string */ protected $fileName; /** @var string */ protected $endpointUrl; /** @var string */ protected $version; /** @var string */ protected $channel; /** * @param Factory $appDataFactory * @param IClientService $clientService * @param ITimeFactory $timeFactory * @param IConfig $config * @param ILogger $logger */ public function __construct(Factory $appDataFactory, IClientService $clientService, ITimeFactory $timeFactory, IConfig $config, ILogger $logger) { $this->appData = $appDataFactory->get('appstore'); $this->clientService = $clientService; $this->timeFactory = $timeFactory; $this->config = $config; $this->logger = $logger; } /** * Fetches the response from the server * * @param string $ETag * @param string $content * * @return array */ protected function fetch($ETag, $content) { $appstoreenabled = $this->config->getSystemValue('appstoreenabled', true); if (!$appstoreenabled) { return []; } $options = [ 'timeout' => 10, ]; if ($ETag !== '') { $options['headers'] = [ 'If-None-Match' => $ETag, ]; } $client = $this->clientService->newClient(); $response = $client->get($this->endpointUrl, $options); $responseJson = []; if ($response->getStatusCode() === Http::STATUS_NOT_MODIFIED) { $responseJson['data'] = json_decode($content, true); } else { $responseJson['data'] = json_decode($response->getBody(), true); $ETag = $response->getHeader('ETag'); } $responseJson['timestamp'] = $this->timeFactory->getTime(); $responseJson['ncversion'] = $this->getVersion(); if ($ETag !== '') { $responseJson['ETag'] = $ETag; } return $responseJson; } /** * Returns the array with the categories on the appstore server * * @return array */ public function get() { $appstoreenabled = $this->config->getSystemValue('appstoreenabled', true); $internetavailable = $this->config->getSystemValue('has_internet_connection', true); if (!$appstoreenabled || !$internetavailable) { return []; } $rootFolder = $this->appData->getFolder('/'); $ETag = ''; $content = ''; try { // File does already exists $file = $rootFolder->getFile($this->fileName); $jsonBlob = json_decode($file->getContent(), true); if (is_array($jsonBlob)) { // No caching when the version has been updated if (isset($jsonBlob['ncversion']) && $jsonBlob['ncversion'] === $this->getVersion()) { // If the timestamp is older than 300 seconds request the files new if ((int)$jsonBlob['timestamp'] > ($this->timeFactory->getTime() - self::INVALIDATE_AFTER_SECONDS)) { return $jsonBlob['data']; } if (isset($jsonBlob['ETag'])) { $ETag = $jsonBlob['ETag']; $content = json_encode($jsonBlob['data']); } } } } catch (NotFoundException $e) { // File does not already exists $file = $rootFolder->newFile($this->fileName); } // Refresh the file content try { $responseJson = $this->fetch($ETag, $content); $file->putContent(json_encode($responseJson)); return json_decode($file->getContent(), true)['data']; } catch (ConnectException $e) { $this->logger->warning('Could not connect to appstore: ' . $e->getMessage(), ['app' => 'appstoreFetcher']); return []; } catch (\Exception $e) { $this->logger->logException($e, ['app' => 'appstoreFetcher', 'level' => ILogger::WARN]); return []; } } /** * Get the currently Nextcloud version * @return string */ protected function getVersion() { if ($this->version === null) { $this->version = $this->config->getSystemValue('version', '0.0.0'); } return $this->version; } /** * Set the current Nextcloud version * @param string $version */ public function setVersion(string $version) { $this->version = $version; } /** * Get the currently Nextcloud update channel * @return string */ protected function getChannel() { if ($this->channel === null) { $this->channel = \OC_Util::getChannel(); } return $this->channel; } /** * Set the current Nextcloud update channel * @param string $channel */ public function setChannel(string $channel) { $this->channel = $channel; } }