NOM

get, head, getprint, getstore, mirror - Interface procédurale LWP

SYNOPSIS

 perl -MLWP::Simple -e 'getprint "http://www.sn.no";'
 use LWP::Simple;
 $contenu = get("http://www.sn.no/";);
 if (mirror("http://www.sn.no/";, "foo") == RC_NOT_MODIFIED) {
     ...
 }
 if (is_success(getprint("http://www.sn.no/";))) {
     ...
 }

DESCRIPTION

Cette interface s'adresse à tous ceux qui souhaitent utiliser une version simplifiée de la bibliothèque libwww-perl. Elle permet également de faire des solilignes (« one-liners »). Si vous nécessitez un plus grand contrôle ou un meilleur accès aux en-têtes des requêtes envoyées et des réponses reçues, nous vous conseillons d'utiliser l'interface orientée objet du module LWP::UserAgent.

Les fonctions suivantes sont fournies (et exportées) par ce module :

get($url)
La fonction get() va chercher le document identifié par l'adresse URL donnée et renvoie ce document. Cette fonction retourne undef en cas d'échec. L'argument $url peut être une simple chaîne de caractères ou une référence à un objet URI.

Vous ne pouvez pas examiner le code de la réponse ni ses en-têtes (comme Content-Type) lorsque vous accédez au Web avec cette fonction. Si vous souhaitez obtenir ces informations, utilisez plutôt l'interface OO (voir la page de manuel LWP::UserAgent).

head($url)
Récupère les en-têtes d'un document. Renvoie les cinq valeurs suivantes si l'opération réussit : ($content_type, $document_length, $modified_time, $expires, $server)

Renvoie une liste vide si l'opération échoue. Dans un contexte scalaire, retourne VRAI si l'opération réussit.

getprint($url)
Récupère et imprime un document identifié par une adresse URL. Le document est imprimé sur STDOUT à mesure que les données sont reçues du réseau. Si la requête échoue, le code d'état et le message sont imprimés sur STDERR. La valeur de retour est le code de la réponse HTTP.

getstore($url, $fichier)
Récupère un document identifié par une adresse URL et enregistre celui-ci dans le fichier. La valeur de retour est le code de la réponse HTTP.

mirror($url, $fichier)
Récupère et enregistre un document identifié par une adresse URL en vérifiant les en-têtes If-modified-since et Content-Length. Retourne le code de la réponse HTTP.

Ce module exporte également les constantes et les procédures du module HTTP::Status. Vous pouvez utiliser celles-ci quand vous vérifiez le code de réponse des fonctions getprint(), getstore() et mirror(). Ces constantes sont :

   RC_CONTINUE
   RC_SWITCHING_PROTOCOLS
   RC_OK
   RC_CREATED
   RC_ACCEPTED
   RC_NON_AUTHORITATIVE_INFORMATION
   RC_NO_CONTENT
   RC_RESET_CONTENT
   RC_PARTIAL_CONTENT
   RC_MULTIPLE_CHOICES
   RC_MOVED_PERMANENTLY
   RC_MOVED_TEMPORARILY
   RC_SEE_OTHER
   RC_NOT_MODIFIED
   RC_USE_PROXY
   RC_BAD_REQUEST
   RC_UNAUTHORIZED
   RC_PAYMENT_REQUIRED
   RC_FORBIDDEN
   RC_NOT_FOUND
   RC_METHOD_NOT_ALLOWED
   RC_NOT_ACCEPTABLE
   RC_PROXY_AUTHENTICATION_REQUIRED
   RC_REQUEST_TIMEOUT
   RC_CONFLICT
   RC_GONE
   RC_LENGTH_REQUIRED
   RC_PRECONDITION_FAILED
   RC_REQUEST_ENTITY_TOO_LARGE
   RC_REQUEST_URI_TOO_LARGE
   RC_UNSUPPORTED_MEDIA_TYPE
   RC_INTERNAL_SERVER_ERROR
   RC_NOT_IMPLEMENTED
   RC_BAD_GATEWAY
   RC_SERVICE_UNAVAILABLE
   RC_GATEWAY_TIMEOUT
   RC_HTTP_VERSION_NOT_SUPPORTED

Les fonctions de classification du module HTTP::Status sont :

is_success($rc)
Vrai si le code de la réponse indique que la requête a réussi.

is_error($rc)
Vrai si le code de la réponse indique qu'une erreur est survenue.

Le module exporte également l'objet LWP::UserAgent dans la variable $ua si vous le demandez de façon explicite.

L'agent utilisateur créé par ce module s'identifie comme « LWP::Simple/#.## » (où « #.## » représente le numéro de version de libwww-perl) et initialise ses valeurs proxy par défaut à partir de l'environnement (en appelant $ua->env_proxy).

VERSION FRANÇAISE

Cette traduction française correspond à la version anglaise distribuée avec LWP::Simple 1.35. Pour en savoir plus concernant ces traductions, consultez http://perl.enstimac.fr/.

TRADUCTION

Traduction initiale et mise à jour <v1.35>: Isabelle Hernandez <fantom@panix.com>.

RELECTURE

Briac Pilpré <briac@cpan.org>

VOIR AUSSI

LWP, la page de manuel LWP::UserAgent, la page de manuel HTTP::Status, lwp-request, lwp-mirror