Update JS libs + Add reload script feature

CoinK0in · CoinK0in · commit e1a9bc8f1ab4 · 2021-08-15T10:49:40.000+02:00
diff --git a/README.md b/README.md
@@ -237,8 +237,10 @@ Child elements of `encrypted_something` are build with a key `<unique name>` in
 The list have to be contructed with the name of an HTML element `<html tag>` as first item and `id` or `class` as the second item.
 
 ```yaml
-encrypted_something:
-    <uniq name>: [<html tag>, <'class' or 'id'>]
+plugins:
+    - encryptcontent:
+        encrypted_something:
+            <uniq name>: [<html tag>, <'class' or 'id'>]
 ```
 
 The `<unique name>` key identifies the name of a specific element of the page that will be searched by beautifulSoup.
@@ -273,8 +275,10 @@ Then add these elements in the format of a yaml dictionary under the variable `e
 Set your configuration like this : 
 
 ```yaml
-      encrypted_something:
-          mkdocs-encrypted-toc: [div, id]
+plugins:
+    - encryptcontent:
+        encrypted_something:
+            mkdocs-encrypted-toc: [div, id]
 ```
 
 2. Other example, with multiples target. In you Material Theme, you want to encrypt ToC content and Footer.
@@ -298,16 +302,18 @@ After modification, your template looks like this :
 
 Your configuration like this :
 ```yaml
-      encrypted_something:
-          mkdocs-encrypted-toc: [nav, class]
-          mkdocs-encrypted-footer: [div, id]
-          mkdocs-encrypted-footer-meta: [div, id]
+plugins:
+    - encryptcontent:
+        encrypted_something:
+            mkdocs-encrypted-toc: [nav, class]
+            mkdocs-encrypted-footer: [div, id]
+            mkdocs-encrypted-footer-meta: [div, id]
 ```
 
 
 ### Search index encryption
 
-> **ALPHA VERSION**, use at your own risks. ONLY work with themes using default mkdocs search.
+> **ALPHA VERSION**, use at your own risks. **ONLY** work with themes using default mkdocs search.
 
 Related to [issue #13](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/13)
 
@@ -338,6 +344,28 @@ This functionality overwrite the index creation function of the “search” plu
 When the configuration mode is set to "**dynamically**", the javascripts contrib files of the default search plugin are also overloaded to include a process for decrypting and keeping the search index.
 
 
+### Reload scripts
+
+Related to [issue #14](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/14)
+
+You can set `reload_scripts:` in your `mkdocs.yml` with list of script source, to reload and execute some js lib after decryption process.
+
+```yaml
+plugins:
+    reload_scripts:
+        - "./js/example.js"
+```
+
+This feature use the following JQuery function to remove, add and reload javascripts. 
+
+```javascript
+var reload_js = function(src) {
+    $('script[src="' + src + '"]').remove();
+    $('<script>').attr('src', src).appendTo('head');
+};
+```
+
+
 # Contributing
 
 From reporting a bug to submitting a pull request: every contribution is appreciated and welcome.
diff --git a/encryptcontent/decrypt-form.tpl.html b/encryptcontent/decrypt-form.tpl.html
@@ -44,7 +44,7 @@ <h1>{{ summary }}</h1>
                 return false;
             }
         };
-        {% if remember_password %}
+        {% if remember_password -%}
         var setCookie = function(name,value,days,path) {
             /* Set local cookie to store password */
             var expires = "";
@@ -57,13 +57,13 @@ <h1>{{ summary }}</h1>
             if (path) {
                 current_path = "; path=" + path
             }
-            {% if disable_cookie_protection %}
+            {% if disable_cookie_protection -%}
             encryptcontent = name + "=" + encodeURIComponent(value || "") + expires + current_path;
-            {% else %}
+            {%- else -%}
             encryptcontent = name + "=" + encodeURIComponent(value || "") + expires + current_path;
             // add security flag on cookie
             encryptcontent = encryptcontent + "; SameSite=Strict; Secure";
-            {% endif %}
+            {%- endif %}
             return encryptcontent;
         };
         var getCookie = function(name) {
@@ -77,19 +77,24 @@ <h1>{{ summary }}</h1>
             }
             return null;
         };
-        {% endif %}
+        {%- endif %}
+        // Reload scripts src after decryption process
+        var reload_js = function(src) {
+            $('script[src="' + src + '"]').remove();
+            $('<script>').attr('src', src).appendTo('head');
+        };
         var init_decryptor = function() {
             var password_input = document.getElementById('mkdocs-content-password'),
                 encrypted_content = document.getElementById('mkdocs-encrypted-content'),
                 decrypted_content = document.getElementById('mkdocs-decrypted-content'),
-                {% if password_button %}
+                {% if password_button -%}
                 decrypt_button = document.getElementById("mkdocs-decrypt-button"),
-                {% endif %}
+                {%- endif %}
                 decrypt_form = document.getElementById('mkdocs-decrypt-form');
             // Adjust password field width to placeholder length
             let input = document.getElementById("mkdocs-content-password");
             input.setAttribute('size', input.getAttribute('placeholder').length);
-            {% if experimental %}
+            {% if experimental -%}
             // Decrypt sessionStorage search index with password if exist
             var decrypt_search = function(path_location) {
                 sessionIndex = sessionStorage.getItem('encryptcontent-index');
@@ -115,8 +120,8 @@ <h1>{{ summary }}</h1>
                     searchWorker.postMessage({init: true, sessionIndex: sessionIndex});
                 }
             }
-            {% endif %}
-            {% if encrypted_something %}
+            {%- endif %}
+            {% if encrypted_something -%}
             var encrypted_something = {{ encrypted_something }}
             // Decrypt all others elements
             var decrypt_somethings = function() {
@@ -149,7 +154,7 @@ <h1>{{ summary }}</h1>
                     }
                 }
             }
-            {% endif %}
+            {%- endif %}
             // Decrypt content
             var decrypt_action = function() {
                 // grab the ciphertext bundle
@@ -163,14 +168,18 @@ <h1>{{ summary }}</h1>
                     decrypted_content.innerHTML = content;
                     encrypted_content.parentNode.removeChild(encrypted_content);
                     // any post processing on the decrypted content should be done here
-                    {% if arithmatex %}
+                    {% if arithmatex -%}
                     MathJax.typesetPromise()
-                    {% endif %}
-                    {% if hljs %}
+                    {%- endif %}
+                    {% if hljs -%}
                     document.getElementById("mkdocs-decrypted-content").querySelectorAll('pre code').forEach((block) => {
                         hljs.highlightBlock(block);
                     });
-                    {% endif %}
+                    {%- endif %}
+                    {% if reload_scripts | length > 0 -%}
+                    let reload_scripts = {{ reload_scripts }}
+                    for (i = 0; i < reload_scripts.length; i++) { reload_js(reload_scripts[i]); };
+                    {%- endif %}
                 } else {
                     // create HTML element for the inform message
                     var decrypt_msg = document.createElement('p');
@@ -187,64 +196,64 @@ <h1>{{ summary }}</h1>
                     password_input.focus();
                 }
             }
-            {% if remember_password %}
+            {% if remember_password -%}
             /* If remember_password is set, try to use cookie to decrypt content when page is loaded */
             var password_cookie = getCookie('encryptcontent')
             if (password_cookie) {
                 password_input.value = password_cookie
                 decrypt_action();
-                {% if experimental %}
+                {% if experimental -%}
                 decrypt_search(window.location.pathname.substring(1));
-                {% endif %}
-                {% if encrypted_something %}
+                {%- endif %}
+                {% if encrypted_something -%}
                 decrypt_somethings();
-                {% endif %}
+                {%- endif %}
             }
-            {% endif %}
-            {% if password_button %}
+            {%- endif %}
+            {% if password_button -%}
             /* If password_button is set, try decrypt content when button is press */
             if (decrypt_button) {
                 decrypt_button.onclick = function(event) {
                     event.preventDefault();
                     decrypt_action();
-                    {% if experimental %}
+                    {% if experimental -%}
                     decrypt_search(window.location.pathname.substring(1));
-                    {% endif %}
-                    {% if encrypted_something %}
+                    {%- endif %}
+                    {% if encrypted_something -%}
                     decrypt_somethings();
-                    {% endif %}
+                    {%- endif %}
                 };
             }
-            {% endif %}
+            {%- endif %}
             /* Default, try decrypt content when password is send */
             password_input.addEventListener('keydown', function(event) {
                 if (event.key === "Enter") {
                     if (event.ctrlKey) {
-                        {% if remember_password %}
+                        {% if remember_password -%}
                         // set password on cookie with default path=/ (Overwrite specific cookie)
                         // this cookie can by use on all page of your site
                         document.cookie = setCookie("encryptcontent", password_input.value, 1)
-                        {% endif %}
-                        {% if experimental %}
+                        {%- endif %}
+                        {% if experimental -%}
                         // Decrypt all possible values on search index
                         decrypt_search("/");
-                        {% endif %}
+                        {%- endif %}
                     } else {
-                        {% if remember_password %}
+                        {% if remember_password -%}
                         // set password on cookie with specific path=document.location.pathname
                         // this cookie can only be use on this specific page of your site
                         document.cookie = setCookie("encryptcontent", password_input.value, 1, document.location.pathname)
-                        {% endif %}
-                        {% if experimental %}
+                        {%- endif %}
+                        {% if experimental -%}
                         // Only decrypt current page on search index
                         decrypt_search(window.location.pathname.substring(1));
-                        {% endif %}
+                        {%- endif %}
                     }
                     event.preventDefault();
                     decrypt_action();
-                    {% if encrypted_something %}
+                    {% if encrypted_something -%}
                     decrypt_somethings();
-                    {% endif %}
+                    {%- endif %}
                 }
             });
         };
diff --git a/encryptcontent/plugin.py b/encryptcontent/plugin.py
@@ -17,12 +17,12 @@
     string_types = str
 
 JS_LIBRARIES = [
-    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.0.0/core.js',
-    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.0.0/enc-base64.js',
-    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.0.0/cipher-core.js',
-    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.0.0/pad-nopadding.js',
-    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.0.0/md5.js',
-    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.0.0/aes.js'
+    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.1.1/core.js',
+    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.1.1/enc-base64.js',
+    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.1.1/cipher-core.js',
+    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.1.1/pad-nopadding.js',
+    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.1.1/md5.js',
+    '//cdnjs.cloudflare.com/ajax/libs/crypto-js/4.1.1/aes.js'
 ]
 
 PLUGIN_DIR = os.path.dirname(os.path.realpath(__file__))
@@ -64,6 +64,7 @@ class encryptContentPlugin(BasePlugin):
         ('password_button', config_options.Type(bool, default=False)),
         ('encrypted_something', config_options.Type(dict, default={})),
         ('search_index', config_options.Choice(('clear', 'dynamically', 'encrypted'), default='encrypted')),
+        ('reload_scripts', config_options.Type(list, default=[])),
         ('experimental', config_options.Type(bool, default=False)),
     )
 
@@ -111,6 +112,7 @@ def __encrypt_content__(self, content):
             'remember_password': self.config['remember_password'],
             'disable_cookie_protection': self.config['disable_cookie_protection'],
             'encrypted_something': self.config['encrypted_something'],
+            'reload_scripts': self.config['reload_scripts'],
             'experimental': self.config['experimental'],
         })
         return decrypt_form
diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@ def read(fname):
 
 setup(
     name='mkdocs-encryptcontent-plugin',
-    version='1.1.0.1',
+    version='1.2.0.1',
     author='CoinK0in',
     author_email='12155947+CoinK0in@users.noreply.github.com',
     description='A MkDocs plugin that encrypt/decrypt markdown content with AES',
