Export de Telegram au format csv – introduction à BeautifulSoup
Quand les petites mains ne suffisent plus pour parcourir des quantités monstrueuses de données.
Quand les expressions régulières sont hors-jeu face au html.
Quand l’agrégation de données dans un beau fichier csv ne semble qu’un rêve lointain.
BeautifulSoup (et Python dans sa globalité) est là !
Il y a quelques temps, la question de comment récupérer l’historique des messages Telegram pour les transférer dans un fichier au format csv a été posée par un des membres d’OpenFacto. Si la réponse vous intéresse, et que vous souhaitez apprendre quelques bases de programmation Python en chemin, vous êtes sur le bon article.
*****
TL;DR : voir le premier paragraphe pour l’export Telegram, le code python html → csv se trouve à la fin.
*****
Export de l’historique Telegram
La version bureautique de Telegram propose une fonctionnalité d’export des messages :
Il est possible de sélectionner les éléments à exporter parmi les messages texte seuls, photos, vidéos, messages vocaux, etc.
A l’issue du téléchargement, on obtient un ensemble de fichiers au format html contenant l’historique récupéré.
Vous vous apprêtez à sortir vos meilleures expressions régulières pour parser ces fichiers ? Retirez immédiatement vos doigts de ce clavier, malheureux ! Les expressions régulières, aussi élégantes soient-elles, ne sont pas adaptées pour parser du html (voir notamment cette fameuse réponse sur StackOverflow). Oui, c’est réalisable, mais le format d’une page html fait qu’en général vous passerez plus de temps à trouver la bonne regex qui matche la bonne balise à chaque fois, que si vous utilisiez un outil créé expressément pour cette tâche.
Ici nous allons faire usage de la librairie Python BeautifulSoup.
Quelques bases pour Python et BeautifulSoup
En programmation, il est recommandé d’utiliser un environnement de développement intégré (IDE en anglais), par exemple VSCodium, logiciel libre, ou Pycharm, spécifique à python. Un IDE est un éditeur de texte exclusivement utilisé pour coder, qui permet par exemple la coloration syntaxique du code, et facilite son écriture en soulignant notamment les librairies non installées, les variables non déclarées/mal orthographiées, etc. Oui, au vu de la taille du code, cela peut s’écrire bêtement sous Vim (ce qui a d’ailleurs été le cas). Cependant, à la longue, un IDE est objectivement appréciable.
Pour pouvoir utiliser une librairie comme csv, permettant de créer/manipuler un fichier csv, on utilise le mot clé import suivi du nom de la librairie. Nous avons également besoin de os, pour la manipulation de noms de fichiers et dossiers. Et pour BeautifulSoup il suffit d’importer une partie seulement de la librairie, à savoir bs4. Si la librairie n’est pas déjà installée sur l’ordinateur, on l’installe via la commande pip install beautifulsoup4, à taper soit dans un terminal classique, soit dans le terminal intégré à l’IDE.
Note : il s’agit d’une simple copie d’écran. Le code complet se trouve à la fin de l’article.
Nous partons ici du postulat que nous plaçons le code dans un fichier (par exemple telegram.py) se trouvant dans le même dossier que l’ensemble des fichiers html récoltés. Nous définissons donc la variable directory, à laquelle on assigne le chemin vers le dossier contenant le fichier python (et donc les fichiers html voisins).
Ensuite, pour créer un tableau csv, avec des lignes, des colonnes, nous allons d’abord créer une liste python (cf. [ ], qui est une liste vide), elle-même constituée de listes : par exemple le n-ième élément de cette liste correspond à la n-ième ligne du tableau, et est implémenté sous la forme d’une liste où le premier élément correspond à la première colonne, le deuxième élément à la deuxième colonne, etc.. En résumé, un tableau = une liste de listes.
Pour une question d’esthétisme et de clarté, nous allons nommer nos colonnes. A cette fin, nous ajoutons (.append()) à la liste (vide) le nom de chaque colonne, la première ligne des fichiers csv étant généralement utilisée pour déterminer les noms des colonnes.
A titre de rappel, Python est un langage faisant usage de l’indentation (tabulation ou quatre espaces) afin de délimiter ses blocs de code (boucle, condition, fonction, classe, etc.). Ici nous allons parcourir (boucle for – ne pas oublier le caractère ‘:’ en fin de ligne, et l’incrémentation de l’indentation) l’ensemble des fichiers contenus dans le dossier directory. Puis si le fichier se termine par l’extension « .html » (condition « if », à nouveau ne pas oublier le caractère ‘:’ et l’incrémentation de l’indentation), alors on l’ouvre en lecture simple.
Avant de nous plonger dans les fonctions offertes par BeautifulSoup, il faut jeter un œil aux fichiers html pour déterminer les informations que nous souhaitons extraire ainsi que leur emplacement.A titre d’exemple, voilà ce qu’un message Telegram peut donner :
<div class="message default clearfix" id="message197514"> <div class="pull_left userpic_wrap"> <div class="userpic userpic2" style="width: 42px; height: 42px"> <div class="initials" style="line-height: 42px"> </div> </div> </div> <div class="body"> <div class="pull_right date details" title="11.02.2020 09:03:59"> 09:03 </div> <div class="from_name"> Toto </div> <div class="text"> 10:03: Hello world ! </div> </div> </div>
On voit qu’un message est délimité par des balises <div> qui ont pour classe message default clearfix.
A l’intérieur de chaque message, l’heure et la date de réception par le serveur se trouvent dans une autre balise <div> dont la classe est pull_right date details, plus exactement en tant que valeur de l’attribut title. De manière similaire, l’expéditeur se trouve dans une balise <div> de classe from_name, à la différence que cette fois il s’agit du texte contenu dans la balise et non de la valeur d’un attribut de cette balise.
Voyons maintenant comment récupérer tout cela avec BeautifulSoup :
- Pour récupérer toutes les balises html correspondant à un critère, on utilise la méthode
findAll(). Il est possible de spécifier notamment le nom de la balise recherchée et la classe.
- Si une seule balise doit être récupérée, on utilise la méthode
find().
- Le contenu d’un attribut de balise s’obtient, comme pour un dictionnaire, en spécifiant son nom dans
.attrs.
- Enfn le contenu d’une balise est lisible via
.text.
Il s’agit ici d’une partie infinitésimale de toutes les fonctions offertes par BeautifulSoup. Sentez-vous libres de lire la documentation pour en découvrir plus !
On notera dans le code ci-dessous que l’heure et la date ont été séparés dans deux variables distinctes afin de créer deux colonnes toutes aussi distinctes. En outre, une condition a été rajoutée dans la récupération du contenu du message pour gérer un cas spécifique à l’historique étudié lors de l’écriture du code.
La méthode .append() permet d’ajouter une nouvelle colonne à la ligne courante row. Une fois la ligne complète, on l’ajoute à la liste de lignes output_rows.
⚠ A noter toutefois que ce code est simplifié au maximum et ne gère pas les erreurs (exceptions) pouvant être levées. Un bon programmeur prendra le temps de vérifier par exemple que la méthode find() ne retourne pas un None – lorsque l’élément cherché n’est pas trouvé – avant d’appliquer une autre méthode sur l’élément retourné, ce qui évitera au programme de planter.
Il ne reste alors plus qu’à écrire le contenu de output_rows dans notre fichier csv. Le fichier peut être ouvert avec le paramètre ‘a’ – et non ‘w’ – si l’on souhaite ajouter (append) de nouvelles données à celles déjà présentes dans le fichier plutôt que d’écraser celles déjà existantes.
Pour faire tourner ce bout de code, il suffit lancer la commande python suivie du nom du fichier (ici telegram.py) dans un terminal, et un fichier output.csv apparaîtra quelques secondes plus tard dans le même répertoire.
Code complet
Ici le code étudié ci-dessus :
from bs4 import BeautifulSoup
import csv
import os
# Placer le script dans le meme repertoire que les fichiers d'historique
directory = os.path.dirname(os.path.realpath(__file__))
# Creation du tableau et des noms de colonnes
output_rows = []
output_rows.append(("Date", "Time", "Sender", "Message"))
for html_file in os.listdir(directory):
filename = os.fsdecode(html_file)
if filename.endswith(".html"):
html = open(filename).read()
soup = BeautifulSoup(html, features="html.parser")
msgs = soup.findAll("div", {"class": "message default clearfix"})
for msg in msgs:
row = []
# Date et heure
time = msg.find("div", {"class": "pull_right date details"}).attrs["title"]
date, time = time.split()
row.extend((date, time))
# Expediteur
row.append(msg.find("div", {"class": "from_name"}).text.strip())
# Message
date_msg = msg.find("div", {"class": "text"}).text
if ": " in date_msg:
msg_alone = date_msg.split(": ")[1].strip()
else:
msg_alone = date_msg.strip()
row.append(msg_alone)
output_rows.append(row)
with open("output.csv", "w") as csv_file:
writer = csv.writer(csv_file)
writer.writerows(output_rows)
Le code mis à jour est disponible sur le dépôt GitHub OpenFacto.
Pour aller plus loin
Scraper les internets
Si Telegram a pris le parti de faire usage du format html pour stocker ses historiques, il n’est pas le seul à l’utiliser : Internet regorge de pages html ! (ce qui est sans doute le principal cas d’application visé au départ par BeautifulSoup, plus que les historiques Telegram…)
Alors pourquoi ne pas employer ces nouvelles connaissances en vue de parcourir (on dira « scraper ») la toile mondiale ?
La seule différence notable est qu’il faudra dans un premier temps récupérer la page html qui nous intéresse. Python met à disposition la librairie request, qu’il suffit d’importer comme précédemment avec le mot clé import. Nous obtenons le contenu de la page via la méthode request() à laquelle nous passons la variable contenant l’url ainsi que, astuce de sioux, un objet headers. Celui-ci permettra de contourner certaines vérifications qui s’assurent que les requêtes sont bien réalisées par un navigateur et non un robot.
Pensez également à mettre un temps de pause (via la méthode sleep()) entre deux requêtes pour éviter de surcharger le serveur requêté – et provoquer un DoS si ce dernier est un peu fragile.
import requests
from random import randint
from time import sleep
useragent = 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:75.0) Gecko/20100101 Firefox/75.0'
headers = {
'User-Agent': useragent
}
url = "" # url du site à requêter
sleep(randint(3,10))
response = requests.get(url, headers = headers)
Crontab
Quid si vous souhaitez aller toujours plus loin dans l’automatisation ? C’est le moment de passer à… cron ! Il s’agit du programme, sous Linux et Mac, permettant de programmer une tâche afin qu’elle soit exécutée de manière répétitive à un moment précis. L’équivalent Windows-ien est le Task Scheduler. Nous allons nous concentrer ici sur cron.
Pour lister les tables cron déjà disponibles, on lance la commande suivante :crontab -l
Pour éditer les tables, on utilise l’option -e :crontab -e
Un doute sur une commande ? On utilise man crontab afin d’afficher le manuel (appuyer sur la touche ‘q’ pour le quitter).
Une fois la commande d’édition lancée, vous vous trouvez dans un éditeur de texte (généralement Vi(m) ou Nano). Pour éditer (entrer dans le mode édition) de Vi(m), appuyez sur la touche ‘i’. Pour sortir de ce mode, appuyez sur la touche echap. Pour quitter le document sans sauvegarder (si, si, c’est possible de quitter Vi(m)), appuyez sur echap puis « :q! ». Pour sauvegarder, echap puis « :w ». Pour plus de commandes : là.
Chaque ligne correspond à une tâche à exécuter et a le format suivant :
mm hh jj MM JJ tâche avec :
- mm : les minutes (0-59) ;
- hh : les heures (0-23) ;
- jj : le jour du mois (0-31) ;
- MM : le mois (1-12, ou les noms) ;
- JJ : le jour de la semaine (0-7, 7 correspondant à dimanche, ou les noms) ;
- tâche : la tâche à exécuter.
Les ranges sont acceptés, tel que 0-15 dans les minutes pour une exécution à chaque minute durant le premier quart d’heure. Le charactère spécial ‘*’ signifie « du premier au dernier », et peut être « divisé », comme avec « */2 » dans les heures pour signifier « toutes les deux heures ».
Par exemple, pour faire tourner un script tous les jours à 23h59 :59 23 * * * /chemin/vers/mon_script.py
Ou toutes les 10 minutes :*/10 * * * * /chemin/vers/mon_script.py
IMPORTANT : ce code est donc exécuté automatiquement suivant la configuration dans la crontab. Il est essentiel que le fichier exécuté soit détenu et éditable par votre utilisateur et seulement votre utilisateur. Si le script est lancé en tant que root (ou autre équivalent à l’administrateur de la machine), il ne doit appartenir qu’à root (ou équivalent) et seulement éditable par lui. Autrement, si votre machine se fait compromettre, un attaquant pourra éditer le script et attendre tranquillement l’exécution automatique de son code malveillant avec les droits de votre utilisateur, ou, pire, ceux de root.
Prenez donc le temps de vérifier les droits sur votre script :
ls -la /chemin/vers/mon_script.py
Les droits inscrits doivent ressembler à quelque chose comme :-rwxrw-r--. 1 nom_utilisteur nom_groupe taille date mon_script.py
Ce qui signifie :
- lecture (r), écriture (w), exécution (x) pour l’utilisateur nom_utilisateur ;
- lecture, écriture pour l’ensemble des utilisateurs appartenant au groupe nom_groupe ;
- lecture seule pour tous les autres utilisateurs.
Utilisez la commande chown nom_utilisateur: mon_script.py pour modifier l’utilisateur et le groupe propriétaires du script.
Utilisez la commande chmod 764 mon_script.py pour positionner les droits ci-dessus.
Au besoin, vérifiez que tous les dossiers parents appartiennent à l’utilisateur en question – ou un utilisateur plus privilégié comme root.