<?php

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2014-2021 (original work) Open Assessment Technologies SA;
 */

namespace oat\oatbox\service;

use oat\oatbox\log\LoggerService;
use oat\oatbox\log\TaoLoggerAwareInterface;
use Psr\Log\LoggerAwareInterface;
use oat\oatbox\service\exception\InvalidServiceManagerException;
use Zend\ServiceManager\ServiceLocatorAwareInterface;
use Zend\ServiceManager\ServiceLocatorAwareTrait;

/**
 * Class ServiceManagerAwareTrait
 *
 * Trait to transport oat\oatbox\service\ServiceManager
 * It includes tools to register and propagate oat service
 *
 * @package oat\oatbox\service
 * @author Moyon Camille
 * @deprecated New services must be registered using Dependency Injection Container
 */
trait ServiceManagerAwareTrait
{
    use ServiceLocatorAwareTrait;

    /**
     * Get the oat service manager.
     *
     * It should be used for service building, register, build, propagate
     * For reading operation please use $this->getServiceLocator() instead
     *
     * @return ServiceManager
     * @throws InvalidServiceManagerException
     * @deprecated New services must be registered using Dependency Injection Container
     */
    public function getServiceManager()
    {
        $serviceManager = $this->getServiceLocator();
        if ($serviceManager instanceof ServiceManager) {
            return $serviceManager;
        }
        $msg = is_null($serviceManager)
            ? 'ServiceLocator not initialized for ' . get_class($this)
            : 'Alternate service locator not compatible with getServiceManager() in ' . __CLASS__;
        throw new InvalidServiceManagerException($msg);
    }

    /**
     * Register a service through ServiceManager
     *
     * @param $serviceKey
     * @param ConfigurableService $service
     * @param bool $allowOverride
     * @throws \common_Exception
     * @deprecated New services must be registered using Dependency Injection Container
     */
    public function registerService($serviceKey, ConfigurableService $service, $allowOverride = true)
    {
        if ($allowOverride || ! $this->getServiceLocator()->has($serviceKey)) {
            $this->getServiceManager()->register($serviceKey, $service);
        }
    }

    /**
     * Propagate service dependencies
     *
     * @param $service
     * @return mixed
     * @deprecated New services must be registered using Dependency Injection Container
     */
    protected function propagate($service)
    {
        // Propagate the service manager
        if ($service instanceof ServiceLocatorAwareInterface) {
            $service->setServiceLocator($this->getServiceLocator());
        }

        // Propagate the logger service
        if ($service instanceof LoggerAwareInterface) {
            $logger = null;
            if ($this instanceof TaoLoggerAwareInterface) {
                $logger = $this->getLogger();
            } else {
                if ($this->getServiceLocator()->has(LoggerService::SERVICE_ID)) {
                    $logger = $this->getServiceLocator()->get(LoggerService::SERVICE_ID);
                }
            }
            if (!is_null($logger)) {
                $service->setLogger($logger);
            }
        }

        return $service;
    }
}