class.tx_coreupdates_installnewsysexts.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2008-2011 Benjamin Mack <benni@typo3.org>
*  (c) 2008-2011 Steffen Kamper <info@sk-typo3.de>
*  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!
***************************************************************/

/**
 * Contains the update class for adding the system extension "simulate static".
 *
 * $Id: class.tx_coreupdates_installnewsysexts.php 10335 2011-01-26 16:41:07Z stephenking $
 *
 * @author  Benjamin Mack <benni@typo3.org>
 * @author  Steffen Kamper <info@sk-typo3.de>
 */
class tx_coreupdates_installnewsysexts extends Tx_Install_Updates_Base {
    protected $title = 'Install New System Extensions';
    protected $newSystemExtensions = array('recycler', 't3editor', 'reports', 'scheduler');

    /**
     * Checks if an update is needed
     *
     * @param   string      &$description: The description for the update
     * @return  boolean     whether an update is needed (true) or not (false)
     */
    public function checkForUpdate(&$description) {
        $result = FALSE;
        $description = '
            <p>
                Install the following system extensions that are new since TYPO3
                4.3:
            </p>
        ';

        $description .= '
            <ul>
        ';

        foreach($this->newSystemExtensions as $_EXTKEY) {
            if (!t3lib_extMgm::isLoaded($_EXTKEY)) {
                $EM_CONF = FALSE;
                    // extension may not been loaded at this point, so we can't use an API function from t3lib_extmgm
                require (PATH_site . 'typo3/sysext/' . $_EXTKEY . '/ext_emconf.php');
                $description .= '
                    <li>
                        <strong>
                            ' . $EM_CONF[$_EXTKEY]['title'] . ' [' . $_EXTKEY . ']
                        </strong>
                        <br />
                        ' . $EM_CONF[$_EXTKEY]['description'] . '
                    </li>
                ';

                $result = TRUE;
            }
        }

        $description .= '
            </ul>
        ';
        if ($this->isWizardDone()) {
            $result = FALSE;
        }

        return $result;
    }

    /**
     * second step: get user input for installing sysextensions
     *
     * @param   string      input prefix, all names of form fields have to start with this. Append custom name in [ ... ]
     * @return  string      HTML output
     */
    public function getUserInput($inputPrefix) {
        $content = '
            <p>
                <strong>
                    Install the following system extensions that are new in
                    TYPO3 4.3:
                </strong>
            </p>
        ';

        $content .= '
            <fieldset>
                <ol>
        ';

        foreach($this->newSystemExtensions as $_EXTKEY) {
            if (!t3lib_extMgm::isLoaded($_EXTKEY)) {
                $EM_CONF = FALSE;
                    // extension may not been loaded at this point, so we can't use an API function from t3lib_extmgm
                require (PATH_site . 'typo3/sysext/' . $_EXTKEY . '/ext_emconf.php');
                $content .= '
                    <li class="labelAfter">
                        <input type="checkbox" id="' . $_EXTKEY . '" name="' . $inputPrefix . '[sysext][' . $_EXTKEY . ']" value="1" checked="checked" />
                        <label for="' . $_EXTKEY . '">' . $EM_CONF[$_EXTKEY]['title'] . ' [' . $_EXTKEY . ']</label>
                    </li>
                ';
            }
        }

        $content .= '
                </ol>
            </fieldset>
        ';

        return $content;
    }

    /**
     * Adds the extensions "about", "cshmanual" and "simulatestatic" to the extList in TYPO3_CONF_VARS
     *
     * @param   array       &$dbQueries: queries done in this update
     * @param   mixed       &$customMessages: custom messages
     * @return  boolean     whether it worked (true) or not (false)
     */
    public function performUpdate(&$dbQueries, &$customMessages) {

            // Get extension keys that were submitted by the user to be installed and that are valid for this update wizard
        if (is_array($this->pObj->INSTALL['update']['installNewSystemExtensions']['sysext'])) {
            $extArray = array_intersect(
                $this->newSystemExtensions,
                array_keys($this->pObj->INSTALL['update']['installNewSystemExtensions']['sysext'])
            );
            $this->installExtensions($extArray);
        }

            // Never show this wizard again
        $this->markWizardAsDone();

        return TRUE;
    }


    /**
     * Adds extension to extension list and returns new list. If -1 is returned, an error happend.
     * Does NOT check dependencies yet.
     *
     * @param   array       Extension keys to add
     * @return  string      New list of installed extensions or -1 if error
     * @deprecated since TYPO3 4.5, will be removed in TYPO3 4.7 - Should not be needed anymore. Extensions should be installed directly by calling Tx_Install_Updates_Base::installExtensions()
     */
    function addExtToList(array $extKeys) {
        t3lib_div::logDeprecatedFunction();
            // Get list of installed extensions and add this one.
        $tmpLoadedExt = $GLOBALS['TYPO3_LOADED_EXT'];
        if (isset($tmpLoadedExt['_CACHEFILE'])) {
            unset($tmpLoadedExt['_CACHEFILE']);
        }

        $listArr = array_keys($tmpLoadedExt);
        $listArr = array_merge($listArr, $extKeys);

            // Implode unique list of extensions to load and return:
        return implode(',', array_unique($listArr));
    }


    /**
     * Writes the extension list to "localconf.php" file
     * Removes the temp_CACHED* files before return.
     *
     * @param   string      List of extensions
     * @return  void
     * @deprecated since TYPO3 4.5, will be removed in TYPO3 4.7 - Use Tx_Install_Updates_Base::installExtensions() instead
     */
    protected function writeNewExtensionList($newExtList) {
        t3lib_div::logDeprecatedFunction();
            // Instance of install tool
        $instObj = new t3lib_install;
        $instObj->allowUpdateLocalConf = 1;
        $instObj->updateIdentity = 'TYPO3 Core Update Manager';

            // Get lines from localconf file
        $lines = $instObj->writeToLocalconf_control();
        $instObj->setValueInLocalconfFile($lines, '$TYPO3_CONF_VARS[\'EXT\'][\'extList\']', $newExtList);
        $instObj->writeToLocalconf_control($lines);

        $GLOBALS['TYPO3_CONF_VARS']['EXT']['extList'] = $newExtList;
        t3lib_extMgm::removeCacheFiles();
    }
}
?>