class apachesolr_confgen_zipfile in Apache Solr Config Generator 8

Zip file creation class. Makes zip files.

Last Modification and Extension By :

Hasin Hayder HomePage : www.hasinme.info Email : [e-mail] IDE : PHP Designer 2005

Originally Based on :

http://www.zend.com/codex.php?id=535&single=1 By Eric Mueller <[e-mail]>

http://www.zend.com/codex.php?id=470&single=1 by Denis125 <[e-mail]>

a patch from Peter Listiak <[e-mail]> for last modified date and time of the compressed file

Official ZIP file format: http://www.pkware.com/appnote.txt

@access public

Hierarchy

• class \apachesolr_confgen_zipfile

File

lib/apachesolr_confgen_zipfile.php, line 35

Zip file creation class to pack Apache Solr configuration files

class apachesolr_confgen_zipfile {

  /**
   * Array to store compressed data
   *
   * @var  array    $datasec
   */
  var $datasec = array();

  /**
   * Central directory
   *
   * @var  array    $ctrl_dir
   */
  var $ctrl_dir = array();

  /**
   * End of central directory record
   *
   * @var  string   $eof_ctrl_dir
   */
  var $eof_ctrl_dir = "PK\5\6\0\0\0\0";

  /**
   * Last offset position
   *
   * @var  integer  $old_offset
   */
  var $old_offset = 0;

  /**
   * Converts an Unix timestamp to a four byte DOS date and time format (date
   * in high two bytes, time in low two bytes allowing magnitude comparison).
   *
   * @param  integer  the current Unix timestamp
   *
   * @return integer  the current date in a four byte DOS format
   *
   * @access private
   */
  function unix2DosTime($unixtime = 0) {
    $timearray = $unixtime == 0 ? getdate() : getdate($unixtime);
    if ($timearray['year'] < 1980) {
      $timearray['year'] = 1980;
      $timearray['mon'] = 1;
      $timearray['mday'] = 1;
      $timearray['hours'] = 0;
      $timearray['minutes'] = 0;
      $timearray['seconds'] = 0;
    }

    // end if
    return $timearray['year'] - 1980 << 25 | $timearray['mon'] << 21 | $timearray['mday'] << 16 | $timearray['hours'] << 11 | $timearray['minutes'] << 5 | $timearray['seconds'] >> 1;
  }

  // end of the 'unix2DosTime()' method
  function addDir($name) {

    // adds "directory" to archive - do this before putting any files in directory!
    // $name - name of directory... like this: "path/"
    // ...then you can add files using add_file with names like "path/file.txt"
    $name = str_replace("\\", "/", $name);
    $fr = "PK\3\4";
    $fr .= "\n\0";

    // ver needed to extract
    $fr .= "\0\0";

    // gen purpose bit flag
    $fr .= "\0\0";

    // compression method
    $fr .= "\0\0\0\0";

    // last mod time and date
    $fr .= pack("V", 0);

    // crc32
    $fr .= pack("V", 0);

    //compressed filesize
    $fr .= pack("V", 0);

    //uncompressed filesize
    $fr .= pack("v", strlen($name));

    //length of pathname
    $fr .= pack("v", 0);

    //extra field length
    $fr .= $name;

    // end of "local file header" segment
    // no "file data" segment for path
    // "data descriptor" segment (optional but necessary if archive is not served as file)
    $fr .= pack("V", $crc);

    //crc32
    $fr .= pack("V", $c_len);

    //compressed filesize
    $fr .= pack("V", $unc_len);

    //uncompressed filesize

    // add this entry to array
    $this->datasec[] = $fr;
    $new_offset = strlen(implode("", $this->datasec));

    // ext. file attributes mirrors MS-DOS directory attr byte, detailed
    // at http://support.microsoft.com/support/kb/articles/Q125/0/19.asp
    // now add to central record
    $cdrec = "PK\1\2";
    $cdrec .= "\0\0";

    // version made by
    $cdrec .= "\n\0";

    // version needed to extract
    $cdrec .= "\0\0";

    // gen purpose bit flag
    $cdrec .= "\0\0";

    // compression method
    $cdrec .= "\0\0\0\0";

    // last mod time & date
    $cdrec .= pack("V", 0);

    // crc32
    $cdrec .= pack("V", 0);

    //compressed filesize
    $cdrec .= pack("V", 0);

    //uncompressed filesize
    $cdrec .= pack("v", strlen($name));

    //length of filename
    $cdrec .= pack("v", 0);

    //extra field length
    $cdrec .= pack("v", 0);

    //file comment length
    $cdrec .= pack("v", 0);

    //disk number start
    $cdrec .= pack("v", 0);

    //internal file attributes
    $ext = "\0\0\20\0";
    $ext = "";
    $cdrec .= pack("V", 16);

    //external file attributes  - 'directory' bit set
    $cdrec .= pack("V", $this->old_offset);

    //relative offset of local header
    $this->old_offset = $new_offset;
    $cdrec .= $name;

    // optional extra field, file comment goes here
    // save to array
    $this->ctrl_dir[] = $cdrec;
  }

  /**
   * Adds "file" to archive
   *
   * @param  string   file contents
   * @param  string   name of the file in the archive (may contains the path)
   * @param  integer  the current timestamp
   *
   * @access public
   */
  function addFile($data, $name, $time = 0) {
    $name = str_replace('\\', '/', $name);
    $dtime = dechex($this
      ->unix2DosTime($time));
    $hexdtime = '\\x' . $dtime[6] . $dtime[7] . '\\x' . $dtime[4] . $dtime[5] . '\\x' . $dtime[2] . $dtime[3] . '\\x' . $dtime[0] . $dtime[1];
    eval('$hexdtime = "' . $hexdtime . '";');
    $fr = "PK\3\4";
    $fr .= "\24\0";

    // ver needed to extract
    $fr .= "\0\0";

    // gen purpose bit flag
    $fr .= "\10\0";

    // compression method
    $fr .= $hexdtime;

    // last mod time and date
    // "local file header" segment
    $unc_len = strlen($data);
    $crc = crc32($data);
    $zdata = gzcompress($data);
    $zdata = substr(substr($zdata, 0, strlen($zdata) - 4), 2);

    // fix crc bug
    $c_len = strlen($zdata);
    $fr .= pack('V', $crc);

    // crc32
    $fr .= pack('V', $c_len);

    // compressed filesize
    $fr .= pack('V', $unc_len);

    // uncompressed filesize
    $fr .= pack('v', strlen($name));

    // length of filename
    $fr .= pack('v', 0);

    // extra field length
    $fr .= $name;

    // "file data" segment
    $fr .= $zdata;

    // "data descriptor" segment (optional but necessary if archive is not
    // served as file)
    $fr .= pack('V', $crc);

    // crc32
    $fr .= pack('V', $c_len);

    // compressed filesize
    $fr .= pack('V', $unc_len);

    // uncompressed filesize
    // add this entry to array
    $this->datasec[] = $fr;

    // now add to central directory record
    $cdrec = "PK\1\2";
    $cdrec .= "\0\0";

    // version made by
    $cdrec .= "\24\0";

    // version needed to extract
    $cdrec .= "\0\0";

    // gen purpose bit flag
    $cdrec .= "\10\0";

    // compression method
    $cdrec .= $hexdtime;

    // last mod time & date
    $cdrec .= pack('V', $crc);

    // crc32
    $cdrec .= pack('V', $c_len);

    // compressed filesize
    $cdrec .= pack('V', $unc_len);

    // uncompressed filesize
    $cdrec .= pack('v', strlen($name));

    // length of filename
    $cdrec .= pack('v', 0);

    // extra field length
    $cdrec .= pack('v', 0);

    // file comment length
    $cdrec .= pack('v', 0);

    // disk number start
    $cdrec .= pack('v', 0);

    // internal file attributes
    $cdrec .= pack('V', 32);

    // external file attributes - 'archive' bit set
    $cdrec .= pack('V', $this->old_offset);

    // relative offset of local header
    $this->old_offset += strlen($fr);
    $cdrec .= $name;

    // optional extra field, file comment goes here
    // save to central directory
    $this->ctrl_dir[] = $cdrec;
  }

  // end of the 'addFile()' method

  /**
   * Dumps out file
   *
   * @return  string  the zipped file
   *
   * @access public
   */
  function file() {
    $data = implode('', $this->datasec);
    $ctrldir = implode('', $this->ctrl_dir);
    return $data . $ctrldir . $this->eof_ctrl_dir . pack('v', sizeof($this->ctrl_dir)) . pack('v', sizeof($this->ctrl_dir)) . pack('V', strlen($ctrldir)) . pack('V', strlen($data)) . "\0\0";

    // .zip file comment length
  }

  // end of the 'file()' method

  /**
   * A Wrapper of original addFile Function
   *
   * Created By Hasin Hayder at 29th Jan, 1:29 AM
   *
   * @param array An Array of files with relative/absolute path to be added in Zip File
   *
   * @access public
   */
  function addFiles($files) {
    foreach ($files as $file) {
      if (is_file($file)) {

        //directory check
        $data = implode('', file($file));
        $this
          ->addFile($data, $file);
      }
    }
  }

  /**
   * A Wrapper of original file Function
   *
   * Created By Hasin Hayder at 29th Jan, 1:29 AM
   *
   * @param string Output file name
   *
   * @access public
   */
  function output($file) {
    $fp = fopen($file, "w");
    fwrite($fp, $this
      ->file());
    fclose($fp);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
apachesolr_confgen_zipfile::$ctrl_dir		property	Central directory
apachesolr_confgen_zipfile::$datasec		property	Array to store compressed data
apachesolr_confgen_zipfile::$eof_ctrl_dir		property	End of central directory record
apachesolr_confgen_zipfile::$old_offset		property	Last offset position
apachesolr_confgen_zipfile::addDir		function
apachesolr_confgen_zipfile::addFile		function	Adds "file" to archive
apachesolr_confgen_zipfile::addFiles		function	A Wrapper of original addFile Function
apachesolr_confgen_zipfile::file		function	Dumps out file
apachesolr_confgen_zipfile::output		function	A Wrapper of original file Function
apachesolr_confgen_zipfile::unix2DosTime		function	Converts an Unix timestamp to a four byte DOS date and time format (date in high two bytes, time in low two bytes allowing magnitude comparison).