Réussir. son site e-commerce. avecoscommerce

Transcription

1 N i c odavid l a s Mercer C h u A d a p t é p a r S a n d r i n e B u r r i e l Réussir son site e-commerce avecoscommerce

2 annexe A

3 Dépannage SOMMAIRE Un code sans bogues est un doux rêve inaccessible. Plutôt que de prier pour ne jamais y être confronté, voici les outils qui vous permettront de leur faire face... B Types d erreurs B Processus de traitement B Débogage de code MOTS-CLÉS B Erreurs de syntaxe B Erreurs d exécution B Erreurs logiques B Débogage

4 Créer son site e-commerce avec oscommerce À SAVOIR Irrécupérable N oubliez pas que si vous parvenez à une situation pire que tout ce que vous pouviez imaginer et que votre site n est, pour une raison ou une autre, pas réparable, la solution la plus simple consiste à tout effacer et à repartir de votre dernière sauvegarde. Au cours de votre carrière, vous rencontrerez des erreurs dans votre code. Quelle que soit la minutie avec laquelle vous travaillez, les problèmes ne manqueront pas d apparaître. Les erreurs (plus couramment désignées sous le nom de bogues) sont en fait devenues si courantes que toute grande société se doit de mettre en place des programmes exhaustifs de tests et de débogage, qui durent parfois des mois, avant de pouvoir considérer un nouveau logiciel comme suffisamment stable. Même après cela, comme vous en avez probablement fait l expérience, il subsiste des problèmes qui sont passés à travers les mailles du filet et qui nécessitent des correctifs ou des mises à jour. Du fait que les bogues font, en quelque sorte, partie intégrante de l existence d un logiciel, il est plus sain d apprendre à les gérer correctement que d espérer les éviter totalement. Cette annexe vous propose quelques méthodes intéressantes et vous donne également le processus optimal pour traiter les erreurs. À SAVOIR Contrôler les niveaux d avertissement Vous contrôlez les niveaux d avertissement et leur affichage dans le fichier de configuration de PHP, php.ini. EXEMPLE Chemins des fichiers Les chemins d accès aux fichiers sont parfois différents entre votre machine de développement et votre site, ce qui conduit à des liens brisés, des pertes de fichiers ou des interruptions de connexions. EXEMPLE Une erreur logique aux conséquences graves Le fait de taper accidentellement un signe plus (+) au lieu d un signe moins (-) n apparaîtra ni comme une erreur d exécution, ni comme une erreur de syntaxe ; en revanche, cela affectera visiblement le résultat d un calcul. Les effets peuvent en être désastreux si ce code est intégré au calcul de facturation. Types d erreurs Nous avons vu au chapitre 1 qu il existe trois principaux types d erreurss auxquels vous pouvez être confrontés : Les erreurs de syntaxe Ces erreurs empêchent PHP d exécuter effectivement votre code ; elles présentent toutefois l avantage d être assez faciles à localiser si vous avez mis en place un système de notification sur votre machine de développement. Bien entendu, une fois que votre site est en production, il n est pas souhaitable que les erreurs internes du système puissent être affichées à l écran : ce type de notification peut en effet donner à des utilisateurs malintentionnés les moyens de glaner des informations sur votre système. Les erreurs d exécution Les erreurs de ce type sont légèrement plus graves que les erreurs de syntaxe car elles ne sont pas tout à fait aussi évidentes ou faciles à localiser. Les erreurs d exécution se produisent dans différents cas de figure, que vous identifiez généralement grâce à des tests approfondis menés aussi bien sur votre site en production que sur votre machine de développement. Si ces erreurs n apparaissent pas lors de l analyse du script PHP, elles deviendront en revanche visibles au cours de son exécution. Les erreurs logiques Elles sont très sournoises car elles n apparaissent pas réellement. C est à vous qu il incombe de voir si votre site fonctionne comme il le devrait. 426

5 Il est important que vous puissiez déterminer par vous-même le type d erreur qui s est produit. Cela nécessite souvent d avoir un peu d expérience pour réaliser ce que signifie un message d erreur, car PHP ne peut isoler systématiquement l endroit exact où le bogue s est produit. Si vous vous êtes déjà retrouvé face à des messages d erreur sibyllins, nous vous conseillons de lire la section «Déboguez vous-même le code» : vous y trouverez de l aide sur un large éventail de problèmes. A Dépannage Un processus efficace pour gérer les erreurs Lorsque vous êtes confronté à un bogue dont la solution n est pas triviale, utilisez le processus suivant pour le résoudre (figure A-1). Figure A 1 Processus de résolution d erreur 427

6 Créer son site e-commerce avec oscommerce MÉTHODE Progression Gardez à l esprit qu à chaque fois que vous essayez de résoudre un problème dans votre code, vous en apprenez davantage sur le logiciel, ce qui vous aidera à résoudre la prochaine erreur. Comme vous pouvez le constater, tenter de résoudre vous-même le problème constitue la première étape du processus. Si ce n est pas possible, le processus élargit progressivement l étendue des solutions à envisager. Toutefois, il faut idéalement éviter de mener cette tentative de résolution jusqu à des recherches de plusieurs heures sur Internet. L idée est plutôt de parvenir à gérer vous-même le problème et à poursuivre votre travail. Pour réussir ceci avec un degré de confiance suffisant, vous aurez besoin : d expérience ; d une boîte à outils pour la résolution de problèmes. Il n est malheureusement pas possible d acquérir une expérience suffisante à travers la lecture d un livre ; la section suivante présentera donc quelques outils qui vous aideront à accomplir votre tâche ; quant à l expérience que vous engrangerez, cela dépend simplement de vous. Une fois que vous posséderez quelques astuces du métier, vous découvrirez que la résolution de problèmes peut devenir, la plupart du temps, une occupation satisfaisante. Déboguez vous-même votre code Commençons par étudier quelques-uns des problèmes de syntaxe, qui sont les plus simples à résoudre. PHP peut renvoyer un large éventail d avertissements différents, suivant l emplacement du problème et l erreur provoquée. Imaginons que vous ayez ajouté une ligne dans votre code afin de réaliser une tâche particulière (vous avez pu souhaiter ajouter une instruction echo supplémentaire). Lorsque vous exécutez votre script, vous obtenez toutefois le résultat de la figure A-2. Figure A 2 Une erreur de syntaxe dans notre fichier feed.php T T_VARIABLE Une T_VARIABLE est simplement le nom PHP d une variable définie dans votre script. L étude de ce message vous apprend qu à la ligne 94 du script feed.php, l interpréteur PHP s attend à trouver une virgule (,) ou un point-virgule (;) mais qu au lieu de cela, il trouve un objet appelé une T_VARIABLE. Si nous étudions plus précisément cet emplacement dans le fichier, nous y trouvons le code suivant : } else{ echo "previous"; } 428

7 echo "</td><td align=center width='30%'>" $i=0; $l=1; for($i=0;$i < $numrows;$i=$i+$limit){ A Dépannage Voyez-vous l erreur? Nous avons simplement oublié de terminer notre instruction echo par un point-virgule, PHP ne réalise donc pas que la ligne est terminée et tombe sur $i de manière inattendue. Il suffit d ajouter un point-virgule pour résoudre le problème et le script s exécute à nouveau normalement. Pour le moment, tout va bien, mais que faire au sujet d autres types d erreurs de syntaxe? Que pouvons-nous attendre de la part de PHP si, par exemple, nous oublions une accolade deux lignes au-dessus de l instruction echo? Nous pourrions raisonnablement supposer que PHP indique qu il manque une accolade sur la ligne 92. Tentons donc de supprimer cette accolade fermante correspondant à l instruction else dans l extrait de code précédent (figure A-3). Figure A 3 Une nouvelle erreur de syntaxe Voilà qui ne nous aide pas particulièrement. La ligne 156 est la toute dernière ligne du script, or nous savons déjà que c est la ligne 92 qui est en cause. Comment les choses ont-elles pu déraper ainsi, et que tente de nous indiquer PHP? Le problème réside ici dans le fait que PHP ne sait pas réellement ce que fait votre programme ; il se contente de partir du principe que vous savez ce que vous faites. Ainsi, lorsque vous ouvrez une accolade, il traitera tout ce qui suit comme les éléments d un même bloc de code, jusqu à trouver l accolade fermante correspondante même si cela ne correspond pas à vos intentions. Dans notre cas, il n y a aucune accolade fermante correspondant à celle de l instruction else, PHP nous indique donc : Je suis parvenu jusqu à la fin du fichier, mais ce n est pas ce que j attendais car vous n avez pas rédigé correctement la fin de votre script. C est ici qu il est utile d avoir un bon éditeur PHP. Si vous utilisez un environnement de développement comme Zend, l éditeur de scripts est spécifiquement adapté à PHP : cela peut souvent vous aider à localiser des problèmes comme celui que nous venons de décrire. En effet, les éditeurs de texte spécialisés indentent automatiquement le code, ce qui permet de repérer d un simple coup d œil des problèmes comme le nôtre. Comparez les mises en page des figures A-4 (sans indentation) et A-5 (avec indentation). 429

8 Créer son site e-commerce avec oscommerce Figure A 4 Notre fichier feed.php vu par le Bloc-notes de Windows Figure A 5 Le même fichier ouvert dans l éditeur Zend OUTILS Quelques éditeurs de texte de base Un certain nombre d outils de base peuvent vous aider à travailler sur votre code, sans forcément installer un environnement de développement complet. Sous Windows : WordPad gère généralement mieux le code que le Bloc-notes, en particulier pour les fichiers en provenance d un serveur Linux. Sous Linux : vi et emacs (pour ne froisser personne) sont deux excellents éditeurs de texte qui permettent la coloration syntaxique, l indentation du code, etc. À partir de cette simple capture d écran, nous remarquons immédiatement qu il manque une accolade entre la quatrième et la cinquième instruction echo visibles à l écran. Comment? Observez l indentation du code : si la cinquième instruction echo faisait partie du bloc else, elle serait indentée de la même manière. Bien sûr, tout ceci manque un peu de naturel, mais vous saisissez l idée : assurez-vous d avoir un éditeur de code digne de ce nom avant toute tentative sérieuse de débogage. Que faire au sujet de problèmes plus épineux, comme des erreurs dans la logique même du code? Vous avez peut-être remarqué que, bien que PHP ne renvoie aucune erreur, votre page web ne se comporte pas comme vous l attendez. Des problèmes comme ceux-ci nécessitent une approche légèrement plus sophistiquée. Supposons, par exemple, qu en visualisant la page feed.php dans votre navigateur, vous remarquiez que la navigation en bas de page ne fonctionne pas correctement (figure A-6). 430

9 A Dépannage Figure A 6 Une erreur dans les liens de navigation de la page d actualités technologiques La capture d écran met également en lumière pourquoi il est primordial de tout tester de manière approfondie. Voyez-vous le problème? Les liens de navigation au bas de la page montrent qu il n y a qu une seule page ; mais vous pouvez clairement constater qu il est possible de suivre le lien Suivant. Cela implique donc qu il y a plus de cinq objets dans le flux. Nous avons donc un problème : ou bien il n y a que cinq objets dans le flux RSS, auquel cas le lien Suivant ne doit pas être actif ; ou bien il y a plus de cinq éléments et il doit alors y avoir plus d une page de résultats. Que faisons-nous dans un cas semblable? Il n y a aucune erreur, aucun avertissement pour nous guider, nous devons donc nous en sortir seuls. Par chance, une grande partie de l analyse du problème a déjà été effectuée car nous savons comment cette partie de l application est censée se comporter. En d autres termes, le problème est simple à comprendre (ce qui ne signifie pas nécessairement qu il soit simple à résoudre, mais c est une étape importante dans sa résolution). De surcroît, nous avons déjà avancé deux explications plausibles pour ce problème. Soit le lien Suivant ne se comporte pas correctement, soit c est l affichage du nombre de pages qui pose problème. Quelle est l étape suivante? Devons-nous nous précipiter sur le code pour tenter de le corriger? Pas encore : il nous reste encore une chose à faire afin de clarifier le problème. Puisque nous avons accès à la base de données, essayons de voir combien d enregistrements s y trouvent réellement : cela nous indiquera si nous devrions avoir plus de pages que ce qui est affiché. Une petite visite à la ligne de commandes MySQL nous donne les informations désirées (figure A-7). Nous trouvons dix éléments dans la table d alimentation du flux : cela signifie donc que l erreur se situe au niveau de l affichage du nombre de pages. Allons-nous le corriger tout de suite? Non, toujours pas : ce n est pas parce que le nombre de pages est erroné que les liens Suivant et Précédent ne posent pas de problème. Testons-les donc rapidement avant toute autre chose. Avec dix lignes dans la base de données, nous nous attendons à ce que la première page comporte un lien Précédent inactif et un lien Suivant actif. Si nous cliquons sur le bouton Suivant, la page suivante devrait comporter un lien Précédent actif, un lien Suivant inactif, et 431

10 Créer son site e-commerce avec oscommerce afficher plusieurs informations. Tester ce point nous permet de confirmer que les liens fonctionnent correctement (figure A-8). Figure A 7 Vérification du nombre d enregistrements dans la table feed Figure A 8 Vérification du fonctionnement des liens de navigation 432 MÉTHODE Faire table rase Lorsque vous déboguez, essayez autant que possible de ne faire aucune hypothèse quant à la nature de l erreur. Avant de poursuivre, nous devons faire quelques remarques. Tout d abord, l affichage du nombre de pages et les liens peuvent fonctionner pour un nombre d enregistrements donné. Cependant, même si c est le cas, vous ne devez pas partir du principe qu ils fonctionnent pour n importe quel nombre d informations. La page doit au contraire être testée pour un large éventail de valeurs, afin de s assurer de son bon fonctionnement. De plus, si les liens Précédent et Suivant ne fonctionnaient pas, vous ne pourriez alors faire aucune hypothèse sur la nature du problème : les erreurs sur la pagination et sur les liens peuvent avoir soit des causes distinctes, soit une origine commune, ce que vous ne pouvez pas déduire des informations en votre possession. Nous pouvons maintenant considérer que le problème a été relativement bien analysé. Nous comprenons comment le code est censé fonctionner et nous avons rassemblé des informations qui nous permettent d éliminer certaines possibilités tout en confirmant certains soupçons. Après ces étapes, il est encore nécessaire de maintenir, autant que possible, une vision claire des choses : souvent, les problèmes ont des causes très inattendues ou subtiles, qui sont d autant plus difficiles à déceler si la réflexion se base principalement sur des hypothèses. Puisque l analyse

11 est terminée, nous devons maintenant examiner le code afin de comprendre la nature du problème. C est ici que certaines astuces peuvent se révéler utiles. Deux des questions les plus courantes auxquelles un programmeur doit pouvoir répondre sont : Quelles valeurs possèdent les variables à un instant donné de l exécution du programme? Comment le programme s exécute-t-il? À ce stade, il est intéressant de mentionner l existence des environnements de développement intégrés, qui aident à développer et déboguer du code. Tous les outils de cet environnement interagissent pour que vous produisiez un code de meilleure qualité, et que vous déboguiez et analysiez le code que vous avez déjà rédigé. Beaucoup d entre eux sont payants (particulièrement si vous travaillez sous Windows). Si toutefois vous préférez investir votre argent ailleurs que dans des outils de développement, un éditeur librement disponible comme Dev-PHP pourra vous intéresser. Vous pouvez néanmoins découvrir efficacement le contenu des variables aussi bien que les détails d exécution du programme en utilisant les méthodes suivantes : renvoyer à l écran, grâce à l instruction echo, le contenu des variables ; renvoyer à l écran, grâce à l instruction echo, des marqueurs d exécution du programme. Voyons comment tout ceci peut nous aider à résoudre notre problème d affichage. Nous savons que, selon toute probabilité, nous sommes face à un problème qui concerne uniquement l affichage du nombre de pages : concentrons donc nos efforts sur l étude de ce qui se passe sous le capot. Avec un peu de chance, cela nous révélera l endroit où se produit l erreur, que nous pourrons alors corriger. Commençons par le commencement, et trouvons la section de code correspondante : OUTILS Environnement de développement Zend Zend, société créée par deux importants contributeurs de PHP, propose un studio de développement spécialement dédié à ce langage. Il s agit d une suite d outils destinés à faciliter le développement et le débogage. Un tel environnement met, par exemple, à votre disposition : un analyseur de code ; un outil de complétion de code ; la coloration syntaxique ; un gestionnaire de projets ; un éditeur de code ; un outil de débogage graphique ; des assistants. B zend-studio A Dépannage $i=0; $l=1; for($i=0;$i < $numrows;$i=$numrows+$limit){ if($i <> $start){ echo " <a href='". tep_href_link(filename_feed). '&start='. $i. "'>". $l. "</a> "; } else { echo " $l ";} $l=$l+1; } OUTILS Dev-PHP B 433

12 Créer son site e-commerce avec oscommerce Cet extrait de code est responsable de la création des pages. Nous pouvons tout d abord remarquer qu il utilise la variable $numrows, déclarée ailleurs. Recherchons cette déclaration afin de comprendre le type de valeur que la variable doit contenir. En remontant dans la page, nous trouvons : $find_rows = tep_db_query("select count(*) from feed;"); $numrows=mysql_result($find_rows, 0); Remarquez que $numrows doit mémoriser le nombre d enregistrements dans la base de données. Rappelez-vous que nous avons utilisé, plus haut, la même requête SQL afin de déterminer cette valeur. Nous utilisons également les variables $limit et $start. En parcourant les sections précédentes du code, nous trouvons les déclarations suivantes : if(!isset($_get['start'])) { $start = 0; }else { $start = $_GET['start']; } $limit = 10; À partir de cela, nous pouvons déterminer que la variable $start contient la valeur de $i, c est-à-dire la variable d itération de la boucle for ; $limit représente quant à elle le nombre d objets à afficher dans chaque page. Puisque nous n obtenons pas, à l écran, un nombre de pages correct, étudions plus en détail le fonctionnement de la boucle for. Pour ce faire, nous allons tracer les valeurs des variables utilisées, ainsi que le déroulement de l exécution du programme. En conséquence, nous pouvons donc utiliser une modification de débogage telle que celle-ci : $i=0; $l=1; for($i=0;$i < $numrows;$i=$numrows+$limit){ echo "Nous sommes ici dans la boucle for : "; echo '$i = '. $i. " "; echo '$l = '. $l. " "; echo '$numrows = '. $numrows. " "; echo '$limit = '. $limit. " "; if($i <> $start){ echo " Nous sommes ici dans l'instruction if : "; echo ' $i = '. $i. " "; echo ' $l = '. $l. " "; echo ' $numrows = '. $numrows. " "; echo ' $start = '. $start. " "; echo " <a href='". tep_href_link(filename_feed). '&start='. $i. "'>". $l. "</a> "; 434

13 } else { echo " $l "; echo " Nous sommes ici dans le bloc else : "; echo ' $i = '. $i. " "; echo ' $l = '. $l. " "; echo ' $numrows = '. $numrows. " "; A Dépannage } } $l=$l+1; Vous n aurez pas besoin, en général, d être aussi détaillé que dans cet exemple. Si vous avez déjà une idée assez claire de la cause du problème, vous n aurez guère besoin que d une ou deux valeurs pour comprendre ce qui se passe. Si nous nous intéressons au résultat de nos modifications, nous observerons pour la première page l affichage de la figure A-9. Figure A 9 Erreur de navigation : affichage à l écran des informations d exécution du programme Vous devriez immédiatement avoir le sentiment désagréable que quelque chose ne va pas, car nous ne parcourons la boucle qu une seule fois avant de sortir. Pire encore, notre condition if n est jamais évaluée à true avant que la boucle for ne termine son unique exécution. Les valeurs que nous avons affichées semblent toutes être correctes par rapport à ce que devrait être la première itération de la boucle for. Nous devrions donc reporter nos soupçons sur les conditions effectives d exécution cette boucle for. Étudions-les plus en détail : for($i=0;$i < $numrows;$i=$numrows+$limit){ L accident bête! Si nous observons la condition de cette boucle for d un point de vue structurel, nous lui avons demandé de réaliser les actions suivantes : 1 Commencer la boucle avec $i égale à zéro. 2 Tester si $i est inférieure à $numrows. 3 Si c est le cas, exécuter le bloc de code. 4 Évaluer la valeur de l expression finale $i=$numrows+$limit. 5 Répéter les étapes 2 à

14 Créer son site e-commerce avec oscommerce La sortie de nos instructions echo, visible sur la capture d écran précédente, nous indique qu initialement : $numrows = 10 $limit = 5 Par conséquent, lorsque nous arrivons à l étape 4, la valeur 11 est affectée à la variable $i. Le passage à l étape 5 nous redirige vers l étape 2, où nous devons vérifier si $i (21) est inférieure à $numrows (10). Ce n est clairement pas le cas ; la boucle for se termine donc et nous en sortons sans réaliser la moindre action supplémentaire. Pour être honnête, cet exemple n est pas tout à fait naturel : un programmeur expérimenté aurait immédiatement remarqué que $numrows+$limit>$numrows car $limit>0. Dans une perspective d étude de l exécution d un programme, cet exemple est parfait : il nous a permis d observer un résultat inattendu en ce que la boucle for ne s exécutait qu une seule fois. Nous devons donc modifier cette boucle afin qu elle s exécute un nombre correct de fois. Pour ce faire, réfléchissons attentivement à ce qu elle doit réaliser. Elle doit récupérer le nombre d enregistrements stockés dans la base de données et diviser ce total par le nombre maximal d informations à afficher : de cette manière, nous obtenons le nombre de pages à créer. Ensuite, elle doit, pour chaque page, créer un lien numéroté vers chacune des autres pages de résultat, à l exception de la page courante qui ne comporte pas de lien. Si nous modifions la troisième condition de la boucle for en : for($i=0;$i < $numrows;$i=$i+$limit){ le problème est résolu car, quelle que soit la valeur de $numrows, le nombre d itérations de la boucle for sera correct : en effet, à chaque itération, nous incrémentons la valeur de $i de $limit. Le code ainsi corrigé nous fournit le résultat de la figure A-10. Figure A 10 Exécution du programme après correction des erreurs 436

15 Si vous observez attentivement ce résultat, vous constaterez qu un 2 est affiché en bas de l écran. C est exactement ce que nous attendons, car il faut effectivement deux pages pour afficher les dix informations. La boucle for se termine après la première instruction if (sans compter l exécution initiale du bloc else) car après cette instruction $i possède la valeur 10. Pour finir notre exercice de débogage, nous pouvons maintenant supprimer le code que nous avions ajouté dans le but de tracer l exécution du programme. Vous pouvez également constater qu à la seconde itération de la boucle for, $i possède la valeur 5. De ce fait, l instruction if est évaluée à true et le code correspondant est exécuté, car $i (5) est différent de $start (0) (nous sommes en effet sur la première page). Cela signifie qu un lien vers la seconde page doit être affiché et que la valeur de $start pour ce lien doit être positionnée à 5 et insérée dans l URL. ATTENTION! Condition d une boucle for Notez qu ici, la condition sur la variable $i est exprimée par une inégalité stricte : $i possède la valeur 10 après notre seconde itération, ce qui est égal (mais pas inférieur) à $numrows. Si nous avions par erreur choisi une inégalité large (<=), nous afficherions une troisième page totalement vide. A Dépannage En résumé... Même si rien ne peut réellement remplacer l expérience, vous ne pourrez pas espérer entrer dans l arène sans outils pour vous assister. Cette annexe vous a montré comment gérer quelques-unes des erreurs les plus simples et les plus courantes, qui se produisent relativement souvent. À la suite de cela, nous avons présenté un processus utile, permettant de résoudre des problèmes plus complexes, grâce à un exemple utilisant le code du flux RSS ajouté au chapitre 9. Grâce à cet exemple, vous avez appris à rechercher des informations et à analyser un problème avant de vous plonger dans le code. Une fois que vous avez établi le comportement attendu de ce code (assurez-vous toutefois de le comprendre suffisamment pour que vos attentes soient correctes), vous pouvez explorer les causes d erreur possibles. Vous avez également appris quelques astuces permettant de tracer l exécution du programme, afin d obtenir des informations de débogage importantes. N oubliez pas qu il existe de nombreux environnements de développement qui mettent à votre disposition toutes sortes de fonctionnalités destinées à vous faciliter la tâche. Si vous réalisez que vous ne pouvez pas investir assez de temps dans l analyse et la correction manuelles d erreurs, l utilisation d un des environnements intégrés du marché spécialisés sur PHP est certainement une alternative à explorer. 437