]> granicus.if.org Git - php/commitdiff
imagettftext() uses the last charactermap it found and not the one you want
authorScott MacVicar <scottmac@php.net>
Mon, 17 Feb 2014 05:53:19 +0000 (21:53 -0800)
committerScott MacVicar <scottmac@php.net>
Mon, 17 Feb 2014 06:49:31 +0000 (22:49 -0800)
Summary:
This caused issues when you picked a font with multiple maps, it wouldn't
pick the unicode version but instead pick the last one it saw. Change so
we cache on a per encoding level. There was even a todo list item in the code.

In an ideal world we can probably iterate through at font write time.

Test Plan:
See said unit test, it's Apache Licensed font included

NEWS
ext/gd/libgd/gd.h
ext/gd/libgd/gdft.c
ext/gd/tests/Rochester-Regular.otf [new file with mode: 0644]
ext/gd/tests/Rochester-Regular.otf.LICENSE.txt [new file with mode: 0644]
ext/gd/tests/imagettftext_charmap_order.phpt [new file with mode: 0644]

diff --git a/NEWS b/NEWS
index b0e4f42e0d45094dc63c2dbe927fbecb4c1e6f37..b3d5864d631dc2879ecb5ace6f40113616a88916 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -2,6 +2,10 @@ PHP                                                                        NEWS
 |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 ?? ??? 2014, PHP 5.6.0 Alpha 3
 
+- gd:
+  . Fixed imagettftext to load the correct character map rather than the last one.
+    (Scott)
+
 - Openssl
   . Fixed segfault when accessing non-existent context for client SNI use
     (Daniel Lowrey)
index 20156b97b58aa2c51755ec35cf9fac9f8eb1f955..b61d972e80d529afd5b5cff39f723986d028b3ba 100644 (file)
@@ -471,7 +471,7 @@ typedef struct {
        double linespacing;     /* fine tune line spacing for '\n' */
        int flags;              /* Logical OR of gdFTEX_ values */
        int charmap;            /* TBB: 2.0.12: may be gdFTEX_Unicode,
-                                  gdFTEX_Shift_JIS, or gdFTEX_Big5;
+                                  gdFTEX_Shift_JIS, gdFTEX_Big5 or gdFTEX_MacRoman;
                                   when not specified, maps are searched
                                   for in the above order. */
        int hdpi;
@@ -487,6 +487,7 @@ typedef struct {
 #define gdFTEX_Unicode 0
 #define gdFTEX_Shift_JIS 1
 #define gdFTEX_Big5 2
+#define gdFTEX_MacRoman 3
 
 /* FreeType 2 text output with fine tuning */
 char *
index ac2bf344ffecf2ce5eb6e873b71c4639eef9fe1c..f4ee6390819314daa255b6e8d2638e2d7167deaf 100644 (file)
@@ -126,6 +126,7 @@ typedef struct
 typedef struct
 {
        char *fontlist;         /* key */
+       int preferred_map;
        FT_Library *library;
 } fontkey_t;
 
@@ -337,8 +338,27 @@ static int fontTest (void *element, void *key)
 {
        font_t *a = (font_t *) element;
        fontkey_t *b = (fontkey_t *) key;
-
-       return (strcmp (a->fontlist, b->fontlist) == 0);
+       
+       if (strcmp (a->fontlist, b->fontlist) == 0) {
+               switch (b->preferred_map) {
+                       case gdFTEX_Unicode:
+                               if (a->have_char_map_unicode) {
+                                       return 1;
+                               }
+                               break;
+                       case gdFTEX_Shift_JIS:
+                               if (a->have_char_map_sjis) {
+                                       return 1;
+                               }
+                               break;
+                       case gdFTEX_Big5:
+                               if (a->have_char_map_sjis) {
+                                       return 1;
+                               }
+                               break;
+               }
+       }
+       return 0;
 }
 
 static void *fontFetch (char **error, void *key)
@@ -454,15 +474,17 @@ static void *fontFetch (char **error, void *key)
         *         just use the map in a->face->charmaps[num_charmaps] and be done with it.
         */
 
-       a->have_char_map_unicode = 0;
-       a->have_char_map_big5 = 0;
-       a->have_char_map_sjis = 0;
-       a->have_char_map_apple_roman = 0;
        for (n = 0; n < a->face->num_charmaps; n++) {
                charmap = a->face->charmaps[n];
                platform = charmap->platform_id;
                encoding = charmap->encoding_id;
 
+               /* Whatever is the last value is what should be set */
+               a->have_char_map_unicode = 0;
+               a->have_char_map_big5 = 0;
+               a->have_char_map_sjis = 0;
+               a->have_char_map_apple_roman = 0;
+
 /* EAM DEBUG - Newer versions of libfree2 make it easier by defining encodings */
 #if (defined(FREETYPE_MAJOR) && ((FREETYPE_MAJOR == 2 && ((FREETYPE_MINOR == 1 && FREETYPE_PATCH >= 3) || FREETYPE_MINOR > 1) || FREETYPE_MAJOR > 2)))
        if (charmap->encoding == FT_ENCODING_MS_SYMBOL
@@ -483,17 +505,29 @@ static void *fontFetch (char **error, void *key)
                {                                               /* Apple Unicode */
                        a->have_char_map_unicode = 1;
                        found = charmap;
+                       if (b->preferred_map == gdFTEX_Unicode) {
+                               break;
+                       }
                } else if (platform == 3 && encoding == 4) {    /* Windows Big5 */
                        a->have_char_map_big5 = 1;
                        found = charmap;
+                       if (b->preferred_map == gdFTEX_Big5) {
+                               break;
+                       }
                } else if (platform == 3 && encoding == 2) {    /* Windows Sjis */
                        a->have_char_map_sjis = 1;
                        found = charmap;
+                       if (b->preferred_map == gdFTEX_Shift_JIS) {
+                               break;
+                       }
                } else if ((platform == 1 && encoding == 0)     /* Apple Roman */
                        || (platform == 2 && encoding == 0))
                {                                               /* ISO ASCII */
                        a->have_char_map_apple_roman = 1;
                        found = charmap;
+                       if (b->preferred_map == gdFTEX_MacRoman) {
+                               break;
+                       }
                }
        }
        if (!found) {
@@ -826,9 +860,18 @@ gdImageStringFTEx (gdImage * im, int *brect, int fg, char *fontlist, double ptsi
        }
        /*****/
 
+       /* 2.0.12: allow explicit specification of the preferred map;
+        * but we still fall back if it is not available.
+        */
+       m = gdFTEX_Unicode;
+       if (strex && (strex->flags & gdFTEX_CHARMAP)) {
+               m = strex->charmap;
+       }
+
        /* get the font (via font cache) */
        fontkey.fontlist = fontlist;
        fontkey.library = &library;
+       fontkey.preferred_map = m;
        font = (font_t *) gdCacheGet (fontCache, &fontkey);
        if (!font) {
                gdCacheDelete(tc_cache);
@@ -870,13 +913,7 @@ gdImageStringFTEx (gdImage * im, int *brect, int fg, char *fontlist, double ptsi
        if (fg < 0) {
                render_mode |= FT_LOAD_MONOCHROME;
        }
-       /* 2.0.12: allow explicit specification of the preferred map;
-        * but we still fall back if it is not available.
-        */
-       m = gdFTEX_Unicode;
-       if (strex && (strex->flags & gdFTEX_CHARMAP)) {
-               m = strex->charmap;
-       }
+
        /* Try all three types of maps, but start with the specified one */
        mfound = 0;
        for (i = 0; i < 3; i++) {
diff --git a/ext/gd/tests/Rochester-Regular.otf b/ext/gd/tests/Rochester-Regular.otf
new file mode 100644 (file)
index 0000000..79f63ce
Binary files /dev/null and b/ext/gd/tests/Rochester-Regular.otf differ
diff --git a/ext/gd/tests/Rochester-Regular.otf.LICENSE.txt b/ext/gd/tests/Rochester-Regular.otf.LICENSE.txt
new file mode 100644 (file)
index 0000000..d645695
--- /dev/null
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/ext/gd/tests/imagettftext_charmap_order.phpt b/ext/gd/tests/imagettftext_charmap_order.phpt
new file mode 100644 (file)
index 0000000..2be20b7
--- /dev/null
@@ -0,0 +1,65 @@
+--TEST--
+Font charmap order is deterministic based on order in the font, use the selected encoding
+--SKIPIF--
+<?php
+       if(!extension_loaded('gd')){ die('skip gd extension not available'); }
+       if(!function_exists('imagettftext')) die('skip imagettftext() not available');
+?>
+--FILE--
+<?php
+// this is an Apache Licensed font, see separate LICENSE file
+$font = __DIR__.'/Rochester-Regular.otf';
+
+// thank you Helgi
+$sample_string = "\xC3\x9E\xC3\xB6";
+
+$im = imagecreatetruecolor(
+  100,
+  80
+);
+
+$white = imagecolorallocate($im, 255, 255, 255);
+$black = imagecolorallocate($im, 0, 0, 0);
+
+imagefilledrectangle(
+  $im,
+  0,
+  0,
+  100,
+  80,
+  $white
+);
+
+imagettftext(
+  $im,
+  45,
+  0,
+  15,
+  60,
+  $black,
+  $font,
+  $sample_string
+);
+
+$w = imagesx($im);
+$h = imagesy($im);
+$black_pixels = 0;
+
+for ($y = 0; $y < $h; $y++) {
+    for ($x = 0; $x < $w; $x++) {
+        $rgb = imagecolorat($im, $x, $y);
+        if ($rgb === 0) {
+          ++$black_pixels;
+        }
+    }
+}
+
+if ($black_pixels >= 10) {
+  printf("SUCCESS %d black pixels\n", $black_pixels);
+} else {
+  printf("FAIL %d black pixels\n", $black_pixels);
+}
+imagedestroy($im);
+?>
+--EXPECTF--
+SUCCESS %d black pixels
\ No newline at end of file