eZpedia : Solution

Read-only site

Tue, 28 Aug 2012 08:41:04 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
Rules[]=module;switchlanguage/to

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

You may need to clear INI caches after adding these settings!

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

Reseting the admin password in eZ publish

Sun, 20 May 2012 07:29:11 GMT

From: kracker,xavier

Tags: Security, Admin, Password, Reset, Solution

Question: I forgot my admin password or (insert other problem description here) and I can’t login to eZ publish admin, how can I reset the admin password?

Answers and Solutions

Answer #1

To generate your new password hash under mysql you can run this command. This is the most direct way of solving this problem. I reference this sql shortcut frequently.

SET @key = 'publish';
SET @username = 'admin';
SET @del = '\n';
SET @hash = MD5(CONCAT(@username,@del,@key));
UPDATE ezuser SET password_hash=@hash WHERE login=@username;

Answer #2

To generate your new password hash under linux, you can run:

echo -n -e "admin\npublish" | md5sum

The result is:

c78e3b0f3d9244ed8c6d1c29464bdff9

To do this for another user, replace admin with the login, and publish with the wanted password.

This requires HashType in site.ini to be md5_user.

This is the normal setting, so if you don’t know you changed it, this will work just fine.

Answer #3

Update the password_hash field in your eZ publish database table ezuser for the record `admin` user (login). By replacing the password_hash with the default hash as provided by the setup wizard for the password text `publish`.

I’ve done this several times to solve this problem.

The default hash for the admin password is kinda hidden in the file: ' ezpublish/share/db_data.dba'

For me the default hash was this string for the password 'publish'.

c78e3b0f3d9244ed8c6d1c29464bdff9

This hash when used as the `admin` user’s password hash will reset the password to `publish` without the quotes.

Example sql to do this:

UPDATE ezuser SET password_hash='c78e3b0f3d9244ed8c6d1c29464bdff9' WHERE login='admin';

Answer #4

Rerun the setup wizard by editing your site.ini.append(.php) and ensure that this line is set.

# Set to true if you want the setup system to be activated
 
CheckValidity=true

Answer #5

Temporarily disable the validation check on the password. It means that anyone can login on every account simply putting any random password.

1) Edit the file ' kernel/classes/datatypes/ezuser/ezuser.php'

2) Search for the function ' authenticateHash' (Line 1083 on eZ publish, 3.7)

3) Add this first line:

return true; // no matter what, consider the password valid

Then login as 'admin', change your password, write it down on a post it and put in on your monitor :)

Most security expects frown on the last point ;)

Answer #6

mysql -u USERNAME -p DATABASE
UPDATE ezuser SET password_hash = MD5("admin\nPASSWORD") WHERE login LIKE "admin";

Resetting Administration Password in eZ publish

1. Login via shell, console, ssh, ...
2. Backup your eZ publish database to sql file (Best Practice)
3. Connect to your eZ publish Database.
4. Run this sql line to reset password of admin user

UPDATE ezuser SET password_hash='c78e3b0f3d9244ed8c6d1c29464bdff9' WHERE login='admin';

5. Clear Cache (Optional)

References

Package: Retrieving 3.8 Packages

Mon, 12 Dec 2011 00:33:08 GMT

Hint

Remember that prior to eZ Publish 3.8 packages were distributed within the download source packages themselves. After eZ Publish 3.8 the packages were distributed to the installation during the setup wizard package import.

Did you know If you create the 'packages' directory in the root ezpublish directory and download the required packages into this directory before running the setup wizard you will install your packages via local sources overriding the remote sources.

Local packages installation and setup wizard completion time is much faster than remote package import and installation during setup wizard.

External references

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

References

Package

Clear Cache in eZ Publish

Mon, 14 Nov 2011 22:22:02 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;

Siteaccess Specific

If you are working on a multi-siteaccess website, the specific siteaccess must be appended to the clear cache code.

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

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

Creating image alias image variations in PHP

Mon, 31 Oct 2011 03:28:19 GMT

This is compatible with eZ Publish 4.

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

About

This is an example solution to generate or remove content object image datatype image alias image variations which do not yet exist within the system.

Example solution: bcimagealias extension

The solution bcimagealias extension is available for download on projects.ez.no/bcimagealias

Calling example script

This script generates or removes all image alias image variation image files in the system per siteaccess. Here is an example of how to call the script.

cd /path/to/ezpublish/;
./extension/ezimagealias/bin/php/bcimagealiases.php --siteacess ezwebin_site_user --generate

cd /path/to/ezpublish/;
./extension/ezimagealias/bin/php/bcimagealiases.php --siteacess ezwebin_site_user --remove

This extension also provides a workflow event and cronjob part to generate all image alias variation images in the system each time called. See INSTALL documentation within the extension.

External Reference

Project: bcimagealias
Doc: eZPersistentObject::fetchObjectList
Doc: eZImageAliasHandler
Forum: Creating image alias image variations in PHP
Forum: How to fetch class objects in PHP

Reference

ezimagealiashandler

Change the language of existing content objects

Thu, 20 Oct 2011 06:19:03 GMT

About

This is an example solution.

eng-GB -> eng-US

Very basic example to 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

Very basic example to 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';

eng-GB -> ita-IT

Here is another example which converts all content from eng-GB to ita-IT (this example does not remove any languages from the system)

UPDATE ezcontentclass_attribute SET serialized_description_list = REPLACE( serialized_description_list, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass_attribute SET serialized_name_list = REPLACE( serialized_name_list, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass_attribute SET serialized_data_text = REPLACE( serialized_data_text, 'eng-GB', 'ita-IT' );
 
UPDATE ezcontentclass_name SET language_locale = REPLACE( language_locale, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass_name SET language_id = 3; -- <id_of your intial LANGUAGE FROM TABLE ezcontent_language>
 
UPDATE ezcontentclass SET initial_language_id = 2; -- <id_of your intial LANGUAGE FROM TABLE ezcontent_language>
UPDATE ezcontentclass SET serialized_name_list = REPLACE( serialized_name_list, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass SET serialized_description_list = REPLACE( serialized_description_list, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass SET language_mask = 3;

eng-GB -> esl-ES

Here is another more specific example which converts content from eng-GB to esl-ES and removes eng-GB language

UPDATE ezcontentclass_attribute SET serialized_description_list = REPLACE( serialized_description_list, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass_attribute SET serialized_name_list = REPLACE( serialized_name_list, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass_attribute SET serialized_data_text = REPLACE( serialized_data_text, 'eng-GB', 'esl-ES' );
 
UPDATE ezcontentclass_name SET language_locale = REPLACE( language_locale, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass_name SET language_id = 3 WHERE language_id = 5; -- <id_of your intial LANGUAGE FROM TABLE ezcontent_language>
 
UPDATE ezcontentclass SET initial_language_id = 2, language_mask = 3 WHERE initial_language_id = 4 OR language_mask = 5; -- <id_of your intial LANGUAGE FROM TABLE ezcontent_language>
UPDATE ezcontentclass SET serialized_name_list = REPLACE( serialized_name_list, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass SET serialized_description_list = REPLACE( serialized_description_list, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass SET language_mask = 3; -- <id_of your esl-ES LANGUAGE FROM TABLE ezcontent_language>
 
DELETE FROM ezcontent_language WHERE locale = 'eng-GB';

External Reference

Adding related object programmatic

Thu, 28 Apr 2011 13:13:40 GMT

Question

How to add related object programmatically ...

Answer

To add a list of object as an object relation through CLI, this code is not perfect and may remove any existing object relations you have.

Example

Here is an example eZ Publish PHP CLI Script which shows how to use this feature.

<?php
/**
 * tmp
 *
 * @package tmp
 * @author Olav Frengstad <[email protected]>
 */
require_once 'autoload.php';
 
$cli = eZCLI::instance();
 
$script = eZScript::instance( array(
        'description' => 'test script',
        'use-modules' => true,
        'use-extensions' => true,
) );
 
$script->startup();
 
$config = $argumentConfig = '';
 
$optionHelp = $arguments = false;
$useStandardOptions = array(
        'user'          => true,
        'siteaccess'    => true,
);
$options = $script->getOptions(
        $config,
        $argumentConfig,
        $optionHelp,
        $arguments,
        $useStandardOptions
);
 
$script->initialize();
 
$user = eZUser::fetchByName('admin');
if ( !$user )
{
        $user = eZUser::currentUser();
}
 
$rel = array(153);
$object = eZContentObject::fetch( 154 );
 
$object->appendInputRelationList( $rel,eZContentObject::RELATION_LINK );
$object->commitInputRelations($object->CurrentVersion);
$object->store();
 
$script->shutdown();

To run it save the file in your ez directory (preferably put it in an extension) and call it:

$ php relation.php --siteaccess <your-siteaccess-name>

Creating custom rss feeds using the layout/set module view

Thu, 21 Oct 2010 23:41:07 GMT

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

This article which describes in detail using the layout/set module view in various ways.

Example Settings

These are the example settings of an average layout.ini.append.php

span style="background-color: yellow;"> [podcast]
PageLayout=podcast_rss_pagelayout.tpl
ContentType=application/rss+xml
# Related issue, https://issues.ez.no/12677
# If you remove this line, URLs that are built using url_alias_list will have the following prepended, '/layout/set/json/'.
UseAccessPass=false
UseFullUrl=true
 
[podcast_episode]
PageLayout=podcast_episode_pagelayout.tpl
ContentType=text/html
# Related issue, https://issues.ez.no/12677
UseAccessPass=false
UseFullUrl=true
 
[discussions]
PageLayout=discussions_pagelayout.tpl
ContentType=application/rss+xml
 
[author]
PageLayout=author_rss_pagelayout.tpl
ContentType=application/rss+xml
# ContentType=text/xml
 
[comments]
PageLayout=comment_rss_pagelayout.tpl
ContentType=application/rss+xml
# ContentType=text/xml
 
[article_statistics.csv]
PageLayout=article_statistics_pagelayout.tpl
ContentType=text/csv
# ContentType=text/txt

Templates

Example template overrides for layout/set view.

Author Article RSS Feed

Example uri, '/layout/set/author?user=938'

 
 
{set-block scope=root variable=cache_ttl}0{/set-block}
{def $user_id=ezhttp( 'user', 'get' )}
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:atom="https://www.w3.org/2005/Atom">
  <channel>
    <atom:link href="https://example.com/rss/feed/user/{$user_id}" rel="self" type="application/rss+xml"/>
    <title>Example User Feed</title>
    <link>https://example.com</link>
    <description>A feed of the articles being started at example.com!</description>
    <language>en-US</language>
    <image>
      <url>https://example.com/var/ezwebin_site/storage/images/media/images/example_logo_rss.png</url>
      <title>example BETA User Feed</title>
      <link>https://example.com</link>
    </image>
{* ezhttp( 'user', 'get' )}  |-- <b>{$view_parameters.user}</b> {$view_parameters|attribute(show,1) *}
 
{if ezhttp_hasvariable( 'user', 'get' )}
{def $topics=fetch( 'content', 'list',
     hash( 'parent_node_id', 42,
           'limit',           30,
           'depth',            3,
           'class_filter_type',  'include',
           'class_filter_array', array( 'article','comment' ),
           'attribute_filter', array( array( 'owner',
                                        '=',
                                        $user_id ) ),
           'sort_by', array( 'published', false() )
     ) )}
{foreach $topics as $t}
    <item>
      <title>{if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if}{if $t.object.class_identifier|eq('article')} : {$t.name|trim|htmlentities}{else} on {$t.parent.name|trim|htmlentities}{/if}</title>
      <author>{$t.object.owner.data_map.user_account.content.email} ({if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if})</author>
      <link>https://example.com/{$t.url_alias}</link>
      <guid>https://example.com/{$t.url_alias}</guid>
      <description><![CDATA[{$t.data_map.body.content.output.output_text}]]></description>
      <pubDate>{$t.object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s PDT')}</pubDate>{*
      <pubDate>Sat, 04 Jul 2010 13:54:12 GMT</pubDate> *}
    </item>
{/foreach}{/if}
 
  </channel>
</rss>

Article RSS Feed

Example uri, '/layout/set/articles'

 
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:atom="https://www.w3.org/2005/Atom">
  <channel>
    <atom:link href="https://example.com/rss/feed/articles" rel="self" type="application/rss+xml"/>    <title>example BETA article Feed</title>
    <link>https://example.com</link>
    <description>A feed of the articles from example.com</description>
    <language>en-US</language>
    <image>
      <url>https://example.com/var/ezwebin_site/storage/images/media/images/example-block-logo_rss.png</u
rl>
      <title>Example article Feed</title>
      <link>https://example.com</link>
    </image>
{def $topics=fetch( 'content', 'list',
     hash( 'parent_node_id', 77,
           'limit',           30,           'sort_by', array( 'published', false() )
     ) )}{foreach $topics as $t}
    <item>
      <title>{if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if}: {$t.name|trim|was
h}</title>
      <author>[email protected] ({if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if
})</author>
      <link>https://example.com/{$t.url_alias}</link>
      <guid>https://example.com/{$t.url_alias}</guid>
      <description><![CDATA[{$t.data_map.body.content.output.output_text}]]></description>
      <pubDate>{$t.object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s PDT')}</pubDate>{*
      <pubDate>Sat, 04 Jul 2010 13:54:12 GMT</pubDate> *}
    </item>
{/foreach}
 
  </channel>
</rss>

Podcast RSS Feed

Example uri, '/layout/set/podcast'

 
{def $podcast_node_id=4200
     $max_episodes=50
     $podcast=fetch( 'content', 'node', hash( 'node_id', $podcast_node_id ) )
     $episodes=fetch( 'content', 'list', hash( 'parent_node_id', $podcast_node_id,
                                               'limit', $max_episodes,
                                               'class_filter_type', 'include',
                                               'class_filter_array', array( 'podcast_episode' ),
                                               'sort_by', array( 'published', false() ) ) )
     $podcastDescription='Example.com: The home of ...'
     $podcastItunesSubtitle='Example subtitle'
     $podcastItunesSummary='Example summary'
     $podcastItunesKeywords='Example, keywords'
     $podcastItunesCategory='News &amp; Opinion'
     $podcastImageUrl=concat('https://',ezsys('hostname'),'/extension/example/design/ezwebin/images/podcast/blocklogo144.jpg')
     $podcastItunesImageUrl=concat('https://',ezsys('hostname'),'/extension/example/design/ezwebin/images/podcast/ituneslogo.jpg')
     $podcastTitle=$podcast.data_map.title.content|trim|wash
     $siteUrl='https://example.com'
     $podcastUrl=concat($siteUrl,'/rss/feed/podcast')
     $podcastPageUrl=concat($siteUrl,'/podcast')
     $podcastItunesEmail='[email protected]'
     $audioFileUrl=''
     $audioFileLength=''
     $episodeDatamap=''
}<?xml version="1.0" encoding="utf-8"?>
<rss xmlns:atom="https://www.w3.org/2005/Atom" xmlns:itunes="https://www.itunes.com/dtds/podcast-1.0.dtd" version="2.0">
  <channel>
    <title>{$podcastTitle}</title>
    <link>{$siteUrl}</link>
    <description>{$podcastDescription}</description>
    <language>en-US</language>
 
    <copyright>(C) example.com {currentdate()|datetime( 'custom', '%Y' )}</copyright>
    <image>
      <url>{$podcastImageUrl}</url>
      <title>{$podcastTitle}</title>
      <link>{$siteUrl}</link>
      <width>144</width>
      <height>144</height>
    </image>
    <atom:link href="{$podcastUrl}" rel="self" type="application/rss+xml"/>
    <category>{$podcastItunesCategory}</category>
    <itunes:image href="{$podcastItunesImageUrl}" />    <itunes:author>example.com</itunes:author>
    <itunes:subtitle>{$podcastItunesSubtitle}</itunes:subtitle>
    <itunes:summary>{$podcastItunesSummary}</itunes:summary>
    <itunes:keywords>{$podcastItunesKeywords}</itunes:keywords>
    <itunes:explicit>no</itunes:explicit>
    <itunes:owner>
      <itunes:name>example.com</itunes:name>
      <itunes:email>{$podcastItunesEmail}</itunes:email>
    </itunes:owner>
    <itunes:block>no</itunes:block>
    <itunes:category text="{$podcastItunesCategory}"/>
    <pubDate>{if $episodes[0]}{if $episodes[0].data_map.published.has_content}{$episodes[0].data_map.published.content.timestamp|datetime('custom', '%D, %d %M %Y %H:%
i:%s -0700')}{else}{$episodes[0].object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s -0700')}{/if}{/if}</pubDate>
    <lastBuildDate>{currentdate()|datetime('custom', '%D, %d %M %Y %H:%i:%s -0700')}</lastBuildDate>
{foreach $episodes as $episode}
{set $episodeDatamap=$episode.data_map
     $audioFileUrl=$episodeDatamap.audio.content
     $audioFileLength=$episodeDatamap.audio_length.content
}
    <item>
      <title>{$episode.name|trim|wash}</title>
{if $episodeDatamap.audio.has_content}
 
      <link>{$audioFileUrl}</link>
{else}
 
      <link>{$podcastPageUrl}</link>
{/if}
 
      <description>{$episodeDatamap.description.content|trim|wash}</description>
      <pubDate>{if $episodeDatamap.published.has_content}{$episodeDatamap.published.content.timestamp|datetime('custom', '%D, %d %M %Y %H:%i:%s -0700')}{else}{$episode.object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s -0700')}{/if}</pubDate>
{if $episodeDatamap.audio.has_content}
 
      <enclosure url="{$audioFileUrl}" length="{$audioFileLength}" type="audio/mpeg"/>
      <guid isPermaLink="false">{$audioFileUrl}</guid>
{/if}
      <category>{$episodeDatamap.category.content|trim|wash}</category>
      <itunes:author>example.com</itunes:author>
      <itunes:subtitle>{$episodeDatamap.subtitle.content|trim|wash}</itunes:subtitle>
      <itunes:summary>{$episodeDatamap.description.content|trim|wash}</itunes:summary>
      <itunes:keywords>{$episodeDatamap.keywords.content.keyword_string|trim|wash}</itunes:keywords>
      <itunes:explicit>{if $episodeDatamap.explicit.content}yes{else}no{/if}</itunes:explicit>
      <itunes:duration>{$episodeDatamap.duration.content|trim}</itunes:duration>
    </item>
{/foreach}
  </channel>
</rss>

Comment RSS Feed

Example uri, '/layout/set/comment'

 
{set-block scope=root variable=cache_ttl}0{/set-block}
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:atom="https://www.w3.org/2005/Atom">
  <channel>
    <atom:link href="https://example.com/rss/feed/comments" rel="self" type="application/rss+xml"/>
    <title>Example Comment Feed</title>
    <link>https://example.com</link>
    <description>A feed of the comments from example.com.</description>
    <language>en-US</language>
    <image>
      <url>https://example.com/var/ezwebin_site/storage/images/media/images/example-block-logo-rss.png</url>
      <title>example BETA Comment Feed</title>
      <link>https://example.com</link>
    </image>
{def $topics=fetch( 'content', 'list',
     hash( 'parent_node_id', 77,
           'limit',           30,           'depth',            3,
           'class_filter_type',  'include',           'class_filter_array', array( 'comment' ),
           'sort_by', array( 'published', false() )
     ) )}
{if $topics|count|gt(0)}
{foreach $topics as $t}
    <item>
      <title>{if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if}{if $t.object.class
_identifier|eq('article')} : {$t.name|trim|htmlentities}{else} on {$t.parent.name|trim|htmlentities}{/if}</title>
      <author>{$t.object.owner.data_map.user_account.content.email} ({if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if})</author>
      <link>https://example.com/{$t.parent.url_alias}/(comment)/{$t.node_id}#comment-{$t.node_id}</link>
      <guid>https://example.com/{$t.parent.url_alias}/(comment)/{$t.node_id}#comment-{$t.node_id}</guid>
      <description><![CDATA[{$t.data_map.body.content.output.output_text}]]></description>
      <pubDate>{$t.object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s PDT')}</pubDate>{*
      <pubDate>Sat, 04 Jul 2010 13:54:12 GMT</pubDate> *}
    </item>
{/foreach}{/if}
 
  </channel>
</rss>

Article Statistics CSV Export

Example uri, '/layout/set/article_statistics.csv?startDate=2010-07-14&endDate=2010-07-19'

 
{* Example: https://example.com/layout/set/article_statistics.csv?startDate=2010-07-14&endDate=2010-07-19 *}
{def $articles=false()
$commentCount=false()
$articleTitle=false()
$articleOwner=false()
$articleDate=false()
$articleTime=false()
$articleWordCount=false()
$articleFollowCount=false()
$articleShareCount=false()}
 
{if and( ezhttp_hasvariable( 'startDate', 'get' ), ezhttp_hasvariable( 'endDate', 'get' ) )}
 
{def $startDate=ezhttp( 'startDate', 'get' )|explode("-")
     $endDate=ezhttp( 'endDate', 'get' )|explode("-")}
{def $startDateTimestamp=maketime(0,0,0,$startDate.1,$startDate.2,$startDate.0)
     $endDateTimestamp=maketime(23,59,59,$endDate.1,$endDate.2,$endDate.0)}
{set $articles=fetch( 'content', 'list', hash(
     'parent_node_id', 77,
     'class_filter_type', 'include',
     'class_filter_array', array( 'article' ),
     'sort_by', array( 'published', false() ),
     'attribute_filter', array( array( 'published', '>=', $startDateTimestamp ),
                                array( 'published', '<', $endDateTimestamp ) )
 ) )}
{else}
{set $articles=fetch( 'content', 'list', hash(
     'parent_node_id', 77,
     'class_filter_type', 'include',
     'class_filter_array', array( 'article' ),
     'sort_by', array( 'published', false() ),
     'limit', 10000
 ) )}
{/if}"Date","Time","Title","Who","Words","Comments","Followers","Shared","Post or Comment","Url"
 
{foreach $articles as $con}{* article variables count etc. Counts the words in the body xml string *}{set
     $commentCount=fetch( 'content', 'tree_count', hash(
     'parent_node_id', $con.object.main_node_id,
     'class_filter_type', 'include',
     'class_filter_array', array( 'comment' ) ) )
     $articleTitle=$con.object.name|explode('"')|implode("")
     $articleOwner=$con.object.owner.name|explode('"')|implode("")
     $articleWordCount=$con.data_map.body.content.output.output_text|explode( '>' )|implode( '> ' )|strip_tags|simplify|explode( ' ' )|count
     $articleFollowCount=fetch( 'example', 'getfollowerscount', hash( 'id', $con.node_id ) )
     $articleShareCount=fetch( 'example', 'getsharecounts', hash( 'id', $con.node_id ) )
     $articleDate=$con.object.published|datetime( 'custom', '%d-%M' )
     $articleTime=$con.object.published|datetime( 'custom', '%h:%i:%s %A' )
}
"{$articleDate}",{$articleTime},"{$articleTitle}","{$articleOwner}",{$articleWordCount},{$commentCount},{$articleFollowCount},{$articleShareCount},"P","https://example.com/{$con.url_alias}"
 
{/foreach}

References

Doc: Offical layout module documentation
Doc: A word about using layout.ini for printer friendly pagelayout.
Doc: A comment about layout.ini settings
Forum: custom icalendar pagelayout example
Forum: disable debug for custom layout/set layouts
Forum: view cache with layout/set
Search: layout/set

How to fetch content based on view parameter date range

Wed, 21 Jul 2010 17:48:13 GMT

Summary

This solution is template based and very simple.

It optionally relies on view parameters to provide a date range with which to limit the fetch results.

{* Example: https://example/layout/set/content_statistics.csv/(startDate)/2010-07-14/(endDate)/2010-07-19/ *}
{def $articles=false()}
 
{if and( is_set( $view_parameters.startDate ), is_set( $view_parameters.endDate ) )}
 
{def $startDate=$view_parameters.startDate|explode("-")
$endDate=$view_parameters.endDate|explode("-")}
 
{def $startDateTimestamp=maketime(0,0,0,$startDate.1,$startDate.2,$startDate.0)
$endDateTimestamp=maketime(23,59,59,$endDate.1,$endDate.2,$endDate.0)}
 
{set $articles=fetch( 'content', 'list', hash(
     'parent_node_id', 77,
     'class_filter_type', 'include',
     'class_filter_array', array( 'article' ),
     'sort_by', array( 'published', false() ),
     'attribute_filter', array( array( 'published', '>=', $startDateTimestamp ),
                                array( 'published', '<', $endDateTimestamp ) )
 ) )}
{else}
 
{set $articles=fetch( 'content', 'list', hash(
     'parent_node_id', 77,
     'class_filter_type', 'include',
     'class_filter_array', array( 'article' ),
     'sort_by', array( 'published', false() ),
     'limit', 10000
 ) )}
{/if}

References

These forum threads were the basis for this solution. Thanks to the contributors for the hints and tips.

Google Webmaster Tools

Thu, 08 Jul 2010 18:04:20 GMT

In order to register your eZ Publish website in Google Webmaster Tools, you need to verify you are the owner of the site. One possibility, and in case of eZ Publish the easiest, is adding an additional HTML meta header to your web pages.

You can add the verification code you get from Google Webmaster tools, In the site.ini.append.php file

either as a global override (settings/override/site.ini.append.php)
or just for specific site accesses (settings/siteaccess/[yoursiteaccessname]/site.ini.append.php)

[SiteSettings]
MetaDataArray[verify-v1]=yourgooglewebmastertoolscode

indexing/searching pdf files with accented chars

Thu, 24 Sep 2009 13:57:56 GMT

eZpublish needs external tools for pdf file indexing. Path to that tool is set in binaryfile.ini

Originally i was using the pstotext too, but it does not work well and often gives garbage as output. Better tool is pdftotext from xpdf project, as suggested in this article.

In my case the above was not enough, as pdf files apparently are in iso-8859-1 but eZpublish expects UTF-8 as input.

So, the contents of ezpdftotext should be:

#!/bin/sh
pdftotext $1 -|iconv -f ISO-8859-1 -t UTF-8

Bookmarked eZ publish Solutions for newbies

Mon, 31 Aug 2009 10:11:15 GMT

This info is quite old, based on eZp 3 series and may be partly obsolete now. Also, ezwebin that was introduced onwards from ez 3.8 breaks many things.

Bookmarks

Editing, creating and removing content from the user page / Tips & Tricks / Customization
https://www.ez.no/ez_publish/documentation/customization/tips_tricks/editing_creating_and_removing_content_from_the_user_page

Re: How Can create, remove, edit a object from the Pagelayout? / How Can create, remove, edit a object from the Pagelayout? / Developer
https://www.ez.no/community/forum/developer/how_can_create_remove_edit_a_object_from_the_pagelayout/re_how_can_create_remove_edit_a_object_from_the_pagelayout

Re: how to create a simple user interface for content creation ? / how to create a simple user interface for content creation ? / Setup & design
https://www.ez.no/community/forum/setup_design/how_to_create_a_simple_user_interface_for_content_creation/re_how_to_create_a_simple_user_interface_for_content_creation__2

Adding an action button / The guestbook / Building an eZ publish site
https://www.ez.no/ez_publish/documentation/building_an_ez_publish_site/the_guestbook/adding_an_action_button

Creating a tree-style appearence / The links page / Building an eZ publish site
https://www.ez.no/ez_publish/documentation/building_an_ez_publish_site/the_links_page/creating_a_tree_style_appearence

Developer toolbar / Specs / Developer
https://www.ez.no/community/developer/specs/developer_toolbar

Adding tree functionality to 3.4 subleft menu template / Setup & design / Forum
https://www.ez.no/community/forum/setup_design/adding_tree_functionality_to_3_4_subleft_menu_template

Left menu, exclude a node / Setup & design / Forum
https://www.ez.no/community/forum/setup_design/left_menu_exclude_a_node

Re: Online editors / Online editors / Suggestions
https://www.ez.no/community/forum/suggestions/online_editors/re_online_editors__34

Using a Different Online Editor / General / Forum
https://ez.no/community/forum/general/using_a_different_online_editor

XMLArea extension development / Developer / Forum
https://ez.no/community/forum/developer/xmlarea_extension_development

Limiting users to 1 site design? / Developer / Forum
https://www.ez.no/community/forum/developer/limiting_users_to_1_site_design

Re: multiple sites on one database / multiple sites on one database / Setup & design
https://www.ez.no/community/forum/setup_design/multiple_sites_on_one_database/re_multiple_sites_on_one_database__3

Changed RootNode and got serious url trouble / Setup & design / Forum
https://www.ez.no/community/forum/setup_design/changed_rootnode_and_got_serious_url_trouble

RootNode and Bread-crumbs / Setup & design / Forum
https://www.ez.no/community/forum/setup_design/rootnode_and_breadcrumbs

Override templates / Custom design / Customization
https://ez.no/ez_publish/documentation/customization/custom_design/override_templates

How to find the parent and grandparent of an object / Incoming / Documentation
https://www.ez.no/ez_publish/documentation/incoming/how_to_find_the_parent_and_grandparent_of_an_object

tree / Content / Data fetching
https://ez.no/ez_publish/documentation/reference/data_fetching/content/tree

Separate pagelayouts for ‘view’ and ‘edit’ - NOT POSSIBLE? / Developer / Forum
https://ez.no/community/forum/developer/separate_pagelayouts_for_view_and_edit_not_possible

Building an eZ publish module / Extensions / Development
https://ez.no/ez_publish/documentation/development/extensions/building_an_ez_publish_module

Redirect inside a tpl file / Developer / ForumBuilding an eZ publish module / Extensions / Development
https://www.ez.no/community/forum/developer/redirect_inside_a_tpl_file

how to use a parameter in a template operator? / Developer / Forum
https://www.ez.no/community/forum/developer/how_to_use_a_parameter_in_a_template_operator

urgent! important! how to store session variables????? / Setup & design / Forum
https://www.ez.no/community/forum/setup_design/urgent_important_how_to_store_session_variables

Function list / Functions / eZ template
https://ez.no/products/ez_publish/documentation/development/libraries/ez_template/functions/function_list

Adding a Remove Button/Image / Tips & Tricks / Customizationist
https://www.ez.no/ez_publish/documentation/customization/tips_tricks/adding_a_remove_button_image

Redirecting after content publishing / Tips & Tricks / Customization
https://ez.no/products/ez_publish/documentation/customization/tips_tricks/redirecting_after_content_publishing

Disabling drafts in user profiles / Developer / Foruming_after_content_publishing
https://www.ez.no/community/forum/developer/disabling_draf

eZContentObject class Referencets_in_user_profiles
https://pubsvn.ez.no/doxygen-3.4/classeZContentObject.html

Creating a new translation / Language and charset / Configuration
https://ez.no/ez_publish/documentation/configuration/conf

what is i18n / Developer / Forumiguration/language_and_charset/creating_a_new_translation
https://www.ez.no/community/forum/developer/what_is_i18n_

Common template issues / Examples / Custom design
https://www.ez.no/ez_publish/documentation/customization/custom_design/examples/common_template_issue

What to do if ez publish loads a blank page or error?

Mon, 31 Aug 2009 10:10:16 GMT

Clear the caches using a shell command (in sites root folder):

php bin/php/ezcache.php --clear-all --purge

Check var/log/error.log and php error log for more information.

Performance Tuning eZ Publish 4

Fri, 21 Aug 2009 00:02:53 GMT

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

About

Recommended eZ Publish 4 Apache configuration improvements for best possible production web server performance.

Topics

Application / Web Server

Apache

The basis of Apache PHP application server configuration requires virtual host configuration be stored within Apache solely.

The htacess Problem

The basis of Apache PHP application server configuration best practices for performance is preventing the use of htaccess configuration usage as not-possible as it prevents best practices and reasonable performance.

This is because .htaccess files are check per http request, ie: per file included on webserver from browser within html page (including html page) ie many many times per requested page to set any required httpd / php application configuration variables / conditions / etc (ie: loading the web server configuration) from direct disk access each time (not cached).

This represents a tremendous systemic performance problem that can only be resolved by relocating all configuration changes to the Apache virtual host configuration file and disabling .htaccess file access completely.

Remember htacess files configuration syntax is almost always different than the same applicable syntax within an apche virtual host configuration file.

Disable htaccess

Here is an example of how to disable htacess file access using the AllowOverride None setting. This example would be added within your virtual host configuration file for your we eZ Publish installation within Apache.

<Directory /var/www/path/to/ezpublish>
  Options Indexes FollowSymLinks MultiViews
  AllowOverride None
  Order allow,deny
  allow from all
</Directory>

Recommended Apache Modules

mod_expire - Greatly improves performance
mod_rewrite - Greatly improves application server flexibility and provides for clean user friendly aka nice urls.

PHP

I recommend increasing the following default php.ini variables to increase default limits to prevent future performance and upload limits from being reached as the default configuration is insufficient.

memory_limit
max_input_time
upload_max_filesize
post_max_size

Database Server

A word on database performance improvements.

MYSQL
PGSQL
ORACLE
MSSQL

References

Doc: x
Article: x
Forum: x
Forum: x

Setting: Disable Dirty Object Draft Edit Show Versions View

Tue, 18 Aug 2009 05:11:50 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

Tips Running eZ Publish PHP CLI Scripts

Tue, 18 Aug 2009 02:32:28 GMT

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

Capture all script output to log file: # php /path/to/script | tee ~/ez.script.2006.11.17.001.log
A solution to running php cli scripts or other programs with required arguments in a limited hosting environment.

Tips Running - Cronjobs and scripts with required arguments in limited hosting environment

Tue, 18 Aug 2009 02:28:58 GMT

Previous Title

Running cronjobs and scripts with required arguments / parameters in limited hosting environment

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

Detecting and solving content object corruption

Mon, 17 Aug 2009 07:51:53 GMT

About

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

Solutions

...

External References

Forum: Problem: corrupt contentobjects

How to fetch and display image alias variations in jpeg format

Mon, 17 Aug 2009 07:49:59 GMT

From: kracker and Peter Schnuerer

Date: Wednesday 01 June 2005 8:02:17 pm

Filed under: Images Variation

Was called: Image operator always creates png but I need jpg

Summary

I wrote an extensive thread on altering eZ publish image variation behavior to remove static hard coded values. An interesting (while long winded) thread ...

Reference

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

Connecting to Webdav using Microsoft Windows Vista

Mon, 17 Aug 2009 07:46:43 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

Patch: Adding view parameter support into custom user extention module view

Mon, 17 Aug 2009 07:08:59 GMT

This is compatible with eZ Publish 3.

Compatibility

This article was written for eZ Publish 3. Prolly before eZ Publish 3.9. To our knowledge this feature has been added within (at least) eZ Publish 4.1

About

From: Jamie

Date: Tuesday March 22nd 2005, 5:23 pm

Filed under: General

Jamie: If for some odd reason you’d like to be able to use view parameters (userParameters) in user module’s register.php provided by eZ publish, here’s the 5 lines of code you need to add.

After the line:

$Params['TemplateObject'] =& $tpl;

add:

include_once( "lib/ezutils/classes/ezuri.php" );
 
$uri =& eZURI::instance( eZSys::requestURI() );
$GLOBALS['eZRequestedURI'] =& $uri;
 
$viewParameters = $uri->UserParameters();
 
$tpl->setVariable( 'view_parameters', $viewParameters );

Then, in your overridden register.tpl, you can access the userParameter like this:

$view_parameters.type

If your URL looks something like:

https://www.example.com/user/register/(type)/something

That is to say, the register.tpl should then work as described here.

The above may not be the most correct/elegant/efficient way to do it, but it works for me, and that’s all I need right now.

And thanks go to Katana on the #ezpublish IRC channel for prodding me in the right direction with the above.

Check out Katana’s formsess project for some clever Smarty-powered forms processing magic type stuff.

How to create shorter paths and urls to content objects

Mon, 17 Aug 2009 07:01:25 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

Upgrading eZ Publish 3.3 to 3.9

Mon, 17 Aug 2009 03:50:53 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.

How to select distinct using a function definition

Mon, 17 Aug 2009 00:13:58 GMT

Background

A user working within a function definition to query the database using the 'SELECT DISTINCT' command.

Question

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

Solution

Yes. See forum thread reference for solution.

External Reference

Forum: [solved] Function definition, Select Distinct

Search returns no results found

Mon, 17 Aug 2009 00:10:21 GMT

About

When the stock eZ publish search returns 'No Results Found', when results should be found.
Or, i haven’t broke it, it’s stock, there’s data, it should work, it’s not working, what’s different?

Problem

I was using eZ publish recently for a web site (really, gasp?!? the audience applauds).

Towards the end of the work I went to polish off the implementation’s search (mostly template overrides to make the look consistent).

Inoticed that while the eZ publish build (3.5.0 at the time) was stock and looked good to go as far as the ezsearch settings were concerned.
Yet I every time, in every location I used the search features I got the dreaded error: “No results were found when searching for...”
What’s the deal? The audience pondered ...

Solution

Well the deal as pointed out by the infamous #ezpublish troll, Bedlore.

The problem is infact the database server’s actual databases permissions are set too restrictive to allow the ezsearch component to create the temporary tables required durring a search (yes, it’s true ezsearch does create temporary tables during a search).

In my case I had to run this sql as the database server’s administrator.

USE mysql;
 UPDATE db SET Create_priv='Y', Grant_priv='Y', References_priv='Y', Index_priv='Y', Alter_priv='Y' WHERE user="csi_ezpublish" AND db="beta";
FLUSH privileges;

After I ran the above sql I found I could use all the eZ publish search feaetures normaly again.

Special thanks to participants: kracker, Bedlore
References: n/a

How to provide for Intranet IP Based Authentication

Mon, 17 Aug 2009 00:08:17 GMT

This is compatible with eZ Publish 3.

About

It is _not_ recommended to change the kernel, because upgrades will be much harder. But if you really want to do it, this is how.

Special Thanks to participants: Andy Masiar, Bjorn Dieding, Mark Marsiglio, Kristian Hole

References:Intranet IP Based Authentication

Dated: 2005/10/30 18:26

Question

Is it possible to authenticate users based on their IP?

Answer

There is a patch for login based on IP.

This is made for only one user, but you get the idea of how to do it.

This patch gets the IP address and the corresponding user from the site.ini.append.php file. (Patch is for 3.5.1)

--- ezpublish_releases/ezpublish-3.5.1/pre_check.php     2005-02-24 12:05:54.000000000 +0100
+++ precheck_fixedfor351.php    2005-03-09 09:26:30.999605632 +0100
@@ -89,6 +89,19 @@
 //     $uri =& $GLOBALS['eZRequestedURI'];
     $check = array( "module" => "user",
                     "function" => "login" );
+
+       //---LoginOnIP-HACK
+    if ( $ini->hasVariable( 'LoginOnIP', 'IPAddress' ) && $ini->hasVariable( 'LoginOnIP', 'UserID' )
+         && $_SERVER['REMOTE_ADDR'] == $ini->variable( 'LoginOnIP', 'IPAddress' ) )
+    {
+        include_once( 'kernel/classes/datatypes/ezuser/ezuser.php' );
+
+        $userID = ( int ) $ini->variable( 'LoginOnIP', 'UserID' );
+        $user = eZUser::fetch( $userID );
+        eZUser::setCurrentlyLoggedInUser( $user, $userID );
+    }
+       //---LoginOnIP-HACK
+
     if ( $http->hasSessionVariable( "eZUserLoggedInID" ) and
          $http->sessionVariable( "eZUserLoggedInID" ) != '' and
          $http->sessionVariable( "eZUserLoggedInID" ) != $ini->variable( 'UserSettings', 'AnonymousUserID' ) )
@@ -173,4 +186,4 @@
 }

References

Package: Creating, Managing, Deploying and Maintaining eZ Publish Packages

Sun, 16 Aug 2009 23:31:38 GMT

From: Bjorn Dieding @ xrow.de

About an eZ Publish Package

A package is compressed file which contains information related to eZ Publish.

It contains some information stored as XML.
It can contain by convention additional file resources
File extension: *.ezpkg
File format: tar

References

Package: Creating eZ Publish Packages

Sun, 16 Aug 2009 23:27:02 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

Package: Testing a site design package using the ez.no demo site

Sun, 16 Aug 2009 23:25:36 GMT

* Submitted by Luke Serwatka

Brief

If you would like to test out a site design (css + images + files) package without installing it on your own eZ publish installation you can do so very simply. Use the ez.no demo site

Steps

Login to the Admin interface (Log in with username: admin and password: publish)
Go to the Package Admin, Import the package (requires you to first download the package to your local machine to upload it to the demo site, example packages available from ez.no)
Go to the Design Admin, select “Look and Feel“, select the newly available design, save your changes.
Go to the Cache Admin, Clear All Cache
Load / refresh the user demo site in your browser: https://devel.ezpublish.no/

Voila!

You can use WinRAR to extract files from contributed designs files.
You also can browse ezpackage files using Total Commander for Windows.

Modify SiteAccessRules to allow advanced editing

Sun, 16 Aug 2009 15:05:59 GMT

This is compatible with eZ Publish 3.

Problem

Class and template editing are disabled by default since the 3.9.0 release.However, it looks like complaints from user have lead eZ to reenable this functionality at least in 3.9.2. So the information below is likely not required for new installs.

Notices

On the final page of eZ publish installation and setup, the user is presented with message:
- "The ability to edit classes and templates have been disabled in the Administration Interface in order to comply with the warranty in the eZ Publish Now service."
Edit controls are still displayed on 'Setup/classes' page and create template override controls on 'Design/templates'. Yet when trying to use them, displays these error messages:
- "The requested page could not be displayed. (22) The requested view can not be accessed. The <edit> within the <class> is disabled and thus it can not be accessed."
- "The requested page could not be displayed. (22) The requested view can not be accessed. The <templatecreate> within the <visual> is disabled and thus it can not be accessed."

Settings

To enable these features, remove the following settings (remove the 'Rules[]' lines) from 'settings/override/site.ini.append.php'

[SiteAccessRules]
Rules[]
Rules[]=access;disable
Rules[]=module;class/edit
Rules[]=module;class/groupedit
Rules[]=module;class/copy
Rules[]=module;class/down
Rules[]=module;class/up
Rules[]=module;class/removeclass
Rules[]=module;class/removegroup
Rules[]=module;class/translation
Rules[]=module;visual/templateedit
Rules[]=module;visual/templatecreate

External Reference

Forum: Why is the 3.9.0 release crippled by default

Publishing static pages

Sun, 16 Aug 2009 14:47:43 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

Disabling versioning for content objects

Sun, 16 Aug 2009 14:46:30 GMT

Problem

The problem is versioning is built in (deep) into eZ publish. You can’t just remove it. Thankfully it is fairly configurable so you can extended the base implementation and alter key areas to archive the desired results. Which are more of a way to minimize revisions / hide the revision management.

There are a few issues involved in achieving these results.

admin edit views
user edit views
add: edit view template (override) to remove / hide all non-essential functionality
alter: (optional) a content class version history limit from 5 to 2.
add: use hidden form fields to specify values of attributes

Misc References

[20:20] <zrg> i think returnURI field is relevant to mention there
[20:20] <kracker> agreed, i’m working through finding the correct acl permissions configuration for the web app
[20:21] <zrg> also the disableconfirm, i have yet to find out tho exactly how they can be used
[20:24] <zrg> its gonna be good. but now i sleep, will add the gory details when back among living
[20:25] * zrg is now known as zrg_comatose

Solution #1

Restrict Class Version History (by class) to only two revisions, published or draft.

Edit the your override for content.ini (ie: override/content.ini.append.php )
1. For folder class in content.ini
2. See: VersionHistoryClass[1]=5
3. Change it to : VersionHistoryClass[1]=2
4. Warning: If you change it to 1 (ie: VersionHistoryClass[1]=1 ) you will not be able to edit object
How to use hidden form fields to specify values of attributes
Remove the discard draft warning (non-core)

Solution #2

We found this kind of hack (for 3.4.2) to turn of the draft versioning mechanism: just override the content/edit_draft.tpl with this:

{let
  last_draft=$object.versions|extract_right(1)[0]
  content_attributes=$last_draft.contentobject_attributes
  main_node_id=$last_draft.main_parent_node_id
  edit_version=$last_draft.version
  edit_language=$last_draft.translation.language_code
  attribute_base='ContentObjectAttribute'
 }
 
 {include uri="design:content/edit.tpl"}
 
 {/let}

References

https://ez.no/community/forum/suggestions/make_versioning_drafts_optional_per_class (last post)
Comment, “i tried to explain how to code in my CMS to another guy once, tutored him for a week firsthand.. some time after that he started heavy drinking i heard, never seen him since :P” –#ezpublish <zrg>

Switching to rewrite rules, removing index.php from URLs and redirecting old requests

Sun, 16 Aug 2009 14:19:42 GMT

About

You will need some mod_rewrite rules set up in Apache. Generally, these should be added to the VirtualHost configuration.

Example

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

Redirect old url conventions/patterns

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]

Reference

Doc: Rewrite
Doc: Solution: Switching to rewrite rules
Forum: N/A

Switching to rewrite rules

Sun, 16 Aug 2009 14:17:29 GMT

Redirect old url conventions/patterns

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

Building php-cli (php 4.4.4) for eZ publish

Sun, 16 Aug 2009 12:31:05 GMT

This is compatible with PHP 4.4.x

I have seen a number of folks (in irc://irc.freenode.net #ezpublish) recently ask about the subject of php-cli and eZ publish.

Many seem to be without a php-cli executable binary and looking to find, install or build from source and install php-cli.

I have for some time been offering compiled php-cli binaries at:
https://download.ezcommunity.net/php-cli/

I have ready to go php-cli binaries for GNU/Linux (php v4.3.x and php v4.4.4) and Windows (php v4.3 only).
The binaries have been tested (lightly) and are known to work on just about any current glibc GNU/Linux distribution.

Today I compiled the very latest php-cli (php v4.4.4) for GNU/Linux for an eZ publish client in need of a stand alone php-cli (v4.4.x) binary.

I have posted the packaged binary for others who do not have php-cli and have found they need php-cli in their eZ publish development and production servers. https://download.ezcommunity.net/php-cli/linux/php-4-4-4-cli.tar.gz

The packaged binary is simple for anyone with shell access (ssh) to upload to their eZ publish installation and use it without having to ask your hosting provider to install php-cli (some hosting providers will not offer this service or the software).

This compiled works out of the box.

For those users who can, I still recommend compiling the standalone php-cli from source themselves.

Here are the commands I used today to compile php-cli from source.

# php-cli (php 4.4.4) compile instructions:
 
lynx https://www.php.net/get/php-4.4.4.tar.gz/from/a/mirror
 
tar -vzxf php-4.4.4.tar.gz
 
cd php-4.4.4
 
mkdir /usr/local/php-4-4-4-cli
 
./configure --prefix=/usr/local/php-4-4-4-cli/php-cli --disable-cgi
 
make
 
make test
 
make install-cli
 
cd /usr/local/
 
tar -vzcf php-4-4-4-cli.tar.gz php-4-4-4-cli

//kracker

Kottonmouth Kings - Enjoy

Building php-cli for eZ publish command line scripts

Sun, 16 Aug 2009 12:30:18 GMT

This is compatible with PHP 4.4.x

About

Building standalone php-cli (php 4.4.4 + refcount patch) for eZ publish

The Patch

eZ publish and eZ publish command line scripts like the update scripts which interact with the content object database can use so many references that it causes PHP to segfault, crash, fail, die ...

This problem has been around for a long time and has only partially been resolved in PHP 4.4.x.

To help reduce the chance PHP might segfault, one may 'patch' PHP source code and recomple PHP.

Refcount (Increased Reference Support) Patch from https://ilia.ws/archives/5-Top-10-ways-to-crash-PHP.html

Index: zend.h
 ====================================
 RCS file: /repository/Zend/Attic/zend.h,v
 retrieving revision 1.164.2.21
 diff -u -3 -p -r1.164.2.21 zend.h
 --- zend.h      16 Mar 2004 17:36:17 -0000      1.164.2.21
 +++ zend.h      14 Apr 2004 18:01:37 -0000
 @@ -263,7 +263,7 @@ struct _zval_struct {
         zvalue_value value;             /* value */
         zend_uchar type;        /* active type */
         zend_uchar is_ref;
 -       zend_ushort refcount;
 +       int refcount;
  };

Patching PHP

Here are the commands I used today patch the php-cli source to include improved reference support.

# php-cli (php 4.4.4) compile instructions:
 
lynx https://www.php.net/get/php-4.4.4.tar.gz/from/a/mirror
 
tar -vzxf php-4.4.4.tar.gz
 
cd php-4.4.4
 
# apply patch
 
vi Zend/zend.h

Building PHP

Here are the commands I used today to compile php-cli from source.

mkdir /usr/local/php-cli-4-4-4-refcount
 
./configure --prefix=/usr/local/php-cli-4-4-4-refcount --disable-cgi
 
make
 
make test
 
make install-cli

Testing

Use this patched php-cli binary to run your eZ publish command line, cronjob, update scripts

Example Use Case

/usr/local/php-cli-4-4-4-refcount/bin/php -d memory_limit=456M -C update/common/scripts/updatesearchindex2.php -s admin-dev -dall  --logfiles --verbose | tee ez.script.index-2006-11-14-0006.log

Another Patch

Another patch has been documented to solve other reference related problems related to eZ publish's PHP code. If the above patch does not solve your breakdowns, consider applying this other patch and test the results.

References

References
[Sdk-public] Update search index Segfaulting fix
Building stock php-cli (PHP 4.4.4) for eZ publish

Top 10 most frequently used extensions

Sun, 16 Aug 2009 06:43:41 GMT

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

Introduction

What were the top 10 most frequently used eZ publish extensions from year to year.

2009

2006

The Extensions

ezdhtml - eZ online editor - Released in 2006 as Free Software licensed under the GNU GPL v2
dynamicmenu
googlesitemaps
wrap_operator
bhlocaltranslations
stats
xmlarea
ezodcsm
regexreplace
shuffle
icons_in_extension

Honorable Mention

xmlarea - Many thanks STEVO + !

Summary

Conclusion

External References

Forum: Top 10 eZ publish extensions in 2006
Forum: Top 10 eZ Publish Extensions in 2009

Overriding kernel classes within an extension

Sat, 15 Aug 2009 11:17:11 GMT

This feature is available since eZ publish 4.1.

About

The best way to override kernel classes within eZ Publish.

This article features solutions for both eZ Pubish 3 and eZ Publish 4.

Please notice that the primary solution described for eZ Publish 4 is a supported but not recommended feature.

Please use with care and caution when working with the internals of the eZ Publish Kernel.

Question

What is the best way to override default eZ Publish kernel classes?

Answers

Several solutions come to mind. The best solution in eZ Publish 4 is to override the class within an extension. Remember this should be considered kernel hacking which while allowed and even more supported than ever in eZ Publish 4 it is still causioned.

PATCHING

In the past the best way to do this was to simply patch the original file and replace it with a modified file within original kernel location.

Creating a Kernel Override Extension

This is the standard solution within eZ Publish.

Create and activate extension

See articles on creating an extension

Copy default kernel file into the extension.

Remember pathing is a relative scheme (pattern) which must be maintained within the extension directory root.

mkdir -p extension/customname/kernel/classes/; cp -va kernel/classes/ezcontentobjecttree.php extension/customname/kernel/classes/;

Configure config.php enable kernel overrides

Create if file does not exist in root of ezpublish directory. Edit config.php file and enable the following setting.

EZP_AUTOLOAD_ALLOW_KERNEL_OVERRIDE

Activating kernel override extension

Activate extension in settings
Regenerate autoload cache

./bin/php/ezpgenerateautoload.php -o

References

Doc: N/A
Doc: config.php

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

Mon, 10 Aug 2009 02:59:47 GMT

About

Summary

References

The Missing eZ publish Left Menu with Index

Sun, 09 Aug 2009 03:22:50 GMT

About

from : zurgutt
description: Left menu with indexpage in it.

Example

Here is a hack code for left menu override, which will add indexpage as first item in menu.
Its very strange its not there to begin with - almost all sites need it.

<div id="leftmenu">
<div id="leftmenu-design">
 
<h3 class="hide">{"Left menu"|i18n("design/base")}</h3>
 
{let docs=treemenu( $module_result.path,
                    is_set( $module_result.node_id )|choose( 2, $module_result.node_id ),
                    ezini( 'MenuContentSettings', 'LeftIdentifierList', 'menu.ini' ),
                    0, 5 )
                    depth=1
                    last_level=0
                    root_node=fetch( content, node, hash( node_id, 2 ) )
                    root_node_array=array( hash('id', $root_node.node_id,
                                                'level', 0,
                                                'url_alias', $root_node.url_alias,
                                                'url', $root_node.url,
                                                'text', $root_node.name,
                                                'is_selected', eq($module_result.node_id, $root_node.node_id)
                                                ) )
}
        <ul>
        {section var=menu loop=merge($root_node_array, $:docs) last-value}
            {set last_level=$menu.last|is_array|choose( $menu.level, $menu.last.level )}
            {section show=and( $last_level|eq( $menu.level ), $menu.number|gt( 1 ) )}
                </li>
            {section-else}
            {section show=and( $last_level|gt( $menu.level ), $menu.number|gt( 1 ) )}
                </li>
                    {"</ul>
                </li>"|repeat(sub( $last_level, $menu.level ))}
            {/section}
            {/section}
 
            {section show=and( $last_level|lt( $menu.level ), $menu.number|gt( 1 ) )}
                {'<ul><li>'|repeat(sub($menu.level,$last_level,1))}
                <ul>
                    <li class="menu-level-{$menu.level}">
            {section-else}
                <li class="menu-level-{$menu.level}">
            {/section}
 
            <a {$menu.is_selected|choose( '', 'class="selected"' )} href={$menu.url_alias|ezurl}>{$menu.text|shorten( 25 )}</a>
 
            {set depth=$menu.level}
        {/section}
           </li>
 
        {section show=sub( $depth, 0 )|gt( 0 ) loop=sub( $depth, 0 )}
            </ul>
        </li>
        {/section}
        </ul>
 
{/let}
 
</div>
</div>

Embedding a poll content object within a page

Sun, 09 Aug 2009 03:22:07 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

Limiting Payment Gateways by Product Content Class

Sun, 09 Aug 2009 03:11:02 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, 09 Aug 2009 03:10:33 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

Converting HTML Form Post Variables into URL View Parameters

Sun, 09 Aug 2009 03:10:18 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)

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

Sun, 09 Aug 2009 03:07:30 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

Checking out all projects.ez.no subversion repositories

Sun, 09 Aug 2009 03:06:46 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 );
 
?>

Template Development Without Clearing Cache

Sun, 09 Aug 2009 03:05:57 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

x86-64 etc, php, ez documentation

Sun, 09 Aug 2009 03:04:06 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

Disable language selection prompt

Sun, 09 Aug 2009 03:03:37 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

Sun, 09 Aug 2009 03:03:21 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

Sun, 09 Aug 2009 03:02:53 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

Sun, 09 Aug 2009 03:01:55 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

Content object published, modified and created date modification

Sun, 09 Aug 2009 02:51:01 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.

External references

Creating eZ publish Doxygen API Documentation

Sun, 09 Aug 2009 02:50:44 GMT

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

Introduction

There is a vast amount of documentation available regarding the source code of eZ publish within the php source code comments.

This source code documentation must be generated into a format like html pages to be useful to developers.

The PubSVN server hosts several generated copies of this documentation one for each major version of eZ publish. These hosted copies of the documentation are useful for online reading.

If your interested in generating your own copy this documentation follow the following steps.

Steps

Download the latest stable release of Doxygen
Download the latest stable release of eZ publish
Install Doxygen
Run Doxygen on eZ publish
Review the generated HTML API documentation

Using shell

Install

Download the latest source distribution, doxygen-1.5.1.src.tar.gz (2.8M) ( ftp | http )

# wget https://ftp.stack.nl/pub/users/dimitri/doxygen-1.5.1.src.tar.gz

Unpack package

# tar -zxf doxygen-1.5.1.src.tar.gz;

Configure package

# cd doxygen-1.5.1;
# ./configure --help;

# sudo apt-get install qt3-linguist qt3-dev-tools-embedded qt3-dev-tools-compat qt3-dev-tools qt3-apps-dev libqt3-mt-dev libqt3-headers libqt3-compat-headers;

# mkdir /usr/local/doxygen;
# ./configure --prefix /usr/local/doxygen --english-only;

Make and Install package

# make;
# make install;

Generate Documentation

# /usr/local/doxygen/bin/doxygen --help

Doxygen version 1.5.1
Copyright Dimitri van Heesch 1997-2006
 
You can use doxygen in a number of ways:
 
1) Use doxygen to generate a template configuration file:
    /usr/local/doxygen/bin/doxygen [-s] -g [configName]
 
    If - is used for configName doxygen will write to standard output.
 
2) Use doxygen to update an old configuration file:
    /usr/local/doxygen/bin/doxygen [-s] -u [configName]
 
3) Use doxygen to generate documentation using an existing configuration file:
    /usr/local/doxygen/bin/doxygen [configName]
 
    If - is used for configName doxygen will read from standard input.
 
4) Use doxygen to generate a template style sheet file for RTF, HTML or Latex.
    RTF:   /usr/local/doxygen/bin/doxygen -w rtf styleSheetFile
    HTML:  /usr/local/doxygen/bin/doxygen -w html headerFile footerFile styleSheetFile [configFile]
    LaTeX: /usr/local/doxygen/bin/doxygen -w latex headerFile styleSheetFile [configFile]
 
5) Use doxygen to generate an rtf extensions file
    RTF:   /usr/local/doxygen/bin/doxygen -e rtf extensionsFile
 
If -s is specified the comments in the config file will be omitted.
If configName is omitted `Doxyfile' will be used as a default.

# cd /web/ez/ezpublish-3.8.4/doc/

# svn export https://pubsvn.ez.no/nextgen/trunk/tests
# svn export https://pubsvn.ez.no/nextgen/trunk/benchmarks

# /usr/local/doxygen/bin/doxygen /web/ez/ezpublish-3.8.4/doc/doxygen/Doxyfile

Results

You can view an example log the result of running the doxygen documentation generation command.

Review Documentation

The resulting documentation will have been generated and stored on disk in the 'doc/generated/html/' directory.

Extending Doxygen Configuration

The default doxygen configuration file distributed with eZ publish has been pointed out to not take advantage of a few useful configuration features available. This is because the documentation can be viewed using a URL like "https://example.org/reference/view/ez" through the eZ interface. Having extra HTML and JavaScript would break this view. However, you can create a standalone version of the documentation by changing the settings below.

Note, "If the GENERATE_TREEVIEW tag is set to YES, a side panel will be generated containing a tree-like index structure...."

This option used by PubSVN's hosted copy of the generated doxygen documentation generated from eZ publish trunk. I belive by default this option is not enabled!

Removing the references to "doc/doxygen/empty.html" in the Doxyfile on lines 608 and 614 causes the Doxygen standard theme to be used (as seen on PubSVN).

Using GUI

Install

Download the latest MacOS or Windows package.

Doxygen-1.5.1.dmg (16.5M) ( ftp | http )

doxygen-1.5.1-p1-setup.exe (5.3M) ( ftp | http )

Generate Documentation

Here is the basic use of the gui documentation wizard named doxywizard. If you want to use a previously defined doxygen configuration file Doxyfile, pass it as an argument to the wizard or use the "Load" button in the main window.

(Screenshots to be provided when image upload will be available)

Click on the Wizard button, a new dialog box appears.

Give a name and a version to your project (eg. Ezpdoc and 1.0 respectively)
Give the directory name where ezpublish is installed (eg. /var/www/html/Ezpublish)
Check the "Scan recursively" box
Give the name of an existing destination directory (eg. /home/me/Ezpublish/Doxygen)

Click on the "Mode" tab

Check the "Documented entities only"
Check one of the "Optimize" that fits to your purpose

Click on the "Output" Tab

Check "HTML" and "with frame and a navigation tree"
Check "Include cross-referenced..."
uncheck all the others unless you need it

Click on the 3Diagrams" tab

Check the "Use buit-in class diagram generator"

Click the OK button of the Wizard dialog box

Click the Save button of doxywizard main screen and save it as Doxyfile in the destination directory previously entered

The final step is to click on the Start button and here you are !

Review Documentation

The resulting documentation will have been generated and stored on disk in the 'doc/generated/html/' directory.

Summary

This process can be automated to generate eZ publish documentation on a regular basis via cron.

External Reference

Download Doxygen Software
Download eZ publish
PubSVN eZ publish Trunk (Doxygen, API/Source Code) Documentation
Crontab example
Doxygen Manual

Manipulating eZXML Document Contents

Sun, 09 Aug 2009 02:50:32 GMT

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

Problem - Example #1

I need to modify the contents of the eZXML document stored in the ezorder.data_text_1 (variable/field).

I need to append three sibling items to the last in the 'shop_account' structure.

The document

The eZXML document contains the following example structure.

<shop_account>
  <first-name>Null</first-name>
  <mi></mi>
  <last-name>Man</last-name>
  <address1>7x Campus</address1>
  <address2>Suite 250</address2>
  <city>Anchorage</city>
  <zip>99507</zip>
  <state>AK</state>
  <phone>907-555-1212</phone>
  <email>[email protected]</email>
  <shipping>1</shipping>
  <shippingtype>0</shippingtype>
</shop_account>

I could not find a way to modify an existing document simply this using any existing eZ code or API. I was pointed by a friend to use 'domxml' as an alternative to provide the features should need to modify an existing document without having to write code to regenerate it myself (which I did not really want to do, or think I should have too).

The code

The following is an example of the code used in this example solution

/* umm ... */

The summary

There are a number of solutions to this problem. This is simply one example for the next person trying to use, manipulate information stored (trapped) in ezxml / xml inside the eZ publish database content.

Remove all shop orders

Sun, 09 Aug 2009 02:50:20 GMT

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

Question

How can I remove all shop orders?

Solution

Use the 'shop' argument of the ' cleanup.php' php-cli / eZ script to remove all shop orders (among other information).

/usr/local/php4.4.4/bin/php update/common/scripts/cleanup.php -s shop -d -c --logfiles -v --db-user=db --db-password=db --db-database=shop_dev_390 --sql shop

External reference

Documentation: eZ scripts

How to clean all the old objects versions

Sun, 09 Aug 2009 02:48:26 GMT

Question

My web site has more than 6000 objects and some of objects in the content subtree have more than 20 versions! The size of the database increase dramaticly! I'd like to know, if there's a script to delete all the old objects versions included image files.

Solution

My first suggestion would be to checkout the ' flatten.php' script (requires php-cli to run) ' bin/php/flatten.php'.

If you do not have php-cli enabled in your php installation you can get it very quickly by building from source or using existing binaries.

This solution, the combination of php-cli and the flatten.php script should meet your needs. Any other suggestions from the community on this topic?

References

From ez.no forums, How to clean all the old objects versions

Convert database from iso-8859-1 encoding to utf-8 encoding

Sun, 09 Aug 2009 02:45:24 GMT

Problem

Convert database from 'iso-8859-1' encoding to 'utf-8' encoding

Solution

See reference, ez.no forum thread (medium length)

Reference

https://ez.no/community/forum/general/convert_from_iso_8859_1_encoding_to_utf_8

Moving eZ publish installations

Sun, 09 Aug 2009 02:43:18 GMT

Tips When Moving Production Domain Names and Websites

Often when moving a production website (possibly powered by eZ publish) you face a problem, moving to a new provider you want to minimize the down time experienced by your customers and visitors.

In some situations no one knows you exist, your a new site, or a new sub-site so you have a bit more freedom (to take your time or learn).

In other situations time is critical and you must move a store (source code and database) to a new provider, along with moving DNS to a new provider, configuring the new server and configuring the application to run on the new server ...

You run into a real problem, you can access the server by ip address but not by the desired domain name (as those changes are in the process of propagating (delivered) to the rest of the internet).

Yet to test the website you may need to access it via a domain name ...

Well, here’s what you do ...

Configure your computers host file

On Linux/Unix - usually /etc/hosts
On MacOS X - try here
On Windows - %WINDIR%\system32\drivers\etc\hosts

To statically point the new server’s ip address to the hostname / domain name

Example Host file addition:

192.168.0.3 example.ezpublish.com example2.ezpublish.com

You can add several hostnames after the IP address, as well as have multiple lines for the same IP if required.

Spell Checking Content Using eZ publish Online Editor and Firefox

Sun, 09 Aug 2009 02:42:26 GMT

Submitted By: Graham Brookins

Brief: Firefox + eZ publish + Online Editor + Spellcheck Plugin

If you manage an website powered by eZ publish, one of the first questions that becomes a regular occurrence; Is my content spelled correctly. The answer is found in a process which ensures that content has been read not just passed on without a quality control process. A process like being reviewed for comprehension, spelling, crammer, readability, continuity, clarity, accuracy and quality by an editor.

I love the eZ publish Online Editor! Now I know what your thinking, what about all that nay saying from people who say $99 for a javascript gui editor designed specifically for an enterprise cmf/cms system! It’s too much, It’s not enough, it’s not free (as in free beer)! I say, take another look at the eZ publish Online Editor v2.0. The new 2.0 supports both Internet Explorer (existing) and Mozilla/Gecko (new) based browsers. I even heard that there are some eZ publish hosting companies which provides a free copy of the online editor for use on your eZ publish installation.

I just recently was given the opportunity to try it and I was blown away. Not only does it work in Firefox but combined with other Firefox extensions, Managing eZ publish content has never been more efficient and quick. Upon installing a the Firefox Plugin SpellBound and a Dictionary, I found that any form field, including eZ publish forms and could be spell checked quickly and simply.

Before this I would edit all my content in a hand text editor and spell checked before posting for reliability and avoid browser page session timeouts, crashes, or other accidents by only posted content through an editor process, cause it works well.

Still being able to combine Firefox with the online editor could make my smaller less important content additions / changes spelled accurately much quicker.

Problem

Missing Client Side, Spell Check from OE / eZ publish

Solution

Use a browser plugin to provide spell checking within the browser itself, for which all content to the website passes through.

Directions

Install Firefox
Install the SpellBound Plugin, a Dictionary for your region,
Restart Firefox. !Voila

Problem

The 'Context Menu' in OE prevents use of firefox right click menu features / items.

Unfortunately, It’s true, the Online Editor Appears to lack the a browser side feature to control / allow the use of a browsers right click menu inside of an eZ xml text field with a default installation of the Online Editor. Nor does it provide a client side feature enable or disable this behavior on a per session or instance basis. Which prevents the use of a many browser plugins / features when you right click inside of an eZ xml text field and the editor is enabled.

Solution

Disable the eZ publish OE Right Click Context Menu (permanently in the source code)

Simply edit this file 'ezmozillaeditor.js' located in your eZ publish installation at 'extension/ezdhtml/design/standard/javascripts/ezdhtml/'

Change these lines:

editorDoc.addEventListener( "contextmenu", disableDefaultContextMenu, false );
    editorDoc.addEventListener( "mousedown", removeContextMenu, false);
    editorDoc.addEventListener("contextmenu", function(){showContextMenu(editorID,indexDir,objectID,objectVersion);}, false);

Comment them out / Change them to:

/*
    editorDoc.addEventListener( "contextmenu", disableDefaultContextMenu, false );
    editorDoc.addEventListener( "mousedown", removeContextMenu, false);
    editorDoc.addEventListener("contextmenu", function(){showContextMenu(editorID,indexDir,objectID,objectVersion);}, false);
*/

An other perhaps more flexible alternative would be to add a setting in the oe extension to support a per installation setting configuration which could enable or disable a feature similar to this for greater flexibility in the implementation. Yet a better solution would be to offer a per session configuration in the oe which could enable or disable the oe menu with a click of a button and or a keyboard shortcut + right click which could allow per click choice to allow the suppression of the oe’s context sensitive right click menu and allow the browser’s menu to be used in it’s stead.

editorDoc.addEventListener( "contextmenu", disableDefaultContextMenu, true );
    editorDoc.addEventListener( "mousedown", removeContextMenu, true);
    editorDoc.addEventListener("contextmenu", function(){showContextMenu(editorID,indexDir,objectID,objectVersion);}, true);

Hint, Hint, Article Ideas:

Managing eZ publish Nice Url Length

Sun, 09 Aug 2009 02:40:11 GMT

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

Summary

I saw this question in the forums once.

The answer at the time was to carefully control the individual object names of possible url attributes both at a class and object level.

References

None

Improving eZ publish Performance Optimization

Sun, 09 Aug 2009 02:38:41 GMT

This page is perhaps one of the most important to the largest number of users in the community.

Lets face it, we all run eZ publish on a wide range of hardware / software systems and configurations.

We desperately need to know just how to get the most out of the configurations we are running eZ publish within.

Performance, Reviews for eZ publish (the process / theory of breaking down the whole thing to find and address the critical bottle necs.

While I don’t have that just yet, I wanted to share this little tidbit ...

Web cacheing with a Proxy

Their are performance benifits from using a reverse proxy in front of eZ Publish.

Content view cache

eZ Publish content view cache stores the output from a node view the first time it's accessed and generated. Requests afterwards are served from the viewcache.

Disable ProcessCaching

If you add this line into your override/site.ini.append.php or siteaccess/corporate/site.ini.append.php ini file you may get a very segnificant reduction in eZ publish processing time per request (cached or uncached!)

[TemplateSettings]
 # reduces latency when disabled
 # ProcessCaching=enabled
 ProcessCaching=disabled

Example of my settings in override/site.ini.append.php from a recent project

[TemplateSettings]
Debug=disabled
# Debug=enabled
DebugOutput=disabled
# DebugOutput=enabled
TemplateCache=enabled
TemplateCompile=enabled
# reduces latency when disabled
ProcessCaching=disabled

References

https://www.ez.no/ez_publish/documentation/configuration/optimization/disabling_the_cache

https://ez.no/ez_publish/documentation/development/kernel/cache_block_optimization

Search 'Performance' : eZ publish Optimization, Caching, Smart View Caching

Building eZ publish from svn

Sun, 09 Aug 2009 02:37:33 GMT

From: kracker

Surprised, I found it! I can’t believe I found it! :D !!! OK, so i’ll .... post it!

I had been talking yesterday about my modified set of ezpublish build from svn scripts and I stumbled upon them.

Warning: These are fairly old, incomplete and unmaintained.

https://download.ezcommunity.net/ezbuild

https://download.ezcommunity.net/ezbuild.tar.gz

Installing addons with a SVN-installation

From : SEAwolfx

https://ez.no/community/bugs/while_setup_packages_list_can_not_be_displayed

The eZ publish Language Translation : ezlupdate

From : kracker & SEAwolfx

Description: ezlupdate compilation and installation, common problem experianced by user

Most users forget or need to relearn a few key steps in the installation of ezlupdate.

For example:

1) Many users forget to set the QTDIR in my environment on the shell ( readme )

The Include-directory for QT is taken from the shell environment, which could be set with: “export QTDIR=/usr/qt/3/include” before using the ./bin/makedist.sh skript or before compiling manually.

2) Wrong Sever and Paths ...

SEAwolfx: do i have to set the paths to pubsvn instead to svn.ez.no ... i think so?!

SEAwolfx: just look in to the bin/shell/commons.sh

SEAwolfx: my vars:

SEAwolfx: REPOSITORY_BASE_URL=”https://pubsvn.ez.no/svn/ezpublish”

SEAwolfx: TR_REPOSITORY_BASE_URL=”https://pubsvn.ez.no/svn/translations”

SEAwolfx: REPOSITORY_BRANCH_PATH=”https://pubsvn.ez.no/svn/nextgen/stable/3.7”

SEAwolfx: wrong paths.

Further Topics:

* Building eZPublish from SVN-Sources (building_ezpublish_from_svn_sources_v1-3.txt)

Overriding kernel error templates

Sun, 21 Jun 2009 02:04:55 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

How to change the datatype of attributes?

Sun, 21 Jun 2009 01:06:02 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

Dynamic Layouts - Managing Style as Content

Fri, 29 Feb 2008 20:34:41 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}

Overriding the eZ Web Interface (ezwebin) with custom designs

Mon, 29 Oct 2007 10:22:16 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).

Working with eZ publish translations

Fri, 10 Aug 2007 04:51:49 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

Website toolbar for custom classes

Sat, 19 May 2007 12:01:03 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.

Creating deb packages

Fri, 09 Mar 2007 10:55:31 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

Creating rpm packages

Fri, 09 Mar 2007 10:55:28 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

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 and maintaining an eZ publish patch

Fri, 16 Feb 2007 13:59:21 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