eZpedia : Solutions

Upgrading eZ Publish 3.3 t o 3.9

Sun, 09 Aug 2009 10:23:08 GMT

Prerequisits

If you need to upgrade eZ, start here:
https://ez.no/doc/ez_publish/upgrading

Examine this image carefully:
https://ez.no/doc/layout/set/full/ez_publish/upgrading/images/ez_publish_releases

Requirements

Backup the database!

Steps

Then, open Notepad and list your upgrade path, with every stop. You can then copy and paste out of Notepad onto the command line.
Pay particular attention to the scripts listed on each page (for example: upgrading from 3.3-5 to 3.4).
Some of the scripts don't run (due to version conflicts), and some are optional. Read the pages in the upgrade documentation carefully - or you'll have to do it over and over.
Take your time and be patient. The commands below are an example, you'll need to substitute your database access parameters as well as the siteaccess names.

Commands will vary between different upgrade paths.

mysql -udb_ez -p db_ez < update/database/mysql/3.4/dbupdate-3.3-5-to-3.4.0.sql
 
php-cli update/common/scripts/updateremoteid.php
php-cli update/common/scripts/updatesession.php
php-cli update/common/scripts/updatetoplevel.php
php-cli update/common/scripts/addorderemail.php
 
mysql -udb_ez -p db_ez < update/database/mysql/3.4/dbupdate-3.4.0-to-3.4.1.sql
mysql -udb_ez -p db_ez < update/database/mysql/3.4/dbupdate-3.4.1-to-3.4.2.sql
mysql -udb_ez -p db_ez < update/database/mysql/3.4/dbupdate-3.4.2-to-3.4.3.sql
mysql -udb_ez -p db_ez < update/database/mysql/3.4/dbupdate-3.4.3-to-3.4.4.sql
 
mysql -u db_ez -p db_ez < update/database/mysql/3.5/dbupdate-3.4.4-to-3.5.0.sql
 
php-cli update/common/scripts/updateiscontainer.php -s new
php-cli update/common/scripts/updateniceurls.php
php-cli update/common/scripts/updatesearchindex.php --clean
 
mysql -u db_ez -p db_ez < update/database/mysql/3.5/dbupdate-3.5.0-to-3.5.1.sql
mysql -u db_ez -p db_ez < update/database/mysql/3.5/dbupdate-3.5.1-to-3.5.2.sql
 
php-cli update/common/scripts/updatetoplevel.php -s adm
php-cli update/common/scripts/updateeztimetype.php -s new
 
php-cli update/common/scripts/updatecrc32.php
 
mysql -u db_ez -p db_ez < update/database/mysql/3.6/dbupdate-3.5.2-to-3.6.0.sql
 
php-cli update/common/scripts/convertxmllinks.php
php-cli update/common/scripts/updaterelatedobjectslinks.php -s adm
 
mysql -u db_ez -p db_ez < update/database/mysql/3.8/dbupdate-3.6.0-to-3.8.0.sql
 
php-cli update/common/scripts/updatemultilingual.php -s new
php-cli update/common/scripts/updaterssimport.php -s new
 
mysql -u db_ez -p db_ez < update/database/mysql/3.8/dbupdate-3.8.0-to-3.8.1.sql
mysql -u db_ez -p db_ez < update/database/mysql/3.8/dbupdate-3.8.1-to-3.8.2.sql
mysql -u db_ez -p db_ez < update/database/mysql/3.8/dbupdate-3.8.2-to-3.8.3.sql
mysql -u db_ez -p db_ez < update/database/mysql/3.8/dbupdate-3.8.3-to-3.8.4.sql
mysql -u db_ez -p db_ez < update/database/mysql/3.8/dbupdate-3.8.4-to-3.8.5.sql
mysql -u db_ez -p db_ez < update/database/mysql/3.8/dbupdate-3.8.5-to-3.8.6.sql
 
php-cli update/common/scripts/correctxmltextclasses.php --global

Results

I upgraded from 3.3-5 to 3.8.6 and it went fairly smoothly.

Problems

Issues I did encounter

updatetoplevel.php updated override/content.ini.append.php like so, and the system didn't run well. (I commented the changes out):

#[NodeSettings]
#RootNode=4159
#UserRootNode=4160
#MediaRootNode=4161
#SetupRootNode=4163
#DesignRootNode=4162

Results

updateiscontainer.php didn't run, and although I normally don't make changes in the database - I changed the ezcontentclass table and set the is_container flag manually.

At this time, you should be able to use the admin console.
Go to Setup > Upgrade > and check the database consistency.
Manually run any SQL through the database engine.
Clearing the cache and updating the search index are important.

Limiting Payment Gateways by Product Content Class

Thu, 06 Aug 2009 11:11:46 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

About

I am using the xrowecommerce extension from xrow and the paymentgateway directebanking which is written by all2e in order of us (wirverbindenwelten).

For a special shopmodification I need to have a paymentlimitaion by productclass.

This example is using a modified xrowecommerce extension.

in the paymentgateway event php I add the following to the execute function

$productPayment = $order->attribute( 'product_items' );

Also add the variable $productPayment to template through $process->Template['templateVars']

$process->Template['templateVars'] = array( 
  'event' => $event, 'product_gateway_limitation' => $productPayment 
 );

After this I check my product class in the template file selectgateway.tpl

by looping the product items in my $productPayment array as needed.

If u need help u are welcome in irc://irc.freenode.net#ezpublish and irc://irc.freenode.net#ezpublish.de

References

Forum: paymentgateway in xrowecommerce
Forum: shop checkout -> hidden value to selectgateway.tpl
Forum: I want to offer several payment method - workflow limitation
Forum: payment gateway based on price
Project: xrowecommerce

How to shrink or reduce the site of eZ Publish database backup dump files

Sun, 19 Jul 2009 18:38:48 GMT

Question

I have a small site like a blog with only a few hundred entries. My mysql database backup dump files have grown in size upwards to over 1,000 MB! How can I reduce the size or amount of data stored in the eZ Publish Database?

Answers

Sadly the size is quite common. We have seen much larger sizes in the GB of exports of active clean eZ Publish installation databases. Suggest reading up on the flatten.php an cleanup.php php cli shell scripts as these should help you reduce some database size.

Suggested steps

- Empty the trash for all users

- Run flatten.php and cleanup.php scripts

- Remove session information from database

eZ Publish will store session information in the database and you may need to enable the php configuration setting, 'session.gc_probability' to purge the expired sessions.

PHP Sessions

Confirm these values in php.ini

session.gc_probability = 1
session.gc_divisor = 100

eZ Publish Sessions

If you dump your database and review the file size and then review the contents you would find that the ezsession table often contains large amounts of session rows.

Mysql

You can quickly truncate the ezsession table using sql thus freeing the table of records.

mysql > truncate table ezsession;

PHP

Or you may use the eZ Publish PHP CLI API (cleanup script) to free sessions in eZ Publish.

php update/common/scripts/cleanup.php session;
php update/common/scripts/cleanup.php expired_session;

Reference

Doc: https://ez.no/doc/ez_publish/upgrading/the_system_upgrade_scripts
Forum: Huge database

eZ ODF - Creating, Importing and Exporting ODF/PDF Documents

Fri, 17 Jul 2009 11:41:35 GMT

About

Summary

References

Converting HTML Form Post Variables into URL View Parameters

Sat, 20 Jun 2009 19:01:46 GMT

This feature is available since eZ publish 3.5.

About

A recommended feature within eZ Publish template language is the use of view parameters instead of ezhttp operators to access _GET or _POST variables. View parameters are eZ Publish cache friendly while ezhttp usage is not.

Example Problem

Often a problem arises during requirements analysis and development with eZ Publish is how to submit complex combinations of view parameters as _POST variables and transform those variables into view parameters and redirecting the browser.

An example of this might be a filter bar which limits the results of a fetch with a series of html form inputs and options.

This document should provide an example of turning the html form _POST variables into view parameters.

Solutions

At the end of the day this requires either using one of the following

javascript onSubmit/onClick solution (incompatible with text browsers to append parameters and redirect browser)
custom module view (compatible with all browsers and simple to create)
default '/content/action' module view in eZ Publish to provide this parameter type translation/redirection.

Default /content/action module view

This module view is provided in the default kernel but has some limitations

Variables

DestinationURL - This is the path to your view without starting slash. Don't use ezurl on this value as it would add a starting slash.
Parameter - Any input variable with the name ie, 'Example #1 In a custom template for the node uri, 'ez_publish_root_node/events'
Submit - This parameter is ignored and not translated. Apparently this includes multiple values with the same name.
All other parameters submitted within the html form elements be added with the /([name])/[value] view parameters format.

Example Form

<form action={"content/action"|ezurl} method="post">
 
<input type="hidden" name="DestinationURL" value="{$node.url_alias}" />
 
<input type="text" name="(keyword)" value="" size="12" /> <br />
 
<input type="checkbox" name="(year)" value="1999" /> <br />
 
<input type="checkbox" name="(month)" value="12" /> <br />
 
<input type="submit" name="Submit" value="Go" />
 
</form>

Result

Upon submit the user will be redirected to: 'ez_publish_root_node/events/(keyword)//(year)/1999/(month)/12' if both checkboxes are checked and no text is input.

Limitations and Problems

The primary problem with the default 'content/action' module solution is certain html form input _POST values are converted inconsistently due to the generic nature of the solution provided by default.

Checkboxes are only submitted if checked, textline could be optional and on submit send empty values and cause further user page loading / redirection problems.

These problems at any level require custom php to properly detect, evaluate and set reliable url + view parameters hence the recommendation to use the bcposttoview custom module solution if these limitations affect you and your code.

Custom module view

You could create a custom module view within an extension activated for your user siteaccess to provide custom redirection implementation (review the file kernel/content/action.php for the default example).

At some point I hope for someone to publish at least an example of such a solution for further modification as needed by the user / developer as a starting point for avoiding null values in url parameters in redirected url (a common short coming of using the default /content/action module method).

Example Solution

2009.09.20 Brookins Consulting published the bcposttoview module view extension which was an example (several in fact) self contained modules and module views within the bcposttoview extension. The name mirrored off of an old deprecated module view name ezposttoview mentioned online in conjunction as an older example of this functionality but not available to the public, while our bcposttoview is freely available example in response to the for mentioned need (above).

Javascript redirection

You could use javascript to convert html form variables into view parameters. This would be better when used in conjunction with ajax content request than simply html form variables to url variable conversion to avoid the need for a custom module view for redirection.

In the end we think a module view redirection provides better browser compatibility than javascript hands down. Although a javascript solution (or ajax solution) was used on top of the module view solution that would be just fine since it provides a reliable fallback for browsers without javascript.

Example Javascript Method #1

function defaultStaticFormToViewParameterUrlRedirect( suffixString = '' )
{
    var form=document.getElementById( 'form_search' + suffixString );
    var action=form.action;
 
    var todaySelect=document.getElementById( '(today)' + suffixString );
    var locationSelect=document.getElementById( '(location)' + suffixString );
    var keywordSelect=document.getElementById( '(keyword)' + suffixString );
    var eventTypeSelect=document.getElementById( '(eventType)' + suffixString );
 
    if (todaySelect.value)
    {
        action += '/(today)/' + escape( todaySelect.value ); 
    }
    if (locationSelect.value)
    {
        action += '/(location)/' + escape( locationSelect.value ); 
    }
    if (keywordSelect.value)
    {
        action += '/(keyword)/' + escape( keywordSelect.value ); 
    }
    if (eventTypeSelect.value)
    {
        action += '/(eventType)/' + escape( eventTypeSelect.value ); 
    }
 
    form.action=action;
}

Example Javascript Form (with fallback)

<form action={"content/action"|ezurl} method="post"  onsubmit="defaultStaticFormToViewParameterUrlRedirect( '' )">
 
<input type="hidden" name="DestinationURL" value="{$node.url_alias}" />
 
<input type="text" name="(keyword)" value="" size="12" /> <br />
 
<input type="checkbox" name="(year)" value="1999" /> <br />
 
<input type="checkbox" name="(month)" value="12" /> <br />
 
<input type="submit" name="Submit" value="Go" />
 
</form>

Example Javascript Method #2

function eventFilter( i )
{
   var filter=document.getElementById( 'EventFilter' );
   var filter_action=filter.action;
 
   var offset=document.getElementById( 'Offset' );
   var date=document.getElementById( 'Date' );
   var city=document.getElementById( 'City' );
   var state=document.getElementById( 'State' );
   var country=document.getElementById( 'Country' );
   var production=document.getElementById( 'Production' );
   var coordinator=document.getElementById( 'Coordinator' );
 
   if ( offset.value != '0' )
   {
   filter_action += '/(offset)/' + escape( offset.value ); 
   }
   if ( date.value != 'all' )
   {
   filter_action += '/(date)/' + escape( date.value ); 
   }
   if ( city.value != 'all' )
   {
   filter_action += '/(city)/' + escape( city.value ); 
   }
   if ( state.value != 'all' )
   {
   filter_action += '/(state)/' + escape( state.value ); 
   }
   if ( country.value != 'all' )
   {
   filter_action += '/(country)/' + escape( country.value ); 
   }
   if ( production.value != 'all' )
   {
   filter_action += '/(production)/' + escape( production.value ); 
   }
   if ( coordinator.value != 'all' )
   {
   filter_action += '/(coordinator)/' + escape( coordinator.value ); 
   }
   filter.action=filter_action;
}

Reference

Custom module view Example Solution: bcposttoview
Custom design template Example Solution bceventfilter (Filter Bar and Results Display Examples)
Old Doc (Read comments), HTTP Post to URL conversion
Doc: Module View Parameters
Doc: Basic template tasks, Custom view parameters
Forum: Filter content passing values from URL
Forum: Content Filtering
Forum: Best way to multi filter
Search: Older mentions of an ezsystems module view called 'ezposttoview' which provided a custom module view solution for a time on ez.no which has since been deprecated (and further more was never publicly released)

Switching to rewrite rules

Wed, 11 Feb 2009 15:42:24 GMT

If you're switching from a setup where index.php is occuring in the URL, to a rewrite rule based setup, you can make sure any old links are properly redirected (with HTTP status MOVED PERMANENTLY) to the new URL without index.php. Put this in the appropriate virtual host context of your Apache configuration:

RewriteRule ^/index\.php/(.*)$ /$1 [L,R=301]

Running cronjobs and scripts with parameters in limited environment

Fri, 09 Jan 2009 14:15:30 GMT

Question

How can I run eZ Publish scripts and cronjobs with parameters on shared hosting without ssh.

You may only be allowed to run php files as a cronjob without any parameters and without the possibility to browse eZ Publish directory.

You also may not have command line access. Yeah, this can be pretty frustrating, but can not find or afford a better hosting solution.

Solution

When your provider doesn't allow you to run cronjob tasks with parameters and when your server runs php-cgi.

In order to run cronjob task with parameters, you can create a separate php file and then create a cronjob task pointing to that file.

Custom Script Example

Here is an example of the solution using the data_import extension as an example.

File: /path/to/ezpublish/extensions/custom/cronjobs/run_custom_cronjob_script.php

<?php
 
$output = shell_exec('cd /path/to/ezpublish/; /path/to/php5 runcronjobs.php import_images_csv');
 
echo "<pre>$output</pre>";
 
?>

The above example creates an output (as seen in the code) so you will know if your import is successful or not.

Web Browser Example

You may for very small tasks be able to run the above file from a web browser as long as the script completes quickly as browser requests do not work well with long running tasks.

The following tasks have been reported to be able to be run from the web browser with success if only limited. Most successes have been reported to resolve around limited execution time.

Scripts: Custom Scripts - Try limiting the execution time
Cronjobs: Data Import - Try limiting how much complicated data import you attempt each time
Database: Dump / Load / Custom SQL- Try using phpmyadmin or other dba tools

References

Clear Cache in eZ Publish

Wed, 17 Dec 2008 23:38:54 GMT

Introduction

How to clear cache using eZ Publish 4

Administration

Use the website administration interphase to clear all cache via a gui.

Simply navigate to Setup tab
Click the clear cache icon
Refresh browser window of website

Command line

If you know how to use the command line you can use it to clear cache.

Unix

If you are using a complete unix like operating system you can use the following command to clear and purge all cache within eZ Publish.

cd /path/to/ezpublish;
./bin/php/ezcache.php --clear-all --purge;

Windows

If you are using Windows you can use the following command to clear and purge all cache within eZ Publish.

# cd c:/web/pro/ezpublish/doc;
c:\php\php ./bin/php/ezcache.php --clear-all --purge;

Manual

If you are unable to use the administration gui or command line to clear cache, you can still remove the cache files manually.

cd /path/to/ezpublish;
rm -vrf /var/cache;
rm -vrf /var/ezwebin_site/cache

Specific: Clearing image alias cache

If you are unable to use the administration gui you can use this command line to clear this specific combination / type of cache.

cd /path/to/ezpublish;
 ./bin/php/ezcache.php --clear-id=imagealias --clear-all;
 ./bin/php/ezcache.php --clear-id=imagealias --clear-all --purge;
  ./bin/php/ezcache.php --clear-all --purge;

The above example commands suggested in the forum.

References

Publishing static pages from eZ Publish

Thu, 13 Nov 2008 01:34:44 GMT

Question

How does one publish static pages from a completed eZ Publish website installation?

Suggestion

Read the following reference and suggestion example.

Example

I used this to produce an inexpensive visual preview of a customer's eZ Publish website.

httrack http://ez  -O "."  -%v  -*layout* -*Calendar/* -*visual* --footer "" --preserve

References

Form: Publishing static pages

How to handle Information Collection in template.

Mon, 04 Feb 2008 23:11:45 GMT

Solution

This piece of template code iterating the already stored and collected information has only the purpose of demonstration.

{def $collection=fetch('content','collected_info_list', hash('object_id', $obj.id))}
{foreach $collection as $col}
  {$col.creator.contentobject.name|wash} {* name of the user who stored something into the i.c. *}
  {foreach $col.attributes as $colAttr}
      {$colAttr.contentclass_attribute_name}
     {attribute_result_gui view=info attribute=$colAttr}
  {/foreach}
{/foreach}

References

Doc: N/a

Fetching ezimage datatype image alias properties using PHP

Mon, 17 Dec 2007 10:05:11 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Introduction

Did you know that you can use the eZ Publish kernel api to obtain image alias properties from content object attributes which use the ezimage datatype.

Example

This is a simple php example of how you may use the eZ Publish kernel api to obtain image alias properties. This example comes from a simple example custom module view.

<?php
 
/**
 * File image.php
 *
 * @package image.php
 * @version //autogentag//
 * @copyright Copyright (C) 2007 Brookins Consulting. All rights reserved.
 * @license https://www.gnu.org/licenses/gpl.txt GPL License
 */
 
$Module =& $Params['Module'];
 
// START
 
// Assume this type of module/view url:
// www.site.com/myextension/mymodule/myview/1234
// 1234 maps to the view parameter, MyNode (eg: $Params["MyNode"])
 
// 0. Include the necessary files -- I would imagine that some are include
 
include_once( 'lib/ezdb/classes/ezdb.php' );
include_once( 'lib/ezutils/classes/ezfunctionhandler.php' );
include_once( 'lib/ezutils/classes/ezoperationhandler.php' );
include_once( 'lib/ezutils/classes/ezhttptool.php' );
include_once( 'kernel/common/template.php' );
include_once( 'kernel/classes/ezcontentclass.php' );
include_once( 'kernel/classes/ezpreferences.php' );
include_once( 'kernel/classes/datatypes/ezimage/ezimage.php' );
include_once( 'kernel/classes/datatypes/ezurl/ezurl.php' );
include_once( 'kernel/classes/datatypes/ezurl/ezurlobjectlink.php' );
 
// 1. Create an instance of the database
$db =& eZDB::instance();
 
// 2. Query the node via node id
$my_node =& eZContentObject::fetchByNodeID( $Params["MyNode"] );
// $my_node =& eZContentObject::fetchByNodeID( '86' );
 
// 3. Get a copy of the data_map
$my_node_data_map = $my_node->fetchDataMap();
 
// 4. Get a reference to the image
$my_node_image = $my_node_data_map["image"];
// $my_node_image_data = $my_node_image->DataText;
 
// Example Usage of the eZ Image Alias Handler Class / System
include_once( 'kernel/classes/datatypes/ezimage/ezimagealiashandler.php' );
 
// 5. Fetch Alias Handler
$image_alias_handler = new eZImageAliasHandler( $my_node_image );
 
// 6. Fetch Alias Attributes*
 
// 7. Fetch Original Image Path as URI
$my_node_image_uri =  "/" . $image_alias_handler->attributeFromOriginal( 'url' );
 
// 8. Fetch Original Image Dimentions
$my_node_image_width = $image_alias_handler->attributeFromOriginal( 'width' );
$my_node_image_height = $image_alias_handler->attributeFromOriginal( 'height' );
 
// 9. Get the associated link
$my_node_link_object = $my_node_data_map["my_link"];
$my_node_link_url_object = eZURL::fetch( $my_node_link_object->DataInt );
$my_node_link_url=str_replace ( "/", "+", $my_node_link_url_object->attribute( 'url' ) );
 
// 10. Instantiate the template and set the template vars
$tpl =& templateInit();
$tpl->setVariable( 'parameters', $Params );
$tpl->setVariable( 'my_node_image_path', $my_node_image_uri );
$tpl->setVariable( 'my_node_image_width', $my_node_image_width );
$tpl->setVariable( 'my_node_image_height', $my_node_image_height );
$tpl->setVariable( 'my_node_link_url', $my_node_link_url );
 
// END
 
// phpinfo();
eZExecution::cleanExit();
 
?>

References

ezimagealiashandler

Overriding kernel error templates

Sun, 25 Nov 2007 09:11:01 GMT

Match conditions

Templates used/called by the kernel/error view do indeed have a couple design keys that could be used for override via override.ini(.append.php). Besides the obvious Source filter, it is also possible to use:

error_type: this is always kernel for the standard modules,
error_number: 1 for access denied, etc.

For all intents and purposes, however, this is not a viable method of displaying custom error templates because it is not possible to match on a given view.

Template variables

kernel/error/view.php passes very (very) little useful information to the various error_code templates, so there is nothing natively available in these templates to
use for doing things like for example a switch/case on section.

The best solution at the time of writing is to use $redirect_uri, from which it is possible to extract the module, current node ID, etc.

Author

Based on a summary by Andrew Kelly in Trouble overriding "Access Denied" template (eZ forums)

Reference

Disable Dirty Object Draft Edit Show Versions View

Wed, 14 Nov 2007 14:16:48 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Need

To ensure that users who are editing their own content objects on the frontend are not bothered by encountering the "existing drafts" window / page.

Solution

One solution may be to use the following setting to provide for the above need.

Setting

Default setting from the setings file, settings/site.ini

[ContentSettings]
# What to do when editing an object that has draft versions newer than the current version.
# Use 'showversions' to select which version to edit, or 'usecurrent' to always edit the current version.
EditDirtyObjectAction=showversions|usecurrent

Solution setting for your setings override file, settings/override/site.ini.append.php

[ContentSettings]
 EditDirtyObjectAction=usecurrent

References

Doc: Reference - EditDirtyObjectAction

Import existing content object url aliases into eZ using the eZUrlAlias API

Fri, 26 Oct 2007 18:54:50 GMT

Question

How to create though data import (content migration) a complex maping of internal url aliases into eZ Publish for compatibility internal with existing urls

Reference

Forum: Migration to eZ Publish : A url migration solution

How to change the datatype of attributes?

Mon, 08 Oct 2007 05:15:40 GMT

There's no feature currently included with eZ Publish to change an attribute's datatype. However, there are some methods for it already.

Internally compatible datatypes

If a datatype is internally compatible, which means it stores both its class level and object level data in the same way in the database fields of ezcontentobject_attribute and ezcontentclass_attribute, then you can use some simple SQL to change the datatypes. The following example SQL will change all attributes of the datatype with identifier "places" to the datatype with identifier "ezinteger":

UPDATE ezcontentclass_attribute SET data_type_string='ezinteger' WHERE data_type_string='places';
[UPDATE ezcontentobject_attribute SET data_type_string='ezinteger' WHERE data_type_string='places';

Non-internally compatible datatypes

There is an experimental extension available at https://ez.no/developer/contribs/datatypes/datatypes. You can write plug-ins for it to handle conversion of specific datatypes.

References

Forum: Change Object Content Class
Forum: Converting ezstring to ezxml with ezchangeclass extension
Forum: Changing an attribute datatype (Outdated information)
Contribution: Object content class change

Checking out all projects.ez.no subversion repositories

Mon, 24 Sep 2007 08:45:13 GMT

Problem

There is a lot of individual projects svn repositories!
How to get your head around so many projects.
This is how you can check them all out quickly ...

Resources

Project Repositories: List of svn repository url locations within in csv file, repositories.csv
- Warning: "...there are DOS EOL markers XD in that .csv file XD"

Solutions

Checking out with shell commands

wget -q -O - 'https://projects.ez.no/repositories.csv' | tr -d '\015' | xargs -i svn co {}

Checking out with php commands

<?php
 
 
$handle = fopen( "https://projects.ez.no/repositories.csv", "r" );
$row = 1;
 
while ( ( $data = fgetcsv( $handle, 1000, "," ) ) !== FALSE) {
    $num = count($data);
    // echo "** <p> $num fields in line $row: <br /></p>\n";
 
    $row++;
    for ($c=0; $c < $num; $c++) {
        $line = $data[$c];
 
        $repo = escapeshellcmd( $line );
        $name = split( "/", $repo );
        $name = $name[3];
        // print_r( $name );
        // Example: http://svn.projects.ez.no/bcwebsitestatistics
 
        $last_line = system("svn co $repo", $retval );
 
        echo "Repository Name: ". $name . "\n";
        echo "Repository URL: ". $repo . "\n";
        echo "Checkout Last Line: ". $last_line . "\n";
 
        if( $retval == "0" )
        {
          echo "Checkout: ". "Success" . "\n";
        }
        else {
          echo "Checkout: ". "Failure" . "\n";
        }
        echo "\n\n";
 
        // DEBUG: Print additional information
        /*
        echo '
        </pre>
        <hr />Last line of the output: ' . $last_line . '
        <hr />Return value: ' . $retval . "\n\n";
        */
    }
}
 
fclose( $handle );
 
?>

Dealing with content object corruption

Sat, 25 Aug 2007 20:10:36 GMT

About

Dealing with content object corruption or what to do with a corrupt eZ Publish Database?

External References

Forum: Problem: corrupt contentobjects

How to do an attribute filter using the like condition

Mon, 13 Aug 2007 08:43:28 GMT

We have seen this question asked many times and wanted to ensure this question is simpler to answer in the future

Question

How exactly do you use an attribute filter using the like condition?

Solutions

These solutions have been tested but may not be generic, so some modifications to ids etc may be required.

Filter by Class/Attribute Identifier

{def $c=fetch( 'content', 'tree', hash( 'parent_node_id', 175,
               depth, 7,
               attribute_filter, array( array( 'article/keywords', 'like', '*string*' ) )
               ) )}
 
{$c|attribute(show,1)}
{$c.0|attribute(show,1)}

Filter by Attribute ID

{def $c=fetch( 'content', 'tree', hash( 'parent_node_id', 175,
                depth, 7,
                attribute_filter, array( array( 865, 'like', '*string*' ) )
                ) )}

Filter by dynamic string variable

{def $tag='string'}
{def $c=fetch( 'content', 'tree', hash( 'parent_node_id', 175,
                depth, 7,
                attribute_filter, array( array( 'article/keywords', 'like', concat( '*', $tag, '*' ) ) )
                ) )}

Warning

Be certain to clear cache or disable cache!

References

Forum: How to use an attribute filter like condition?
Doc: Reference, fetch functions, list

Template Development Without Clearing Cache

Mon, 13 Aug 2007 08:17:49 GMT

You can do template development without having to constantly clear cache! This page is perhaps one of the most important to the largest number of users in the community.

Global Example

Simply add these settings to the following file and clear cache (one last time)

The following example works great with both eZ Publish 3.9 and even better (solution for the best template debug information) with 4.0.

Example File: setting/override/site.ini.append.php

[ContentSettings]
ViewCaching=disabled
 
[TemplateSettings]
TemplateCache=disabled
TemplateCompile=disabled
DevelopmentMode=enabled
CacheThreshold=0
ShowUsedTemplates=enabled
# TemplateOptimization=enabled
 # Debug=enabled

References

None

Reasons to become an eZ Partner

Sun, 12 Aug 2007 09:58:05 GMT

There are many reasons why regular users of eZ Publish should join eZ systems as eZ Partners

Reasons

Communication; Increased communication between eZ Systems and you
Ecosystem; Become an integral part of the worldwide ecosystem dedicated to the advancement of eZ
Discounts; Discounts for all eZ Systems Products and Services; Including eZ Systems Support
Advertising; Have your business advertised on ez.no in the worldwide partner directory
Points; Earn points which raise your level in the ecosystem, partner directory and partner level

Consider the following

An Investment; If your going to be using eZ Publish in 6 Months from now wouldn't you prefer to earn benefits during this time?
Potential Savings; If, in the future you wish to purchase support, consulting, services or products from eZ Systems; as a partner you are entitled to valuable discounts.
Growth; While you use eZ publish it helps greatly to network with those who have a wealth of experiance in eZ. Becomming a partner opens up oportunities for growth

External References

Retrieving all packages eZ Publish 3.8

Sat, 11 Aug 2007 04:14:56 GMT

External references

Forum: How to retrieve all packages for eZ Publish 3.8 Installation

Microsoft Vista and Webdav

Sun, 05 Aug 2007 20:38:44 GMT

Problem

I just setup a webdav site. It didn't work. Then I found out that none of my ez webdav sites are working - shocking!

Cause

Well, the reason is: You can't open a webdav site with CTRL+O like it was before at Windows XP and Explorer.

Solution

You need to open, Start -> Computer -> Extras -> add network resource
Choose "web folder" (or is there "webdav" in english?)
Enter the url WITHOUT # at the end! Like, https://webdav.mysite.com/
Save it - works again.

Reference

Forum: webdav and vista

Dealing with templates with static strings or ids

Tue, 03 Jul 2007 04:29:22 GMT

Description

You should not leave static strings or ids within a customized template where ever possible.

Instead you should move these into a settings file and make reference to the custom settings variables you define.

Example

This example should show clearly a basic example of how to store your custom variable contents within a settings file and access them in a template.

Setting

File: s ettings/override/example_com.ini.append.php

<?php /* #?ini charset="utf-8"?
 
[CustomNodeIDs]
NodeName001=42
NodeName002=84
NodeName003=11
 
*/ ?>

Template

File: design/standard/templates/pagelayout.tpl

{def $node_name_001 = ezini( 'CustomNodeIDs', 'NodeName001', 'example_com.ini' )}
{if is_set( $node_name_001 )}
    [...display something...]
{else}
   [...display something else...]
{/if}

Reference

Template Operator: ezini

Website toolbar for custom classes

Sat, 19 May 2007 10:10:31 GMT

By default, the website toolbar in 3.9 is only shown for classes shipped with the website interface. If you want it to be shown for a custom class, add your class' name to the AvailableForClasses[] array in extension/ezwebin/settings/websitetoolbar.ini and clear the cache ;)

If your class is a container, you also need to add it to the ContentClassContainers array in the same file to enable creating objects under it.

Embedding a poll content object within a page

Mon, 16 Apr 2007 12:40:12 GMT

Brief

eZ publish offers the ability to embed content objects within a template.

Question

How to ... embedded Poll in page

Solution

See related forum thread.

External references

Forum: Poll embedded in page

Using eZ publish doxygen api documentation

Mon, 09 Apr 2007 04:49:59 GMT

About

eZ Publish PHP source code contains inline documentation. The inline documentation uses the doxygen format. This inline documentation can be processed and used to build html documentation based on the contents of the eZ Publish PHP source code.

Hosted Doxygen Documentation

PubSVN hosts a regularly updated copy of this generated html doxygen documentation which is built from the eZ Publish Trunk Subversion Repository. This documentation offers a unique perspective in looking and searching quickly for information about the eZ Publish PHP source code and available APIs.

https://pubsvn.ez.no/doxygen/

External reference

Project: Doxygen
Doxygen Manual
Download Doxygen Software
Download eZ publish

x86-64 etc, php, ez documentation

Tue, 03 Apr 2007 20:06:52 GMT

Nesting : A potential issue

Error

Fatal error: Maximum function nesting level of '64' reached, aborting! in /var/www/vhosts/ez/lib/eztemplate/classes/eztemplatecompiler.php on line 1330
Fatal error: Maximum function nesting level of '64' reached, aborting! in Unknown on line 0
Fatal error: Maximum function nesting level of '64' reached, aborting! in Unknown on line 0
Fatal error: Maximum function nesting level of '64' reached, aborting! in Unknown on line 0

Addressed

As a 64 bit error, https://issues.ez.no/3609

Forum: https://ez.no/community/forum/install_configuration/install_problem_with_3_4_php_error_due_to_function_nesting

Solution:

It's a good idea to disable or remove xdebug from your production server until you are certain you must enable it to solve a specific problem.

xdebug.max_nesting_level = 100

Rounded Corners on Images

Tue, 27 Mar 2007 23:38:57 GMT

Abstract: Image processing is a very powerful feature of eZpublish. This article shows you how to combine 24 bit PNG images with ImageMagick via the eZpublish image alias system, and to produce images with pre-rendered rounded corners.

**************************************************************
There are a number of ways of approaching this problem.
It is possible to overlay a mask (a second image with a transparent centre) in an overlaid div, but this solution has one big drawback: Internet Explorer has patchy support for the only image format which has full alpha support, png24. Which means you are stuck with using a gif, and with jagged edges.
A much better way is to get ImageMagick, one of the graphics processors included with EzPublish, to do the work. It is theoretically possible to get ImageMagick to measure the picture and draw the mask, but this is complicated (if anyone gets it to work please let us know). These discussions may be a good starting place if you feel like taking this to the next level:
https://www.imagemagick.org/Usage/thumbnails/#rounded_border
This section of the ImageMagick useage manual gives details on this, but there are hurdles which would need to be overcome, such as getting ImageMagick in EzPublish to read external vector files (.mvg)
and some more discussion here.
https://www.imagemagick.org/discourse-server/viewtopic.php?f=1&t=8401
For my particular use case we needed the resulting images to conform to an exact size, so rather than tackling the really hard stuff I elected to get ImageMagick to pull a png24 matt image from the design directory and overlay it on the source image. This is a simpler version of the technique described here:
https://www-128.ibm.com/developerw...y/l-graf2/?ca=dgr-lnxw15GraphicsLine
but as the final image size is pre-determined there is no need to add the corners individually.
The first thing you'll need to do is to establish whether the version of ImageMagick supports the -composite command. In the case of our host, Atvert Systems, we discovered that they were running the default version which shipped with the operating system - 6.0.7.1-16. (and this situation is quite likely for a professional hosting environment where system stability is more of a priority than having the latest versions of all components)
Luckily Karl, who runs Atvert, was very helpful in identifying the problem and he quickly upgraded ImageMagick to version 6.3.2.7-1, which supports the necessary commands.
The next step is to make a test graphic, you can skip this if you are feeling really sure of yourself but I'd recommend it - you'll probably save yourself a few headaches. Make a two layer Photoshop (but make sure you convert the background layer to an normal one in PS's case) or Gimp file, put the word 'front' on one layer and the work 'back' on another, both with transparent backgrounds. Export the two layers as png24s with transparency. Put the 'front' one in your siteaccess images folder - that will eventually be your matt.
You now need to find out the 'fully qualified path' to that folder. It won't be the ftp path. In our case in involved prepending /var/www/html/ to the address you see in an ftp client. It's probably best to contact your hosting provider on this, unless you feel like a lot of guessing.
Next, open image.ini.append.php. you can do this in either the siteaccess copy or the override copy. Just don't do it in both ! :)
The first thing to add is the filter definition, it goes in the [ImageMagick]
section:

[ImageMagick]
Filters[]=rounded=-compose dst-over -composite -gravity NorthWest /var/www/html/ ... more path goes here ... /design/news_site/images/picmask.png

This makes a filter called 'rounded', makes the destination go over the source, references the overlay to the top left corner and calls the matt image
The -gravity switch may not be necessary.
Next, make an alias for the image which will use the filter:

[AliasSettings]
AliasList[]=mypicturewitharoundedborder

Finally, add the filters to the alias;

[mypicturewitharoundedborder]
Filters[]=geometry/scalewidth=156 Filters[]=geometry/crop=156;90;0;0
Filters[]=rounded=

The final filter applies the mask.
Save and upload the ini file, go to your EzPublish Online Editor, choose an image (the 'back' one you made earlier) choose the mypicturewitharoundedborder alias from the dropdown and publish. When you are happy that it's working delete the 'front' image and replace it with one that does something useful!
Thanks to Bruce Morrison from DesignIT for his invaluable help in wrangling ImageMagick's sometimes slightly-less-than-intuitive command line syntax.

Disable language selection prompt

Sun, 25 Mar 2007 07:32:16 GMT

You can simply disable the language selection dialog by providing a default or custom setting.

External reference

skip language selection whi...

Online Editor copy and paste privilige settings in Mozilla based browsers

Thu, 22 Mar 2007 00:12:42 GMT

Introduction

Mozilla and Firefox displays an error using the Online Editor without additional browser profile settings.

This is a common occurance for most casual users. Many don't quite understand this behavior. We hope this article provides for a clear explanation.

Error

"Quote"

Reasoning

Client side scripts should be required to ask first for permissions. This is a good solution.

Solution

Add the settings ...

External reference

Issue: 7131
Forum: N/A

Inserting inline client script into content using a custom tag

Tue, 20 Mar 2007 05:56:06 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Summary

On: Monday 12 March 2007 6:58:37 pm
From: Diego Barcia

Instructions

For a site, I needed to insert JavaScript statements to be parsed and not displayed by the browser, on a page-by-page basis. So I configured a <script> custom tag of an inline type into the content.ini file of the admin and the public siteacceses:

AvailableCustomTags[]=script
IsInline[script]=true

Then, I created a template file in the \templates\content\datatype\view\ezxmltags\ directory (of the site's design), called script.tpl, with this code:

<script type="text/javascript" language="javascript">{$content}</script>

This worked fine. There is no need to wrap the $content variable within {literal} operators; there won't be any trouble using JavaScript curly braces ('{', '}').
The custom tag *must* be of an inline type, or else a parse error will be triggered by the engine, because block tags are printed between <p> tags, so the result would be like:

<p>{JavaScript code}</p>.

Building an automated eZ publish demo

Sat, 10 Mar 2007 19:58:02 GMT

Tools

eZ publish
MySQL
Subversion
Cron

Setup

Install and configure stock eZ
Write script to drop demo db, load a stock db and optionally update demo code from svn.
Configure cron to run script

External reference

Tools: https://zev.ez.no/svn/dev_tools

Working with eZ publish translations

Thu, 08 Mar 2007 07:42:13 GMT

About

eZ publish translations are both simple to create and update.

Dependencies

QT Toolkit
QT Linguist
ezlupdate

You will want to make certain you have QT Linguist and ezlupdate created and installed properly before continuing.

Using QT Linguist

Using Linguist with eZ publish

Loading eZ publish translation

Modifying eZ publish translation

Saving eZ publish translation

Loading modified eZ publish translation into eZ publish

Modifying stock eZ publish

...

Using a translation extension

...

Creating an extension translation

mkdir ezexample/translations/
jack@host:/web/ez/$ /web/ez/bin/linux/ezlupdate -u --extension ezexample eng-US
Extension mode, directory: ezexample
eZ publish translations directory created: ezexample/translations/eng-US
eZ publish translations directory created: ezexample/translations/untranslated

External reference

Creating a translation extension

Translating from French to English using ezwebin

Overriding the default website interface extension

Wed, 07 Mar 2007 10:58:57 GMT

If you want to override the default website interface style sheets and templates, here is one method of acheiving it.

Create the following structure in the extension directory:

In the extension/ezwebin_custom/settings directory create a file called design.ini.append.php with the following content:

<?php /*
[ExtensionSettings]
DesignExtensions[]=ezwebin_custom
*/ ?>

Edit settings/override/site.ini.append.php file and add this into the [ExtensionSettings] block:

ActiveExtensions[]=ezwebin_custom
Note that ezwebin_custom must be placed BEFORE ezwebin to override it. For example like:

[ExtensionSettings]
ActiveExtensions[]=ezodf
ActiveExtensions[]=ezdhtml
ActiveExtensions[]=ezwebin_custom
ActiveExtensions[]=ezwebin

Edit the [DesignSettings] block of settings/siteacees/your_default_site_access so that the default SiteDesign matches the name of the design folder in your new extension e.g. design/ezwebin_custom would require setting SiteDesign=ezwebin_custom. Also make sure ezwebin is added to the AdditionalSiteDesignList. Example:

[DesignSettings]
SiteDesign=ezwebin_custom
AdditionalSiteDesignList[]=base
AdditionalSiteDesignList[]=ezwebin

Copy stylesheets from 'extension/ezwebin/design/ezwebin/stylesheets' to your custom design extension 'extension/ezwebin_custom/design/ezwebin/stylesheets'. Edit these to make style shanges.

You should now be able to create system and override templates as you would be used to in previous versions, except you will now be working in the extension/ezwebin_custom/design/ezwebin_custom directory rather than design/your_site_access/.

Class and template editing are disabled by default since the 3.9.0 release. A solution to this problem is to modify SiteAccessRules to allow advanced editing.

Creating ezpkg packages

Tue, 06 Mar 2007 22:10:18 GMT

Description

You might want to create custom deb packages of your own supported eZ publish requirements.

As many distributions have poor support for PHP 4.4 branch (atm) many users find themselves installing their own software to provide PHP 4.4 or greater.

Examples

Examples of software possibly worth packaging for production server software management.

sitedesigns
extensions
content classes
content packages

Commands

No command summary provided at this time.

Create eZ extension package for 3.9

Create xyz in /a/b/c/

root@localhost:#

Paste this into vim, save and quit

Build deb

External reference

Forum: none

Creating deb packages

Tue, 06 Mar 2007 22:03:51 GMT

Description

You might want to create custom deb packages of your own supported eZ publish requirements.

As many distributions have poor support for PHP 4.4 branch (atm) many users find themselves installing their own software to provide PHP 4.4 or greater.

Examples

Examples of software possibly worth packaging for production server software management.

eZ
PHP
Apache
MySQL

Custom source repositories

Dotdeb is an unofficial repository containing many packages for the Debian stable (aka “ Sarge“) distribution

They have many packages which may meet your basic needs and free you from the need to create a custom package.

SQL

Commands

No command summary provided at this time.

The basic process is as follows

Create file
Build deb
Install PHP

Create PHP4.4.6 deb

Command Desc

Build deb

Then you might ...

Install deb

External reference

Select distinct using a function definition

Thu, 01 Mar 2007 19:43:39 GMT

Background

Summary of thread ...

Question

Is there any way to use a "SELECT DISTINCT" query using the following function definition?

Solution

See forum thread ...

External Reference

Forum: [solved] Function definition, Select Distinct

Fetch random image

Fri, 23 Feb 2007 08:03:40 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Example template

{def $nrimages=fetch( 'content', 'tree_count', hash( 'parent_node_id', 2, 'class_filter_type', 'include', 'class_filter_array', array('image') ) )}
{def $randomimage=fetch( 'content', 'tree', hash( 'parent_node_id', 2, 'class_filter_type', 'include', 'class_filter_array', array('image'), 'offset', rand(0, dec($nrimages)), 'limit', 1 ) )}
{content_view_gui content_object=$randomimage[0] view=embed}

Reference

Forum: N/A

Creating rpm packages

Sat, 17 Feb 2007 18:16:29 GMT

Description

You might want to create custom rpm packages of your own supported eZ publish requirements.

As many distributions have poor support for PHP 4.4 branch (atm) many users find themselves installing their own software to provide PHP 4.4 or greater.

Examples

Examples of software possibly worth packaging for production server software management.

eZ
PHP
Apache
MySQL

Commands

No command summary provided at this time.

The basic process is as follows

Create spec file
Build rpm and srpm
Install PHP

Create PHP4.4.6 RPM

Create Spec File

root@lotta:~/> vim /usr/src/packages/SPECS/.spec

Build rpm and srpm

root@lotta:~/> cd /usr/src/packages/BUILD
root@lotta:/usr/src/packages/BUILD> rpmbuild -ba .spec

Install PHP rpm

root@lotta:~/> rpm -i /usr/src/packages/RPMS/i586/php-4.4.6-1.i586.rpm

Example Spec Files

Create PHP4.4.6 RPM for Suse Linux Enterprise Server 10

Paste this into the file /usr/src/packages/SPECS/.spec

%define name php
%define version 4.4.6
%define release 1
%define _prefix /usr
%define var --with-apxs2=/usr/sbin/apxs2-prefork --with-gd --with-t1lib --with-jpeg-dir --with-png-dir --with-zlib-dir --with-ttf --with-freetype-dir --with-t1lib --enable-gd-native-ttf --enable-gd-jis-conv --enable-bcmath --enable-calendar --with-curl --with-dom --with-xmlrpc --enable-ftp --with-iconv --with-gettext --enable-mbstring --with-mcrypt --with-mhash --enable-sockets
 
Summary: PHP is a server-side scripting language for creating dynamic Web pages
Name: %{name}
Version: %{version}
Release: %{release}
Source: https://no.php.net/distributions/%{name}-%{version}.tar.gz
Vendor: The PHP Group
URL: https://www.php.net/
License: The PHP License
Group: System Environment/Libraries
Prefix: != %{_prefix}
BuildRoot: /tmp/%{name}-buildroot
 
 
%files
/bin
/include
/lib
/etc
/man
%defattr(-,root,root)
 
%description
PHP is a server-side scripting language for creating dynamic Web pages.
 
%prep
%setup -q
 
%build
echo %{_prefix}
./configure --prefix=$RPM_BUILD_ROOT %{var}
make
 
%install
rm -rf $RPM_BUILD_ROOT
make ROOT="$RPM_BUILD_ROOT" install
 
%clean
rm -rf $RPM_BUILD_ROOT
 
%changelog
* Thu Mar 6 2007 Kim Johansen <[email protected]>
- First draft of the spec file

Create PHP4.4.6 RPM for CentOS 4.4

Paste this into the file /usr/src/packages/SPECS/.spec

%define name php
%define version 4.4.6
%define release 1
%define _prefix /usr
%define var --with-apxs2=/usr/sbin/apxs --with-gd --with-t1lib --with-jpeg-dir --with-pn\
g-dir --with-zlib-dir --with-ttf=/usr/include/freetype1 --with-freetype-dir=/usr/include/freetype2 --with\
-t1lib --enable-gd-native-ttf --enable-gd-jis-conv --enable-bcmath --enable-calendar --with-curl --with-d\
om --with-xmlrpc --enable-ftp --with-iconv --with-gettext --enable-mbstring --with-mcrypt --with-mhash --\
enable-sockets
 
Summary: PHP is a server-side scripting language for creating dynamic Web pages
Name: %{name}
Version: %{version}
Release: %{release}
Source: https://no.php.net/distributions/%{name}-%{version}.tar.gz
Vendor: The PHP Group
URL: https://www.php.net/
License: The PHP License
Group: System Environment/Libraries
Prefix: != %{_prefix}
BuildRoot: /tmp/%{name}-buildroot
 
 
%files
/bin
/include
/lib
/etc
/man
%defattr(-,root,root)
 
%description
PHP is a server-side scripting language for creating dynamic Web pages.
 
%prep
%setup -q
 
%build
echo %{_prefix}
./configure --prefix=$RPM_BUILD_ROOT %{var}
make
 
%install
rm -rf $RPM_BUILD_ROOT
make ROOT="$RPM_BUILD_ROOT" install
 
%clean
rm -rf $RPM_BUILD_ROOT
 
%changelog
* Thu Mar 9 2007 Graham Brookins <[email protected]>
- First draft of the spec file

External reference

Creating and maintaining an eZ publish patch

Thu, 15 Feb 2007 23:31:07 GMT

While I have little hesitation in creating a patch directory structure within an the related extension or settings extension for the instance of that site installation there is a bit of work in keeping track of these modifications or patches for future upgrades.

Storing patch files in an extension

This makes patching fairly simple to repeat. Sometimes I use a patch file, sometimes I only use instances of the modified file and original file.

Path: [ Patch Base Path] + [ Version of eZ] + [ Relative Stock Path]

extension/ezexample/patch
extension/ezexample/patch/3.8
extension/ezexample/patch/3.9
extension/ezexample/patch/3.10
extension/ezexample/patch/3.10/kernel/shop/module.php
extension/ezexample/patch/3.10/kernel/shop/module.php.orig
extension/ezexample/patch/3.10/kernel/shop/module.php.diff

Example

Example of extension's which include kernel patches and or patch directory structure. (...)

Include path

Still, I can't remember if my tests in modifying the include_path were successful, I don't remember using it regularly after my first encounter with it.

The idea being you can add a file path to the php include path configuration variable which should allow you to be able to in affect override a specific stock file without having to actualy replace the stock file.

Example php.ini setting

Example of the php.ini setting requirered to override a stock eZ publish file (kernel or lib) (...)

External reference

Forum: core extend kernel code

Overriding the eZ Web Interface (ezwebin) with custom designs

Wed, 07 Feb 2007 20:22:06 GMT

The original source for most of this material comes from a blog post by an eZ publish developer.

If you've installed 3.9.0 with the eZ Web Interface (hereinafter referred to as ezwebin) but need to customize your siteaccess to differ from the demo design, your first step is to get your hierarchies organized to override the default ezwebin design on a per-siteaccess basis.

Note: pay careful attention to order of ActiveExtensions in following two examples. In case of CSS your extension has to be listed below ezwebin, but for templates above it.

To Modify CSS (Without Modifying Templates)

1. Go to your /extension/directory and replicate the structure of ezwebin for your own design name. For example, if your siteaccess is "my_siteaccess" and your desired design is "my_design" then you'll create a structure as follows:

extension
| -ezwebin
| -my_design
| | -- design
| | | --- ezwebin
| | | |---- images
| | | |---- stylesheets
| | | |---- templates
| | -- settings

Note that you want to leave the original ezwebin directory intact, but merely mimic its' structure. Also, note that in the my_design/design directory, the correct name of the child is ezwebin (for 3.9.0) as this is where your CSS overrides will be placed and seen by the system.

2. Next, you'll want to initialize your design in the system. Go to extension/my_design/settings/ and create a new file named "design.ini.append.php" Inside, specify the following settings:

<?php /*
[ExtensionSettings]
DesignExtensions[]=my_design
*/ ?>

3. Now is the best time to copy the CSS files and templates from extension/ezwebin/design/ezwebin into your newly created extension/my_design/design/ezwebin so you can modify their contents to suit your design needs.

4. Next, you'll need to make the system aware that your new "extension" (conceptually) exists. To do that, go to settings/override/site.ini.append.php and open it for editing. Find the section for [ExtensionSettings] and active your extension LAST (in order) as follows:

[ExtensionSettings]
ActiveExtensions[]
ActiveExtensions[]=ezwebin
ActiveExtensions[]=ezdhtml
ActiveExtensions[]=ezodf
ActiveExtensions[]=my_design

5. Last, you'll need to edit the settings/siteaccess/my_siteaccess/site.ini.append.php to make it aware that your extension design exists. Add your design FIRST (in order), although it may seem a little counter-intuitive at first glance.

[DesignSettings]
SiteDesign=my_design
AdditionalSiteDesignList[]=ezwebin
AdditionalSiteDesignList[]=base

6. You're done. Login to your Admin view and clear *all* cache. Voila, your new CSS files will be used.

NOTE: At this time, there appears to be a bug. CSS file are honored by the system (but templates are currently not honored).

To Modify Templates (Without Modifying CSS)

extension
| -ezwebin
| -my_design
| | -- design
| | | --- ezwebin
| | | |---- images
| | | |---- stylesheets
| | | |---- templates
| | -- settings

Note that you want to leave the original ezwebin directory intact, but merely mimic its' structure. Also, note that in the my_design/design directory, the correct name of the child is ezwebin (for 3.9.0) as this is where your TPL overrides will be placed and seen by the system.

2. Next, you'll want to initialize your design in the system. Go to extension/my_design/settings/ and create a new file named "design.ini.append.php" Inside, specify the following settings:

<?php /*
[ExtensionSettings]
DesignExtensions[]=my_design
*/ ?>

[ExtensionSettings]
ActiveExtensions[]
ActiveExtensions[]=ezdhtml
ActiveExtensions[]=ezodf
ActiveExtensions[]=my_design
ActiveExtensions[]=ezwebin

[DesignSettings]
SiteDesign=my_design
AdditionalSiteDesignList[]=ezwebin
AdditionalSiteDesignList[]=base

6. You're done. Login to your Admin view and clear *all* cache. Voila, your new TPL files will be used.

NOTE: At this time, there appears to be a bug. TPL file are honored by the system (but stylesheets are currently not honored).

To Modify Both CSS and Templates (Special Case)

You must consider your implementation of eZ publish. This workaround is valid if 1) you have only one frontpage/user view (non-admin view) siteaccess OR 2) if all your frontpage/user view (non-admin view) siteaccesses will use the CSS changes. This work around is not valid if you have multiple siteaccesses which must use different stylesheets.

The strategy here is to setup template overrides in the method recommended by eZ Systems, then to craft a workaround so CSS overrides are used (across all non-admin siteaccesses).

extension
| -ezwebin
| -my_design
| | -- design
| | | --- ezwebin
| | | |---- images
| | | |---- stylesheets
| | | |---- templates
| | -- settings

Note that you want to leave the original ezwebin directory intact, but merely mimic its' structure. Also, note that in the my_design/design directory, the correct name of the child is ezwebin (for 3.9.0) as this is where your TPL overrides will be placed and seen by the system.

2. Next, you'll want to initialize your design in the system. Go to extension/my_design/settings/ and create a new file named "design.ini.append.php" Inside, specify the following settings:

<?php /*
[ExtensionSettings]
DesignExtensions[]=my_design
*/ ?>

[ExtensionSettings]
ActiveExtensions[]
ActiveExtensions[]=ezdhtml
ActiveExtensions[]=ezodf
ActiveExtensions[]=my_design
ActiveExtensions[]=ezwebin

[DesignSettings]
SiteDesign=my_design
AdditionalSiteDesignList[]=ezwebin
AdditionalSiteDesignList[]=base

6. Place your modified CSS files in extension/my_design/design/ezwebin/override/stylesheets (reminder: this will affect all your non-admin siteaccesses which use the eZ Web Interface).

7. Place any images need by your CSS files into extension/my_design/design/ezwebin/overrides/images

8. You're done. Login to your Admin view and clear *all* cache. Voila, both your new TPL files and your new CSS will be used on all siteaccesses which use the ezwebin (eZ Web Interface).

To Modify Both CSS and Templates (Universal Method)

There is not currently a verified workaround strategy which will allow targeting of individual siteaccesses for both modified CSS and Templates. The bug report contains some suggested methods, but they are not yet verified as working (please note eZ Systems has asked no further discussion on the bug report itself, so please discuss this issue either on the eZ forums or IRC (Freenode #ezpublish).

Read-only site

Tue, 23 Jan 2007 07:55:36 GMT

For a general description of read-only, we recommend Read-only on Wikipedia.

Howto

You can temporarily make your eZ publish site read-only, for example when

you're moving it to another server
you want to upgrade it to a new major release, but because you don't want to have a downtime you made a copy of it on which you will run the upgrade script and which will become the new "production" site

Use the following site access rule settings in settings/override/site.ini.append.php to make your site read-only. Note that this also affects the administration interface.

[SiteAccessRules]
Rules[]
Rules[]=access;disable
Rules[]=moduleall
Rules[]=access;enable
Rules[]=module;content/view
Rules[]=module;content/download
Rules[]=module;content/search
Rules[]=module;content/advancedsearch
Rules[]=module;user/login
Rules[]=module;user/logout

Depending on the functionality of your site, you can still choose to allow access to other modules and views, like user/preferences.

Known bugs

#9953: website root / disabled although access to the content/view module is enabled (fixed in 3.9.1, 3.8.7, 3.7.10, 3.6.12)

External resources

SiteAccessRules documentation

Dynamic Layouts - Managing Style as Content

Sun, 21 Jan 2007 06:49:39 GMT

About

This is a different approach to template design. It is the creation of a container class, Div, that allows the content editor (or designer) to style the div and store the settings as content.

The div content is object relations into the system. This allows a great amount of design control, without requiring template or CSS modifications.

Application

The intent of this class and template is to allow page-specific styles, images, and layouts to be applied to single pages, without creating node override templates or custom classes. Page-specific images that are placed in CSS files create a significant amount of overhead, and this alleviates that overhead, and makes the images more manageable.

Notes

The objective of the class is primarily layout, to divide the {$module_result.content} area into divs that can be managed as eZ content, instead of templates with CSS files. It is a recursive looping template, that first delivers a named div, then the style tags of the container, followed by the styled div, and including the children, with the same approach. The children use object relations to refer to content within the system.

Class

The class has the following attributes:

Name - Name of div, and object/node
Class - General CSS class - can be used in conjunction with CSS files
Style - Text block with any style tag content. {} will be added by the template
Background Image - Web ready background image. Original image will be used. Height and width can be entered manually, or omitted.
Content - Optional object relations to content within the system. node/view/line is used to display content

Template

{def $children=fetch(&apos;content&apos;,&apos;list&apos;,hash(parent_node_id,$node.node_id,sort_by,$node.sort_array))}
 
<div name="{$node.name|wash}">
<style>
#{$node.name|wash}
{ldelim}
{$node.data_map.style.content}
{if $node.data_map.background_image.has_content}
background-image: url({$node.data_map.background_image.content.original.url|ezroot(&apos;single&apos;,&apos;full&apos;)});
{/if}
{rdelim}
</style>
 
<div id="{$node.name|wash}" class="{$node.data_map.class.content|wash}" >
{if $children|count|gt(0)}
{foreach $children as $k => $v}
  {node_view_gui content_node=$v view="full"}
{/foreach}
{else}
{def $related_objects=fetch(&apos;content&apos;,&apos;related_objects&apos;,hash(&apos;object_id&apos;,$node.object.id,&apos;all_relations&apos;, true()))}
<div id="{$node.name|wash}" class="{$node.data_map.class.content|wash}" >
{foreach $related_objects as $k => $v}
{node_view_gui content_node=$v.main_node view="line"}
{/foreach}
{/if}
 
</div>
</div>
 
{undef}

Script to delete all nodes under a node in content structure

Sun, 14 Jan 2007 23:47:06 GMT

About

This is a script to delete all nodes under some tree.
Please note that this script may use large amounts of memory.

Source

<?php
 
include_once( 'lib/ezutils/classes/ezcli.php' );
include_once( 'kernel/classes/ezscript.php' );
include_once( 'kernel/classes/ezcontentobjecttreenode.php' );
 
 
function deleteNodes( $classID, $parentNodeID, $depth )
{
    global $db;
 
    $deleteIDArray = array();
    $nodeArray =& eZContentObjectTreeNode::subTree( array( 'ClassFilterType' => 'include', 'ClassFilterArray' => $classID, 'Depth' => $depth, ), $parentNodeID );
 
    print("Deleting " . count($nodeArray) . " nodes. If that is not what you want it would be good to press ctrl-c now.. deleting starts in 20 seconds!!\n\n");
     sleep(20);
 
     $deletecount = 0;
    $deleteIDArray = array();
 
     foreach ( $nodeArray as $node )
    {
        print("Deleting node " . $node->attribute( 'main_node_id' ) . ' , "' . $node->attribute( 'url_alias' ) . "'\n");
        eZContentObjectTreeNode::removeSubtrees( array( $node->attribute( 'main_node_id' ) ), false );
        $deletecount++;
        print("$deletecount, ");
    }
}
 
$cli =& eZCLI::instance();
 
// change the admin-password! see below ...
 
$script =& eZScript::instance( array( 'description' => ( "delete nodes ...\n\n"."delete main nodes ...,\n" ),
'use-session' => false,
'use-modules' => true,
'use-extensions' => true,
'user' => array ( 'login' => 'admin', 'password' => 'ADMINPASS' ),
) );
 
$script->startup();
$options = $script->getOptions();
 
$script->initialize();
set_time_limit( 0 );
 
 
// 'deleteNodes' function, used to remove all nodes under passed node_id
// example usage of 'deleteNodes' function: deleteNodes( $classID, $parentNodeID, $depth )
 
deleteNodes( array( 'article' ), 6713, 10 );
 
?>

Change the language of existing content objects

Sun, 14 Jan 2007 07:42:42 GMT

About

This is an example solution.

eng-GB -> eng-US

Convert from eng-GB to eng-US

UPDATE ezcontentobject_name
 SET
   content_translation='eng-US',
   real_translation='eng-US'
 WHERE
   content_translation='eng-GB' AND
   real_translation='eng-GB';

eng-GB -> ger-DE

Convert from eng-GB to ger-DE

UPDATE ezcontentobject_name
 SET
   content_translation='ger-DE',
   real_translation='ger-DE'
 WHERE
   content_translation='eng-GB' AND
   real_translation='eng-GB';
 
 UPDATE ezcontentobject_attribute
 SET
   language_code='ger-DE'
 WHERE
   language_code='eng-GB';
 
 UPDATE ezcontent_translation
 SET
   locale='ger-DE',
   name='Deutsch (Deutschland)'
 WHERE
   locale='eng-GB';

External Reference

How can I change the language of existing content objects?

Creating shorter paths

Tue, 09 Jan 2007 14:03:22 GMT

Summary

Information from andre1 in the technical manual reference for siteaccess settings, pathprefix, and from Dirk Schmedding on the list.

Example

You can use the PathPrefix setting in a siteaccess' site.ini to remove parts of the URL. For example:

[SiteAccessSettings] 
PathPrefix=dir

Old url: www.example.org/dir/subdir/some_content
New url: www.example.org/subdir/some_content

Or alternatively:

[SiteAccessSettings] 
PathPrefix=dir/subdir/

old url: www.example.org/dir/subdir/some_content
new url: www.example.org/some_content

PathPrefixExclude

If you have a structure like this:

www.example.org/foo
www.example.org/foo/bar
www.example.org/baz

and you set your PathPrefix like this:

[SiteAccessSettings]
PathPrefix=foo

You will then be unable to access www.example.org/baz. However, you can use PathPrefixExclude to specify URLs that are not subject to PathPrefix, like this:

[SiteAccessSettings]
PathPrefix=foo
PathPrefixExclude[]
PathPrefixExclude[]=baz

You will need to do this for every URL for which PathPrefix should not apply.

External reference

Removing index.php from URLs

Tue, 09 Jan 2007 13:30:33 GMT

About

You will need some mod_rewrite rules set up in Apache. Generally, these should be added to the VirtualHost configuration. A basic set looks like this:

RewriteRule ^/var/storage/.* $0 [L] 
RewriteRule ^/var/[^/]+/storage/.* $0 [L] 
RewriteRule ^/design/[^/]+/(stylesheets|images|javascripts?)/.* $0 [L] 
RewriteRule ^/share/icons/.* $0 [L] 
RewriteRule ^/extension/[^/]+/design/[^/]+/(stylesheets|images|javascripts?)/.* $0 [L] 
RewriteRule .* /index.php

(Taken from Jan Borsodi's comment here)

Secondly, you will probably need to add the ForceVirtualHost setting in settings/override/site.ini.append.php. eZ can allegedly detect when it is installed in a virtual host setup, but it's not always correct.

[SiteAccessSettings]
ForceVirtualHost=true

Reference

Doc: Rewrite
Forum: N/A

Template operator to strip strings for tags

Fri, 05 Jan 2007 12:55:22 GMT

Question

<Tidemann> is there an operator that strips a string for tags?
<Tidemann> ...or removes images from an ezxml output

Solution

<Bratt> No, but you can make one really simple
 <Bratt> ...by using simpletags()
 <Bratt> Set up this in template.ini: [SimpleTagsOperator], TagList_NoTags[], TagList_NoTags[text]=;;strip_tags
 <Bratt> Then you can use simpletags( 'NoTags' )
 <Tidemann> Bratt: hmm.. nice... haven't seen simpletags before actually
 <Tidemann> Bratt: can I use the method here to enable a-tags too then? https://ez.no/community/forum/setup_design/text_block_vs_xml_block_in_forum_topic_tpl/re_text_block_vs_xml_block_q__4
 <Bratt> Sure, just set it up in template.ini
 <Tidemann> cool! thanx!
 <kracker> wow, i wish you would write that into eZpedia ...
<Bratt> Yes, I know.  Took some time before I realized how simple it could be done
<zurgutt> interesting
<Tidemann> Bratt: uhm.. TagList_NoTags[text]=;;strip_tags seems to remove everything
<Tidemann> {$child.data_map.intro.content|simpletags('NoTags')} <-- right?
<Bratt> Tidemann: Yes, that was the point.  If you want to keep a-tags, you need to set that up in template.ini
<Bratt> Add a line something like: TagList_NoTags[text]=<a>;</a>;strip_tags
<Bratt> But I would call it something other than NoTags then
<Bratt> KeepLinks, or whatever
<Tidemann> Bratt: I didn't realise it removed the content of the tag aswell...
<Bratt> Tidemann: A tag includes the content of it :)
<Tidemann> Bratt: hehe..

External reference

Forum: Text block vs xml block

How to find object by node_id?

Tue, 02 Jan 2007 12:15:10 GMT

Question

How can you 'find' an object, if all that is known is the node_id?

Answer

{{def $my_node =fetch( 'content', 'node', hash( 'node_id', $node.node_id ) )
        $my_object=$my_node.object} 
{$my_node.name|wash}

External reference

Content object published, modified and created date modification

Mon, 01 Jan 2007 04:16:30 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Problem

Many people want to manualy specifiy the date's visible to users and or simply set a specific publish date in the future or edit the publish date after it has been published alredy.

Solutions

I think there are a few solutions which may be implemented in order of complexity.

Script: PHP or SQL Update script - Alter object date of a node(s) manually.
Admin: Manually edit content object dates to any date.