MokoConsulting/MokoSuiteOpenGraph
1
0
Fork 0
Code Issues 3 Pull Requests Releases 4 Wiki Activity

No TTF font file bundled or documented for image text overlay #50

New Issue
Closed
opened 2026-06-21 14:54:46 +00:00 by jmiller · 2 comments
jmiller commented 2026-06-21 14:54:46 +00:00
Owner
Copy Link
Copy Source

Problem

ImageGenerator.php requires a TTF font file for text overlay on generated OG images, but:

  • No font file is included in the package
  • No documentation describes where to place a font or how to configure the path
  • No fallback behavior when the font is missing

Fix

Either:

  1. Bundle a permissively-licensed font (e.g., Open Sans, Noto Sans — both Apache 2.0 / OFL compatible with GPL-3.0)
  2. Or document the required configuration and add a validation check with admin warning when font is missing

File

  • source/packages/plg_system_mokoog/src/Helper/ImageGenerator.php
## Problem `ImageGenerator.php` requires a TTF font file for text overlay on generated OG images, but: - No font file is included in the package - No documentation describes where to place a font or how to configure the path - No fallback behavior when the font is missing ## Fix Either: 1. Bundle a permissively-licensed font (e.g., Open Sans, Noto Sans — both Apache 2.0 / OFL compatible with GPL-3.0) 2. Or document the required configuration and add a validation check with admin warning when font is missing ## File - `source/packages/plg_system_mokoog/src/Helper/ImageGenerator.php`
jmiller added the documentationproduction-readiness labels 2026-06-21 14:54:46 +00:00
jmiller commented 2026-06-21 14:54:51 +00:00
Author
Owner
Copy Link
Copy Source

Branch created: feature/50-no-ttf-font-file-bundled-or-documented-f

git fetch origin
git checkout feature/50-no-ttf-font-file-bundled-or-documented-f
Branch created: [`feature/50-no-ttf-font-file-bundled-or-documented-f`](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteOpenGraph/src/branch/feature/50-no-ttf-font-file-bundled-or-documented-f) ```bash git fetch origin git checkout feature/50-no-ttf-font-file-bundled-or-documented-f ```
jmiller commented 2026-06-21 16:11:59 +00:00
Author
Owner
Copy Link
Copy Source

Closing — ImageGenerator::generate() is never called anywhere in the codebase. The class exists but isn't wired into any workflow, so no TTF font is actually needed at runtime. The font path is a parameter to generate(), so when/if a caller is added, the caller will need to provide the font. The generator already logs a clear warning if the font is missing (#49).

Closing — `ImageGenerator::generate()` is never called anywhere in the codebase. The class exists but isn't wired into any workflow, so no TTF font is actually needed at runtime. The font path is a parameter to `generate()`, so when/if a caller is added, the caller will need to provide the font. The generator already logs a clear warning if the font is missing (#49).
Sign in to join this conversation.
Labels
Clear labels
bug
Something is broken
 documentation
Documentation improvements
 enhancement
production-readiness
Required before v1.0 release
 security
Security vulnerability or hardening
 testing
Test coverage and QA
No labels documentation production-readiness
Priority Medium
Type Feature
Milestone
No items
No Milestone
Assignees
Clear assignees
jmiller (Jonathan Miller)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: MokoConsulting/MokoSuiteOpenGraph#50
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?