Dedicated FontException, cleaner font-related font exception messages (Closes mpdf#1209)

Author: finwe

CHANGELOG.md

@@ -1,6 +1,9 @@
 mPDF 8.1.x
 ===========================
+
 * Add Page Number Myanmar Language Support
+* new `Mpdf\Exception\FontException` extending base `MpdfException` was introduced and is thrown on Font manipulation
+* A bit cleaner exception messages for font-related errors
 
 mPDF 8.0.x
 ===========================

src/Exception/FontException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Mpdf\Exception;
+
+class FontException extends \Mpdf\MpdfException
+{
+
+}

src/OtlDump.php

@@ -178,7 +178,7 @@ function getMetrics($file, $fontkey, $TTCfontID = 0, $debug = false, $BMPonly =
 $this->fh = fopen($file, 'rb');
 
 if (!$this->fh) {
-throw new \Mpdf\MpdfException(sprintf('Unable to open file "%s"', $file));
+throw new \Mpdf\Exception\FontException(sprintf('Unable to open file "%s"', $file));
 }
 
 $this->_pos = 0;
@@ -196,21 +196,21 @@ function getMetrics($file, $fontkey, $TTCfontID = 0, $debug = false, $BMPonly =
 $this->panose = [];
 
 if ($version == 0x4F54544F) {
-throw new \Mpdf\MpdfException("Postscript outlines are not supported");
+throw new \Mpdf\Exception\FontException("Postscript outlines are not supported");
 }
 
 if ($version == 0x74746366 && !$TTCfontID) {
-throw new \Mpdf\MpdfException("TTCfontID for a TrueType Collection has to be defined in ttfontdata configuration key (" . $file . ")");
+throw new \Mpdf\Exception\FontException("TTCfontID for a TrueType Collection has to be defined in ttfontdata configuration key (" . $file . ")");
 }
 
 if (!in_array($version, [0x00010000, 0x74727565]) && !$TTCfontID) {
-throw new \Mpdf\MpdfException("Not a TrueType font: version=" . $version);
+throw new \Mpdf\Exception\FontException("Not a TrueType font: version=" . $version);
 }
 
 if ($TTCfontID > 0) {
 $this->version = $version = $this->read_ulong(); // TTC Header version now
 if (!in_array($version, [0x00010000, 0x00020000])) {
-throw new \Mpdf\MpdfException("Error parsing TrueType Collection: version=" . $version . " - " . $file);
+throw new \Mpdf\Exception\FontException("Error parsing TrueType Collection: version=" . $version . " - " . $file);
 }
 $this->numTTCFonts = $this->read_ulong();
 for ($i = 1; $i <= $this->numTTCFonts; $i++) {
@@ -259,7 +259,7 @@ function checksumTables()
 }
 $xchecksum = $t['checksum'];
 if ($xchecksum != $checksum) {
-throw new \Mpdf\MpdfException(sprintf('TTF file "%s": invalid checksum %s table: %s (expected %s)', $this->filename, dechex($checksum[0]) . dechex($checksum[1]), $t['tag'], dechex($xchecksum[0]) . dechex($xchecksum[1])));
+throw new \Mpdf\Exception\FontException(sprintf('TTF file "%s": invalid checksum %s table: %s (expected %s)', $this->filename, dechex($checksum[0]) . dechex($checksum[1]), $t['tag'], dechex($xchecksum[0]) . dechex($xchecksum[1])));
 }
 }
 }
@@ -473,7 +473,7 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 $name_offset = $this->seek_table("name");
 $format = $this->read_ushort();
 if ($format != 0 && $format != 1) {
-throw new \Mpdf\MpdfException("Unknown name table format " . $format);
+throw new \Mpdf\Exception\FontException("Error loading font: Unknown name table format " . $format);
 }
 $numRecords = $this->read_ushort();
 $string_data_offset = $name_offset + $this->read_ushort();
@@ -495,7 +495,7 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 $opos = $this->_pos;
 $this->seek($string_data_offset + $offset);
 if ($length % 2 != 0) {
-throw new \Mpdf\MpdfException("PostScript name is UTF-16BE string of odd length");
+throw new \Mpdf\Exception\FontException("Error loading font: PostScript name is UTF-16BE string of odd length");
 }
 $length /= 2;
 $N = '';
@@ -536,14 +536,14 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 }
 }
 if (!$psName) {
-throw new \Mpdf\MpdfException("Could not find PostScript font name: " . $this->filename);
+throw new \Mpdf\Exception\FontException("Error loading font: Could not find PostScript font name: " . $this->filename);
 }
 if ($debug) {
 for ($i = 0; $i < count($psName); $i++) {
 $c = $psName[$i];
 $oc = ord($c);
 if ($oc > 126 || strpos(' [](){}<>/%', $c) !== false) {
-throw new \Mpdf\MpdfException("psName=" . $psName . " contains invalid character " . $c . " ie U+" . ord(c));
+throw new \Mpdf\Exception\FontException("psName=" . $psName . " contains invalid character " . $c . " ie U+" . ord(c));
 }
 }
 }
@@ -581,14 +581,14 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 $ver_maj = $this->read_ushort();
 $ver_min = $this->read_ushort();
 if ($ver_maj != 1) {
-throw new \Mpdf\MpdfException('Unknown head table version ' . $ver_maj . '.' . $ver_min);
+throw new \Mpdf\Exception\FontException('Error loading font: Unknown head table version ' . $ver_maj . '.' . $ver_min);
 }
 $this->fontRevision = $this->read_ushort() . $this->read_ushort();
 
 $this->skip(4);
 $magic = $this->read_ulong();
 if ($magic != 0x5F0F3CF5) {
-throw new \Mpdf\MpdfException('Invalid head table magic ' . $magic);
+throw new \Mpdf\Exception\FontException('Error loading font: Invalid head table magic ' . $magic);
 }
 $this->skip(2);
 } else {
@@ -606,7 +606,7 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 $indexToLocFormat = $this->read_ushort();
 $glyphDataFormat = $this->read_ushort();
 if ($glyphDataFormat != 0) {
-throw new \Mpdf\MpdfException('Unknown glyph data format ' . $glyphDataFormat);
+throw new \Mpdf\Exception\FontException('Error loading font: Unknown glyph data format ' . $glyphDataFormat);
 }
 
 ///////////////////////////////////
@@ -635,7 +635,7 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 if ($fsType == 0x0002 || ($fsType & 0x0300) != 0) {
 global $overrideTTFFontRestriction;
 if (!$overrideTTFFontRestriction) {
-throw new \Mpdf\MpdfException('ERROR - Font file ' . $this->filename . ' cannot be embedded due to copyright restrictions.');
+throw new \Mpdf\Exception\FontException('Font file ' . $this->filename . ' cannot be embedded due to copyright restrictions.');
 }
 $this->restrictedUse = true;
 }
@@ -685,7 +685,7 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 $ver_maj = $this->read_ushort();
 $ver_min = $this->read_ushort();
 if ($ver_maj < 1 || $ver_maj > 4) {
-throw new \Mpdf\MpdfException('Unknown post table version ' . $ver_maj);
+throw new \Mpdf\Exception\FontException('Error loading font: Unknown post table version ' . $ver_maj);
 }
 } else {
 $this->skip(4);
@@ -715,19 +715,19 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 $ver_maj = $this->read_ushort();
 $ver_min = $this->read_ushort();
 if ($ver_maj != 1) {
-throw new \Mpdf\MpdfException('Unknown hhea table version ' . $ver_maj);
+throw new \Mpdf\Exception\FontException(sprintf('Error loading font: Unknown hhea table version %s', $ver_maj));
 }
 $this->skip(28);
 } else {
 $this->skip(32);
 }
 $metricDataFormat = $this->read_ushort();
 if ($metricDataFormat != 0) {
-throw new \Mpdf\MpdfException('Unknown horizontal metric data format ' . $metricDataFormat);
+throw new \Mpdf\Exception\FontException('Error loading font: Unknown horizontal metric data format ' . $metricDataFormat);
 }
 $numberOfHMetrics = $this->read_ushort();
 if ($numberOfHMetrics == 0) {
-throw new \Mpdf\MpdfException('Number of horizontal metrics is 0');
+throw new \Mpdf\Exception\FontException('Error loading font: Number of horizontal metrics is 0');
 }
 
 ///////////////////////////////////
@@ -738,7 +738,7 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 $ver_maj = $this->read_ushort();
 $ver_min = $this->read_ushort();
 if ($ver_maj != 1) {
-throw new \Mpdf\MpdfException('Unknown maxp table version ' . $ver_maj);
+throw new \Mpdf\Exception\FontException('Error loading font: Unknown maxp table version ' . $ver_maj);
 }
 } else {
 $this->skip(4);
@@ -781,7 +781,7 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 }
 
 if (!$unicode_cmap_offset) {
-throw new \Mpdf\MpdfException('Font (' . $this->filename . ') does not have cmap for Unicode (platform 3, encoding 1, format 4, or platform 0, any encoding, format 4)');
+throw new \Mpdf\Exception\FontException('Font (' . $this->filename . ') does not have cmap for Unicode (platform 3, encoding 1, format 4, or platform 0, any encoding, format 4)');
 }
 
 $sipset = false;
@@ -858,7 +858,7 @@ function extractInfo($debug = false, $BMPonly = false, $kerninfo = false, $useOT
 $bctr++;
 }
 } else {
-throw new \Mpdf\MpdfException($names[1] . " : WARNING - The font does not have enough space to map all (unmapped) included glyphs into Private Use Area U+E000 - U+F8FF");
+throw new \Mpdf\Exception\FontException(sprintf('Font "%s" does not have cmap for Unicode (platform 3, encoding 1, format 4, or platform 0, any encoding, format 4)', $this->filename));
 }
 }
 $glyphToChar[$gid][] = $bctr;
@@ -1568,7 +1568,7 @@ function _getGSUBtables()
 }
 }
 } else {
-throw new \Mpdf\MpdfException("GPOS Lookup Type " . $Lookup[$i]['Type'] . ", Format " . $SubstFormat . " not supported (ttfontsuni.php).");
+throw new \Mpdf\Exception\FontException("GPOS Lookup Type " . $Lookup[$i]['Type'] . ", Format " . $SubstFormat . " not supported (ttfontsuni.php).");
 }
 }
 } // LookupType 6: Chaining Contextual Substitution Subtable
@@ -1625,7 +1625,7 @@ function _getGSUBtables()
 }
 }
 } else {
-throw new \Mpdf\MpdfException("Lookup Type " . $Lookup[$i]['Type'] . " not supported.");
+throw new \Mpdf\Exception\FontException("Lookup Type " . $Lookup[$i]['Type'] . " not supported.");
 }
 }
 }
@@ -1807,7 +1807,7 @@ function _getGSUBtables()
 $glyphs = $this->_getCoverage();
 $Lookup[$i]['Subtable'][$c]['CoverageInputGlyphs'][] = implode("|", $glyphs);
 }
-throw new \Mpdf\MpdfException("Lookup Type 5, SubstFormat 3 not tested. Please report this with the name of font used - " . $this->fontkey);
+throw new \Mpdf\Exception\FontException("Lookup Type 5, SubstFormat 3 not tested. Please report this with the name of font used - " . $this->fontkey);
 }
 }
 }
@@ -2728,7 +2728,7 @@ function _getGSUBignoreString($flag, $MarkFilteringSet)
 
 // Flag & 0x0010 = UseMarkFilteringSet
 if ($flag & 0x0010) {
-throw new \Mpdf\MpdfException("This font " . $this->fontkey . " contains MarkGlyphSets");
+throw new \Mpdf\Exception\FontException("This font " . $this->fontkey . " contains MarkGlyphSets");
 $str = "Mark Glyph Set: ";
 $str .= $this->MarkGlyphSets[$MarkFilteringSet];
 }
@@ -3757,21 +3757,21 @@ function _getGPOSarray(&$Lookup, $lul, $scripttag, $level = 1, $lcoverage = '',
 // Format 1:
 //===========
 if ($PosFormat == 1) {
-throw new \Mpdf\MpdfException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not YET TESTED.");
+throw new \Mpdf\Exception\FontException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not YET TESTED.");
 } //===========
 // Format 2:
 //===========
 else {
 if ($PosFormat == 2) {
-throw new \Mpdf\MpdfException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not YET TESTED.");
+throw new \Mpdf\Exception\FontException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not YET TESTED.");
 } //===========
 // Format 3:
 //===========
 else {
 if ($PosFormat == 3) {
-throw new \Mpdf\MpdfException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not YET TESTED.");
+throw new \Mpdf\Exception\FontException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not YET TESTED.");
 } else {
-throw new \Mpdf\MpdfException("GPOS Lookup Type " . $Type . ", Format " . $PosFormat . " not supported.");
+throw new \Mpdf\Exception\FontException("GPOS Lookup Type " . $Type . ", Format " . $PosFormat . " not supported.");
 }
 }
 }
@@ -3785,7 +3785,7 @@ function _getGPOSarray(&$Lookup, $lul, $scripttag, $level = 1, $lcoverage = '',
 // Format 1:
 //===========
 if ($PosFormat == 1) {
-throw new \Mpdf\MpdfException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not TESTED YET.");
+throw new \Mpdf\Exception\FontException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not TESTED YET.");
 } //===========
 // Format 2:
 //===========
@@ -3794,7 +3794,7 @@ function _getGPOSarray(&$Lookup, $lul, $scripttag, $level = 1, $lcoverage = '',
 $html .= '<div>GPOS Lookup Type 8: Format 2 not yet supported in OTL dump</div>';
 continue;
 /* NB When developing - cf. GSUB 6.2 */
-throw new \Mpdf\MpdfException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not TESTED YET.");
+throw new \Mpdf\Exception\FontException("GPOS Lookup Type " . $Type . " Format " . $PosFormat . " not TESTED YET.");
 } //===========
 // Format 3:
 //===========
@@ -4179,7 +4179,7 @@ function getLOCA($indexToLocFormat, $numGlyphs)
 $this->glyphPos[] = ($arr[$n + 1]);
 }
 } else {
-throw new \Mpdf\MpdfException('Unknown location table format ' . $indexToLocFormat);
+throw new \Mpdf\Exception\FontException('Unknown location table format ' . $indexToLocFormat);
 }
 }
 }