Site management -- Gestion du site (le système de siteaccess)

Date de publication: le mardi 22 mars 2011 à 12h58
Dernière modification: par Pascal BOYER le dimanche 27 mars 2011 à 21h00

22/02/2011 11:59

versions 4.x

A single eZ Publish installation is capable of hosting multiple sites by making use of something called the siteaccess system. This system makes it possible to use different configuration settings based on a set of rules. The rules control which group of settings that should be used in a particular case. The siteaccess rules must be specified in the global override for the site.ini configuration file ("/settings/override/site.ini.append.php").
Une seule installation de eZ Publish peut héberger plusieurs sites en utilisant ce que l'on appelle le système de siteaccess. Ce système permet d'utiliser différents paramètres de configuration liés à un jeu de règles contrôlant le groupe de paramètres à employer dans un cas particulier. Les règles des siteaccess doivent être spécifiées dans une surcharge globale du fichier de configuration site.ini (/settings/override/site.ini.append.php).

Siteaccess

A collection of configuration settings is called a siteaccess. When a siteaccess is in use, the default configuration settings will be overridden by the settings that are defined for the siteaccess. Among other things, a siteaccess dictates which database, design and var directory that should be used (these are sometime referred to as "resources"). By making use of different siteaccesses, it is possible to combine different content and designs. A typical eZ Publish site consists of two siteaccesses: a public interface for visitors and a restricted interface for administrators. Both siteaccesses use the same content (same database and same var directory) but they use different designs. While the administration siteaccess would most likely use the built in administration design, the public siteaccess would use a custom design. The following illustration shows this scenario.
Un ensemble de paramètres de configuration est appelé siteaccess. Lorsqu'un siteaccess est utilisé, les paramètres de configuration par défaut sont surchargés par les paramètres définis pour ce siteaccess. Un siteaccess impose, entre autres, la base de données, le design et les sous-répertoires de var/ devant être utilisés (tout ceci est parfois référencé en tant que ressources). L'utilisation de différents siteaccess permet de combiner différents contenus et différents designs. Un site eZ Publish classique contient deux siteaccess: une interface publique pour les visiteurs et une interface d'accès restreint pour les administrateurs. Ces deux siteaccess utilisent le même contenu (même base de données et même répertoire var/) mais utilisent des designs différents. Alors que le siteaccess d'administration utilise généralement le design d'administration, le siteaccess public utilise un design personnalisé. L'illustration suivante montre un tel scénario:

Example of a setup with two siteaccesses.
Exemple de configuration avec deux siteaccess

A siteaccess is nothing more than a set of configuration files that override the default settings when the siteaccess is used. A single eZ Publish installation can virtually host an unlimited number of sites by the way of siteaccesses. The configuration settings for a siteaccess are located inside a dedicated subdirectory within the "/settings/siteaccess" directory. The name of the subdirectory is the actual name of the siteaccess. (Please note that siteaccess name should only contain letters, digits and underscores.) The following illustration shows a setup with two siteaccesses: admin and public. 
Un siteaccess n'est rien d'autre qu'un jeu de fichiers de configuration dont le rôle est de surcharger les paramètres par défaut lorsque ce siteaccess est utilisé. Une seule installation de eZ Publish peut, virtuellement et grâce aux siteaccess, héberger un nombre infini de sites. Les paramètres de configuration liés à un siteaccess sont placés dans un sous-répertoire dédié du répertoire settings/siteaccess/. Le nom même du sous-répertoire correspond au nom du siteaccess. Notez que le nom d'un siteaccess ne doit contenir que des lettres, des chiffres et le symbole underscore ("_"). L'illustration suivante montre une configuration avec deux siteaccess: admin et public:

Siteaccess directory example.
Exemple de répertoires de siteaccess

When a siteaccess is in use, eZ Publish reads the configuration files using the following sequence:
Lorsqu'un siteaccess est utilisé, eZ Publish lit les fichiers de configuration dans l'ordre suivant:

0 Default configuration settings - /settings/*.ini?
0 Les paramètres de configuration par défaut - /settings/*.ini?
1 Active extension siteaccesses - /extension/my_extension/settings/siteaccess/my_site/*.ini.append.php
1 Les siteaccess des extensions actives - /extension/mon_extension/settings/siteaccess/mon_site/*.ini.append.php
2 Siteaccesses - /settings/siteaccess/my_site/*.ini.append.php?
2 Les siteaccess - /settings/siteaccess/mon_site/*.ini.append.php?
3 Active extensions - /extension/my_extension/settings/*.ini[.append.php]?
3 Les extensions actives - /extension/mon_extension/settings/*.ini[.append.php]?
4 Global overrides - /settings/override/*.ini.append.php
4 Les surcharges globales - /settings/override/*.ini.append.php

In other words, eZ Publish will first read the default configuration settings. Secondly it will read my_site/*.ini.append.php to find the siteaccesses for the active extensions for the installation. Then it will determine which siteaccess to use based on the rules that are defined in the global override for "site.ini" ("/settings/override/site.ini.append.php"). When it knows which siteaccess to use, it will go into the directory of that siteaccess and read the configuration files that belong to that siteaccess. Next it will go into the configuration file for the active extensions and read the configuration files for the active extensions. The settings of the siteaccess will override the default configuration settings.
En d'autres termes, eZ Publish lit d'abord les paramètres de configuration par défaut. Il lit ensuite mon_site/*ini.append.php afin de trouver les siteaccess des extensions actives. Il détermine alors quel siteaccess utiliser en se basant sur les règles définies dans la surcharge globale du fichier site.ini (dans /settings/override/site.ini.append.php). Il peut dès lors parcourir le répertoire de ce siteaccess pour y lire les fichiers de configuration. Le système parcourt ensuite le fichier de configuration indiquant les extensions actives puis il lit les fichiers de configuration de ces extensions. Les paramètres du siteaccess surchargeront les paramètres de configuration par défaut.

For example, if the siteaccess uses a database called "Amiga", the system will see this and automatically use the specified database when an incoming request is processed. Finally, eZ Publish reads the configuration files in the global override directory. The settings in the global override directory will override all other settings. In other words, if a database called "CD32" is specified in the global override for "site.ini" then eZ Publish will attempt to use that database regardless of what is specified in the siteaccess settings. If a setting is not overridden by either the siteaccess or from within a global override then the default setting will be used. The default settings are set by the ini files located in the "/settings" directory.
Exemple: si le siteaccess utilise la base de données nommée Amiga, alors le système utilise automatiquement celle-ci lors du traitement d'une requête entrante. En dernier lieu, eZ Publish lit les fichiers de configuration placés dans le répertoire des surcharges globales et les paramètres contenus par les fichier de ce répertoire surchargent tous les autres paramètres. En clair, si une base de données nommée CD32 est spécifiée dans le fichier de surcharge globale du fichier site.ini, alors eZ Publish tente d'utiliser cette base de données sans tenir compte de ce qui est spécifié dans les paramètres du siteaccess. Lorsqu'un paramètre n'est surchargé ni par le siteaccess ni par une surcharge globale, alors le paramètre par défaut est utilisé. Les paramètres par défaut sont définis dans les fichiers ini placés à la racine du répertoire settings/

The following figure illustrates how the system reads the configuration files using the "site.ini" file as an example. As already mentioned, settings placed in the override files will be used instead of the default ones.
La figure ci-dessous illustre, pour le fichier site.ini, l'ordre dans lequel le système lit les fichiers de configuration. Comme nous venons de l'expliquer, les paramètres placés dans les fichiers de surcharge sont utilisés en lieu et place des paramètres par défaut.

Configuration override example
Exemple de surcharge de configuration

Rules for Online Editor and extensions / Règles pour l'éditeur Online Editor et pour les extensions

This applies for Online Editor and other extensions:
Ceci s'applique à l'éditeur Online Editor et aux extensions:

if a configuration array is initialized in "extension/<extension_name>/settings/<ini_file>" and you want to insert a new value into this array:
si un tableau de configuration est initialisé dans extension/<nom_extension>/settings/<ini_file> et que vous souhaitez ajouter une nouvelle valeur à ce tableau:

1. Do not edit "extension/<extension_name>/settings/<ini_file>", because it will be overwritten next time when you upgrade the extension.
1. Ne pas éditer extension/<nom_extension>/settings/<ini_file> car il sera écrasé lors de la prochaine mise à jour de l'extension.

2. Do not create "extension/<extension_name>/settings/siteaccess/<siteaccess_name>/<ini_file>", because it will be overridden by
"extension/<extension_name>/settings/<ini_file>".
2. Ne cas créer extension/<nom_extension>/settings/siteaccess/<nom_siteaccess>/<ini_file> car il sera surchargé par
extension/<nom_extension>/settings/<ini_file>.

3. Do not create or edit "settings/siteaccess/<siteaccess_name>/<ini_file>", because it will be overriden by
"extension/<extension_name>/settings/<ini_file>".
3. Ne pas créer ou éditer settings/siteaccess/<nom_siteaccess>/<ini_file> car il sera surchargé par
extension/<nom_extension>/settings/<ini_file>.

4. To affect all siteaccesses where <extension_name> is used, specify new value in "settings/override/<ini_file>".
4. Afin que tous les siteaccess liés à <nom_extension> soient affectés, ajouter une nouvelle valeur dans settings/override/<ini_file>

5. To only affect a certain siteaccess, you need to use the following workaround:
5. Pour n'affecter que certains siteaccess, vous devez suivre les règles ci-apprès:
- create a new custom extension specially for these settings: "extension/<custom_extension>/"
- créer une nouvelle extension personnalisée spécialement pour ces paramètres: extension/<mon_extension_personnalisée>/
- specify new value in "extension/<custom_extension>/settings/<ini_file>"
- spécifier la nouvelle valeur dans extension/<mon_extension_personnalisée>/settings/<ini_file>
- enable the custom extension for the target siteaccess by adding
- activer la nouvelle extension - uniquement pour le siteaccess visé - en ajoutant:

ActiveAccessExtensions[]=<custom_extension>

to "settings/siteaccess/<siteaccess_name>/site.ini.append.php"
au fichier settings/siteaccess/<nom_siteaccess>/site.ini.append.php
- make sure the configuration array is not re-initialized in "settings/override/<ini_file>" (if exists).
- s'assurer que le tableau de configuration n'est pas réinitialisé dans settings/override/<ini_file> (s'il existe)

Note: The name of <ini_file> here should always contain either ".append" or ".append.php" in the end. The only exception are default configuration files (for example "settings/design.ini" or "extension/ezoe/settings/ezoe.ini").
Note: le nom de <ini_file> doit toujours être suffixé par .append ou .append.php. La seule exception concerne les fichiers de configuration par défaut (par exemple settings/design.ini ou extension/ezoe/settings/ezoe.ini).

Note: A non technical description of a site access is to view it as a "Content Channel": a Content Channel refers to a way the user of an eZ Publish installation can access the content, this encompasses
Note: une description non technique d'un siteaccess consisterait à le présenter comme un canal de contenu faisant référence à la façon dont un utilisateur de eZ Publish accède aux contenus, ce qui englobe:
-  all “front end” site accesses like a website, or a mobile version of the website,
-  tous les accès au front end tel qu'un site web ou sa version mobile,
-  all “back end “ site accesses like the administration interface(s)
-  tous les accès au back end telle que l'interface d'administration
-  all automated content access interfaces like Application Programmers Interfaces (APIs)
-  toutes les interfaces d'accès aux contenus telles que les Application Programmers Interfaces (APIs)
‘  Translated versions of a site are not counted as additional site accesses
‘  Les versions traduites d'un site ne sont pas comptées en tant que siteaccess supplémentaires.

Commentaires