Automatically add font license info for Google fonts #298

mikachan · 2023-04-01T23:01:45Z

This adds a function that automatically handles adding the font license information for each Google font to the theme's readme.txt file.

Part of #195.

Handle remove as well as add functionality

commit 0374c69 Merge: 83de623 072da09 Author: Sarah Norris <sarah@sekai.co.uk> Date: Tue Apr 4 16:15:50 2023 +0100 Merge pull request #297 from WordPress/add/font-family-labels Add labels around Google font family checkbox controls commit 83de623 Merge: 58491a7 b814f29 Author: Sarah Norris <sarah@sekai.co.uk> Date: Tue Apr 4 16:13:48 2023 +0100 Merge pull request #296 from WordPress/try/add-current-wp-version Add current WordPress version to style.css and readme.txt commit 58491a7 Author: github-actions <github-actions@github.com> Date: Mon Apr 3 20:54:08 2023 +0000 Version bump & changelog update commit 3a58a30 Merge: bb36a3a fd779d3 Author: Jeff Ong <jonger4@gmail.com> Date: Mon Apr 3 11:27:38 2023 -0400 Merge pull request #292 from WordPress/try/site-editor-overwrite Add Export (Clone) to site editor commit fd779d3 Author: Jeff Ong <jonger4@gmail.com> Date: Mon Apr 3 11:26:11 2023 -0400 Carry forward previous theme tags. commit 072da09 Author: Sarah Norris <sarah@sekai.co.uk> Date: Sat Apr 1 21:39:54 2023 +0100 Add checkbox labels to font family table header commit 54318c6 Author: Sarah Norris <sarah@sekai.co.uk> Date: Sat Apr 1 21:39:22 2023 +0100 Add checkbox labels to font family variants commit b814f29 Author: Sarah Norris <sarah@sekai.co.uk> Date: Sat Apr 1 20:54:04 2023 +0100 Add current WP version to readme.txt commit f4070b2 Author: Sarah Norris <sarah@sekai.co.uk> Date: Sat Apr 1 20:53:50 2023 +0100 Add current WP version to style.css commit bb36a3a Merge: b5a0a0a 8c4098a Author: Matias Benedetto <matias.benedetto@gmail.com> Date: Fri Mar 31 17:35:57 2023 -0300 Merge pull request #293 from WordPress/update/google-fonts-json-_4537839996 Update Google Fonts JSON data from API commit cd5f862 Author: Matias Benedetto <matias.benedetto@gmail.com> Date: Fri Mar 31 17:22:36 2023 -0300 setting the filename of the exported zip file commit b5a0a0a Merge: e3f9193 260d115 Author: Matias Benedetto <matias.benedetto@gmail.com> Date: Fri Mar 31 13:05:52 2023 -0300 Merge pull request #291 from WordPress/fix/280 Fixing image downloading not working in some cases commit 1b19d29 Author: Jeff Ong <jonger4@gmail.com> Date: Thu Mar 30 12:24:35 2023 -0400 Make linter happy. commit b86a1f1 Author: Jeff Ong <jonger4@gmail.com> Date: Thu Mar 30 12:23:42 2023 -0400 Rename file. commit 6efb440 Author: Jeff Ong <jonger4@gmail.com> Date: Wed Mar 29 17:27:42 2023 -0400 Add validation to form button, improve spacing. commit b5c6a17 Author: Jeff Ong <jonger4@gmail.com> Date: Wed Mar 29 17:11:01 2023 -0400 Async/await, update icon, button. commit 8bc38ef Author: Jeff Ong <jonger4@gmail.com> Date: Wed Mar 29 16:40:00 2023 -0400 Use tt3 as placeholder Co-authored-by: Ben Dwyer <ben@scruffian.com> commit 16f3c5c Author: Matias Benedetto <matias.benedetto@gmail.com> Date: Wed Mar 29 15:50:17 2023 -0300 Implementing WordPress apiFetch replacing the browser's fetch function commit 4870efb Author: Jeff Ong <jonger4@gmail.com> Date: Mon Mar 27 17:47:44 2023 -0400 Lint php. commit ebdf773 Author: Jeff Ong <jonger4@gmail.com> Date: Mon Mar 27 17:47:22 2023 -0400 Site editor rest API export. commit a7b2de4 Author: Jeff Ong <jonger4@gmail.com> Date: Mon Mar 27 13:49:35 2023 -0400 Add panel to sidebar in site editor. commit 8c4098a Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Date: Tue Mar 28 00:15:24 2023 +0000 Updating file commit 260d115 Author: Matias Benedetto <matias.benedetto@gmail.com> Date: Mon Mar 27 15:48:44 2023 -0300 fixing image downloading not working in some cases

This reverts commit 8d05847.

This reverts commit a4397de.

admin/class-manage-fonts.php

matiasbenedetto

Thanks for working on this! Very useful enhancement! 😍

My main concern is this: We already have a client-side library to read the font metadata. Do you think it is worth bundling another entire library for the backend?

I don't have an answer to that question, but maybe this could help to decide:
Would the use of just the client-side library to extract the metadata increase or decrease code complexity?

matiasbenedetto · 2023-04-10T15:21:17Z

When I add a font, 3 deprecation notices are displayed:

Deprecated: file_get_contents(): Passing null to parameter #4 ($offset) of type int is deprecated in create-block-theme/includes/FontLib/Font.php on line 31

Deprecated: Function strftime() is deprecated in /create-block-theme/includes/FontLib/BinaryStream.php on line 285

Deprecated: Function strftime() is deprecated in create-block-theme/includes/FontLib/BinaryStream.php on line 285

matiasbenedetto · 2023-04-10T15:22:33Z

Not all the fonts available on Google Fonts are licensed under SIL license, there are a few licensed under Apache or Ubuntu licenses. If I add for example the font called Arimo, it adds a SIL license notice when Arimo uses Apache licensing. https://fonts.google.com/attribution

Example:

Arimo Font
Licensed under the SIL Open Font License, Version 1.1 (http://scripts.sil.org/OFL)
Source: https://www.google.com/fonts/specimen/Arimo

matiasbenedetto · 2023-04-10T15:23:20Z

Should we add the copyright notice and the author's name to be compliant with the attribution part of the SIL license? I guess that it won't hurt and we can we that info from the file metadata. In this way, we could make this work for local font files too.

Apparently, we need to add the copyright notice too: https://themes.trac.wordpress.org/ticket/136638#comment:2

admin/class-manage-fonts.php

composer.json

admin/class-manage-fonts.php

madhusudhand

update gitignore to exclude includes dir?

mikachan · 2023-04-18T10:17:52Z

My main concern is this: We already have a client-side library to read the font metadata. Do you think it is worth bundling another entire library for the backend?

I'd rather not include a whole additional library that does the same thing, so I'd like to try and use the client-side library here instead. Hopefully it doesn't increase the code complexity too much.

mikachan · 2023-04-18T10:25:10Z

Not all the fonts available on Google Fonts are licensed under SIL license, there are a few licensed under Apache or Ubuntu licenses. If I add for example the font called Arimo, it adds a SIL license notice when Arimo uses Apache licensing.

This was the main reason I added the FontLib library 😅 Hmm, I was testing this using the Aclonica font, and the Apache license was coming through correctly from the metadata. Maybe this information isn't always correct with Google fonts... I'll do some more testing around this. Maybe it'll work better with the other library.

mikachan · 2023-04-19T12:41:57Z

Thank you @matiasbenedetto @madhusudhand for the reviews!

I've updated the PR with the following:

Tried out using the client-side font library to read the font files and removed the PHP font library
It's now passing the font credit info from the font metadata through the Google font form, along with all the other existing font data (name, weight etc)
Included the copyright info
It's now using the source URL from the font metadata
Added an 'ending tag' to the font credit info in the readme.txt, as this makes it a lot easier to remove the credits when the font is removed from the theme

I think this covers the feedback so far. I prefer using a single font library!

matiasbenedetto

Adding some particular fonts, for example Abyssinica SIL, the entire SIL license text is printed in the readme.txt file. Is this expected?

mikachan · 2023-04-27T14:51:45Z

Thanks for testing again!

Is this expected?

Ah, no! I've not seen that before. I'll look into how we can handle that.

mikachan · 2023-04-27T16:03:30Z

I think I've improved this with a bit of a refactor.

I've changed this so it's using the get() function to get the data from the font file, and this seems more reliable than before.
I've limited the license info content to 200 characters, as this seemed reasonable. The full license can always be read at the license URL, which we're also including.

matiasbenedetto · 2023-04-27T16:27:15Z

I've limited the license info content to 200 characters

I haven't read the code yet, but can it be a good idea to limit it to one line instead of counting the characters?

mikachan · 2023-04-27T16:57:00Z

but can it be a good idea to limit it to one line instead of counting the characters?

I considered this too, and couldn't decide which one was best! I've updated it so it will now limit the content to the first line, and still limit it to 200 characters as well in case there's one long single-line string.

matiasbenedetto

I found a little problem: let's say a family has several font faces; if you delete just one font face, but the rest of the family is there, the license is gone from readme.txt . Apart from that this PR seems almost ready to go!

Github video upload is not working for me today so I upload the screencast of featuring the issue here:
https://i.imgur.com/nNjO55W.mp4

mikachan · 2023-05-04T17:30:36Z

Good spot, @matiasbenedetto! I've fixed this by moving the 'remove' functionality to the prepare_font_families_for_database function, so it can be run based on the font family logic rather than the font face. Thanks!

matiasbenedetto

It seems to be working great now. Thanks for this enhancement. Very useful.

As a follow up, I created an issue to extend this functionality to the local font file assets uploaded: #348

LGTM 🚀

mikachan added 3 commits April 1, 2023 22:10

Add font license function for Google fonts

ab21e9e

Install php-font-lib

9e29028

Use php-font-lib to check for license info

6015bc2

mikachan added the enhancement New feature or request label Apr 1, 2023

mikachan self-assigned this Apr 1, 2023

mikachan mentioned this pull request Apr 1, 2023

Consider adding input for theme credits #195

Closed

3 tasks

mikachan added 10 commits April 2, 2023 18:49

Use custom format for OFL

b5eaaa5

Rename function to manage_font_license

121fc68

Handle remove as well as add functionality

Try to fix fallback-fonts-list file

8d05847

Revert "Try to fix fallback-fonts-list file"

92cd07c

This reverts commit 8d05847.

Revert "Squashed merge commit with trunk"

a96c5f8

This reverts commit a4397de.

Replace php-font-lib with a later release

6b7028c

Rename font name variable

329cc48

Use stripos rather than strpos

27cb94b

Refactor remove functionality

d2347ad

mikachan marked this pull request as ready for review April 5, 2023 16:36

matiasbenedetto reviewed Apr 10, 2023

View reviewed changes

admin/class-manage-fonts.php Outdated Show resolved Hide resolved

matiasbenedetto reviewed Apr 10, 2023

View reviewed changes

admin/class-manage-fonts.php Outdated Show resolved Hide resolved

matiasbenedetto reviewed Apr 10, 2023

View reviewed changes

composer.json Outdated Show resolved Hide resolved

madhusudhand reviewed Apr 13, 2023

View reviewed changes

admin/class-manage-fonts.php Outdated Show resolved Hide resolved

madhusudhand reviewed Apr 13, 2023

View reviewed changes

mikachan added 2 commits April 19, 2023 12:56

Use lib-font to get font credits

e1669b7

Use font-credits data passed from client-side

d24aece

mikachan added 3 commits April 19, 2023 13:17

Remove php-font-lib

686f375

Add ending tag to credit info

531fecb

Use array_key_exists consistently

0433552

matiasbenedetto reviewed Apr 27, 2023

View reviewed changes

mikachan added 4 commits April 27, 2023 15:52

Merge branch 'trunk' into add/handle-google-font-credits

2b4348f

Use get() function to get name records

3c7df1c

Trim whitespace from all credit fields

f1bec0c

Prevent license info from being over 200 chars

740ca8a

Refactor end of credits note

168cf9a

Split license info at first new line

43d7ad9

matiasbenedetto requested changes May 4, 2023

View reviewed changes

mikachan added 2 commits May 4, 2023 18:25

Add new line above credits

9894b33

Move delete functionality to prepare_font_families_for_database

5945aaa

mikachan requested a review from matiasbenedetto May 5, 2023 11:28

matiasbenedetto mentioned this pull request May 5, 2023

Add font license automatically for local fonts uploaded #348

Closed

matiasbenedetto approved these changes May 5, 2023

View reviewed changes

mikachan merged commit 7960aa1 into trunk May 8, 2023

mikachan deleted the add/handle-google-font-credits branch May 8, 2023 11:37

mikachan mentioned this pull request May 11, 2023

Automatically add font license info for local fonts #367

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically add font license info for Google fonts #298

Automatically add font license info for Google fonts #298

mikachan commented Apr 1, 2023 •

edited

Loading

matiasbenedetto left a comment •

edited

Loading

matiasbenedetto commented Apr 10, 2023

matiasbenedetto commented Apr 10, 2023

matiasbenedetto commented Apr 10, 2023 •

edited

Loading

madhusudhand left a comment

mikachan commented Apr 18, 2023

mikachan commented Apr 18, 2023

mikachan commented Apr 19, 2023

matiasbenedetto left a comment

mikachan commented Apr 27, 2023

mikachan commented Apr 27, 2023

matiasbenedetto commented Apr 27, 2023

mikachan commented Apr 27, 2023

matiasbenedetto left a comment

mikachan commented May 4, 2023

matiasbenedetto left a comment

Automatically add font license info for Google fonts #298

Automatically add font license info for Google fonts #298

Conversation

mikachan commented Apr 1, 2023 • edited Loading

matiasbenedetto left a comment • edited Loading

Choose a reason for hiding this comment

matiasbenedetto commented Apr 10, 2023

matiasbenedetto commented Apr 10, 2023

matiasbenedetto commented Apr 10, 2023 • edited Loading

madhusudhand left a comment

Choose a reason for hiding this comment

mikachan commented Apr 18, 2023

mikachan commented Apr 18, 2023

mikachan commented Apr 19, 2023

matiasbenedetto left a comment

Choose a reason for hiding this comment

mikachan commented Apr 27, 2023

mikachan commented Apr 27, 2023

matiasbenedetto commented Apr 27, 2023

mikachan commented Apr 27, 2023

matiasbenedetto left a comment

Choose a reason for hiding this comment

mikachan commented May 4, 2023

matiasbenedetto left a comment

Choose a reason for hiding this comment

mikachan commented Apr 1, 2023 •

edited

Loading

matiasbenedetto left a comment •

edited

Loading

matiasbenedetto commented Apr 10, 2023 •

edited

Loading