Changeset 1238

Timestamp:

01/15/08 01:49:21 (8 months ago)

Author:

mikey

Message:

introduce star file format version 2: expanded space for id in header entry from 80 to 232 bytes, dropped basename and path from header entry to keep the maximum length of 256 bytes per header entry

Files:

• trunk/build/star/compile-reader.ini (modified) (1 diff)
• trunk/build/star/compile-writer-archive.ini (modified) (1 diff)
• trunk/build/star/compile-writer-cli.ini (modified) (1 diff)
• trunk/src/main/php/org/stubbles/phing/tasks/stubStarWriterTask.php (modified) (4 diffs)
• trunk/src/main/php/org/stubbles/star/StarArchive.php (modified) (5 diffs)
• trunk/src/main/php/org/stubbles/star/StarConsole.php (modified) (4 diffs)
• trunk/src/main/php/org/stubbles/star/StarStreamWrapper.php (modified) (1 diff)

trunk/build/star/compile-reader.ini

@@ -11 +11 @@
-title = "Stubbles Archive Reader"
-package = "org::stubbles::star"
-6
+7
-author = "Stubbles Development Team <http://stubbles.net>
-copyright = "© 2007-2008 Stubbles Development Team"

trunk/build/star/compile-writer-archive.ini

@@ -15 +15 @@
-title = "Stubbles Archive Writer"
-package = "org::stubbles::star"
-6
+7
-author = "Stubbles Development Team <http://stubbles.net>
-copyright = "© 2007-2008 Stubbles Development Team"

trunk/build/star/compile-writer-cli.ini

@@ -16 +16 @@
-title = "Stubbles Archive CLI Writer"
-package = "org::stubbles::star"
-6
+7
-author = "Stubbles Development Team <http://stubbles.net>
-copyright = "© 2007-2008 Stubbles Development Team"

trunk/src/main/php/org/stubbles/phing/tasks/stubStarWriterTask.php

@@ -64 +64 @@
-    protected $preface     = null;
-    /**
+     * the version of the starfile to build
+     *
+     * @var  int
+     */
+    protected $starVersion = 2;
+    /**
-     * the path to put the star archive into
-     *
@@ -146 +152 @@
-    {
-        $this->preface = $preface;
+    }
+
+    /**
+     * sets the star version number
+     *
+     * @param  string  $starVersion
+     */
+    public function setStarVersion($starVersion)
+    {
+        $this->starVersion = $starVersion;
-    }
-
@@ -205 +221 @@
-
-        // works now with refactored buildfile
-/*
+
-        $decorators = array();
-        foreach ($this->decorators as $decorator) {
-            $decorators[$decorator->getStarId()] = $decorator;
-        }
-*/
-
-
+
+
+, $this->starVersion
-        foreach($this->filesets as $fs) {
-            try {
@@ -240 +256 @@
-
-                    $this->log('Adding ' . $fullFileName . ' as ' . $id);
-
+=
-                        $starFile = new StarFile($fullFileName, $this->baseSrcPath);
-                    } else {

trunk/src/main/php/org/stubbles/star/StarArchive.php

@@ -50 +50 @@
-    protected $metadata             = array();
-    /**
-
-
-
+
+
+
+
+
-    
-    /**
@@ -59 +61 @@
-     * @param  StarWriter  $writer  writer to use
-     */
-
+, $version = 2
-    {
-        $this->writer = $writer;
-        $this->writer->setExtension('star');
+        $this->version = $version;
-    }
-    
@@ -137 +140 @@
-        $this->writer->write(pack('a4c1a8a14a229',
-                                  'star',
-self::VERSION
+$this->version
-                                  (string) count($ids),
-                                  date('YmdHis'),
@@ -146 +149 @@
-        // write index
-        foreach ($ids as $id) {
-
-
-
-
-
-
-
-
-
+
-            $offset += $this->index[$id]['datasize'];
-        }
@@ -172 +167 @@
-        $this->writer->close();
-    }
+
+    /**
+     * returns the header of entries depending on requested version
+     *
+     * @param   string  $id      id of entry to create header data for
+     * @param   int     $offset  offset where entry is located in file
+     * @return  string
+     */
+    protected function getHeader($id, $offset)
+    {
+        switch ($this->version) {
+            case 1:
+                $method = 'getHeaderForVersion1';
+                break;
+            
+            case 2:
+            default:
+                $method = 'getHeaderForVersion2';
+        }
+        
+        return $this->$method($id, $offset);
+    }
+
+    /**
+     * returns the header of entries for star files version 1
+     *
+     * @param   string  $id      id of entry to create header data for
+     * @param   int     $offset  offset where entry is located in file
+     * @return  string
+     */
+    protected function getHeaderForVersion1($id, $offset)
+    {
+        return pack('a80a72a80a8a8a8', $id,
+                                       $this->index[$id]['basename'],
+                                       $this->index[$id]['path'],
+                                       (string) $this->index[$id]['datasize'],
+                                       (string) $offset,
+                                       "\0"
+               );
+    }
+
+    /**
+     * returns the header of entries for star files version 2
+     *
+     * @param   string  $id      id of entry to create header data for
+     * @param   int     $offset  offset where entry is located in file
+     * @return  string
+     */
+    protected function getHeaderForVersion2($id, $offset)
+    {
+        return pack('a232a8a8a8', $id,
+                                  (string) $this->index[$id]['datasize'],
+                                  (string) $offset,
+                                  "\0"
+               );
+    }
-}
-?>

trunk/src/main/php/org/stubbles/star/StarConsole.php

@@ -42 +42 @@
-                                                         'default' => ''
-                                                   ),
+                                   'star'       => array('short'   => 's',
+                                                         'min'     => 0,
+                                                         'max'     => 1,
+                                                         'desc'    => 'Star version to use: 1 or 2.',
+                                                         'default' => ''
+                                                   ),
-                                   'verbose'    => array('short'   => 'v',
-                                                         'min'     => 0,
@@ -66 +72 @@
-     */
-    private $target;
+    /**
+     * star version to use
+     *
+     * @var  int
+     */
+    private $starVersion = 2;
-    
-    /**
@@ -144 +156 @@
-            $this->target = $this->args->getValue('target');
-        }
+        
+        if ($this->args->isDefined('star') == true) {
+            $this->starVersion = $this->args->getValue('star');
+        }
-    }
-    
@@ -164 +180 @@
-        $target = ((null == $this->target) ? ($conf['MAIN']['target']) : ($this->target));
-        $this->verbose('Writing star data to ' . $target . "\n");
-
+, $this->starVersion
-        $removePath  = null;
-        if ($this->args->isDefined('removePath') == true) {

trunk/src/main/php/org/stubbles/star/StarStreamWrapper.php

@@ -103 +103 @@
-        }
-        
+        if (1 === $header['version']) {
+            $key = 'a80id/a72filename/a80path/a8size/a8offset/a*reserved';
+        } else {
+            $key = 'a232id/a8size/a8offset/a*reserved';
+        }
+
-        for ($i = 0; $i < $header['indexsize']; $i++) {
-
-
-
-
+
-            $current['index'][$entry['id']]  = array('size' => (int) $entry['size'], 'offset' => (int) $entry['offset']);
-            $current['header']['totalSize'] += 0x0100 + ((int) $entry['size']);