├── CHANGELOG.md ├── LICENSE ├── README.md ├── composer.json └── inc └── namespace.php /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 6 | 7 | ## [2.1.3] - 2020-09-12 8 | 9 | ### Changed 10 | * Update `dealerdirect/phpcodesniffer-composer-installer` dev requirement from ^0.5.0 to ^0.7.0 for Composer 2 support. 11 | 12 | ## [2.1.2] - 2020-08-30 13 | 14 | ### Changed 15 | * Exclude tests and config files from dist-archive. [#43] 16 | 17 | ## [2.1.1] - 2020-07-22 18 | 19 | ### Changed 20 | * Call `wp_get_installed_translations()` and `get_available_languages()` only once to improve performance on plugins list table. [#39] 21 | * Cache results of failed API requests to reduce retries on follow-up requests which may fail too. [#40] 22 | 23 | ## [2.1.0] - 2020-07-20 24 | 25 | ### Fixed 26 | * Prevent PHP fatal error for malformed date strings in PO files. Props @nickcernis. [#32] 27 | 28 | ### Changed 29 | * Only install updates for actually available languages. [#28] 30 | * Performance: Make closures static where possible. [#30] 31 | * Performance: Use fully qualified name for special compiled PHP functions. [#36] 32 | 33 | ## [2.0.0] - 2019-03-15 34 | 35 | ### Fixed 36 | * Various documentation improvements. 37 | 38 | ### Changed 39 | * Delete cached API results when plugins/themes are updated to avoid stale or missing translation updates. 40 | 41 | ### Added 42 | * Integration tests. 43 | 44 | ### Removed 45 | * Support for PHP 7.0. 46 | 47 | ## [1.0.2] - 2018-08-31 48 | 49 | ### Changed 50 | * Improve support for new `wp language plugin|theme install|update` commands in WP-CLI 2.0. 51 | 52 | ## [1.0.1] - 2018-06-29 53 | 54 | ### Fixed 55 | * Prevent a PHP notice that could occur under some circumstances. 56 | 57 | ## 1.0.0 - 2018-06-19 58 | 59 | ## Added 60 | * Initial release 61 | 62 | [Unreleased]: https://github.com/wearerequired/traduttore-registry/compare/2.1.3...HEAD 63 | [2.1.3]: https://github.com/wearerequired/traduttore-registry/compare/2.1.2...2.1.3 64 | [2.1.2]: https://github.com/wearerequired/traduttore-registry/compare/2.1.1...2.1.2 65 | [2.1.1]: https://github.com/wearerequired/traduttore-registry/compare/2.1.0...2.1.1 66 | [2.1.0]: https://github.com/wearerequired/traduttore-registry/compare/2.0.0...2.1.0 67 | [2.0.0]: https://github.com/wearerequired/traduttore-registry/compare/1.0.2...2.0.0 68 | [1.0.2]: https://github.com/wearerequired/traduttore-registry/compare/1.0.1...1.0.2 69 | [1.0.1]: https://github.com/wearerequired/traduttore-registry/compare/1.0.0...1.0.1 70 | 71 | [#28]: https://github.com/wearerequired/traduttore-registry/issues/28 72 | [#30]: https://github.com/wearerequired/traduttore-registry/issues/30 73 | [#32]: https://github.com/wearerequired/traduttore-registry/issues/32 74 | [#36]: https://github.com/wearerequired/traduttore-registry/issues/36 75 | [#39]: https://github.com/wearerequired/traduttore-registry/issues/39 76 | [#40]: https://github.com/wearerequired/traduttore-registry/issues/40 77 | [#43]: https://github.com/wearerequired/traduttore-registry/issues/43 78 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Traduttore Registry 2 | 3 | 4 | ![PHPUnit](https://github.com/wearerequired/traduttore-registry/workflows/PHPUnit/badge.svg) 5 | ![Lint](https://github.com/wearerequired/traduttore-registry/workflows/Lint/badge.svg) 6 | [![codecov](https://codecov.io/gh/wearerequired/traduttore-registry/branch/master/graph/badge.svg)](https://codecov.io/gh/wearerequired/traduttore-registry) 7 | [![Latest Stable Version](https://poser.pugx.org/wearerequired/traduttore-registry/v/stable)](https://packagist.org/packages/wearerequired/traduttore-registry) 8 | [![Latest Unstable Version](https://poser.pugx.org/wearerequired/traduttore-registry/v/unstable)](https://packagist.org/packages/wearerequired/traduttore-registry) 9 | 10 | Allows loading translation files from a custom GlotPress site running [Traduttore](https://github.com/wearerequired/traduttore). 11 | 12 | ## Installation 13 | 14 | If you're using [Composer](https://getcomposer.org/) to manage dependencies, you can use the following command to add the plugin to your site: 15 | 16 | ```bash 17 | composer require wearerequired/traduttore-registry 18 | ``` 19 | 20 | After that, you can use `\Required\Traduttore_Registry\add_project( $type, $slug, $api_url )` in your theme or plugin. 21 | 22 | *Parameters:* 23 | 24 | * `$type`: either `plugin` or `theme`. 25 | * `$slug`: must match the theme/plugin directory slug. 26 | * `$api_url`: the URL to the Traduttore project translation API. 27 | 28 | *Note:* On a multisite install it's recommended to use it in a must-use plugin. 29 | 30 | ## Usage 31 | 32 | Here's an example of how you can use that function: 33 | 34 | ```php 35 | \Required\Traduttore_Registry\add_project( 36 | 'plugin', 37 | 'example-plugin', 38 | 'https://translate.example.com/api/translations/acme/acme-plugin/' 39 | ); 40 | 41 | \Required\Traduttore_Registry\add_project( 42 | 'theme', 43 | 'example-theme', 44 | 'https://translate.example.com/api/translations/acme/acme-theme/' 45 | ); 46 | ``` 47 | 48 |
49 | 50 | [![a required open source product - let's get in touch](https://media.required.com/images/open-source-banner.png)](https://required.com/en/lets-get-in-touch/) 51 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "wearerequired/traduttore-registry", 3 | "description": "Allows loading translation files from a custom GlotPress site running Traduttore", 4 | "license": "GPL-2.0-or-later", 5 | "type": "library", 6 | "keywords": [ 7 | "wordpress", 8 | "glotpress", 9 | "translations" 10 | ], 11 | "authors": [ 12 | { 13 | "name": "required", 14 | "email": "support@required.ch", 15 | "homepage": "https://required.com", 16 | "role": "Company" 17 | }, 18 | { 19 | "name": "Dominik Schilling", 20 | "email": "dominik@required.ch", 21 | "role": "Developer" 22 | }, 23 | { 24 | "name": "Pascal Birchler", 25 | "role": "Developer" 26 | } 27 | ], 28 | "homepage": "https://github.com/wearerequired/traduttore-registry", 29 | "require": { 30 | "php": ">=7.1" 31 | }, 32 | "require-dev": { 33 | "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0", 34 | "phpunit/phpunit": "^7.5.13", 35 | "wearerequired/coding-standards": "^1.0", 36 | "yoast/phpunit-polyfills": "^1.0" 37 | }, 38 | "autoload": { 39 | "files": [ 40 | "inc/namespace.php" 41 | ] 42 | }, 43 | "autoload-dev": { 44 | "psr-4": { 45 | "Required\\Traduttore_Registry\\Tests\\": "tests/phpunit/tests" 46 | } 47 | }, 48 | "config": { 49 | "allow-plugins": { 50 | "dealerdirect/phpcodesniffer-composer-installer": true 51 | }, 52 | "sort-packages": true 53 | }, 54 | "extra": { 55 | "branch-alias": { 56 | "dev-master": "2.x-dev" 57 | } 58 | }, 59 | "scripts": { 60 | "format": "vendor/bin/phpcbf --standard=phpcs.xml.dist --report-summary --report-source", 61 | "lint": "vendor/bin/phpcs --standard=phpcs.xml.dist --report-summary --report-source", 62 | "test": "vendor/bin/phpunit" 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /inc/namespace.php: -------------------------------------------------------------------------------- 1 | translations ) ) { 74 | $value->translations = []; 75 | } 76 | 77 | $translations = get_translations( $type, $slug, $api_url ); 78 | 79 | if ( ! isset( $translations['translations'] ) ) { 80 | return $value; 81 | } 82 | 83 | $installed_translations = get_installed_translations( $type ); 84 | $locales = get_available_locales(); 85 | 86 | /** This filter is documented in wp-includes/update.php */ 87 | $locales = apply_filters( $type . 's_update_check_locales', $locales ); 88 | $active_locales = array_unique( $locales ); 89 | 90 | foreach ( (array) $translations['translations'] as $translation ) { 91 | if ( ! \in_array( $translation['language'], $active_locales, true ) ) { 92 | continue; 93 | } 94 | 95 | if ( $translation['updated'] && isset( $installed_translations[ $slug ][ $translation['language'] ] ) ) { 96 | $local = sanitize_date( $installed_translations[ $slug ][ $translation['language'] ]['PO-Revision-Date'] ); 97 | $remote = new DateTime( $translation['updated'] ); 98 | 99 | if ( $local >= $remote ) { 100 | continue; 101 | } 102 | } 103 | 104 | $translation['type'] = $type; 105 | $translation['slug'] = $slug; 106 | 107 | $value->translations[] = $translation; 108 | } 109 | 110 | return $value; 111 | } 112 | ); 113 | } 114 | 115 | /** 116 | * Registers actions for clearing translation caches. 117 | * 118 | * @since 1.1.0 119 | */ 120 | function register_clean_translations_cache() { 121 | $clear_plugin_translations = static function() { 122 | clean_translations_cache( 'plugin' ); 123 | }; 124 | $clear_theme_translations = static function() { 125 | clean_translations_cache( 'theme' ); 126 | }; 127 | 128 | add_action( 'set_site_transient_update_plugins', $clear_plugin_translations ); 129 | add_action( 'delete_site_transient_update_plugins', $clear_plugin_translations ); 130 | 131 | add_action( 'set_site_transient_update_themes', $clear_theme_translations ); 132 | add_action( 'delete_site_transient_update_themes', $clear_theme_translations ); 133 | } 134 | 135 | /** 136 | * Clears existing translation cache for a given type. 137 | * 138 | * @since 1.1.0 139 | * 140 | * @param string $type Project type. Either plugin or theme. 141 | */ 142 | function clean_translations_cache( $type ) { 143 | $transient_key = constant( __NAMESPACE__ . '\TRANSIENT_KEY_' . strtoupper( $type ) ); 144 | $translations = get_site_transient( $transient_key ); 145 | 146 | if ( ! \is_object( $translations ) ) { 147 | return; 148 | } 149 | 150 | /* 151 | * Don't delete the cache if the transient gets changed multiple times 152 | * during a single request. Set cache lifetime to maximum 15 seconds. 153 | */ 154 | $cache_lifespan = 15; 155 | $time_not_changed = isset( $translations->_last_checked ) && ( time() - $translations->_last_checked ) > $cache_lifespan; 156 | 157 | if ( ! $time_not_changed ) { 158 | return; 159 | } 160 | 161 | delete_site_transient( $transient_key ); 162 | } 163 | 164 | /** 165 | * Gets the translations for a given project. 166 | * 167 | * @since 1.0.0 168 | * 169 | * @param string $type Project type. Either plugin or theme. 170 | * @param string $slug Project directory slug. 171 | * @param string $url Full GlotPress API URL for the project. 172 | * @return array Translation data. 173 | */ 174 | function get_translations( $type, $slug, $url ) { 175 | $transient_key = constant( __NAMESPACE__ . '\TRANSIENT_KEY_' . strtoupper( $type ) ); 176 | $translations = get_site_transient( $transient_key ); 177 | 178 | if ( ! \is_object( $translations ) ) { 179 | $translations = new \stdClass(); 180 | } 181 | 182 | if ( isset( $translations->{$slug} ) && \is_array( $translations->{$slug} ) ) { 183 | return $translations->{$slug}; 184 | } 185 | 186 | $result = json_decode( wp_remote_retrieve_body( wp_remote_get( $url, [ 'timeout' => 2 ] ) ), true ); 187 | if ( ! \is_array( $result ) ) { 188 | // Cache an empty result in case of a failure 189 | // and retry on next update check. 190 | $result = []; 191 | } 192 | 193 | $translations->{$slug} = $result; 194 | $translations->_last_checked = time(); 195 | 196 | set_site_transient( $transient_key, $translations ); 197 | 198 | return $result; 199 | } 200 | 201 | /** 202 | * Sanitizes a date string. 203 | * 204 | * DateTime fails to parse date strings that contain brackets, such as 205 | * “Tue Dec 22 2015 12:52:19 GMT+0100 (West-Europa)”, which appears in 206 | * PO-Revision-Date headers. Sanitization ensures such date headers are 207 | * parsed correctly into DateTime instances. 208 | * 209 | * @since 2.1.0 210 | * 211 | * @param string $date_string The date string to sanitize. 212 | * @return \DateTime Date from string if parsable, otherwise the Unix epoch. 213 | */ 214 | function sanitize_date( $date_string ) { 215 | $date_and_timezone = explode( '(', $date_string ); 216 | $date_no_timezone = trim( $date_and_timezone[0] ); 217 | 218 | try { 219 | $date = new DateTime( $date_no_timezone ); 220 | } catch ( \Exception $e ) { 221 | return new DateTime( '1970-01-01' ); 222 | } 223 | 224 | return $date; 225 | } 226 | 227 | /** 228 | * Gets the installed translations. 229 | * 230 | * Results are cached. 231 | * 232 | * @since 2.2.0 233 | * 234 | * @see wp_get_installed_translations() 235 | * 236 | * @param string $type Project type. Either plugin or theme. 237 | * @return array Translation data. 238 | */ 239 | function get_installed_translations( $type ) { 240 | static $cache = []; 241 | 242 | if ( ! isset( $cache[ $type ] ) ) { 243 | $cache[ $type ] = wp_get_installed_translations( $type . 's' ); 244 | } 245 | 246 | return $cache[ $type ]; 247 | } 248 | 249 | /** 250 | * Gets all available and installed locales. 251 | * 252 | * Results are cached. 253 | * 254 | * @since 2.2.0 255 | * 256 | * @see get_available_languages() 257 | * 258 | * @return array List of installed locales. 259 | */ 260 | function get_available_locales() { 261 | static $cache = null; 262 | 263 | if ( ! isset( $cache ) ) { 264 | $cache = array_values( get_available_languages() ); 265 | } 266 | 267 | return $cache; 268 | } 269 | --------------------------------------------------------------------------------