TerIndexer.php 7.64 KB
Newer Older
1
<?php
2
namespace T3o\TerFe2\Solr\IndexQueue;
3
4
5

/**
 * This file is part of the TYPO3 CMS project.
6
 *
7
8
9
 * 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.
10
 *
11
12
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
13
 *
14
15
 * The TYPO3 project - inspiring people to share!
 */
16

17
use TYPO3\CMS\Core\Utility\GeneralUtility;
18
use ApacheSolrForTypo3\Solr\IndexQueue\Item;
19
use TYPO3\CMS\Core\Utility\VersionNumberUtility;
Thomas Löffler's avatar
Thomas Löffler committed
20
use T3o\TerFe2\Utility\Version;
21
22

/**
23
 * Class \T3o\TerFe2\Solr\IndexQueue\TerIndexer
24
25
26
27
28
 *
 * @author Sascha Egerer <sascha@sascha-egerer.de>
 * @author Thomas Löffler <thomas.loeffler@typo3.org>
 * @author Tomas Norre Mikkelsen <tomasnorre@gmail.com>
 */
29
class TerIndexer extends \ApacheSolrForTypo3\Solr\IndexQueue\Indexer {
30
31
32


    /**
33
     * @var \TYPO3\CMS\Extbase\Object\ObjectManager
34
35
36
37
     */
    protected $objectManager;

    /**
38
     * @var \T3o\TerFe2\Domain\Repository\ExtensionRepository
39
40
41
42
43
44
45
     */
    protected $extensionRepository;


    public function __construct(array $options = array()) {
        parent::__construct($options);

46
        $this->objectManager = GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
47
        $this->extensionRepository = $this->objectManager->get(\T3o\TerFe2\Domain\Repository\ExtensionRepository::class);
48
49
50
51
52

        $this->extensionRepository->setShowInsecure(FALSE);
    }

    /**
53
54
55
56
57
     * Converts an item array (record) to a Solr document by mapping the
     * record's fields onto Solr document fields as configured in TypoScript.
     *
     * @param Item $item An index queue item
     * @param int $language Language Id
58
     * @return \Apache_Solr_Document The Solr document converted from the record
59
     */
60
61
62
63
64
65
66
67
68
69
70
71
72
    protected function itemToDocument(Item $item, $language = 0)
    {
        $document = null;

        $itemRecord = $this->getFullItemRecord($item, $language);
        if (!is_null($itemRecord)) {
            $itemIndexingConfiguration = $this->getItemTypeConfiguration($item,
                $language);

            $document = $this->getBaseDocument($item, $itemRecord);
            $document = $this->addDocumentFieldsFromTyposcript($document, $itemIndexingConfiguration, $itemRecord);
            $document = $this->addSpecialFields($document, $itemRecord);
        }
73

74
75
        return $document;
    }
76

77
78
79
80
81
    /**
     * @param \Apache_Solr_Document $document
     * @param array $itemRecord
     * @return \Apache_Solr_Document
     */
82
    public function addSpecialFields(\Apache_Solr_Document $document, array $itemRecord)
83
84
85
    {
        $extension = $this->extensionRepository->findByUid($itemRecord['uid']);

86
        if ($extension instanceof \T3o\TerFe2\Domain\Model\Extension) {
87
88
89
            $document->setField(
                'extensionIcon_stringS',
                $this->getExtensionIcon(
90
91
                    $itemRecord['ext_key'],
                    $extension->getLastVersion()->getVersionString()
92
93
                )
            );
94

95
96
97
            $typo3Dependency = $this->getDependencyVersionForPackage($extension, 'typo3');
            $document->setField('extensionMinTYPO3Version_tIntS', $typo3Dependency['minimum']);
            $document->setField('extensionMaxTYPO3Version_tIntS', $typo3Dependency['maximum']);
98

99
100
101
102
103
            $dependencyString = '';
            $dependencyString .= $typo3Dependency['minimum'] > 0 ? VersionNumberUtility::convertIntegerToVersionNumber($typo3Dependency['minimum']) : '';
            $dependencyString .= $typo3Dependency['maximum'] > 0 ? ' - ' . VersionNumberUtility::convertIntegerToVersionNumber($typo3Dependency['maximum']) : '';
            $document->setField('extensionDependency_stringS', $dependencyString ?: 'N/A');

104
            $document->setField('outdated_boolS', $extension->getLastVersion()->getReviewState() === -2);
Thomas Löffler's avatar
Thomas Löffler committed
105

Thomas Löffler's avatar
Thomas Löffler committed
106
107
108
109
110
111
112
113
            // does this extension supports different versions?
            // @todo: use JSON with all versions to get them
            $lastVersion = $extension->getLastVersion();
            $document->setField('supports6_boolS', Version::doesExtensionVersionSupportTypo3Version($lastVersion, 6200000));
            $document->setField('supports7_boolS', Version::doesExtensionVersionSupportTypo3Version($lastVersion, 7006000));
            $document->setField('supports8_boolS', Version::doesExtensionVersionSupportTypo3Version($lastVersion, 8007000));
            $document->setField('supports9_boolS', Version::doesExtensionVersionSupportTypo3Version($lastVersion, 9000000));

Thomas Löffler's avatar
Thomas Löffler committed
114
115
116
117
118
119
            // add documentation link
            /** @var \T3o\TerFe2\Service\Documentation $documentationService */
            $documentationService = GeneralUtility::makeInstance(\T3o\TerFe2\Service\Documentation::class);
            $documentationLink = $documentationService->getDocumentationLink($extension->getExtKey(), $extension->getLastVersion()->getVersionString(), true);
            $document->setField('extensionDocumentationLink_stringS', $documentationLink);

120
121
        }

122
        return $document;
123
124
125
126
127
    }

    /**
     * get the minimum dependency of an extension for a given $relationName (extension, php version, TYPO3 version...)
     *
128
     * @param \T3o\TerFe2\Domain\Model\Extension $extension
129
     * @param string $relationName The dependency to get the version from (e.g. "typo3" to get the minimum typo3 version)
Thomas Löffler's avatar
Thomas Löffler committed
130
     * @return array
131
     */
132
    protected function getDependencyVersionForPackage(\T3o\TerFe2\Domain\Model\Extension $extension, $relationName) {
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
        $versions = array(
            'minimum' => 0,
            'maximum' => 0
        );

        foreach ($extension->getLastVersion()->getSoftwareRelations() as $relation) {
            if ($relation->getRelationType() === 'depends' && $relation->getRelationKey() === $relationName) {
                $versions = array(
                    'minimum' => $relation->getMinimumVersion(),
                    'maximum' => $relation->getMaximumVersion()
                );
                break;
            }
        }

        return $versions;
    }

    /**
     * get the relative path for the extension icon
     * could be png or gif
     *
     * @param $extensionKey
     * @param $extensionVersion
     * @return string
     */
    protected function getExtensionIcon($extensionKey, $extensionVersion) {

        // check if there is a gif or a png icon or if there is no icon
        $iconFilePng = $this->generateIconFileName(
            $extensionKey,
            $extensionVersion,
            'png'
        );
        $iconFileGif = $this->generateIconFileName(
            $extensionKey,
            $extensionVersion,
            'gif'
        );

        $iconPath = 'fileadmin/ter/';
        $icon = '';

        if (file_exists(PATH_site.$iconPath.$iconFilePng)) {
177
            $icon = \T3o\TerFe2\Utility\File::getRelativeUrlFromAbsolutePath($iconPath.$iconFilePng);
178
        } elseif(file_exists(PATH_site.$iconPath.$iconFileGif)) {
179
            $icon = \T3o\TerFe2\Utility\File::getRelativeUrlFromAbsolutePath($iconPath.$iconFileGif);
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
        }

        return $icon;
    }

    /**
     * generate the path to an extension icon for a specific version
     *
     * @param $extension
     * @param $version
     * @param $fileType
     * @return string
     */
    protected function generateIconFileName($extension, $version, $fileType) {
        if (empty($extension) || empty($version) || empty($fileType)) {
            return '';
        }
        $extension = strtolower($extension);
        $fileType = strtolower(trim($fileType, '. '));
        return $extension[0] . '/' . $extension[1] . '/' . $extension . '_' . $version . '.' . $fileType;
    }
201
}