Explication détaillée de XML et exemple de code pour les applications CGI modernes

Introduction

La popularité de Perl est directement liée au développement fulgurant d'Internet. Les fonctions puissantes et la facilité d'extensibilité de Perl en font le choix le plus naturel pour développer des applications CGI, et il est rapidement devenu le langage préféré pour les scripts CGI. CGI lui-même n’est pas parfait. Cependant, grâce à la popularité de nombreux développeurs, CGI est encore largement utilisé aujourd'hui et ne montre aucun signe de « retraite » dans un avenir proche.

Un script CGI::XMLApplication typique se compose de trois parties : un petit script exécutable qui fournit un support d'accès à l'application, un module logique qui implémente diverses méthodes de gestionnaire et un module logique qui implémente diverses méthodes de gestionnaire basées sur le statutIl peut y avoir une ou plusieurs feuilles de style XSLT Les feuilles de style XSLT peuvent convertir les résultats renvoyés par le module dans un format que le navigateur peut afficher à l'utilisateur.

Ci-dessous, nous présentons brièvement l'application de CGI::XMLApplication à travers des exemples.

Exemple 1 : Passerelle CGI XSLT

CGI::XMLApplication suppose que les concepteurs et les développeurs impliqués dans un projet séparent la logique et la présentation de l'application à l'aide de feuilles de style XSLT pour rendre cette séparation apparente. Très direct et n'aura aucun impact sur le projet. Les développeurs doivent uniquement pouvoir faire en sorte que setStylesheet renvoie l'emplacement de la feuille de style XSLT qui correspond à l'état actuel de l'application. La conversion de l'arborescence DOM créée par l'application, la transmission des paramètres XSLT au moteur de conversion et la transmission du contenu converti au navigateur sont toutes transparentes pour les utilisateurs.

Pour mettre en évidence cette séparation, notre premier exemple n'est pas une application web au sens traditionnel, mais une passerelle XSLT générique qui peut être ajoutée au cgi-bin du serveur pour convertir l'intégralité du contenu XML. L'arborescence des répertoires est convertie dans un format conforme au navigateur demandeur, et tout cela est transparent pour les utilisateurs, les feuilles de style et les auteurs de documents.

La première étape consiste à établir un script CGI qui relie la requête du client à l'application. Nous souhaitons rendre les documents XML facilement consultables via des URL et rendre la création d'hyperliens entre ces documents intuitive. Par conséquent, nous allons créer un script CGI sans l'extension afin qu'en tant que nœud dans le chemin URL, tout ce qui se trouve à droite du nœud soit interprété dans un environnement de document virtuel contenant du contenu XML. Dans ce cas, nous appelons CGI un sélecteur de feuille de style.

use strict;
use lib '/path/to/secure/webapp/libs';
use XSLGateway;
use CGI qw(:standard);my $q = CGI->new();
my %context = ();
my $gateway_name = 'stylechooser';

Après avoir chargé les modules appropriés et défini quelques variables valides tout au long du script, nous commençons à ajouter au %context qui est transmis à la classe qui gère la logique de l'application. domaines. Dans cette application, nous transmettons uniquement l'URL demandée (entrée REQUEST) à droite du chemin d'accès au fichier script et la clé STYLE contenant les données stockées dans le paramètre style query.

$context{REQUEST} = $q->url(-path => 1);
$context{REQUEST} =~ s/^$gateway_name/?//;
$context{REQUEST} ||= 'index.xml';
$context{STYLE} = $q->param ('style') if $q->param('style');

Enfin, nous créons une instance de la classe logique XSLGateway et traitons la requête en appelant sa méthode run, en passant %context comme seul paramètre.

my $app = XSLGateway->new();
$app->run(%context);

Le script CGI est terminé. Ci-dessous nous créons le module XSLGateway qui fait l'essentiel du travail :

package XSLGateway;
use strict;
use vars qw(@ISA);
use CGI::XMLApplication;
use XML::LibXML;
@ISA = qw(CGI::XMLApplication);

Comme je l'ai mentionné en introduction, CGI::XMLApplication fonctionne via l'appel event : dans la classe d'application The l'exécution d'une méthode donnée dépend de la saisie d'un champ spécifié (généralement le nom du bouton utilisé pour soumettre le formulaire .), et deux méthodes d'appel doivent être exécutées : selectStylesheet et méthode requestDOM.

selectStylesheet renvoie le chemin complet du système de fichiers vers la feuille de style XSLT appropriée. Par souci de simplicité, nous supposons que la feuille de style sera conservée dans un seul répertoire. Nous pouvons fournir d'autres feuilles de style via le champ $context-> {STYLE} pour augmenter la flexibilité du système.

sub selectStylesheet {
my $self = shift;
my $context = shift;
my $style = $context->{STYLE} || 'default';
my $style_path = '/opt/www/htdocs/stylesheets/';
return $style_path . $style . '.xsl';
}

Ensuite, nous devons créer la méthode requestDOM, qui renverra l'expression XML::LibXML DOM du document XML transféré. Étant donné que notre passerelle ne fonctionne qu'avec des fichiers statiques, nous devons utiliser XML::LibXML pour analyser le document et renvoyer l'arborescence des résultats.

sub requestDOM {
my $self = shift;
my $context = shift;
my $xml_file = $context->{REQUEST} || 'index.xml';
my $doc_path = '/opt/www/htdocs/xmldocs/';
my $requested_doc = $doc_path . $xml_file;
my $parser = XML::LibXML->new;
my $doc = $parser->parse_file($requested_doc);
return $doc;
}

À ce stade, notre script CGI peut être exécuté en toute sécurité dans le répertoire cgi-bin du serveur et télécharge certains documents XML et un ou deux styles XSLT dans certains répertoires appropriés. Nous pouvons maintenant commencer à tester les résultats de notre travail. Une requête à localhost/cgi-bin/stylechooser/mydocs/somefile.xml amènera le serveur Internet à sélectionner le fichier mydocs/somefile.xml dans le répertoire /opt/www/htdocs/xmldocs/, en utilisant /opt/www/htdocs /stylesheets La feuille de style default.xsl dans / transforme le fichier et le transmet au client.

如果需要，我们可以扩充这一基本的框架，例如，可以 在样式表选择CGI脚本程序添加一些查找组件，选择合适的样式表，可以设置或读 取HTTP cookies，对网站进行修饰。

例2：一个简单的购物系统

在 该例子中，我们将使用CGI::XMLApplication创建一个简化的Web应用程序，购物 系统。

与上个例子相同，这个应用程序中与CGI-BIN有关的部分仍然非常 地少。我们所需要作的只不过是初始化CustomerOrder应用类并调用它的run()方 法。这次，我们将CGI.pm中Vars作为%context的PARAMS域：

use strict;
use CGI qw(:standard);
use lib '/path/to/secure/webapp/libs';
use CustomerOrder;
my $q = CGI->new();
my %context = ();
$context{PARAMS} = $q- >Vars;
my $app = CustomerOrder->new();
$app->run(% context);

在这个例子中，我们假定该应用中的产品信息存储在关 系数据库中，产品清单不是太长，使我们在应用中不会出现多屏才能显示相关信 息的麻烦：用户输入订购的产品数量的主要数据输入屏，显示订购单内容和所选 物品总价格的确认屏，显示订单已经处理的提示。为了简单起见，我们在这里没 有涉及送货和财务数据的输入等问题。

package CustomerOrder;
use strict;
use vars qw(@ISA);
use CGI::XMLApplication;
use XML::LibXML::SAX::Builder;
use XML::Generator::DBI;
use DBI;
@ISA = qw (CGI::XMLApplication);

在加载必要的模块和定义从 CGI::XMLAplication中继承的类后，我们开始创建应用中与各种状态有关的事件 调用。首先，我们必须通过创建registerEvents()方法注册这些事件。在本例中 ，我们将注册order_confirm 和order_send方法，这二个方法设置%context中的 SCREENSTYLE域。稍后，我们将利用该属性定义在显示客户端的数据时应该使用三 个XSLT样式表中的哪一个。

需要注意的是，这些事件将被映射到实现它们 的实际的子程序中，子程序的命名规则是event_<事件名>，例如， order_confim事件是由event_order_confim执行的。另外，还需要注意的是，各 种事件的选择是由CGI::XMLApplication根据其查找一个与注册事件同名的表格参 数的能力进行的。例如，要执行order_confirm事件，表格组件中必须包含一个提 交非空值的名字为order_confirm的表格域。

# 事件的注册和事件调用

sub registerEvents {
return qw( order_confirm order_send );
}
sub event_order_confirm {
my ($self, $context) = @_;
$context->{SCREENSTYLE} = 'order_confirm.xsl';
}
sub event_order_send {
my ($self, $context) = @_;
$context->{SCREENSTYLE} = 'order_send.xsl';
}

如果没有请求执行其他的事 件，则缺省地执行event_default。在本例中，我们只使用它将SCREENSTYLE域设 定为一个合适的值。

sub event_default {
my ($self, $context) = @_;
$context->{SCREENSTYLE} = 'order_default.xsl';
}

每次请求都会执行 event_init方法，而且总是在其他方法之前执行它，这使得它非常适合对应用中 被其他事件使用的部分进行初始化。在本例中，我们使用它返回利用 fetch_recordset()方法从数据库中获取的产品信息的、最初的DOM树。

sub event_init {
my ($self, $context) = @_;
$context->{DOMTREE} = $self->fetch_recordset();
}

state-handler方法完成后，我们需要执行必需的 selectStylesheet和requestDOM方法。

与在第一个例子中一样，我们假设 所有的应用的样式表都存储在服务器上相同的目录中。我们所需要作的是返回 $context->{SCREENSTYLE}的值所指定的路线，并添加到末尾。

# app config and helpers
sub selectStylesheet {
my ($self, $context) = @_;
my $style = $context-> {SCREENSTYLE};
my $style_path = '/opt/www/htdocs/stylesheets/cart/';
return $style_path . $style;
}

在研究requestDOM处理程序之前，我们先来详细 地研究fetch_recordset helper方法。

需要记住的是，我们要做的工作是 从一个关系数据库中选择所订购产品的有关信息，但传递给XSLT处理器的数据必 须是DOM树。在本例中，我们不通过编程的方法，而是利用XML::Generator::DBI ，它能够从执行SQL SELECT语句得到的数据中生成SAX数据。创建要求的DOM树就 是建立XML::LibXML::SAX::Builder（它从SAX事件中创建XML::LibXML DOM树）的 实例。

sub fetch_recordset {
my $self = shift;
my $sql = 'select id, name, price from products';
my $dbh = DBI->connect('dbi:Oracle:webclients',
'chico',
'swordfish')
|| die "database connection couldn't
be initialized: $DBI::errstr n";
my $builder = XML::LibXML::SAX::Builder->new();
my $gen = XML::Generator::DBI->new(Handler => $builder,
dbh => $dbh,
RootElement => 'document',
QueryElement => 'productlist',
RowElement => 'product');
my $dom = $gen->execute($sql) || die "Error Building DOM Treen";
return $dom;}

fetch_recordset方法完成了另一项很重要的任务，但它返回的 DOM树只包含我们想向客户发送信息的一部分，我们还必须获取用户输入的产品数 量，另外，还需要提供一个订购产品的总计。

sub requestDOM {
my ($self, $context) = @_;
my $root = $context-> {DOMTREE}->getDocumentElement();
my $grand_total = '0';

为了将当前的订货数量作为更大的文档的一部分， 我们将遍历所有的产品元素，并在每行中添加和子元素。的值可以从$context- >{PARAMS}域获得。

foreach my $row ($root->findnodes ('/document/productlist/product')) {
my $id = $row- >findvalue('id');
my $cost = $row->findvalue ('price');
my $quantity = $context->{PARAMS}->{$id} || '0';
my $item_total = $quantity * $cost;
$grand_total += $item_total;
# add the order quantity and item totals to the tree.
$row->appendTextChild('quantity', $quantity);
$row->appendTextChild('item-total', $item_total);
}

最后，我们将增加一些有关订单的元信息 ，方法是在具有元素的根元素中添加一个元素，该元素中包含有当前所选货物的 总价值。

$grand_total ||= '0.00';
my $info = XML::LibXML::Element->new('instance-info');
$info- >appendTextChild('order-total', $grand_total);
$root- >appendChild($info);
return $context->{DOMTREE};
}

细心的读者可能已经注意到，我们这个非常简单的应用程序在 order_send方法中没有作任何实际的事。决定如何处理这些数据是产品订购应用 程序中与具体的购物网站最有关的部分。

结束语

CGI::XMLApplication在CGI脚本程序的编程中提供了一种清晰的、模块化 的隔离系统的内容和表示的方法，单就这一点，就值得我们对它进行一番研究。 此外，它还可以使我们避免纠缠于一些细节问题，而集中精力解决主要的问题。

【相关推荐】

1. Explication détaillée de l'exemple de code d'écriture de données cgi dans du texte ou une base de données

2 Partage d'un exemple de didacticiel sur l'exécution de scripts Python à l'aide de CGI sur IIS

3.

Utilisez le module CGI pour créer un exemple de didacticiel de page Web simple

4

Partagez un exemple de didacticiel de programmation Python CGI5 .

Qu'est-ce que CGI ? Introduction détaillée à la programmation Python CGI

6.

Le processus FastCGI s'est arrêté de manière inattendue, provoquant une erreur 500

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!