diff --git a/README.md b/README.md index 59217bdb..9f3b3e4b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_200] Variable calculation with propertyerror](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_210~1..v1.1_210)) +- [[tutorial v1.1_210] Username is mandatory if a password is set](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_210/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_211~1..v1.1_211)) -# [tutorial v1.1_210] Username is mandatory if a password is set +# [tutorial v1.1_211] redefines the behavior to password mandatory if the user is defined -[Read the tutorial "Username is mandatory if a password is set" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#username-is-mandatory-if-a-password-is-set) +[Read the tutorial "redefines the behavior to password mandatory if the user is defined" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#redefines-the-behavior-to-password-mandatory-if-the-user-is-defined) ## Screenshot @@ -29,7 +29,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_210 +git switch --detach v1.1_211 ``` ## Structure @@ -37,24 +37,25 @@ git switch --detach v1.1_210

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   └── 00-foxyproxy.yml
- └── types
-     └── proxy
-         └── 00_type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   ├── 40-no_proxy.yml
+ │   ├── 50-prompt_authentication.yml
+ │   ├── 55-proxy_dns_socks5.yml
+ │   └── 60-dns_over_https.yml
+ ├── foxyproxy
+ │   ├── 00-foxyproxy.yml
+ │   └── 10-redefine.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


-Contents of the foxyproxy/00-foxyproxy.yml file +Contents of the foxyproxy/10-redefine.yml file ```yml %YAML 1.2 @@ -62,127 +63,18 @@ Contents of the foxyproxy/00-foxyproxy.yml file version: 1.1 proxies: - description: Proxy configuration - _type: leadership - - title: - description: Title or Description - mandatory: false - - type: - description: Proxy Type - choices: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 - - PAC URL - - WPAD - - System (use system settings) - - Direct (no proxy) - default: Direct (no proxy) - - color: - description: Color - regexp: ^#(?:[0-9a-f]{3}){1,2}$ - default: - jinja: >- - #{%- for i in range(6) -%}{{- '0123456789abcdef' | random -}}{%- endfor -%} - description: random color value - auto_save: true - - address: - description: IP address, DNS name, server name - type: domainname - params: - allow_ip: true - allow_without_dot: true - default: - description: copy HTTP address if proxy is not "Manual" - variable: firefox.manual.http_proxy.address - propertyerror: false - disabled: - jinja: |- - {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} - return_type: boolean - description: |- - if type not in: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 - - port: - description: Port - type: port - default: - description: copy HTTP port if proxy is not "Manual" - variable: firefox.manual.http_proxy.port - propertyerror: false - disabled: - jinja: |- - {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} - return_type: boolean - description: |- - if type not in: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 username: - description: Username - type: unix_user - mandatory: - jinja: |- - {% if _.password is not propertyerror and _.password %} - true - {% else %} - false - {% endif %} - return_type: boolean - description: if a password is set - disabled: - jinja: |- - {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} - return_type: boolean - description: |- - if type not in: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 + redefine: true + mandatory: false password: - description: Password - type: secret - mandatory: false - disabled: + redefine: true + hidden: jinja: |- - {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} + {{ not _.username }} return_type: boolean - description: |- - if type not in: - - HTTP - - HTTPS/SSL - - SOCKS4 - - SOCKS5 - - url: - description: URL - type: web_address - default: - description: copy HTTP address if proxy is "Auto" - variable: firefox.auto - propertyerror: false - disabled: - jinja: |- - {{ _.type not in ['PAC URL', 'WPAD'] }} - return_type: boolean - description: |- - if type is not in: - - PAC URL - - WPAD + description: if username is empty ... ``` @@ -291,16 +183,16 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox > **Path**: foxyproxy.proxies\ > `basic` -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. | -| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** | -| **foxyproxy.proxies.color**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value | -| **foxyproxy.proxies.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.
**Validators**:
• type domainname
• the domain name can be a hostname
• the domain name can be an IP
**Default**: copy HTTP address if proxy is not "Manual"
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | -| **foxyproxy.proxies.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: copy HTTP port if proxy is not "Manual"
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | -| **foxyproxy.proxies.username**
[`UNIX user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* *`disabled`* | Username.
**Mandatory**: if a password is set
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | -| **foxyproxy.proxies.password**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Password.
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | -| **foxyproxy.proxies.url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Default**: copy HTTP address if proxy is "Auto"
**Disabled**: if type is not in:
- PAC URL
- WPAD | +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. | +| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** | +| **foxyproxy.proxies.color**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value | +| **foxyproxy.proxies.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.
**Validators**:
• type domainname
• the domain name can be a hostname
• the domain name can be an IP
**Default**: copy HTTP address if proxy is not "Manual"
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: copy HTTP port if proxy is not "Manual"
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.username**
[`UNIX user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Username.
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.password**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* *`disabled`* | Password.
**Hidden**: if username is empty
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Default**: copy HTTP address if proxy is "Auto"
**Disabled**: if type is not in:
- PAC URL
- WPAD | *** @@ -309,18 +201,13 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox ```shell rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml ``` -#### New variables +#### Modified variables -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| **foxyproxy.proxies.username**
[`UNIX user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* *`disabled`* | Username.
**Mandatory**: if a password is set
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | -| **foxyproxy.proxies.password**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Password.
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | - -#### Modified variable - -| Variable | Description | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| -| **foxyproxy.proxies.color**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.color**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value | +| **foxyproxy.proxies.username**
~~`mandatory`~~ [`UNIX user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Username.
**Mandatory**: ~~if a password is set~~
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.password**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* *`disabled`* | Password.
**Hidden**: if username is empty
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | *** @@ -388,6 +275,7 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox > > **Caption:** > - Variable +> - Unmodifiable variable > - Default value > - Modified value > - (:hourglass_flowing_sand: Original default value) @@ -410,11 +298,11 @@ Variables: - :open_file_folder: title (Title or Description) - :notebook: title (Title or Description): An other company ← loaded from the YAML file "config/02/config.yml" - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #d82f2b + - :notebook: color (Color): #d5ce53 - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/02/config.yml" - :notebook: port (Port): 8080 ← loaded from the YAML file "config/02/config.yml" - :notebook: username (Username): null - - :notebook: password (Password): null + - :notebook: password (Password): null *** ### Example 3 @@ -444,13 +332,43 @@ foxyproxy: ```shell rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml ``` -> [!CAUTION] +> [!WARNING] > > - foxyproxy (FoxyProxy) > - proxies (Proxy configuration) -> - username (Username): :stop_sign: mandatory variable at index "0" but has no value +> - password (Password): :bell: variable "password" (Password) at index "0" is hidden, it will be ignored when loading from the YAML file "config/03/config.yml" + +> [!NOTE] +> +> **Caption:** +> - Variable +> - Unmodifiable variable +> - Default value +> - Modified value +> - (:hourglass_flowing_sand: Original default value) + +Variables: +- :open_file_folder: firefox (Firefox) + - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy + - :open_file_folder: dns_over_https (DNS over HTTPS) + - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false +- :open_file_folder: foxyproxy (FoxyProxy) + - :open_file_folder: proxies (Proxy configuration) + - :open_file_folder: title (Title or Description) + - :notebook: title (Title or Description): My company ← loaded from the YAML file "config/03/config.yml" + - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) + - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/03/config.yml" + - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/03/config.yml" + - :notebook: port (Port): 8080 ← loaded from the YAML file "config/03/config.yml" + - :notebook: username (Username): null + - :notebook: password (Password): null + - :open_file_folder: title (Title or Description) + - :notebook: title (Title or Description): An other company ← loaded from the YAML file "config/03/config.yml" + - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) + - :notebook: color (Color): #4fef30 + - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/03/config.yml" + - :notebook: port (Port): 8080 ← loaded from the YAML file "config/03/config.yml" + - :notebook: username (Username): null + - :notebook: password (Password): null *** - - -- [[tutorial v1.1_211] redefines the behavior to password mandatory if the user is defined](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_211/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_211~1..v1.1_211)) diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 2281678c..a6a17e7d 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,8 +1,8 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
+
╭───────────────────── Caption ─────────────────────╮
+│ Variable              Default value               │
+│ Unmodifiable variable Modified value              │
+│                       (⏳ Original default value) │
+╰───────────────────────────────────────────────────╯
 Variables:
 ┣━━ 📂 firefox (Firefox)
 ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
@@ -31,12 +31,12 @@ Variables:
             the YAML file "config/02/config.yml"
             ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file 
             "config/02/config.yml" (⏳ Direct (no proxy))
-            ┣━━ 📓 color (Color): #d82f2b
+            ┣━━ 📓 color (Color): #d5ce53
             ┣━━ 📓 address (IP address, DNS name, server name): 
             proxy.company.net ◀ loaded from the YAML file 
             "config/02/config.yml"
             ┣━━ 📓 port (Port): 8080 ◀ loaded from the YAML file 
             "config/02/config.yml"
             ┣━━ 📓 username (Username): null
-            ┗━━ 📓 password (Password): null
+            ┗━━ 📓 password (Password): null
 
diff --git a/config/03/output_ro.html b/config/03/output_ro.html index c21d5c74..fe234ceb 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,6 +1,47 @@ -
🛑 Caution
-┗━━ foxyproxy (FoxyProxy)
-    ┗━━ proxies (Proxy configuration)
-        ┗━━ username (Username): 🛑 mandatory variable at index "0" but has no 
-            value
+
🔔 Warning
+┗━━ foxyproxy (FoxyProxy)
+    ┗━━ proxies (Proxy configuration)
+        ┗━━ password (Password): 🔔 variable "password" (Password) at index "0" 
+            is hidden, it will be ignored when loading from the YAML file 
+            "config/03/config.yml"
+
+╭───────────────────── Caption ─────────────────────╮
+│ Variable              Default value               │
+│ Unmodifiable variable Modified value              │
+│                       (⏳ Original default value) │
+╰───────────────────────────────────────────────────╯
+Variables:
+┣━━ 📂 firefox (Firefox)
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+┗━━ 📂 dns_over_https (DNS over HTTPS)
+    ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false
+┗━━ 📂 foxyproxy (FoxyProxy)
+    ┗━━ 📂 proxies (Proxy configuration)
+        ┣━━ 📂 title (Title or Description)
+        ┣━━ 📓 title (Title or Description): My company ◀ loaded from the 
+        YAML file "config/03/config.yml"
+        ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file 
+        "config/03/config.yml" (⏳ Direct (no proxy))
+        ┣━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file 
+        "config/03/config.yml"
+        ┣━━ 📓 address (IP address, DNS name, server name): 
+        proxy.company.net ◀ loaded from the YAML file 
+        "config/03/config.yml"
+        ┣━━ 📓 port (Port): 8080 ◀ loaded from the YAML file 
+        "config/03/config.yml"
+        ┣━━ 📓 username (Username): null
+        ┗━━ 📓 password (Password): null
+        ┗━━ 📂 title (Title or Description)
+            ┣━━ 📓 title (Title or Description): An other company ◀ loaded from 
+            the YAML file "config/03/config.yml"
+            ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file 
+            "config/03/config.yml" (⏳ Direct (no proxy))
+            ┣━━ 📓 color (Color): #4fef30
+            ┣━━ 📓 address (IP address, DNS name, server name): 
+            proxy.company.net ◀ loaded from the YAML file 
+            "config/03/config.yml"
+            ┣━━ 📓 port (Port): 8080 ◀ loaded from the YAML file 
+            "config/03/config.yml"
+            ┣━━ 📓 username (Username): null
+            ┗━━ 📓 password (Password): null
 
diff --git a/tree.html b/tree.html index 81c17896..2f98f608 100644 --- a/tree.html +++ b/tree.html @@ -1,17 +1,18 @@

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   └── 00-foxyproxy.yml
- └── types
-     └── proxy
-         └── 00_type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   ├── 40-no_proxy.yml
+ │   ├── 50-prompt_authentication.yml
+ │   ├── 55-proxy_dns_socks5.yml
+ │   └── 60-dns_over_https.yml
+ ├── foxyproxy
+ │   ├── 00-foxyproxy.yml
+ │   └── 10-redefine.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


\ No newline at end of file