lib/ziplib.php

   1 <?php
   2
   3 /**
   4  * GZIP stuff.
   5  *
   6  * Note that we use gzopen()/gzwrite() instead of gzcompress() even if
   7  * gzcompress() is available.  Gzcompress() puts out data with
   8  * different headers --- in particular it includes an "adler-32"
   9  * checksum rather than a "CRC32" checksum. Since we need the CRC-32
  10  * checksum, and since not all PHP's have gzcompress(), we'll just
  11  * stick with gzopen().
  12  */
  13 function gzip_cleanup()
  14 {
  15     global $gzip_tmpfile;
  16
  17     if ($gzip_tmpfile)
  18         @unlink($gzip_tmpfile);
  19 }
  20
  21 function gzip_tempnam()
  22 {
  23     global $gzip_tmpfile;
  24
  25     if (!$gzip_tmpfile) {
  26         //FIXME: does this work on non-unix machines?
  27         if (is_writable("/tmp"))
  28             $gzip_tmpfile = tempnam("/tmp", "wkzip");
  29         else
  30             $gzip_tmpfile = tempnam(TEMP_DIR, "wkzip");
  31         register_shutdown_function("gzip_cleanup");
  32     }
  33     return $gzip_tmpfile;
  34 }
  35
  36 function gzip_compress($data)
  37 {
  38     $filename = gzip_tempnam();
  39     if (!($fp = gzopen($filename, "wb")))
  40         trigger_error(sprintf("%s failed", 'gzopen'), E_USER_ERROR);
  41     gzwrite($fp, $data, strlen($data));
  42     if (!gzclose($fp)) {
  43         trigger_error(sprintf("%s failed", 'gzclose'), E_USER_ERROR);
  44     }
  45     $z = NULL;
  46     if (!($fp = fopen($filename, "rb"))) {
  47         trigger_error(sprintf("%s failed", 'fopen'), E_USER_ERROR);
  48     }
  49     while (!feof($fp)) {
  50         $z .= fread($fp, 1024);
  51     }
  52     if (!fclose($fp))
  53         trigger_error(sprintf("%s failed", 'fclose'), E_USER_ERROR);
  54     unlink($filename);
  55     return $z;
  56 }
  57
  58 function gzip_uncompress($data)
  59 {
  60     $filename = gzip_tempnam();
  61     if (!($fp = fopen($filename, "wb")))
  62         trigger_error(sprintf("%s failed", 'fopen'), E_USER_ERROR);
  63     fwrite($fp, $data, strlen($data));
  64     if (!fclose($fp))
  65         trigger_error(sprintf("%s failed", 'fclose'), E_USER_ERROR);
  66
  67     if (!($fp = gzopen($filename, "rb")))
  68         trigger_error(sprintf("%s failed", 'gzopen'), E_USER_ERROR);
  69     $unz = '';
  70     while ($buf = gzread($fp, 4096))
  71         $unz .= $buf;
  72     if (!gzclose($fp))
  73         trigger_error(sprintf("%s failed", 'gzclose'), E_USER_ERROR);
  74
  75     unlink($filename);
  76     return $unz;
  77 }
  78
  79 /**
  80  * CRC32 computation.  Hacked from Info-zip's zip-2.3 source code.
  81  */
  82
  83 function zip_crc32($str, $crc = 0)
  84 {
  85     static $zip_crc_table;
  86
  87     if (empty($zip_crc_table)) {
  88         /* NOTE: The range of PHP ints seems to be -0x80000000 to 0x7fffffff.
  89          * So, had to munge these constants.
  90          */
  91         $zip_crc_table
  92             = array(0x00000000, 0x77073096, -0x11f19ed4, -0x66f6ae46, 0x076dc419,
  93             0x706af48f, -0x169c5acb, -0x619b6a5d, 0x0edb8832, 0x79dcb8a4,
  94             -0x1f2a16e2, -0x682d2678, 0x09b64c2b, 0x7eb17cbd, -0x1847d2f9,
  95             -0x6f40e26f, 0x1db71064, 0x6ab020f2, -0x0c468eb8, -0x7b41be22,
  96             0x1adad47d, 0x6ddde4eb, -0x0b2b4aaf, -0x7c2c7a39, 0x136c9856,
  97             0x646ba8c0, -0x029d0686, -0x759a3614, 0x14015c4f, 0x63066cd9,
  98             -0x05f0c29d, -0x72f7f20b, 0x3b6e20c8, 0x4c69105e, -0x2a9fbe1c,
  99             -0x5d988e8e, 0x3c03e4d1, 0x4b04d447, -0x2df27a03, -0x5af54a95,
 100             0x35b5a8fa, 0x42b2986c, -0x2444362a, -0x534306c0, 0x32d86ce3,
 101             0x45df5c75, -0x2329f231, -0x542ec2a7, 0x26d930ac, 0x51de003a,
 102             -0x3728ae80, -0x402f9eea, 0x21b4f4b5, 0x56b3c423, -0x30456a67,
 103             -0x47425af1, 0x2802b89e, 0x5f058808, -0x39f3264e, -0x4ef416dc,
 104             0x2f6f7c87, 0x58684c11, -0x3e9ee255, -0x4999d2c3, 0x76dc4190,
 105             0x01db7106, -0x672ddf44, -0x102aefd6, 0x71b18589, 0x06b6b51f,
 106             -0x60401b5b, -0x17472bcd, 0x7807c9a2, 0x0f00f934, -0x69f65772,
 107             -0x1ef167e8, 0x7f6a0dbb, 0x086d3d2d, -0x6e9b9369, -0x199ca3ff,
 108             0x6b6b51f4, 0x1c6c6162, -0x7a9acf28, -0x0d9dffb2, 0x6c0695ed,
 109             0x1b01a57b, -0x7df70b3f, -0x0af03ba9, 0x65b0d9c6, 0x12b7e950,
 110             -0x74414716, -0x03467784, 0x62dd1ddf, 0x15da2d49, -0x732c830d,
 111             -0x042bb39b, 0x4db26158, 0x3ab551ce, -0x5c43ff8c, -0x2b44cf1e,
 112             0x4adfa541, 0x3dd895d7, -0x5b2e3b93, -0x2c290b05, 0x4369e96a,
 113             0x346ed9fc, -0x529877ba, -0x259f4730, 0x44042d73, 0x33031de5,
 114             -0x55f5b3a1, -0x22f28337, 0x5005713c, 0x270241aa, -0x41f4eff0,
 115             -0x36f3df7a, 0x5768b525, 0x206f85b3, -0x46992bf7, -0x319e1b61,
 116             0x5edef90e, 0x29d9c998, -0x4f2f67de, -0x3828574c, 0x59b33d17,
 117             0x2eb40d81, -0x4842a3c5, -0x3f459353, -0x12477ce0, -0x65404c4a,
 118             0x03b6e20c, 0x74b1d29a, -0x152ab8c7, -0x622d8851, 0x04db2615,
 119             0x73dc1683, -0x1c9cf4ee, -0x6b9bc47c, 0x0d6d6a3e, 0x7a6a5aa8,
 120             -0x1bf130f5, -0x6cf60063, 0x0a00ae27, 0x7d079eb1, -0x0ff06cbc,
 121             -0x78f75c2e, 0x1e01f268, 0x6906c2fe, -0x089da8a3, -0x7f9a9835,
 122             0x196c3671, 0x6e6b06e7, -0x012be48a, -0x762cd420, 0x10da7a5a,
 123             0x67dd4acc, -0x06462091, -0x71411007, 0x17b7be43, 0x60b08ed5,
 124             -0x29295c18, -0x5e2e6c82, 0x38d8c2c4, 0x4fdff252, -0x2e44980f,
 125             -0x5943a899, 0x3fb506dd, 0x48b2364b, -0x27f2d426, -0x50f5e4b4,
 126             0x36034af6, 0x41047a60, -0x209f103d, -0x579820ab, 0x316e8eef,
 127             0x4669be79, -0x349e4c74, -0x43997ce6, 0x256fd2a0, 0x5268e236,
 128             -0x33f3886b, -0x44f4b8fd, 0x220216b9, 0x5505262f, -0x3a45c442,
 129             -0x4d42f4d8, 0x2bb45a92, 0x5cb36a04, -0x3d280059, -0x4a2f30cf,
 130             0x2cd99e8b, 0x5bdeae1d, -0x649b3d50, -0x139c0dda, 0x756aa39c,
 131             0x026d930a, -0x63f6f957, -0x14f1c9c1, 0x72076785, 0x05005713,
 132             -0x6a40b57e, -0x1d4785ec, 0x7bb12bae, 0x0cb61b38, -0x6d2d7165,
 133             -0x1a2a41f3, 0x7cdcefb7, 0x0bdbdf21, -0x792c2d2c, -0x0e2b1dbe,
 134             0x68ddb3f8, 0x1fda836e, -0x7e41e933, -0x0946d9a5, 0x6fb077e1,
 135             0x18b74777, -0x77f7a51a, -0x00f09590, 0x66063bca, 0x11010b5c,
 136             -0x709a6101, -0x079d5197, 0x616bffd3, 0x166ccf45, -0x5ff51d88,
 137             -0x28f22d12, 0x4e048354, 0x3903b3c2, -0x5898d99f, -0x2f9fe909,
 138             0x4969474d, 0x3e6e77db, -0x512e95b6, -0x2629a524, 0x40df0b66,
 139             0x37d83bf0, -0x564351ad, -0x2144613b, 0x47b2cf7f, 0x30b5ffe9,
 140             -0x42420de4, -0x35453d76, 0x53b39330, 0x24b4a3a6, -0x452fc9fb,
 141             -0x3228f96d, 0x54de5729, 0x23d967bf, -0x4c9985d2, -0x3b9eb548,
 142             0x5d681b02, 0x2a6f2b94, -0x4bf441c9, -0x3cf3715f, 0x5a05df1b,
 143             0x2d02ef8d);
 144     }
 145
 146     $crc = ~$crc;
 147     for ($i = 0; $i < strlen($str); $i++) {
 148         $crc = ($zip_crc_table[($crc ^ ord($str[$i])) & 0xff]
 149             ^ (($crc >> 8) & 0xffffff));
 150     }
 151     return ~$crc;
 152 }
 153
 154 define('GZIP_MAGIC', "\037\213");
 155 define('GZIP_DEFLATE', 010);
 156
 157 function zip_deflate($content)
 158 {
 159     // Compress content, and suck information from gzip header.
 160     $z = gzencode($content);
 161
 162     // Suck OS type byte from gzip header. FIXME: this smells bad.
 163
 164     extract(unpack("a2magic/Ccomp_type/Cflags/@9/Cos_type", $z));
 165
 166     if ($magic != GZIP_MAGIC)
 167         trigger_error(sprintf("Bad %s", "gzip magic"), E_USER_ERROR);
 168     if ($comp_type != GZIP_DEFLATE)
 169         trigger_error(sprintf("Bad %s", "gzip comp type"), E_USER_ERROR);
 170     if (($flags & 0x3e) != 0)
 171         trigger_error(sprintf("Bad %s", sprintf("flags (0x%02x)", $flags)),
 172             E_USER_ERROR);
 173
 174     $gz_header_len = 10;
 175     $gz_data_len = strlen($z) - $gz_header_len - 8;
 176     if ($gz_data_len < 0)
 177         trigger_error("not enough gzip output?", E_USER_ERROR);
 178
 179     extract(unpack("Vcrc32", substr($z, $gz_header_len + $gz_data_len)));
 180
 181     return array(substr($z, $gz_header_len, $gz_data_len), // gzipped data
 182         $crc32, // crc
 183         $os_type // OS type
 184     );
 185 }
 186
 187 function zip_inflate($data, $crc32, $uncomp_size)
 188 {
 189     $data = gzinflate($data);
 190     if (strlen($data) != $uncomp_size)
 191         trigger_error("not enough output from gzinflate", E_USER_ERROR);
 192     $zcrc32 = zip_crc32($data);
 193     if ($zcrc32 < 0) { // force unsigned
 194         $zcrc32 += 4294967296;
 195     }
 196     if ($crc32 < 0) { // force unsigned
 197         $crc32 += 4294967296;
 198     }
 199     if ($zcrc32 != $crc32)
 200         trigger_error("CRC32 mismatch: calculated=$zcrc32, expected=$crc32", E_USER_ERROR);
 201     return $data;
 202 }
 203
 204 function unixtime2dostime($unix_time)
 205 {
 206     if ($unix_time % 1)
 207         $unix_time++; // Round up to even seconds.
 208
 209     list ($year, $month, $mday, $hour, $min, $sec)
 210         = explode(" ", date("Y n j G i s", $unix_time));
 211
 212     if ($year < 1980)
 213         list ($year, $month, $mday, $hour, $min, $sec) = array(1980, 1, 1, 0, 0, 0);
 214
 215     $dosdate = (($year - 1980) << 9) | ($month << 5) | $mday;
 216     $dostime = ($hour << 11) | ($min << 5) | ($sec >> 1);
 217
 218     return array($dosdate, $dostime);
 219 }
 220
 221 function dostime2unixtime($dosdate, $dostime)
 222 {
 223     $mday = $dosdate & 0x1f;
 224     $month = ($dosdate >> 5) & 0x0f;
 225     $year = 1980 + (($dosdate >> 9) & 0x7f);
 226
 227     $sec = ($dostime & 0x1f) * 2;
 228     $min = ($dostime >> 5) & 0x3f;
 229     $hour = ($dostime >> 11) & 0x1f;
 230
 231     return mktime($hour, $min, $sec, $month, $mday, $year);
 232 }
 233
 234 /**
 235  * Class for zipfile creation.
 236  */
 237 define('ZIP_DEFLATE', GZIP_DEFLATE);
 238 define('ZIP_STORE', 0);
 239 define('ZIP_CENTHEAD_MAGIC', "PK\001\002");
 240 define('ZIP_LOCHEAD_MAGIC', "PK\003\004");
 241 define('ZIP_ENDDIR_MAGIC', "PK\005\006");
 242
 243 class ZipWriter
 244 {
 245     function ZipWriter($comment = "", $zipname = "archive.zip")
 246     {
 247         $this->comment = $comment;
 248         $this->nfiles = 0;
 249         $this->dir = ""; // "Central directory block"
 250         $this->offset = 0; // Current file position.
 251
 252         $zipname = addslashes($zipname);
 253         header("Content-Type: application/zip; name=\"$zipname\"");
 254         header("Content-Disposition: attachment; filename=\"$zipname\"");
 255     }
 256
 257     function addSrcFile($target, $src, $attrib = array())
 258     {
 259         if (empty($attrib['mtime']))
 260             $attrib = array('mtime' => filemtime($src), 'is_ascii' => 0);
 261         $this->addRegularFile($target, file_get_contents($src), $attrib);
 262     }
 263
 264     function addRegularFile($filename, $content, $attrib = array())
 265     {
 266         $size = strlen($content);
 267         list ($data, $crc32, $os_type) = zip_deflate($content);
 268         if (strlen($data) < $size) {
 269             $content = $data; // Use compressed data.
 270             $comp_type = ZIP_DEFLATE;
 271         } else
 272             unset($crc32); // force plain store.
 273
 274         if (!isset($crc32)) {
 275             $comp_type = ZIP_STORE;
 276             $crc32 = zip_crc32($content);
 277         }
 278
 279         if (!empty($attrib['write_protected']))
 280             $atx = (0100444 << 16) | 1; // S_IFREG + read permissions to
 281         // everybody.
 282         else
 283             $atx = (0100644 << 16); // Add owner write perms.
 284
 285         $ati = $attrib['is_ascii'] ? 1 : 0;
 286
 287         if (empty($attrib['mtime']))
 288             $attrib['mtime'] = time();
 289         list ($mod_date, $mod_time) = unixtime2dostime($attrib['mtime']);
 290
 291         // Construct parts common to "Local file header" and "Central
 292         // directory file header."
 293         if (!isset($attrib['extra_field']))
 294             $attrib['extra_field'] = '';
 295         if (!isset($attrib['file_comment']))
 296             $attrib['file_comment'] = '';
 297
 298         $head = pack("vvvvvVVVvv",
 299             20, // Version needed to extract (FIXME: is this right?)
 300             0, // Gen purp bit flag
 301             $comp_type,
 302             $mod_time,
 303             $mod_date,
 304             $crc32,
 305             strlen($content),
 306             $size,
 307             strlen($filename),
 308             strlen($attrib['extra_field']));
 309
 310         // Construct the "Local file header"
 311         $lheader = ZIP_LOCHEAD_MAGIC . $head . $filename
 312             . $attrib['extra_field'];
 313
 314         // Construct the "central directory file header"
 315         $this->dir .= pack("a4CC",
 316             ZIP_CENTHEAD_MAGIC,
 317             23, // Version made by (FIXME: is this right?)
 318             $os_type);
 319         $this->dir .= $head;
 320         $this->dir .= pack("vvvVV",
 321             strlen($attrib['file_comment']),
 322             0, // Disk number start
 323             $ati, // Internal file attributes
 324             $atx, // External file attributes
 325             $this->offset); // Relative offset of local header
 326         $this->dir .= $filename . $attrib['extra_field']
 327             . $attrib['file_comment'];
 328
 329         // Output the "Local file header" and file contents.
 330         echo $lheader;
 331         echo $content;
 332
 333         $this->offset += strlen($lheader) + strlen($content);
 334         $this->nfiles++;
 335     }
 336
 337     function finish()
 338     {
 339         // Output the central directory
 340         echo $this->dir;
 341
 342         // Construct the "End of central directory record"
 343         echo ZIP_ENDDIR_MAGIC;
 344         echo pack("vvvvVVv",
 345             0, // Number of this disk.
 346             0, // Number of disk with start of c dir
 347             $this->nfiles, // Number entries on this disk
 348             $this->nfiles, // Number entries
 349             strlen($this->dir), // Size of central directory
 350             $this->offset, // Offset of central directory
 351             strlen($this->comment));
 352         echo $this->comment;
 353     }
 354 }
 355
 356 /**
 357  * Class for reading zip files. Handles buffers also.
 358  *
 359  * BUGS:
 360  *
 361  * Many of the ExitWiki()'s should probably be warn()'s (eg. CRC mismatch).
 362  *
 363  * Only a subset of zip formats is recognized. (I think that
 364  * unsupported formats will be recognized as such rather than silently
 365  * munged.)
 366  *
 367  * We don't read the central directory. This means we don't see the
 368  * file attributes (text? read-only?), or file comments.
 369  *
 370  * Right now we ignore the file mod date and time, since we don't need it.
 371  */
 372 class ZipReader
 373 {
 374     function ZipReader($zipfile)
 375     {
 376         if (!is_string($zipfile)) { // filepointer: File already open
 377             $this->fp = $zipfile;
 378             $zipfile = NULL;
 379         } elseif (((ord($zipfile[0]) * 256 + ord($zipfile[1])) % 31 == 0) // buffer
 380             and (substr($zipfile, 0, 2) == "\037\213")
 381             or (substr($zipfile, 0, 2) == "x\332")
 382         ) { // 120, 218
 383             $this->fp = NULL;
 384             $this->buf = $zipfile;
 385             $zipfile = NULL;
 386         }
 387         if ($zipfile) {
 388             $this->zipfile = $zipfile;
 389             if (!($this->fp = fopen($zipfile, "rb"))) {
 390                 trigger_error(sprintf(_("Can't open zip file “%s” for reading"),
 391                     $zipfile), E_USER_ERROR);
 392             }
 393         }
 394     }
 395
 396     function _read($nbytes)
 397     {
 398         if ($this->fp) {
 399             $chunk = fread($this->fp, $nbytes);
 400             if (strlen($chunk) != $nbytes)
 401                 trigger_error(_("Unexpected EOF in zip file"), E_USER_ERROR);
 402             return $chunk;
 403         } elseif ($this->buf) {
 404             if (strlen($this->buf) < $nbytes)
 405                 trigger_error(_("Unexpected EOF in zip file"), E_USER_ERROR);
 406             $chunk = substr($this->buf, 0, $nbytes);
 407             $this->buf = substr($this->buf, $nbytes);
 408             return $chunk;
 409         }
 410     }
 411
 412     function done()
 413     {
 414         if ($this->fp)
 415             fclose($this->fp);
 416         else
 417             $this->buf = '';
 418         return false;
 419     }
 420
 421     function readFile()
 422     {
 423         $head = $this->_read(30); // FIXME: This is bad for gzip compressed buffers
 424
 425         extract(unpack("a4magic/vreq_version/vflags/vcomp_type"
 426                 . "/vmod_time/vmod_date"
 427                 . "/Vcrc32/Vcomp_size/Vuncomp_size"
 428                 . "/vfilename_len/vextrafld_len",
 429             $head));
 430
 431         if ($magic != ZIP_LOCHEAD_MAGIC) {
 432             // maybe gzip?
 433             //$x = substr($magic,0,3);
 434             if (substr($magic, 0, 3) == "\037\213\225") //and (substr($magic,3,1) & 0x3e) == 0)
 435             {
 436                 if ($this->fp) {
 437                     fclose($this->fp);
 438                     $this->fp = fopen($this->zipfile, "rb");
 439                     $content = $this->_read(filesize($this->fp));
 440                 } else {
 441                     $content = $this->buf;
 442                 }
 443                 // TODO...
 444                 $data = zip_deflate($content);
 445                 return array($filename, $data, $attrib);
 446             }
 447             if ($magic != ZIP_CENTHEAD_MAGIC)
 448                 // FIXME: better message?
 449                 ExitWiki(sprintf("Unsupported ZIP header type: %s", $magic));
 450             return $this->done();
 451         }
 452         if (($flags & 0x21) != 0)
 453             ExitWiki("Encryption and/or zip patches not supported.");
 454         if (($flags & 0x08) != 0)
 455             // FIXME: better message?
 456             ExitWiki("Postponed CRC not yet supported.");
 457
 458         $filename = $this->_read($filename_len);
 459         //FIXME: we should probably check $req_version.
 460         $attrib['mtime'] = dostime2unixtime($mod_date, $mod_time);
 461         if ($extrafld_len != 0)
 462             $attrib['extra_field'] = $this->_read($extrafld_len);
 463
 464         $data = $this->_read($comp_size);
 465
 466         if ($comp_type == ZIP_DEFLATE) {
 467             $data = zip_inflate($data, $crc32, $uncomp_size);
 468         } elseif ($comp_type == ZIP_STORE) {
 469             $crc = zip_crc32($data);
 470             if ($crc32 != $crc)
 471                 ExitWiki(sprintf("CRC mismatch %x != %x", $crc, $crc32));
 472         } else
 473             ExitWiki(sprintf("Compression method %s unsupported",
 474                 $comp_method));
 475
 476         if (strlen($data) != $uncomp_size)
 477             ExitWiki(sprintf("Uncompressed size mismatch %d != %d",
 478                 strlen($data), $uncomp_size));
 479
 480         return array($filename, $data, $attrib);
 481     }
 482 }
 483
 484 /**
 485  * Routines for Mime mailification of pages.
 486  */
 487 //FIXME: these should go elsewhere (libmime?).
 488
 489 /**
 490  * Routines for quoted-printable en/decoding.
 491  */
 492 function QuotedPrintableEncode($string)
 493 {
 494     // Quote special characters in line.
 495     $quoted = "";
 496     while ($string) {
 497         // The complicated regexp is to force quoting of trailing spaces.
 498         preg_match('/^([ !-<>-~]*)(?:([!-<>-~]$)|(.))/s', $string, $match);
 499         $quoted .= $match[1] . $match[2];
 500         if (!empty($match[3]))
 501             $quoted .= sprintf("=%02X", ord($match[3]));
 502         $string = substr($string, strlen($match[0]));
 503     }
 504     // Split line.
 505     // This splits the line (preferably after white-space) into lines
 506     // which are no longer than 76 chars (after adding trailing '=' for
 507     // soft line break, but before adding \r\n.)
 508     return preg_replace('/(?=.{77})(.{10,74}[ \t]|.{71,73}[^=][^=])/s',
 509         "\\1=\r\n", $quoted);
 510 }
 511
 512 function QuotedPrintableDecode($string)
 513 {
 514     // Eliminate soft line-breaks.
 515     $string = preg_replace('/=[ \t\r]*\n/', '', $string);
 516     return quoted_printable_decode($string);
 517 }
 518
 519 define('MIME_TOKEN_REGEXP', "[-!#-'*+.0-9A-Z^-~]+");
 520
 521 function MimeContentTypeHeader($type, $subtype, $params)
 522 {
 523     $header = "Content-Type: $type/$subtype";
 524     reset($params);
 525     while (list($key, $val) = each($params)) {
 526         //FIXME:  what about non-ascii printables in $val?
 527         if (!preg_match('/^' . MIME_TOKEN_REGEXP . '$/', $val))
 528             $val = '"' . addslashes($val) . '"';
 529         $header .= ";\r\n  $key=$val";
 530     }
 531     return "$header\r\n";
 532 }
 533
 534 function MimeMultipart($parts)
 535 {
 536     global $mime_multipart_count;
 537
 538     // The string "=_" can not occur in quoted-printable encoded data.
 539     $boundary = "=_multipart_boundary_" . ++$mime_multipart_count;
 540
 541     $head = MimeContentTypeHeader('multipart', 'mixed',
 542         array('boundary' => $boundary));
 543
 544     $sep = "\r\n--$boundary\r\n";
 545
 546     return $head . $sep . implode($sep, $parts) . "\r\n--${boundary}--\r\n";
 547 }
 548
 549 /**
 550  * For reference see:
 551  * http://www.nacs.uci.edu/indiv/ehood/MIME/2045/rfc2045.html
 552  * http://www.faqs.org/rfcs/rfc2045.html
 553  * (RFC 1521 has been superceeded by RFC 2045 & others).
 554  *
 555  * Also see http://www.faqs.org/rfcs/rfc2822.html
 556  *
 557  *
 558  * Notes on content-transfer-encoding.
 559  *
 560  * "7bit" means short lines of US-ASCII.
 561  * "8bit" means short lines of octets with (possibly) the high-order bit set.
 562  * "binary" means lines are not necessarily short enough for SMTP
 563  * transport, and non-ASCII characters may be present.
 564  *
 565  * Only "7bit", "quoted-printable", and "base64" are universally safe
 566  * for transport via e-mail.  (Though many MTAs can/will be configured to
 567  * automatically convert encodings to a safe type if they receive
 568  * mail encoded in '8bit' and/or 'binary' encodings.
 569  */
 570 function MimeifyPageRevision(&$page, &$revision)
 571 {
 572     // $wikidb =& $revision->_wikidb;
 573     // $page = $wikidb->getPage($revision->getName());
 574     // FIXME: add 'hits' to $params
 575     $params = array('pagename' => $page->getName(),
 576         'flags' => "",
 577         'author' => $revision->get('author'),
 578         'owner' => $page->getOwner(),
 579         'version' => $revision->getVersion(),
 580         'lastmodified' => $revision->get('mtime'));
 581
 582     if ($page->get('mtime'))
 583         $params['created'] = $page->get('mtime');
 584     if ($page->get('locked'))
 585         $params['flags'] = 'PAGE_LOCKED';
 586     if (ENABLE_EXTERNAL_PAGES && $page->get('external'))
 587         $params['flags'] = ($params['flags'] ? $params['flags'] . ',EXTERNAL_PAGE' : 'EXTERNAL_PAGE');
 588     if ($revision->get('author_id'))
 589         $params['author_id'] = $revision->get('author_id');
 590     if ($revision->get('summary'))
 591         $params['summary'] = $revision->get('summary');
 592     if ($page->get('hits'))
 593         $params['hits'] = $page->get('hits');
 594     if ($page->get('owner'))
 595         $params['owner'] = $page->get('owner');
 596     if ($page->get('perm') and class_exists('PagePermission')) {
 597         $acl = getPagePermissions($page);
 598         $params['acl'] = $acl->asAclLines();
 599         //TODO: convert to multiple lines? acl-view => groups,...; acl-edit => groups,...
 600     }
 601
 602     // Non-US-ASCII is not allowed in Mime headers (at least not without
 603     // special handling) --- so we urlencode all parameter values.
 604     foreach ($params as $key => $val)
 605         $params[$key] = rawurlencode($val);
 606     if (isset($params['acl']))
 607         // default: "view:_EVERY; edit:_AUTHENTICATED; create:_AUTHENTICATED,_BOGOUSER; ".
 608         //          "list:_EVERY; remove:_ADMIN,_OWNER; change:_ADMIN,_OWNER; dump:_EVERY; "
 609         $params['acl'] = str_replace(array("%3A", "%3B%20", "%2C"), array(":", "; ", ","), $params['acl']);
 610
 611     $out = MimeContentTypeHeader('application', 'x-phpwiki', $params);
 612     $out .= sprintf("Content-Transfer-Encoding: %s\r\n",
 613         STRICT_MAILABLE_PAGEDUMPS ? 'quoted-printable' : 'binary');
 614
 615     $out .= "\r\n";
 616
 617     foreach ($revision->getContent() as $line) {
 618         // This is a dirty hack to allow saving binary text files. See above.
 619         $line = rtrim($line);
 620         if (STRICT_MAILABLE_PAGEDUMPS)
 621             $line = QuotedPrintableEncode(rtrim($line));
 622         $out .= "$line\r\n";
 623     }
 624     return $out;
 625 }
 626
 627 /**
 628  * Routines for parsing Mime-ified phpwiki pages.
 629  */
 630 function ParseRFC822Headers(&$string)
 631 {
 632     if (preg_match("/^From (.*)\r?\n/", $string, $match)) {
 633         $headers['from '] = preg_replace('/^\s+|\s+$/', '', $match[1]);
 634         $string = substr($string, strlen($match[0]));
 635     }
 636
 637     while (preg_match('/^([!-9;-~]+) [ \t]* : [ \t]* '
 638             . '( .* \r?\n (?: [ \t] .* \r?\n)* )/x',
 639         $string, $match)) {
 640         $headers[strtolower($match[1])]
 641             = preg_replace('/^\s+|\s+$/', '', $match[2]);
 642         $string = substr($string, strlen($match[0]));
 643     }
 644
 645     if (empty($headers))
 646         return false;
 647
 648     if (strlen($string) > 0) {
 649         if (!preg_match("/^\r?\n/", $string, $match)) {
 650             // No blank line after headers.
 651             return false;
 652         }
 653         $string = substr($string, strlen($match[0]));
 654     }
 655
 656     return $headers;
 657 }
 658
 659 function ParseMimeContentType($string)
 660 {
 661     // FIXME: Remove (RFC822 style comments).
 662
 663     // Get type/subtype
 664     if (!preg_match(':^\s*(' . MIME_TOKEN_REGEXP . ')\s*'
 665             . '/'
 666             . '\s*(' . MIME_TOKEN_REGEXP . ')\s*:x',
 667         $string, $match)
 668     )
 669         ExitWiki(sprintf("Bad %s", 'MIME content-type'));
 670
 671     $type = strtolower($match[1]);
 672     $subtype = strtolower($match[2]);
 673     $string = substr($string, strlen($match[0]));
 674
 675     $param = array();
 676     while (preg_match('/^;\s*(' . MIME_TOKEN_REGEXP . ')\s*=\s*'
 677             . '(?:(' . MIME_TOKEN_REGEXP . ')|"((?:[^"\\\\]|\\.)*)") \s*/sx',
 678         $string, $match)) {
 679         //" <--kludge for brain-dead syntax coloring
 680         if (strlen($match[2]))
 681             $val = $match[2];
 682         else
 683             $val = preg_replace('/[\\\\](.)/s', '\\1', $match[3]);
 684
 685         $param[strtolower($match[1])] = $val;
 686
 687         $string = substr($string, strlen($match[0]));
 688     }
 689
 690     return array($type, $subtype, $param);
 691 }
 692
 693 function ParseMimeMultipart($data, $boundary)
 694 {
 695     if (!$boundary)
 696         ExitWiki("No boundary?");
 697
 698     $boundary = preg_quote($boundary);
 699
 700     while (preg_match("/^(|.*?\n)--$boundary((?:--)?)[^\n]*\n/s",
 701         $data, $match)) {
 702         $data = substr($data, strlen($match[0]));
 703         if (!isset($parts))
 704             $parts = array(); // First time through: discard leading chaff
 705         else {
 706             if ($content = ParseMimeifiedPages($match[1]))
 707                 for (reset($content); $p = current($content); next($content))
 708                     $parts[] = $p;
 709         }
 710
 711         if ($match[2])
 712             return $parts; // End boundary found.
 713     }
 714     ExitWiki("No end boundary?");
 715 }
 716
 717 function GenerateFootnotesFromRefs($params)
 718 {
 719     $footnotes = array();
 720     reset($params);
 721     while (list($p, $reference) = each($params)) {
 722         if (preg_match('/^ref([1-9][0-9]*)$/', $p, $m))
 723             $footnotes[$m[1]] = sprintf(_("[%d] See [%s]"),
 724                 $m[1], rawurldecode($reference));
 725     }
 726
 727     if (sizeof($footnotes) > 0) {
 728         ksort($footnotes);
 729         return "-----\n"
 730             . "!" . _("References") . "\n"
 731             . join("\n%%%\n", $footnotes) . "\n";
 732     } else
 733         return "";
 734 }
 735
 736 // counterpart to $acl->asAclLines() and rawurl undecode
 737 // default: "view:_EVERY; edit:_AUTHENTICATED; create:_AUTHENTICATED,_BOGOUSER; ".
 738 //          "list:_EVERY; remove:_ADMIN,_OWNER; change:_ADMIN,_OWNER; dump:_EVERY; "
 739 function ParseMimeifiedPerm($string)
 740 {
 741     if (!class_exists('PagePermission')) {
 742         return '';
 743     }
 744     $hash = array();
 745     foreach (explode(";", trim($string)) as $accessgroup) {
 746         list($access, $groupstring) = explode(":", trim($accessgroup));
 747         $access = trim($access);
 748         $groups = explode(",", trim($groupstring));
 749         foreach ($groups as $group) {
 750             $group = trim($group);
 751             $bool = (boolean)(substr($group, 0, 1) != '-');
 752             if (substr($group, 0, 1) == '-' or substr($group, 0, 1) == '+')
 753                 $group = substr($group, 1);
 754             $hash[$access][$group] = $bool;
 755         }
 756     }
 757     $perm = new PagePermission($hash);
 758     $perm->sanify();
 759     return serialize($perm->perm);
 760 }
 761
 762 // Convert references in meta-data to footnotes.
 763 // Only zip archives generated by phpwiki 1.2.x or earlier should have
 764 // references.
 765 function ParseMimeifiedPages($data)
 766 {
 767     if (!($headers = ParseRFC822Headers($data))
 768         || empty($headers['content-type'])
 769     ) {
 770         //trigger_error( sprintf(_("Can't find %s"),'content-type header'),
 771         //               E_USER_WARNING );
 772         return false;
 773     }
 774     $typeheader = $headers['content-type'];
 775
 776     if (!(list ($type, $subtype, $params) = ParseMimeContentType($typeheader))) {
 777         trigger_error(sprintf("Can't parse %s: (%s)",
 778                 'content-type', $typeheader),
 779             E_USER_WARNING);
 780         return false;
 781     }
 782     if ("$type/$subtype" == 'multipart/mixed') {
 783         return ParseMimeMultipart($data, $params['boundary']);
 784     } elseif ("$type/$subtype" != 'application/x-phpwiki') {
 785         trigger_error(sprintf("Bad %s", "content-type: $type/$subtype"),
 786             E_USER_WARNING);
 787         return false;
 788     }
 789
 790     // FIXME: more sanity checking?
 791     $page = array();
 792     $pagedata = array();
 793     $versiondata = array();
 794     if (isset($headers['date']))
 795         $pagedata['date'] = strtotime($headers['date']);
 796
 797     //DONE: support owner and acl
 798     foreach ($params as $key => $value) {
 799         if (empty($value))
 800             continue;
 801         $value = rawurldecode($value);
 802         switch ($key) {
 803             case 'pagename':
 804             case 'version':
 805                 $page[$key] = $value;
 806                 break;
 807             case 'flags':
 808                 if (preg_match('/PAGE_LOCKED/', $value))
 809                     $pagedata['locked'] = 'yes';
 810                 if (ENABLE_EXTERNAL_PAGES && preg_match('/EXTERNAL_PAGE/', $value))
 811                     $pagedata['external'] = 'yes';
 812                 break;
 813             case 'owner':
 814             case 'created':
 815             case 'hits':
 816                 $pagedata[$key] = $value;
 817                 break;
 818             case 'acl':
 819             case 'perm':
 820                 if (class_exists('PagePermission')) {
 821                     $pagedata['perm'] = ParseMimeifiedPerm($value);
 822                 }
 823                 break;
 824             case 'lastmodified':
 825                 $versiondata['mtime'] = $value;
 826                 break;
 827             case 'author':
 828             case 'author_id':
 829             case 'summary':
 830             case 'pagetype':
 831                 $versiondata[$key] = $value;
 832                 break;
 833         }
 834     }
 835
 836     // FIXME: do we need to try harder to find a pagename if we
 837     //        haven't got one yet?
 838     if (!isset($versiondata['author'])) {
 839         global $request;
 840         if (is_object($request)) {
 841             $user = $request->getUser();
 842             $versiondata['author'] = $user->getId(); //FIXME:?
 843         }
 844     }
 845
 846     $encoding = strtolower($headers['content-transfer-encoding']);
 847     if ($encoding == 'quoted-printable')
 848         $data = QuotedPrintableDecode($data);
 849     else if ($encoding && $encoding != 'binary')
 850         ExitWiki(sprintf("Unknown %s", 'encoding type: $encoding'));
 851
 852     $data .= GenerateFootnotesFromRefs($params);
 853
 854     $page['content'] = preg_replace('/[ \t\r]*\n/', "\n", chop($data));
 855     $page['pagedata'] = $pagedata;
 856     $page['versiondata'] = $versiondata;
 857
 858     return array($page);
 859 }
 860
 861 // Local Variables:
 862 // mode: php
 863 // tab-width: 8
 864 // c-basic-offset: 4
 865 // c-hanging-comment-ender-p: nil
 866 // indent-tabs-mode: nil
 867 // End: