"TYPO3 4.0.1: typo3_src-4.0.1/t3lib/class.t3lib_svbase.php Source File", "datetime" => "Sat Dec 2 19:22:19 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

class.t3lib_svbase.php

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2005 Kasper Skaarhoj (kasperYYYY@typo3.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!
***************************************************************/
define ('T3_ERR_SV_GENERAL', -1); // General error - something went wrong
define ('T3_ERR_SV_NOT_AVAIL', -2); // During execution it showed that the service is not available and should be ignored. The service itself should call $this->setNonAvailable()
define ('T3_ERR_SV_WRONG_SUBTYPE', -3); // passed subtype is not possible with this service
define ('T3_ERR_SV_NO_INPUT', -4); // passed subtype is not possible with this service


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 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

// 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');






class t3lib_svbase {

        var $info=array();

        var $error=array();

        var $writeDevLog = false;


        var $out = '';

        var $inputFile = '';

        var $inputContent = '';

        var $inputType = '';

        var $outputFile = '';


        var $tempFiles = array();



        /***************************************
         *
         *       Get service meta information
         *
         ***************************************/


        function getServiceInfo() {
                return $this->info;
        }


        function getServiceKey() {
                return $this->info['serviceKey'];
        }


        function getServiceTitle() {
                return $this->info['title'];
        }


        function getServiceOption($optionName, $defaultValue='', $includeDefaultConfig=TRUE) {
                global $TYPO3_CONF_VARS;

                $config = NULL;

                $svOptions = $TYPO3_CONF_VARS['SVCONF'][$this->info['serviceType']];

                if(isset($svOptions[$this->info['serviceKey']][$optionName])) {
                        $config = $svOptions[$this->info['serviceKey']][$optionName];
                } elseif($includeDefaultConfig AND isset($svOptions['default'][$optionName])) {
                        $config = $svOptions['default'][$optionName];
                }
                if(!isset($config)) {
                        $config = $defaultValue;
                }
                return $config;
        }



        /***************************************
         *
         *       Error handling
         *
         ***************************************/


        function devLog($msg, $severity=0, $dataVar=FALSE) {
                if($this->writeDevLog) {
                        t3lib_div::devLog($msg, $this->info['serviceKey'], $severity, $dataVar);
                }
        }


        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'])) {
                        $GLOBALS['TT']->setTSlogMessage($errMsg,2);
                }

        }


        function errorPull() {
                array_pop($this->error);

                // pop for $GLOBALS['TT']->setTSlogMessage is not supported
        }


        function getLastError() {
                if(count($this->error)) {
                        $error = end($this->error);
                        return $error['nr'];
                } else {
                        return TRUE; // means all is ok - no error
                }
        }


        function getLastErrorMsg() {
                if(count($this->error)) {
                        $error = end($this->error);
                        return $error['msg'];
                } else {
                        return '';
                }
        }


        function getErrorMsgArray() {
                $errArr = array();

                if(count($this->error)) {
                        reset($this->error);
                        foreach($this->error as $error) {
                                $errArr[] = $error['msg'];
                        }
                }
                return $errArr;
        }


        function getLastErrorArray() {
                return end($this->error);
        }

        function resetErrors() {
                $this->error=array();
        }



        /***************************************
         *
         *       General service functions
         *
         ***************************************/



        function checkExec($progList) {
                global $T3_VAR, $TYPO3_CONF_VARS;

                $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)) {
                                        // program not found
                                $this->errorPush('External program not found: '.$prog, T3_ERR_SV_PROG_NOT_FOUND);
                                $ret = FALSE;
                        }
                }
                return $ret;
        }


        function deactivateService() {
                t3lib_extMgm::deactivateService($this->info['serviceType'], $this->info['serviceKey']);
        }









        /***************************************
         *
         *       IO tools
         *
         ***************************************/



        function checkInputFile ($absFile)      {
                if(t3lib_div::isAllowedAbsPath($absFile) && @is_file($absFile)) {
                        if(@is_readable($absFile)) {
                                return $absFile;
                        } else {
                                $this->errorPush(T3_ERR_SV_FILE_READ, 'File is not readable: '.$absFile);
                        }
                } else {
                        $this->errorPush(T3_ERR_SV_FILE_NOT_FOUND, 'File not found: '.$absFile);
                }
                return FALSE;
        }


        function readFile ($absFile, $length=0) {
                $out = FALSE;

                if ($this->checkInputFile ($absFile)) {
                        if ($fd = fopen ($absFile, 'rb')) {
                                $length = intval($length) ? intval($length) : filesize ($absFile);
                                if ($length > 0) {
                                        $out = fread ($fd, $length);
                                }
                                fclose ($fd);
                        } else {
                                $this->errorPush(T3_ERR_SV_FILE_READ, 'Can not read from file: '.$absFile);
                        }
                }
                return $out;
        }


        function writeFile ($content, $absFile='')      {
                $ret = TRUE;

                if (!$absFile) {
                        $absFile = $this->tempFile($this->prefixId);
                }

                if($absFile && t3lib_div::isAllowedAbsPath($absFile)) {
                        if ($fd = @fopen($absFile,'wb')) {
                                @fwrite($fd, $content);
                                @fclose($fd);
                        } else {
                                $this->errorPush(T3_ERR_SV_FILE_WRITE, 'Can not write to file: '.$absFile);
                                $absFile = FALSE;
                        }
                }

                return $absFile;
        }

        function tempFile ($filePrefix) {
                $absFile = t3lib_div::tempnam($filePrefix);
                if($absFile) {
                        $ret = TRUE;
                        $this->registerTempFile ($absFile);
                } else {
                        $ret = FALSE;
                        $this->errorPush(T3_ERR_SV_FILE_WRITE, 'Can not create temp file.');
                }
                return ($ret ? $absFile : FALSE);
        }

        function registerTempFile ($absFile)    {
                $this->tempFiles[] = $absFile;
        }

        function unlinkTempFiles ()     {
                foreach ($this->tempFiles as $absFile) {
                        t3lib_div::unlink_tempfile($absFile);
                }
                $this->tempFiles = array();
        }


        /***************************************
         *
         *       IO input
         *
         ***************************************/


        function setInput ($content, $type='') {
                $this->inputContent = $content;
                $this->inputFile = '';
                $this->inputType = $type;
        }


        function setInputFile ($absFile, $type='') {
                $this->inputContent = '';
                $this->inputFile = $absFile;
                $this->inputType = $type;
        }


        function getInput () {
                if ($this->inputContent=='') {
                        $this->inputContent = $this->readFile($this->inputFile);
                }
                return $this->inputContent;
        }


        function getInputFile ($createFile='') {
                if($this->inputFile) {
                        $this->inputFile = $this->checkInputFile($this->inputFile);
                } elseif ($this->inputContent) {
                        $this->inputFile = $this->writeFile($this->inputContent, $createFile);
                }
                return $this->inputFile;
        }




        /***************************************
         *
         *       IO output
         *
         ***************************************/


        function setOutputFile ($absFile) {
                $this->outputFile = $absFile;
        }


        function getOutput () {
                if ($this->outputFile) {
                        $this->out = $this->readFile($this->outputFile);
                }
                return $this->out;
        }


        function getOutputFile ($absFile='') {
                if (!$this->outputFile) {
                        $this->outputFile = $this->writeFile($this->out, $absFile);
                }
                return $this->outputFile;
        }




        /***************************************
         *
         *       Service implementation
         *
         ***************************************/

        function init() {
                // 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']
                if (trim($this->info['exec'])) {
                        if (!$this->checkExec($this->info['exec'])) {
                                // nothing todo here or?
                        }
                }

                return $this->getLastError();
        }


        function reset()        {
                $this->unlinkTempFiles();
                $this->resetErrors();
                $this->out = '';
                $this->inputFile = '';
                $this->inputContent = '';
                $this->inputType = '';
                $this->outputFile = '';
        }

        function __destruct() {
                $this->unlinkTempFiles();
        }


        /* every service type has it's own API
        function process($content='', $type='', $conf=array())  {       //
        }
        */

}

?>