lib/ziplib.php

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