Message-ID: <1716925872.3156.1485852229107.JavaMail.confluence@ip-10-127-227-164> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_3155_2070821144.1485852229107" ------=_Part_3155_2070821144.1485852229107 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html Binary files URL handling

Binary files URL handling

IO URL decoration=

By default, images and binary files referenced by content will be served= from the same server as the application, like /var/ezdemo= _site/storage/images/3/6/4/6/6463-1-eng-GB/kidding.png<= /code>. This is the default semantic configuration:

=20 
ezpublish:
    system:
        default:
            io:
=09            url_prefix: "$var_dir$/$storage_dir$"
=20

 $var_dir$ and = $storage_dir$ are dynamic, siteaccess-aware settings, and will be replaced by= those settings value in the execution context.

 

URL decorators are an eZ Platform features. If an image field is display= ed via a legacy callback or legacy template, no decoration will be applied.=


Using a static server for images

One common use-case is to use an= optimized nginx to serve images in an optimized way. The example image abo= ve could be made available as http://static.example.com/= images/3/6/4/6/6463-1-eng-GB/kidding.png, by setting up= a server that uses ezpublish/ezpublish_legacy/var/ezdemo_site/storag= e. The eZ Platform configuration would be as follows:<= /p>

=20 
ezpublish:
    system:
        default:
            io:
=09            url_prefix: "http://static.example.com/"
=20

Legacy compatiblity

Legacy still requires non-absolute path to store images (var/site/storag= e/images/etc.). In order to work around this, a UrlRedecorator= , that converts back and forth between the legacy uri prefix and the one in= use in the application has been added. It is used in all places where a le= gacy URL is returned/expected, and takes care of making sure the value is a= s expected.

Internals

Any BinaryFile returned by the public API is prefixed = with the value of this setting, internally stored as ezsettings.scope= .io.url_prefix.

Dynamic containe= r settings

Those settings are siteaccess-aware.

io.url_prefix<= /h4>

Default value: $var_dir$/$storage_dir$
Exampl= e: /var/ezdemo_site/storage

Used to configure the default URL decorator service (<= /span>ezpublish.core.io.default_url_decorator, used by a= ll binarydata handlers to generate the URI of loaded files. It is always in= terpreted as an absolute URI, meaning that unless it contains a scheme (http://, ftp://), it will be prepended= with a '/'.

io.legacy_url_= prefix

Default value: $var_dir$/$storage_dir$Example: var/ezdemo_site/storage

Used by the legacy storage engine to convert images public URI to = a format it understands. Unlike io.url_prefix, it is not an absolute link. = Cannot be overridden using semantic configuration. Changing this= value will break compatibility for the legacy backoffice.

io.root_dir

Example: %ezpublish_legacy.root_dir%/= $var_dir$/$storage_dir$
Default value: /var/www/ezpu= blish/ezpublish_legacy/var/ezdemo_site/storage<= /p>

Physical path where binary files are stored on disk. C= annot be overridden using semantic configuration. Changing this value will = break compatibility for the legacy backoffice.

Services

URL decorators

An UrlDecorator decorates and undecorates a given string (url) in some w= ay. It has two mirror methods: decorate and undecorate.

Two implementations are provided: Prefix, and Absolut= ePrefix. They both add a prefix to a URL, but AbsolutePrefix will ensure that unless the prefix is an external URL, the result wil= l be prepended with /.

Three UrlDecorator services are introduced:

  • ezpublish.core.io.prefix_url_decorator used by the binaryd= ata handlers to decorate all uris sent out by the API. Uses AbsolutePrefix.=
  • ezpublish.core.io.image_fieldtype.legacy_url_decorator use= d via the UrlRedecorator (see below) by various legacy elements (Converter,= Storage Gateway, etc.) to generate its internal storage format for uris. U= ses a Prefix, not an AbsolutePrefix, meaning that no leading / is added.

In addition, a UrlRedecorator service, ezpublish.core.io.image_fie= ldtype.legacy_url_redecorator, uses both decorators above to convert= URIs between what is used on the new stack, and what format legacy expects= (relative urls from the ezpublish root).

 

------=_Part_3155_2070821144.1485852229107--