--- /dev/null
+<?php
+/***************************************************************
+* Copyright notice
+*
+* (c) 2011 Claus Due, Wildside A/S <claus@wildside.dk>
+* 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.
+*
+* 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!
+***************************************************************/
+
+/**
+ * Field provider for Extbase CommandController Scheduler task
+ *
+ * @package Extbase
+ * @subpackage Scheduler
+ */
+class Tx_Extbase_Scheduler_FieldProvider implements Tx_Scheduler_AdditionalFieldProvider {
+
+ /**
+ * @var Tx_Extbase_MVC_CLI_CommandManager
+ */
+ protected $commandManager;
+
+ /**
+ * @var Tx_Extbase_Object_ObjectManagerInterface
+ */
+ protected $objectManager;
+
+ /**
+ * @var Tx_Extbase_Reflection_Service
+ */
+ protected $reflectionService;
+
+ /**
+ * @var Tx_Extbase_Scheduler_Task
+ */
+ protected $task;
+
+ /**
+ * Constructor
+ *
+ * @param Tx_Extbase_Object_ObjectManagerInterface $objectManager
+ * @param Tx_Extbase_MVC_CLI_CommandManager $commandManager
+ * @param Tx_Extbase_Reflection_Service $reflectionService
+ */
+ public function __construct(Tx_Extbase_Object_ObjectManagerInterface $objectManager = NULL, Tx_Extbase_MVC_CLI_CommandManager $commandManager = NULL, Tx_Extbase_Reflection_Service $reflectionService = NULL) {
+ $this->objectManager = $objectManager !== NULL ? $objectManager : t3lib_div::makeInstance('Tx_Extbase_Object_ObjectManager');
+ $this->commandManager = $commandManager !== NULL ? $commandManager : $this->objectManager->get('Tx_Extbase_MVC_CLI_CommandManager');
+ $this->reflectionService = $reflectionService !== NULL ? $reflectionService : $this->objectManager->get('Tx_Extbase_Reflection_Service');
+ }
+
+ /**
+ * Render additional information fields within the scheduler backend.
+ *
+ * @param array $taskInfo Array information of task to return
+ * @param mixed $task Tx_Extbase_Scheduler_Task or tx_scheduler_Execution instance
+ * @param Tx_Scheduler_Module $schedulerModule Reference to the calling object (BE module of the Scheduler)
+ * @return array Additional fields
+ * @see interfaces/tx_scheduler_AdditionalFieldProvider#getAdditionalFields($taskInfo, $task, $schedulerModule)
+ */
+ public function getAdditionalFields(array &$taskInfo, $task, Tx_Scheduler_Module $schedulerModule) {
+ $this->task = $task;
+ if ($this->task !== NULL) {
+ $this->task->setScheduler();
+ }
+ $fields = array();
+ $fields['action'] = $this->getCommandControllerActionField();
+ if ($this->task !== NULL && $this->task->getCommandIdentifier()) {
+ $command = $this->commandManager->getCommandByIdentifier($this->task->getCommandIdentifier());
+ $fields['description'] = $this->getCommandControllerActionDescriptionField();
+ $argumentFields = $this->getCommandControllerActionArgumentFields($command->getArgumentDefinitions());
+ $fields = array_merge($fields, $argumentFields);
+ $this->task->save();
+ }
+ return $fields;
+ }
+
+ /**
+ * Validates additional selected fields
+ *
+ * @param array $submittedData
+ * @param Tx_Scheduler_Module $schedulerModule
+ * @return boolean
+ */
+ public function validateAdditionalFields(array &$submittedData, Tx_Scheduler_Module $schedulerModule) {
+ return TRUE;
+ }
+
+ /**
+ * Saves additional field values
+ *
+ * @param array $submittedData
+ * @param Tx_Scheduler_Task $task
+ * @return boolean
+ */
+ public function saveAdditionalFields(array $submittedData, Tx_Scheduler_Task $task) {
+ $task->setCommandIdentifier($submittedData['task_extbase']['action']);
+ $task->setArguments($submittedData['task_extbase']['arguments']);
+ return TRUE;
+ }
+
+ /**
+ * Get description of selected command
+ *
+ * @return string
+ */
+ protected function getCommandControllerActionDescriptionField() {
+ $command = $this->commandManager->getCommandByIdentifier($this->task->getCommandIdentifier());
+ return array(
+ 'code' => '',
+ 'label' => '<strong>' . $command->getDescription() . '</strong>'
+ );
+ }
+
+ /**
+ * Gets a select field containing all possible CommandController actions
+ *
+ * @return array
+ */
+ protected function getCommandControllerActionField() {
+ $commands = $this->commandManager->getAvailableCommands();
+ $options = array();
+ foreach ($commands as $command) {
+ if ($command->isInternal() === FALSE) {
+ $classNameParts = explode('_', $command->getControllerClassName());
+ $identifier = $command->getCommandIdentifier();
+ $options[$identifier] = $classNameParts[1] . ' ' . str_replace('CommandController', '', $classNameParts[3]) . ': ' . $command->getControllerCommandName();
+ }
+ }
+ $name = "action";
+ $currentlySelectedCommand = $this->task !== NULL ? $this->task->getCommandIdentifier() : NULL;
+ return array(
+ 'code' => $this->renderSelectField($name, $options, $currentlySelectedCommand),
+ 'label' => $this->getActionLabel()
+ );
+ }
+
+ /**
+ * Gets a set of fields covering arguments which must be sent to $currentControllerAction.
+ * Also registers the default values of those fields with the Task, allowing
+ * them to be read upon execution.
+ *
+ * @param array $argumentDefinitions
+ * @return array
+ */
+ protected function getCommandControllerActionArgumentFields(array $argumentDefinitions) {
+ $fields = array();
+ $argumentValues = $this->task->getArguments();
+ foreach ($argumentDefinitions as $index=>$argument) {
+ $name = $argument->getName();
+ $defaultValue = $this->getDefaultArgumentValue($argument);
+ $this->task->addDefaultValue($name, $defaultValue);
+ $value = isset($argumentValues[$name]) ? $argumentValues[$name] : $defaultValue;
+ $fields[$name] = array(
+ 'code' => $this->renderField($argument, $value),
+ 'label' => $this->getArgumentLabel($argument)
+ );
+ }
+ return $fields;
+ }
+
+ /**
+ * Gets a label for $key based on either provided extension or currently
+ * selected CommandController extension,ยด
+ *
+ * @param string $localLanguageKey
+ * @param string $extensionName
+ * @return string
+ */
+ protected function getLanguageLabel($localLanguageKey, $extensionName = NULL) {
+ if (!$extensionName) {
+ list ($extensionName, $commandControllerName, $commandName) = explode(':', $this->task->getCommandIdentifier());
+ }
+ $label = Tx_Extbase_Utility_Localization::translate($localLanguageKey, $extensionName);
+ return $label;
+ }
+
+ /**
+ * Gets the data type required for the argument value
+ *
+ * @param Tx_Extbase_MVC_CLI_CommandArgumentDefinition $argument
+ * @return string the argument type
+ */
+ protected function getArgumentType(Tx_Extbase_MVC_CLI_CommandArgumentDefinition $argument) {
+ $command = $this->commandManager->getCommandByIdentifier($this->task->getCommandIdentifier());
+ $controllerClassName = $command->getControllerClassName();
+ $methodName = $command->getControllerCommandName() . 'Command';
+ $tags = $this->reflectionService->getMethodTagsValues($controllerClassName, $methodName);
+ foreach ($tags['param'] as $tag) {
+ list ($argumentType, $argumentVariableName) = explode(' ', $tag);
+ if (substr($argumentVariableName, 1) === $argument->getName()) {
+ return $argumentType;
+ }
+ }
+ }
+
+ /**
+ * Get a human-readable label for a command argument
+ *
+ * @param Tx_Extbase_MVC_CLI_CommandArgumentDefinition $argument
+ * @return string
+ */
+ protected function getArgumentLabel(Tx_Extbase_MVC_CLI_CommandArgumentDefinition $argument) {
+ $argumentName = $argument->getName();
+ list ($extensionName, $commandControllerName, $commandName) = explode(':', $this->task->getCommandIdentifier());
+ $path = array('command', $commandControllerName, $commandName, 'arguments', $argumentName);
+ $labelNameIndex = implode('.', $path);
+ $label = $this->getLanguageLabel($labelNameIndex);
+ if (!$label) {
+ $label = 'Argument: ' . $argumentName;
+ }
+ $descriptionIndex = $labelNameIndex . '.description';
+ $description = $this->getLanguageLabel($descriptionIndex);
+ if (strlen($description) === 0) {
+ $description = $argument->getDescription();
+ }
+ if (strlen($description) > 0) {
+ $label .= '. <em>' . htmlspecialchars($description) . '</em>';
+ }
+ return $label;
+ }
+
+ /**
+ * Gets the default value of argument
+ *
+ * @param Tx_Extbase_MVC_CLI_CommandArgumentDefinition $argument
+ * @return mixed
+ */
+ protected function getDefaultArgumentValue(Tx_Extbase_MVC_CLI_CommandArgumentDefinition $argument) {
+ $type = $this->getArgumentType($argument);
+ $argumentName = $argument->getName();
+ $command = $this->commandManager->getCommandByIdentifier($this->task->getCommandIdentifier());
+ $argumentReflection = $this->reflectionService->getMethodParameters($command->getControllerClassName(), $command->getControllerCommandName() . 'Command');
+ $defaultValue = $argumentReflection[$argumentName]['defaultValue'];
+ if ($type === 'boolean') {
+ $defaultValue = ((bool) $defaultValue) ? 1 : 0;
+ }
+ return $defaultValue;
+ }
+
+ /**
+ * Get a human-readable label for the action field
+ *
+ * @return string
+ */
+ protected function getActionLabel() {
+ $index = 'task.action';
+ $label = $this->getLanguageLabel($index, 'extbase');
+ if (!$label) {
+ $label = 'CommandController Command. <em>Save and reopen to define command arguments</em>';
+ }
+ return $label;
+ }
+
+ /**
+ * Render a select field with name $name and options $options
+ *
+ * @param string $name
+ * @param array $options
+ * @param string $selectedOptionValue
+ * @return string
+ */
+ protected function renderSelectField($name, array $options, $selectedOptionValue) {
+ $html = array(
+ '<select name="tx_scheduler[task_extbase][' . htmlspecialchars($name) . ']">'
+ );
+ foreach ($options as $optionValue=>$optionLabel) {
+ $selected = $optionValue === $selectedOptionValue ? ' selected="selected"' : '';
+ array_push($html, '<option title="test" value="' . htmlspecialchars($optionValue) . '"' . $selected . '>' . htmlspecialchars($optionLabel) . '</option>');
+ }
+ array_push($html, '</select>');
+ return implode(LF, $html);
+ }
+
+ /**
+ * Renders a field for defining an argument's value
+ *
+ * @param Tx_Extbase_MVC_CLI_CommandArgumentDefinition $argument
+ * @param mixed $currentValue
+ * @return string
+ */
+ protected function renderField(Tx_Extbase_MVC_CLI_CommandArgumentDefinition $argument, $currentValue) {
+ $type = $this->getArgumentType($argument);
+ $name = $argument->getName();
+ $fieldName = 'tx_scheduler[task_extbase][arguments][' . htmlspecialchars($name) . ']';
+ if ($type === 'boolean') {
+ // checkbox field for boolean values.
+ $html = '<input type="hidden" name="' . $fieldName . '" value="0" />';
+ $html .= '<input type="checkbox" name="' . $fieldName . '" value="1" ' . ((boolean)$currentValue ? ' checked="checked"' : '') . '/>';
+ } else {
+ // regular string, also the default field type
+ $html = '<input type="text" name="' . $fieldName . '" value="' . htmlspecialchars($currentValue) . '" /> ';
+ }
+ return $html;
+ }
+
+}
+
+?>
--- /dev/null
+<?php
+/***************************************************************
+* Copyright notice
+*
+* (c) 2011 Claus Due, Wildside A/S <claus@wildside.dk>
+* 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.
+*
+* 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!
+***************************************************************/
+
+/**
+ * Scheduler task to execute CommandController commands
+ *
+ * @package Extbase
+ * @subpackage Scheduler
+ */
+class Tx_Extbase_Scheduler_Task extends Tx_Scheduler_Task {
+
+ /**
+ * @var string
+ */
+ protected $commandIdentifier;
+
+ /**
+ * @var array
+ */
+ protected $arguments = array();
+
+ /**
+ * @var array
+ */
+ protected $defaults = array();
+
+ /**
+ * @var Tx_Extbase_Object_ObjectManagerInterface
+ */
+ protected $objectManager;
+
+ /**
+ * @var Tx_Extbase_MVC_CLI_CommandManager
+ */
+ protected $commandManager;
+
+ /**
+ * @var Tx_Extbase_Scheduler_TaskExecutor
+ */
+ protected $taskExecutor;
+
+ /**
+ * Function execute from the Scheduler
+ *
+ * @return boolean TRUE on successful execution, FALSE on error
+ */
+ public function execute() {
+ $this->objectManager = t3lib_div::makeInstance('Tx_Extbase_Object_ObjectManager');
+ $this->commandManager = $this->objectManager->get('Tx_Extbase_MVC_CLI_CommandManager');
+ $this->taskExecutor = $this->objectManager->get('Tx_Extbase_Scheduler_TaskExecutor');
+ try {
+ $this->taskExecutor->execute($this);
+ return TRUE;
+ } catch (Exception $e) {
+ t3lib_div::sysLog($e->getMessage(), $this->commandIdentifier, 3);
+ return FALSE;
+ }
+ }
+
+ /**
+ * @param string $commandIdentifier
+ */
+ public function setCommandIdentifier($commandIdentifier) {
+ $this->commandIdentifier = $commandIdentifier;
+ }
+
+ /**
+ * @return string
+ */
+ public function getCommandIdentifier() {
+ return $this->commandIdentifier;
+ }
+
+ /**
+ * @param array $arguments
+ */
+ public function setArguments($arguments) {
+ $this->arguments = $arguments;
+ }
+
+ /**
+ * @return array
+ */
+ public function getArguments() {
+ return $this->arguments;
+ }
+
+ /**
+ * @param array $defaults
+ */
+ public function setDefaults(array $defaults) {
+ $this->defaults = $defaults;
+ }
+
+ /**
+ * @return array
+ */
+ public function getDefaults() {
+ return $this->defaults;
+ }
+
+ /**
+ * @param string $argumentName
+ * @param mixed $argumentValue
+ */
+ public function addDefaultValue($argumentName, $argumentValue) {
+ if (is_bool($argumentValue)) {
+ $argumentValue = intval($argumentValue);
+ }
+ $this->defaults[$argumentName] = $argumentValue;
+ }
+
+ /**
+ * Return a text representation of the selected command and arguments
+ *
+ * @return string Information to display
+ */
+ public function getAdditionalInformation() {
+ $label = $this->commandIdentifier;
+ if (count($this->arguments) > 0) {
+ $arguments = array();
+ foreach ($this->arguments as $argumentName=>$argumentValue) {
+ if ($argumentValue != $this->defaults[$argumentName]) {
+ array_push($arguments, $argumentName . '=' . $argumentValue);
+ }
+ }
+ $label .= ' ' . implode(', ', $arguments);
+ }
+ return $label;
+ }
+
+}
+
+?>
\ No newline at end of file
--- /dev/null
+<?php
+/***************************************************************
+* Copyright notice
+*
+* (c) 2011 Claus Due, Wildside A/S <claus@wildside.dk>
+* 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.
+*
+* 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!
+***************************************************************/
+
+/**
+ * Task Executor
+ *
+ * Takes a Tx_Extbase_Scheduler_Task and executes the CommandController command
+ * defined therein.
+ *
+ * @package Extbase
+ * @subpackage Scheduler
+ */
+class Tx_Extbase_Scheduler_TaskExecutor implements t3lib_Singleton {
+
+ /**
+ * @var Tx_Extbase_Object_ObjectManagerInterface
+ */
+ protected $objectManager;
+
+ /**
+ * @var Tx_Extbase_MVC_CLI_CommandManager
+ */
+ protected $commandManager;
+
+ /**
+ * @var Tx_Extbase_Configuration_ConfigurationManagerInterface
+ */
+ protected $configurationManager;
+
+ /**
+ * @param Tx_Extbase_Object_ObjectManager $objectManager
+ */
+ public function injectObjectManager(Tx_Extbase_Object_ObjectManager $objectManager) {
+ $this->objectManager = $objectManager;
+ }
+
+ /**
+ * @param Tx_Extbase_MVC_CLI_CommandManager $commandManager
+ */
+ public function injectCommandManager(Tx_Extbase_MVC_CLI_CommandManager $commandManager) {
+ $this->commandManager = $commandManager;
+ }
+
+ /**
+ * @param Tx_Extbase_Configuration_ConfigurationManagerInterface $configurationManager
+ */
+ public function injectConfigurationManager(Tx_Extbase_Configuration_ConfigurationManagerInterface $configurationManager) {
+ $this->configurationManager = $configurationManager;
+ }
+
+ /**
+ * Initializes configuration manager, object container and reflection service
+ *
+ * @param array $configuration
+ * @return void
+ */
+ protected function initialize(array $configuration) {
+ // initialize configuration
+ $this->configurationManager->setContentObject(t3lib_div::makeInstance('tslib_cObj'));
+ $this->configurationManager->setConfiguration($configuration);
+
+ // configure object container
+ $typoScriptSetup = $this->configurationManager->getConfiguration(Tx_Extbase_Configuration_ConfigurationManagerInterface::CONFIGURATION_TYPE_FULL_TYPOSCRIPT);
+ if (isset($typoScriptSetup['config.']['tx_extbase.']['objects.'])) {
+ $objectContainer = t3lib_div::makeInstance('Tx_Extbase_Object_Container_Container');
+ foreach ($typoScriptSetup['config.']['tx_extbase.']['objects.'] as $classNameWithDot => $classConfiguration) {
+ if (isset($classConfiguration['className'])) {
+ $originalClassName = rtrim($classNameWithDot, '.');
+ $objectContainer->registerImplementation($originalClassName, $classConfiguration['className']);
+ }
+ }
+ }
+
+ // initialize reflection
+ $reflectionService = $this->objectManager->get('Tx_Extbase_Reflection_Service');
+ $reflectionService->setDataCache($GLOBALS['typo3CacheManager']->getCache('extbase_reflection'));
+ if (!$reflectionService->isInitialized()) {
+ $reflectionService->initialize();
+ }
+ }
+
+ /**
+ * Execute Task
+ *
+ * If errors occur during Task execution they are thrown as Exceptions which
+ * must be caught manually if you manually execute Tasks through your code.
+ *
+ * @param Tx_Extbase_Scheduler_Task $task the task to execute
+ * @return void
+ */
+ public function execute(Tx_Extbase_Scheduler_Task $task) {
+ $commandIdentifier = $task->getCommandIdentifier();
+ list ($extensionKey, $controllerName, $commandName) = explode(':', $commandIdentifier);
+ $extensionName = t3lib_div::underscoredToUpperCamelCase($extensionKey);
+ $this->initialize(array('extensionName' => $extensionName));
+
+ $request = $this->objectManager->create('Tx_Extbase_MVC_CLI_Request');
+ $dispatcher = $this->objectManager->get('Tx_Extbase_MVC_Dispatcher');
+ $response = $this->objectManager->create('Tx_Extbase_MVC_CLI_Response');
+
+ // execute command
+ $command = $this->commandManager->getCommandByIdentifier($commandIdentifier);
+ $request->setControllerObjectName($command->getControllerClassName());
+ $request->setControllerCommandName($command->getControllerCommandName());
+ $request->setArguments($task->getArguments());
+ $dispatcher->dispatch($request, $response);
+
+ $this->shutdown();
+ }
+
+ /**
+ * Resets framework singletons
+ *
+ * @return void
+ */
+ protected function shutdown() {
+ // shutdown
+ $persistenceManager = $this->objectManager->get('Tx_Extbase_Persistence_Manager');
+ $persistenceManager->persistAll();
+ $reflectionService = $this->objectManager->get('Tx_Extbase_Reflection_Service');
+ $reflectionService->shutdown();
+ }
+
+}
+
+?>
\ No newline at end of file
projects / Packages / TYPO3.CMS.git / commitdiff