File vendors/shells/bedita_base.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304

<?php 
/*-----8<--------------------------------------------------------------------
 * 
 * BEdita - a semantic content management framework
 * 
 * Copyright 2009 ChannelWeb Srl, Chialab Srl
 * 
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published 
 * by the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License 
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 * 
 *------------------------------------------------------------------->8-----
 */

App::import('Lib', 'BeLib');

/**
 * Base class for bedita shell scripts: provides common filesystem related methods.
 */
class BeditaBaseShell extends Shell {

    /**
     * Verbose mode.
     */
    private $verbose = false;

    /**
     * Debug mode.
     */
    private $debug = false;

    /**
     * Call parent::__construct and set up exception handler
     *
     * @param ShellDispatcher $dispatch
     */
    public function __construct($dispatch) {
        parent::__construct($dispatch);
        set_exception_handler(array($this, 'handleExceptions'));
    }

    /**
     * Handle Exceptions
     *
     * @param Exception $exception
     * @return void
     */
    public function handleExceptions(Exception $exception) {
        $shellMethod = ' - shell ' . $this->name . '::' . $this->command;
        $this->log($exception->getMessage() . $shellMethod, 'error');
        if ($exception instanceof BeditaException) {
            $errorTrace = $exception->errorTrace();
        } else {
            $errorTrace = get_class($exception) . ' - ' . $exception->getMessage()
            . " \nFile: " . $exception->getFile() . ' - line: ' . $exception->getLine()
            . " \nTrace:\n" . $exception->getTraceAsString();
        }
        $this->log($errorTrace, 'exception');
        $this->error($exception->getMessage());
    }

    /**
     * Initializes the Shell
     * Setup self::verbose param
     */
    public function initialize() {
        parent::initialize();
        // verbose mode.
        if (array_key_exists('verbose', $this->params) || array_key_exists('-verbose', $this->params)) {
            $this->verbose = true;
            $this->debug = true;
        }
        if (array_key_exists('debug', $this->params) || array_key_exists('-debug', $this->params)) {
            $this->debug = true;
        }
    }

    /**
     * Init configuration for all bedita shells, called in startup()
     */
    protected function initConfig() {
        // load cached configurations
        BeLib::getObject("BeConfigure")->initConfig();
    }

    /**
     * Default shell startup, call initConfig (may raise db/model errors!), to override
     * in subclasses
     * @see Shell::startup()
     */
    function startup() {
        $this->initConfig();
        // default debug = 1, only if debug or verbose options are set
        if ($this->debug) {
            Configure::write('debug', 1);
        }
        $this->Dispatch->clear();
    }

    function help() {
        $this->out('  Default parameters:');
        $this->out("    --verbose\tVerbose output");
    }

    public function title($title) {
        $this->out();
        $this->hr();
        $this->out(' ' . strtoupper($title));
        $this->hr();
        $this->out();
    }
    
    protected function check_sys_get_temp_dir() {
        if ( !function_exists('sys_get_temp_dir') ) {
            // Based on http://www.phpit.net/
            // article/creating-zip-tar-archives-dynamically-php/2/
            function sys_get_temp_dir()
            {
                // Try to get from environment variable
                if ( !empty($_ENV['TMP']) )
                {
                    return realpath( $_ENV['TMP'] );
                }
                else if ( !empty($_ENV['TMPDIR']) )
                {
                    return realpath( $_ENV['TMPDIR'] );
                }
                else if ( !empty($_ENV['TEMP']) )
                {
                    return realpath( $_ENV['TEMP'] );
                }
        
                // Detect by creating a temporary file
                else
                {
                    // Try to use system's temporary directory
                    // as random name shouldn't exist
                    $temp_file = tempnam( md5(uniqid(rand(), TRUE)), '' );
                    if ( $temp_file )
                    {
                        $temp_dir = realpath( dirname($temp_file) );
                        unlink( $temp_file );
                        return $temp_dir;
                    }
                    else
                    {
                        return FALSE;
                    }
                }
            }
        }
    }

    protected function setupTempDir() {
        $basePath = sys_get_temp_dir().DS."bedita-shell-tmp".DS;
        if(!is_dir($basePath)) {
            if(!mkdir($basePath))
                throw new Exception("Error creating temp dir: ".$basePath);
        } else {
            $this->__clean($basePath);
        }
        return $basePath;
    }

    protected function cleanTempDir() {
        $exportPath = sys_get_temp_dir().DS."bedita-shell-tmp".DS;
        $folder= new Folder();
        if(!$folder->delete($exportPath)) {
            throw new Exception("Error deleting dir $exportPath");
        }
    }
    
    /**
     * Read mandatory shell argument ($opt), 
     * exit with err message if parameter not present
     *
     * @param unknown_type $opt
     * @param unknown_type $errMsg
     */
    protected function mandatoryArgument($opt, $errMsg) {
        if (isset($this->params[$opt])) {
            return $this->params[$opt];
        } else {
            $this->error("Missing parameters" , $errMsg);
        }
    } 
   
    /**
     * Read shell input argument from file, 
     * through reerved argument -input
     * input file in "properties" form:
     * 
     * param1=value
     * param2=value
     */
    protected function readInputArgs() {
        if (isset($this->params["input"])) {
            $inFile = $this->params["input"];
            if(file_exists($inFile)) {
                $this->out("Read shell arguments from file $inFile");
                $ini = parse_ini_file($inFile);
                foreach ($ini as $k => $v) {
                    $this->params[$k] = $v;
                }
            }
        }
    }
    
    public function test() {
        pr($this->params);
        pr($this->args);
    }

    protected function checkExportFile($expFile) {
        if (file_exists($expFile)) {
            $res = $this->in("$expFile exists, overwrite? [y/n]");
            if($res == 'y') {
                if(!unlink($expFile)){
                    throw new Exception("Error deleting $expFile");
                }
            } else {
                $this->out('Export aborted. Bye.');
                exit;
            }
        }
    }

    protected function isUrl($str) {
        return filter_var($str, FILTER_VALIDATE_URL);
    }

    protected function checkUrl($url) {
        $headers = @get_headers($url);
        if (strpos($headers[0], '404')) {
            $this->out('Url not found');
            exit;
        } else {
            $this->out('Url ok');
        }
    }

    protected function checkDir($dir) {
        if (!file_exists($dir)) {
            $res = $this->in("$dir doesn't exist, create? [y/n]");
            if($res == 'y') {
                if(!mkdir($dir)){
                    throw new Exception("Error creating $dir");
                }
            } else {
                $this->out('Operation aborted. Bye.');
                exit;
            }
        } elseif (!is_dir($dir)) {
            $this->out("$dir is not a directory. Exiting.");
            exit;
        }
    }

    protected function __clean($path, $removeDirs=true) {
        
        $folder = new Folder($path);
        $list = $folder->read();

        if($removeDirs) {
            foreach ($list[0] as $d) {
                if($d[0] != '.') { // don't delete hidden dirs (.svn,...)
                    if(!$folder->delete($folder->path.DS.$d)) {
                        throw new Exception("Error deleting dir $d");
                    }
                }
            }
        }
        foreach ($list[1] as $f) {
            $file = new File($folder->path.DS.$f);
            if(!$file->delete()) {
                throw new Exception("Error deleting file $f");
            }
        }
        return ;
    }

    /**
     * Verbose output.
     *
     * @param string Message.
     * @param integer New-lines.
     * @see Shell::out()
     */
    protected function verbose($message = null, $newlines = 1) {
        if (!$this->verbose) {
            return;
        }

        return $this->out($message, $newlines);
    }
}

Classes

Interfaces

Exceptions