Fixed bug #15092: Ajax loaded items of inline records are encoded twice (Thanks to...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_svbase.php
old mode 100755 (executable)
new mode 100644 (file)
index 170af94..46fc274
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *
-*  (c) 1999-2004 Kasper Skaarhoj (kasper@typo3.com)
+*  (c) 1999-2010 Kasper Skaarhoj (kasperYYYY@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the Typo3 project. The Typo3 project is
  * $Id$
  * TODO: temp files are not removed
  *
- * @author     René Fritz <r.fritz@colorcube.de>
+ * @author     Rene Fritz <r.fritz@colorcube.de>
  */
 /**
  * [CLASS/FUNCTION INDEX of SCRIPT]
  *
  *
  *
- *  121: class t3lib_svbase
+ *  125: class t3lib_svbase
  *
  *              SECTION: Get service meta information
- *  175:     function getServiceInfo()
- *  183:     function getServiceKey()
- *  191:     function getServiceTitle()
+ *  191:     function getServiceInfo()
+ *  201:     function getServiceKey()
+ *  211:     function getServiceTitle()
+ *  224:     function getServiceOption($optionName, $defaultValue='', $includeDefaultConfig=TRUE)
  *
  *              SECTION: Error handling
- *  212:     function errorPush($errNum=T3_ERR_SV_GENERAL, $errMsg='Unspecified error occured')
- *  227:     function errorPull()
- *  239:     function getLastError()
- *  254:     function getLastErrorMsg()
- *  269:     function getErrorMsgArray()
- *  287:     function getLastErrorArray()
- *  296:     function resetErrors()
+ *  259:     function devLog($msg, $severity=0, $dataVar=FALSE)
+ *  273:     function errorPush($errNum=T3_ERR_SV_GENERAL, $errMsg='Unspecified error occured')
+ *  288:     function errorPull()
+ *  300:     function getLastError()
+ *  315:     function getLastErrorMsg()
+ *  330:     function getErrorMsgArray()
+ *  348:     function getLastErrorArray()
+ *  357:     function resetErrors()
  *
  *              SECTION: General service functions
- *  316:     function checkExec($progList)
- *  338:     function deactivateService()
- *  344:     function available()
+ *  377:     function checkExec($progList)
+ *  401:     function deactivateService()
  *
  *              SECTION: IO tools
- *  382:     function checkInputFile ($absFile)
- *  403:     function readFile ($absFile, $length=0)
- *  426:     function writeFile ($content, $absFile='')
+ *  427:     function checkInputFile ($absFile)
+ *  448:     function readFile ($absFile, $length=0)
+ *  473:     function writeFile ($content, $absFile='')
+ *  499:     function tempFile ($filePrefix)
+ *  517:     function registerTempFile ($absFile)
+ *  527:     function unlinkTempFiles ()
  *
  *              SECTION: IO input
- *  467:     function setInput ($content, $type='')
- *  481:     function setInputFile ($absFile, $type='')
- *  494:     function getInput ()
- *  509:     function getInputFile ($absFile='')
+ *  549:     function setInput ($content, $type='')
+ *  563:     function setInputFile ($absFile, $type='')
+ *  576:     function getInput ()
+ *  591:     function getInputFile ($createFile='')
  *
  *              SECTION: IO output
- *  534:     function setOutputFile ($absFile)
- *  544:     function getOutput ()
- *  558:     function getOutputFile ($absFile='')
+ *  616:     function setOutputFile ($absFile)
+ *  626:     function getOutput ()
+ *  640:     function getOutputFile ($absFile='')
  *
  *              SECTION: Service implementation
- *  582:     function init()
- *  601:     function reset()
- *  612:     function process($content='', $type='', $conf=array())
+ *  664:     function init()
+ *  688:     function reset()
+ *  703:     function __destruct()
  *
- * TOTAL FUNCTIONS: 26
+ * TOTAL FUNCTIONS: 30
  * (This index is automatically created/updated by the extension "extdeveval")
  *
  */
@@ -96,7 +100,7 @@ define ('T3_ERR_SV_NO_INPUT', -4); // passed subtype is not possible with this s
 
 define ('T3_ERR_SV_FILE_NOT_FOUND', -20); // File not found which the service should process
 define ('T3_ERR_SV_FILE_READ', -21); // File not readable
-define ('T3_ERR_SV_FILE_WRITE', -22); // File not writeable
+define ('T3_ERR_SV_FILE_WRITE', -22); // File not writable
 
 define ('T3_ERR_SV_PROG_NOT_FOUND', -40); // passed subtype is not possible with this service
 define ('T3_ERR_SV_PROG_FAILED', -41); // passed subtype is not possible with this service
@@ -104,7 +108,6 @@ define ('T3_ERR_SV_PROG_FAILED', -41); // passed subtype is not possible with th
 // define ('T3_ERR_SV_serviceType_myerr, -100); // All errors with prefix T3_ERR_SV_[serviceType]_ and lower than -99 are service type dependent error
 
 
-require_once(PATH_t3lib.'class.t3lib_exec.php');
 
 
 
@@ -114,11 +117,11 @@ require_once(PATH_t3lib.'class.t3lib_exec.php');
 /**
  * Parent class for "Services" classes
  *
- * @author     René Fritz <r.fritz@colorcube.de>
+ * @author     Rene Fritz <r.fritz@colorcube.de>
  * @package TYPO3
  * @subpackage t3lib
  */
-class t3lib_svbase {
+abstract class t3lib_svbase {
 
        /**
         * service description array
@@ -162,15 +165,15 @@ class t3lib_svbase {
         */
        var $outputFile = '';
 
-        
+
        /**
         * Temporary files which have to be deleted
         *
         * @private
         */
        var $tempFiles = array();
-        
-        
+
+
 
        /***************************************
         *
@@ -180,6 +183,8 @@ class t3lib_svbase {
 
 
        /**
+        * Returns internal information array for service
+        *
         * @return      array           service description array
         */
        function getServiceInfo() {
@@ -188,6 +193,8 @@ class t3lib_svbase {
 
 
        /**
+        * Returns the service key of the service
+        *
         * @return      string          service key
         */
        function getServiceKey() {
@@ -196,6 +203,8 @@ class t3lib_svbase {
 
 
        /**
+        * Returns the title of the service
+        *
         * @return      string          service title
         */
        function getServiceTitle() {
@@ -207,19 +216,17 @@ class t3lib_svbase {
         * Returns service configuration values from the $TYPO3_CONF_VARS['SVCONF'] array
         *
         * @param       string          Name of the config option
-        * @return      mixed           Default configuration value for the service. Will be returned if no value found.
         * @param       boolean         If set the 'default' config will be return if no special config for this service is available (default: true)
-        * @return      mixed           configuration value for the service 
+        * @param       [type]          $includeDefaultConfig: ...
+        * @return      mixed           configuration value for the service
         */
        function getServiceOption($optionName, $defaultValue='', $includeDefaultConfig=TRUE) {
-               global $TYPO3_CONF_VARS;
-               
                $config = NULL;
-               
-               $svOptions = $TYPO3_CONF_VARS['SVCONF'][$this->info['serviceType']];
-               
+
+               $svOptions = $GLOBALS['TYPO3_CONF_VARS']['SVCONF'][$this->info['serviceType']];
+
                if(isset($svOptions[$this->info['serviceKey']][$optionName])) {
-                       $config = $svOptions['default'][$optionName];
+                       $config = $svOptions[$this->info['serviceKey']][$optionName];
                } elseif($includeDefaultConfig AND isset($svOptions['default'][$optionName])) {
                        $config = $svOptions['default'][$optionName];
                }
@@ -241,7 +248,7 @@ class t3lib_svbase {
        /**
         * Logs debug messages to t3lib_div::devLog()
         *
-        * @param       string          Debug message
+        * @param       string          Debug message
         * @param       integer         Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
         * @param       array           Additional data you want to pass to the logger.
         * @return      void
@@ -251,8 +258,8 @@ class t3lib_svbase {
                        t3lib_div::devLog($msg, $this->info['serviceKey'], $severity, $dataVar);
                }
        }
-       
-       
+
+
        /**
         * Puts an error on the error stack. Calling without parameter adds a general error.
         *
@@ -263,7 +270,7 @@ class t3lib_svbase {
        function errorPush($errNum=T3_ERR_SV_GENERAL, $errMsg='Unspecified error occured') {
                array_push($this->error, array('nr'=>$errNum, 'msg'=>$errMsg));
 
-               if (is_object($GLOBALS["TT"])) {
+               if (is_object($GLOBALS['TT'])) {
                        $GLOBALS['TT']->setTSlogMessage($errMsg,2);
                }
 
@@ -367,8 +374,6 @@ class t3lib_svbase {
        function checkExec($progList) {
                $ret = TRUE;
 
-               require_once(PATH_t3lib.'class.t3lib_exec.php');
-
                $progList = t3lib_div::trimExplode(',', $progList, 1);
                foreach($progList as $prog) {
                        if (!t3lib_exec::checkCommand($prog)) {
@@ -391,29 +396,11 @@ class t3lib_svbase {
        }
 
 
-/**
-function available()   {
-       global $AB,$BE_USER,$LANG,$BACK_PATH,$TCA_DESCR,$TCA,$CLIENT,$TYPO3_CONF_VARS;
 
-       // check if the service is available at runtime
-       // the sense of this method is that the service might need some more information to check the availablity
 
-       / *
 
-       $excludeServiceKeys='';
-       while (is_object($serviceObj = t3lib_div::makeInstanceService('anyService','', $excludeServiceKeys))) {
-               if ($serviceObj->available('some special parm to check availablity')) {
-                       break;
-               }
-               $excludeServiceKeys .= ','.$serviceObj->getServiceKey;
-               unset($serviceObj);
-       }
 
-       * /
 
-       return TRUE;
-}
-*/
 
 
        /***************************************
@@ -431,7 +418,7 @@ function available()        {
         * @return      string          File name or FALSE.
         */
        function checkInputFile ($absFile)      {
-               if(@is_file($absFile)) {
+               if(t3lib_div::isAllowedAbsPath($absFile) && @is_file($absFile)) {
                        if(@is_readable($absFile)) {
                                return $absFile;
                        } else {
@@ -454,12 +441,9 @@ function available()       {
        function readFile ($absFile, $length=0) {
                $out = FALSE;
 
-               if ($this->checkInputFile ($absFile)) {
-                       if ($fd = fopen ($absFile, 'rb')) {
-                               $length = intval($length) ? intval($length) : filesize ($absFile);
-                               $out = fread ($fd, $length);
-                               fclose ($fd);
-                       } else {
+               if ($this->checkInputFile($absFile)) {
+                       $out = file_get_contents($absFile);
+                       if ($out===FALSE)       {
                                $this->errorPush(T3_ERR_SV_FILE_READ, 'Can not read from file: '.$absFile);
                        }
                }
@@ -481,7 +465,7 @@ function available()        {
                        $absFile = $this->tempFile($this->prefixId);
                }
 
-               if($absFile) {
+               if($absFile && t3lib_div::isAllowedAbsPath($absFile)) {
                        if ($fd = @fopen($absFile,'wb')) {
                                @fwrite($fd, $content);
                                @fclose($fd);
@@ -496,7 +480,7 @@ function available()        {
 
        /**
         * Create a temporary file.
-        * 
+        *
         * @param       string          File prefix.
         * @return      string          File name or FALSE
         */
@@ -514,17 +498,17 @@ function available()      {
 
        /**
         * Register file which should be deleted afterwards.
-        * 
+        *
         * @param       string          File name with absolute path.
         * @return      void
         */
        function registerTempFile ($absFile)    {
                $this->tempFiles[] = $absFile;
        }
-       
+
        /**
         * Delete registered temporary files.
-        * 
+        *
         * @param       string          File name with absolute path.
         * @return      void
         */
@@ -533,9 +517,9 @@ function available()        {
                        t3lib_div::unlink_tempfile($absFile);
                }
                $this->tempFiles = array();
-       }       
-       
-       
+       }
+
+
        /***************************************
         *
         *       IO input
@@ -546,9 +530,9 @@ function available()        {
        /**
         * Set the input content for service processing.
         *
-        * @param       mixed
-        * @param       [type]          $type: ...
-        * @return      [type]          ...
+        * @param       mixed           Input content (going into ->inputContent)
+        * @param       string          The type of the input content (or file). Might be the same as the service subtypes.
+        * @return      void
         */
        function setInput ($content, $type='') {
                $this->inputContent = $content;
@@ -561,8 +545,8 @@ function available()        {
         * Set the input file name for service processing.
         *
         * @param       string          file name
-        * @param       [type]          $type: ...
-        * @return      [type]          ...
+        * @param       string          The type of the input content (or file). Might be the same as the service subtypes.
+        * @return      void
         */
        function setInputFile ($absFile, $type='') {
                $this->inputContent = '';
@@ -573,7 +557,7 @@ function available()        {
 
        /**
         * Get the input content.
-        * Will be read from input file if needed.
+        * Will be read from input file if needed. (That is if ->inputContent is empty and ->inputFile is not)
         *
         * @return      mixed
         */
@@ -615,7 +599,7 @@ function available()        {
         * Set the output file name.
         *
         * @param       string          file name
-        * @return      [type]          ...
+        * @return      void
         */
        function setOutputFile ($absFile) {
                $this->outputFile = $absFile;
@@ -636,9 +620,9 @@ function available()        {
 
 
        /**
-        * Get the output file name.
+        * Get the output file name. If no output file is set, the ->out buffer is written to the file given by input parameter filename
         *
-        * @param       [type]          $absFile: ...
+        * @param       string          Absolute filename to write to
         * @return      mixed
         */
        function getOutputFile ($absFile='') {
@@ -669,7 +653,7 @@ function available()        {
                // do not work :-(  but will not hurt
                register_shutdown_function(array(&$this, '__destruct'));
                // look in makeInstanceService()
-               
+
                $this->reset();
 
                        // check for external programs which are defined by $info['exec']
@@ -679,7 +663,7 @@ function available()        {
                        }
                }
 
-               return $this->getLastError();
+               return ($this->getLastError() === true);
        }
 
 
@@ -701,16 +685,16 @@ function available()      {
 
        /**
         * Clean up the service.
-        * 
-        * @return      void            
+        *
+        * @return      void
         */
        function __destruct() {
                $this->unlinkTempFiles();
        }
-       
-       
+
+
        /* every service type has it's own API
-       function process($content='', $type='', $conf=array())  {
+       function process($content='', $type='', $conf=array())  {       //
        }
        */