ArchiveTar Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	tar ()
	__computeUnsignedChecksum ($bytestring)
	__parseNullPaddedString ($string)
	__parseTar ()
	__readTar ($filename='')
	__generateTAR ()
	openTAR ($value)
	saveTar ()
	toTar ($filename, $useGzip)
Öffentliche Attribute
	$filename
	$isGzipped
	$tar_file
	$files
	$directories
	$numFiles
	$numDirectories

---

Ausführliche Beschreibung

Definiert in Zeile 66 der Datei ArchiveTar.class.php.

---

Dokumentation der Elementfunktionen

ArchiveTar::__computeUnsignedChecksum

(

$

bytestring

)

Definiert in Zeile 89 der Datei ArchiveTar.class.php.

Wird benutzt von __generateTAR() und __parseTar().

     {
          $unsigned_chksum=0;
          for($i=0; $i<512; $i++)
               $unsigned_chksum += ord($bytestring[$i]);
          for($i=0; $i<8; $i++)
               $unsigned_chksum -= ord($bytestring[148 + $i]);
          $unsigned_chksum += ord(" ") * 8;

          return $unsigned_chksum;
     }

ArchiveTar::__generateTAR

(

)

Definiert in Zeile 239 der Datei ArchiveTar.class.php.

Benutzt __computeUnsignedChecksum().

     {
          // Clear any data currently in $this->tar_file    
          unset($this->tar_file);

          // Generate Records for each directory, if we have directories
          if($this->numDirectories > 0) {
               foreach($this->directories as $key => $information) {
                    unset($header);

                    // Generate tar header for this directory
                    // Filename, Permissions, UID, GID, size, Time, checksum, typeflag, linkname, magic, version, user name, group name, devmajor, devminor, prefix, end
                    $header .= str_pad($information["name"],100,chr(0));
                    $header .= str_pad(decoct($information["mode"]),7,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_pad(decoct($information["user_id"]),7,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_pad(decoct($information["group_id"]),7,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_pad(decoct(0),11,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_pad(decoct($information["time"]),11,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_repeat(" ",8);
                    $header .= "5";
                    $header .= str_repeat(chr(0),100);
                    $header .= str_pad("ustar",6,chr(32));
                    $header .= chr(32) . chr(0);
                    $header .= str_pad("",32,chr(0));
                    $header .= str_pad("",32,chr(0));
                    $header .= str_repeat(chr(0),8);
                    $header .= str_repeat(chr(0),8);
                    $header .= str_repeat(chr(0),155);
                    $header .= str_repeat(chr(0),12);

                    // Compute header checksum
                    $checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)),6,"0",STR_PAD_LEFT);
                    for($i=0; $i<6; $i++) {
                         $header[(148 + $i)] = substr($checksum,$i,1);
                    }
                    $header[154] = chr(0);
                    $header[155] = chr(32);

                    // Add new tar formatted data to tar file contents
                    $this->tar_file .= $header;
               }
          }

          // Generate Records for each file, if we have files (We should...)
          if($this->numFiles > 0)
          {
               foreach($this->files as $key => $information)
               {
                    unset($header);

                    // Generate the TAR header for this file
                    // Filename, Permissions, UID, GID, size, Time, checksum, typeflag, linkname, magic, version, user name, group name, devmajor, devminor, prefix, end
                    $header .= str_pad($information["name"],100,chr(0));
                    $header .= str_pad(decoct($information["mode"]),7,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_pad(decoct($information["user_id"]),7,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_pad(decoct($information["group_id"]),7,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_pad(decoct($information["size"]),11,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_pad(decoct($information["time"]),11,"0",STR_PAD_LEFT) . chr(0);
                    $header .= str_repeat(" ",8);
                    $header .= "0";
                    $header .= str_repeat(chr(0),100);
                    $header .= str_pad("ustar",6,chr(32));
                    $header .= chr(32) . chr(0);
                    $header .= str_pad($information["user_name"],32,chr(0));    // How do I get a file's user name from PHP?
                    $header .= str_pad($information["group_name"],32,chr(0));   // How do I get a file's group name from PHP?
                    $header .= str_repeat(chr(0),8);
                    $header .= str_repeat(chr(0),8);
                    $header .= str_repeat(chr(0),155);
                    $header .= str_repeat(chr(0),12);

                    // Compute header checksum
                    $checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)),6,"0",STR_PAD_LEFT);
                    for($i=0; $i<6; $i++)
                    {
                         $header[(148 + $i)] = substr($checksum,$i,1);
                    }
                    $header[154] = chr(0);
                    $header[155] = chr(32);

                    // Pad file contents to byte count divisible by 512
                    $file_contents = str_pad($information["file"],(ceil($information["size"] / 512) * 512),chr(0));

                    // Add new tar formatted data to tar file contents
                    $this->tar_file .= $header . $file_contents;
               }
          }

          // Add 512 bytes of NULLs to designate EOF
          $this->tar_file .= str_repeat(chr(0),512);

          return true;
     }

ArchiveTar::__parseNullPaddedString

(

$

string

)

Definiert in Zeile 104 der Datei ArchiveTar.class.php.

Wird benutzt von __parseTar().

     {
          $position = strpos($string,chr(0));
          return substr($string,0,$position);
     }

ArchiveTar::__parseTar

(

)

Definiert in Zeile 113 der Datei ArchiveTar.class.php.

Benutzt __computeUnsignedChecksum() und __parseNullPaddedString().

Wird benutzt von __readTar().

     {
          // Read Files from archive
          $this->numFiles=0;
          $tar_length = strlen($this->tar_file);
          $main_offset = 0;
          while($main_offset < $tar_length) {
               // If we read a block of 512 nulls, we are at the end of the archive
               if(substr($this->tar_file,$main_offset,512) == str_repeat(chr(0),512))
                    break;

               // Parse file name
               $file_name          = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset,100));

               // Parse the file mode
               $file_mode          = substr($this->tar_file,$main_offset + 100,8);

               // Parse the file user ID
               $file_uid      = octdec(substr($this->tar_file,$main_offset + 108,8));

               // Parse the file group ID
               $file_gid      = octdec(substr($this->tar_file,$main_offset + 116,8));

               // Parse the file size
               $file_size          = octdec(substr($this->tar_file,$main_offset + 124,12));

               // Parse the file update time - unix timestamp format
               $file_time          = octdec(substr($this->tar_file,$main_offset + 136,12));

               // Parse Checksum
               $file_chksum        = octdec(substr($this->tar_file,$main_offset + 148,6));

               // Parse user name
               $file_uname         = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset + 265,32));

               // Parse Group name
               $file_gname         = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset + 297,32));

               // Make sure our file is valid
               if($this->__computeUnsignedChecksum(substr($this->tar_file,$main_offset,512)) != $file_chksum)
                    return false;

               // Parse File Contents
               $file_contents      = substr($this->tar_file,$main_offset + 512,$file_size);

               /*   ### Unused Header Information ###
                    $activeFile["typeflag"]       = substr($this->tar_file,$main_offset + 156,1);
                    $activeFile["linkname"]       = substr($this->tar_file,$main_offset + 157,100);
                    $activeFile["magic"]          = substr($this->tar_file,$main_offset + 257,6);
                    $activeFile["version"]        = substr($this->tar_file,$main_offset + 263,2);
                    $activeFile["devmajor"]       = substr($this->tar_file,$main_offset + 329,8);
                    $activeFile["devminor"]       = substr($this->tar_file,$main_offset + 337,8);
                    $activeFile["prefix"]         = substr($this->tar_file,$main_offset + 345,155);
                    $activeFile["endheader"] = substr($this->tar_file,$main_offset + 500,12);
               */

               if($file_size > 0) {
                    // Increment number of files
                    $this->numFiles++;

                    // Create us a new file in our array
                    $activeFile = &$this->files[];

                    // Asign Values
                    $activeFile["name"]      = $file_name;
                    $activeFile["mode"]      = $file_mode;
                    $activeFile["size"]      = $file_size;
                    $activeFile["time"]      = $file_time;
                    $activeFile["user_id"]        = $file_uid;
                    $activeFile["group_id"]       = $file_gid;
                    $activeFile["user_name"] = $file_uname;
                    $activeFile["group_name"]     = $file_gname;
                    $activeFile["checksum"]       = $file_chksum;
                    $activeFile["file"]      = $file_contents;

               } else {
                    // Increment number of directories
                    $this->numDirectories++;

                    // Create a new directory in our array
                    $activeDir = &$this->directories[];

                    // Assign values
                    $activeDir["name"]       = $file_name;
                    $activeDir["mode"]       = $file_mode;
                    $activeDir["time"]       = $file_time;
                    $activeDir["user_id"]         = $file_uid;
                    $activeDir["group_id"]        = $file_gid;
                    $activeDir["user_name"]       = $file_uname;
                    $activeDir["group_name"] = $file_gname;
                    $activeDir["checksum"]        = $file_chksum;
               }

               // Move our offset the number of blocks we have processed
               $main_offset += 512 + (ceil($file_size / 512) * 512);
          }

          return true;
     }

ArchiveTar::__readTar

(

$

filename = ''

)

Definiert in Zeile 216 der Datei ArchiveTar.class.php.

Benutzt __parseTar().

Wird benutzt von openTAR().

     {
          // Set the filename to load
          // Read in the TAR file

          if($this->tar_file[0] == chr(31) && $this->tar_file[1] == chr(139) && $this->tar_file[2] == chr(8)) {
               if(!function_exists("gzinflate"))
                    return false;

               $this->isGzipped = TRUE;

               $this->tar_file = gzinflate(substr($this->tar_file,10,-4));
          }

          // Parse the TAR file
          $this->__parseTar();

          return true;
     }

ArchiveTar::openTAR

(

$

value

)

Definiert in Zeile 334 der Datei ArchiveTar.class.php.

Benutzt __readTar().

     {
          // Clear any values from previous tar archives
          unset($this->filename);
          unset($this->isGzipped);
          unset($this->tar_file);
          unset($this->files);
          unset($this->directories);
          unset($this->numFiles);
          unset($this->numDirectories);

          $this->filename = 'none';
          $this->tar_file = $value;
          // Parse this file
          $this->__readTar();

          return true;
     }

ArchiveTar::saveTar

(

)

Definiert in Zeile 355 der Datei ArchiveTar.class.php.

Benutzt toTar().

     {
          if(!$this->filename)
               return false;

          // Write tar to current file using specified gzip compression
          $this->toTar($this->filename,$this->isGzipped);

          return true;
     }

ArchiveTar::tar

(

)

Definiert in Zeile 81 der Datei ArchiveTar.class.php.

                    {
          return true;
     }

ArchiveTar::toTar	(	$	filename,
		$	useGzip
	)

Definiert in Zeile 368 der Datei ArchiveTar.class.php.

Benutzt $filename.

Wird benutzt von saveTar().

     {
          if(!$filename)
               return false;

          // Encode processed files into TAR file format
          $this->__generateTar();

          // GZ Compress the data if we need to
          if($useGzip) {
               // Make sure we have gzip support
               if(!function_exists("gzencode"))
                    return false;

               $file = gzencode($this->tar_file);
          } else {
               $file = $this->tar_file;
          }

          // Write the TAR file
          $fp = fopen($filename,"wb");
          fwrite($fp,$file);
          fclose($fp);

          return true;
     }

---

Dokumentation der Datenelemente

ArchiveTar::$directories

Definiert in Zeile 75 der Datei ArchiveTar.class.php.

ArchiveTar::$filename

Definiert in Zeile 69 der Datei ArchiveTar.class.php.

Wird benutzt von toTar().

ArchiveTar::$files

Definiert in Zeile 74 der Datei ArchiveTar.class.php.

ArchiveTar::$isGzipped

Definiert in Zeile 70 der Datei ArchiveTar.class.php.

ArchiveTar::$numDirectories

Definiert in Zeile 77 der Datei ArchiveTar.class.php.

ArchiveTar::$numFiles

Definiert in Zeile 76 der Datei ArchiveTar.class.php.

ArchiveTar::$tar_file

Definiert in Zeile 71 der Datei ArchiveTar.class.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• serviceClasses/ArchiveTar.class.php