jkphl/micrometa

<?php

/**
 * micrometa
 *
 * @category   Jkphl
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Ports
 * @author     Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @copyright  Copyright © 2018 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Micrometa\Ports;

use Jkphl\Domfactory\Ports\Dom;
use Jkphl\Micrometa\Application\Service\ExtractorService;
use Jkphl\Micrometa\Infrastructure\Factory\ItemFactory;
use Jkphl\Micrometa\Infrastructure\Factory\ParserFactory;
use Jkphl\Micrometa\Infrastructure\Logger\ExceptionLogger;
use Jkphl\Micrometa\Ports\Item\ItemInterface;
use Jkphl\Micrometa\Ports\Item\ItemObjectModel;
use Jkphl\Micrometa\Ports\Item\ItemObjectModelInterface;
use League\Uri\Http;
use Psr\Log\LoggerInterface;

/**
 * Parser
 *
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Ports
 */
class Parser
{
    /**
     * Micro information formats
     *
     * @var int
     */
    protected $formats;
    /**
     * Logger
     *
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * Parser constructor
     *
     * @param int $formats                 Micro information formats to extract
     * @param LoggerInterface|null $logger PSR-3 compatible logger
     *
     * @api
     */
    public function __construct($formats = Format::ALL, LoggerInterface $logger = null)
    {
        $this->formats = $formats;
        $this->logger  = $logger ?: new ExceptionLogger();
    }

    /**
     * Extract micro information items out of a URI or piece of source
     *
     * @param string $uri         URI
     * @param string|null $source Source code
     * @param int $formats        Micro information formats to extract
     * @param array $httpOptions  HTTP request options
     *
     * @return ItemObjectModelInterface Item object model
     * @api
     */
    public function __invoke($uri, $source = null, $formats = null, array $httpOptions = [])
    {
        $dom   = new \DOMDocument();
        $items = [];

        try {
            $parsers = ParserFactory::createParsersFromFormats(
                intval($formats ?: $this->formats),
                Http::createFromString($uri),
                $this->logger
            );
            $dom     = $this->createDom($uri, $source, $httpOptions);
            $items   = $this->extractItems($dom, $parsers);

            // In case of exceptions: Log if possible
        } catch (\Exception $exception) {
            $this->logger->critical($exception->getMessage(), ['exception' => $exception]);
        }

        return new ItemObjectModel($dom, $items);
    }

    /**
     * Create the DOM document to parse
     *
     * @param string $uri         URI
     * @param string|null $source Source code
     * @param array $httpOptions  HTTP request options
     *
     * @return \DOMDocument DOM document
     */
    protected function createDom($uri, $source = null, array $httpOptions = [])
    {
        return (($source !== null) && strlen(trim($source))) ?
            Dom::createFromString($source) : Dom::createFromUri($uri, $httpOptions);
    }

    /**
     * Extract all items from a DOM using particular parsers
     *
     * @param \DOMDocument $dom   DOM document
     * @param \Generator $parsers Parsers
     *
     * @return ItemInterface[] Items
     */
    protected function extractItems(\DOMDocument $dom, \Generator $parsers)
    {
        $items     = [];
        $extractor = new ExtractorService();
        foreach ($parsers as $parser) {
            $results = $extractor->extract($dom, $parser);
            $items   = array_merge($items, ItemFactory::createFromApplicationItems($results->getItems()));
        }

        return $items;
    }
}