Skip to content
Snippets Groups Projects
New look: Off

Enable bundled fonts in Tor Browser

    • Closed (moved) Issue created by David Fifield @dcf

    Add the ability to include fonts with the browser and use them instead of system fonts.

    This Firefox ticket is somewhat related: dynamically load fonts packaged with Firefox https://bugzilla.mozilla.org/show_bug.cgi?id=998844

    To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information

    Child items ...

    • Activity

    • David Fifield added TorBrowserTeam201507R component::applications/tor browser owner::tbb-team parent::18097 priority::medium resolution::fixed status::closed tbb-5.0a4 tbb-fingerprinting-fonts type::enhancement labels

      added TorBrowserTeam201507R component::applications/tor browser owner::tbb-team parent::18097 priority::medium resolution::fixed status::closed tbb-5.0a4 tbb-fingerprinting-fonts type::enhancement labels

    • D
      David Fifield @dcf ·
      Author

      I started a branch to work on this: https://gitweb.torproject.org/user/dcf/tor-browser-bundle.git/log/?h=fonts This comment is being made when HEAD is tbb-4.0-alpha-3-fonts-1. Here is the overall diff so far.

      At this point the branch only handles the linux bundles. linux is easier because we can control font behavior with a fonts.conf file without patching the browser source code. I added two fonts to the bundle, Droid and Lohit. Droid covers all the languages of TBB, and Lohit additionally covers various Indic scripts.

      This is the main important change.

      +export FONTCONFIG_PATH="${HOME}/TorBrowser/Data/fontconfig"
+export FONTCONFIG_FILE="fonts.conf"

      It overrides global Fontconfig settings by an included configuration file that loads only those fonts included with the browser.

      I uploaded bundles built from the branch. https://people.torproject.org/~dcf/pt-bundle/4.0-alpha-3-fonts-1/ mac and windows are there, but they only include the font files, and don't actually use them. Here are the sizes of the bundles with included fonts:

      40970478 TorBrowser-4.0-alpha-3-fonts-1-osx32_en-US.dmg
33539120 torbrowser-install-4.0-alpha-3-fonts-1_en-US.exe
34123852 tor-browser-linux32-4.0-alpha-3-fonts-1_en-US.tar.xz
35833512 tor-browser-linux64-4.0-alpha-3-fonts-1_en-US.tar.xz

      Compare that to the size of 4.0-alpha-3 without included fonts:

      34742225 TorBrowser-4.0-alpha-3-osx32_en-US.dmg
29868034 torbrowser-install-4.0-alpha-3_en-US.exe
30430008 tor-browser-linux32-4.0-alpha-3_en-US.tar.xz
32140468 tor-browser-linux64-4.0-alpha-3_en-US.tar.xz

      Here is the diff of bundle contents:

      +80K    ./Browser/fonts/DroidKufi-Bold.ttf
+80K    ./Browser/fonts/DroidKufi-Regular.ttf
+91K    ./Browser/fonts/DroidNaskh-Bold.ttf
+88K    ./Browser/fonts/DroidNaskh-Regular.ttf
+109K   ./Browser/fonts/DroidNaskhUI-Regular.ttf
+36K    ./Browser/fonts/DroidSansArabic.ttf
+14K    ./Browser/fonts/DroidSansArmenian.ttf
+190K   ./Browser/fonts/DroidSans-Bold.ttf
+218K   ./Browser/fonts/DroidSansEthiopic-Bold.ttf
+223K   ./Browser/fonts/DroidSansEthiopic-Regular.ttf
+4.4M   ./Browser/fonts/DroidSansFallbackFull.ttf
+3.8M   ./Browser/fonts/DroidSansFallback.ttf
+21K    ./Browser/fonts/DroidSansGeorgian.ttf
+30K    ./Browser/fonts/DroidSansHebrew-Bold.ttf
+30K    ./Browser/fonts/DroidSansHebrew-Regular.ttf
+1.2M   ./Browser/fonts/DroidSansJapanese.ttf
+117K   ./Browser/fonts/DroidSansMono.ttf
+187K   ./Browser/fonts/DroidSans.ttf
+259K   ./Browser/fonts/DroidSerif-BoldItalic.ttf
+245K   ./Browser/fonts/DroidSerif-Bold.ttf
+247K   ./Browser/fonts/DroidSerif-Italic.ttf
+244K   ./Browser/fonts/DroidSerif-Regular.ttf
+137K   ./Browser/fonts/Lohit-Assamese.ttf
+137K   ./Browser/fonts/Lohit-Bengali.ttf
+71K    ./Browser/fonts/Lohit-Devanagari.ttf
+61K    ./Browser/fonts/Lohit-Gujarati.ttf
+194K   ./Browser/fonts/Lohit-Kannada.ttf
+49K    ./Browser/fonts/Lohit-Malayalam.ttf
+70K    ./Browser/fonts/Lohit-Marathi.ttf
+96K    ./Browser/fonts/Lohit-Oriya.ttf
+24K    ./Browser/fonts/Lohit-Punjabi.ttf
+65K    ./Browser/fonts/Lohit-Tamil-Classical.ttf
+61K    ./Browser/fonts/Lohit-Tamil.ttf
+167K   ./Browser/fonts/Lohit-Telugu.ttf
-125K   ./Browser/precomplete
+127K   ./Browser/precomplete
+639    ./Browser/TorBrowser/Data/fontconfig/conf.d/65-0-lohit-marathi.conf
+636    ./Browser/TorBrowser/Data/fontconfig/conf.d/65-0-lohit-nepali.conf
+492    ./Browser/TorBrowser/Data/fontconfig/conf.d/65-droid.conf
+1.7K   ./Browser/TorBrowser/Data/fontconfig/conf.d/65-lohit.conf
+626    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-assamese.conf
+639    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-bengali.conf
+3.1K   ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-devanagari.conf
+643    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-gujarati.conf
+620    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-kannada.conf
+634    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-oriya.conf
+621    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-punjabi.conf
+663    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-tamil-classical.conf
+633    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-tamil.conf
+633    ./Browser/TorBrowser/Data/fontconfig/conf.d/66-lohit-telugu.conf
+643    ./Browser/TorBrowser/Data/fontconfig/conf.d/67-lohit-malayalam.conf
+6.3K   ./Browser/TorBrowser/Data/fontconfig/fonts.conf
+572    ./Browser/TorBrowser/Docs/Licenses/Droid-Fonts.txt
+4.3K   ./Browser/TorBrowser/Docs/Licenses/Lohit-Fonts.txt
-5.8K   ./Browser/TorBrowser/Docs/sources/versions
+6.1K   ./Browser/TorBrowser/Docs/sources/versions
    • intrigeri
      intrigeri @intrigeri ·

      Trac:
      Cc: N/A to anonym, intrigeri

    • D
      David Fifield @dcf ·
      Author

      Trac:
      4.5-alpha-2-fonts-1.patch

    • D
      David Fifield @dcf ·
      Author

      tor-browser patch against tor-browser-31.3.0esr-4.5-1-build1.

    • D
      David Fifield @dcf ·
      Author

      Trac:
      droid-sans-georgian-4.5-alpha-2-fonts-1

    • D
      David Fifield @dcf ·
      Author

      Screenshot of 4.5-alpha-2-fonts-1 showing www.wikipedia.org and a copy-paste of the Fonts panel.

    • D
      David Fifield @dcf ·
      Author

      Trac:
      fontlist.log

    • D
      David Fifield @dcf ·
      Author

      NSPR_LOG_MODULES=fontlist:5 for 4.5-alpha-2-fonts-1.

    • D
      David Fifield @dcf ·
      Author

      I started looking at Firefox changes to disable system fonts and use only bundled fonts. comment:1 shows that it's easy to do on linux with fonts.conf. It remains to do it on other platforms.

      I started by trying to disable system fonts for DirectWrite. DirectWrite is one of two font rendering APIs used on Windows (the other is GDI). It doesn't quite work yet. The system fonts are not loaded, and bundled fonts are loaded. But all text is rendered as squares, even in browser chrome—except, curiously, Georgian text. It seems that for whatever reason the only font displayed by default is Droid Sans Georgian, even though you can select others from the Content menu. More on that below.

      This is the code I tried, my fonts branch of tor-browser-bundle.git, and a patch against tor-browser.git. The tor-browser.git patch is Mozilla #998844 (for --enable-bundled-fonts), plus a dummy loader for system fonts in the DirectWrite renderer.

      I had to set gfx.font_rendering.directwrite.enabled=true and restart in order to enable DirectWrite. (Running in KVM, about:support says "Direct2D Enabled: Blocked for your graphics card because of unresolved driver issues." and "DirectWrite Enabled: false (6.2.9200.16581)".)

      Here's what it looks like: droid-sans-georgian-4.5-alpha-2-fonts-1.png Almost everything is rendered as boxes, except for the Georgian text. I copy-pasted from the Fonts panel in the Inspector into a text editor, which shows that the "Droid Sans Georgian" font is being used. However, if I go into the Content menu, I can select Droid Sans (by looking for the right pattern of boxes, "▯▯▯▯▯ ▯▯▯▯"), and then the Latin text shows up properly (not on the Wikipedia page, but on other pages).

      If I delete fonts/DroidSansGeorgian.ttf, then the font that gets loaded is instead Lohit Oriya, and is similarly broken. The shape of the boxes in Lohit Oriya have a noticeably different shape. Perhaps the fonts selection governed by ordering in an internal hash table or something.

      I turn on fontlist logging with

      set NSPR_LOG_MODULES=fontlist:5
cd Browser
firefox.exe -console

      and I see this on the console:

      0[1197208]: (fontlist-postscript) name: Droid Sans Georgian Regular, psname: Droid SansGeorgian
0[1197208]: (fontlist-fullname) name: Droid Sans Georgian Regular, fullname: Droid Sans Georgian
0[1197208]: (fontlist) added (Droid Sans Georgian Regular) to family (Droid Sans Georgian) with style: normal weight: 400 stretch: 0 psname: DroidSansGeorgian fullname: Droid Sans Georgian
0[1197208]: (fontlist) added (Droid Sans Georgian Bold) to family (Droid Sans Georgian) with style: normal weight: 700 stretch: 0 psname: DroidSansGeorgian fullname: Droid Sans Georgian
0[1197208]: (fontlist-cmap) name: Droid Sans Georgian Bold, size: 304 hash: 29410df0 new
0[1197208]: (fontlist-cmap) name: Droid Sans Georgian Regular, size: 1880 hash:54f67428 new

      a few seconds later, while it's sitting at the about:tor screen, I see it load the rest of the fonts. The full log is in fontlist.log. (However, note that only Droid Sans Georgian has fontlist-cmap lines.)

    • D
      David Fifield @dcf ·
      Author

      Trac:
      fontinit.log

    • D
      David Fifield @dcf ·
      Author

      NSPR_LOG_MODULES=fontinit:5 for 4.5-alpha-2-fonts-1.

    • D
      David Fifield @dcf ·
      Author

      Trac:
      textrun.log

    • D
      David Fifield @dcf ·
      Author

      NSPR_LOG_MODULES=textrun:5 for 4.5-alpha-2-fonts-1.

    • D
      David Fifield @dcf ·
      Author

      Trac:
      textrunui.log

    • D
      David Fifield @dcf ·
      Author

      NSPR_LOG_MODULES=textrunui:5 for 4.5-alpha-2-fonts-1.

    • D
      David Fifield @dcf ·
      Author

      Trac:
      cmapdata.log

    • D
      David Fifield @dcf ·
      Author

      NSPR_LOG_MODULES=cmapdata:5 for 4.5-alpha-2-fonts-1.

    • D
      David Fifield @dcf ·
      Author

      Here are other Firefox logs from 4.5-alpha-2-fonts-1. I got the names of log modules from https://hg.mozilla.org/mozilla-central/file/636498d041b5/gfx/thebes/gfxPlatform.cpp#l2058.

      0[c07268]: (cmapdata) name: Droid Sans Georgian Bold u+000000 [80040000 80000000 00000000 00000000 00000000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Bold u+001000 [00000000 00000000 00000000 00000000 00000000 ffffffff fc00ffff fffffff8]
0[c07268]: (cmapdata) name: Droid Sans Georgian Bold u+002d00 [ffffffff fc000000 00000000 00000000 00000000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000000 [00000000 ffffffff ffffffff fffffffe 00000000 ffffffff ffffffff ffffffff]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000100 [ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000200 [ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000300 [ffffffff ffffffff ffffffff ffffff3e 0febffff dfffffff ffffffff ffffffff]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000400 [ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000500 [ffffffff ff000000 00000000 00000000 00007fff ffffffff ff00ffff ffe0f800]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000600 [fbfffff3 ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000700 [00000000 00000000 0000ffff ffffffff 00000000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+000800 [00000000 00000000 00000000 00000000 00000000 bff80000 00000000 0ffffffe]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+001d00 [ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffe00000 00000003]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+001e00 [ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+001f00 [fffffcfc ffffffff fcfcff55 fffffffc ffffffff fffffbff fbfff3f7 ffff3bfe]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+002000 [ffff3fff e23fb86e 08000002 003f8fc1 0000f800 ffffffe4 00000000 00008000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+002100 [04001300 22020000 0006181e 00000000 0800fc00 00800000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+002200 [22016463 00500000 00800000 cc000000 00000000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+002300 [20008000 c0000000 00000000 00000000 00000000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+002500 [a0088888 08080808 0000ffff fff80000 8888f000 c0382028 083900c0 02000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+002600 [00000000 00000038 a0000000 96310000 00000000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+002c00 [00000000 00000000 00000000 ffffffff 00000000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+002e00 [00000100 00000000 00000000 00000000 00000000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+00a700 [000001ff c0000000 00000000 00000000 00f80000 00000000 00000000 00000000]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+00fb00 [60000007 fffffefa dbffffff ffffffff ffffffff ffffffff c0001fff ffffffff]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+00fc00 [00000000 00000000 00000003 f0000000 00000000 00000000 00000000 00003800]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+00fd00 [00000000 0000000f 00000000 00000000 00000000 00000000 00000000 0000283c]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+00fe00 [00000000 f0000000 00000000 0000fbff ffffffff ffffffff ffffffff fffffff8]
0[c07268]: (cmapdata) name: Droid Sans Georgian Regular u+00ff00 [00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000008]

      If I guess at the meaning right, it looks like "Droid Sans Georgian Regular" is claiming support for lots of code points, including most of ASCII. Maybe it doesn't actually support those, but Firefox believes it does, so it doesn't try loading any other fonts.

    • D
      David Fifield @dcf ·
      Author

      If I set the prefs, font.name.sans-serif.x-unicode="Droid Sans" font.name.sans-serif.x-western="Droid Sans" font.name.serif.x-unicode="Droid Serif" font.name.serif.x-western="Droid Serif" then it begins to work right, for Latin text. Presumably we could set the mappings for all our fonts in all.js. The font used for browser chrome is still messed up.

    • Loading
    • Loading
    • Loading
    • Loading
    • Loading
    • Loading
    • Loading
    • Loading
    • Loading
    • Loading
    Please register or sign in to reply