March 2012

3. eZ Publish with eZ Oracle 2.x

eZ Systems provides an extension eZ Oracle to handle the Oracle database implementation. The documentation is very clean and usefull.

Be careful when you download the package. The documentation shows a link to http://projects.ez.no/ezoracle, but on this project, there is a important note ( at the bottom of the page) to go on Github.

Finally, with eZ Publish Community 2012.2 use eZ Oracle 2.3 and download it directly from Github : https://github.com/ezsystems/ezoracle

3.1 Installation

My mission was to install an new eZ Publish on this architecture.

3.1.1 Fisrt way, but is not the good one for me

The eZ Oracle setup instructions explains how to install the extension, import the eZ schema and the eZ data.

But after that, you have to continue the eZ Publish installation process manually. You can't use the standard installation process using the browser (Mail, Databases, languages, siteaccess settings etc…)
And you have to install the imported packages manually too. (ezwebin, ezflow etc...)
I first tried this method, but I canceled.

Now, I know the second method works perfectly, I advise you to use it.

3.1.2 Second way

It's more easy when you come from Linux to install a new eZ Publish on your Linux. (5-20 minutes max).
So I do a new installation on Linux, Apache, and MySQL on my Debian virtual machine.
At this time, my task wasn't to install an new eZ Publish but to migrate an existing one to Windows and Oracle. So, I just had to :

• move the eZ Publish files from my Linux installation to the Windows DocumentRoot
• quick install the eZ Oracle on this eZ Publish
  • unpack in extension directory
  • in override/site.ini.append.php add ActiveExtensions[]=ezoracle in ExtensionSettings section
  • regenerate the autoloads ( php bin/php/ezpgenerateautoloads.php -e)
• migrate the MySQL database to the Oracle database.

The last step can be complicated ! But no, eZ Oracle include a script to do that perfectly !

Note: Naturally, you can do that without installing MySQL on you Windows Server. The MySQL server on your virtual machine will do the job.

3.2 Migrate from your LAMP installation

3.2.1 Files

You just have to copy all files and be careful about the rights.

3.2.2 Rewrite Rules

It's time to install the Rewrite Rule.

To do that, simply add this file : web.config into the DocumentRoot. Like a .htaccess file, IIS will read it.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <system.webServer>
 
    <defaultDocument>
      <!-- Set the default document -->
      <files>
        <remove value="index.php" />
        <add value="index.php" />
      </files>
    </defaultDocument>
 
    <rewrite>
      <rules>
 
        <rule name="Rest API" stopProcessing="true">
          <match url="^api/" ignoreCase="false" />
          <action type="Rewrite" url="index_rest.php" />
        </rule>
 
        <rule name="Treemenu" stopProcessing="true">
          <match url="^([^/]+/)?content/treemenu.*" ignoreCase="false" />
          <action type="Rewrite" url="index_treemenu.php" />
        </rule>
 
        <rule name="Direct access resources" stopProcessing="true">
          <match url=".*" ignoreCase="false" />
          <conditions logicalGrouping="MatchAny">
            <add input="{URL}" pattern="var/([^/]+/)?storage/images(-versioned)?/" ignoreCase="false" />
            <add input="{URL}" pattern="var/([^/]+/)?cache/(texttoimage|public)/" ignoreCase="false" />
            <add input="{URL}" pattern="design/[^/]+/(stylesheets|images|javascript)/" ignoreCase="false" />
            <add input="{URL}" pattern="share/icons/" ignoreCase="false" />
            <add input="{URL}" pattern="extension/[^/]+/design/[^/]+/(stylesheets|flash|images|lib|javascripts?)/" ignoreCase="false" />
            <add input="{URL}" pattern="packages/styles/.+/(stylesheets|images|javascript)/[^/]+/" ignoreCase="false" />
            <add input="{URL}" pattern="packages/styles/.+/thumbnail/" ignoreCase="false" />
            <add input="{URL}" pattern="var/storage/packages/" ignoreCase="false" />
          </conditions>
          <action type="None" />
        </rule>
 
        <!-- Makes it possible to placed your favicon at the root of your
             eZ Publish instance. It will then be served directly. -->
        <rule name="Faviconrewrite" stopProcessing="true">
          <match url="^favicon\.ico$" ignoreCase="false" />
          <!-- Uncomment the line below if you want you favicon be served from the standard design.
               You can customize the path to favicon.ico by replacing design/standard/images/favicon.ico
               by the adequate path. -->
          <!--<action type="Rewrite" url="design/standard/images/favicon.ico" />-->
          <action type="None" />
        </rule>
        <rule name="Favicon" stopProcessing="true">
          <match url="^design/standard/images/favicon\.ico$" ignoreCase="false" />
          <action type="None" />
        </rule>
 
        <!-- Give direct access to robots.txt for use by crawlers (Google, Bing, Spammers..) -->
        <rule name="Robots" stopProcessing="true">
          <match url="^robots\.txt$" ignoreCase="false" />
          <action type="None" />
        </rule>
 
        <!-- Uncomment the following lines when using popup style debug. -->
        <!--<rule name="Debug" stopProcessing="true">
          <match url="^(.*)$" ignoreCase="false" />
          <conditions logicalGrouping="MatchAny">
            <add input="{URL}" pattern="var/cache/debug\.html" ignoreCase="false" />
            <add input="{URL}" pattern="var/[^/]+/cache/debug\.html" ignoreCase="false" />
          </conditions>
          <action type="None" />
        </rule>-->
 
        <!-- Platform for Privacy Preferences Project ( P3P ) related files for Internet Explorer
             More info here : http://en.wikipedia.org/wiki/P3p -->
        <rule name="P3P" stopProcessing="true">
          <match url="^w3c/p3p\.xml$" ignoreCase="false" />
          <action type="None" />
        </rule>
 
        <rule name="Everything else">
          <match url=".*" ignoreCase="false" />
          <action type="Rewrite" url="index.php" />
        </rule>
      </rules>
    </rewrite>
 
  </system.webServer>
</configuration>

3.2.3 Database

I assume you have already an Oracle database with the good eZ Oracle requirements.

The eZ Oracle documentation explains how to migrate from MySQL, I will only explain these commands :

Note: Unusually on eZ Publish, you have to run this command in the extension/ezoracle/bin/php directory.

php mysql2oracle-schema.php YOURMYSQLDB:mysqluser/mysqlpassword@YOURLAMPMySQLSERVER --drop > mydump.sql 

This command dumps your MySQL schema from your MySQL server (in my case my virtual machine).
You can now understand why we needed to install the mysqli driver at the php installation step. (Your Windows server has to connect to a MySQL server)

You have to load this file into the Oracle database. You can do that using SQLPlus or the client of your choice (like TOAD, or Navicat)

Using SQLPlus :

sqlplus oracleuser/oraclepassword@ORCL < mydump.sql 

Note: In my case ORCL was ORACLESERVER_HOST/ORACLEDATABASE_NAME

When the dump is imported into your Oracle database, the last steps are very simple.

Migrate the data :

php mysql2oracle-data.php YOURMYSQLDB:mysqluser/mysqlpassword@YOURLAMPMySQLSERVER oracleuser/oraclepassword@ORACLESERVER_HOST/ORACLEDATABASE_NAME

Update the sequences :

php ora-update-seqs.php oracleuser/oraclepassword@ORACLESERVER_HOST/ORACLEDATABASE_NAME

Final steps :

• Configure the override/settings/site.ini.append.php's DatabaseSettings section

  [DatabaseSettings]
  DatabaseImplementation=ezoracle
  User=oracleuser
  Password=oraclepassword
  Database=ORACLESERVER_HOST/ORACLEDATABASE_NAME 

• Clear the cache

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

Enjoy your eZ Publish !

Conclusion

This tutorial comes from my notes and I think I didn't forget anything.

Even if this installation works, my advice will always be to install eZ Publish on Linux.
I didn't make any benchmark, but I think the performances will always be better on Linux.

But, If one day you have to do this installation I hope this article will help you ;-)

Plop+