SoapProvider.php

<?php
namespace T3o\TerFe2\Provider;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

/**
 * Extension provider for soap requests
 */
class SoapProvider extends \T3o\TerFe2\Provider\AbstractProvider
{

    /**
     * @var string
     */
    protected $getExtensionsFunc;

    /**
     * @var string
     */
    protected $getFileUrlFunc;

    /**
     * @var string
     */
    protected $getFileNameFunc;

    /**
     * @var string
     */
    protected $getDownloadCountFunc;

    /**
     * @var \T3o\TerFe2\Service\SoapService
     */
    protected $soapService;

    /**
     * Initialize provider
     *
     * @throws \Exception
     */
    public function initializeProvider()
    {
        if (empty($this->configuration['wsdlUrl'])) {
            throw new \Exception('No wsdl url configured');
        }

        $username = (empty($this->configuration['username']) ? $this->configuration['username'] : '');
        $password = (empty($this->configuration['password']) ? $this->configuration['password'] : '');
        $httpAuth['login'] = $this->configuration['httpAuth']['login'] ?: '';
        $httpAuth['password'] = $this->configuration['httpAuth']['password'] ?: '';
        $this->soapService = $this->objectManager->get(\T3o\TerFe2\Service\SoapService::class);
        $this->soapService->connect($this->configuration['wsdlUrl'], $username, $password, $httpAuth);

        // Set getExtensionsFunc
        if (!empty($this->configuration['getExtensionsFunc'])) {
            $this->getExtensionsFunc = $this->configuration['getExtensionsFunc'];
        }

        // Set getFileUrlFunc
        if (!empty($this->configuration['getFileUrlFunc'])) {
            $this->getFileUrlFunc = $this->configuration['getFileUrlFunc'];
        }

        // Set getFileNameFunc
        if (!empty($this->configuration['getFileNameFunc'])) {
            $this->getFileNameFunc = $this->configuration['getFileNameFunc'];
        }

        // Set getDownloadCountFunc
        if (!empty($this->configuration['getDownloadCountFunc'])) {
            $this->getDownloadCountFunc = $this->configuration['getDownloadCountFunc'];
        }
    }

    /**
     * Returns all extensions since last run
     *
     * @param int $lastRun Timestamp of last update
     * @param int $offset Offset to start with
     * @param int $count Extension count to load
     * @return array Extension rows
     * @throws \Exception
     */
    public function getExtensions($lastRun, $offset, $count)
    {
        if (empty($this->getExtensionsFunc)) {
            throw new \Exception('No configuration for "getExtensionsFunc" found');
        }
        $parameters = [
            'lastRun' => (int)$lastRun,
            'offset' => (int)$offset,
            'count' => (int)$count,
        ];
        $result = $this->soapService->__call($this->getExtensionsFunc, $parameters);
        return !empty($result['extensions']) ? $result['extensions'] : [];
    }

    /**
     * Returns the url to an extension related file
     *
     * @param \T3o\TerFe2\Domain\Model\Version $version Version object
     * @param string $fileType File type
     * @return string Url to file
     * @throws \Exception
     */
    public function getFileUrl(\T3o\TerFe2\Domain\Model\Version $version, $fileType)
    {
        if (empty($this->getFileUrlFunc)) {
            throw new \Exception('No configuration for "getFileUrlFunc" found');
        }
        $parameters = [
            'extension' => (string)$version->getExtension()->getExtKey(),
            'version' => (string)$version->getVersionString(),
            'fileType' => (string)$fileType,
        ];
        $result = $this->soapService->__call($this->getFileUrlFunc, $parameters);
        if (empty($result['url'])) {
            throw new \Exception('Could not get url to file from soap server');
        }
        return (string)$result['url'];
    }

    /**
     * Returns name of an extension related file
     *
     * @param \T3o\TerFe2\Domain\Model\Version $version Version object
     * @param string $fileType File type
     * @return string File name
     * @throws \Exception
     */
    public function getFileName(\T3o\TerFe2\Domain\Model\Version $version, $fileType)
    {
        if (empty($this->getFileNameFunc)) {
            throw new \Exception('No configuration for "getFileNameFunc" found');
        }
        $parameters = [
            'extension' => (string)$version->getExtension()->getExtKey(),
            'version' => (string)$version->getVersionString(),
            'fileType' => (string)$fileType,
        ];
        $result = $this->soapService->__call($this->getFileNameFunc, $parameters);
        if (empty($result['filename'])) {
            throw new \Exception('Could not get filename from soap server');
        }
        return (string)$result['filename'];
    }

    /**
     * Returns all information about an extension version
     *
     * @param \T3o\TerFe2\Domain\Model\Version $version Version object
     * @return array Version details
     * @throws \Exception
     */
    public function getVersionDetails(\T3o\TerFe2\Domain\Model\Version $version)
    {
        if (empty($this->getVersionDetailsFunc)) {
            throw new \Exception('No configuration for "getVersionDetailsFunc" found');
        }
        $parameters = [
            'extension' => (string)$version->getExtension()->getExtKey(),
            'version' => (string)$version->getVersionString(),
        ];
        $result = $this->soapService->__call($this->getVersionDetailsFunc, $parameters);
        if (empty($result) || !is_array($result)) {
            throw new \Exception('Could not get version details from soap server');
        }
        return $result;
    }
}