lib/ziplib.php

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