class.ext_update.php

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2009 Juergen Furrer <juergen.furrer@gmail.com>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project 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; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
 *
 *  This script 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.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 * Class for updating jfmulticontent content elements
 *
 * @author     Juergen Furrer <juergen.furrer@gmail.com>
 */
class ext_update
{
    private $tstemplates;
    private $contentElements = array();
    private $wrongLanguage = array();
    private $missingHtmlTemplates = array();
    private $movedFields = array();
    private $flexObj;
    private $ll = 'LLL:EXT:jfmulticontent/locallang.xml:updater.';
    private $sheet_mapping = array(
        'tab'       => 'general',
        'accordion' => 'general',
        'slider'    => 'general',
        'autoplay'  => 'general',
    );
    private $style_mapping = array(
        '2colomn' => '2column',
        '3colomn' => '3column',
        '4colomn' => '4column',
    );

    /**
     * Main function, returning the HTML content of the module
     *
     * @return	string		HTML
     */
    public function main()
    {
        $out = '';
        if (class_exists(t3lib_utility_VersionNumber) && t3lib_utility_VersionNumber::convertVersionNumberToInteger(TYPO3_version) < 4003000) {
            // add flashmessages styles
            $cssPath = $GLOBALS['BACK_PATH'] . t3lib_extMgm::extRelPath('jfmulticontent');
            $out .= '<link rel="stylesheet" type="text/css" href="' . $cssPath . 'compat/flashmessages.css" media="screen" />';
        }
        $this->flexObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools::class);
        // analyze
        $this->contentElements = $this->getContentElements();
        $this->wrongLanguage   = $this->getWrongLanguage();
        $this->wrongStyle      = $this->getWrongStyle();
        if (\TYPO3\CMS\Core\Utility\GeneralUtility::_GP('do_update')) {
            $out .= '<a href="' . \TYPO3\CMS\Core\Utility\GeneralUtility::linkThisScript(array('do_update' => '', 'func' => '')) . '">' . $GLOBALS['LANG']->sL($this->ll . 'back') . '</a><br/>';
            $func = trim(\TYPO3\CMS\Core\Utility\GeneralUtility::_GP('func'));
            if (method_exists($this, $func)) {
                $out .= '
<div style="padding:15px 15px 20px 0;">
	<div class="typo3-message message-ok">
		<div class="message-header">' . $GLOBALS['LANG']->sL($this->ll . 'updateresults') . '</div>
		<div class="message-body">
		' . $this->$func() . '
		</div>
	</div>
</div>';
            } else {
                $out .= '
<div style="padding:15px 15px 20px 0;">
	<div class="typo3-message message-error">
		<div class="message-body">ERROR: ' . $func . '() not found</div>
	</div>
</div>';
            }
        } else {
            $out .= '<a href="' . \TYPO3\CMS\Core\Utility\GeneralUtility::linkThisScript(array('do_update' => '', 'func' => '')) . '">' . $GLOBALS['LANG']->sL($this->ll . 'reload') . '
			<img style="vertical-align:bottom;" src="/typo3/sysext/t3skin/extjs/images/grid/refresh.gif" width="18" height="16"></a><br/>';
            $out .= $this->displayWarning();
            $out .= '<h3>' . $GLOBALS['LANG']->sL($this->ll . 'actions') . '</h3>';
            // Update all flexform
            $out .= $this->displayUpdateOption('searchFlexForm',      count($this->contentElements), 'updateFlexForm');
            // Update wrong Style
            $out .= $this->displayUpdateOption('searchWrongStyle',    count($this->wrongStyle),      'updateWrongStyle');
            // Update wrong  language
            $out .= $this->displayUpdateOption('searchWrongLanguage', count($this->wrongLanguage),   'updateWrongLanguage');
        }

        return $out;
    }

    /**
     * Display the html of the update option
     * @param string $k
     * @param int $count
     * @param string $func
     * @return hteml
     */
    private function displayUpdateOption($k, $count, $func)
    {
        $msg = $GLOBALS['LANG']->sL($this->ll . 'msg_' . $k) . ' ';
        $msg .= '<br/><strong>' . str_replace('###COUNT###', $count, $GLOBALS['LANG']->sL($this->ll . 'foundMsg_' . $k)) . '</strong>';
        $msg .= ' <img src="/typo3conf/ext/jfmulticontent/compat/gfx/' . ($count == 0 ? 'ok' : 'warning') . '.png" width="18" height="16">';
        if ($count) {
            $msg .= '<p style="margin:5px 0;">' . $GLOBALS['LANG']->sL($this->ll . 'question_' . $k) . '<p>';
            $msg .= '<p style="margin-bottom:10px;"><em>' . $GLOBALS['LANG']->sL($this->ll . 'questionInfo_' . $k) . '</em><p>';
            $msg .= $this->getButton($func);
        } else {
            $msg .= '<br/>' . $GLOBALS['LANG']->sL($this->ll . 'nothingtodo');
        }
        $out = $this->wrapForm($msg, $GLOBALS['LANG']->sL($this->ll . 'lbl_' . $k));
        $out .= '<br/><br/>';
        return $out;
    }

    /**
     * Display the warningmessage
     * 
     * @return html
     */
    private function displayWarning()
    {
        $out = '
<div style="padding:15px 15px 20px 0;">
	<div class="typo3-message message-warning">
		<div class="message-header">' . $GLOBALS['LANG']->sL($this->ll . 'warningHeader') . '</div>
		<div class="message-body">
			' . $GLOBALS['LANG']->sL($this->ll . 'warningMsg') . '
		</div>
	</div>
</div>';
        return $out;
    }

    /**
     * Returns the fieldset of updatesection
     * 
     * @param string $content
     * @param string $fsLabel
     * @return html
     */
    private function wrapForm($content, $fsLabel)
    {
        $out = '
<form action="">
	<fieldset style="background:#f4f4f4;margin-right:15px;">
		<legend>' . $fsLabel . '</legend>
		' . $content . '
	</fieldset>
</form>';
        return $out;
    }

    /**
     * Return the button for update
     * 
     * @param string $func
     * @param string $lbl
     * @return html
     */
    private function getButton($func, $lbl = 'DO IT')
    {
        $params = array('do_update' => 1, 'func' => $func);
        $onClick = "document.location='" . \TYPO3\CMS\Core\Utility\GeneralUtility::linkThisScript($params) . "'; return false;";
        $button = '<input type="submit" value="' . $lbl . '" onclick="' . htmlspecialchars($onClick) . '">';
        return $button;
    }

    /**
     * Returns all content elements with old values
     * 
     * @return array
     */
    private function getContentElements()
    {
        $select_fields = '*';
        $from_table = 'tt_content';
        $where_clause = '
		CType=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('list', $from_table) . '
		AND list_type=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('jfmulticontent_pi1', $from_table) . '
		AND deleted=0';
        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($select_fields, $from_table, $where_clause);
        if ($res) {
            $resultRows = array();
            while (($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))) {
                $ff_parsed = \TYPO3\CMS\Core\Utility\GeneralUtility::xml2array($row['pi_flexform']);
                // Check for old sheet values
                if (is_array($ff_parsed['data'])) {
                    foreach ($ff_parsed['data'] as $key => $val) {
                        if (array_key_exists($key, $this->sheet_mapping)) {
                            $resultRows[$row['uid']] = array(
                                'ff'        => $row['pi_flexform'],
                                'ff_parsed' => $ff_parsed,
                                'title'     => $row['title'],
                                'pid'       => $row['pid'],
                            );
                        }
                    }
                }
            }
        }
        return $resultRows;
    }

    /**
     * Return all contents with wrong styles
     * 
     * @return string
     */
    private function getWrongStyle()
    {
        $select_fields = '*';
        $from_table = 'tt_content';
        $where_clause = '
		CType=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('list', $from_table) . '
		AND list_type=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('jfmulticontent_pi1', $from_table) . '
		AND deleted=0';
        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($select_fields, $from_table, $where_clause);
        if ($res) {
            $resultRows = array();
            while (($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))) {
                $ff_parsed = \TYPO3\CMS\Core\Utility\GeneralUtility::xml2array($row['pi_flexform']);
                // Check for old sheet values
                if (is_array($ff_parsed['data'])) {
                    foreach ($ff_parsed['data'] as $key => $val) {
                        if (array_key_exists($val['lDEF']['style']['vDEF'], $this->style_mapping)) {
                            $resultRows[$row['uid']] = array(
                                'ff'        => $row['pi_flexform'],
                                'ff_parsed' => $ff_parsed,
                                'title'     => $row['title'],
                                'pid'       => $row['pid'],
                            );
                        }
                    }
                }
            }
        }
        return $resultRows;
    }

    /**
     * Returns all contents with content from differend languages
     * 
     * @return string
     */
    private function getWrongLanguage()
    {
        $select_fields = '*';
        $from_table = 'tt_content';
        $where_clause = '
		CType=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('list', $from_table) . '
		AND list_type=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('jfmulticontent_pi1', $from_table) . '
		AND deleted=0';
        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($select_fields, $from_table, $where_clause);
        if ($res) {
            $resultRows = array();
            while (($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))) {
                $addArray = false;
                $tempRows = array();
                $res2 = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                    $select_fields,
                    $from_table,
                    'uid IN (' . implode(',', $GLOBALS['TYPO3_DB']->fullQuoteArray(\TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $row['tx_jfmulticontent_contents'], true), $from_table)) . ')
					AND deleted=0'
                );
                while (($row2 = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res2))) {
                    if ($row2['sys_language_uid'] != 0) {
                        $addArray = true;
                        $tempRows[] = $row2['l18n_parent'];
                    } else {
                        $tempRows[] = $row2['uid'];
                    }
                }
                if ($addArray === true) {
                    $resultRows[$row['uid']] = $tempRows;
                }
            }
        }
        return $resultRows;
    }

    /**
     * Update the content elements
     * 
     * @return string
     */
    private function updateFlexForm()
    {
        $msg = null;
        if (count($this->contentElements) > 0 && count($this->sheet_mapping) > 0) {
            foreach ($this->contentElements as $content_id => $contentElement) {
                foreach ($this->sheet_mapping as $sheet_old => $sheet_new) {
                    $old_values = $contentElement['ff_parsed']['data'][$sheet_old]['lDEF'];
                    if (count($old_values) > 0) {
                        foreach ($old_values as $key => $val) {
                            $contentElement['ff_parsed']['data'][$sheet_new]['lDEF'][$key] = $val;
                        }
                    }
                    unset($contentElement['ff_parsed']['data'][$sheet_old]);
                }
                // Update the content
                $table = 'tt_content';
                $where = 'uid=' . $content_id;
                $fields_values = array(
                    'pi_flexform' => $this->flexObj->flexArray2Xml($contentElement['ff_parsed'], 1)
                );
                if ($GLOBALS['TYPO3_DB']->exec_UPDATEquery($table, $where, $fields_values)) {
                    $msg[] = 'Updated contentElement uid: ' . $content_id . ', pid: ' . $this->contentElements[$content_id]['pid'];
                }
            }
        }
        return implode('<br/>', $msg);
    }

    /**
     * Update the content elements
     * 
     * @return string
     */
    private function updateWrongStyle()
    {
        $msg = null;
        if (count($this->wrongStyle) > 0 && count($this->style_mapping) > 0) {
            foreach ($this->wrongStyle as $content_id => $contentElement) {
                $contentElement['ff_parsed']['data']['general']['lDEF']['style']['vDEF'] = $this->style_mapping[$contentElement['ff_parsed']['data']['general']['lDEF']['style']['vDEF']];
                // Update the content
                $table = 'tt_content';
                $where = 'uid=' . $content_id;
                $fields_values = array(
                    'pi_flexform' => $this->flexObj->flexArray2Xml($contentElement['ff_parsed'], 1)
                );
                if ($GLOBALS['TYPO3_DB']->exec_UPDATEquery($table, $where, $fields_values)) {
                    $msg[] = 'Updated contentElement uid: ' . $content_id . ', pid: ' . $this->wrongStyle[$content_id]['pid'];
                }
            }
        }
        return implode('<br/>', $msg);
    }

    /**
     * Update the content elements
     * 
     * @return string
     */
    private function updateWrongLanguage()
    {
        $msg = null;
        if (count($this->wrongLanguage) > 0) {
            foreach ($this->wrongLanguage as $content_id => $contentElements) {
                // Update the content
                $table = 'tt_content';
                $where = 'uid=' . $content_id;
                $fields_values = array(
                    'tx_jfmulticontent_contents' => implode(',', $contentElements)
                );
                if ($GLOBALS['TYPO3_DB']->exec_UPDATEquery($table, $where, $fields_values)) {
                    $msg[] = 'Updated contentElement uid: ' . $content_id;
                }
            }
        }
        return implode('<br/>', $msg);
    }

    /**
     * Checks how many rows are found and returns true if there are any
     * (this function is called from the extension manager)
     *
     * @param	string		$what: what should be updated
     * @return	bool
     */
    public function access($what = 'all')
    {
        return true;
    }
}

if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/jfmulticontent/class.ext_update.php']) {
    include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/jfmulticontent/class.ext_update.php']);
}