Post-install fixes of sevenx_multisite #

This page is for developers who maintain or copy the sevenx_multisite installer, and for administrators who want to understand a log line from the install. It answers: what the two hook files do, and what each repair after the content import is for. The step numbers refer to the table on The multisite installer script.

Contents #

1. install-scripts.php
2. post-install-fix.php
3. Repairs of the imported data
4. Nodes, layouts, menus and tags
5. URL aliases and site prefixes
6. Class names
7. Reading the log

install-scripts.php #

settings/install-scripts.php defines the two hooks CreateSites (kernel/setup/steps/ezstep_create_sites.php) calls around the package install:

function eZSitePreInstall( )
{
    $installer = new sevenxMultiSiteInstaller( array( 'var_dir' => 'var/site' ) );
    $installer->preInstall();
}

function eZSitePostInstall( &$parameters )
{
    $installer = new sevenxMultiSiteInstaller( $parameters );
    $installer->postInstall();
}

CreateSites calls eZSitePreInstall( $siteType ) after including the settings files and before it installs the required packages, and eZSitePostInstall( $parameters ) at the end, with the content language temporarily set to the clean data's language ("in the primary language every dataMap() of an eng-US object came back empty"). After the post-install it checks eZSiteInstaller::abortedStep() and reports EZSW-080 when a step stopped the chain. What preInstall() does is on The multisite installer script.

post-install-fix.php #

settings/post-install-fix.php (1050 lines) is loaded by the installer with require_once; it is not a <settings-file>. Its header says why it is separate: "Keep all non-interactive DB normalization here so the installer and build_reference can share the same logic." Every function is wrapped in if ( !function_exists(...) ).

"The only difference between the two installations is the content package the site package requires", so the same file serves sevenx_multisite and sevenx_multisite_clean.

Repairs of the imported data #

These steps run early, because they only need the objects and "several later steps are fragile":

Nodes, layouts, menus and tags #

Step 35 calls sevenxFixPackageNodesAndExplayouts(), which:

1. Reads the node assignments of every object-media-o-*.xml of the content package and creates the nodes that are still missing, resolving parents by remote id, in up to 50 passes. This builds the map from package node and object ids to the ids of this installation.
2. Remaps the explayouts_* and eztags_attribute_link references and removes those that point at content the package does not ship (see Layouts data and the share .dba files).
3. sevenxFixMenuINIFiles(): writes settings/siteaccess/<sa>/menu.ini.append.php for site, eng, sevenx_site_user (Fit & Healthy) and bold, bold_ger (Bold Agency), with [SiteInfo] RemoteID (media-o-site-info or media-o-site-info-bold), MainMenuID[], NexusMainMenuID[], FooterMenuID[], NexusFooterMenuID[], PrivacyPolicyID and CookiePolicyID. Each list starts with a bare Key[] line so it replaces the theme's list instead of being appended to it; a page the package did not install is left out. The ids are written into the project's siteaccess settings, not into the theme extension.
4. sevenxFixEzTagsFromPackage(): stores every eztags attribute again from the strings in the object file, and raises the priority of rule 50 to 175.
5. sevenxFixEmbeddedObjectIDs(): rewrites numeric object_id and node_id of embeds in ezxmltext fields.
6. Clears all caches with eZCache::clearAll(), because "the first page views were served from caches built before these fixes".

The installer method then clears the layout resolver cache.

URL aliases and site prefixes #

Each site lives below its own home node and hides it with PathPrefix, so its URLs need aliases that start with the prefix:

Class names #

Reading the log #

The fixes log through eZDebug::writeNotice(), one summary line each, for example "Created N missing tree nodes in N pass(es)", "References to content ... does not ship, removed: ...", "Regenerated URL aliases for N nodes, N changed", "Stored N prefixed URL alias path(s)", "Switched off N block link(s) to pages this installation does not have". On a clean install the "removed" counts are expected; on a full install they should be zero.

Related pages #

• sevenx_multisite
• The multisite installer script
• Install scripts in a site package
• Changing the installer script
• Site packages: start here
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.