getid3 /getid3/module.archive.gzip.php

Language PHP Lines 262
MD5 Hash 246e7185ffc62c04d42022bfc813af2f Estimated Cost $4,255 (why?)
Repository https://bitbucket.org/holyfield/getid3.git View Raw File View Project SPDX
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<?php
/////////////////////////////////////////////////////////////////
/// getID3() by James Heinrich <info@getid3.org>               //
//  available at http://getid3.sourceforge.net                 //
//            or http://www.getid3.org                         //
/////////////////////////////////////////////////////////////////
// See readme.txt for more details                             //
/////////////////////////////////////////////////////////////////
//                                                             //
// module.archive.gzip.php                                     //
// module for analyzing GZIP files                             //
// dependencies: NONE                                          //
//                                                            ///
/////////////////////////////////////////////////////////////////
//                                                             //
// Module originally written by                                //
//      Mike Mozolin <teddybear─é┬śmail*ru>                       //
//                                                             //
/////////////////////////////////////////////////////////////////


class getid3_gzip extends getid3_handler {
	
	// public: Optional file list - disable for speed.
	var $option_gzip_parse_contents = false; // decode gzipped files, if possible, and parse recursively (.tar.gz for example)
	

	function Analyze() {
		$info = &$this->getid3->info;
		
		$info ['fileformat'] = 'gzip';
		
		$start_length = 10;
		$unpack_header = 'a1id1/a1id2/a1cmethod/a1flags/a4mtime/a1xflags/a1os';
		//+---+---+---+---+---+---+---+---+---+---+
		//|ID1|ID2|CM |FLG|     MTIME     |XFL|OS |
		//+---+---+---+---+---+---+---+---+---+---+
		

		if ($info ['filesize'] > $info ['php_memory_limit']) {
			$info ['error'] [] = 'File is too large (' . number_format ( $info ['filesize'] ) . ' bytes) to read into memory (limit: ' . number_format ( $info ['php_memory_limit'] / 1048576 ) . 'MB)';
			return false;
		}
		fseek ( $this->getid3->fp, 0 );
		$buffer = fread ( $this->getid3->fp, $info ['filesize'] );
		
		$arr_members = explode ( "\x1F\x8B\x08", $buffer );
		while ( true ) {
			$is_wrong_members = false;
			$num_members = intval ( count ( $arr_members ) );
			for($i = 0; $i < $num_members; $i ++) {
				if (strlen ( $arr_members [$i] ) == 0) {
					continue;
				}
				$buf = "\x1F\x8B\x08" . $arr_members [$i];
				
				$attr = unpack ( $unpack_header, substr ( $buf, 0, $start_length ) );
				if (! $this->get_os_type ( ord ( $attr ['os'] ) )) {
					// Merge member with previous if wrong OS type
					$arr_members [$i - 1] .= $buf;
					$arr_members [$i] = '';
					$is_wrong_members = true;
					continue;
				}
			}
			if (! $is_wrong_members) {
				break;
			}
		}
		
		$info ['gzip'] ['files'] = array ();
		
		$fpointer = 0;
		$idx = 0;
		for($i = 0; $i < $num_members; $i ++) {
			if (strlen ( $arr_members [$i] ) == 0) {
				continue;
			}
			$thisInfo = &$info ['gzip'] ['member_header'] [++ $idx];
			
			$buff = "\x1F\x8B\x08" . $arr_members [$i];
			
			$attr = unpack ( $unpack_header, substr ( $buff, 0, $start_length ) );
			$thisInfo ['filemtime'] = getid3_lib::LittleEndian2Int ( $attr ['mtime'] );
			$thisInfo ['raw'] ['id1'] = ord ( $attr ['cmethod'] );
			$thisInfo ['raw'] ['id2'] = ord ( $attr ['cmethod'] );
			$thisInfo ['raw'] ['cmethod'] = ord ( $attr ['cmethod'] );
			$thisInfo ['raw'] ['os'] = ord ( $attr ['os'] );
			$thisInfo ['raw'] ['xflags'] = ord ( $attr ['xflags'] );
			$thisInfo ['raw'] ['flags'] = ord ( $attr ['flags'] );
			
			$thisInfo ['flags'] ['crc16'] = ( bool ) ($thisInfo ['raw'] ['flags'] & 0x02);
			$thisInfo ['flags'] ['extra'] = ( bool ) ($thisInfo ['raw'] ['flags'] & 0x04);
			$thisInfo ['flags'] ['filename'] = ( bool ) ($thisInfo ['raw'] ['flags'] & 0x08);
			$thisInfo ['flags'] ['comment'] = ( bool ) ($thisInfo ['raw'] ['flags'] & 0x10);
			
			$thisInfo ['compression'] = $this->get_xflag_type ( $thisInfo ['raw'] ['xflags'] );
			
			$thisInfo ['os'] = $this->get_os_type ( $thisInfo ['raw'] ['os'] );
			if (! $thisInfo ['os']) {
				$info ['error'] [] = 'Read error on gzip file';
				return false;
			}
			
			$fpointer = 10;
			$arr_xsubfield = array ();
			// bit 2 - FLG.FEXTRA
			//+---+---+=================================+
			//| XLEN  |...XLEN bytes of "extra field"...|
			//+---+---+=================================+
			if ($thisInfo ['flags'] ['extra']) {
				$w_xlen = substr ( $buff, $fpointer, 2 );
				$xlen = getid3_lib::LittleEndian2Int ( $w_xlen );
				$fpointer += 2;
				
				$thisInfo ['raw'] ['xfield'] = substr ( $buff, $fpointer, $xlen );
				// Extra SubFields
				//+---+---+---+---+==================================+
				//|SI1|SI2|  LEN  |... LEN bytes of subfield data ...|
				//+---+---+---+---+==================================+
				$idx = 0;
				while ( true ) {
					if ($idx >= $xlen) {
						break;
					}
					$si1 = ord ( substr ( $buff, $fpointer + $idx ++, 1 ) );
					$si2 = ord ( substr ( $buff, $fpointer + $idx ++, 1 ) );
					if (($si1 == 0x41) && ($si2 == 0x70)) {
						$w_xsublen = substr ( $buff, $fpointer + $idx, 2 );
						$xsublen = getid3_lib::LittleEndian2Int ( $w_xsublen );
						$idx += 2;
						$arr_xsubfield [] = substr ( $buff, $fpointer + $idx, $xsublen );
						$idx += $xsublen;
					} else {
						break;
					}
				}
				$fpointer += $xlen;
			}
			// bit 3 - FLG.FNAME
			//+=========================================+
			//|...original file name, zero-terminated...|
			//+=========================================+
			// GZIP files may have only one file, with no filename, so assume original filename is current filename without .gz
			$thisInfo ['filename'] = preg_replace ( '#\.gz$#i', '', $info ['filename'] );
			if ($thisInfo ['flags'] ['filename']) {
				while ( true ) {
					if (ord ( $buff [$fpointer] ) == 0) {
						$fpointer ++;
						break;
					}
					$thisInfo ['filename'] .= $buff [$fpointer];
					$fpointer ++;
				}
			}
			// bit 4 - FLG.FCOMMENT
			//+===================================+
			//|...file comment, zero-terminated...|
			//+===================================+
			if ($thisInfo ['flags'] ['comment']) {
				while ( true ) {
					if (ord ( $buff [$fpointer] ) == 0) {
						$fpointer ++;
						break;
					}
					$thisInfo ['comment'] .= $buff [$fpointer];
					$fpointer ++;
				}
			}
			// bit 1 - FLG.FHCRC
			//+---+---+
			//| CRC16 |
			//+---+---+
			if ($thisInfo ['flags'] ['crc16']) {
				$w_crc = substr ( $buff, $fpointer, 2 );
				$thisInfo ['crc16'] = getid3_lib::LittleEndian2Int ( $w_crc );
				$fpointer += 2;
			}
			// bit 0 - FLG.FTEXT
			//if ($thisInfo['raw']['flags'] & 0x01) {
			//	Ignored...
			//}
			// bits 5, 6, 7 - reserved
			

			$thisInfo ['crc32'] = getid3_lib::LittleEndian2Int ( substr ( $buff, strlen ( $buff ) - 8, 4 ) );
			$thisInfo ['filesize'] = getid3_lib::LittleEndian2Int ( substr ( $buff, strlen ( $buff ) - 4 ) );
			
			$info ['gzip'] ['files'] = getid3_lib::array_merge_clobber ( $info ['gzip'] ['files'], getid3_lib::CreateDeepArray ( $thisInfo ['filename'], '/', $thisInfo ['filesize'] ) );
			
			if ($this->option_gzip_parse_contents) {
				// Try to inflate GZip
				$csize = 0;
				$inflated = '';
				$chkcrc32 = '';
				if (function_exists ( 'gzinflate' )) {
					$cdata = substr ( $buff, $fpointer );
					$cdata = substr ( $cdata, 0, strlen ( $cdata ) - 8 );
					$csize = strlen ( $cdata );
					$inflated = gzinflate ( $cdata );
					
					// Calculate CRC32 for inflated content
					$thisInfo ['crc32_valid'] = ( bool ) (sprintf ( '%u', crc32 ( $inflated ) ) == $thisInfo ['crc32']);
					
					// determine format
					$formattest = substr ( $inflated, 0, 32774 );
					$getid3_temp = new getID3 ();
					$determined_format = $getid3_temp->GetFileFormat ( $formattest );
					unset ( $getid3_temp );
					
					// file format is determined
					$determined_format ['module'] = (isset ( $determined_format ['module'] ) ? $determined_format ['module'] : '');
					switch ($determined_format ['module']) {
						case 'tar' :
							// view TAR-file info
							if (file_exists ( GETID3_INCLUDEPATH . $determined_format ['include'] ) && include_once (GETID3_INCLUDEPATH . $determined_format ['include'])) {
								if (($temp_tar_filename = tempnam ( GETID3_TEMP_DIR, 'getID3' )) === false) {
									// can't find anywhere to create a temp file, abort
									$info ['error'] [] = 'Unable to create temp file to parse TAR inside GZIP file';
									break;
								}
								if (($fp_temp_tar = fopen ( $temp_tar_filename, 'w+b' )) != false) {
									fwrite ( $fp_temp_tar, $inflated );
									fclose ( $fp_temp_tar );
									$getid3_temp = new getID3 ();
									$getid3_temp->openfile ( $temp_tar_filename );
									$getid3_tar = new getid3_tar ( $getid3_temp );
									$getid3_tar->Analyze ();
									$info ['gzip'] ['member_header'] [$idx] ['tar'] = $getid3_temp->info ['tar'];
									unset ( $getid3_temp, $getid3_tar );
									unlink ( $temp_tar_filename );
								} else {
									$info ['error'] [] = 'Unable to fopen() temp file to parse TAR inside GZIP file';
									break;
								}
							}
							break;
						
						case '' :
						default :
							// unknown or unhandled format
							break;
					}
				}
			}
		}
		return true;
	}
	
	// Converts the OS type
	function get_os_type($key) {
		static $os_type = array ('0' => 'FAT filesystem (MS-DOS, OS/2, NT/Win32)', '1' => 'Amiga', '2' => 'VMS (or OpenVMS)', '3' => 'Unix', '4' => 'VM/CMS', '5' => 'Atari TOS', '6' => 'HPFS filesystem (OS/2, NT)', '7' => 'Macintosh', '8' => 'Z-System', '9' => 'CP/M', '10' => 'TOPS-20', '11' => 'NTFS filesystem (NT)', '12' => 'QDOS', '13' => 'Acorn RISCOS', '255' => 'unknown' );
		return (isset ( $os_type [$key] ) ? $os_type [$key] : '');
	}
	
	// Converts the eXtra FLags
	function get_xflag_type($key) {
		static $xflag_type = array ('0' => 'unknown', '2' => 'maximum compression', '4' => 'fastest algorithm' );
		return (isset ( $xflag_type [$key] ) ? $xflag_type [$key] : '');
	}
}
Back to Top