Ce site est optimisé pour être consulté depuis un navigateur moderne dans lequel JavaScript est activé.

script pour invitation Matrix par email

vincent

J’ai concocté un petit script bash qui vise à simplifier légèrement l’invitation de personnes sur le serveur Matrix de club1.

il se base sur la commande matrixtoken, et sert surtout à rajouter un petit texte sympa pour la personne qui recevra l’email.

Pour l’instant je l’ai appelé matrixtoken-mail, mais peut-être qu’il y a mieux ?

Voici ce qu’il contient :

#!/bin/bash

if test -z "$1"
then
	echo 'mail address ?'
	read mailAddr
else
	mailAddr="$1"
fi


token=$(matrixtoken)
#token='testT0k3n'

mutt -s 'Invitation Matrix sur le serveur club1.fr' -- "$mailAddr" \
<<EOF
Voici un code d'invitation pour le serveur Matrix de club1.
Il te permet de te créer un compte en allant sur <https://riot.club1.fr/#/register>.

Jeton à copier :

${token}

Ce jeton expirera dans 30 jours.

Plus d'information sur le serveur Matrix de club1 :
<https://club1.fr/matrix>
EOF

if test $? -eq 0
then
	echo "invitation sent to ${mailAddr} with token '${token}'"
fi

Amélioration possibles :

lire le fichier de config qui définit la durée d’expiration des jetons.

Si ça vous plaît, je propose de rajouter ça dans les scripts publiques !

nicolas

vincent lire le fichier de config qui définit la durée d’expiration des jetons.

Ça ne va pas être possible. Le but même de matrixtoken est de permettre aux membres de créer un compte sans avoir accès en lecture au fichier de config. Par contre je peux ajouter une option à matrixtoken pour afficher une partie de la config actuelle.

vincent

nicolas Par contre je peux ajouter une option à matrixtoken pour afficher une partie de la config actuelle.

Haha marrant, mais bon, c’est très bonus tout ça 😅.

vincent

Voici le script mis à jour après la nouvelle version de la commande matrixtoken :

#!/bin/bash

if test -z "$1"
then
	echo 'mail address ?'
	read mailAddr
else
	mailAddr="$1"
fi

jsonToken=$(matrixtoken -j)


expire=$(echo "$jsonToken" | jq '.expiry_time // ""' --raw-output)
token=$(echo "$jsonToken" | jq '.token // ""' --raw-output)

# used for testing
# token='testT0k3n'
# expire='1625394937000'


expireMsg='';

if test -n expire
then
	expire="${expire%???}"
	expireDate="$(LC_TIME='fr_FR.utf8' date -d @${expire} +'%A %-d %B %Y à %R')"
	expireMsg="Ce jeton expirera le ${expireDate}"
fi


mutt -s 'Invitation Matrix sur le serveur club1.fr' -- "$mailAddr" \
<<EOF
Voici un code d'invitation pour le serveur Matrix de club1.
Il te permet de te créer un compte en allant sur <https://riot.club1.fr/#/register>.

Jeton à copier :

${token}

${expireMsg}

Plus d'information sur le serveur Matrix de club1 :
<https://club1.fr/matrix>
EOF

if test $? -eq 0
then
	echo "invitation sent to ${mailAddr} with token '${token}'"
fi

amélioration notable :

le script affiche la date officielle de péremption du jeton (ce n’est plus hardcodé) dans un français impecable.

nicolas

Il faudrait juste checker si matrixtoken renvoie une erreur et ne pas envoyer un email foireux si c’est le cas. Tu peux assez facilement tester en utilisant l’option -c que tu fais pointer sur n’importe quel fichier.

vincent

nicolas OK ! merci !

Et voici :

#!/bin/bash
# send a Matrix invitation token by email
# email can be provided as first argument, otherwise, it will be asked interactively

if test -z "$1"
then
	echo 'mail address ?'
	read mailAddr
else
	mailAddr="$1"
fi

jsonToken=$(matrixtoken -j)

if test "$?" != 0
then
	exit 1
fi

expire=$(echo "$jsonToken" | jq '.expiry_time // ""' --raw-output)
token=$(echo "$jsonToken" | jq '.token // ""' --raw-output)

# used for testing
# token='testT0k3n'
# expire='1625394937000'


expireMsg='';

if test -n expire
then
	expire="${expire%???}"
	expireDate="$(LC_TIME='fr_FR.utf8' date -d @${expire} +'%A %-d %B %Y à %R')"
	expireMsg="Ce jeton expirera le ${expireDate}"
fi


mutt -s 'Invitation Matrix sur le serveur club1.fr' -- "$mailAddr" \
<<EOF
Voici un code d'invitation pour le serveur Matrix de club1.
Il te permet de te créer un compte en allant sur <https://riot.club1.fr/#/register>.

Jeton à copier :

${token}

${expireMsg}

Plus d'information sur le serveur Matrix de club1 :
<https://club1.fr/matrix>
EOF

if test $? -eq 0
then
	echo "invitation sent to ${mailAddr} with token '${token}'"
fi

vincent

Youpi ! c’est ajouté !

Voici le fichier au sein du repo Git « hosting » :
https://github.com/club-1/hosting/blob/master/src/matrixinvite.sh

On vient même de rajouter ça à la doc :

https://club1.fr/docs/fr/services/matrix.html#commande-matrixinvite

vincent

Je copie ici la judicieuse remarque de @yann dans cette issue Github :

Il manque une option --help qui aiderait à utiliser la commande en plus de la documentation.

Je me permet donc de ré-ouvrir ce ticket pour ne pas oublier !

yann

Décidément, entre quand je pose mes questions sur le Matrix et quand je les pose sur GitHub, à chaque fois j’me trouve des excuses pour éviter le forum haaaaaa pardon !!!

Oui voilà, une --help ou une entrée man ça serait très chouette, même si euh bin voilà je me rends bien compte que le script est très très simple d’usage.

vincent

yann Oui voilà, une –help ou une entrée man ça serait très chouette, même si euh bin voilà je me rends bien compte que le script est très très simple d’usage.

J’ai fait à l’instant une proposition d’ajout :
https://github.com/club-1/hosting/pull/83

$ matrixinvite --help
Send a Matrix invitation token by email.

Usage: matrixinvite [EMAIL_ADDRESS]

Email address can be provided as first argument,
otherwise, it will be asked interactively.
  
  --help, -h            print this help

Source code: <https://github.com/club-1/hosting/blob/master/src/matrixinvite.sh>
Club1 doc: <https://club1.fr/docs/fr/services/matrix.html#commande-matrixinvite>

nicolas

vincent J’ai fait à l’instant une proposition d’ajout

C’est mergé et déployé, donc je referme ce ticket.

yann c’est sûrement bien que matrixtoken reste le plus indépendant possible

C’est le plan oui, matrixtoken est la brique du bas et elle a vocation à être le plus basique et générique possible. Pour la documentation, je pense que comme le dit @vincent elles sont décrites toutes les deux dans la doc et c’est vraiment par ce biais qu’elle seront découvertes de toutes façon donc ça devrait aller.

yann

Ahh super oui ! D’ailleurs je me suis demandé à un moment si la documentation de matrixtoken ne devrait pas indiquer l’existence de matrixinvite d’une manière ou d’une autre, mais en y réfléchissant deux secondes je me dis que c’est sûrement bien que matrixtoken reste le plus indépendant possible.

vincent

yann Au moins le rapprochement est fait au niveau de la doc vu qu’elles sont documentés sur la même page.

yann

Oui c’est très bien comme ça en effet :) merci beaucoup d’avoir pris ce temps !