AdminCommand.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Lowlevel;

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

class AdminCommand extends \TYPO3\CMS\Core\Controller\CommandLineController
{
    public $adminModules = [
        'setBElock' => 'Set the Backend Lock',
        'clearBElock' => 'Clears the Backend Lock',
        'msg' => 1
    ];

    public function __construct()
    {
        // Running parent class constructor
        parent::__construct();
        // Adding options to help archive:
        $this->cli_options[] = ['--redirect=[URL]', 'For toolkey "setBElock": The URL to which the redirection will occur.'];
        // Setting help texts:
        $this->cli_help['name'] = 'lowlevel_admin -- Various functions for administration and maintenance of TYPO3 from the command line';
        $this->cli_help['synopsis'] = 'toolkey ###OPTIONS###';
        $this->cli_help['description'] = 'The \'toolkey\' keywords are:

  ' . implode('
  ', array_keys($this->adminModules));
        $this->cli_help['examples'] = '/.../cli_dispatch.phpsh lowlevel_admin setBElock --redirect=http://url_which_explains_why.com/';
        $this->cli_help['author'] = 'Kasper Skaarhoej, (c) 2009';
    }

    /**************************
     *
     * CLI functionality
     *
     *************************/
    public function cli_main($argv)
    {
        // Force user to admin state and set workspace to "Live":
        $GLOBALS['BE_USER']->user['admin'] = 1;
        $GLOBALS['BE_USER']->setWorkspace(0);
        // Print help
        $analysisType = (string)$this->cli_args['_DEFAULT'][1];
        if (!$analysisType) {
            $this->cli_validateArgs();
            $this->cli_help();
            die;
        }
        // Analysis type:
        switch ((string)$analysisType) {
            case 'setBElock':
                if (@is_file((PATH_typo3conf . 'LOCK_BACKEND'))) {
                    $this->cli_echo('A lockfile already exists. Overwriting it...
');
                }
                $lockFileContent = $this->cli_argValue('--redirect');
                \TYPO3\CMS\Core\Utility\GeneralUtility::writeFile(PATH_typo3conf . 'LOCK_BACKEND', $lockFileContent);
                $this->cli_echo('Wrote lock-file to \'' . PATH_typo3conf . 'LOCK_BACKEND\' with content \'' . $lockFileContent . '\'');
                break;
            case 'clearBElock':
                if (@is_file((PATH_typo3conf . 'LOCK_BACKEND'))) {
                    unlink(PATH_typo3conf . 'LOCK_BACKEND');
                    if (@is_file((PATH_typo3conf . 'LOCK_BACKEND'))) {
                        $this->cli_echo('ERROR: Could not remove lock file \'' . PATH_typo3conf . 'LOCK_BACKEND\'!!
', 1);
                    } else {
                        $this->cli_echo('Removed lock file \'' . PATH_typo3conf . 'LOCK_BACKEND\'
');
                    }
                } else {
                    $this->cli_echo('No lock file \'' . PATH_typo3conf . 'LOCK_BACKEND\' was found; hence no lock can be removed.\'
');
                }
                break;
            default:
                $this->cli_echo('Unknown toolkey, \'' . $analysisType . '\'');
        }
        $this->cli_echo(LF);
    }
}