Update to 3.0.0

Author: Oleksii Sinyaev

CHANGELOG.md

@@ -1,5 +1,18 @@
 # WProofreader Plugin for WordPress Changelog
 
+## 3.0.0 - 2025-10-31
+
+* Added a few global activation toggles (disabled by default):
+* * Enable in admin area to run WProofreader across the WordPress admin.
+* * Enable on front end to run WProofreader on the public site.
+* Fixed issue where spelling autocorrect could modify URLs; now disabled by default in link-related fields.
+* Updated service path to remove the legacy component ssrv.cgi, which is no longer used.
+* Improved dedicated loading for the Block Editor (enqueue_block_assets), with safe exclusions for the Site Editor and Permalinks settings screen.
+* Improved asset versioning based on file modification time to reduce caching issues.
+* Improved unified script handles and localization objects for consistency.
+* Hardened AJAX endpoint for the language list with nonce verification, capability checks, strict sanitization, and structured JSON response.
+* Comprehensive refactoring and code cleanup: simplified initialization flow for admin, Block Editor, and front end; consolidated settings bootstrap and defaults.
+
 ## 2.8.0 - 2025-06-25
 
 * Fixed issue with user preferences not being remembered. A recent issue caused user-selected options (e.g., selected language, ignore settings, enabled check types) to reset on every page reload. Now, these preferences are stored.

README.md

@@ -25,7 +25,7 @@ Free WProofreader plugin supports only spell-check for 6 languages and comes wit
 * **Allowed number of websites:** 1 website.
 * **Languages available for spell checking:** (6 languages) American English, British English, French, German, Italian and Spanish.
 * **Languages available for grammar checking:** Not available.
-* **User-level custom dictionary:** No cloud backup. The dictionary is only available in one browser on a single device. The dictionary is not available for review and modification.
+* **User-level custom dictionary:** No cloud backup. The dictionary is only available in one browser on a single device.
 * **Organization-level custom dictionary:** Not available.
 
 **Pro version: ($49)**

assets/environmentChecker.js

@@ -0,0 +1,26 @@
+window.addEventListener("load", (event) => {
+    var  bundlePath = 'https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js';
+
+    function loadScript(doc, src) {
+        const script = doc.createElement('script');
+        const appendTo = doc.head || doc.documentElement;
+
+        script.type = 'text/javascript';
+        script.charset = 'UTF-8';
+        script.async = false;
+        script.src = src;
+
+        appendTo.appendChild(script);
+    }
+
+    window.gutenbergIframe = document.querySelector('[name=editor-canvas]');
+    window.WEBSPELLCHECKER_CONFIG.globalBadge= true;
+
+    if (window.gutenbergIframe) {
+        window.WEBSPELLCHECKER_CONFIG.globalBadge = false;
+        loadScript(window.gutenbergIframe.contentWindow.document, bundlePath);
+        window.gutenbergIframe = null;
+    }
+
+    loadScript(document, bundlePath);
+});

assets/gutenberg-environment.js

@@ -1,86 +1,78 @@
-jQuery(document).ready(function ($){
-
-    function isGutenbergActive() {
-        return document.body.classList.contains('block-editor-page');
-    }
-
-    function isContentEditable(element){
+(function () {
+    'use strict';
+    const SELECTORS = {
+        RICH_TEXT: '.rich-text',
+        MCE_CONTENT_BODY: '.mce-content-body',
+        GUTENBERG_PAGE: 'block-editor-page',
+        GUTENBERG_IFRAME: 'block-editor-iframe__body',
+        TABLE_CELL: 'wp-block-table__cell-content'
+    };
+
+    const INSTANCE_ATTRIBUTE = 'data-wsc-instance';
+    const INIT_DELAY = 100;
+
+    const isGutenbergActive = () => {
+        return document.body.classList.contains(SELECTORS.GUTENBERG_PAGE) ||
+               document.body.classList.contains(SELECTORS.GUTENBERG_IFRAME);
+    };
+
+    function isContentEditable(element) {
         return element.isContentEditable;
     }
-
-    function isInstanceCreated(element){
-        return element.hasAttribute('data-wsc-instance');
+    function isInstanceCreated(element) {
+        return element.hasAttribute(INSTANCE_ATTRIBUTE);
     }
 
-    function isGutenbergTableCell(element){
-        return element.classList.contains('wp-block-table__cell-content');
+    function isGutenbergTableCell(element) {
+        return element.classList.contains(SELECTORS.TABLE_CELL);
     }
 
-    function ignoreElement(element) {
-        if (!isContentEditable(element)){
+    const shouldIgnoreElement = (element) => {
+        if (!isContentEditable(element)) {
             return true;
         }
 
-        if (isInstanceCreated(element)){
+        if (isInstanceCreated(element)) {
             return true;
         }
 
-        if (isGutenbergTableCell(element)){
+        if (isGutenbergTableCell(element)) {
             return true;
         }
 
         return false;
-    }
+    };
 
-    function createInstance(element){
+    const createInstance = (element) => {
         WEBSPELLCHECKER.init({
             container: element,
         });
-    }
+    };
 
-    if (!isGutenbergActive()){
-        return;
-    }
-
-    function handleGutenbergReady(){
-
-        $(".rich-text").each(function (index) {
-            const element = jQuery(this).get(0);
-            if (ignoreElement(element)) {
+    const initializeElements = (selector) => {
+        document.querySelectorAll(selector).forEach((element) => {
+            if (shouldIgnoreElement(element)) {
                 return;
             }
+
             createInstance(element);
         });
+    };
 
-        wp.data.subscribe(function () {
-            var isSidebarOpened = wp.data.select('core/edit-post').isEditorSidebarOpened();
-            if (isSidebarOpened) {
-                jQuery('.wsc-badge__wrapper').css('right', '300px');
-            } else {
-                jQuery('.wsc-badge__wrapper').css('right', '30px');
-            }
-        });
-    }
-    function handleTinyMceInit(editor) {
-        const element = editor.getBody();
-        if (ignoreElement(element)) {
-            return;
-        }
-        createInstance(element);
-    }
-    function handleGutenbergReadyWithDelay(){
-        setTimeout(handleGutenbergReady, 100);
-    }
+    const handleGutenbergReady = () => {
+        initializeElements(SELECTORS.RICH_TEXT);
+        initializeElements(SELECTORS.MCE_CONTENT_BODY);
+    };
 
-    window._wpLoadBlockEditor.then(handleGutenbergReadyWithDelay);
+    const handleGutenbergReadyWithDelay = () => {
+        setTimeout(handleGutenbergReady, INIT_DELAY);
+    };
 
-    if (window.tinymce) {
-        tinymce.on('addeditor', function (event) {
-            const editor = event.editor;
-            editor.on('init', function () {
-                handleTinyMceInit(editor);
-            });
-        });
-    }
+    window.webspellcheckerAlreadyLoaded = () => {
+        if (!isGutenbergActive() || !window.WEBSPELLCHECKER_CONFIG?.globalBadge) {
+            return;
+        }
 
-});
+        handleGutenbergReadyWithDelay();
+    };
+})();

assets/instance.js

@@ -1,44 +1,94 @@
-jQuery(document).ready(function ($) {
-    var CheckEnableGrammar = (ProofreaderInstance.enableGrammar === 'true');
-    var AppInstance;
-    AppInstance = WEBSPELLCHECKER.initWebApi({
+/**
+ * WProofreader Settings Page
+ * Initializes the spell checker instance and fetches languages.
+ */
+jQuery(function ($) {
+    'use strict';
+
+    // Guards
+    if (typeof WEBSPELLCHECKER === 'undefined' || typeof ProofreaderInstance === 'undefined') return;
+
+    const $root = $('#wsc_proofreader');
+    let $select = $root.find('select[name="wsc_proofreader[slang]"]');
+    if (!$select.length) return;
+
+    const enableGrammar = (ProofreaderInstance.enableGrammar === 'true');
+
+    // Init WebSpellChecker
+    const app = WEBSPELLCHECKER.initWebApi({
         autoSearch: true,
         serviceProtocol: 'https',
         serviceHost: 'svc.webspellchecker.net',
-        servicePath: 'spellcheck31/script/ssrv.cgi',
+        servicePath: 'spellcheck31/api',
         servicePort: '443',
-        enableGrammar: CheckEnableGrammar,
+        enableGrammar: enableGrammar,
         serviceId: ProofreaderInstance.key_for_proofreader,
         lang: ProofreaderInstance.slang,
-        appType:'wp_plugin',
-        function(instance) {
-            AppInstance = instance;
-        },
-
+        appType: 'wp_plugin'
     });
-    AppInstance.getInfo({
-        success: function (result) {
-            jQuery.ajax({
-                type: "POST",
-                url: ajaxurl,
+
+    // Get info → send to WP → render languages
+    app.getInfo({
+        success(result) {
+            $.ajax({
+                type: 'POST',
+                url: window.ajaxurl,
                 data: {
-                    action: "get_proofreader_info_callback",
+                    action: 'get_proofreader_info_callback',
                     security: ProofreaderInstance.ajax_nonce,
                     getInfoResult: result
-                },
-                success: function (data) {
-                    $('#wsc_proofreader select ').html(data);
-                },
-                error: function (errorThrown) {
-                    /// console.log(errorThrown);
                 }
-            });
+            })
+                .done((res) => {
+                    // Support both: raw HTML string OR {success:true, data:"..."} OR {success:true, data:{html:"..."}}
+                    const html =
+                        (typeof res === 'string') ? res :
+                            (res && res.success && typeof res.data?.html === 'string') ? res.data.html :
+                                (res && res.success && typeof res.data === 'string') ? res.data : '';
+
+                    if (!html) {
+                        displayError('Failed to load language list. Invalid response format.');
+                        return;
+                    }
+
+                    // If a full <select> returned — replace; otherwise swap <option>s
+                    if (/<\s*select[^>]*>/i.test(html)) {
+                        $select.replaceWith(html);
+                        $select = $root.find('select[name="wsc_proofreader[slang]"]');
+                    } else {
+                        $select.html(html);
+                    }
+                })
+                .fail((jqXHR, textStatus) => {
+                    let msg = 'Failed to load language list.';
+                    if (jqXHR?.responseJSON?.data?.message) {
+                        msg = jqXHR.responseJSON.data.message;
+                    } else if (textStatus) {
+                        msg += ` (${textStatus})`;
+                    }
+                    displayError(msg);
+                });
         },
-        error: function (e) {
-            if(e.message){
-                var message = '<strong>WProofreader:</strong> '+e.message;
-                $('#wsc_proofreader').prepend('<div class="error"><p>'+message+'.</p><p><a target="_blank" href="https://webspellchecker.com/contact-us/">Contact us</a> for technical assistance.</p></div>');
-            }
+        error(err) {
+            displayError(err?.message || 'Unexpected initialization error.');
         }
     });
+
+    function displayError(message) {
+        const html =
+            '<div class="error">' +
+            `<p><strong>WProofreader:</strong> ${escapeHtml(message)}</p>` +
+            '<p><a target="_blank" href="https://webspellchecker.com/contact-us/">Contact us</a> for technical assistance.</p>' +
+            '</div>';
+        $root.prepend(html);
+    }
+
+    function escapeHtml(str) {
+        return String(str)
+            .replace(/&/g, '&amp;')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;')
+            .replace(/"/g, '&quot;')
+            .replace(/'/g, '&#039;');
+    }
 });