lib/ziplib.php

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