9. Noms intégrés

Cette page liste tous les noms intégrés disponibles dans les scripts Karrigell

9.1 Valeurs en lecture seule

ACCEPTED_LANGUAGES La liste des langues acceptées par le client (on peut les définir dans le navigateur)
CONFIG Les options de configuration, telles qu'elles sont définies dans les fichiers de configuration

Attributs

  • karrigell_dir
  • root_dir
  • data_dir
  • cache_dir
  • allow_directory_listing
  • hide_extensions
  • ignore
  • logging_file
  • output_encoding
COOKIE Les cookies envoyés par le client au server. Instance de la classe SimpleCookie dans le module cookie de la distribution Python standard
HEADERS Les entêtes de requête, envoyés par l'agent utilisateur (navigateur) au serveur. Instance de la classe email.Message
QUERY Quand un script reçoit des données de formulaire, ou dans la chaîne de requête (query string) de l'url, QUERY est un dictionnaire qui fait correspondre les noms des champs et leurs valeurs
REQUEST Quand un script reçoit des données de formulaire, ou dans la chaîne de requête (query string) de l'url, REQUEST est un dictionnaire qui fait correspondre les noms des champs et leurs valeurs (synomyme de QUERY)
REQUEST_HANDLER Un objet qui représente le gestionnaire de requête courant

Attributes

client_address Un tuple avec l'adresse IP et le port du client, par exemple ('127.0.0.1', 1825)
command La commande ou méthode HTTP (généralement GET ou POST)
version Numéro de version de Karrigell
THIS Un objet qui représente le script courant. Les exemples supposent que le chemin du script dans le système de fichiers est C:\cygwin\home\Karrigell\webapps\demo\thisTest.pih, et qu'on l'appelle par demo/thisTest.pih?arg1=value1

Attributs

url L'url utilisée par le client pour invoquer le script, y compris la chaîne de requête (query string) s'il y en avait une (/demo/thisTest.pih?arg1=value1)
script_url La partie de l'url qui s'arrête au nom du script avec son extension ; enlève le le nom de fonction pour les scripts ks, les arguments des "url intelligentes", la chaîne de requête, etc. (/demo/thisTest.pih)
baseurl La partie de l'url avant le nom du script (demo/)
args Si le script est appelé avec des arguments additionnels séparés par des /, args est la liste de ces arguments (voir url intelligentes)
name Nom complet du script dans le système de fichiers (C:\cygwin\home\Karrigell\webapps\demo\thisTest.pih)
cwd Nom complet du répertoire du script dans le système de fichiers (C:\cygwin\home\Karrigell\webapps\demo)
ext Extension du script (.pih)
rel() Une fonction utilisée pour construire des urls correctes à l'intérieur des fonctions qui reçoivent leurs arguments sous forme d'"url intelligentes" (du type host/script/script.ks/foo/bar)
py_code Le code source du script, ou sa conversion en code pur-Python
parent Le script parent du script courant, si celui-ci a été inclus par la fonction Include(), ou None

9.2 Variables et fonctions

Include() Fonction utilisée pour inclure un fichier ou un script dans un autre script
Login([script_url],[role], [valid_in], [redir_to]) Fonction utilisée pour limiter l'accès au script à des utilisateurs authentifiés. Par défaut, si l'utilisateur n'est pas connecté, redirige vers le script login.ks dans le répertoire common/admin. Une autre url de script url peut être spécifiée pour personnaliser le test d'authentification. Si l'utilisateur est déjà connecté, la fonction ne fait rien
role est la liste des rôles acceptés par le script. Il prend la valeur ["admin"] par défaut et peut inclure "edit", "visit" comme autres valeurs, ainsi que des valeurs personnalisables par l'administrateur
valid_in spécifie la partie du site où l'utilisateur sera connecté. Par défaut il s'agit des scripts dans le même fichier que le script appelant
redir_to est le chemin vers lequel l'utilisateur doit être dirigé après une authentification réussie. Par défaut il s'agit du chemin du script original
Logout([script_url], [valid_in], [redir_to]) Déconnecte l'utilisateur. Les arguments ont la même signification que ci-dessus
REL() Une fonction qui transforme un nom de chemin relatif dans le système de fichiers en un nom absolu, en se basant sur le répertoire du script
RESPONSE Les entêtes de réponse envoyés par le serveur au client, tels que Content-type. Instance de la classe email.Message
Role() Indique le rôle de l'utilisateur. S'il n'est pas connecté (voir Login()), la valeur est None ; sinon la valeur peut être "visit", "edit", "admin" ou une chaîne personnalisée par l'administrateur
Session() Fonction qui renvoie l'objet de session
SET_COOKIE Les cookies envoyés par le serveur au client. Instance de la classe SimpleCookie du module cookie de la distribution standard

9.3 Exceptions

HTTP_REDIRECTION raise HTTP_REDIRECTION,url réalise une redirection HTTP (code 302) vers l'url spécifiée
SCRIPT_END Exception pour interrompre l'exécution du script