Changeset 3754115

Timestamp:

10/19/2026 06:40:44 AM (4 weeks ago)

Author:

autoaltai

Message:

[200~releasing

Location:

welcoma-accessibility-widget/trunk

Files:

• changelog.txt (added)
• includes/class-welcoma-frontend.php (modified) (7 diffs)
• public/css/welcoma-font.min.css (added)
• public/css/welcoma-widget.min.css (added)
• public/js/welcoma-prepaint.min.js (added)
• public/js/welcoma-widget.js (modified) (4 diffs)
• public/js/welcoma-widget.min.js (added)
• readme.txt (modified) (2 diffs)
• welcoma-accessibility-widget.php (modified) (3 diffs)

welcoma-accessibility-widget/trunk/includes/class-welcoma-frontend.php

@@ -26 +26 @@
                 add_action( 'wp_body_open', array( $this, 'render_skip_link' ) );
                 add_action( 'wp_footer', array( $this, 'render_widget_landmark' ), 5 );
+                add_action( 'wp_ajax_welcoma_i18n', array( $this, 'ajax_translations' ) );
+                add_action( 'wp_ajax_nopriv_welcoma_i18n', array( $this, 'ajax_translations' ) );
         }
 
@@ -143 +145 @@
                 }
 
-                $settings = Welcoma_Settings::get();
-
+                $settings       = Welcoma_Settings::get();
+                $active_modules = $this->active_modules( $settings );
+
+                // Pre-paint state restoration is shipped as a normal enqueued script.
+                $this->enqueue_core_assets();
+
+                // ── Build title / branding translations (flat cache shape) ──
+                $title_translations = array();
+                foreach ( Welcoma_Translator::all_lang_codes() as $lang ) {
+                        $val = Welcoma_Translator::get_string( 'accessibility_title', $lang );
+                        if ( '' !== $val ) {
+                                $title_translations[ $lang ] = $val;
+                        }
+                }
+                // Ensure the current source-locale/settings value is always present
+                // even before any background job has run.
+                if ( empty( $title_translations['en'] ) ) {
+                        $title_translations['en'] = 'Accessibility';
+                }
+
+                // Only the start language goes into the page. Every language would add ~150 KB to
+                // each HTML page; other languages are fetched when a visitor switches (ajax_translations).
+                $inline_langs   = $this->initial_langs( $settings );
+                $translations   = $this->build_translations( $active_modules, $inline_langs );
+                $statement_data = get_option( 'welcoma_statement', array( 'content' => '' ) );
+                $statement_data['translations'] = empty( $translations['statement'] ) ? null : $translations['statement'];
+                $module_translations            = $translations['module_translations'];
+                $static_ui                      = $translations['static_ui'];
+                $i18n_url                       = add_query_arg(
+                        array(
+                                'action' => 'welcoma_i18n',
+                                'v'      => $this->translations_version( $active_modules ),
+                        ),
+                        admin_url( 'admin-ajax.php' )
+                );
+                $this->localize( $settings, $active_modules, $title_translations, $module_translations, $statement_data, $static_ui, $inline_langs, $i18n_url );
+        }
+
+        /**
+         * Modules shown in the widget: enabled ones plus every module a built-in profile uses.
+         *
+         * @param array $settings Widget settings.
+         * @return array[]
+         */
+        private function active_modules( $settings ) {
                 // Add-ons register their own modules through welcoma_widget_modules. Core
                 // does not perform payment/license checks for locally implemented features.
@@ -171 +216 @@
                         );
                 }
-
-                // Pre-paint state restoration is shipped as a normal enqueued script.
+                return $active_modules;
+        }
+
+        /**
+         * CSS/JS of the widget. Minified files (built by the release workflow) unless
+         * SCRIPT_DEBUG is on or they are missing (development checkout).
+         */
+        private function enqueue_core_assets() {
                 wp_enqueue_script(
                         'welcoma-prepaint',
-                        WELCOMA_WIDGET_URL . 'public/js/welcoma-prepaint.js',
+                        WELCOMA_WIDGET_URL . 'public/js/' . welcoma_widget_asset( 'welcoma-prepaint.js' ),
                         array(),
                         WELCOMA_WIDGET_VERSION,
-                        false
+                        false // must run before the first paint to restore the visitor's settings
                 );
                 wp_localize_script(
@@ -188 +239 @@
                 wp_enqueue_style(
                         'welcoma-widget',
-                        WELCOMA_WIDGET_URL . 'public/css/welcoma-widget.css',
+                        WELCOMA_WIDGET_URL . 'public/css/' . welcoma_widget_asset( 'welcoma-widget.css' ),
                         array(),
                         WELCOMA_WIDGET_VERSION
@@ -195 +246 @@
                 wp_enqueue_style(
                         'welcoma-fonts',
-                        WELCOMA_WIDGET_URL . 'public/css/welcoma-font.css',
+                        WELCOMA_WIDGET_URL . 'public/css/' . welcoma_widget_asset( 'welcoma-font.css' ),
                         array(),
                         WELCOMA_WIDGET_VERSION
@@ -202 +253 @@
                 wp_enqueue_script(
                         'welcoma-widget',
-                        WELCOMA_WIDGET_URL . 'public/js/welcoma-widget.js',
+                        WELCOMA_WIDGET_URL . 'public/js/' . welcoma_widget_asset( 'welcoma-widget.js' ),
                         array(),
                         WELCOMA_WIDGET_VERSION,
-                        true
-                );
-
-                // ── Build title / branding translations (flat cache shape) ──
-                $cache              = Welcoma_Translator::get_cache();
-                $snapshot           = Welcoma_Translator::get_snapshot();
-                $title_translations = array();
-
-                foreach ( Welcoma_Translator::all_lang_codes() as $lang ) {
-                        $val = Welcoma_Translator::get_string( 'accessibility_title', $lang );
-                        if ( '' !== $val ) {
-                                $title_translations[ $lang ] = $val;
-                        }
-                }
-                // Ensure the current source-locale/settings value is always present
-                // even before any background job has run.
-                if ( empty( $title_translations['en'] ) ) {
-                        $title_translations['en'] = 'Accessibility';
-                }
-
-                // ── Build module translations ──
-                // Cache keys are stored as '{module_id}_name' and '{module_id}_desc'
-                // e.g. 'font-size_name', 'font-size_desc'
-                $module_translations = array();
-
-                foreach ( $active_modules as $m ) {
-                        $id = $m['id'];
-
-                        $module_translations[ $id ] = array(
-                                'name' => array(),
-                                'desc' => array(),
-                        );
-
-                        $safe_id        = str_replace( '-', '_', $id );
-                        $is_custom      = ! empty( $m['is_custom'] );
-                        $name_cache_key = ( $is_custom ? 'custom_profile__' : 'mod__' ) . $safe_id . '__name';
-                        $desc_cache_key = ( $is_custom ? 'custom_profile__' : 'mod__' ) . $safe_id . '__desc';
-
-                        foreach ( Welcoma_Translator::all_lang_codes() as $lang ) {
-                                $name_val = Welcoma_Translator::get_string( $name_cache_key, $lang );
-                                if ( '' !== $name_val ) {
-                                        $module_translations[ $id ]['name'][ $lang ] = $name_val;
-                                }
-                                $desc_val = Welcoma_Translator::get_string( $desc_cache_key, $lang );
-                                if ( '' !== $desc_val ) {
-                                        $module_translations[ $id ]['desc'][ $lang ] = $desc_val;
-                                }
-                        }
-                }
-
-                $statement_data    = get_option( 'welcoma_statement', array( 'content' => '' ) );
-                $stmt_translations = array();
-
-                foreach ( Welcoma_Translator::all_lang_codes() as $lang ) {
-                        $val = Welcoma_Translator::get_string( 'statement', $lang );
-                        if ( '' !== $val ) {
-                                $stmt_translations[ $lang ] = $val;
-                        }
-                }
-
-                $statement_data['translations'] = empty( $stmt_translations ) ? null : $stmt_translations;
-
-                // Static UI strings are now translated via the same Translation
-                // API cache as everything else (per-language, follows the
-                // widget's own language switcher rather than the site locale).
-                $static_ui = array();
-                foreach ( Welcoma_Translator::static_ui_strings() as $ui_key => $ui_en_default ) {
-                        $static_ui[ $ui_key ] = array();
-                        foreach ( Welcoma_Translator::all_lang_codes() as $lang ) {
-                                $val = Welcoma_Translator::get_string( $ui_key, $lang );
-                                if ( '' !== $val ) {
-                                        $static_ui[ $ui_key ][ $lang ] = $val;
-                                }
-                        }
-                        if ( empty( $static_ui[ $ui_key ] ) ) {
-                                unset( $static_ui[ $ui_key ] );
-                        }
-                }
+                        true // footer, not deferred: Pro extends window.WelcomaWidget before the widget's init on DOMContentLoaded
+                );
+        }
+
+        /**
+         * Hand the widget its configuration.
+         */
+        private function localize( $settings, $active_modules, $title_translations, $module_translations, $statement_data, $static_ui, $inline_langs, $i18n_url ) {
+
                 wp_localize_script(
                         'welcoma-widget',
@@ -340 +322 @@
                                         : array(),
                                 'flags_url'                => WELCOMA_WIDGET_URL . 'public/assets/flags/',
+                                'i18n_loaded'              => $inline_langs,
+                                'i18n_url'                 => $i18n_url,
                         )
                 );
         }
+
+        /**
+         * Languages the visitor starts with: the admin default, or the first enabled language when
+         * the default isn't enabled (same rule as the widget JS), plus the base language of a
+         * regional code (pt-br → pt) because the widget falls back to it.
+         *
+         * @param array $settings Widget settings.
+         * @return string[]
+         */
+        private function initial_langs( $settings ) {
+                $default = ! empty( $settings['default_language'] ) ? (string) $settings['default_language'] : 'en';
+                $enabled = ! empty( $settings['enabled_languages'] ) ? (array) $settings['enabled_languages'] : array();
+                if ( $enabled && ! in_array( $default, $enabled, true ) ) {
+                        foreach ( Welcoma_Translator::all_lang_codes() as $code ) {
+                                if ( in_array( $code, $enabled, true ) ) {
+                                        $default = $code;
+                                        break;
+                                }
+                        }
+                }
+                return $this->with_base_lang( array( $default ) );
+        }
+
+        /**
+         * @param string[] $langs Language codes.
+         * @return string[] Codes plus their base language (pt-br → pt), only known codes.
+         */
+        private function with_base_lang( array $langs ) {
+                $known = Welcoma_Translator::all_lang_codes();
+                $out   = array();
+                foreach ( $langs as $lang ) {
+                        foreach ( array( $lang, strtok( $lang, '-' ) ) as $code ) {
+                                if ( in_array( $code, $known, true ) && ! in_array( $code, $out, true ) ) {
+                                        $out[] = $code;
+                                }
+                        }
+                }
+                return $out;
+        }
+
+        /**
+         * Module, UI and statement translations for the given languages, in the shape the widget
+         * reads (module_translations[id].name[lang], static_ui[key][lang], statement[lang]).
+         *
+         * @param array    $active_modules Modules shown in the widget.
+         * @param string[] $langs          Language codes.
+         * @return array{module_translations: array, static_ui: array, statement: array}
+         */
+        private function build_translations( $active_modules, array $langs ) {
+                $module_translations = array();
+                foreach ( $active_modules as $m ) {
+                        $id                         = $m['id'];
+                        $module_translations[ $id ] = array(
+                                'name' => array(),
+                                'desc' => array(),
+                        );
+                        // Cache keys: 'mod__{id}__name' / '__desc' (custom profiles: 'custom_profile__…').
+                        $prefix = ( empty( $m['is_custom'] ) ? 'mod__' : 'custom_profile__' ) . str_replace( '-', '_', $id );
+                        foreach ( $langs as $lang ) {
+                                foreach ( array( 'name', 'desc' ) as $field ) {
+                                        $val = Welcoma_Translator::get_string( $prefix . '__' . $field, $lang );
+                                        if ( '' !== $val ) {
+                                                $module_translations[ $id ][ $field ][ $lang ] = $val;
+                                        }
+                                }
+                        }
+                }
+
+                $statement = array();
+                foreach ( $langs as $lang ) {
+                        $val = Welcoma_Translator::get_string( 'statement', $lang );
+                        if ( '' !== $val ) {
+                                // Inserted as HTML by the widget – filter on output, so translations cached
+                                // before the Pro translator sanitised them can't carry script either.
+                                $statement[ $lang ] = wp_kses_post( $val );
+                        }
+                }
+
+                // Static UI strings follow the widget's own language switcher, not the site locale.
+                $static_ui = array();
+                foreach ( array_keys( Welcoma_Translator::static_ui_strings() ) as $ui_key ) {
+                        foreach ( $langs as $lang ) {
+                                $val = Welcoma_Translator::get_string( $ui_key, $lang );
+                                if ( '' !== $val ) {
+                                        $static_ui[ $ui_key ][ $lang ] = $val;
+                                }
+                        }
+                }
+
+                return array(
+                        'module_translations' => $module_translations,
+                        'static_ui'           => $static_ui,
+                        'statement'           => $statement,
+                );
+        }
+
+        /**
+         * Changes whenever a translation, the module list or the statement changes, so browsers
+         * can cache ajax_translations() responses for long and still never get stale text.
+         *
+         * @param array $active_modules Modules shown in the widget.
+         * @return string
+         */
+        private function translations_version( $active_modules ) {
+                $statement = get_option( 'welcoma_statement', array() );
+                return substr(
+                        md5( WELCOMA_WIDGET_VERSION . '|' . serialize( Welcoma_Translator::get_cache() ) . '|' . wp_json_encode( wp_list_pluck( $active_modules, 'id' ) ) . '|' . wp_json_encode( $statement ) ),
+                        0,
+                        12
+                );
+        }
+
+        /**
+         * admin-ajax?action=welcoma_i18n&lang=xx – translations of one language for the widget's
+         * language switcher. Public data, no nonce; cached by the browser (the URL carries a
+         * content version). admin-ajax instead of REST: security plugins often block the REST API
+         * for visitors.
+         */
+        public function ajax_translations() {
+                $lang = isset( $_GET['lang'] ) ? sanitize_text_field( wp_unslash( $_GET['lang'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification
+                $settings = Welcoma_Settings::get();
+                if ( empty( $settings['widget_enabled'] ) || ! in_array( $lang, Welcoma_Translator::all_lang_codes(), true ) ) {
+                        wp_send_json_error( null, 404 );
+                }
+
+                $langs = $this->with_base_lang( array( $lang ) );
+                $data  = $this->build_translations( $this->active_modules( $settings ), $langs );
+
+                // admin-ajax sends no-cache headers, and wp_send_json() → wp_die() sends them again while
+                // the output is still buffered – so a plain header() call gets overwritten. The filter
+                // covers both calls. The URL carries a content version, so caching is safe.
+                $cache_headers = static function () {
+                        return array(
+                                'Cache-Control' => 'public, max-age=86400',
+                                'Expires'       => gmdate( 'D, d M Y H:i:s', time() + DAY_IN_SECONDS ) . ' GMT',
+                        );
+                };
+                add_filter( 'nocache_headers', $cache_headers, PHP_INT_MAX );
+                foreach ( $cache_headers() as $name => $value ) {
+                        header( $name . ': ' . $value );
+                }
+                wp_send_json(
+                        array(
+                                'langs'               => $langs,
+                                'module_translations' => $data['module_translations'],
+                                'static_ui'           => $data['static_ui'],
+                                'statement'           => $data['statement'],
+                        )
+                );
+        }
 }

welcoma-accessibility-widget/trunk/public/js/welcoma-widget.js

@@ -29 +29 @@
         DATA.default_language || 'en';
     var WELCOMA_FLAG_BASE_URL = DATA.flags_url || '';
+
+    /* ----------------------------------------------------------------
+     * Translations are delivered for the start language only (they used to add
+     * ~150 KB of every language to each page). Other languages are fetched once
+     * from DATA.i18n_url when needed and merged into the same DATA structures,
+     * so getModuleName(), getStatic() etc. work unchanged.
+     * ---------------------------------------------------------------- */
+    var loadedLangs = Array.isArray(DATA.i18n_loaded) ? DATA.i18n_loaded.slice() : null;
+    var refreshLanguageTexts = function () { };
+
+    function isLangLoaded(lang) {
+        if (!loadedLangs || !DATA.i18n_url) { return true; } // old data shape: everything inline
+        return loadedLangs.indexOf(lang) !== -1;
+    }
+
+    function mergeTranslations(data) {
+        if (!data || typeof data !== 'object') { return; }
+        var mt = data.module_translations || {};
+        DATA.module_translations = DATA.module_translations || {};
+        Object.keys(mt).forEach(function (id) {
+            var target = DATA.module_translations[id] = DATA.module_translations[id] || { name: {}, desc: {} };
+            ['name', 'desc'].forEach(function (field) {
+                target[field] = target[field] || {};
+                Object.keys(mt[id][field] || {}).forEach(function (lang) { target[field][lang] = mt[id][field][lang]; });
+            });
+        });
+        var ui = data.static_ui || {};
+        DATA.static_ui = DATA.static_ui || {};
+        Object.keys(ui).forEach(function (key) {
+            DATA.static_ui[key] = DATA.static_ui[key] || {};
+            Object.keys(ui[key]).forEach(function (lang) { DATA.static_ui[key][lang] = ui[key][lang]; });
+        });
+        var st = data.statement || {};
+        if (Object.keys(st).length) {
+            DATA.statement = DATA.statement || {};
+            DATA.statement.translations = DATA.statement.translations || {};
+            Object.keys(st).forEach(function (lang) { DATA.statement.translations[lang] = st[lang]; });
+        }
+        (data.langs || []).forEach(function (lang) {
+            if (loadedLangs.indexOf(lang) === -1) { loadedLangs.push(lang); }
+        });
+    }
+
+    // Calls done() once the language is available – or failed to load, in which case the
+    // widget simply shows the source-language texts as before.
+    function ensureLang(lang, done) {
+        if (isLangLoaded(lang) || !window.fetch) { done(); return; }
+        var url = DATA.i18n_url + (DATA.i18n_url.indexOf('?') === -1 ? '?' : '&') + 'lang=' + encodeURIComponent(lang);
+        window.fetch(url, { credentials: 'same-origin' })
+            .then(function (r) { return r.ok ? r.json() : null; })
+            .then(function (json) { mergeTranslations(json); done(); }, function () { done(); });
+    }
 
     /* ----------------------------------------------------------------
@@ -1909 +1961 @@
                     closeLangDropdown(true);
 
+                    ensureLang(activeLang, refreshLanguageTexts);
+                });
+            });
+
+            // Re-label everything in the active language (after a switch, or once a
+            // language remembered from earlier in the session has been loaded).
+            refreshLanguageTexts = function () {
                     // Update panel title
                     var titleEl = panel.querySelector('.welcoma-panel-title');
@@ -1953 +2012 @@
 
                     closeLangDropdown();
-                });
-            });
+            };
         }
 
@@ -2508 +2566 @@
         loadState();
         buildUI();
+        // A language picked earlier in this session may not be in the page yet.
+        if (!isLangLoaded(activeLang)) { ensureLang(activeLang, function () { refreshLanguageTexts(); }); }
         renderProfiles();
         renderTiles();

welcoma-accessibility-widget/trunk/readme.txt

@@ -6 +6 @@
 Tested up to: 7.1
 Requires PHP: 7.2
-Stable tag: 1.0.1
+Stable tag: 1.0.4
 License: GPLv2 or later
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
@@ -324 +324 @@
 == Changelog ==
 
+= 1.0.4 =
+Fix: the language files loaded by the widget's language switcher are now cached by the browser as intended.
+
+= 1.0.3 =
+Performance: pages only carry the widget texts of the start language (other languages load when a visitor switches), and the front-end JS/CSS ship minified. On a typical page the HTML is about 150 KB smaller.
+
+= 1.0.2 =
+Security: translated accessibility statements are filtered before they are shown to visitors.
+
 = 1.0.1 =
 Improved the "Reduced Motion & Flash" profile: it now also mutes sounds and lowers color saturation, in addition to stopping animations.

welcoma-accessibility-widget/trunk/welcoma-accessibility-widget.php

@@ -4 +4 @@
  * Plugin URI:        https://welcoma.app/
  * Description:       Accessibility widget with A11y profiles, keyboard navigation, text and contrast controls, multilingual UI, and accessibility statements.
- * Version:           1.0.1
+ * Version:           1.0.4
  * Requires at least: 6.2
  * Requires PHP:      7.2
@@ -24 +24 @@
  * Plugin constants.
  */
-define( 'WELCOMA_WIDGET_VERSION', '1.0.1' );
+define( 'WELCOMA_WIDGET_VERSION', '1.0.4' );
 define( 'WELCOMA_WIDGET_FILE', __FILE__ );
 define( 'WELCOMA_WIDGET_PATH', plugin_dir_path( __FILE__ ) );
@@ -90 +90 @@
  * @return array<string,string> Language code => brand text.
  */
+/**
+ * File name of a front-end asset: the minified build (name.min.js / name.min.css, created by
+ * the release workflow) unless SCRIPT_DEBUG is on or no build exists (development checkout).
+ *
+ * @param string $file File name in public/js or public/css, e.g. 'welcoma-widget.js'.
+ * @param string $base Plugin directory that contains public/ (defaults to this plugin).
+ * @return string
+ */
+function welcoma_widget_asset( $file, $base = '' ) {
+        if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
+                return $file;
+        }
+        $base = $base ? $base : plugin_dir_path( __FILE__ );
+        $dir  = '.css' === substr( $file, -4 ) ? 'public/css/' : 'public/js/';
+        $min  = preg_replace( '/\.(js|css)$/', '.min.$1', $file );
+        return is_readable( trailingslashit( $base ) . $dir . $min ) ? $min : $file;
+}
+
 function welcoma_widget_footer_brand_defaults() {
         return array(