ext_update

Complexity

Total Complexity

38

Size/Duplication

Total Lines	401
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	renameIndexRelatedColumns()	0	34	2
A	access()	0	17	4
A	main()	0	23	4
A	getMetadataConfig()	0	34	4
B	oldIndexRelatedTableNames()	0	20	7
B	doSolariumSolrUpdate()	0	85	9
A	solariumSolrUpdateRequired()	0	26	3
A	updateMetadataConfig()	0	67	5

<?php
/**
 * (c) Kitodo. Key to digital objects e.V. <contact@kitodo.org>
 *
 * This file is part of the Kitodo and TYPO3 projects.
 *
 * @license GNU General Public License version 3 or later.
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

/**
 * Update class 'ext_update' for the 'dlf' extension.
 *
 * @author	Sebastian Meyer <sebastian.meyer@slub-dresden.de>
 * @package	TYPO3
 * @subpackage	tx_dlf
 * @access	public
 */
class ext_update {

    /**
     * This holds the output ready to return
     *
     * @var	string
     * @access protected
     */
    protected $content = '';

    /**
     * Triggers the update option in the extension manager
     *
     * @access	public
     *
     * @return	boolean		Should the update option be shown?
     */
    public function access() {

        if (count($this->getMetadataConfig())) {

            return TRUE;

        } else if ($this->oldIndexRelatedTableNames()) {

            return TRUE;

        } else if ($this->solariumSolrUpdateRequired()) {

            return TRUE;

        }

        return FALSE;

    }

    /**
     * Get all outdated metadata configuration records
     *
     * @access	protected
     *
     * @return	array		Array of UIDs of outdated records
     */
    protected function getMetadataConfig() {

        $uids = array ();

        // check if tx_dlf_metadata.xpath exists anyhow
        $fieldsInDatabase = $GLOBALS['TYPO3_DB']->admin_get_fields('tx_dlf_metadata');

        if (!in_array('xpath', array_keys($fieldsInDatabase))) {

            return $uids;

        }

        // Get all records with outdated configuration.
        $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
            'tx_dlf_metadata.uid AS uid',
            'tx_dlf_metadata',
            'tx_dlf_metadata.format=0 AND NOT tx_dlf_metadata.xpath=\'\''.tx_dlf_helper::whereClause('tx_dlf_metadata'),
            '',
            '',
            ''
        );

        if ($GLOBALS['TYPO3_DB']->sql_num_rows($result)) {

            while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {

                $uids[] = intval($resArray['uid']);

            }

        }

        return $uids;

    }

    /**
     * The main method of the class
     *
     * @access	public
     *
     * @return	string		The content that is displayed on the website
     */
    public function main() {

        // Load localization file.
        $GLOBALS['LANG']->includeLLFile('EXT:dlf/locallang.xml');

        // Update the metadata configuration.
        if (count($this->getMetadataConfig())) {
            $this->updateMetadataConfig();
        }

        if ($this->oldIndexRelatedTableNames()) {

            $this->renameIndexRelatedColumns();

        }

        if ($this->solariumSolrUpdateRequired()) {

            $this->doSolariumSolrUpdate();

        }

        return $this->content;

    }

    /**
     * Check for old index related colums
     *
     * @access	protected
     *
     * @return	boolean		true if old index related columns exist
     */
    protected function oldIndexRelatedTableNames() {

        $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
            'column_name',
            'INFORMATION_SCHEMA.COLUMNS',
            'TABLE_NAME = "tx_dlf_metadata"',
            '',
            '',
            ''
            );

        while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {

            if ($resArray['column_name'] == 'tokenized'
                || $resArray['column_name'] == 'stored'
                || $resArray['column_name'] == 'indexed'
                || $resArray['column_name'] == 'boost'
                || $resArray['column_name'] == 'autocomplete') {

                    return TRUE;

            }

        }

    }

    /**
     * Copy the data of the old index related columns to the new columns
     *
     * @access	protected
     *
     * @return	void
     */
    protected function renameIndexRelatedColumns() {

        $sqlQuery = "UPDATE tx_dlf_metadata SET `index_tokenized` = `tokenized`
											, `index_stored` = `stored`
											, `index_indexed` = `indexed`
											, `index_boost` = `boost`
											, `index_autocomplete` = `autocomplete`";

        // Copy the content of the old tables to the new ones
        $result = $GLOBALS['TYPO3_DB']->sql_query($sqlQuery);

        if ($result) {

            $message = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
                'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
                $GLOBALS['LANG']->getLL('update.copyIndexRelatedColumnsOkay', TRUE),
                $GLOBALS['LANG']->getLL('update.copyIndexRelatedColumns', TRUE),
                \TYPO3\CMS\Core\Messaging\FlashMessage::OK,
                FALSE
                );

        } else {

            $message = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
                'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
                $GLOBALS['LANG']->getLL('update.copyIndexRelatedColumnsNotOkay', TRUE),
                $GLOBALS['LANG']->getLL('update.copyIndexRelatedColumns', TRUE),
                \TYPO3\CMS\Core\Messaging\FlashMessage::WARNING,
                FALSE
                );

        }

        $this->content .= $message->render();

    }

    /**
     * Update all outdated metadata configuration records
     *
     * @access	protected
     *
     * @return	void
     */
    protected function updateMetadataConfig() {

        $metadataUids = $this->getMetadataConfig();

        if (!empty($metadataUids)) {

            $data = array ();

            // Get all old metadata configuration records.
            $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                'tx_dlf_metadata.uid AS uid,tx_dlf_metadata.pid AS pid,tx_dlf_metadata.cruser_id AS cruser_id,tx_dlf_metadata.encoded AS encoded,tx_dlf_metadata.xpath AS xpath,tx_dlf_metadata.xpath_sorting AS xpath_sorting',
                'tx_dlf_metadata',
                'tx_dlf_metadata.uid IN ('.implode(',', $metadataUids).')'.tx_dlf_helper::whereClause('tx_dlf_metadata'),
                '',
                '',
                ''
            );

            while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {

                $newId = uniqid('NEW');

                // Copy record to new table.
                $data['tx_dlf_metadataformat'][$newId] = array (
                    'pid' => $resArray['pid'],
                    'cruser_id' => $resArray['cruser_id'],
                    'parent_id' => $resArray['uid'],
                    'encoded' => $resArray['encoded'],
                    'xpath' => $resArray['xpath'],
                    'xpath_sorting' => $resArray['xpath_sorting']
                );

                // Add reference to old table.
                $data['tx_dlf_metadata'][$resArray['uid']]['format'] = $newId;

            }

            if (!empty($data)) {

                // Process datamap.
                $substUids = tx_dlf_helper::processDBasAdmin($data);

                unset ($data);

                if (!empty($substUids)) {

                    $message = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
                        'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
                        $GLOBALS['LANG']->getLL('update.metadataConfigOkay', TRUE),
                        $GLOBALS['LANG']->getLL('update.metadataConfig', TRUE),
                        \TYPO3\CMS\Core\Messaging\FlashMessage::OK,
                        FALSE
                    );

                } else {

                    $message = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
                        'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
                        $GLOBALS['LANG']->getLL('update.metadataConfigNotOkay', TRUE),
                        $GLOBALS['LANG']->getLL('update.metadataConfig', TRUE),
                        \TYPO3\CMS\Core\Messaging\FlashMessage::WARNING,
                        FALSE
                    );

                }

                $this->content .= $message->render();

            }

        }

    }

    /**
     * Check all configured Solr cores
     *
     * @access	protected
     *
     * @return	boolean
     */
    protected function solariumSolrUpdateRequired() {

        // Get all Solr cores that were not deleted.
        $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
            'index_name',
            'tx_dlf_solrcores',
            'deleted = 0',
            '',
            '',
            ''
            );

        while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {

            // Instantiate search object.
            $solr = tx_dlf_solr::getInstance($resArray['index_name']);

            if (!$solr->ready) {

The property $ready is declared protected in tx_dlf_solr. Since you implement __get, consider adding a @property or @property-read.

                return TRUE;

            }

        }

        return FALSE;

    }

    /**
     * Create all configured Solr cores
     *
     * @access	protected
     *
     * @return	void
     */
    protected function doSolariumSolrUpdate() {

        // Get all Solr cores that were not deleted.
        $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
            'index_name',
            'tx_dlf_solrcores',
            'deleted = 0',
            '',
            '',
            ''
            );

        while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {

            // Instantiate search object.
            $solr = tx_dlf_solr::getInstance($resArray['index_name']);

            if (!$solr->ready) {

The property $ready is declared protected in tx_dlf_solr. Since you implement __get, consider adding a @property or @property-read.

                $conf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['dlf']);

                $solrInfo = tx_dlf_solr::getSolrConnectionInfo();

                // Prepend username and password to hostname.
                if ($solrInfo['username'] && $solrInfo['password']) {

                    $host = $solrInfo['username'].':'.$solrInfo['password'].'@'.$solrInfo['host'];

                } else {

                    $host = $solrInfo['host'];

                }

                $context = stream_context_create(array (
                    'http' => array (
                        'method' => 'GET',
                        'user_agent' => ($conf['useragent'] ? $conf['useragent'] : ini_get('user_agent'))
                    )
                ));

                // Build request for adding new Solr core.
                // @see http://wiki.apache.org/solr/CoreAdmin
                $url = $solrInfo['scheme'].'://'.$host.':'.$solrInfo['port'].'/'.$solrInfo['path'].'/admin/cores?wt=xml&action=CREATE&name='.$resArray['index_name'].'&instanceDir=dlfCore'.$resArray['index_name'].'&dataDir=data&configSet=dlf';

                $response = @simplexml_load_string(file_get_contents($url, FALSE, $context));

                // Process response.
                if ($response) {

                    $status = $response->xpath('//lst[@name="responseHeader"]/int[@name="status"]');

                    if ($status && $status[0] == 0) {

The expression $status of type SimpleXMLElement[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                        continue;

                    }

                }

                $message = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
                    'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
                    $GLOBALS['LANG']->getLL('update.solariumSolrUpdateNotOkay', TRUE),
                    sprintf($GLOBALS['LANG']->getLL('update.solariumSolrUpdate', TRUE), $resArray['index_name']),
                    \TYPO3\CMS\Core\Messaging\FlashMessage::ERROR,
                    FALSE
                    );

                $this->content .= $message->render();

                return;

            }

        }

        $message = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
            'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
            $GLOBALS['LANG']->getLL('update.solariumSolrUpdateOkay', TRUE),
            $GLOBALS['LANG']->getLL('update.solariumSolrUpdate', TRUE),
            \TYPO3\CMS\Core\Messaging\FlashMessage::OK,
            FALSE
            );

        $this->content .= $message->render();

    }

}