aboutsummaryrefslogtreecommitdiff
path: root/src/ZipStream.php
blob: 3f2d480b5f479f7f8ee82399ec9cde599fc26108 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
<?php
/**
 * Dynamically generate streamed zip archives.
 *
 * @author Paul Duncan <pabs@pablotron.org>
 * @copyright 2007-2018 Paul Duncan <pabs@pablotron.org>
 * @license MIT
 * @package Pablotron\ZipStream
 */

declare(strict_types = 1);

namespace Pablotron\ZipStream;

/**
 * Current version of ZipStream.
 *
 * @api
 */
const VERSION = '0.3.0';

/**
 * Version needed to extract.
 *
 * @internal
 *
 * @example "examples/09-version.php"
 */
const VERSION_NEEDED = 45;

/**
 * Base class for all exceptions raised by ZipStream.
 */
class Error extends \Exception { };

/**
 * Comment length error.
 */
final class CommentError extends Error { };

/**
 * Deflate context error.
 */
final class DeflateError extends Error { };

/**
 * Unknown compression method error.
 */
final class UnknownMethodError extends Error {
  /** @var int Unknown compression method. */
  public $method;

  /**
   * Create a new UnknownMethod error.
   *
   * @param int $method Unknown compression method.
   */
  public function __construct(int $method) {
    $this->method = $method;
    parent::__construct('unknown compression method');
  }
};

/**
 * File related error.
 */
final class FileError extends Error {
  /** @var string Name of fail in which error occurred. */
  public $file_name;

  /**
   * Create a new UnknownMethod error.
   *
   * @param string $file_name File name.
   * @param string $message Error message.
   */
  public function __construct(string $file_name, string $message) {
    $this->file_name = $file_name;
    parent::__construct($message);
  }
};

/**
 * Path validation error.
 */
final class PathError extends Error {
  /** @var string string Invalid file name. */
  public $file_name;

  /**
   * Create a new UnknownMethod error.
   *
   * @param string $file_name File name.
   * @param string $message Error message.
   */
  public function __construct(string $file_name, string $message) {
    $this->file_name = $file_name;
    parent::__construct($message);
  }
};

/**
 * Valid compression methods.
 */
final class Methods {
  /** Store file without compression. */
  const STORE = 0;

  /** Store file using DEFLATE compression. */
  const DEFLATE = 8;

  /**
   * Check for supported compression method.
   *
   * @internal
   *
   * @param int $method Compression method.
   *
   * @return void
   *
   * @throw UnsupportedMethodError if compression method is unsupported.
   */
  static public function check(int $method) : void {
    if ($method != Methods::DEFLATE && $method != Methods::STORE) {
      throw new UnknownMethodError($method);
    }
  }
};

/**
 * Abstract interface for stream output.
 *
 * @api
 *
 * @see FileWriter, HTTPResponseWriter
 */
interface Writer {
  /**
   * Set metadata for generated archive.
   *
   * @param string $key Metadata key (one of "name" or "type").
   * @param string $val Metadata value.
   *
   * @return void
   */
  public function set(string $key, string $val) : void;

  /**
   * Flush metadata and begin streaming archive contents.
   *
   * @return void
   */
  public function open() : void;

  /**
   * Write archive contents.
   *
   * @param string $data Archive file data.
   *
   * @return void
   */
  public function write(string $data) : void;

  /**
   * Finish writing archive data.
   *
   * @return void
   */
  public function close() : void;
};

/**
 * Stream generated archive as an HTTP response.
 *
 * @api
 *
 * Streams generated zip archive as an HTTP response.  This is the
 * default writer used by ZipStream if none is provided.
 *
 * @see Writer
 */
final class HTTPResponseWriter implements Writer {
  /**
   * @var array Hash of metadata.
   * @internal
   */
  private $args = [];

  /**
   * Set metadata for generated archive.
   *
   * @param string $key Metadata key (one of "name" or "type").
   * @param string $val Metadata value.
   *
   * @return void
   */
  public function set(string $key, string $val) : void {
    $this->args[$key] = $val;
  }

  /**
   * Flush metadata and begin streaming archive contents.
   *
   * @return void
   */
  public function open() : void {
    # write response headers
    foreach ($this->get_headers as $key => $val) {
      header("$key: $val");
    }
  }

  /**
   * Write archive contents.
   *
   * @param string $data Archive file data.
   *
   * @return void
   */
  public function write(string $data) : void {
    echo $data;
  }

  /**
   * Finish writing archive data.
   *
   * @return void
   */
  public function close() : void {
    # ignore
  }

  /**
   * Get HTTP headers.
   *
   * @internal
   *
   * @return array Hash of HTTP headers.
   */
  private function get_headers() : array {
    # build pre-RFC6266 file name
    $old_name = preg_replace('/[^a-z0-9_.-]+/', '_', $this->args['name']);

    # build URI-encoded (RFC6266) file name
    $new_name = urlencode($this->args['name']);

    # build and return response headers
    return [
      'Content-Type' => $this->args['type'],
      'Content-Disposition' => join('; ', [
        'attachment',
        "filename=\"{$old_name}\"",
        "filename*=UTF-8''{$new_name}"
      ]),

      'Pragma' => 'public',
      'Cache-Control' => 'public, must-revalidate',
      'Content-Transfer-Encoding' => 'binary',
    ];
  }
};

/**
 * Write generated zip archive to a local file.
 *
 * @api
 *
 * @example "examples/06-file_writer.php"
 */
final class FileWriter implements Writer {
  /** @var string Output file path. */
  public $path;

  /**
   * @var resource Output file handle.
   * @internal
   */
  private $fh;

  const FILE_WRITER_STATE_INIT = 0;
  const FILE_WRITER_STATE_OPEN = 1;
  const FILE_WRITER_STATE_CLOSED = 2;
  const FILE_WRITER_STATE_ERROR = 3;

  /**
   * Create a new FileWriter.
   *
   * @api
   *
   */
  public function __construct() {
    # set state
    $this->state = self::FILE_WRITER_STATE_INIT;
  }

  /**
   * Set metadata for generated archive.
   *
   * @param string $key Metadata key (one of "name" or "type").
   * @param string $val Metadata value.
   *
   * @return void
   */
  public function set(string $key, string $val) : void {
    # check state
    if ($this->state !== self::FILE_WRITER_STATE_INIT) {
      # set state, raise error
      $this->state = self::FILE_WRITER_STATE_ERROR;
      throw new Error("invalid file writer state");
    }

    if ($key == 'name') {
      # save name
      $this->path = $val;
    } else {
      # ignore other metadata
    }
  }

  /**
   * Flush metadata and begin streaming archive contents.
   *
   * @return void
   *
   * @throw FileError if output archive could not be opened.
   */
  public function open() : void {
    # check state
    if ($this->state !== self::FILE_WRITER_STATE_INIT) {
      # set state, raise error
      $this->state = self::FILE_WRITER_STATE_ERROR;
      throw new Error("invalid file writer state");
    }

    # open output file
    $this->fh = @fopen($this->path, 'wb');
    if (!$this->fh) {
      throw new FileError($path, "couldn't open file");
    }

    # set state
    $this->state = self::FILE_WRITER_STATE_OPEN;
  }

  /**
   * Write archive contents.
   *
   * @param string $data Archive file data.
   *
   * @return void
   */
  public function write(string $data) : void {
    # check state
    if ($this->state != self::FILE_WRITER_STATE_OPEN) {
      # set state, raise error
      $this->state = self::FILE_WRITER_STATE_ERROR;
      throw new Error("invalid output state");
    }

    # write data
    $len = fwrite($this->fh, $data);

    # check for error
    if ($len === false) {
      # set state, raise error
      $this->state = self::FILE_WRITER_STATE_ERROR;
      throw new FileError($this->path, 'fwrite() failed');
    }
  }

  /**
   * Finish writing archive data.
   *
   * @return void
   */
  public function close() : void {
    # check state
    if ($this->state == self::FILE_WRITER_STATE_CLOSED) {
      return;
    } else if ($this->state != self::FILE_WRITER_STATE_OPEN) {
      # set state, raise error
      $this->state = self::FILE_WRITER_STATE_ERROR;
      throw new Error("invalid output state");
    }

    # close file handle
    @fclose($this->fh);

    # set state
    $this->state = self::FILE_WRITER_STATE_CLOSED;
  }
};

/**
 * Write generated zip archive to a stream.
 *
 * @api
 *
 * @example "examples/07-stream_writer.php"
 */
final class StreamWriter implements Writer {
  /** @var resource Output stream. */
  public $stream;

  const STREAM_WRITER_STATE_INIT = 0;
  const STREAM_WRITER_STATE_OPEN = 1;
  const STREAM_WRITER_STATE_CLOSED = 2;
  const STREAM_WRITER_STATE_ERROR = 3;

  /**
   * Create a new StreamWriter.
   *
   * @api
   *
   * @param resource $stream Output stream.
   *
   * @example "examples/07-stream_writer.php"
   */
  public function __construct($stream) {
    # check stream
    if (!is_resource($stream)) {
      $this->state = self::STREAM_WRITER_STATE_ERROR;
      throw new Error('stream is not a resource');
    }

    # set state, cache stream
    $this->state = self::STREAM_WRITER_STATE_INIT;
    $this->stream = $stream;
  }

  /**
   * Set metadata for generated archive.
   *
   * *Note:* This method is not used for StreamWriter.
   *
   * @param string $key Metadata key (one of "name" or "type").
   * @param string $val Metadata value.
   *
   * @return void
   */
  public function set(string $key, string $val) : void {
    # ignore metadata
  }

  /**
   * Flush metadata and begin streaming archive contents.
   *
   * *Note:* This method is not used for StreamWriter.
   *
   * @return void
   *
   * @throw FileError if output archive could not be opened.
   */
  public function open() : void {
    # set state
    $this->state = self::STREAM_WRITER_STATE_OPEN;
  }

  /**
   * Write archive contents.
   *
   * @param string $data Archive file data.
   *
   * @return void
   */
  public function write(string $data) : void {
    # check state
    if ($this->state != self::STREAM_WRITER_STATE_OPEN) {
      # set state, raise error
      $this->state = self::STREAM_WRITER_STATE_ERROR;
      throw new Error("invalid output state");
    }

    # write data
    $len = fwrite($this->stream, $data);

    # check for error
    if ($len === false) {
      # set state, raise error
      $this->state = self::STREAM_WRITER_STATE_ERROR;
      throw new Error('fwrite() failed');
    }
  }

  /**
   * Finish writing archive data.
   *
   * @return void
   */
  public function close() : void {
    # check state
    if ($this->state == self::STREAM_WRITER_STATE_CLOSED) {
      return;
    } else if ($this->state != self::STREAM_WRITER_STATE_OPEN) {
      # set state, raise error
      $this->state = self::STREAM_WRITER_STATE_ERROR;
      throw new Error("invalid output state");
    }

    # flush output
    if (!@fflush($this->stream)) {
      # set state, raise error
      $this->state = self::STREAM_WRITER_STATE_ERROR;
      throw new Error("fflush() failed");
    }

    # set state
    $this->state = self::STREAM_WRITER_STATE_CLOSED;
  }
};

/**
 * Convert a UNIX timestamp into DOS date and time components.
 *
 * @internal
 *
 * @example "examples/08-datetime.php"
 */
final class DateTime {
  /**
   * @var int $time Input UNIX timestamp.
   * @var int $dos_time Output DOS timestamp.
   * @var int $dos_date Output DOS datestamp.
   */
  public $time,
         $dos_time,
         $dos_date;

  /**
   * Minimal date/time representable by a DOS timestamp.
   * @internal
   */
  static $DOS_EPOCH = [
    'year'    => 1980,
    'mon'     => 1,
    'mday'    => 1,
    'hours'   => 0,
    'minutes' => 0,
    'seconds' => 0,
  ];

  /**
   * Convert a UNIX timestamp into DOS date and time components.
   *
   * @param int $time Input UNIX timestamp.
   *
   * @example "examples/08-datetime.php"
   */
  public function __construct(int $time) {
    $this->time = $time;

    # get date array for timestamp
    $d = getdate($time);

    # set lower-bound on dates
    if ($d['year'] < 1980) {
      $d = self::$DOS_EPOCH;
    }

    # remove extra years from 1980
    $d['year'] -= 1980;

    $this->dos_date = (
      (($d['year'] & 0x7F) << 9) |
      (($d['mon'] & 0xF) << 5) |
      ($d['mday'] & 0x1F)
    );

    $this->dos_time = (
      (($d['hours'] & 0x3F) << 11) |
      (($d['minutes'] & 0x3F) << 5) |
      (($d['seconds'] & 0x3F) >> 1)
    );
  }
};

/**
 * CRC32b hash context wrapper.
 * @internal
 */
final class Hasher {
  /** @var int $hash Output hash result. */
  public $hash;

  /** @var object $ctx Internal hash context. */
  private $ctx;

  /**
   * Create a new Hasher.
   */
  public function __construct() {
    $this->ctx = hash_init('crc32b');
  }

  /**
   * Write data to Hasher.
   *
   * @param string $data Input data.
   * @return void
   * @throw Error if called after close().
   */
  public function write(string $data) : void {
    if ($this->ctx !== null) {
      # update hash context
      hash_update($this->ctx, $data);
    } else {
      throw new Error('hash context already finalized');
    }
  }

  /**
   * Create hash of input data.
   *
   * Finalize the internal has context and return a CRC32b hash of the
   * given input data.
   *
   * @return int CRC32b hash of input data.
   */
  public function close() : int {
    if ($this->ctx !== null) {
      # finalize hash context
      $d = hash_final($this->ctx, true);
      $this->ctx = null;

      # encode hash as uint32_t
      # (FIXME: endian issue?)
      $this->hash = (
        (ord($d[0]) << 24) |
        (ord($d[1]) << 16) |
        (ord($d[2]) << 8) |
        (ord($d[3]))
      );
    }

    # return encoded result
    return $this->hash;
  }
};

/**
 * Abstract base class for data filter methods.
 *
 * @internal
 * @see StoreFilter, DeflateFilter
 */
abstract class DataFilter {
  /** @var Writer output writer */
  private $output;

  /**
   * Create a new DataFilter bound to the given Writer.
   *
   * @param Writer $output Output writer.
   */
  public function __construct(Writer &$output) {
    $this->output = $output;
  }

  /**
   * Write data to data filter.
   *
   * @param string $data Output data.
   * @return int Number of bytes written.
   */
  public function write(string $data) : int {
    $this->output->write($data);
    return strlen($data);
  }

  /**
   * Close this data filter.
   *
   * @return int Number of bytes written.
   */
  public abstract function close() : int;
}

/**
 * Data filter for files using the store compression method.
 *
 * @internal
 * @see DataFilter, DeflateFilter
 */
final class StoreFilter extends DataFilter {
  /**
   * Close this data filter.
   *
   * @return int Number of bytes written.
   */
  public function close() : int {
    return 0;
  }
};

/**
 * Data filter for files using the deflate compression method.
 *
 * @internal
 *
 * @see DataFilter, StoreFilter
 */
final class DeflateFilter extends DataFilter {
  /** @var object $ctx Deflate context. */
  private $ctx;

  /**
   * Create a new DeflateFilter bound to the given Writer.
   *
   * @param Writer $output Output writer.
   *
   * @throw DeflateError If initializing deflate context fails.
   */
  public function __construct(Writer &$output) {
    # init parent
    parent::__construct($output);

    # init deflate context, check for error
    $this->ctx = deflate_init(ZLIB_ENCODING_RAW);
    if ($this->ctx === false) {
      throw new DeflateError('deflate_init() failed');
    }
  }

  /**
   * Write data to data filter.
   *
   * @param string $data Output data.
   *
   * @return int Number of bytes written.
   *
   * @throw DeflateError If writing to deflate context fails.
   * @throw Error If this filter was already closed.
   */
  public function write(string $data) : int {
    # check state
    if (!$this->ctx) {
      # filter already closed
      throw new Error('Filter already closed');
    }

    # write data to deflate context, check for error
    $compressed_data = deflate_add($this->ctx, $data, ZLIB_NO_FLUSH);
    if ($compressed_data === false) {
      throw new DeflateError('deflate_add() failed');
    }

    # pass data to parent
    return parent::write($compressed_data);
  }

  /**
   * Close this data filter.
   *
   * @return int Number of bytes written.
   *
   * @throw DeflateError If writing to deflate context fails.
   * @throw Error If this filter was already closed.
   */
  public function close() : int {
    # check state
    if (!$this->ctx) {
      # filter already closed
      throw new Error('Filter already closed');
    }

    # finalize context, flush remaining data
    $compressed_data = deflate_add($this->ctx, '', ZLIB_FINISH);
    if ($compressed_data === false) {
      throw new DeflateError('deflate_add() failed');
    }

    # clear deflate context
    $this->ctx = null;

    # write remaining data, return number of bytes written
    return parent::write($compressed_data);
  }
};

/**
 * Internal representation for a zip file.
 *
 * @internal
 *
 * @see DataFilter, StoreFilter
 */
final class Entry {
  const ENTRY_STATE_INIT = 0;
  const ENTRY_STATE_DATA = 1;
  const ENTRY_STATE_CLOSED = 2;
  const ENTRY_STATE_ERROR = 3;

  /**
   * @var Writer $output
   *   Reference to output writer.
   * @var int $pos
   *   Offset from start of file of entry local header.
   * @var string $name
   *   Name of file.
   * @var int $method
   *   Compression method.
   * @var int $time
   *   File creation time (UNIX timestamp).
   * @var string $comment
   *   File comment.
   * @var int $uncompressed_size
   *   Raw file size, in bytes.  Only valid after file has been
   *   read completely.
   * @var int $compressed_size
   *   Compressed file size, in bytes.  Only valid after file has
   *   been read completely.
   * @var int $hash
   *   CRC32b hash of file contents.  Only valid after file has
   *   been read completely.
   */
  public $output,
         $pos,
         $name,
         $method,
         $time,
         $comment,
         $uncompressed_size,
         $compressed_size,
         $hash;

  /**
   * @var int $len
   *   File length, in bytes.  Only valid after file has been read
   *   completely.
   * @var DateTime $date_time
   *   Date and time converter for this file.
   * @var Hasher $hasher
   *   Internal hasher for this file.
   * @var int $state
   *   Entry state.
   */
  private $len,
          $date_time,
          $hasher,
          $state;

  /**
   * Create a new entry object.
   *
   * @internal
   *
   * @param Writer $output
   *   Reference to output writer.
   * @param int $pos
   *   Offset from start of file of entry local header.
   * @param string $name
   *   Name of file.
   * @param int $method
   *   Compression method.
   * @param int $time
   *   File creation time (UNIX timestamp).
   * @param string $comment
   *   File comment.
   *
   * @throw Error if compression method is unknown.
   * @throw PathError if compression method is unknown.
   */
  public function __construct(
    Writer &$output,
    int $pos,
    string $name,
    int $method,
    int $time,
    string $comment
  ) {
    # set state
    $this->state = self::ENTRY_STATE_INIT;

    $this->output = $output;
    $this->pos = $pos;
    $this->name = $name;
    $this->method = $method;
    $this->time = $time;
    $this->comment = $comment;

    # check comment length
    if (strlen($comment) >= 0xFFFF) {
      $this->state = self::ENTRY_STATE_ERROR;
      throw new CommentError('entry comment too long');
    }

    $this->uncompressed_size = 0;
    $this->compressed_size = 0;
    $this->len = 0;
    $this->date_time = new DateTime($time);

    # init hash context
    $this->hasher = new Hasher();

    # init data filter
    if ($this->method == Methods::DEFLATE) {
      $this->filter = new DeflateFilter($this->output);
    } else if ($this->method == Methods::STORE) {
      $this->filter = new StoreFilter($this->output);
    } else {
      $this->state = self::ENTRY_STATE_ERROR;
      throw new UnknownMethodError($this->method);
    }

    # sanity check path
    $this->check_path($name);
  }

  /**
   * Write data to file entry.
   *
   * @api
   *
   * @param string $data Output file data.
   *
   * @throw Error if entry state is invalid.
   *
   * @return int Number of bytes written to output.
   */
  public function write(string $data) : int {
    try {
      # check entry state
      if ($this->state != self::ENTRY_STATE_DATA) {
        throw new Error("invalid entry state");
      }

      # update output size
      $this->uncompressed_size += strlen($data);

      # update hash context
      $this->hasher->write($data);

      $len = $this->filter->write($data);
      $this->compressed_size += $len;

      # return length
      return $len;
    } catch (Exception $e) {
      $this->state = self::ENTRY_STATE_ERROR;
      throw $e;
    }
  }

  ########################
  # local header methods #
  ########################

  /**
   * Write local file header.
   *
   * @internal
   *
   * @throw Error if entry state is invalid.
   *
   * @return int Number of bytes written to output.
   */
  public function write_local_header() : int {
    # check state
    if ($this->state != self::ENTRY_STATE_INIT) {
      throw new Error("invalid entry state");
    }

    # get entry header, update entry length
    $data = $this->get_local_header();

    # write entry header
    $this->output->write($data);

    # set state
    $this->state = self::ENTRY_STATE_DATA;

    # return header length
    return strlen($data);
  }

  const ENTRY_VERSION_NEEDED = 45;
  const ENTRY_BIT_FLAGS = 0b100000001000;

  /**
   * Create local file header for this entry.
   *
   * @return string Packed local file header.
   */
  private function get_local_header() : string {
    # build extra data
    $extra_data = pack('vv',
      0x01,                       # zip64 extended info header ID (2 bytes)
      0                           # field size (2 bytes)
    );

    # build and return local file header
    return pack('VvvvvvVVVvv',
      0x04034b50,                 # local file header signature (4 bytes)
      VERSION_NEEDED,             # version needed to extract (2 bytes)
      self::ENTRY_BIT_FLAGS,      # general purpose bit flag (2 bytes)
      $this->method,              # compression method (2 bytes)
      $this->date_time->dos_time, # last mod file time (2 bytes)
      $this->date_time->dos_date, # last mod file date (2 bytes)
      0,                          # crc-32 (4 bytes, zero, in footer)
      0,                          # compressed size (4 bytes, zero, in footer)
      0,                          # uncompressed size (4 bytes, zero, in footer)
      strlen($this->name),        # file name length (2 bytes)
      strlen($extra_data)         # extra field length (2 bytes)
    ) . $this->name . $extra_data;
  }

  ########################
  # local footer methods #
  ########################

  /**
   * Write local file footer (e.g. data descriptor).
   *
   * @internal
   *
   * @throw Error if entry state is invalid.
   *
   * @return int Number of bytes written to output.
   */
  public function write_local_footer() : int {
    # check state
    if ($this->state != self::ENTRY_STATE_DATA) {
      $this->state = self::ENTRY_STATE_ERROR;
      throw new Error("invalid entry state");
    }

    # finalize hash context
    $this->hash = $this->hasher->close();
    $this->hasher = null;

    # flush remaining data
    $this->compressed_size += $this->filter->close();

    # get footer
    $data = $this->get_local_footer();

    # write footer to output
    $this->output->write($data);

    # set state
    $this->state = self::ENTRY_STATE_CLOSED;

    # return footer length
    return strlen($data);
  }

  /**
   * Create local file footer (data descriptor) for this entry.
   *
   * @return string Packed local file footer.
   */
  private function get_local_footer() : string {
    return pack('VVPP',
      0x08074b50,                 # data descriptor signature (4 bytes)
      $this->hash,                # crc-32 (4 bytes)
      $this->compressed_size,     # compressed size (8 bytes, zip64)
      $this->uncompressed_size    # uncompressed size (8 bytes, zip64)
    );
  }

  ##########################
  # central header methods #
  ##########################

  /**
   * Write central directory entry for this file to output writer.
   *
   * @internal
   *
   * @return int Number of bytes written to output.
   */
  public function write_central_header() : int {
    $data = $this->get_central_header();
    $this->output->write($data);
    return strlen($data);
  }

  /**
   * Create extra data for central directory entry for this file.
   *
   * @return string Packed extra data for central directory entry.
   */
  private function get_central_extra_data() : string {
    $r = [];

    # check uncompressed size for overflow
    if ($this->uncompressed_size >= 0xFFFFFFFF) {
      # append 64-bit uncompressed size
      $r[] = pack('P', $this->uncompressed_size);
    }

    # check compressed size for overflow
    if ($this->compressed_size >= 0xFFFFFFFF) {
      # append 64-bit compressed size
      $r[] = pack('P', $this->compressed_size);
    }

    # check offset for overflow
    if ($this->pos >= 0xFFFFFFFF) {
      # append 64-bit file offset
      $r[] = pack('P', $this->pos);
    }

    # build result
    $r = join('', $r);

    if (strlen($r) > 0) {
      # has overflow, so generate zip64 info
      $r = pack('vv',
        0x01,                     # zip64 ext. info extra tag (2 bytes)
        strlen($r)                # size of this extra block (2 bytes)
      ) . $r;
    }

    # return packed data
    return $r;
  }

  /**
   * Create central directory entry for this file.
   *
   * @return string Packed central directory entry.
   */
  private function get_central_header() : string {
    $extra_data = $this->get_central_extra_data();

    # get compressed size, uncompressed size, and offset
    $compressed_size = ($this->compressed_size >= 0xFFFFFFFF) ? 0xFFFFFFFF : $this->compressed_size;
    $uncompressed_size = ($this->uncompressed_size >= 0xFFFFFFFF) ? 0xFFFFFFFF : $this->uncompressed_size;
    $pos = ($this->pos >= 0xFFFFFFFF) ? 0xFFFFFFFF : $this->pos;

    # pack and return central header
    return pack('VvvvvvvVVVvvvvvVV',
      0x02014b50,                 # central file header signature (4 bytes)
      VERSION_NEEDED,             # FIXME: version made by (2 bytes)
      VERSION_NEEDED,             # version needed to extract (2 bytes)
      self::ENTRY_BIT_FLAGS,      # general purpose bit flag (2 bytes)
      $this->method,              # compression method (2 bytes)
      $this->date_time->dos_time, # last mod file time (2 bytes)
      $this->date_time->dos_date, # last mod file date (2 bytes)
      $this->hash,                # crc-32 (4 bytes)
      $compressed_size,           # compressed size (4 bytes)
      $uncompressed_size,         # uncompressed size (4 bytes)
      strlen($this->name),        # file name length (2 bytes)
      strlen($extra_data),        # extra field length (2 bytes)
      strlen($this->comment),     # file comment length (2 bytes)
      0,                          # disk number start (2 bytes)
      0,                          # TODO: internal file attributes (2 bytes)
      0,                          # TODO: external file attributes (4 bytes)
      $pos                        # relative offset of local header (4 bytes)
    ) . $this->name . $extra_data . $this->comment;
  }

  ###################
  # utility methods #
  ###################

  /**
   * Check file path.
   *
   * Verifies that the given file path satisfies the following
   * constraints:
   *
   * * Path is not null.
   * * Path not empty.
   * * Path is less than 65535 bytes in length.
   * * Path does not contain a leading slash.
   * * Path does not contain a trailing slash.
   * * Path does not contain double slashes.
   * * Path does not contain backslashes.
   * * Path is not a relative path.
   *
   * @param string $path Input file path.
   *
   * @return void
   *
   * @throw PathError if path is invalid.
   */
  private function check_path(string $path) : void {
    # make sure path is non-null
    if (!$path) {
      throw new PathError($path, "null path");
    }

    # check for empty path
    if (!strlen($path)) {
      throw new PathError($path, "empty path");
    }

    # check for long path
    if (strlen($path) >= 0xFFFF) {
      throw new PathError($path, "path too long");
    }

    # check for leading slash
    if ($path[0] == '/') {
      throw new PathError($path, "path contains leading slash");
    }

    # check for trailing slash
    if (preg_match('/\/$/', $path)) {
      throw new PathError($path, "path contains trailing slash");
    }

    # check for double slashes
    if (preg_match('/\/\//', $path)) {
      throw new PathError($path, "path contains double slashes");
    }

    # check for backslashes
    if (preg_match('/\\\\/', $path)) {
      throw new PathError($path, "path contains backslashes");
    }

    # check for relative path
    if (preg_match('/^\.\.|\\/\.\.\\/|\.\.$/', $path)) {
      throw new PathError($path, "relative path");
    }
  }
};

/**
 * Dynamically generate streamed zip archives.
 *
 * @api
 *
 * @example "examples/01-simple.php"
 */
final class ZipStream {
  /** @internal Initial stream state. */
  const STREAM_STATE_INIT = 0;
  /** @internal Writing an entry. */
  const STREAM_STATE_ENTRY = 1;
  /** @internal Stream is closed. */
  const STREAM_STATE_CLOSED = 2;
  /** @internal Encountered an error white streaming. */
  const STREAM_STATE_ERROR = 3;

  /** @internal Size, in bytes, of chunks to read from files. */
  const READ_BUF_SIZE = 8192;

  /** @var string Output archive name. */
  public $name;

  /**
   * @var array $args Hash of options.
   * @var Writer $output output Writer.
   * @var int $pos Current byte offset in output stream.
   * @var array $entries Array of archive entries.
   */
  private $args,
          $output,
          $pos = 0,
          $entries = [],
          $paths = [];

  /**
   * Default archive options.
   * @internal
   */
  static $ARCHIVE_DEFAULTS = [
    'method'  => Methods::DEFLATE,
    'comment' => '',
    'type'    => 'application/zip',
    'header'  => true,
  ];

  /**
   * Default file options.
   * @internal
   */
  static $FILE_DEFAULTS = [
    'comment' => '',
  ];

  /**
   * Create a new ZipStream object.
   *
   * @param string $name Output archive name.
   * @param array $args Hash of output options (optional).
   *
   * @example "examples/01-simple.php"
   */
  public function __construct(string $name, array $args = []) {
    try {
      # set state
      $this->state = self::STREAM_STATE_INIT;

      # set name and args
      $this->name = $name;
      $this->args = array_merge(self::$ARCHIVE_DEFAULTS, [
        'time' => time(),
      ], $args);

      # check archive method
      Methods::check($this->args['method']);

      # check archive comment length
      if (strlen($this->args['comment']) >= 0xFFFF) {
        throw new CommentError('archive comment too long');
      }

      # initialize output
      if (isset($args['output']) && $args['output']) {
        if (!is_subclass_of($args['output'], Writer::class)) {
          throw new Error('output must implement Writer interface');
        }

        # use specified output writer
        $this->output = $args['output'];
      } else {
        # no output set, create default response writer
        $this->output = new HTTPResponseWriter();
      }

      # set output metadata
      $this->output->set('name', $this->name);
      $this->output->set('type', $this->args['type']);

      # open output
      $this->output->open();
    } catch (Exception $e) {
      $this->state = self::STREAM_STATE_ERROR;
      throw $e;
    }
  }

  /**
   * Add file to output archive.
   *
   * @param string $dst_path Destination path in output archive.
   * @param string $data File contents.
   * @param array $args File options (optional).
   *
   * @return void
   *
   * @example "examples/01-simple.php"
   */
  public function add_file(
    string $dst_path,
    string $data,
    array $args = []
  ) : void {
    $this->add($dst_path, function(Entry &$e) use (&$data) {
      # write data
      $e->write($data);
    }, array_merge(self::$FILE_DEFAULTS, $args));
  }

  /**
   * Add file on the local file system to output archive.
   *
   * @param string $dst_path Destination path in output archive.
   * @param string $src_path Path to input file.
   * @param array $args File options (optional).
   *
   * @return void
   *
   * @example "examples/02-add_file_from_path.php"
   *
   * @throw FileError if the file could not be opened or read.
   */
  public function add_file_from_path(
    string $dst_path,
    string $src_path,
    array &$args = []
  ) : void {
    # get file time
    if (!isset($args['time'])) {
      # get file mtime
      $time = @filemtime($src_path);
      if ($time === false) {
        throw new FileError($src_path, "couldn't get file mtime");
      }

      # save file mtime
      $args['time'] = $time;
    }

    # close input stream
    $args['close'] = true;

    # open input stream
    $fh = @fopen($src_path, 'rb');
    if (!$fh) {
      throw new FileError($src_path, "couldn't open file");
    }

    # read input
    $this->add_stream($dst_path, $fh, $args);
  }

  /**
   * Add contents of resource stream to output archive.
   *
   * @param string $dst_path Destination path in output archive.
   * @param resource $src Input resource stream.
   * @param array $args File options (optional).
   *
   * @return void
   *
   * @example "examples/03-add_stream.php"
   *
   * @throw Error if $src is not a resource.
   * @throw Error if the resource could not be read.
   */
  public function add_stream(
    string $dst_path,
    &$src,
    array &$args = []
  ) : void {
    if (!is_resource($src)) {
      $this->state = self::STREAM_STATE_ERROR;
      throw new Error('source is not a resource');
    }

    $this->add($dst_path, function(Entry &$e) use (&$src, &$args) {
      # read input
      while (!feof($src)) {
        # read chunk
        $buf = @fread($src, self::READ_BUF_SIZE);

        # check for error
        if ($buf === false) {
          throw new Error("fread() error");
        }

        # write chunk to entry
        $e->write($buf);
      }

      # close input
      if (isset($args['close']) && $args['close']) {
        @fclose($src);
      }
    }, $args);
  }

  /**
   * Dynamically write file contents to output archive.
   *
   * @param string $dst_path Destination path in output archive.
   * @param callable $cb Write callback.
   * @param array $args File options (optional).
   *
   * @return void
   *
   * @example "examples/04-add.php"
   *
   * @throw Error if the archive is in an invalid state.
   * @throw Error if the destination path already exists.
   */
  public function add(
    string $dst_path,
    callable $cb,
    array $args = []
  ) : void {
    # check state
    if ($this->state != self::STREAM_STATE_INIT) {
      throw new Error("invalid output state");
    }

    # check for duplicate path
    if (isset($this->paths[$dst_path])) {
      throw new Error("duplicate path: $dst_path");
    }
    $this->paths[$dst_path] = true;

    # merge arguments with defaults
    $args = array_merge(self::$FILE_DEFAULTS, $args);

    try {
      # create new entry
      $e = new Entry(
        $this->output,
        $this->pos,
        $dst_path,
        $this->get_entry_method($args),
        $this->get_entry_time($args),
        $args['comment']
      );

      # add to entry list
      $this->entries[] = $e;

      # set state
      $this->state = self::STREAM_STATE_ENTRY;

      # write entry local header
      $header_len = $e->write_local_header();

      # pass entry to callback
      $cb($e);

      # write entry local footer
      $footer_len = $e->write_local_footer();

      # update output position
      $this->pos += $header_len + $e->compressed_size + $footer_len;

      # set state
      $this->state = self::STREAM_STATE_INIT;
    } catch (Exception $e) {
      # set error state, re-throw exception
      $this->state = self::STREAM_STATE_ERROR;
      throw $e;
    }
  }

  /**
   * Finalize the output stream.
   *
   * @return int Total number of bytes written.
   *
   * @throw Error if the archive is in an invalid state.
   *
   * @example "examples/01-simple.php"
   */
  public function close() : int {
    try {
      if ($this->state != self::STREAM_STATE_INIT) {
        throw new Error("invalid archive state");
      }

      # cache cdr offset, write cdr, get cdr length
      $cdr_pos = $this->pos;
      $cdr_len = array_reduce($this->entries, function($r, $e) {
        return $r + $e->write_central_header();
      }, 0);

      # update position
      $this->pos += $cdr_len;

      # cache zip64 end of cdr position
      $zip64_cdr_pos = $this->pos;

      # write zip64 end cdr record
      $data = $this->get_zip64_end_of_central_directory_record($cdr_pos, $cdr_len);
      $this->output->write($data);
      $this->pos += strlen($data);

      # write zip64 end cdr locator
      $data = $this->get_zip64_end_of_central_directory_locator($zip64_cdr_pos);
      $this->output->write($data);
      $this->pos += strlen($data);

      # write end cdr record
      $data = $this->get_end_of_central_directory_record($cdr_pos, $cdr_len);
      $this->output->write($data);
      $this->pos += strlen($data);

      # close output
      $this->output->close();

      # return total archive length
      return $this->pos;
    } catch (Exception $e) {
      $this->state = self::STREAM_STATE_ERROR;
      throw $e;
    }
  }

  /**
   * Create an archive and send it using a single function.
   *
   * @param string $name Name of output archive.
   * @param callable $cb Context callback.
   * @param array $args Hash of archive options (optional).
   *
   * @example "examples/05-send.php"
   */
  public static function send(
    string $name,
    callable $cb,
    array $args = []
  ) : int {
    # create archive
    $zip = new self($name, $args);

    # pass archive to callback
    $cb($zip);

    # close archive and return total number of bytes written
    return $zip->close();
  }

  ####################################
  # central directory record methods #
  ####################################

  /**
   * Get Zip64 end of Central Directory Record (CDR)
   *
   * @param int $cdr_pos CDR offset, in bytes.
   * @param int $cdr_len Size of CDR, in bytes.
   *
   * @return string Packed Zip64 end of Central Directory Record.
   */
  private function get_zip64_end_of_central_directory_record(
    int $cdr_pos,
    int $cdr_len
  ) : string {
    # get entry count
    $num_entries = count($this->entries);

    return pack('VPvvVVPPPP',
      0x06064b50, # zip64 end of central dir signature (4 bytes)
      44,         # size of zip64 end of central directory record (8 bytes)
      VERSION_NEEDED, # FIXME: version made by (2 bytes)
      VERSION_NEEDED, # version needed to extract (2 bytes)
      0,              # number of this disk (4 bytes)
      0,              # number of the disk with the start of the central directory (4 bytes)
      $num_entries,   # total number of entries in the central directory on this disk (8 bytes)
      $num_entries,   # total number of entries in the central directory (8 bytes)
      $cdr_len,       # size of the central directory  (8 bytes)
      $cdr_pos        # offset of start of central directory with respect to the starting disk number (8 bytes)
      # zip64 extensible data sector (variable size)
      # (FIXME: is extensible data sector needed?)
    );
  }

  /**
   * Get Zip64 End of Central Directory Record (CDR) Locator.
   *
   * @param int $zip64_cdr_pos Zip64 End of CDR offset, in bytes.
   *
   * @return string Packed Zip64 End of CDR Locator.
   */
  private function get_zip64_end_of_central_directory_locator(
    int $zip64_cdr_pos
  ) : string {
    return pack('VVPV',
      0x07064b50,     # zip64 end of central dir locator signature (4 bytes)
      0,              # number of the disk with the start of the zip64 end of central directory (4 bytes)
      $zip64_cdr_pos, # relative offset of the zip64 end of central directory record (8 bytes)
      1               # total number of disks (4 bytes)
    );
  }

  /**
   * Get End of Central Directory Record (CDR) Locator.
   *
   * @param int $cdr_pos CDR offset, in bytes.
   * @param int $cdr_len CDR size, in bytes.
   *
   * @return string End of CDR Record.
   */
  private function get_end_of_central_directory_record(
    int $cdr_pos,
    int $cdr_len
  ) : string {
    # get entry count
    $num_entries = count($this->entries);
    if ($num_entries >= 0xFFFF) {
      # clamp entry count
      $num_entries = 0xFFFF;
    }

    # get/clamp cdr_len and cdr_pos
    $cdr_len = ($cdr_len >= 0xFFFFFFFF) ? 0xFFFFFFFF : $cdr_len;
    $cdr_pos = ($cdr_pos >= 0xFFFFFFFF) ? 0xFFFFFFFF : $cdr_pos;

    # get comment, check length
    $comment = $this->args['comment'];
    if (strlen($comment) >= 0xFFFF) {
      throw new CommentError('archive comment too long');
    }

    return pack('VvvvvVVv',
      0x06054b50,       # end of central dir signature (4 bytes)
      0,                # number of this disk (2 bytes)
      0,                # disk with the start of the central directory (2 bytes)
      $num_entries,     # number of entries in the central directory on this disk (2 bytes)
      $num_entries,     # number of entries in the central directory (2 bytes)
      $cdr_len,         # size of the central directory (4 bytes)
      $cdr_pos,         # offset of start of central directory with respect to the starting disk number (4 bytes)
      strlen($comment)  # .ZIP file comment length (2 bytes)
    ) . $comment;
  }

  ###################
  # utility methods #
  ###################

  /**
   * Get UNIX timestamp for given entry.
   *
   * @param array $args Entry options.
   *
   * @return int UNIX timestamp.
   */
  private function get_entry_time(array &$args) : int {
    if (isset($args['time'])) {
      # use entry time
      return $args['time'];
    } else if (isset($this->args['time'])) {
      # use archive time
      return $this->args['time'];
    } else {
      # fall back to current time
      return time();
    }
  }

  /**
   * Get compression method for given entry.
   *
   * @param array $args Entry options.
   *
   * @return int Compression method.
   */
  private function get_entry_method(array &$args) : int {
    if (isset($args['method'])) {
      $r = $args['method'];
    } else if (isset($this->args['method'])) {
      $r = $this->args['method'];
    } else {
      # fall back to default method
      $r = Methods::DEFLATE;
    }

    # check method
    Methods::check($r);

    # return method
    return $r;
  }
};