Add script reload functionality

CoinK0in · CoinK0in · commit 78ab4beb92be · 2021-08-15T09:49:37.000+02:00
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ Install the package from source with pip:
 ```bash
 cd mkdocs-encryptcontent-plugin/
 python3 setup.py sdist bdist_wheel
-pip3 install dist/mkdocs_encryptcontent_plugin-1.1.0-py3-none-any.whl
+pip3 install dist/mkdocs_encryptcontent_plugin-1.2.0-py3-none-any.whl
 ```
 
 Enable the plugin in your `mkdocs.yml`:
@@ -214,8 +214,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.
@@ -250,8 +252,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.
@@ -275,10 +279,12 @@ 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]
 ```
 
 
@@ -305,6 +311,28 @@ It becomes possible again to make searches on all the pages, even if the content
 If you still want to protect some pages, even though the search index is not encrypted, you can use [mkdocs-exclude-search](https://github.com/chrieke/mkdocs-exclude-search) to exclude parts or complete articles from 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 encrypted_something %}
+            {% if encrypted_something -%}
             var encrypted_something = {{ encrypted_something }}
             // Decrypt all others elements
             var decrypt_somethings = function() {
@@ -121,7 +126,7 @@ <h1>{{ summary }}</h1>
                     }
                 }
             }
-            {% endif %}
+            {%- endif %}
             // Decrypt content
             var decrypt_action = function() {
                 // grab the ciphertext bundle
@@ -138,14 +143,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');
@@ -162,7 +171,7 @@ <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) {
@@ -172,8 +181,8 @@ <h1>{{ summary }}</h1>
                 decrypt_somethings();
                 {% endif %}
             }
-            {% endif %}
-            {% if password_button %}
+            {%- endif %}
+            {% if password_button -%}
             if (decrypt_button) {
                 decrypt_button.onclick = function(event) {
                     event.preventDefault();
@@ -183,10 +192,10 @@ <h1>{{ summary }}</h1>
                     {% endif %}
                 };
             }
-            {% endif %}
+            {%- endif %}
             password_input.addEventListener('keydown', function(event) {
                 if (event.key === "Enter") {
-                    {% if remember_password %}
+                    {% if remember_password -%}
                     if (event.ctrlKey) {
                         // set password on cookie with default path=/ (Overwrite specific cookie)
                         // this cookie can by use on all page of your site
@@ -196,12 +205,12 @@ <h1>{{ summary }}</h1>
                         // 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 %}
+                    {%- 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
@@ -62,6 +62,7 @@ class encryptContentPlugin(BasePlugin):
         ('password_button_text', mkdocs.config.config_options.Type(string_types, default=str(settings['password_button_text']))),
         ('encrypted_something', mkdocs.config.config_options.Type(dict, default={})),
         ('decrypt_search', mkdocs.config.config_options.Type(bool, default=False)),
+        ('reload_scripts', mkdocs.config.config_options.Type(list, default=[])),
     )
 
     def __hash_md5__(self, text):
@@ -108,6 +109,7 @@ def __encrypt_content__(self, content):
             'remember_password': self.remember_password,
             'disable_cookie_protection': self.disable_cookie_protection,
             'encrypted_something': self.encrypted_something,
+            'reload_scripts': self.reload_scripts,
         })
         return decrypt_form
 
@@ -185,7 +187,12 @@ def on_pre_build(self, config):
         setattr(self, 'decrypt_search', False)
         if 'decrypt_search' in plugin_config.keys():
             decrypt_search = self.config.get('decrypt_search')
-            setattr(self, 'decrypt_search', decrypt_search)            
+            setattr(self, 'decrypt_search', decrypt_search)
+        # Check if some script need to be reloaded after decryption process
+        setattr(self, 'reload_scripts', [])
+        if 'reload_scripts' in plugin_config.keys():
+            reload_scripts = self.config.get('reload_scripts')
+            setattr(self, 'reload_scripts', reload_scripts)
 
     def on_page_markdown(self, markdown, page, config, **kwargs):
         """
diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@ def read(fname):
 
 setup(
     name='mkdocs-encryptcontent-plugin',
-    version='1.1.0',
+    version='1.2.0',
     author='CoinK0in',
     author_email='12155947+CoinK0in@users.noreply.github.com',
     description='A MkDocs plugin that encrypt/decrypt markdown content with AES',
@@ -35,7 +35,9 @@ def read(fname):
         'Programming Language :: Python',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7'
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9'
     ],
     packages=find_packages(exclude=['*.tests']),
     entry_points={
