MicroDataSchema.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Rtehtmlarea\Extension;

use TYPO3\CMS\Core\Utility\GeneralUtility;

class MicroDataSchema extends \TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi {

    // The key of the TYPO3 extension that is extending htmlArea RTE
    protected $extensionKey = 'rtehtmlarea';

    // The name of the plugin registered by the extension
    protected $pluginName = 'MicrodataSchema';

    // Path to this main locallang file of the extension relative to the extension dir.
    protected $relativePathToLocallangFile = 'extensions/MicrodataSchema/locallang.xlf';

    // Path to the skin (css) file relative to the extension dir
    protected $relativePathToSkin = 'extensions/MicrodataSchema/skin/htmlarea.css';

    protected $htmlAreaRTE;

    // Reference to the invoking object
    protected $thisConfig;

    // Reference to RTE PageTSConfig
    protected $toolbar;

    // Reference to RTE toolbar array
    protected $LOCAL_LANG;

    // Frontend language array
    protected $pluginButtons = 'showmicrodata';

    protected $convertToolbarForHtmlAreaArray = array(
        'showmicrodata' => 'ShowMicrodata'
    );

    public function buildJavascriptConfiguration($RTEcounter) {
        $registerRTEinJavascriptString = '';
        $schema = array(
            'types' => array(),
            'properties' => array()
        );
        // Parse configured schemas
        if (is_array($this->thisConfig['schema.']) && is_array($this->thisConfig['schema.']['sources.'])) {
            foreach ($this->thisConfig['schema.']['sources.'] as $source) {
                $fileName = trim($source);
                $absolutePath = GeneralUtility::getFileAbsFileName($fileName);
                // Fallback to default schema file if configured file does not exists or is of zero size
                if (!$fileName || !file_exists($absolutePath) || !filesize($absolutePath)) {
                    $fileName = 'EXT:' . $this->ID . '/extensions/MicrodataSchema/res/schemaOrgAll.rdf';
                }
                $fileName = $this->htmlAreaRTE->getFullFileName($fileName);
                $rdf = GeneralUtility::getUrl($fileName);
                if ($rdf) {
                    $this->parseSchema($rdf, $schema);
                }
            }
        }
        uasort($schema['types'], array($this, 'compareLabels'));
        uasort($schema['properties'], array($this, 'compareLabels'));
        // Insert no type and no property entries
        if ($this->htmlAreaRTE->is_FE()) {
            $noSchema = $GLOBALS['TSFE']->getLLL('No type', $this->LOCAL_LANG);
            $noProperty = $GLOBALS['TSFE']->getLLL('No property', $this->LOCAL_LANG);
        } else {
            $noSchema = $GLOBALS['LANG']->getLL('No type');
            $noProperty = $GLOBALS['LANG']->getLL('No property');
        }
        array_unshift($schema['types'], array('name' => 'none', 'label' => $noSchema));
        array_unshift($schema['properties'], array('name' => 'none', 'label' => $noProperty));
        // Convert character set
        if ($this->htmlAreaRTE->is_FE()) {
            $GLOBALS['TSFE']->csConvObj->convArray($schema, $this->htmlAreaRTE->outputCharset, 'utf-8');
        }
        // Store json encoded array in temporary file
        $registerRTEinJavascriptString = LF . TAB . 'RTEarea[editornumber].schemaUrl = "' . ($this->htmlAreaRTE->is_FE() && $GLOBALS['TSFE']->absRefPrefix ? $GLOBALS['TSFE']->absRefPrefix : '') . $this->htmlAreaRTE->writeTemporaryFile('', ('schema_' . $this->htmlAreaRTE->language), 'js', json_encode($schema), TRUE) . '";';
        return $registerRTEinJavascriptString;
    }

    protected function compareLabels($a, $b) {
        return strcoll($a['label'], $b['label']);
    }

    protected function parseSchema($string, &$schema) {
        $resources = array();
        $types = array();
        $properties = array();
        // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
        $previousValueOfEntityLoader = libxml_disable_entity_loader(TRUE);
        // Load the document
        $document = new \DOMDocument();
        $document->loadXML($string);
        libxml_disable_entity_loader($previousValueOfEntityLoader);
        if ($document) {
            // Scan resource descriptions
            $items = $document->getElementsByTagName('Description');
            $itemsCount = $items->length;
            foreach ($items as $item) {
                $name = $item->getAttribute('rdf:about');
                $type = $item->getElementsByTagName('type');
                if ($name && $type->length) {
                    $type = $type->item(0)->getAttribute('rdf:resource');
                    $resource = array();
                    $resource['name'] = $name;
                    $labels = $item->getElementsByTagName('label');
                    if ($labels->length) {
                        foreach ($labels as $label) {
                            $language = $label->getAttribute('xml:lang');
                            if ($language === $this->language) {
                                $resource['label'] = $label->nodeValue;
                            } elseif ($language === 'en') {
                                $defaultLabel = $label->nodeValue;
                            }
                        }
                        if (!$resource['label']) {
                            $resource['label'] = $defaultLabel;
                        }
                    }
                    $comments = $item->getElementsByTagName('comment');
                    if ($comments->length) {
                        foreach ($comments as $comment) {
                            $language = $comment->getAttribute('xml:lang');
                            if ($language === $this->language) {
                                $resource['comment'] = $comment->nodeValue;
                            } elseif ($language === 'en') {
                                $defaultComment = $comment->nodeValue;
                            }
                        }
                        if (!$resource['comment']) {
                            $resource['comment'] = $defaultComment;
                        }
                    }
                    switch ($type) {
                        case 'http://www.w3.org/2000/01/rdf-schema#Class':
                            $subClassOfs = $item->getElementsByTagName('subClassOf');
                            if ($subClassOfs->length) {
                                foreach ($subClassOfs as $subClassOf) {
                                    $resource['subClassOf'] = $subClassOf->getAttribute('rdf:resource');
                                }
                            }
                            // schema.rdfs.org/all.rdf may contain duplicates!!
                            if (!in_array($resource['name'], $types)) {
                                $schema['types'][] = $resource;
                                $types[] = $resource['name'];
                            }
                            break;
                        case 'http://www.w3.org/1999/02/22-rdf-syntax-ns#Property':
                            // Keep only the last level of the name
                            // This is the value we want in the itemprop attribute
                            $pos = strrpos($resource['name'], '/');
                            if ($pos) {
                                $resource['name'] = substr($resource['name'], $pos + 1);
                            }
                            $domains = $item->getElementsByTagName('domain');
                            if ($domains->length) {
                                foreach ($domains as $domain) {
                                    $resource['domain'] = $domain->getAttribute('rdf:resource');
                                }
                            }
                            $ranges = $item->getElementsByTagName('range');
                            if ($ranges->length) {
                                foreach ($ranges as $range) {
                                    $resource['range'] = $range->getAttribute('rdf:resource');
                                }
                            }
                            // schema.rdfs.org/all.rdf may contain duplicates!!
                            if (!in_array($resource['name'], $properties)) {
                                $schema['properties'][] = $resource;
                                $properties[] = $resource['name'];
                            }
                            break;
                        default:
                            // Do nothing
                    }
                }
            }
        }
    }

}