New shell script: Templater

README.md

@@ -18,9 +18,10 @@ The Tools
 
  - **cache**: All functionality that exists in the admin cache management panel. Plus some more!
    Really useful in deployment scripts.
- - **snapshot**: Create a compressed tar archive of the /media directory and a database dump into 
-   a directory called /snapshot.  Useful for developers bootstrapping their local environments off 
+ - **snapshot**: Create a compressed tar archive of the /media directory and a database dump into
+   a directory called /snapshot.  Useful for developers bootstrapping their local environments off
    of an existing development environment.
+ - **templater**: Copy template files to current package and theme (for modification).
  - More to be added...
 
 Usage
@@ -42,7 +43,7 @@ Here's example help output from the cache tool:
       help                          This help.
 
       <cachetype>     Comma separated cache codes or value "all" for all caches
-    
+
 
 Requirements
 -------------------

shell/templater.php

@@ -0,0 +1,132 @@
+<?php
+/**
+ * Magento Templater Shell Script
+ *
+ * @category    Mage
+ * @package     Mage_Shell
+ * @copyright   Copyright (c) 2013 Erik Eng <[email protected]>
+ */
+
+require_once 'abstract.php';
+
+/**
+ * Magento Templater Shell Script
+ *
+ * @category    Mage
+ * @package     Mage_Shell
+ * @author      Erik Eng <[email protected]>
+ */
+class Mage_Shell_Templater extends Mage_Shell_Abstract
+{
+
+    /**
+     * Initialize application and parse input parameters
+     *
+     */
+    public function __construct()
+    {
+        if ($this->_includeMage) {
+            require_once $this->_getRootPath() . 'app' . DIRECTORY_SEPARATOR . 'Mage.php';
+            Mage::app(Mage::app()->getStore(1)->getCode(), $this->_appType);
+        }
+
+        $this->_applyPhpVariables();
+        $this->_parseArgs();
+        $this->_construct();
+        $this->_validate();
+        $this->_showHelp();
+    }
+
+    /**
+     * Copy Template
+     *
+     * @var string $templatePath
+     */
+    private function _copyTemplate($templatePath) {
+        $source   = Mage::getBaseDir('design').'/'.$templatePath;
+        $template = end(explode('template/', $templatePath));
+        $dest     = Mage::getDesign()->getTemplateFilename().$template;
+
+        // TODO: Warn if dest already exists
+
+        if(file_exists($source)) {
+            echo 'Copying template "'.$template.'" to current package and theme.', "\n";
+            echo 'Source:       ', $source, "\n";
+            echo 'Destination:  ', $dest, "\n";
+
+            // Create destination dirs if not exists
+            $path = '';
+            $dirs = array_filter(explode('/', $dest));
+            array_pop($dirs);
+            foreach($dirs as $dir) {
+                $path = $path.'/'.$dir;
+                if(!is_dir($path) && !file_exists($path)) {
+                    mkdir($path);
+                }
+            }
+
+            copy($source, $dest);
+            if(!file_exists($dest)) {
+                echo 'Error:    Could not copy template.', "\n";
+            }
+        }
+        else {
+            echo 'Error:  Template path don\'t exists', "\n",
+                '   ', $source, "\n";
+        }
+    }
+
+    /**
+     * Validate Template Path
+     *
+     * @var string $templatePath
+     */
+    private function _validateTemplatePath($templatePath) {
+
+    }
+
+    /**
+     * Run script
+     *
+     */
+    public function run()
+    {
+        if($this->getArg('info')) {
+            echo 'Package "'.Mage::getDesign()->getPackageName().'"',
+                ' with theme "'.Mage::getDesign()->getTheme().'".', "\n";
+            echo 'Skin path:     ', Mage::getDesign()->getSkinBaseDir(), "\n";
+            echo 'Template path: ', Mage::getDesign()->getTemplateFilename(), "\n";
+        }
+        elseif($this->getArg('copy')) {
+            $templatePath = end($_SERVER['argv']);
+            if($templatePath && $templatePath !== 'copy') {
+                $this->_copyTemplate($templatePath);
+            }
+            else {
+                echo 'Error:  No template path supplied', "\n",
+                    'Usage:  php -f templater.php -- copy <path>', "\n";
+            }
+        }
+    }
+
+    /**
+     * Retrieve Usage Help Message
+     *
+     */
+    public function usageHelp()
+    {
+        return <<<USAGE
+Usage:  php -f templater.php -- [options]
+
+  info           Show current package and theme
+  copy <path>    Copy template to current package and theme
+  help           This help
+
+  <path>         Full template path (from path hints)
+
+USAGE;
+    }
+}
+
+$shell = new Mage_Shell_Templater();
+$shell->run();