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     if (function_exists('gzencode'))
 161         $z = gzencode($content);
 162     else
 163         $z = gzip_compress($content);
 164
 165     // Suck OS type byte from gzip header. FIXME: this smells bad.
 166
 167     extract(unpack("a2magic/Ccomp_type/Cflags/@9/Cos_type", $z));
 168
 169     if ($magic != GZIP_MAGIC)
 170         trigger_error(sprintf("Bad %s", "gzip magic"), E_USER_ERROR);
 171     if ($comp_type != GZIP_DEFLATE)
 172         trigger_error(sprintf("Bad %s", "gzip comp type"), E_USER_ERROR);
 173     if (($flags & 0x3e) != 0)
 174         trigger_error(sprintf("Bad %s", sprintf("flags (0x%02x)", $flags)),
 175             E_USER_ERROR);
 176
 177     $gz_header_len = 10;
 178     $gz_data_len = strlen($z) - $gz_header_len - 8;
 179     if ($gz_data_len < 0)
 180         trigger_error("not enough gzip output?", E_USER_ERROR);
 181
 182     extract(unpack("Vcrc32", substr($z, $gz_header_len + $gz_data_len)));
 183
 184     return array(substr($z, $gz_header_len, $gz_data_len), // gzipped data
 185         $crc32, // crc
 186         $os_type // OS type
 187     );
 188 }
 189
 190 function zip_inflate($data, $crc32, $uncomp_size)
 191 {
 192     if (function_exists('gzinflate')) {
 193         $data = gzinflate($data);
 194         if (strlen($data) != $uncomp_size)
 195             trigger_error("not enough output from gzinflate", E_USER_ERROR);
 196         $zcrc32 = zip_crc32($data);
 197         if ($zcrc32 < 0) { // force unsigned
 198             $zcrc32 += 4294967296;
 199         }
 200         if ($crc32 < 0) { // force unsigned
 201             $crc32 += 4294967296;
 202         }
 203         if ($zcrc32 != $crc32)
 204             trigger_error("CRC32 mismatch: calculated=$zcrc32, expected=$crc32", E_USER_ERROR);
 205         return $data;
 206     }
 207
 208     if (!function_exists('gzopen')) {
 209         global $request;
 210         $request->finish(_("Can't inflate data: zlib support not enabled in this PHP"));
 211     }
 212
 213     // Reconstruct gzip header and ungzip the data.
 214     $mtime = time(); //(Bogus mtime)
 215
 216     return gzip_uncompress(pack("a2CxV@10", GZIP_MAGIC, GZIP_DEFLATE, $mtime)
 217         . $data
 218         . pack("VV", $crc32, $uncomp_size));
 219 }
 220
 221 function unixtime2dostime($unix_time)
 222 {
 223     if ($unix_time % 1)
 224         $unix_time++; // Round up to even seconds.
 225
 226     list ($year, $month, $mday, $hour, $min, $sec)
 227         = explode(" ", date("Y n j G i s", $unix_time));
 228
 229     if ($year < 1980)
 230         list ($year, $month, $mday, $hour, $min, $sec) = array(1980, 1, 1, 0, 0, 0);
 231
 232     $dosdate = (($year - 1980) << 9) | ($month << 5) | $mday;
 233     $dostime = ($hour << 11) | ($min << 5) | ($sec >> 1);
 234
 235     return array($dosdate, $dostime);
 236 }
 237
 238 function dostime2unixtime($dosdate, $dostime)
 239 {
 240     $mday = $dosdate & 0x1f;
 241     $month = ($dosdate >> 5) & 0x0f;
 242     $year = 1980 + (($dosdate >> 9) & 0x7f);
 243
 244     $sec = ($dostime & 0x1f) * 2;
 245     $min = ($dostime >> 5) & 0x3f;
 246     $hour = ($dostime >> 11) & 0x1f;
 247
 248     return mktime($hour, $min, $sec, $month, $mday, $year);
 249 }
 250
 251
 252 /**
 253  * Class for zipfile creation.
 254  */
 255 define('ZIP_DEFLATE', GZIP_DEFLATE);
 256 define('ZIP_STORE', 0);
 257 define('ZIP_CENTHEAD_MAGIC', "PK\001\002");
 258 define('ZIP_LOCHEAD_MAGIC', "PK\003\004");
 259 define('ZIP_ENDDIR_MAGIC', "PK\005\006");
 260
 261 class ZipWriter
 262 {
 263     function ZipWriter($comment = "", $zipname = "archive.zip")
 264     {
 265         $this->comment = $comment;
 266         $this->nfiles = 0;
 267         $this->dir = ""; // "Central directory block"
 268         $this->offset = 0; // Current file position.
 269
 270         $zipname = addslashes($zipname);
 271         header("Content-Type: application/zip; name=\"$zipname\"");
 272         header("Content-Disposition: attachment; filename=\"$zipname\"");
 273     }
 274
 275     function addSrcFile($target, $src, $attrib = false)
 276     {
 277         if (empty($attrib['mtime']))
 278             $attrib = array('mtime' => filemtime($src), 'is_ascii' => 0);
 279         $this->addRegularFile($target, file_get_contents($src), $attrib);
 280     }
 281
 282     function addRegularFile($filename, $content, $attrib = false)
 283     {
 284         if (!$attrib)
 285             $attrib = array();
 286
 287         $size = strlen($content);
 288         if (function_exists('gzopen')) {
 289             list ($data, $crc32, $os_type) = zip_deflate($content);
 290             if (strlen($data) < $size) {
 291                 $content = $data; // Use compressed data.
 292                 $comp_type = ZIP_DEFLATE;
 293             } else
 294                 unset($crc32); // force plain store.
 295         } else {
 296             // Punt:
 297             $os_type = 3; // 0 = FAT --- hopefully this is good enough.
 298             /* (Another choice might be 3 = Unix) */
 299         }
 300
 301         if (!isset($crc32)) {
 302             $comp_type = ZIP_STORE;
 303             $crc32 = zip_crc32($content);
 304         }
 305
 306         if (!empty($attrib['write_protected']))
 307             $atx = (0100444 << 16) | 1; // S_IFREG + read permissions to
 308         // everybody.
 309         else
 310             $atx = (0100644 << 16); // Add owner write perms.
 311
 312         $ati = $attrib['is_ascii'] ? 1 : 0;
 313
 314         if (empty($attrib['mtime']))
 315             $attrib['mtime'] = time();
 316         list ($mod_date, $mod_time) = unixtime2dostime($attrib['mtime']);
 317
 318         // Construct parts common to "Local file header" and "Central
 319         // directory file header."
 320         if (!isset($attrib['extra_field']))
 321             $attrib['extra_field'] = '';
 322         if (!isset($attrib['file_comment']))
 323             $attrib['file_comment'] = '';
 324
 325         $head = pack("vvvvvVVVvv",
 326             20, // Version needed to extract (FIXME: is this right?)
 327             0, // Gen purp bit flag
 328             $comp_type,
 329             $mod_time,
 330             $mod_date,
 331             $crc32,
 332             strlen($content),
 333             $size,
 334             strlen($filename),
 335             strlen($attrib['extra_field']));
 336
 337         // Construct the "Local file header"
 338         $lheader = ZIP_LOCHEAD_MAGIC . $head . $filename
 339             . $attrib['extra_field'];
 340
 341         // Construct the "central directory file header"
 342         $this->dir .= pack("a4CC",
 343             ZIP_CENTHEAD_MAGIC,
 344             23, // Version made by (FIXME: is this right?)
 345             $os_type);
 346         $this->dir .= $head;
 347         $this->dir .= pack("vvvVV",
 348             strlen($attrib['file_comment']),
 349             0, // Disk number start
 350             $ati, // Internal file attributes
 351             $atx, // External file attributes
 352             $this->offset); // Relative offset of local header
 353         $this->dir .= $filename . $attrib['extra_field']
 354             . $attrib['file_comment'];
 355
 356         // Output the "Local file header" and file contents.
 357         echo $lheader;
 358         echo $content;
 359
 360         $this->offset += strlen($lheader) + strlen($content);
 361         $this->nfiles++;
 362     }
 363
 364     function finish()
 365     {
 366         // Output the central directory
 367         echo $this->dir;
 368
 369         // Construct the "End of central directory record"
 370         echo ZIP_ENDDIR_MAGIC;
 371         echo pack("vvvvVVv",
 372             0, // Number of this disk.
 373             0, // Number of disk with start of c dir
 374             $this->nfiles, // Number entries on this disk
 375             $this->nfiles, // Number entries
 376             strlen($this->dir), // Size of central directory
 377             $this->offset, // Offset of central directory
 378             strlen($this->comment));
 379         echo $this->comment;
 380     }
 381 }
 382
 383 /**
 384  * Class for reading zip files. Handles buffers also.
 385  *
 386  * BUGS:
 387  *
 388  * Many of the ExitWiki()'s should probably be warn()'s (eg. CRC mismatch).
 389  *
 390  * Only a subset of zip formats is recognized. (I think that
 391  * unsupported formats will be recognized as such rather than silently
 392  * munged.)
 393  *
 394  * We don't read the central directory. This means we don't see the
 395  * file attributes (text? read-only?), or file comments.
 396  *
 397  * Right now we ignore the file mod date and time, since we don't need it.
 398  */
 399 class ZipReader
 400 {
 401     function ZipReader($zipfile)
 402     {
 403         if (!is_string($zipfile)) { // filepointer: File already open
 404             $this->fp = $zipfile;
 405             $zipfile = NULL;
 406         } elseif (((ord($zipfile[0]) * 256 + ord($zipfile[1])) % 31 == 0) // buffer
 407             and (substr($zipfile, 0, 2) == "\037\213")
 408             or (substr($zipfile, 0, 2) == "x\332")
 409         ) { // 120, 218
 410             $this->fp = NULL;
 411             $this->buf = $zipfile;
 412             $zipfile = NULL;
 413         }
 414         if ($zipfile) {
 415             $this->zipfile = $zipfile;
 416             if (!($this->fp = fopen($zipfile, "rb"))) {
 417                 trigger_error(sprintf(_("Can't open zip file '%s' for reading"),
 418                     $zipfile), E_USER_ERROR);
 419             }
 420         }
 421     }
 422
 423     function _read($nbytes)
 424     {
 425         if ($this->fp) {
 426             $chunk = fread($this->fp, $nbytes);
 427             if (strlen($chunk) != $nbytes)
 428                 trigger_error(_("Unexpected EOF in zip file"), E_USER_ERROR);
 429             return $chunk;
 430         } elseif ($this->buf) {
 431             if (strlen($this->buf) < $nbytes)
 432                 trigger_error(_("Unexpected EOF in zip file"), E_USER_ERROR);
 433             $chunk = substr($this->buf, 0, $nbytes);
 434             $this->buf = substr($this->buf, $nbytes);
 435             return $chunk;
 436         }
 437     }
 438
 439     function done()
 440     {
 441         if ($this->fp)
 442             fclose($this->fp);
 443         else
 444             $this->buf = '';
 445         return false;
 446     }
 447
 448     function readFile()
 449     {
 450         $head = $this->_read(30); // FIXME: This is bad for gzip compressed buffers
 451
 452         extract(unpack("a4magic/vreq_version/vflags/vcomp_type"
 453                 . "/vmod_time/vmod_date"
 454                 . "/Vcrc32/Vcomp_size/Vuncomp_size"
 455                 . "/vfilename_len/vextrafld_len",
 456             $head));
 457
 458         if ($magic != ZIP_LOCHEAD_MAGIC) {
 459             // maybe gzip?
 460             //$x = substr($magic,0,3);
 461             if (substr($magic, 0, 3) == "\037\213\225") //and (substr($magic,3,1) & 0x3e) == 0)
 462             {
 463                 if ($this->fp) {
 464                     fclose($this->fp);
 465                     $this->fp = fopen($this->zipfile, "rb");
 466                     $content = $this->_read(filesize($this->fp));
 467                 } else {
 468                     $content = $this->buf;
 469                 }
 470                 // TODO...
 471                 $data = zip_deflate($content);
 472                 return array($filename, $data, $attrib);
 473             }
 474             if ($magic != ZIP_CENTHEAD_MAGIC)
 475                 // FIXME: better message?
 476                 ExitWiki(sprintf("Unsupported ZIP header type: %s", $magic));
 477             return $this->done();
 478         }
 479         if (($flags & 0x21) != 0)
 480             ExitWiki("Encryption and/or zip patches not supported.");
 481         if (($flags & 0x08) != 0)
 482             // FIXME: better message?
 483             ExitWiki("Postponed CRC not yet supported.");
 484
 485         $filename = $this->_read($filename_len);
 486         //FIXME: we should probably check $req_version.
 487         $attrib['mtime'] = dostime2unixtime($mod_date, $mod_time);
 488         if ($extrafld_len != 0)
 489             $attrib['extra_field'] = $this->_read($extrafld_len);
 490
 491         $data = $this->_read($comp_size);
 492
 493         if ($comp_type == ZIP_DEFLATE) {
 494             $data = zip_inflate($data, $crc32, $uncomp_size);
 495         } else if ($comp_type == ZIP_STORE) {
 496             $crc = zip_crc32($data);
 497             if ($crc32 != $crc)
 498                 ExitWiki(sprintf("CRC mismatch %x != %x", $crc, $crc32));
 499         } else
 500             ExitWiki(sprintf("Compression method %s unsupported",
 501                 $comp_method));
 502
 503         if (strlen($data) != $uncomp_size)
 504             ExitWiki(sprintf("Uncompressed size mismatch %d != %d",
 505                 strlen($data), $uncomp_size));
 506
 507         return array($filename, $data, $attrib);
 508     }
 509 }
 510
 511 /**
 512  * Routines for Mime mailification of pages.
 513  */
 514 //FIXME: these should go elsewhere (libmime?).
 515
 516 /**
 517  * Routines for quoted-printable en/decoding.
 518  */
 519 function QuotedPrintableEncode($string)
 520 {
 521     // Quote special characters in line.
 522     $quoted = "";
 523     while ($string) {
 524         // The complicated regexp is to force quoting of trailing spaces.
 525         preg_match('/^([ !-<>-~]*)(?:([!-<>-~]$)|(.))/s', $string, $match);
 526         $quoted .= $match[1] . $match[2];
 527         if (!empty($match[3]))
 528             $quoted .= sprintf("=%02X", ord($match[3]));
 529         $string = substr($string, strlen($match[0]));
 530     }
 531     // Split line.
 532     // This splits the line (preferably after white-space) into lines
 533     // which are no longer than 76 chars (after adding trailing '=' for
 534     // soft line break, but before adding \r\n.)
 535     return preg_replace('/(?=.{77})(.{10,74}[ \t]|.{71,73}[^=][^=])/s',
 536         "\\1=\r\n", $quoted);
 537 }
 538
 539 function QuotedPrintableDecode($string)
 540 {
 541     // Eliminate soft line-breaks.
 542     $string = preg_replace('/=[ \t\r]*\n/', '', $string);
 543     return quoted_printable_decode($string);
 544 }
 545
 546 define('MIME_TOKEN_REGEXP', "[-!#-'*+.0-9A-Z^-~]+");
 547
 548 function MimeContentTypeHeader($type, $subtype, $params)
 549 {
 550     $header = "Content-Type: $type/$subtype";
 551     reset($params);
 552     while (list($key, $val) = each($params)) {
 553         //FIXME:  what about non-ascii printables in $val?
 554         if (!preg_match('/^' . MIME_TOKEN_REGEXP . '$/', $val))
 555             $val = '"' . addslashes($val) . '"';
 556         $header .= ";\r\n  $key=$val";
 557     }
 558     return "$header\r\n";
 559 }
 560
 561 function MimeMultipart($parts)
 562 {
 563     global $mime_multipart_count;
 564
 565     // The string "=_" can not occur in quoted-printable encoded data.
 566     $boundary = "=_multipart_boundary_" . ++$mime_multipart_count;
 567
 568     $head = MimeContentTypeHeader('multipart', 'mixed',
 569         array('boundary' => $boundary));
 570
 571     $sep = "\r\n--$boundary\r\n";
 572
 573     return $head . $sep . implode($sep, $parts) . "\r\n--${boundary}--\r\n";
 574 }
 575
 576 /**
 577  * For reference see:
 578  * http://www.nacs.uci.edu/indiv/ehood/MIME/2045/rfc2045.html
 579  * http://www.faqs.org/rfcs/rfc2045.html
 580  * (RFC 1521 has been superceeded by RFC 2045 & others).
 581  *
 582  * Also see http://www.faqs.org/rfcs/rfc2822.html
 583  *
 584  *
 585  * Notes on content-transfer-encoding.
 586  *
 587  * "7bit" means short lines of US-ASCII.
 588  * "8bit" means short lines of octets with (possibly) the high-order bit set.
 589  * "binary" means lines are not necessarily short enough for SMTP
 590  * transport, and non-ASCII characters may be present.
 591  *
 592  * Only "7bit", "quoted-printable", and "base64" are universally safe
 593  * for transport via e-mail.  (Though many MTAs can/will be configured to
 594  * automatically convert encodings to a safe type if they receive
 595  * mail encoded in '8bit' and/or 'binary' encodings.
 596  */
 597 function MimeifyPageRevision(&$page, &$revision)
 598 {
 599     // $wikidb =& $revision->_wikidb;
 600     // $page = $wikidb->getPage($revision->getName());
 601     // FIXME: add 'hits' to $params
 602     $params = array('pagename' => $page->getName(),
 603         'flags' => "",
 604         'author' => $revision->get('author'),
 605         'owner' => $page->getOwner(),
 606         'version' => $revision->getVersion(),
 607         'lastmodified' => $revision->get('mtime'));
 608
 609     if ($page->get('mtime'))
 610         $params['created'] = $page->get('mtime');
 611     if ($page->get('locked'))
 612         $params['flags'] = 'PAGE_LOCKED';
 613     if (ENABLE_EXTERNAL_PAGES && $page->get('external'))
 614         $params['flags'] = ($params['flags'] ? $params['flags'] . ',EXTERNAL_PAGE' : 'EXTERNAL_PAGE');
 615     if ($revision->get('author_id'))
 616         $params['author_id'] = $revision->get('author_id');
 617     if ($revision->get('markup')) // what is the default? we must use 1
 618         $params['markup'] = $revision->get('markup');
 619     if ($revision->get('summary'))
 620         $params['summary'] = $revision->get('summary');
 621     if ($page->get('hits'))
 622         $params['hits'] = $page->get('hits');
 623     if ($page->get('owner'))
 624         $params['owner'] = $page->get('owner');
 625     if ($page->get('perm') and class_exists('PagePermission')) {
 626         $acl = getPagePermissions($page);
 627         $params['acl'] = $acl->asAclLines();
 628         //TODO: convert to multiple lines? acl-view => groups,...; acl-edit => groups,...
 629     }
 630
 631     $params['charset'] = $GLOBALS['charset'];
 632
 633     // Non-US-ASCII is not allowed in Mime headers (at least not without
 634     // special handling) --- so we urlencode all parameter values.
 635     foreach ($params as $key => $val)
 636         $params[$key] = rawurlencode($val);
 637     if (isset($params['acl']))
 638         // default: "view:_EVERY; edit:_AUTHENTICATED; create:_AUTHENTICATED,_BOGOUSER; ".
 639         //          "list:_EVERY; remove:_ADMIN,_OWNER; change:_ADMIN,_OWNER; dump:_EVERY; "
 640         $params['acl'] = str_replace(array("%3A", "%3B%20", "%2C"), array(":", "; ", ","), $params['acl']);
 641
 642     $out = MimeContentTypeHeader('application', 'x-phpwiki', $params);
 643     $out .= sprintf("Content-Transfer-Encoding: %s\r\n",
 644         STRICT_MAILABLE_PAGEDUMPS ? 'quoted-printable' : 'binary');
 645
 646     $out .= "\r\n";
 647
 648     foreach ($revision->getContent() as $line) {
 649         // This is a dirty hack to allow saving binary text files. See above.
 650         $line = rtrim($line);
 651         if (STRICT_MAILABLE_PAGEDUMPS)
 652             $line = QuotedPrintableEncode(rtrim($line));
 653         $out .= "$line\r\n";
 654     }
 655     return $out;
 656 }
 657
 658 /**
 659  * Routines for parsing Mime-ified phpwiki pages.
 660  */
 661 function ParseRFC822Headers(&$string)
 662 {
 663     if (preg_match("/^From (.*)\r?\n/", $string, $match)) {
 664         $headers['from '] = preg_replace('/^\s+|\s+$/', '', $match[1]);
 665         $string = substr($string, strlen($match[0]));
 666     }
 667
 668     while (preg_match('/^([!-9;-~]+) [ \t]* : [ \t]* '
 669             . '( .* \r?\n (?: [ \t] .* \r?\n)* )/x',
 670         $string, $match)) {
 671         $headers[strtolower($match[1])]
 672             = preg_replace('/^\s+|\s+$/', '', $match[2]);
 673         $string = substr($string, strlen($match[0]));
 674     }
 675
 676     if (empty($headers))
 677         return false;
 678
 679     if (strlen($string) > 0) {
 680         if (!preg_match("/^\r?\n/", $string, $match)) {
 681             // No blank line after headers.
 682             return false;
 683         }
 684         $string = substr($string, strlen($match[0]));
 685     }
 686
 687     return $headers;
 688 }
 689
 690
 691 function ParseMimeContentType($string)
 692 {
 693     // FIXME: Remove (RFC822 style comments).
 694
 695     // Get type/subtype
 696     if (!preg_match(':^\s*(' . MIME_TOKEN_REGEXP . ')\s*'
 697             . '/'
 698             . '\s*(' . MIME_TOKEN_REGEXP . ')\s*:x',
 699         $string, $match)
 700     )
 701         ExitWiki(sprintf("Bad %s", 'MIME content-type'));
 702
 703     $type = strtolower($match[1]);
 704     $subtype = strtolower($match[2]);
 705     $string = substr($string, strlen($match[0]));
 706
 707     $param = array();
 708     while (preg_match('/^;\s*(' . MIME_TOKEN_REGEXP . ')\s*=\s*'
 709             . '(?:(' . MIME_TOKEN_REGEXP . ')|"((?:[^"\\\\]|\\.)*)") \s*/sx',
 710         $string, $match)) {
 711         //" <--kludge for brain-dead syntax coloring
 712         if (strlen($match[2]))
 713             $val = $match[2];
 714         else
 715             $val = preg_replace('/[\\\\](.)/s', '\\1', $match[3]);
 716
 717         $param[strtolower($match[1])] = $val;
 718
 719         $string = substr($string, strlen($match[0]));
 720     }
 721
 722     return array($type, $subtype, $param);
 723 }
 724
 725 function ParseMimeMultipart($data, $boundary)
 726 {
 727     if (!$boundary)
 728         ExitWiki("No boundary?");
 729
 730     $boundary = preg_quote($boundary);
 731
 732     while (preg_match("/^(|.*?\n)--$boundary((?:--)?)[^\n]*\n/s",
 733         $data, $match)) {
 734         $data = substr($data, strlen($match[0]));
 735         if (!isset($parts))
 736             $parts = array(); // First time through: discard leading chaff
 737         else {
 738             if ($content = ParseMimeifiedPages($match[1]))
 739                 for (reset($content); $p = current($content); next($content))
 740                     $parts[] = $p;
 741         }
 742
 743         if ($match[2])
 744             return $parts; // End boundary found.
 745     }
 746     ExitWiki("No end boundary?");
 747 }
 748
 749 function GenerateFootnotesFromRefs($params)
 750 {
 751     $footnotes = array();
 752     reset($params);
 753     while (list($p, $reference) = each($params)) {
 754         if (preg_match('/^ref([1-9][0-9]*)$/', $p, $m))
 755             $footnotes[$m[1]] = sprintf(_("[%d] See [%s]"),
 756                 $m[1], rawurldecode($reference));
 757     }
 758
 759     if (sizeof($footnotes) > 0) {
 760         ksort($footnotes);
 761         return "-----\n"
 762             . "!" . _("References") . "\n"
 763             . join("\n%%%\n", $footnotes) . "\n";
 764     } else
 765         return "";
 766 }
 767
 768 // counterpart to $acl->asAclLines() and rawurl undecode
 769 // default: "view:_EVERY; edit:_AUTHENTICATED; create:_AUTHENTICATED,_BOGOUSER; ".
 770 //          "list:_EVERY; remove:_ADMIN,_OWNER; change:_ADMIN,_OWNER; dump:_EVERY; "
 771 function ParseMimeifiedPerm($string)
 772 {
 773     if (!class_exists('PagePermission')) {
 774         return '';
 775     }
 776     $hash = array();
 777     foreach (explode(";", trim($string)) as $accessgroup) {
 778         list($access, $groupstring) = explode(":", trim($accessgroup));
 779         $access = trim($access);
 780         $groups = explode(",", trim($groupstring));
 781         foreach ($groups as $group) {
 782             $group = trim($group);
 783             $bool = (boolean)(substr($group, 0, 1) != '-');
 784             if (substr($group, 0, 1) == '-' or substr($group, 0, 1) == '+')
 785                 $group = substr($group, 1);
 786             $hash[$access][$group] = $bool;
 787         }
 788     }
 789     $perm = new PagePermission($hash);
 790     $perm->sanify();
 791     return serialize($perm->perm);
 792 }
 793
 794 // Convert references in meta-data to footnotes.
 795 // Only zip archives generated by phpwiki 1.2.x or earlier should have
 796 // references.
 797 function ParseMimeifiedPages($data)
 798 {
 799     if (!($headers = ParseRFC822Headers($data))
 800         || empty($headers['content-type'])
 801     ) {
 802         //trigger_error( sprintf(_("Can't find %s"),'content-type header'),
 803         //               E_USER_WARNING );
 804         return false;
 805     }
 806     $typeheader = $headers['content-type'];
 807
 808     if (!(list ($type, $subtype, $params) = ParseMimeContentType($typeheader))) {
 809         trigger_error(sprintf("Can't parse %s: (%s)",
 810                 'content-type', $typeheader),
 811             E_USER_WARNING);
 812         return false;
 813     }
 814     if ("$type/$subtype" == 'multipart/mixed') {
 815         return ParseMimeMultipart($data, $params['boundary']);
 816     } else if ("$type/$subtype" != 'application/x-phpwiki') {
 817         trigger_error(sprintf("Bad %s", "content-type: $type/$subtype"),
 818             E_USER_WARNING);
 819         return false;
 820     }
 821
 822     // FIXME: more sanity checking?
 823     $page = array();
 824     $pagedata = array();
 825     $versiondata = array();
 826     if (isset($headers['date']))
 827         $pagedata['date'] = strtotime($headers['date']);
 828
 829     //DONE: support owner and acl
 830     foreach ($params as $key => $value) {
 831         if (empty($value))
 832             continue;
 833         $value = rawurldecode($value);
 834         switch ($key) {
 835             case 'pagename':
 836             case 'version':
 837                 $page[$key] = $value;
 838                 break;
 839             case 'flags':
 840                 if (preg_match('/PAGE_LOCKED/', $value))
 841                     $pagedata['locked'] = 'yes';
 842                 if (ENABLE_EXTERNAL_PAGES && preg_match('/EXTERNAL_PAGE/', $value))
 843                     $pagedata['external'] = 'yes';
 844                 break;
 845             case 'owner':
 846             case 'created':
 847             case 'hits':
 848                 $pagedata[$key] = $value;
 849                 break;
 850             case 'acl':
 851             case 'perm':
 852                 if (class_exists('PagePermission')) {
 853                     $pagedata['perm'] = ParseMimeifiedPerm($value);
 854                 }
 855                 break;
 856             case 'lastmodified':
 857                 $versiondata['mtime'] = $value;
 858                 break;
 859             case 'author':
 860             case 'author_id':
 861             case 'summary':
 862             case 'markup':
 863             case 'pagetype':
 864                 $versiondata[$key] = $value;
 865                 break;
 866         }
 867     }
 868
 869     // FIXME: do we need to try harder to find a pagename if we
 870     //        haven't got one yet?
 871     if (!isset($versiondata['author'])) {
 872         global $request;
 873         if (is_object($request)) {
 874             $user = $request->getUser();
 875             $versiondata['author'] = $user->getId(); //FIXME:?
 876         }
 877     }
 878
 879     $encoding = strtolower($headers['content-transfer-encoding']);
 880     if ($encoding == 'quoted-printable')
 881         $data = QuotedPrintableDecode($data);
 882     else if ($encoding && $encoding != 'binary')
 883         ExitWiki(sprintf("Unknown %s", 'encoding type: $encoding'));
 884
 885     if (empty($params['charset']))
 886         $params['charset'] = 'utf-8';
 887
 888     // compare to target charset
 889     if (strtolower($params['charset']) != strtolower($GLOBALS['charset'])) {
 890         $data = charset_convert($params['charset'], $GLOBALS['charset'], $data);
 891         //$page['pagename'] = charset_convert($params['charset'], $GLOBALS['charset'], $page['pagename']);
 892         if (isset($versiondata['summary']))
 893             $versiondata['summary'] = charset_convert($params['charset'], $GLOBALS['charset'], $versiondata['summary']);
 894
 895     }
 896
 897     $data .= GenerateFootnotesFromRefs($params);
 898
 899     $page['content'] = preg_replace('/[ \t\r]*\n/', "\n", chop($data));
 900     $page['pagedata'] = $pagedata;
 901     $page['versiondata'] = $versiondata;
 902
 903     return array($page);
 904 }
 905
 906 // Local Variables:
 907 // mode: php
 908 // tab-width: 8
 909 // c-basic-offset: 4
 910 // c-hanging-comment-ender-p: nil
 911 // indent-tabs-mode: nil
 912 // End: