Ticket #23: ConcatTask.php

<?php
/*
 *  $Id: CopyTask.php,v 1.16 2005/10/05 20:23:22 hlellelid Exp $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */
 
require_once 'phing/Task.php';
include_once 'phing/system/io/PhingFile.php';
include_once 'phing/util/FileUtils.php';
include_once 'phing/util/SourceFileScanner.php';
include_once 'phing/mappers/IdentityMapper.php';
include_once 'phing/mappers/FlattenMapper.php';

/**
 * A phing copy task.  Copies a file or directory to a new file
 * or directory.  Files are only copied if the source file is newer
 * than the destination file, or when the destination file does not
 * exist. It is possible to explictly overwrite existing files.
 *
 * @author   Andreas Aderhold, andi@binarycloud.com
 * @version  $Revision: 1.16 $ $Date: 2005/10/05 20:23:22 $
 * @package  phing.tasks.system
 */
class ConcatTask extends Task {
    
    protected $destfile      = null;   // the destiantion file (from xml attribute)
    protected $force         = true;   // destiantion file should be written even if it is newser than all source files.
    protected $append         = false;  // append to destfile    
    protected $mapperElement = null;

    protected $fileCopyMap   = array(); // asoc array containing mapped file names
    protected $dirCopyMap    = array(); // asoc array containing mapped file names
    protected $fileUtils     = null;    // a instance of fileutils
    protected $filesets      = array(); // all fileset objects assigned to this task
    protected $filterChains  = array(); // all filterchains objects assigned to this task

    protected $verbosity     = PROJECT_MSG_VERBOSE;

    /**
     * Sets up this object internal stuff. i.e. the Fileutils instance
     *
     * @return object   The CopyTask instnace
     * @access public
     */
    function __construct() {
        $this->fileUtils = new FileUtils();
    }

    /**
     * Set the force flag. IntrospectionHelper takes care of
     * booleans in set* methods so we can assume that the right
     * value (boolean primitive) is coming in here.
     *
     * @param  boolean  Overwrite the destination file(s) if it/they already exist
     * @return void
     * @access public
     */
    function setForce($bool) {
        $this->force = (boolean) $bool;
    }

    /**
     * Set the append flag. IntrospectionHelper takes care of
     * booleans in set* methods so we can assume that the right
     * value (boolean primitive) is coming in here.
     *
     * @param  boolean  Overwrite the destination file(s) if it/they already exist
     * @return void
     * @access public
     */
    function setAppend($bool) {
        $this->append = (boolean) $bool;
    }


    /**
     * Used to force listing of all names of copied files.
     * @param boolean $verbosity
     */
    function setVerbose($verbosity) {
        if ($verbosity) {
            $this->verbosity = PROJECT_MSG_INFO;
        } else {
            $this->verbosity = PROJECT_MSG_VERBOSE;
        }
    }
    
    /**
     * Set the destfile. We have to manually take care of the
     * type that is coming due to limited type support in php
     * in and convert it manually if neccessary.
     *
     * @param  string/object  The source file. Either a string or an PhingFile object
     * @return void
     * @access public
     */
    function setDestfile(PhingFile $file) {        
        $this->destfile = $file;
    }

    /**
     * Nested creator, creates a FileSet for this task
     *
     * @access  public
     * @return  object  The created fileset object
     */
    function createFileSet() {
        $num = array_push($this->filesets, new FileSet());
        return $this->filesets[$num-1];
    }

    /**
     * Creates a filterchain
     *
     * @access public
     * @return  object  The created filterchain object
     */
    function createFilterChain() {
        $num = array_push($this->filterChains, new FilterChain($this->project));
        return $this->filterChains[$num-1];
    }

    /**
     * Nested creator, creates one Mapper for this task
     *
     * @access  public
     * @return  object  The created Mapper type object
     * @throws  BuildException
     */
    function createMapper() {
        if ($this->mapperElement !== null) {
            throw new BuildException("Cannot define more than one mapper", $this->location);
        }
        $this->mapperElement = new Mapper($this->project);
        return $this->mapperElement;
    }

    /**
     * The main entry point where everything gets in motion.
     *
     * @access  public
     * @return  true on success
     * @throws  BuildException
     */
    function main() {
    
        $this->validateAttributes();

        if ($this->destfile === null) {
            $this->destfile = new PhingFile($this->destDir, (string) $this->file->getName());
        }
        if ($this->force === true || ($this->file->lastModified() > $this->destFile->lastModified())) {
            $this->fileCopyMap[$this->destfile->getAbsolutePath()] = $this->destfile->getAbsolutePath();
        } else {
            $this->log($this->destfile->getName()." omitted, is up to date");
        }

        $project = $this->getProject();

        // process filesets
        foreach($this->filesets as $fs) {
            $ds = $fs->getDirectoryScanner($project);
            $fromDir  = $fs->getDir($project);
            $srcFiles = $ds->getIncludedFiles();
            $srcDirs  = $ds->getIncludedDirectories();
            $this->_scan($fromDir, $this->destDir, $srcFiles, $srcDirs);
        }

        // go and concat the stuff
        $this->doWork();

        if ($this->destfile !== null) {
            $this->destDir = null;
        }
    }

    /**
     * Validates attributes coming in from XML
     *
     * @access  private
     * @return  void
     * @throws  BuildException
     */
    private function validateAttributes() {
    
        if (count($this->filesets) === 0) {
            throw new BuildException("CopyTask. Specify at least one source - a file or a fileset.");
        }

        if ($this->destfile === null) {
            throw new BuildException("destfile must be set.");
        }

        if ($this->destfile !== null) {
            $this->destDir = new PhingFile($this->destfile->getParent());
        }
    }

    /**
     * Compares source files to destination files to see if they
     * should be copied.
     *
     * @access  private
     * @return  void
     */
    private function _scan(&$fromDir, &$toDir, &$files, &$dirs) {
        /* mappers should be generic, so we get the mappers here and
        pass them on to builMap. This method is not redundan like it seems */
        $mapper = null;
        if ($this->mapperElement !== null) {
            $mapper = $this->mapperElement->getImplementation();
        } else if ($this->flatten) {
            $mapper = new FlattenMapper();
        } else {
            $mapper = new IdentityMapper();
        }
        $this->buildMap($fromDir, $toDir, $files, $mapper, $this->fileCopyMap);
    }

    /**
     * Builds a map of filenames (from->to) that should be copied
     *
     * @access  private
     * @return  void
     */
    private function buildMap(&$fromDir, &$toDir, &$names, &$mapper, &$map) {
        $toCopy = null;
        if ($this->overwrite) {
            $v = array();
            foreach($names as $name) {
                $result = $mapper->main($name);
                if ($result !== null) {
                    $v[] = $name;
                }
            }
            $toCopy = $v;
        } else {
            $ds = new SourceFileScanner($this);
            $toCopy = $ds->restrict($names, $fromDir, $toDir, $mapper);
        }

        for ($i=0,$_i=count($toCopy); $i < $_i; $i++) {
            $src  = new PhingFile($fromDir, $toCopy[$i]);
            $mapped = $mapper->main($toCopy[$i]);
            $dest = new PhingFile($toDir, $mapped[0]);
            $map[$src->getAbsolutePath()] = $dest->getAbsolutePath();
        }
    }


    /**
     * Actually copies the files
     *
     * @access  private
     * @return  void
     * @throws  BuildException
     */
    private function doWork() {
        
        // These "slots" allow filters to retrieve information about the currently-being-process files        
        $fromSlot = $this->getRegisterSlot("currentFromFile");
        $fromBasenameSlot = $this->getRegisterSlot("currentFromFile.basename");    

        $toSlot = $this->getRegisterSlot("currentToFile");
        $toBasenameSlot = $this->getRegisterSlot("currentToFile.basename");    
        
        $mapSize = count($this->fileCopyMap);
        $total = $mapSize;
        if ($mapSize > 0) {
            $this->log("Concatinating ".$mapSize." file".(($mapSize) === 1 ? '' : 's')." to ". $this->destfile->getAbsolutePath());
            // walks the map and actually copies the files
            $count=0;
            $_toFile = $this->destfile->getAbsolutePath();
            try {
                $toFile = new PhingFile($_toFile);
                
              $toSlot->setValue($toFile->getPath());
              $toBasenameSlot->setValue($toFile->getName());
             
              if ($toFile->exists() && $toFile->isFile()) {
                 $toFile->delete();
              }
             
            } catch (IOExeption $ioe) {
                    $this->log("Failed to append to " . $to . ": " . $ioe->getMessage(), PROJECT_MSG_ERR);              
            }
            foreach($this->fileCopyMap as $from => $to) {
                if ($from === $_toFile) {
                    $this->log("Skipping self-copy of " . $from, $this->verbosity);
                    $total--;
                    continue;
                }
                $this->log("From ".$from." to ".$_toFile, $this->verbosity);
                try { // try to append file
                
                    $fromFile = new PhingFile($from);
                    
                    $fromSlot->setValue($fromFile->getPath());
                    $fromBasenameSlot->setValue($fromFile->getName());
                    
                    $this->fileUtils->appendFile($fromFile, $toFile, $this->force, $this->filterChains, $this->getProject());
            
                    $count++;
                } catch (IOException $ioe) {
                    $this->log("Failed to append " . $from . " to " . $to . ": " . $ioe->getMessage(), PROJECT_MSG_ERR);
                }
            }
        }

    }

}