/usr/share/perl5/MIME/Parser.pm is in libmime-tools-perl 5.503-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 | package MIME::Parser;
=head1 NAME
MIME::Parser - experimental class for parsing MIME streams
=head1 SYNOPSIS
Before reading further, you should see L<MIME::Tools> to make sure that
you understand where this module fits into the grand scheme of things.
Go on, do it now. I'll wait.
Ready? Ok...
=head2 Basic usage examples
### Create a new parser object:
my $parser = new MIME::Parser;
### Tell it where to put things:
$parser->output_under("/tmp");
### Parse an input filehandle:
$entity = $parser->parse(\*STDIN);
### Congratulations: you now have a (possibly multipart) MIME entity!
$entity->dump_skeleton; # for debugging
=head2 Examples of input
### Parse from filehandles:
$entity = $parser->parse(\*STDIN);
$entity = $parser->parse(IO::File->new("some command|");
### Parse from any object that supports getline() and read():
$entity = $parser->parse($myHandle);
### Parse an in-core MIME message:
$entity = $parser->parse_data($message);
### Parse an MIME message in a file:
$entity = $parser->parse_open("/some/file.msg");
### Parse an MIME message out of a pipeline:
$entity = $parser->parse_open("gunzip - < file.msg.gz |");
### Parse already-split input (as "deliver" would give it to you):
$entity = $parser->parse_two("msg.head", "msg.body");
=head2 Examples of output control
### Keep parsed message bodies in core (default outputs to disk):
$parser->output_to_core(1);
### Output each message body to a one-per-message directory:
$parser->output_under("/tmp");
### Output each message body to the same directory:
$parser->output_dir("/tmp");
### Change how nameless message-component files are named:
$parser->output_prefix("msg");
### Put temporary files somewhere else
$parser->tmp_dir("/var/tmp/mytmpdir");
=head2 Examples of error recovery
### Normal mechanism:
eval { $entity = $parser->parse(\*STDIN) };
if ($@) {
$results = $parser->results;
$decapitated = $parser->last_head; ### get last top-level head
}
### Ultra-tolerant mechanism:
$parser->ignore_errors(1);
$entity = eval { $parser->parse(\*STDIN) };
$error = ($@ || $parser->last_error);
### Cleanup all files created by the parse:
eval { $entity = $parser->parse(\*STDIN) };
...
$parser->filer->purge;
=head2 Examples of parser options
### Automatically attempt to RFC 2047-decode the MIME headers?
$parser->decode_headers(1); ### default is false
### Parse contained "message/rfc822" objects as nested MIME streams?
$parser->extract_nested_messages(0); ### default is true
### Look for uuencode in "text" messages, and extract it?
$parser->extract_uuencode(1); ### default is false
### Should we forgive normally-fatal errors?
$parser->ignore_errors(0); ### default is true
=head2 Miscellaneous examples
### Convert a Mail::Internet object to a MIME::Entity:
my $data = join('', (@{$mail->header}, "\n", @{$mail->body}));
$entity = $parser->parse_data(\$data);
=head1 DESCRIPTION
You can inherit from this class to create your own subclasses
that parse MIME streams into MIME::Entity objects.
=head1 PUBLIC INTERFACE
=cut
#------------------------------
require 5.004;
### Pragmas:
use strict;
use vars (qw($VERSION $CAT $CRLF));
### core Perl modules
use IO::File;
use File::Spec;
use File::Path;
use Config qw(%Config);
use Carp;
### Kit modules:
use MIME::Tools qw(:config :utils :msgtypes usage tmpopen );
use MIME::Head;
use MIME::Body;
use MIME::Entity;
use MIME::Decoder;
use MIME::Parser::Reader;
use MIME::Parser::Filer;
use MIME::Parser::Results;
#------------------------------
#
# Globals
#
#------------------------------
### The package version, both in 1.23 style *and* usable by MakeMaker:
$VERSION = "5.503";
### How to catenate:
$CAT = '/bin/cat';
### The CRLF sequence:
$CRLF = "\015\012";
### Who am I?
my $ME = 'MIME::Parser';
#------------------------------------------------------------
=head2 Construction
=over 4
=cut
#------------------------------
=item new ARGS...
I<Class method.>
Create a new parser object.
Once you do this, you can then set up various parameters
before doing the actual parsing. For example:
my $parser = new MIME::Parser;
$parser->output_dir("/tmp");
$parser->output_prefix("msg1");
my $entity = $parser->parse(\*STDIN);
Any arguments are passed into C<init()>.
Don't override this in your subclasses; override init() instead.
=cut
sub new {
my $self = bless {}, shift;
$self->init(@_);
}
#------------------------------
=item init ARGS...
I<Instance method.>
Initiallize a new MIME::Parser object.
This is automatically sent to a new object; you may want to override it.
If you override this, be sure to invoke the inherited method.
=cut
sub init {
my $self = shift;
$self->{MP5_DecodeHeaders} = 0;
$self->{MP5_DecodeBodies} = 1;
$self->{MP5_Interface} = {};
$self->{MP5_ParseNested} = 'NEST';
$self->{MP5_TmpToCore} = 0;
$self->{MP5_IgnoreErrors} = 1;
$self->{MP5_UUDecode} = 0;
$self->{MP5_MaxParts} = -1;
$self->{MP5_TmpDir} = undef;
$self->interface(ENTITY_CLASS => 'MIME::Entity');
$self->interface(HEAD_CLASS => 'MIME::Head');
$self->output_dir(".");
$self;
}
#------------------------------
=item init_parse
I<Instance method.>
Invoked automatically whenever one of the top-level parse() methods
is called, to reset the parser to a "ready" state.
=cut
sub init_parse {
my $self = shift;
$self->{MP5_Results} = new MIME::Parser::Results;
$self->{MP5_Filer}->results($self->{MP5_Results});
$self->{MP5_Filer}->purgeable([]);
$self->{MP5_Filer}->init_parse();
$self->{MP5_NumParts} = 0;
1;
}
=back
=cut
#------------------------------------------------------------
=head2 Altering how messages are parsed
=over 4
=cut
#------------------------------
=item decode_headers [YESNO]
I<Instance method.>
Controls whether the parser will attempt to decode all the MIME headers
(as per RFC 2047) the moment it sees them. B<This is not advisable
for two very important reasons:>
=over
=item *
B<It screws up the extraction of information from MIME fields.>
If you fully decode the headers into bytes, you can inadvertently
transform a parseable MIME header like this:
Content-type: text/plain; filename="=?ISO-8859-1?Q?Hi=22Ho?="
into unparseable gobbledygook; in this case:
Content-type: text/plain; filename="Hi"Ho"
=item *
B<It is information-lossy.> An encoded string which contains
both Latin-1 and Cyrillic characters will be turned into a binary
mishmosh which simply can't be rendered.
=back
B<History.>
This method was once the only out-of-the-box way to deal with attachments
whose filenames had non-ASCII characters. However, since MIME-tools 5.4xx
this is no longer necessary.
B<Parameters.>
If YESNO is true, decoding is done. However, you will get a warning
unless you use one of the special "true" values:
"I_NEED_TO_FIX_THIS"
Just shut up and do it. Not recommended.
Provided only for those who need to keep old scripts functioning.
"I_KNOW_WHAT_I_AM_DOING"
Just shut up and do it. Not recommended.
Provided for those who REALLY know what they are doing.
If YESNO is false (the default), no attempt at decoding will be done.
With no argument, just returns the current setting.
B<Remember:> you can always decode the headers I<after> the parsing
has completed (see L<MIME::Head::decode()|MIME::Head/decode>), or
decode the words on demand (see L<MIME::Words>).
=cut
sub decode_headers {
my ($self, $yesno) = @_;
if (@_ > 1) {
$self->{MP5_DecodeHeaders} = $yesno;
if ($yesno) {
if (($yesno eq "I_KNOW_WHAT_I_AM_DOING") ||
($yesno eq "I_NEED_TO_FIX_THIS")) {
### ok
}
else {
$self->whine("as of 5.4xx, decode_headers() should NOT be ".
"set true... if you are doing this to make sure ".
"that non-ASCII filenames are translated, ".
"that's now done automatically; for all else, ".
"use MIME::Words.");
}
}
}
$self->{MP5_DecodeHeaders};
}
#------------------------------
=item extract_nested_messages OPTION
I<Instance method.>
Some MIME messages will contain a part of type C<message/rfc822>
,C<message/partial> or C<message/external-body>:
literally, the text of an embedded mail/news/whatever message.
This option controls whether (and how) we parse that embedded message.
If the OPTION is false, we treat such a message just as if it were a
C<text/plain> document, without attempting to decode its contents.
If the OPTION is true (the default), the body of the C<message/rfc822>
or C<message/partial> part is parsed by this parser, creating an
entity object. What happens then is determined by the actual OPTION:
=over 4
=item NEST or 1
The default setting.
The contained message becomes the sole "part" of the C<message/rfc822>
entity (as if the containing message were a special kind of
"multipart" message).
You can recover the sub-entity by invoking the L<parts()|MIME::Entity/parts>
method on the C<message/rfc822> entity.
=item REPLACE
The contained message replaces the C<message/rfc822> entity, as though
the C<message/rfc822> "container" never existed.
B<Warning:> notice that, with this option, all the header information
in the C<message/rfc822> header is lost. This might seriously bother
you if you're dealing with a top-level message, and you've just lost
the sender's address and the subject line. C<:-/>.
=back
I<Thanks to Andreas Koenig for suggesting this method.>
=cut
sub extract_nested_messages {
my ($self, $option) = @_;
$self->{MP5_ParseNested} = $option if (@_ > 1);
$self->{MP5_ParseNested};
}
sub parse_nested_messages {
usage "parse_nested_messages() is now extract_nested_messages()";
shift->extract_nested_messages(@_);
}
#------------------------------
=item extract_uuencode [YESNO]
I<Instance method.>
If set true, then whenever we are confronted with a message
whose effective content-type is "text/plain" and whose encoding
is 7bit/8bit/binary, we scan the encoded body to see if it contains
uuencoded data (generally given away by a "begin XXX" line).
If it does, we explode the uuencoded message into a multipart,
where the text before the first "begin XXX" becomes the first part,
and all "begin...end" sections following become the subsequent parts.
The filename (if given) is accessible through the normal means.
=cut
sub extract_uuencode {
my ($self, $yesno) = @_;
$self->{MP5_UUDecode} = $yesno if @_ > 1;
$self->{MP5_UUDecode};
}
#------------------------------
=item ignore_errors [YESNO]
I<Instance method.>
Controls whether the parser will attempt to ignore normally-fatal
errors, treating them as warnings and continuing with the parse.
If YESNO is true (the default), many syntax errors are tolerated.
If YESNO is false, fatal errors throw exceptions.
With no argument, just returns the current setting.
=cut
sub ignore_errors {
my ($self, $yesno) = @_;
$self->{MP5_IgnoreErrors} = $yesno if (@_ > 1);
$self->{MP5_IgnoreErrors};
}
#------------------------------
=item decode_bodies [YESNO]
I<Instance method.>
Controls whether the parser should decode entity bodies or not.
If this is set to a false value (default is true), all entity bodies
will be kept as-is in the original content-transfer encoding.
To prevent double encoding on the output side MIME::Body->is_encoded
is set, which tells MIME::Body not to encode the data again, if encoded
data was requested. This is in particular useful, when it's important that
the content B<must not> be modified, e.g. if you want to calculate
OpenPGP signatures from it.
B<WARNING>: the semantics change significantly if you parse MIME
messages with this option set, because MIME::Entity resp. MIME::Body
*always* see encoded data now, while the default behaviour is
working with *decoded* data (and encoding it only if you request it).
You need to decode the data yourself, if you want to have it decoded.
So use this option only if you exactly know, what you're doing, and
that you're sure, that you really need it.
=cut
sub decode_bodies {
my ($self, $yesno) = @_;
$self->{MP5_DecodeBodies} = $yesno if (@_ > 1);
$self->{MP5_DecodeBodies};
}
#------------------------------
#
# MESSAGES...
#
#------------------------------
#
# debug MESSAGE...
#
sub debug {
my $self = shift;
if (MIME::Tools->debugging()) {
if (my $r = $self->{MP5_Results}) {
unshift @_, $r->indent;
$r->msg($M_DEBUG, @_);
}
MIME::Tools::debug(@_);
}
}
#------------------------------
#
# whine PROBLEM...
#
sub whine {
my $self = shift;
if (my $r = $self->{MP5_Results}) {
unshift @_, $r->indent;
$r->msg($M_WARNING, @_);
}
&MIME::Tools::whine(@_);
}
#------------------------------
#
# error PROBLEM...
#
# Possibly-forgivable parse error occurred.
# Raises a fatal exception unless we are ignoring errors.
#
sub error {
my $self = shift;
if (my $r = $self->{MP5_Results}) {
unshift @_, $r->indent;
$r->msg($M_ERROR, @_);
}
&MIME::Tools::error(@_);
$self->{MP5_IgnoreErrors} ? return undef : die @_;
}
#------------------------------
#
# PARSING...
#
#------------------------------
#
# process_preamble IN, READER, ENTITY
#
# I<Instance method.>
# Dispose of a multipart message's preamble.
#
sub process_preamble {
my ($self, $in, $rdr, $ent) = @_;
### Sanity:
($rdr->depth > 0) or die "$ME: internal logic error";
### Parse preamble:
my @saved;
my $data = '';
open(my $fh, '>', \$data) or die $!;
$rdr->read_chunk($in, $fh, 1);
close $fh;
# Ugh. Horrible. If the preamble consists only of CRLF, squash it down
# to the empty string. Else, remove the trailing CRLF.
if( $data =~ m/^[\r\n]\z/ ) {
@saved = ('');
} else {
$data =~ s/[\r\n]\z//;
@saved = split(/^/, $data);
}
$ent->preamble(\@saved);
1;
}
#------------------------------
#
# process_epilogue IN, READER, ENTITY
#
# I<Instance method.>
# Dispose of a multipart message's epilogue.
#
sub process_epilogue {
my ($self, $in, $rdr, $ent) = @_;
$self->debug("process_epilogue");
### Parse epilogue:
my @saved;
$rdr->read_lines($in, \@saved);
$ent->epilogue(\@saved);
1;
}
#------------------------------
#
# process_to_bound IN, READER, OUT
#
# I<Instance method.>
# Dispose of the next chunk into the given output stream OUT.
#
sub process_to_bound {
my ($self, $in, $rdr, $out) = @_;
### Parse:
$rdr->read_chunk($in, $out);
1;
}
#------------------------------
#
# process_header IN, READER
#
# I<Instance method.>
# Process and return the next header.
# Return undef if, instead of a header, the encapsulation boundary is found.
# Fatal exception on failure.
#
sub process_header {
my ($self, $in, $rdr) = @_;
$self->debug("process_header");
### Parse and save the (possibly empty) header, up to and including the
### blank line that terminates it:
my $head = $self->interface('HEAD_CLASS')->new;
### Read the lines of the header.
### We localize IO inside here, so that we can support the IO:: interface
my @headlines;
my $hdr_rdr = $rdr->spawn;
$hdr_rdr->add_terminator("");
$hdr_rdr->add_terminator("\r"); ### sigh
my $headstr = '';
open(my $outfh, '>:scalar', \$headstr) or die $!;
$hdr_rdr->read_chunk($in, $outfh, 0, 1);
close $outfh;
### How did we do?
if ($hdr_rdr->eos_type eq 'DELIM') {
$self->whine("bogus part, without CRLF before body");
return undef;
}
($hdr_rdr->eos_type eq 'DONE') or
$self->error("unexpected end of header\n");
### Extract the header (note that zero-size headers are admissible!):
open(my $readfh, '<:scalar', \$headstr) or die $!;
$head->read( $readfh );
unless( $readfh->eof() ) {
# Not entirely correct, since ->read consumes the line it gives up on.
# it's actually the line /before/ the one we get with ->getline
$self->error("couldn't parse head; error near:\n", $readfh->getline());
}
### If desired, auto-decode the header as per RFC 2047
### This shouldn't affect non-encoded headers; however, it will decode
### headers with international characters. WARNING: currently, the
### character-set information is LOST after decoding.
$head->decode($self->{MP5_DecodeHeaders}) if $self->{MP5_DecodeHeaders};
### If this is the top-level head, save it:
$self->results->top_head($head) if !$self->results->top_head;
return $head;
}
#------------------------------
#
# process_multipart IN, READER, ENTITY
#
# I<Instance method.>
# Process the multipart body, and return the state.
# Fatal exception on failure.
# Invoked by process_part().
#
sub process_multipart {
my ($self, $in, $rdr, $ent) = @_;
my $head = $ent->head;
$self->debug("process_multipart...");
### Get actual type and subtype from the header:
my ($type, $subtype) = (split('/', $head->mime_type, -1), '');
### If this was a type "multipart/digest", then the RFCs say we
### should default the parts to have type "message/rfc822".
### Thanks to Carsten Heyl for suggesting this...
my $retype = (($subtype eq 'digest') ? 'message/rfc822' : '');
### Get the boundaries for the parts:
my $bound = $head->multipart_boundary;
if (!defined($bound) || ($bound =~ /[\r\n]/)) {
$self->error("multipart boundary is missing, or contains CR or LF\n");
$ent->effective_type("application/x-unparseable-multipart");
return $self->process_singlepart($in, $rdr, $ent);
}
my $part_rdr = $rdr->spawn->add_boundary($bound);
### Prepare to parse:
my $eos_type;
my $more_parts;
### Parse preamble...
$self->process_preamble($in, $part_rdr, $ent);
### ...and look at how we finished up:
$eos_type = $part_rdr->eos_type;
if ($eos_type eq 'DELIM'){ $more_parts = 1 }
elsif ($eos_type eq 'CLOSE'){ $self->whine("empty multipart message\n");
$more_parts = 0; }
else { $self->error("unexpected end of preamble\n");
return 1; }
### Parse parts:
my $partno = 0;
my $part;
while ($more_parts) {
++$partno;
$self->debug("parsing part $partno...");
### Parse the next part, and add it to the entity...
my $part = $self->process_part($in, $part_rdr, Retype=>$retype);
return undef unless defined($part);
$ent->add_part($part);
### ...and look at how we finished up:
$eos_type = $part_rdr->eos_type;
if ($eos_type eq 'DELIM') { $more_parts = 1 }
elsif ($eos_type eq 'CLOSE') { $more_parts = 0; }
else { $self->error("unexpected end of parts ".
"before epilogue\n");
return 1; }
}
### Parse epilogue...
### (note that we use the *parent's* reader here, which does not
### know about the boundaries in this multipart!)
$self->process_epilogue($in, $rdr, $ent);
### ...and there's no need to look at how we finished up!
1;
}
#------------------------------
#
# process_singlepart IN, READER, ENTITY
#
# I<Instance method.>
# Process the singlepart body. Returns true.
# Fatal exception on failure.
# Invoked by process_part().
#
sub process_singlepart {
my ($self, $in, $rdr, $ent) = @_;
my $head = $ent->head;
$self->debug("process_singlepart...");
### Obtain a filehandle for reading the encoded information:
### We have two different approaches, based on whether or not we
### have to contend with boundaries.
my $ENCODED; ### handle
my $can_shortcut = (!$rdr->has_bounds and !$self->{MP5_UUDecode});
if ($can_shortcut) {
$self->debug("taking shortcut");
$ENCODED = $in;
$rdr->eos('EOF'); ### be sure to bogus-up the reader state to EOF:
}
else {
$self->debug("using temp file");
$ENCODED = $self->new_tmpfile();
### Read encoded body until boundary (or EOF)...
$self->process_to_bound($in, $rdr, $ENCODED);
### ...and look at how we finished up.
### If we have bounds, we want DELIM or CLOSE.
### Otherwise, we want EOF (and that's all we'd get, anyway!).
if ($rdr->has_bounds) {
($rdr->eos_type =~ /^(DELIM|CLOSE)$/) or
$self->error("part did not end with expected boundary\n");
}
### Flush and rewind encoded buffer, so we can read it:
$ENCODED->flush or die "$ME: can't flush: $!";
$ENCODED->seek(0, 0) or die "$ME: can't seek: $!";
}
### Get a content-decoder to decode this part's encoding:
my $encoding = $head->mime_encoding;
my $decoder = new MIME::Decoder $encoding;
if (!$decoder) {
$self->whine("Unsupported encoding '$encoding': using 'binary'... \n".
"The entity will have an effective MIME type of \n".
"application/octet-stream."); ### as per RFC-2045
$ent->effective_type('application/octet-stream');
$decoder = new MIME::Decoder 'binary';
$encoding = 'binary';
}
### Data should be stored encoded / as-is?
if ( !$self->decode_bodies ) {
$decoder = new MIME::Decoder 'binary';
$encoding = 'binary';
}
### If desired, sidetrack to troll for UUENCODE:
$self->debug("extract uuencode? ", $self->extract_uuencode);
$self->debug("encoding? ", $encoding);
$self->debug("effective type? ", $ent->effective_type);
if ($self->extract_uuencode and
($encoding =~ /^(7bit|8bit|binary)\Z/) and
($ent->effective_type =~
m{^(?:text/plain|application/mac-binhex40|application/mac-binhex)\Z})) {
### Hunt for it:
my $uu_ent = eval { $self->hunt_for_uuencode($ENCODED, $ent) };
if ($uu_ent) { ### snark
%$ent = %$uu_ent;
return 1;
}
else { ### boojum
$self->whine("while hunting for uuencode: $@");
$ENCODED->seek(0,0) or die "$ME: can't seek: $!";
}
}
### Open a new bodyhandle for outputting the data:
my $body = $self->new_body_for($head) or die "$ME: no body"; # gotta die
$body->binmode(1) or die "$ME: can't set to binmode: $!"
unless textual_type($ent->effective_type) or !$self->decode_bodies;
$body->is_encoded(1) if !$self->decode_bodies;
### Decode and save the body (using the decoder):
my $DECODED = $body->open("w") or die "$ME: body not opened: $!";
eval { $decoder->decode($ENCODED, $DECODED); };
$@ and $self->error($@);
$DECODED->close or die "$ME: can't close: $!";
### Success! Remember where we put stuff:
$ent->bodyhandle($body);
### Done!
1;
}
#------------------------------
#
# hunt_for_uuencode ENCODED, ENTITY
#
# I<Instance method.>
# Try to detect and dispatch embedded uuencode as a fake multipart message.
# Returns new entity or undef.
#
sub hunt_for_uuencode {
my ($self, $ENCODED, $ent) = @_;
my ($good, $how_encoded);
local $_;
$self->debug("sniffing around for UUENCODE");
### Heuristic:
$ENCODED->seek(0,0) or die "$ME: can't seek: $!";
while (defined($_ = $ENCODED->getline)) {
if ($good = /^begin [0-7]{3}/) {
$how_encoded = 'uu';
last;
}
if ($good = /^\(This file must be converted with/i) {
$how_encoded = 'binhex';
last;
}
}
$good or do { $self->debug("no one made the cut"); return 0 };
# If a decoder doesn't exist for this type, forget it!
my $decoder = MIME::Decoder->new(($how_encoded eq 'uu')?'x-uuencode'
:'binhex');
unless (defined($decoder)) {
$self->debug("No decoder for $how_encoded attachments");
return 0;
}
### New entity:
my $top_ent = $ent->dup; ### no data yet
$top_ent->make_multipart;
my @parts;
### Made the first cut; on to the real stuff:
$ENCODED->seek(0,0) or die "$ME: can't seek: $!";
$self->whine("Found a $how_encoded attachment");
my $pre;
while (1) {
my $bin_data = '';
### Try next part:
my $out = IO::File->new(\$bin_data, '>:');
eval { $decoder->decode($ENCODED, $out) }; last if $@;
my $preamble = $decoder->last_preamble;
my $filename = $decoder->last_filename;
my $mode = $decoder->last_mode;
### Get probable type:
my $type = 'application/octet-stream';
my ($ext) = $filename =~ /\.(\w+)\Z/; $ext = lc($ext || '');
if ($ext =~ /^(gif|jpe?g|xbm|xpm|png)\Z/) { $type = "image/$1" }
### If we got our first preamble, create the text portion:
if (@$preamble and
(grep /\S/, @$preamble) and
!@parts) {
my $txt_ent = $self->interface('ENTITY_CLASS')->new;
MIME::Entity->build(Type => "text/plain",
Data => "");
$txt_ent->bodyhandle($self->new_body_for($txt_ent->head));
my $io = $txt_ent->bodyhandle->open("w") or die "$ME: can't create: $!";
$io->print(@$preamble) or die "$ME: can't print: $!";
$io->close or die "$ME: can't close: $!";
push @parts, $txt_ent;
}
### Create the attachment:
### We use the x-unix-mode convention from "dtmail 1.2.1 SunOS 5.6".
if (1) {
my $bin_ent = MIME::Entity->build(Type=>$type,
Filename=>$filename,
Data=>"");
$bin_ent->head->mime_attr('Content-type.x-unix-mode' => "0$mode");
$bin_ent->bodyhandle($self->new_body_for($bin_ent->head));
$bin_ent->bodyhandle->binmode(1) or die "$ME: can't set to binmode: $!";
my $io = $bin_ent->bodyhandle->open("w") or die "$ME: can't create: $!";
$io->print($bin_data) or die "$ME: can't print: $!";
$io->close or die "$ME: can't close: $!";
push @parts, $bin_ent;
}
}
### Did we get anything?
@parts or return undef;
### Set the parts and a nice preamble:
$top_ent->parts(\@parts);
$top_ent->preamble
(["The following is a multipart MIME message which was extracted\n",
"from a $how_encoded-encoded message.\n"]);
$top_ent;
}
#------------------------------
#
# process_message IN, READER, ENTITY
#
# I<Instance method.>
# Process the singlepart body, and return true.
# Fatal exception on failure.
# Invoked by process_part().
#
sub process_message {
my ($self, $in, $rdr, $ent) = @_;
my $head = $ent->head;
$self->debug("process_message");
### Verify the encoding restrictions:
my $encoding = $head->mime_encoding;
if ($encoding !~ /^(7bit|8bit|binary)$/) {
$self->error("illegal encoding [$encoding] for MIME type ".
$head->mime_type."\n");
$encoding = 'binary';
}
### Parse the message:
my $msg = $self->process_part($in, $rdr);
return undef unless defined($msg);
### How to handle nested messages?
if ($self->extract_nested_messages eq 'REPLACE') {
%$ent = %$msg; ### shallow replace
%$msg = ();
}
else { ### "NEST" or generic 1:
$ent->bodyhandle(undef);
$ent->add_part($msg);
}
1;
}
#------------------------------
#
# process_part IN, READER, [OPTSHASH...]
#
# I<Instance method.>
# The real back-end engine.
# See the documentation up top for the overview of the algorithm.
# The OPTSHASH can contain:
#
# Retype => retype this part to the given content-type
#
# Return the entity.
# Fatal exception on failure. Returns undef if message to complex
#
sub process_part {
my ($self, $in, $rdr, %p) = @_;
if ($self->{MP5_MaxParts} > 0) {
$self->{MP5_NumParts}++;
if ($self->{MP5_NumParts} > $self->{MP5_MaxParts}) {
# Return UNDEF if msg too complex
return undef;
}
}
$rdr ||= MIME::Parser::Reader->new;
#debug "process_part";
$self->results->level(+1);
### Create a new entity:
my $ent = $self->interface('ENTITY_CLASS')->new;
### Parse and add the header:
my $head = $self->process_header($in, $rdr);
if (not defined $head) {
$self->debug("bogus empty part");
$head = $self->interface('HEAD_CLASS')->new;
$head->mime_type('text/plain');
$ent->head($head);
$ent->bodyhandle($self->new_body_for($head));
$ent->bodyhandle->open("w")->close or die "$ME: can't close: $!";
$self->results->level(-1);
return $ent;
}
$ent->head($head);
### Tweak the content-type based on context from our parent...
### For example, multipart/digest messages default to type message/rfc822:
$head->mime_type($p{Retype}) if $p{Retype};
### Get the MIME type and subtype:
my ($type, $subtype) = (split('/', $head->mime_type, -1), '');
$self->debug("type = $type, subtype = $subtype");
### Handle, according to the MIME type:
if ($type eq 'multipart') {
return undef unless defined($self->process_multipart($in, $rdr, $ent));
}
elsif (("$type/$subtype" eq "message/rfc822" ||
"$type/$subtype" eq "message/external-body" ||
("$type/$subtype" eq "message/partial" && defined($head->mime_attr("content-type.number")) && $head->mime_attr("content-type.number") == 1)) &&
$self->extract_nested_messages) {
$self->debug("attempting to process a nested message");
return undef unless defined($self->process_message($in, $rdr, $ent));
}
else {
$self->process_singlepart($in, $rdr, $ent);
}
### Done (we hope!):
$self->results->level(-1);
return $ent;
}
=back
=head2 Parsing an input source
=over 4
=cut
#------------------------------
=item parse_data DATA
I<Instance method.>
Parse a MIME message that's already in core. This internally creates an "in
memory" filehandle on a Perl scalar value using PerlIO
You may supply the DATA in any of a number of ways...
=over 4
=item *
B<A scalar> which holds the message. A reference to this scalar will be used
internally.
=item *
B<A ref to a scalar> which holds the message. This reference will be used
internally.
=item *
B<DEPRECATED>
B<A ref to an array of scalars.> The array is internally concatenated into a
temporary string, and a reference to the new string is used internally.
It is much more efficient to pass in a scalar reference, so please consider
refactoring your code to use that interface instead. If you absolutely MUST
pass an array, you may be better off using IO::ScalarArray in the calling code
to generate a filehandle, and passing that filehandle to I<parse()>
=back
Returns the parsed MIME::Entity on success.
=cut
sub parse_data {
my ($self, $data) = @_;
### Get data as a scalar:
my $io;
if (! ref $data ) {
$io = IO::File->new(\$data, '<:');
} elsif( ref $data eq 'SCALAR' ) {
$io = IO::File->new($data, '<:');
} elsif( ref $data eq 'ARRAY' ) {
# Passing arrays is deprecated now that we've nuked IO::ScalarArray
# but for backwards compatability we still support it by joining the
# array lines to a scalar and doing scalar IO on it.
my $tmp_data = join('', @$data);
$io = IO::File->new(\$tmp_data, '<:');
} else {
croak "parse_data: wrong argument ref type: ", ref($data);
}
### Parse!
return $self->parse($io);
}
#------------------------------
=item parse INSTREAM
I<Instance method.>
Takes a MIME-stream and splits it into its component entities.
The INSTREAM can be given as an IO::File, a globref filehandle (like
C<\*STDIN>), or as I<any> blessed object conforming to the IO::
interface (which minimally implements getline() and read()).
Returns the parsed MIME::Entity on success.
Throws exception on failure. If the message contained too many
parts (as set by I<max_parts>), returns undef.
=cut
sub parse {
my $self = shift;
my $in = shift;
my $entity;
local $/ = "\n"; ### just to be safe
local $\ = undef; # CPAN ticket #71041
$self->init_parse;
$entity = $self->process_part($in, undef); ### parse!
$entity;
}
### Backcompat:
sub read {
shift->parse(@_);
}
sub parse_FH {
shift->parse(@_);
}
#------------------------------
=item parse_open EXPR
I<Instance method.>
Convenience front-end onto C<parse()>.
Simply give this method any expression that may be sent as the second
argument to open() to open a filehandle for reading.
Returns the parsed MIME::Entity on success.
Throws exception on failure.
=cut
sub parse_open {
my ($self, $expr) = @_;
my $ent;
my $io = IO::File->new($expr) or die "$ME: couldn't open $expr: $!";
$ent = $self->parse($io);
$io->close or die "$ME: can't close: $!";
$ent;
}
### Backcompat:
sub parse_in {
usage "parse_in() is now parse_open()";
shift->parse_open(@_);
}
#------------------------------
=item parse_two HEADFILE, BODYFILE
I<Instance method.>
Convenience front-end onto C<parse_open()>, intended for programs
running under mail-handlers like B<deliver>, which splits the incoming
mail message into a header file and a body file.
Simply give this method the paths to the respective files.
B<Warning:> it is assumed that, once the files are cat'ed together,
there will be a blank line separating the head part and the body part.
B<Warning:> new implementation slurps files into line array
for portability, instead of using 'cat'. May be an issue if
your messages are large.
Returns the parsed MIME::Entity on success.
Throws exception on failure.
=cut
sub parse_two {
my ($self, $headfile, $bodyfile) = @_;
my $data;
foreach ($headfile, $bodyfile) {
open IN, "<$_" or die "$ME: open $_: $!";
$data .= do { local $/; <IN> };
close IN or die "$ME: can't close: $!";
}
return $self->parse_data($data);
}
=back
=cut
#------------------------------------------------------------
=head2 Specifying output destination
B<Warning:> in 5.212 and before, this was done by methods
of MIME::Parser. However, since many users have requested
fine-tuned control over how this is done, the logic has been split
off from the parser into its own class, MIME::Parser::Filer
Every MIME::Parser maintains an instance of a MIME::Parser::Filer
subclass to manage disk output (see L<MIME::Parser::Filer> for details.)
The benefit to this is that the MIME::Parser code won't be
confounded with a lot of garbage related to disk output.
The drawback is that the way you override the default behavior
will change.
For now, all the normal public-interface methods are still provided,
but many are only stubs which create or delegate to the underlying
MIME::Parser::Filer object.
=over 4
=cut
#------------------------------
=item filer [FILER]
I<Instance method.>
Get/set the FILER object used to manage the output of files to disk.
This will be some subclass of L<MIME::Parser::Filer|MIME::Parser::Filer>.
=cut
sub filer {
my ($self, $filer) = @_;
if (@_ > 1) {
$self->{MP5_Filer} = $filer;
$filer->results($self->results); ### but we still need in init_parse
}
$self->{MP5_Filer};
}
#------------------------------
=item output_dir DIRECTORY
I<Instance method.>
Causes messages to be filed directly into the given DIRECTORY.
It does this by setting the underlying L<filer()|/filer> to
a new instance of MIME::Parser::FileInto, and passing the arguments
into that class' new() method.
B<Note:> Since this method replaces the underlying
filer, you must invoke it I<before> doing changing any attributes
of the filer, like the output prefix; otherwise those changes
will be lost.
=cut
sub output_dir {
my ($self, @init) = @_;
if (@_ > 1) {
$self->filer(MIME::Parser::FileInto->new(@init));
}
else {
&MIME::Tools::whine("0-arg form of output_dir is deprecated.");
return $self->filer->output_dir;
}
}
#------------------------------
=item output_under BASEDIR, OPTS...
I<Instance method.>
Causes messages to be filed directly into subdirectories of the given
BASEDIR, one subdirectory per message. It does this by setting the
underlying L<filer()|/filer> to a new instance of MIME::Parser::FileUnder,
and passing the arguments into that class' new() method.
B<Note:> Since this method replaces the underlying
filer, you must invoke it I<before> doing changing any attributes
of the filer, like the output prefix; otherwise those changes
will be lost.
=cut
sub output_under {
my ($self, @init) = @_;
if (@_ > 1) {
$self->filer(MIME::Parser::FileUnder->new(@init));
}
else {
&MIME::Tools::whine("0-arg form of output_under is deprecated.");
return $self->filer->output_dir;
}
}
#------------------------------
=item output_path HEAD
I<Instance method, DEPRECATED.>
Given a MIME head for a file to be extracted, come up with a good
output pathname for the extracted file.
Identical to the preferred form:
$parser->filer->output_path(...args...);
We just delegate this to the underlying L<filer()|/filer> object.
=cut
sub output_path {
my $self = shift;
### We use it, so don't warn!
### &MIME::Tools::whine("output_path deprecated in MIME::Parser");
$self->filer->output_path(@_);
}
#------------------------------
=item output_prefix [PREFIX]
I<Instance method, DEPRECATED.>
Get/set the short string that all filenames for extracted body-parts
will begin with (assuming that there is no better "recommended filename").
Identical to the preferred form:
$parser->filer->output_prefix(...args...);
We just delegate this to the underlying L<filer()|/filer> object.
=cut
sub output_prefix {
my $self = shift;
&MIME::Tools::whine("output_prefix deprecated in MIME::Parser");
$self->filer->output_prefix(@_);
}
#------------------------------
=item evil_filename NAME
I<Instance method, DEPRECATED.>
Identical to the preferred form:
$parser->filer->evil_filename(...args...);
We just delegate this to the underlying L<filer()|/filer> object.
=cut
sub evil_filename {
my $self = shift;
&MIME::Tools::whine("evil_filename deprecated in MIME::Parser");
$self->filer->evil_filename(@_);
}
#------------------------------
=item max_parts NUM
I<Instance method.>
Limits the number of MIME parts we will parse.
Normally, instances of this class parse a message to the bitter end.
Messages with many MIME parts can cause excessive memory consumption.
If you invoke this method, parsing will abort with a die() if a message
contains more than NUM parts.
If NUM is set to -1 (the default), then no maximum limit is enforced.
With no argument, returns the current setting as an integer
=cut
sub max_parts {
my($self, $num) = @_;
if (@_ > 1) {
$self->{MP5_MaxParts} = $num;
}
return $self->{MP5_MaxParts};
}
#------------------------------
=item output_to_core YESNO
I<Instance method.>
Normally, instances of this class output all their decoded body
data to disk files (via MIME::Body::File). However, you can change
this behaviour by invoking this method before parsing:
If YESNO is false (the default), then all body data goes
to disk files.
If YESNO is true, then all body data goes to in-core data structures
This is a little risky (what if someone emails you an MPEG or a tar
file, hmmm?) but people seem to want this bit of noose-shaped rope,
so I'm providing it.
Note that setting this attribute true I<does not> mean that parser-internal
temporary files are avoided! Use L<tmp_to_core()|/tmp_to_core> for that.
With no argument, returns the current setting as a boolean.
=cut
sub output_to_core {
my ($self, $yesno) = @_;
if (@_ > 1) {
$yesno = 0 if ($yesno and $yesno eq 'NONE');
$self->{MP5_FilerToCore} = $yesno;
}
$self->{MP5_FilerToCore};
}
=item tmp_recycling
I<Instance method, DEPRECATED.>
This method is a no-op to preserve the pre-5.421 API.
The tmp_recycling() feature was removed in 5.421 because it had never actually
worked. Please update your code to stop using it.
=cut
sub tmp_recycling
{
return;
}
#------------------------------
=item tmp_to_core [YESNO]
I<Instance method.>
Should L<new_tmpfile()|/new_tmpfile> create real temp files, or
use fake in-core ones? Normally we allow the creation of temporary
disk files, since this allows us to handle huge attachments even when
core is limited.
If YESNO is true, we implement new_tmpfile() via in-core handles.
If YESNO is false (the default), we use real tmpfiles.
With no argument, just returns the current setting.
=cut
sub tmp_to_core {
my ($self, $yesno) = @_;
$self->{MP5_TmpToCore} = $yesno if (@_ > 1);
$self->{MP5_TmpToCore};
}
#------------------------------
=item use_inner_files [YESNO]
I<REMOVED>.
I<Instance method.>
MIME::Parser no longer supports IO::InnerFile, but this method is retained for
backwards compatibility. It does nothing.
The original reasoning for IO::InnerFile was that inner files were faster than
"in-core" temp files. At the time, the "in-core" tempfile support was
implemented with IO::Scalar from the IO-Stringy distribution, which used the
tie() interface to wrap a scalar with the appropriate IO::Handle operations.
The penalty for this was fairly hefty, and IO::InnerFile actually was faster.
Nowadays, MIME::Parser uses Perl's built in ability to open a filehandle on an
in-memory scalar variable via PerlIO. Benchmarking shows that IO::InnerFile is
slightly slower than using in-memory temporary files, and is slightly faster
than on-disk temporary files. Both measurements are within a few percent of
each other. Since there's no real benefit, and since the IO::InnerFile abuse
was fairly hairy and evil ("writes" to it were faked by extending the size of
the inner file with the assumption that the only data you'd ever ->print() to
it would be the line from the "outer" file, for example) it's been removed.
=cut
sub use_inner_files {
return 0;
}
=back
=cut
#------------------------------------------------------------
=head2 Specifying classes to be instantiated
=over 4
=cut
#------------------------------
=item interface ROLE,[VALUE]
I<Instance method.>
During parsing, the parser normally creates instances of certain classes,
like MIME::Entity. However, you may want to create a parser subclass
that uses your own experimental head, entity, etc. classes (for example,
your "head" class may provide some additional MIME-field-oriented methods).
If so, then this is the method that your subclass should invoke during
init. Use it like this:
package MyParser;
@ISA = qw(MIME::Parser);
...
sub init {
my $self = shift;
$self->SUPER::init(@_); ### do my parent's init
$self->interface(ENTITY_CLASS => 'MIME::MyEntity');
$self->interface(HEAD_CLASS => 'MIME::MyHead');
$self; ### return
}
With no VALUE, returns the VALUE currently associated with that ROLE.
=cut
sub interface {
my ($self, $role, $value) = @_;
$self->{MP5_Interface}{$role} = $value if (defined($value));
$self->{MP5_Interface}{$role};
}
#------------------------------
=item new_body_for HEAD
I<Instance method.>
Based on the HEAD of a part we are parsing, return a new
body object (any desirable subclass of MIME::Body) for
receiving that part's data.
If you set the C<output_to_core> option to false before parsing
(the default), then we call C<output_path()> and create a
new MIME::Body::File on that filename.
If you set the C<output_to_core> option to true before parsing,
then you get a MIME::Body::InCore instead.
If you want the parser to do something else entirely, you can
override this method in a subclass.
=cut
sub new_body_for {
my ($self, $head) = @_;
if ($self->output_to_core) {
$self->debug("outputting body to core");
return (new MIME::Body::InCore);
}
else {
my $outpath = $self->output_path($head);
$self->debug("outputting body to disk file: $outpath");
$self->filer->purgeable($outpath); ### we plan to use it
return (new MIME::Body::File $outpath);
}
}
#------------------------------
=pod
=back
=head2 Temporary File Creation
=over
=item tmp_dir DIRECTORY
I<Instance method.>
Causes any temporary files created by this parser to be created in the
given DIRECTORY.
If called without arguments, returns current value.
The default value is undef, which will cause new_tmpfile() to use the
system default temporary directory.
=cut
sub tmp_dir
{
my ($self, $dirname) = @_;
if ( $dirname ) {
$self->{MP5_TmpDir} = $dirname;
}
return $self->{MP5_TmpDir};
}
=item new_tmpfile
I<Instance method.>
Return an IO handle to be used to hold temporary data during a parse.
The default uses MIME::Tools::tmpopen() to create a new temporary file,
unless L<tmp_to_core()|/tmp_to_core> dictates otherwise, but you can
override this. You shouldn't need to.
The location for temporary files can be changed on a per-parser basis
with L<tmp_dir()>.
If you do override this, make certain that the object you return is
set for binmode(), and is able to handle the following methods:
read(BUF, NBYTES)
getline()
getlines()
print(@ARGS)
flush()
seek(0, 0)
Fatal exception if the stream could not be established.
=cut
sub new_tmpfile {
my ($self) = @_;
my $io;
if ($self->{MP5_TmpToCore}) {
my $var;
$io = IO::File->new(\$var, '+>:') or die "$ME: Can't open in-core tmpfile: $!";
} else {
my $args = {};
if( $self->tmp_dir ) {
$args->{DIR} = $self->tmp_dir;
}
$io = tmpopen( $args ) or die "$ME: can't open tmpfile: $!\n";
binmode($io) or die "$ME: can't set to binmode: $!";
}
return $io;
}
=back
=cut
#------------------------------------------------------------
=head2 Parse results and error recovery
=over 4
=cut
#------------------------------
=item last_error
I<Instance method.>
Return the error (if any) that we ignored in the last parse.
=cut
sub last_error {
join '', shift->results->errors;
}
#------------------------------
=item last_head
I<Instance method.>
Return the top-level MIME header of the last stream we attempted to parse.
This is useful for replying to people who sent us bad MIME messages.
### Parse an input stream:
eval { $entity = $parser->parse(\*STDIN) };
if (!$entity) { ### parse failed!
my $decapitated = $parser->last_head;
...
}
=cut
sub last_head {
shift->results->top_head;
}
#------------------------------
=item results
I<Instance method.>
Return an object containing lots of info from the last entity parsed.
This will be an instance of class
L<MIME::Parser::Results|MIME::Parser::Results>.
=cut
sub results {
shift->{MP5_Results};
}
=back
=cut
#------------------------------
1;
__END__
=head1 OPTIMIZING YOUR PARSER
=head2 Maximizing speed
Optimum input mechanisms:
parse() YES (if you give it a globref or a
subclass of IO::File)
parse_open() YES
parse_data() NO (see below)
parse_two() NO (see below)
Optimum settings:
decode_headers() *** (no real difference; 0 is slightly faster)
extract_nested_messages() 0 (may be slightly faster, but in
general you want it set to 1)
output_to_core() 0 (will be MUCH faster)
tmp_to_core() 0 (will be MUCH faster)
B<Native I/O is much faster than object-oriented I/O.>
It's much faster to use E<lt>$fooE<gt> than $foo-E<gt>getline.
For backwards compatibility, this module must continue to use
object-oriented I/O in most places, but if you use L<parse()|/parse>
with a "real" filehandle (string, globref, or subclass of IO::File)
then MIME::Parser is able to perform some crucial optimizations.
B<The parse_two() call is very inefficient.>
Currently this is just a front-end onto parse_data().
If your OS supports it, you're I<far> better off doing something like:
$parser->parse_open("/bin/cat msg.head msg.body |");
=head2 Minimizing memory
Optimum input mechanisms:
parse() YES
parse_open() YES
parse_data() NO (in-core I/O will burn core)
parse_two() NO (in-core I/O will burn core)
Optimum settings:
decode_headers() *** (no real difference)
extract_nested_messages() *** (no real difference)
output_to_core() 0 (will use MUCH less memory)
tmp_to_core is 1)
tmp_to_core() 0 (will use MUCH less memory)
=head2 Maximizing tolerance of bad MIME
Optimum input mechanisms:
parse() *** (doesn't matter)
parse_open() *** (doesn't matter)
parse_data() *** (doesn't matter)
parse_two() *** (doesn't matter)
Optimum settings:
decode_headers() 0 (sidesteps problem of bad hdr encodings)
extract_nested_messages() 0 (sidesteps problems of bad nested messages,
but often you want it set to 1 anyway).
output_to_core() *** (doesn't matter)
tmp_to_core() *** (doesn't matter)
=head2 Avoiding disk-based temporary files
Optimum input mechanisms:
parse() YES (if you give it a seekable handle)
parse_open() YES (becomes a seekable handle)
parse_data() NO (unless you set tmp_to_core(1))
parse_two() NO (unless you set tmp_to_core(1))
Optimum settings:
decode_headers() *** (doesn't matter)
extract_nested_messages() *** (doesn't matter)
output_to_core() *** (doesn't matter)
tmp_to_core() 1
B<You can veto tmpfiles entirely.>
You can set L<tmp_to_core()|/tmp_to_core> true: this will always
use in-core I/O for the buffering (B<warning:> this will slow down
the parsing of messages with large attachments).
B<Final resort.>
You can always override L<new_tmpfile()|/new_tmpfile> in a subclass.
=head1 WARNINGS
=over 4
=item Multipart messages are always read line-by-line
Multipart document parts are read line-by-line, so that the
encapsulation boundaries may easily be detected. However, bad MIME
composition agents (for example, naive CGI scripts) might return
multipart documents where the parts are, say, unencoded bitmap
files... and, consequently, where such "lines" might be
veeeeeeeeery long indeed.
A better solution for this case would be to set up some form of
state machine for input processing. This will be left for future versions.
=item Multipart parts read into temp files before decoding
In my original implementation, the MIME::Decoder classes had to be aware
of encapsulation boundaries in multipart MIME documents.
While this decode-while-parsing approach obviated the need for
temporary files, it resulted in inflexible and complex decoder
implementations.
The revised implementation uses a temporary file (a la C<tmpfile()>)
during parsing to hold the I<encoded> portion of the current MIME
document or part. This file is deleted automatically after the
current part is decoded and the data is written to the "body stream"
object; you'll never see it, and should never need to worry about it.
Some folks have asked for the ability to bypass this temp-file
mechanism, I suppose because they assume it would slow down their application.
I considered accomodating this wish, but the temp-file
approach solves a lot of thorny problems in parsing, and it also
protects against hidden bugs in user applications (what if you've
directed the encoded part into a scalar, and someone unexpectedly
sends you a 6 MB tar file?). Finally, I'm just not conviced that
the temp-file use adds significant overhead.
=item Fuzzing of CRLF and newline on input
RFC 2045 dictates that MIME streams have lines terminated by CRLF
(C<"\r\n">). However, it is extremely likely that folks will want to
parse MIME streams where each line ends in the local newline
character C<"\n"> instead.
An attempt has been made to allow the parser to handle both CRLF
and newline-terminated input.
=item Fuzzing of CRLF and newline on output
The C<"7bit"> and C<"8bit"> decoders will decode both
a C<"\n"> and a C<"\r\n"> end-of-line sequence into a C<"\n">.
The C<"binary"> decoder (default if no encoding specified)
still outputs stuff verbatim... so a MIME message with CRLFs
and no explicit encoding will be output as a text file
that, on many systems, will have an annoying ^M at the end of
each line... I<but this is as it should be>.
=item Inability to handle multipart boundaries that contain newlines
First, let's get something straight: I<this is an evil, EVIL practice,>
and is incompatible with RFC 2046... hence, it's not valid MIME.
If your mailer creates multipart boundary strings that contain
newlines I<when they appear in the message body,> give it two weeks notice
and find another one. If your mail robot receives MIME mail like this,
regard it as syntactically incorrect MIME, which it is.
Why do I say that? Well, in RFC 2046, the syntax of a boundary is
given quite clearly:
boundary := 0*69<bchars> bcharsnospace
bchars := bcharsnospace / " "
bcharsnospace := DIGIT / ALPHA / "'" / "(" / ")" / "+" /"_"
/ "," / "-" / "." / "/" / ":" / "=" / "?"
All of which means that a valid boundary string I<cannot> have
newlines in it, and any newlines in such a string in the message header
are expected to be solely the result of I<folding> the string (i.e.,
inserting to-be-removed newlines for readability and line-shortening
I<only>).
Yet, there is at least one brain-damaged user agent out there
that composes mail like this:
MIME-Version: 1.0
Content-type: multipart/mixed; boundary="----ABC-
123----"
Subject: Hi... I'm a dork!
This is a multipart MIME message (yeah, right...)
----ABC-
123----
Hi there!
We have I<got> to discourage practices like this (and the recent file
upload idiocy where binary files that are part of a multipart MIME
message aren't base64-encoded) if we want MIME to stay relatively
simple, and MIME parsers to be relatively robust.
I<Thanks to Andreas Koenig for bringing a baaaaaaaaad user agent to
my attention.>
=back
=head1 SEE ALSO
L<MIME::Tools>, L<MIME::Head>, L<MIME::Body>, L<MIME::Entity>, L<MIME::Decoder>
=head1 AUTHOR
Eryq (F<eryq@zeegee.com>), ZeeGee Software Inc (F<http://www.zeegee.com>).
David F. Skoll (dfs@roaringpenguin.com) http://www.roaringpenguin.com
All rights reserved. This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
=cut
|