TD1 – Paquets PHP Composer, Routage via l'URL

Installer Docker

Allez sur la page du dépôt Serveur Web Docker, et faites le tutoriel d’installation et de configuration qui se trouve dans la partie Tutoriel > Premier contact. Vous ne devez normalement pas y passer plus de 30 minutes.

Lancer votre serveur Web Docker

Démarrer Docker Desktop. Dans l’onglet Gauche Containers, relancez votre conteneur à l’aide du bouton Play .

Pour rappel, ce conteneur exécute un serveur Web PHP. Le port 80 du conteneur est relié par défaut au port 80 de la machine hôte. Le dossier /var/www/html du conteneur est relié par défaut au dossier public_html de la machine hôte.

En pratique, une fois le conteneur lancé, vous accédez aux pages Web situées dans le dossier public_html de la machine hôte en naviguant à partir de l’URL http://localhost via votre navigateur Web.

1. Dupliquez (fork) vous-même ce dépôt GitLab dans votre espace de nom (= votre login IUT). Cette opération est nécessaire pour que vous puissiez pousser vos modifications sur GitLab.

2. Clonez votre dépôt Git dupliqué dans un répertoire public-html/ComplementWeb/TD1 pour pouvoir y accéder via votre conteneur Docker.

3. Dans votre conteneur, déplacez-vous à la racine de ce nouveau répertoire.

4. Il faut donner les droits en lecture / exécution à Apache (utilisateur www-data).

   setfacl -R -m u:www-data:r-x .
   

   Comme le site enregistre une photo de profil pour chaque utilisateur, il faut donner les droits en écriture sur le dossier ressources/img/utilisateurs/.

   setfacl -R -m u:www-data:rwx ./ressources/img/utilisateurs
   

   Dans votre conteneur Docker, exécutez aussi les instructions suivantes :

   chown -R root:www-data .
   chmod g+w ./ressources/img/utilisateurs/
   

5. Importez les tables utilisateurs et publications dans votre base de données SQL préférée :
   • Pour MySQL, vous devez :
     • exécuter le script d’import MySQL,
     • mettre à jour le fichier de configuration src/Configuration/ConfigurationBDDMySQL.php avec votre login et mot de passe.
   • Pour PostgreSQL, vous devez :
     • exécuter le script d’import PostgreSQL,
     • mettre à jour le fichier de configuration src/Configuration/ConfigurationBDDPostgreSQL.php avec votre login et mot de passe,
     • préciser la bonne classe de configuration ConfigurationBDDPostgreSQL au niveau du constructeur de src/Modele/Repository/ConnexionBaseDeDonnees.php
     • dans les classes PublicationRepository et UtilisateurRepository, modifier les $data['nomDeColonne'] pour mettre tous les noms de colonnes en minuscule. En effet, PostgreSQL passe en minuscule tous les identifiants (sauf s’ils sont entourés de guillemets doubles ", auquel car il faudra toujours y faire référence avec des guillemets doubles).

6. Pour plus de confort, vous pouvez éventuellement augmenter la durée de session d’un utilisateur en augmentant la valeur retournée dans la méthode getDureeExpirationSession de la classe src/Configuration/Configuration.php (actuellement réglée sur 120 secondes).

7. Créez un nouvel utilisateur et une nouvelle publication.
   Souvenez-vous bien de votre identifiant et mot de passe car nous nous en resservirons.

8. Faites marcher le site. Explorez toutes les pages.

1. Créer un fichier composer.json à la racine du site Web avec le contenu suivant

   {
      "autoload": {
         "psr-4": {
            "TheFeed\\": "src"
         }
      }
   }
   

2. Si vous modifiez le fichier composer.json, par exemple pour mettre à jour vos dépendances, vous devez exécuter la commande :

   composer update
   

   Aide : Pour ceux qui sont sur leur machine personnelle, vous devrez installer composer sur votre machine. Aller voir la documentation de composer à cet effet. Pour Linux, il suffit d’installer un paquet. Pour Windows avec XAMPP, l’installateur Windows marche très bien.

3. Quand on installe une application ou un nouveau composant, composer place les librairies téléchargées dans un dossier vendor. Il n’est pas nécessaire de versionner ce dossier souvent volumineux.
   Rajoutez donc une ligne /vendor/ à votre .gitignore. Dites aussi à Git d’ignorer son fichier de configuration interne /composer.lock.

4. Modifiez le fichier web/controleurFrontal.php comme suit :

   -use TheFeed\Lib\Psr4AutoloaderClass;
   -
   -require_once __DIR__ . '/../src/Lib/Psr4AutoloaderClass.php';
   -
   -// initialisation en désactivant l'affichage de débogage
   -$chargeurDeClasse = new Psr4AutoloaderClass(false);
   -$chargeurDeClasse->register();
   -// enregistrement d'une association "espace de nom" → "dossier"
   -$chargeurDeClasse->addNamespace('TheFeed', __DIR__ . '/../src');
   +require_once __DIR__ . '/../vendor/autoload.php';
   

   Aide : Ce format montre une modification de fichier, similaire à la sortie de git diff. Les lignes qui commencent par des + sont à ajouter, et les lignes avec des - à supprimer.

5. Testez votre site qui doit marcher normalement.

1. Dans le fichier web/controleurFrontal.php, faites le changement suivant. Toutes les lignes supprimées de ce fichier doivent être déplacées dans la méthode statique traiterRequete d’une nouvelle classe src/Controleur/RouteurQueryString.php.

   -// Syntaxe alternative
   -// The null coalescing operator returns its first operand if it exists and is not null
   -$action = $_REQUEST['action'] ?? 'afficherListe';
   -
   -
   -$controleur = "publication";
   -if (isset($_REQUEST['controleur']))
   -    $controleur = $_REQUEST['controleur'];
   -
   -$controleurClassName = 'TheFeed\Controleur\Controleur' . ucfirst($controleur);
   -
   -if (class_exists($controleurClassName)) {
   -    if (in_array($action, get_class_methods($controleurClassName))) {
   -        $controleurClassName::$action();
   -    } else {
   -        $controleurClassName::afficherErreur("Erreur d'action");
   -    }
   -} else {
   -    \TheFeed\Controleur\ControleurGenerique::afficherErreur("Erreur de contrôleur");
   -}
   +\TheFeed\Controleur\RouteurQueryString::traiterRequete();
   

2. Testez votre site qui doit marcher normalement.

1. Créez une nouvelle classe src/Controleur/RouteurURL.php vide avec le code suivant.

   <?php
   namespace TheFeed\Controleur;
   
   class RouteurURL
   {
      public static function traiterRequete() { }
   }
   

2. Appelez ce nouveau routeur en modifiant web/controleurFrontal.php :

   -TheFeed\Controleur\RouteurQueryString::traiterRequete();
   +TheFeed\Controleur\RouteurURL::traiterRequete();
   

1. Exécutez la commande suivante dans le terminal ouvert au niveau de la racine de votre site web

   composer require symfony/http-foundation
   

   Remarque : Certaines dépendances de Symfony nécessite une version de PHP > 8.1. Si vous n’avez pas cette version sur votre machine personnelle, vous pouvez peut-être demander une version plus ancienne de cette dépendance.

1. Dans RouteurURL::traiterRequete(), initialisez l’instance suivante de la classe Requete

   use Symfony\Component\HttpFoundation\Request;
   
   $requete = Request::createFromGlobals();
   

   Explication : La méthode createFromGlobals() récupère les informations de la requête depuis les variables globales $_GET, $_POST, … Elle est à peu près équivalente à

   $requete = new Request($_GET,$_POST,[],$_COOKIE,$_FILES,$_SERVER);
   

2. La méthode $requete->getPathInfo() permet d’accéder au bout d’URL qui nous intéresse (/publications, /connexion ou /inscription).

   Affichez cette variable dans RouteurURL::traiterRequete() et accédez aux URL précédentes pour voir le chemin s’afficher.

1. Exécutez la commande suivante dans le terminal ouvert au niveau de la racine de votre site web

   composer require symfony/routing
   

2. Créez votre première route avec le code suivant à insérer dans RouteurURL::traiterRequete() :

   use Symfony\Component\Routing\Route;
   use Symfony\Component\Routing\RouteCollection;
   
   $routes = new RouteCollection();
   
   // Route afficherListe
   $route = new Route(
      path: "/publications", 
      defaults: [
         "_controller" => "\TheFeed\Controleur\ControleurPublication::afficherListe",
      ]
   );
   $routes->add("afficherListe", $route);
   

   Explication : Une nouvelle Route $route associe au chemin (paramètre path) /publications la méthode afficherListe() de ControleurPublication (paramètre defaults). Puis cette route est ajoutée dans l’ensemble de toutes les routes RouteCollection $routes.

   On peut éventuellement simplifier en créant directement une instance de Route dans l’appel à $routes->add :

   $routes->add("afficherListe", new Route(
      path: "/publications", 
      defaults: [
         "_controller" => "\TheFeed\Controleur\ControleurPublication::afficherListe",
      ]
   )); 
   

3. Les informations de la requête essentielles pour le routage (méthode GET ou POST, query string, paramètres POST, …) sont extraites dans un objet séparé :

   use Symfony\Component\Routing\RequestContext;
   
   $contexteRequete = (new RequestContext())->fromRequest($requete);
   

   Ajoutez cette ligne et affichez temporairement son contenu.

4. Nous pouvons alors rechercher quelle route correspond au chemin de la requête courante :

   use Symfony\Component\Routing\Matcher\UrlMatcher;
   
   $associateurUrl = new UrlMatcher($routes, $contexteRequete);
   $donneesRoute = $associateurUrl->match($requete->getPathInfo());
   

   Ajoutez ce code et affichez temporairement le contenu de $donneesRoute. Où se trouve l’information de la méthode PHP à appeler ?

5. Ajoutez le code suivant pour appeler enfin l’action PHP correspondante :

   $donneesRoute["_controller"]();
   

   Explication : Ce code exécute la fonction dont le nom est stocké dans $donneesRoute["_controller"].

6. Votre site doit désormais répondre correctement à une requête à l’URL web/controleurFrontal.php/publications, sauf les liens vers le CSS et les photos qui deviennent invalides.

1. Ajoutez la deuxième route :

   use TheFeed\Controleur\ControleurUtilisateur;
   
   // Route afficherFormulaireConnexion
   $route = new Route(
      path: "/connexion", 
      defaults: [
         "_controller" => "\TheFeed\Controleur\ControleurUtilisateur::afficherFormulaireConnexion",
         // Syntaxes équivalentes 
         // "_controller" => ControleurUtilisateur::class . "::afficherFormulaireConnexion",
         // "_controller" => [ControleurUtilisateur::class, "afficherFormulaireConnexion"],
      ]
   );
   $routes->add("afficherFormulaireConnexion", $route);
   

   Notez les syntaxes équivalentes :

   • l’attribut statique constant NomDeClasse::class d’une classe NomDeClasse est remplacé par le nom de classe qualifié, c.-à-d. le nom de classe précédé du nom de package. Ici, ControleurUtilisateur::class a pour valeur la chaîne de caractères \TheFeed\Controleur\ControleurUtilisateur.
   • De manière générale, la valeur associée à _controller devra être au format callable, car c’est ce qui est accepté lorsque l’on fait $donneesRoute["_controller"](). Parmi les callable, on trouve le format "NomDeClasseQualifie::nomMethodeStatique ou ["NomDeClasseQualifie", "nomMethodeStatique"] pour les méthodes statiques, ou encore [$instanceDeLaClasse, "nomMethode"] ou $instanceDeLaClasse->nomMethode(...) pour les méthodes classiques.

2. Testez la page web/controleurFrontal.php/connexion qui doit marcher, sauf les liens vers le CSS et les photos qui deviennent invalides. Cherchez pourquoi ces liens se sont cassés.

   Aide : Dans le code source de la page Web (Ctrl+U), cliquez sur ces liens cassés pour voir sur quel URL ils renvoient.

1. Enregistrez ce fichier de configuration d’Apache fourni par Symfony à la place de web/.htaccess.

   Remarque :

   • Si la réécriture d’URL ne marche pas à l’IUT (message d’erreur Internal Server Error), vous avez peut-être enregistré le fichier dans .htaccess au lieu de web/.htaccess.
   • Si la réécriture d’URL sur votre machine personnelle ne marche pas, une cause possible est qu’il faut activer le module mod_rewrite de votre serveur Apache.

2. Testez que la page web/connexion marche et que le CSS et les images sont revenus. En effet, l’URL de base des liens relatifs est de nouveau web/.

3. Changez les liens dans vueGenerale.php :

   -<a href="controleurFrontal.php?controleur=publication&action=afficherListe"><span>The Feed</span></a>
   +<a href="./publications"><span>The Feed</span></a>
   
   -<a href="controleurFrontal.php?controleur=publication&action=afficherListe">Accueil</a>
   +<a href="./publications">Accueil</a>
   
   -<a href="controleurFrontal.php?action=afficherFormulaireConnexion&controleur=utilisateur">Connexion</a>
   +<a href="./connexion">Connexion</a>
   

1. Modifiez votre routeur pour avoir les 2 routes web/connexion selon la méthode HTTP.

   Attention : Le nom de chaque route doit être unique ($routes->add("nomRoute", $route);). Si vous définissez deux routes avec le même nom, la deuxième écrase la première.

2. Corrigez l’URL vers laquelle renvoie src/vue/utilisateur/formulaireConnexion.php.

3. Essayez de vous connecter au site : vous devez avoir une erreur Uncaught Symfony\...\NoConfigurationException. En effet, si la connexion réussit, alors elle redirige vers l’ancienne adresse web/?action=afficherListe&controleur=publication. Comme cette adresse est désormais inconnue, Symfony nous renvoie NoConfigurationException.

4. Pour régler temporairement le problème des redirections (qui sera traité proprement à la fin du TD), rajoutons une route pour l’URL web/. Dupliquez la route afficherListe en changeant le path (/publications → /) et en donnant une autre nom à la route pour ne pas écraser la précédente.

5. Essayez de vous connecter au site. Cela doit marche normalement.

1. Ajoutez les routes manquantes (sauf celle vers afficherPublications) :
   • URL /deconnexion, méthode GET → action deconnecter du contrôleur utilisateur
   • URL /inscription, méthode GET → action afficherFormulaireCreation du contrôleur utilisateur
   • URL /inscription, méthode POST → action creerDepuisFormulaire du contrôleur utilisateur
   • URL /publications, méthode POST → action creerDepuisFormulaire du contrôleur publication.
     Attention : Il y a déjà une autre route associée à l’URL /publications (action afficherListe). Il faudra donc spécifier que l’autre route est limité à la méthode GET. Pensez-bien à donner des noms uniques à vos routes!
2. Modifiez les liens correspondants dans
   • src/vue/publication/liste.php,
   • src/vue/utilisateur/formulaireCreation.php
   • src/vue/vueGenerale.php.

1. Créez une nouvelle route :
   • URL /utilisateurs/{idUtilisateur}/publications, méthode GET → action afficherPublications du contrôleur utilisateur

2. Modifiez afficherPublications() (de la classe ControleurUtilisateur) pour qu’il prenne $idUtilisateur en argument au lieu de le lire depuis le query string avec $_REQUEST['idUtilisateur'].

   -public static function afficherPublications(): void
   +public static function afficherPublications($idUtilisateur): void
   
   -    if (isset($_REQUEST['idUtilisateur'])) {
   -        $idUtilisateur = $_REQUEST['idUtilisateur'];
   
   -    } else {
   -        MessageFlash::ajouter("error", "Login manquant.");
   -        ControleurUtilisateur::rediriger("publication", "afficherListe");
   -    }
   

   Attention à ne pas supprimer le reste ! La fonction doit toujours faire les autres instructions (récupérer l’utilisateur via le repository, charger la vue, etc.). On supprime seulement la partie qui récupère l’identifiant de l’utilisateur dans $_REQUEST en introduisant un paramètre.

3. Si vous testez la route, vous verrez qu’elle ne marche pas, car $donneesRoute["_controller"]() appelle afficherPublications sans lui donner d’arguments (il attend $idUtilisateur).

4. Affichez $donneesRoute pour voir comment UrlMatcher a extrait idUtilisateur de l’URL.

1. Importez le composant HttpKernel

   composer require symfony/http-kernel
   

2. Faites évoluer le code de RouteurURL en rajoutant à la fin (juste avant $donneesRoute["_controller"]())

   use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
   use Symfony\Component\HttpKernel\Controller\ControllerResolver;
   
   $requete->attributes->add($donneesRoute);
   
   $resolveurDeControleur = new ControllerResolver();
   $controleur = $resolveurDeControleur->getController($requete);
   
   $resolveurDArguments = new ArgumentResolver();
   $arguments = $resolveurDArguments->getArguments($requete, $controleur);
   

   et en modifiant

   -$donneesRoute["_controller"]();
   +$controleur(...$arguments);
   

3. Testez la route web/utilisateurs/19/publications en remplaçant 19 par un identifiant d’utilisateur ayant quelques publications. La page doit remarcher, mais pas le CSS ni les images.

1. Créez une classe src/Lib/Conteneur.php avec le code suivant :

   <?php
   
   namespace TheFeed\Lib;
   
   class Conteneur
   {
      private static array $listeServices;
   
      public static function ajouterService(string $nom, $service) : void {
         Conteneur::$listeServices[$nom] = $service;
      }
   
      public static function recupererService(string $nom) {
         return Conteneur::$listeServices[$nom];
      }
   }
   

2. Initialisez les deux services $assistantUrl et $generateurUrl dans RouteurUrl (avant l’appel à $donneesRoute["_controller"](...arguments)). Puis stockez-les dans le conteneur.

   $generateurUrl = new UrlGenerator($routes, $contexteRequete);
   $assistantUrl = new UrlHelper(new RequestStack(), $contexteRequete);
   
   Conteneur::ajouterService("generateurUrl", $generateurUrl);
   Conteneur::ajouterService("assistantUrl", $assistantUrl);
   

3. Récupérez les deux services en haut de la vue vueGenerale.php.

   use Symfony\Component\HttpFoundation\UrlHelper;
   use Symfony\Component\Routing\Generator\UrlGenerator;
   use TheFeed\Lib\Conteneur;
   
   /** @var UrlGenerator $generateurUrl */
   $generateurUrl = Conteneur::recupererService("generateurUrl");
   /** @var UrlHelper $assistantUrl */
   $assistantUrl = Conteneur::recupererService("assistantUrl");
   

   Puis utilisez-les dans toutes les vues pour passer tous les liens en URL absolues, soit à partir du nom d’une route, soit à partir du chemin relatif d’un asset. À la fin, vous devez avoir corrigé tous les liens : <a href="">, <img src="">, <form action=""> et <link href="">.

   Remarques :

   • $generateurUrl->generate() échappe les caractères spéciaux des URL. Vous devez donc lui donner les données brutes, et non celles échappées par rawurlencode().
   • $assistantUrl->getAbsoluteUrl() n’échappe pas les caractères spéciaux des URL. À vous de le faire.
   • Vous pouvez utiliser la syntaxe raccourcie <?= $var ?> équivalente à <?php echo $var ?> pour améliorer la lisibilité de vos vues.

1. Changer la méthode ControleurGenerique::rediriger() pour qu’elle prenne en entrée le nom d’une route et un tableau optionnel de paramètres pour les routes variables (mêmes arguments que $generateurUrl->generate()). Cette fonction doit maintenant rediriger vers l’URL absolue correspondante. Vous aurez besoin de récupérer un service du Conteneur.

2. Mettez-à-jour tous les appels à ControleurGenerique::rediriger().

3. Testez votre site.