Rello / analytics

lib/Controller/WhatsNewController.php

<?php
/**
 * Analytics
 *
 * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors, 2019-2022 Marcel Scherello
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Analytics\Controller;

use OCA\Analytics\WhatsNew\WhatsNewCheck;
use OCP\AppFramework\Controller;

The type OCP\AppFramework\Controller was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\AppFramework\Db\DoesNotExistException;

The type OCP\AppFramework\Db\DoesNotExistException was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\AppFramework\Http;

The type OCP\AppFramework\Http was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\AppFramework\Http\DataResponse;

The type OCP\AppFramework\Http\DataResponse was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\IConfig;

The type OCP\IConfig was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\IRequest;

The type OCP\IRequest was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\IUserSession;

The type OCP\IUserSession was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\L10N\IFactory;

The type OCP\L10N\IFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use Psr\Log\LoggerInterface;

The type Psr\Log\LoggerInterface was not found. Maybe you did not declare it correctly or list all dependencies?

class WhatsNewController extends Controller
{

    /** @var IConfig */
    protected $config;
    /** @var IUserSession */
    private $userSession;
    /** @var WhatsNewCheck */
    private $whatsNewService;
    /** @var IFactory */
    private $langFactory;
    private $logger;

    public function __construct(
        string $appName,
        IRequest $request,
        IUserSession $userSession,
        IConfig $config,
        WhatsNewCheck $whatsNewService,
        IFactory $langFactory,
        LoggerInterface $logger
    )
    {
        parent::__construct($appName, $request);
        $this->appName = $appName;

The property appName does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->config = $config;
        $this->userSession = $userSession;
        $this->whatsNewService = $whatsNewService;
        $this->langFactory = $langFactory;
        $this->logger = $logger;
    }

    /**
     * @NoAdminRequired
     */
    public function get(): DataResponse
    {
        $user = $this->userSession->getUser();
        if ($user === null) {
            throw new \RuntimeException("Acting user cannot be resolved");
        }
        $lastRead = $this->config->getUserValue($user->getUID(), $this->appName, 'whatsNewLastRead', 0);
        $currentVersion = $this->whatsNewService->normalizeVersion($this->config->getAppValue($this->appName, 'installed_version'));

        if (version_compare($lastRead, $currentVersion, '>=')) {
            return new DataResponse([], Http::STATUS_NO_CONTENT);
        }

        try {
            $iterator = $this->langFactory->getLanguageIterator();
            $whatsNew = $this->whatsNewService->getChangesForVersion($currentVersion);

            $resultData = [
                'changelogURL' => $whatsNew['changelogURL'],
                'product' => 'Analytics',
                'version' => $currentVersion,
            ];
            do {
                $lang = $iterator->current();
                if (isset($whatsNew['whatsNew'][$lang])) {
                    $resultData['whatsNew'] = $whatsNew['whatsNew'][$lang];
                    break;
                }
                $iterator->next();
            } while ($lang !== 'en' && $iterator->valid());
            return new DataResponse($resultData);
        } catch (DoesNotExistException $e) {
            return new DataResponse([], Http::STATUS_NO_CONTENT);
        }
    }

    /**
     * @NoAdminRequired
     *
     * @throws \OCP\PreConditionNotMetException
     * @throws DoesNotExistException
     */
    public function dismiss(string $version): DataResponse
    {
        $user = $this->userSession->getUser();
        if ($user === null) {
            throw new \RuntimeException("Acting user cannot be resolved");
        }
        $version = $this->whatsNewService->normalizeVersion($version);
        // checks whether it's a valid version, throws an Exception otherwise
        $this->whatsNewService->getChangesForVersion($version);
        $this->config->setUserValue($user->getUID(), $this->appName, 'whatsNewLastRead', $version);
        return new DataResponse();
    }
}