Skip to content

Beta interpreteur #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MrWaloo wants to merge 5 commits into
base: beta
Choose a base branch
from
Open

Beta interpreteur #94

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
13fe696
Utilisation de la directive shebang
MrWaloo Jun 26, 2025
090debb
Delete version.py
MrWaloo Jun 26, 2025
7fbd5d3
Adaptations suite à la remarque pertinante de kwizer15
MrWaloo Jul 7, 2025
ea69d4e
Adaptations suite à la remarque de Loïc
MrWaloo Jul 17, 2025
bb3fb4e
Améliorations du code
MrWaloo Jul 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions core/class/script.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,15 +228,28 @@ public function execute($_options = null) {
if ($this->getType() == 'info' && isset(script::$_requet_cache[$request])) {
return script::$_requet_cache[$request];
}
$cmd = 'sudo chmod +x ' . explode(' ', $request)[0] . ' 2>/dev/null;';
if (strpos($request, '.php') !== false) {
$first_element = explode(' ', $request)[0];
$use_shebang = false;
$from_path = false;
if (file_exists($first_element)) {
Copy link

@kwizer15 kwizer15 Jul 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je pinaille mais tu peux vérifier avec is_readable au lieu de file_exists. Ca permet de s'assurer aussi qu'on peut lire le fichier.

$env_path = explode(PATH_SEPARATOR, getenv('PATH'));
$from_path = in_array(dirname($first_element), $env_path);
if (!$from_path) {
$shebang = trim(file_get_contents($first_element, false, null, 0, 3));
Copy link

@kwizer15 kwizer15 Jul 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je trouve la méthode très lourde d'aller lire tout le fichier pour au final ne s'intéresser qu'à la première ligne.
C'est plus "complexe", mais utiliser fopen, fgets, fclose serait plus approprié. (ou si tu es intéressé tu peux regarder du côté de SplFile qui est natif et fait la même chose de façon orienté objet)
Ça te permettra de lire uniquement la première ligne et de stopper la lecture.

// Au lieu de file_get_contents avec limit
$handle = fopen($first_element, 'r');
if ($handle) {
    $first_line = fgets($handle);
    fclose($handle);
    $use_shebang = str_starts_with(trim($first_line), '#!/');
}

Copy link
Author

@MrWaloo MrWaloo Jul 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mis à part le fait que str_starts_with est une fonction php8, la fonction file_get_contents ne lit que ce qui lui est passé en paramètre. Là, c'est 3 caractères à partir du début qui seront lus.
https://www.php.net/manual/en/function.file-get-contents.php

Copy link

@kwizer15 kwizer15 Jul 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. C'était un juste exemple et c'est bien vue. J'avais pas fait gaffe aux paramètres offest et length. Du coup tu peux effectivement laisser comme ça.

$use_shebang = $shebang == '#!/';
}
if (!is_executable($first_element)) {
$cmd = 'sudo chmod +x ' . $first_element . ' 2>/dev/null;';
}
}
if (!$from_path && !$use_shebang && substr($request, -4) === '.php') {
Copy link

@kwizer15 kwizer15 Jul 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ca serait plus joli avec un tableau associatif [extension => executable] comme la logique est la même.

$interpreters = [
    '.php' => 'php',
    '.py' => 'python', 
    '.pl' => 'perl',
    '.rb' => 'ruby'
];

$extension = substr($request, strrpos($request, '.'));
if (isset($interpreters[$extension]) && !$from_path && !$use_shebang) {
    $cmd .= $interpreters[$extension] . ' ' . $request;
}

$cmd .= 'php ' . $request;
} elseif (strpos($request, '.rb') !== false) {
$cmd .= 'ruby ' . $request;
} elseif (strpos($request, '.py') !== false) {
$cmd .= 'python ' . $request;
} elseif (strpos($request, '.pl') !== false) {
} elseif (!$from_path && !$use_shebang && substr($request, -3) === '.pl') {
$cmd .= 'perl ' . $request;
} elseif (!$from_path && !$use_shebang && substr($request, -3) === '.py') {
$cmd .= 'python ' . $request;
} elseif (!$from_path && !$use_shebang && substr($request, -3) === '.rb') {
$cmd .= 'ruby ' . $request;
} else {
$cmd .= $request;
}
Expand Down
13 changes: 9 additions & 4 deletions desktop/js/script.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ function addCmdToTable(_cmd) {
tr += '<span class="subType" subType="' + init(_cmd.subType) + '"></span>'
tr += '</td>'

tr += '<td class="tdRequest">'
tr += '<td class="tdRequest" colspan="2">'
tr += '<div class="btn-group" role="group">'
tr += '<span class="input-group" style="margin-top : 5px;">'
tr += '<a style="width:30px" class="btn btn-default browseScriptFile btn-xs roundedLeft" title="{{Parcourir}}"><i class="far fa-folder-open"></i></a>'
Expand All @@ -116,8 +116,12 @@ function addCmdToTable(_cmd) {
tr += '<textarea style="height : 95px;margin-top:5px;" class="cmdAttr form-control input-sm" data-l1key="configuration" data-l2key="request"></textarea>'
tr += '</td>'

tr += '<td class="tdOptions">'
tr += '<div class="requestTypeConfig" data-type="http">'
tr += '<td class="tdOptions" style="display : none;">'

//tr += '<div class="requestTypeConfig" data-type="script">'
//tr += '</div>'

tr += '<div class="requestTypeConfig" data-type="http" style="display : none;">'
tr += '<center>'
tr += '<input type="checkbox" class="cmdAttr" data-l1key="configuration" data-l2key="noSslCheck" />{{Vérifier SSL}} '
tr += '<input type="checkbox" class="cmdAttr" data-l1key="configuration" data-l2key="allowEmptyResponse" style="margin-left : 20px;"/>{{Retour vide}} '
Expand Down Expand Up @@ -184,7 +188,8 @@ function addCmdToTable(_cmd) {
tr += '</div>'
tr += '</div>'
tr += '</div>'
tr += '</td>'

tr += '</td>' // tdOptions

tr += '<td>'
tr += '<label class="checkbox-inline"><input type="checkbox" class="cmdAttr" data-l1key="isVisible" checked/>{{Afficher}}</label> '
Expand Down
2 changes: 1 addition & 1 deletion desktop/php/script.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
<th style="width: 70px;">{{Type}}</th>
<th style="width: 300px;">{{Requête}}</th>
<th style="width: 360px;">{{Paramètres}}</th>
<th style="min-width:260px;width:400px">{{Options}}</th>
<th style="min-width:120px;width:260px">{{Options}}</th>
<th style="width: 100px;">{{Etat}}</th>
<th style="min-width:80px;width:100px;">{{Actions}}</th>
</tr>
Expand Down
6 changes: 6 additions & 0 deletions docs/fr_FR/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@
- Support des images d'équipement personnalisées (Jeedom 4.5)

# xx/07/2025
Copy link

@kwizer15 kwizer15 Jul 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zoic21 me confirmera mais je crois que le changelog est complété lors des merges

Copy link
Author

@MrWaloo MrWaloo Jul 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ce n'est pas moi qui ai rajouté cette ligne

J'ai modifié le descriptif de la PR pour avoir le même changelog que dans le code, pour être sûr qu'il n'y ait qu'une seule version du changelog que je propose.


- Correction de l'erreur d'affichage des options pour un type "HTTP" lors de la création d'une commande alors que le type "script" est sélectionné à ce moment.
- Traitement différent pour les commandes de type Script : le forçage de l'interpréteur selon une règle propre au plugin et qui est incompatible avec certains systèmes (python3 sous Debian 11+) est conditionné afin que le script soit lancé comme s'il l'était dans un shell sauf si le forçage de l'interpréteur est nécessaire.
- Mise à jour de la documentation et petites corrections de celle-ci

# 01/07/2024

- Correction de bug
Expand Down
35 changes: 18 additions & 17 deletions docs/fr_FR/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,23 @@ Vous retrouvez ici la liste des commandes :
- **Nom** : Ce champ contient le nom que vous souhaitez donner à votre commande/information.
- **Icône** : Ce champ permet d’associer une icône à votre nom (dans ce cas Jeedom remplace le nom par l’icône dans le Dashboard).
- **Type de script** :
- Le type **http** : permet d’envoyer une requête vers un équipement externe sans forcément attendre un retour de cette commande. L’exemple qui servira de support au type http sera la configuration d’une requête vers une Vera pour allumer une lumière.
- Le type **script** : sert principalement à lancer des scripts internes à Jeedom. L’exemple qui servira de support au type script sera la configuration du script de monitoring température du raspberry.
- Le type **http** : permet d’envoyer une requête vers un équipement externe sans forcément attendre un retour de cette commande. L’exemple qui servira de support au type http sera la configuration d’une requête vers une Vera pour allumer une lumière.
- Le type **XML** : permet de rapatrier des informations encodées en XML depuis un équipement distant. L’exemple qui servira de support au type XML sera la configuration du script pour interroger un Eco-Device.
- Le type **JSON** : permet de rapatrier des informations encodées en JSON depuis un équipement distant. L’exemple qui servira de support au type JSON sera la configuration du script pour interroger Sickbeard (ou XBMC).
- **le type** et le **sous-type**
- Le champ **requête**
- Ce champ doit contenir la requête en elle-même, ou le chemin du script si le champ "type de script" est script. Le bouton "parcourir" : permet de sélectionner le fichier contenu dans le dossier interne à Jeedom.
- Ce champ doit contenir la requête en elle-même, ou le chemin du script si le champ "type de script" est script. Le bouton "parcourir" permet de sélectionner le fichier contenu dans le dossier interne à Jeedom.

> Ce dossier est accessible en SSH dans ``/var/www/html/plugins/script/data/``. Pour info, la commande SSH pour attribuer les droits ``www-data`` à un fichier est : ``sudo chown www-data:www-data NOMDUSCRIPT.EXTENSION``. A savoir que pour exécuter un script, celui-ci doit avoir les droits www-data.
> Ce dossier est accessible en SSH dans ``/var/www/html/plugins/script/data/``. Pour info, la commande SSH pour que ``www-data`` soit le propriétaire d'un fichier est : ``sudo chown www-data:www-data NOMDUSCRIPT.EXTENSION``. A savoir que pour exécuter un script, celui-ci doit appartenir à ``www-data``.

- Le bouton **Editer** : permet d’éditer à l’aide d’un éditeur de code interne un des fichiers contenus dans le répertoire permettant l’accès au code du fichier.
- Le bouton **Nouveau** : permet de créer un fichier de commande.

> Ne pas oublier de saisir le nom du fichier ainsi que son extension complète sous peine de voir votre superbe script ne pas fonctionner. Sans extension Jeedom ne saura pas reconnaître le langage associé à votre fichier. CF : Généralité
> Ne pas oublier de saisir le nom du fichier ainsi que son extension complète sous peine de voir votre superbe script ne pas fonctionner. Sans extension Jeedom ne saura pas reconnaître le langage associé à votre fichier. Il est possible de contourner ce fonctionnement en précisant l'interpréteur dans la ligne shebang ou en plaçant l'interpréteur en première position de la ligne de commande, ce point est détaillé plus loin.

- Le bouton **Supprimer** : permet de supprimer un fichier de commande.

- Le champ **Options** : Champ avec des options variables suivant le choix du type de script.
- **unité** : unité de la donnée (peut être vide).
- **min/max** : bornes de la donnée (peuvent être vides).
Expand All @@ -61,11 +63,13 @@ Vous retrouvez ici la liste des commandes :

> **Important**
>
> Il faut éviter, autant que possible, dans le chemin du script ou dans les paramètres de celui-ci les caractères spéciaux. Les caractères autorisés étant : les chiffres, les lettres (majuscule ou minuscule)
> Il faut éviter les caractères spéciaux, autant que possible, dans le chemin du script ou dans les paramètres de celui-ci. Les caractères autorisés étant : les chiffres, les lettres (majuscule ou minuscule)

> **Important**
>
> Vous pouvez dans le champs requete (pour http, json, xml) mettre du json, il faut juste le faire preceder de `json::`, exemple `json::{"clef":"valeur"}`
> Dans le champs requête (pour http, json, xml), vous pouvez mettre du json, il faut juste le faire précéder de `json::`, exemple `json::{"clef":"valeur"}`

# Le choix HTTP

![exemple](../images/exemple.png)

Expand Down Expand Up @@ -190,27 +194,24 @@ Action : Lancez le script, via un équipement virtuel, lié à votre script !

Le plus sympa mais pas le plus simple à expliquer.

**Prérequis : savoir développer un script en php, python, perl ou ruby.**
**Prérequis : savoir développer un script**

>**IMPORTANT**
>
> L'extension de votre script doit absolument correspondre à son type. En effet Jeedom se base sur l'extension du script pour l'exécutable à lancer
>
> Si le nom de votre fichier ne contient pas :
>
> - .php .py .pl .rb
>
> - Si le script en première position de la ligne de commande contient une ligne shebang, le plugin script lancera un shell qui l’exécutera en se basant sur la directive de la 1ère ligne (shebang).
> - Si le premier élément de la ligne de commande est un exécutable reconnu par le système, par exemple `/usr/bin/python3`, le plugin script lancera un shell qui exécutera cette ligne de commande.
> - Si le script en première position de la ligne de commande ne contient pas de ligne shebang ET que le premier élément de laligne de commande n'est pas un exécutable reconnu par le système, l'extension de votre script doit absolument correspondre à son type. En effet le plugin script se base alors sur l'extension du script pour l'exécutable à lancer.
Copy link

@kwizer15 kwizer15 Jul 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Manque un espace "laligne"

-ET que le premier élément de laligne de commande n'est pas un exécutable
+ET que le premier élément de la ligne de commande n'est pas un exécutable


Le plugin script lancera un shell qui l’exécutera en se basant sur la directive de la 1ère ligne ( shebang ).
Exemple :
Dans ce dernier cas, si le nom de votre fichier ne termine pas par .php .py .pl ou .rb, le plugin script lancera un shell qui l’exécutera comme en ligne de commande.

```bash
Exemples de ligne shebang :

```
#!/bin/csh -f
#!/bin/ksh
#!/usr/bin/env python3
#!/usr/bin/env php
#!/usr/bin/env node
etc ...
```

Le script de monitoring température du Raspberry va servir d’exemple pour l’utilisation du type de script : Script
Expand Down