Conf panel: fetching [ ] in a String / Panneau de conf : récupération de [ ] dans un type string

ashledombos · December 11, 2023, 8:45pm

Hello,

I’m encountering an issue while working with a Yunohost configuration form. I need to fetch the first line of a file named prefix and use it as a string in a form field. My getter function seems to be working correctly; however, there’s a problem with how the string is displayed in the form.

Here’s the issue: when the prefix file contains something like [mymailinglist], the form field displays it as [ "mymailinglist"]. I believe the square bracket is causing the form to interpret the input as a list, but I’m not sure how to correct this.

Has anyone faced a similar problem or have any suggestions on how to ensure the string is displayed correctly without being misinterpreted as a list?

Thanks in advane for your help

My getter:

get__prefix() {
    local prefix_file="$control_dir/prefix"
    if [ -f "$prefix_file" ]; then
        head -n 1 "$prefix_file"  
    else
        echo "" 
    fi
}

Bonjour à tous,

Je rencontre un problème avec un formulaire de configuration Yunohost. J’ai besoin de récupérer la première ligne d’un fichier nommé prefix et de l’utiliser comme une chaîne de caractères dans un champ de formulaire. Ma fonction de récupération semble fonctionner correctement ; cependant, il y a un problème avec la façon dont la chaîne est affichée dans le formulaire.

Voici le problème : lorsque le fichier prefix contient quelque chose comme [mamailinglist], le champ du formulaire l’affiche sous la forme de [ "mamailinglist"]. Je pense que le crochet fait que le formulaire interprète l’entrée comme une liste, mais je ne suis pas sûr de savoir comment corriger cela.

Quelqu’un a-t-il déjà rencontré un problème similaire ou a des suggestions sur la façon de s’assurer que la chaîne est affichée correctement sans être mal interprétée comme une liste ?

Merci d’avance pour votre aide !

Mon getter : voir ci dessus

ashledombos · December 28, 2023, 6:40pm

I have opened an issue here, in case someone wants to follow.

github.com/YunoHost/issues

Improper handling of bracket-enclosed strings in configuration panel string form.

opened 05:49PM - 28 Dec 23 UTC

ashledombos

bug

### Describe the Bug YunoHost seems to misinterpret strings enclosed in brack…ets as arrays or lists when retrieving configuration settings [(_ynh_app_config_get_one](https://github.com/YunoHost/yunohost/blob/6c3290d8bf63143b3426006877b607013895aad5/helpers/config#L3C1-L3C24) function). Specifically, when a config value like `[prefix]` is read from a configuration file (in my case it’s a simple file containing the prefix string), it's incorrectly formatted as `[ "prefix"]`, suggesting an erroneous interpretation as a list or array instead of a simple string. I am currently working on a mailing list package, which includes a configuration panel option to modify the subject prefix. The use of brackets to encapsulate prefixes is a common convention, following standard mailing lists practice. For example, a typical mailing list subject might start with [ListName] to clearly indicate the source or category of the email. ### Context - Hardware: KVM, virtual box etc. - YunoHost version: 11.2.8.2 - Access to server: Through SSH and Webadmin - Special context or tweaks: No special context or tweaks applied ### To Reproduce Reproducing the issue involves either creating a YunoHost package with a string field in `config_panel.toml` and retrieving a text of the type `[mytext]` via a bind or a getter, or by directly invoking the relevant functions. The two methods are as follows: 1. **Through Package Creation with `config_panel.toml`:** - Create a YunoHost package or modify an existing one. - Use or add a string field in the `config_panel.toml` file. - Set up the package to retrieve a value like `[mytext]` either through a bind mechanism or a custom getter function. For instance in my case : - Observe how the system handles this string when it's read from the configuration. 2. **By Directly Invoking Functions:** - Directly call the [_ynh_app_config_get_one](https://github.com/YunoHost/yunohost/blob/6c3290d8bf63143b3426006877b607013895aad5/helpers/config#L3C1-L3C24) and [ynh_read_var_in_file](https://github.com/YunoHost/yunohost/blob/6c3290d8bf63143b3426006877b607013895aad5/helpers/utils#L642C4-L642C4) functions with appropriate parameters to simulate the reading of a configuration value like `[mytext]`. - Or more precisely look at the regular expression [var_part](https://github.com/YunoHost/yunohost/blob/6c3290d8bf63143b3426006877b607013895aad5/helpers/utils#L683) ### Expected Behavior The expected behavior is for YunoHost to correctly interpret and display simple strings, even when they are enclosed in brackets. For example, a string `[prefix]` in the config file should be read and displayed as `[prefix]`, not `[ "prefix"]`. ### Approaches for Solution I have two potential solutions in mind : 1. **Modifying Existing Scripts:** - Adjust the `_ynh_app_config_get_one` and `ynh_read_var_in_file` functions to better handle simple strings, especially those enclosed in brackets. This might involve adding conditions to check if a string matches a simple pattern and then extracting it directly without using complex regular expressions. 2. **Adding a Descripteur in `config_panel.toml`:** - Implement a new descriptor (e.g., `file=text`) in `config_panel.toml`. This descriptor would inform `_ynh_app_config_get_one` about the type of content (simple text or complex structure), which would then pass this information to `ynh_read_var_in_file` to adjust the extraction logic accordingly. ### Logs Logs were not applicable at the moment of reporting. The issue is more about the potential improvement in the script logic than a specific error in the system.