merge-font-noto.sh 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. #!/usr/bin/env bash
  2. # @copyright Copyright (c) 2021, Daniel Calviño Sánchez (danxuliu@gmail.com)
  3. #
  4. # @license GNU AGPL version 3 or any later version
  5. #
  6. # This program is free software: you can redistribute it and/or modify
  7. # it under the terms of the GNU Affero General Public License as
  8. # published by the Free Software Foundation, either version 3 of the
  9. # License, or (at your option) any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. # GNU Affero General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU Affero General Public License
  17. # along with this program. If not, see <http://www.gnu.org/licenses/>.
  18. # Helper script to merge several Noto fonts in a single TTF file.
  19. #
  20. # The "Noto Sans" font (https://www.google.com/get/noto) only includes a subset
  21. # of all the available glyphs in the Noto fonts. This scripts uses
  22. # "merge_noto.py" from the Noto Tools package to add other scripts, like Arabic,
  23. # Devanagari or Hebrew.
  24. #
  25. # "merge_noto.py" originally merges the fonts by region. However it was adjusted
  26. # to merge "all" the fonts in a single file, like done by "merge_fonts.py". The
  27. # reason to use "merge_noto.py" instead of "merge_fonts.py" is that
  28. # "merge_noto.py" merges regular and bold fonts, which are both needed in
  29. # Nextcloud. "merge_fonts.py" only merges regular fonts, and adjusting it to
  30. # handle bold fonts too would have been more work than adjusting
  31. # "merge_noto.py".
  32. #
  33. # Please note that, due to technical limitations of the TTF format (a single
  34. # file can not have more than 65535 glyphs) the merged file does not include any
  35. # Chinese, Japanese or Korean glyph (the Noto CJK files already use all the
  36. # slots). In fact, it seems that it can not include either all the glyphs from
  37. # all the non CJK Noto fonts, so it merges only those predefined in the
  38. # "merge_fonts.py" script (as it is a larger set than the original one in
  39. # "merge_noto.py").
  40. #
  41. # Also please note that merging the fonts is a slow process and it can take a
  42. # while (from minutes to hours, depending on the system).
  43. #
  44. # To perform its job, the script requires the "docker" command to be available.
  45. #
  46. # The Docker Command Line Interface (the "docker" command) requires special
  47. # permissions to talk to the Docker daemon, and those permissions are typically
  48. # available only to the root user. Please see the Docker documentation to find
  49. # out how to give access to a regular user to the Docker daemon:
  50. # https://docs.docker.com/engine/installation/linux/linux-postinstall/
  51. #
  52. # Note, however, that being able to communicate with the Docker daemon is the
  53. # same as being able to get root privileges for the system. Therefore, you must
  54. # give access to the Docker daemon (and thus run this script as) ONLY to trusted
  55. # and secure users:
  56. # https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface
  57. # Stops the container started by this script.
  58. function cleanUp() {
  59. # Disable (yes, "+" disables) exiting immediately on errors to ensure that
  60. # all the cleanup commands are executed (well, no errors should occur during
  61. # the cleanup anyway, but just in case).
  62. set +o errexit
  63. echo "Cleaning up"
  64. docker rm --volumes --force $DOCKER_CONTAINER_ID
  65. }
  66. # Exit immediately on errors.
  67. set -o errexit
  68. # Execute cleanUp when the script exits, either normally or due to an error.
  69. trap cleanUp EXIT
  70. # Ensure working directory is script directory, as some actions (like copying
  71. # the patches to the container) expect that.
  72. cd "$(dirname $0)"
  73. # python:3.9 can not be used, as one of the requeriments of Noto Tools
  74. # (pyclipper) fails to build.
  75. #
  76. # The container exits immediately if no command is given, so a Bash session
  77. # is created to prevent that.
  78. DOCKER_CONTAINER_ID=`docker run --rm --detach --interactive --tty python:3.8-slim bash`
  79. # Install required dependencies.
  80. docker exec $DOCKER_CONTAINER_ID apt-get update
  81. docker exec $DOCKER_CONTAINER_ID apt-get install -y git gcc g++ libjpeg-dev zlib1g-dev wget
  82. # Install Noto Tools in the container.
  83. docker exec --workdir /tmp $DOCKER_CONTAINER_ID git clone https://github.com/googlefonts/nototools
  84. docker exec --workdir /tmp/nototools $DOCKER_CONTAINER_ID git checkout 76b29f8f8f9b
  85. docker exec --workdir /tmp/nototools $DOCKER_CONTAINER_ID pip install --requirement requirements.txt
  86. docker exec --workdir /tmp/nototools $DOCKER_CONTAINER_ID pip install --editable .
  87. # As Noto Tools were installed as "editable" the scripts can be patched after
  88. # installation.
  89. docker cp merge-font-noto-fix-merging-v20201206-phase3-76b29f8f8f9b.patch $DOCKER_CONTAINER_ID:/tmp/nototools/merge-font-noto-fix-merging-v20201206-phase3-76b29f8f8f9b.patch
  90. docker exec --workdir /tmp/nototools --interactive $DOCKER_CONTAINER_ID patch --strip 1 < merge-font-noto-fix-merging-v20201206-phase3-76b29f8f8f9b.patch
  91. # Get Noto fonts.
  92. #
  93. # Phase 2 Noto fonts use 2048 units per em, while phase 3 Noto fonts use 1000*.
  94. # Currently the fonts in the released package** (apparently from 2017-10-25) are
  95. # a mix of both, but fonts with different units per em can not be merged***.
  96. # However, the fonts in the Git repository, although not released yet, are all
  97. # using 1000 units per em already, so those are the ones merged.
  98. #
  99. # *https://github.com/googlefonts/noto-fonts/issues/908#issuecomment-298687906.
  100. # **https://noto-website-2.storage.googleapis.com/pkgs/Noto-unhinted.zip
  101. # ***https://fonttools.readthedocs.io/en/latest/merge.html
  102. docker exec --workdir /tmp $DOCKER_CONTAINER_ID wget https://github.com/googlefonts/noto-fonts/archive/v20201206-phase3.tar.gz
  103. docker exec --workdir /tmp $DOCKER_CONTAINER_ID tar -xzf v20201206-phase3.tar.gz
  104. # noto-fonts in Git and snapshots of Git (like the package used) have a
  105. # subdirectory for each font, but "merge_noto.py" expects to find all the fonts
  106. # in a single directory, so the structure needs to be "flattened".
  107. #
  108. # Hinted fonts* adapt better to being rendered in different sizes. The full
  109. # package in https://www.google.com/get/noto/ includes only unhinted fonts
  110. # (according to its name**, I have not actually verified the fonts themselves),
  111. # while the individual fonts listed below in the page are a mix of hinted and
  112. # unhinted fonts. However, the Git directory has hinted versions of all fonts,
  113. # so those are the ones merged (maybe there is a good reason not to merge hinted
  114. # fonts, but seems to work :-P).
  115. #
  116. # *https://en.wikipedia.org/wiki/Font_hinting
  117. # **https://noto-website-2.storage.googleapis.com/pkgs/Noto-unhinted.zip
  118. docker exec --workdir /tmp $DOCKER_CONTAINER_ID mkdir --parent individual/hinted
  119. docker exec --workdir /tmp $DOCKER_CONTAINER_ID find noto-fonts-20201206-phase3/hinted/ttf -iname "NotoSans*Regular.ttf" -exec mv {} individual/hinted/ \;
  120. docker exec --workdir /tmp $DOCKER_CONTAINER_ID find noto-fonts-20201206-phase3/hinted/ttf -iname "NotoSans*Bold.ttf" -exec mv {} individual/hinted/ \;
  121. # Merge the fonts.
  122. docker exec --workdir /tmp $DOCKER_CONTAINER_ID mkdir --parent combined/hinted
  123. docker exec --workdir /tmp $DOCKER_CONTAINER_ID merge_noto.py
  124. # Copy resulting files.
  125. #
  126. # Noto fonts, as well as the merged files, are licensed under the SIL Open Font
  127. # License: https://scripts.sil.org/OFL
  128. docker cp $DOCKER_CONTAINER_ID:/tmp/combined/hinted/NotoSans-Regular.ttf ../core/fonts/NotoSans-Regular.ttf
  129. docker cp $DOCKER_CONTAINER_ID:/tmp/combined/hinted/NotoSans-Bold.ttf ../core/fonts/NotoSans-Bold.ttf