Changeset 94

Timestamp:

07/11/06 15:33:29 (4 years ago)

Author:

hans

Message:

ticket:8 - Fixed two inter-related issues in TarTask:

1. Added support for includeEmptyDirs attribute, which is now ON by default.
2. The test for whether archive is up-to-date was happening even when archive did not exist.

File:

• branches/2.2/classes/phing/tasks/ext/TarTask.php (modified) (6 diffs)

branches/2.2/classes/phing/tasks/ext/TarTask.php

@@ -45 +45 @@
     private $tarFile;
     private $baseDir;
-
+        private $includeEmpty = true; // Whether to include empty dirs in the TAR
+        
     private $longFileMode = "warn";
 
@@ -106 +107 @@
     public function setBasedir(PhingFile $baseDir) {
         $this->baseDir = $baseDir;
+    }
+
+    /**
+     * Set the include empty dirs flag.
+     * @param  boolean  Flag if empty dirs should be tarred too
+     * @return void
+     * @access public
+     */
+    function setIncludeEmptyDirs($bool) {
+        $this->includeEmpty = (boolean) $bool;
     }
 
@@ -191 +202 @@
             }                        
             
-            // check if tar is out of date with respect to each
-            // fileset
-            $upToDate = true;
-            foreach($this->filesets as $fs) {
-                $files = $fs->getFiles($this->project);
-                if (!$this->archiveIsUpToDate($files, $fs->getDir($this->project))) {
-                    $upToDate = false;
-                }
-                for ($i=0, $fcount=count($files); $i < $fcount; $i++) {
-                    if ($this->tarFile->equals(new PhingFile($fs->getDir($this->project), $files[$i]))) {
-                        throw new BuildException("A tar file cannot include itself", $this->getLocation());
-                    }
-                }
-            }
-            
-            if ($upToDate) {
-                $this->log("Nothing to do: " . $this->tarFile->__toString() . " is up to date.", PROJECT_MSG_INFO);
-                return;
-            }
-
+            // check if tar is out of date with respect to each fileset
+            if($this->tarFile->exists()) {
+                    $upToDate = true;
+                    foreach($this->filesets as $fs) {
+                        $files = $fs->getFiles($this->project, $this->includeEmpty);
+                        if (!$this->archiveIsUpToDate($files, $fs->getDir($this->project))) {
+                            $upToDate = false;
+                        }
+                        for ($i=0, $fcount=count($files); $i < $fcount; $i++) {
+                            if ($this->tarFile->equals(new PhingFile($fs->getDir($this->project), $files[$i]))) {
+                                throw new BuildException("A tar file cannot include itself", $this->getLocation());
+                            }
+                        }
+                    }
+                    if ($upToDate) {
+                        $this->log("Nothing to do: " . $this->tarFile->__toString() . " is up to date.", PROJECT_MSG_INFO);
+                        return;
+                    }
+                        }
+                        
             $this->log("Building tar: " . $this->tarFile->__toString(), PROJECT_MSG_INFO);
             
@@ -219 +230 @@
             
             foreach($this->filesets as $fs) {                                
-                    $files = $fs->getFiles($this->project);
+                    $files = $fs->getFiles($this->project, $this->includeEmpty);
                     if (count($files) > 1 && strlen($fs->getFullpath()) > 0) {
                         throw new BuildException("fullpath attribute may only "
@@ -226 +237 @@
                                                  . "single file.");
                     }
-                    // FIXME 
-                    // Current model is only adding directories implicitly.  This
-                    // won't add any empty directories.  Perhaps modify TarFileSet::getFiles()
-                    // to also include empty directories.  Not high priority, since non-inclusion
-                    // of empty dirs is probably not unexpected behavior for TarTask.
                     $fsBasedir = $fs->getDir($this->project);
                     $filesToTar = array();
@@ -289 +295 @@
      *    the baseDir for the project.
      */
-    public function getFiles(Project $p) {
+    public function getFiles(Project $p, $includeEmpty = true) {
+    
         if ($this->files === null) {
+        
             $ds = $this->getDirectoryScanner($p);
             $this->files = $ds->getIncludedFiles();
-        }
+            
+            if ($includeEmpty) {
+            
+                    // first any empty directories that will not be implicitly added by any of the files
+                                $implicitDirs = array();
+                                foreach($this->files as $file) {
+                                        $implicitDirs[] = dirname($file);
+                                } 
+                                
+                                $incDirs = $ds->getIncludedDirectories();
+                                
+                                // we'll need to add to that list of implicit dirs any directories
+                                // that contain other *directories* (and not files), since otherwise
+                                // we get duplicate directories in the resulting tar
+                                foreach($incDirs as $dir) {
+                                        foreach($incDirs as $dircheck) {
+                                                if (!empty($dir) && $dir == dirname($dircheck)) {
+                                                        $implicitDirs[] = $dir;
+                                                }
+                                        }
+                                }
+                                
+                                $implicitDirs = array_unique($implicitDirs);
+                                
+                                // Now add any empty dirs (dirs not covered by the implicit dirs)
+                                // to the files array. 
+                                
+                                foreach($incDirs as $dir) { // we cannot simply use array_diff() since we want to disregard empty/. dirs
+                                        if ($dir != "" && $dir != "." && !in_array($dir, $implicitDirs)) {
+                                                // it's an empty dir, so we'll add it.
+                                                $this->files[] = $dir;
+                                        }
+                                }
+                        } // if $includeEmpty
+                        
+        } // if ($this->files===null)
+        
         return $this->files;
     }