plone.multilingual 1.2.1

NOT in development. This package is beeing merged on plone.app.multilingual

.. image:: https://travis-ci.org/plone/plone.multilingual.png
:target: http://travis-ci.org/plone/plone.multilingual

plone.multilingual
==================

This package contains the core functionality for the next generation multilingual engine.

These are the main artifacts and its purposes:

canonical:
* the canonical organizes the information about a "translation-group"
* it's using a dictionary with language-codes as keys and uuids
(provided by plone.uuid) as values

storage:
* persistent storage, which holds the canonicals in an IOBTree
* the OOBTree's key is the UUID of the content, the according value is the canonical

manager:
* adapter for ITranslatable
* provides the translations API

adapters:
* ITranslationLocator - where to put a translation
* ITranslationIdChooser - generates a valid id for a translation
* ITranslationCloner - copy the language-independent content to the translation
* ITranslationFactory - creates the translation

In order to have a test we have a type called Demo that has an adapter
called DemoLanguage that will allow to get the language of the object::

>>> from plone.multilingual.interfaces import ITranslationManager
>>> from plone.multilingual.interfaces import ILanguage
>>> from plone.app.testing import setRoles, login, TEST_USER_ID, TEST_USER_NAME
>>> from zope.lifecycleevent import modified

>>> portal = layer['portal']
>>> setRoles(portal, TEST_USER_ID, ['Manager'])
>>> login(portal, TEST_USER_NAME)
>>> portal.invokeFactory('Folder', 'ob1', title=u"An archetypes based folder")
'ob1'

>>> ILanguage(portal['ob1']).set_language('ca')
>>> portal['ob1'].reindexObject()
>>> modified(portal['ob1'])

Ensuring that the new object gets its UUID::

>>> from plone.uuid.interfaces import IUUID
>>> ob1_uuid = IUUID(portal['ob1'])
>>> isinstance(ob1_uuid, str)
True

We create a new translation in 'en' language::

>>> ITranslationManager(portal['ob1']).add_translation('en')

We try to create a new translation in 'ca' that already exists::

>>> ITranslationManager(portal['ob1']).add_translation('ca')
Traceback (most recent call last):
...
KeyError: 'Translation already exists'

We try to create a new translation without language::

>>> ITranslationManager(portal['ob1']).add_translation(None)
Traceback (most recent call last):
...
KeyError: 'There is no target language'

We get the 'en' translation::

>>> ITranslationManager(portal['ob1']).get_translation('en')
<ATFolder at /plone/ob1-en>
>>> ILanguage(ITranslationManager(portal['ob1']).get_translation('en')).get_language() == 'en'
True

let's get all the translations::

>>> ITranslationManager(portal['ob1']).get_translations()
{'ca': <ATFolder at /plone/ob1>, 'en': <ATFolder at /plone/ob1-en>}

let's get only the languages::

>>> ITranslationManager(portal['ob1']).get_translated_languages()
['ca', 'en']

has_translation::

>>> ITranslationManager(portal['ob1']).has_translation('en')
True

>>> ITranslationManager(portal['ob1']).has_translation('it')
False

register_translation with invalid language::

>>> ITranslationManager(portal['ob1']).remove_translation('en')
>>> ITranslationManager(portal['ob1']).register_translation(None, portal['ob1-en'])
Traceback (most recent call last):
...
KeyError: 'There is no target language'

register a translation with content::

>>> ITranslationManager(portal['ob1']).register_translation('en', portal['ob1-en'])
>>> ITranslationManager(portal['ob1']).get_translations()
{'ca': <ATFolder at /plone/ob1>, 'en': <ATFolder at /plone/ob1-en>}

changing the content-language (there should act a subscriber)::

>>> ILanguage(portal['ob1-en']).set_language('it')
>>> from zope.event import notify
>>> from zope.lifecycleevent import ObjectModifiedEvent
>>> notify(ObjectModifiedEvent(portal['ob1-en']))
>>> ITranslationManager(portal['ob1']).get_translations()
{'ca': <ATFolder at /plone/ob1>, 'it': <ATFolder at /plone/ob1-en>}

test more translations::

>>> obj_it = ITranslationManager(portal['ob1']).get_translation('it')
>>> ITranslationManager(obj_it).add_translation('fr')
>>> ITranslationManager(obj_it).add_translation('pt')
>>> ITranslationManager(portal['ob1']).get_translated_languages()
['ca', 'it', 'fr', 'pt']
>>> ITranslationManager(obj_it).get_translated_languages()
['ca', 'it', 'fr', 'pt']

test if canonicals objects are the same::

>>> obj_ca = ITranslationManager(obj_it).get_translation('ca')
>>> canonical_it = ITranslationManager(obj_it).query_canonical()
>>> canonical_ca = ITranslationManager(obj_ca).query_canonical()
>>> canonical_it == canonical_ca
True

Messing up with content
-----------------------
In case that we do mess up things with content (users always do)::

>>> from zope.lifecycleevent import modified
>>> portal.invokeFactory('Folder', 'ob2', title=u"An archetypes based doc")
'ob2'
>>> ILanguage(portal['ob2']).set_language('it')
>>> modified(portal['ob2'])
>>> ILanguage(portal['ob2']).get_language()
'it'
>>> ITranslationManager(portal['ob2']).add_translation('en')
>>> ob2_en = ITranslationManager(portal['ob2']).get_translation('en')

>>> portal.invokeFactory('Folder', 'ob3', title=u"An archetypes based doc")
'ob3'
>>> ILanguage(portal['ob3']).set_language('it')
>>> modified(portal['ob3'])
>>> ILanguage(portal['ob3']).get_language()
'it'
>>> ITranslationManager(portal['ob3']).add_translation('es')
>>> ob3_es = ITranslationManager(portal['ob3']).get_translation('es')

>>> from OFS.event import ObjectWillBeRemovedEvent
>>> notify(ObjectWillBeRemovedEvent(portal['ob2']))
>>> portal.manage_delObjects('ob2')

>>> notify(ObjectWillBeRemovedEvent(ob3_es))
>>> portal.manage_delObjects(ob3_es.id)

>>> c_old = ITranslationManager(portal['ob3']).query_canonical()
>>> c_new = ITranslationManager(ob2_en).query_canonical()
>>> c_old == c_new
False

>>> isinstance(c_old, str)
True
>>> isinstance(c_new, str)
True

>>> ITranslationManager(ob2_en).register_translation('it', portal['ob3'])

>>> c1 = ITranslationManager(portal['ob3']).query_canonical()
>>> c2 = ITranslationManager(ob2_en).query_canonical()
>>> c1 == c2
True

Other use case, A('it' + 'en') and B('it' + 'es'), and we want A('en') -> B('es')::

>>> portal.invokeFactory('Folder', 'mess1', title=u"An archetypes based doc")
'mess1'
>>> ILanguage(portal['mess1']).set_language('it')
>>> modified(portal['mess1'])
>>> ILanguage(portal['mess1']).get_language()
'it'
>>> ITranslationManager(portal['mess1']).add_translation('en')
>>> mess1_en = ITranslationManager(portal['mess1']).get_translation('en')

>>> portal.invokeFactory('Folder', 'mess2', title=u"An archetypes based doc")
'mess2'
>>> ILanguage(portal['mess2']).set_language('it')
>>> ITranslationManager(portal['mess2']).add_translation('es')
>>> mess2_es = ITranslationManager(portal['mess2']).get_translation('es')

>>> ITranslationManager(mess1_en).register_translation('es', mess2_es)
>>> ITranslationManager(portal['mess2']).get_translation('es')
>>> ITranslationManager(portal['mess1']).get_translation('es')
<ATFolder at /plone/mess2-es>

Default-Adapters
----------------
id-chooser::

>>> from plone.multilingual.interfaces import ITranslationIdChooser
>>> chooser = ITranslationIdChooser(portal['ob1-en'])
>>> chooser(portal, 'es')
'ob1-es'

locator::

>>> ITranslationManager(portal['ob1']).add_translation('es')
>>> child_id = portal.ob1.invokeFactory('Folder', 'ob1_child', language="ca")

>>> from plone.multilingual.interfaces import ITranslationLocator
>>> locator = ITranslationLocator(portal['ob1-en'])
>>> locator('es') == portal
True

>>> child_locator = ITranslationLocator(portal.ob1.ob1_child)
>>> child_locator('es') == portal['ob1-es']
True

>>> ITranslationManager(portal['ob1']).remove_translation('es')

Convert intids to uuids upgrade step
------------------------------------

An upgrade step is available in case of having an existing site with the experimental
0.1 plone.multilingual version::

>>> from plone.multilingual.upgrades.to02 import upgrade

.. note::
You must reinstall the plone.multilingual package in order to install the required new
utility in place before upgrading. If you are using a version of Dexterity below 2.0, you
must install the package plone.app.referenceablebehavior and enable the *Referenceable*
(plone.app.referenceablebehavior.referenceable.IReferenceable) behavior for all your
Dexterity content types before you attempt to upgrade your site.

You can run the @@pml-upgrade view at the root of your site or follow the upgrade step in
portal_setup > upgrades. If you can't see the upgrade step, press *Show old upgrades* and
select the *Convert translation based intids to uuids (0.1 → 02)*

Upgrade to catalog
------------------
::

>>> from plone.multilingual.upgrades.to03 import upgrade

we shouldn't find the storage-utility anymore::

>>> from plone.multilingual.interfaces import IMultilingualStorage
>>> gsm = portal.getSiteManager()
>>> gsm.queryUtility(IMultilingualStorage) is None
True

Changelog
=========

1.2.1 2013-10-16
----------------

- Solving on-the-fly language independent field
[ramon]

1.2 2013-09-24
--------------

- Deprecated ``ObjectModifiedEvent`` method
[ramon]

- Don't fire ``ObjectModifiedEvent`` just reindex required indexes in catalog.
[saily]

- Don't trigger reindex if language has not changed.
[saily]

1.1.1 2013-07-03
----------------

- on IObjectRemovedEvent the subscriber ran and reindexed the object
to be removed. Bug solved
[ramon]

1.1 2013-06-19
--------------

- change set_recursive_language in order to update each object
by ITranslationManager instead of notify a IObjectModified event.
This prevent a sort of recursion between different events
[gborelli]

- completed interfaces for TranslationManager and add method
``get_restricted_translations``
[jensens]

- uniquify translated languages [kiorky]

1.0 2013-04-16
--------------

- Merge ``README.rst`` and ``src/plone/multilingual/README.rst`` into
one single file.
[saily]

- Fix all integration- and doctests
[saily]

- Fix wrong accessor in DemoLanguage adapter.
[saily]

- Support Sessions in tests.
[saily]

- Update createdEvent to use aq_parent of created, copied or moved object
instead of ``event.newParent`` which is not available on
``ObjectCreatedEvent``.
[saily]

- Some pep8 cleanup and alignment to plone coding conventions.
[saily]

- Add buildouts for Plone 4.0, 4.1, 4.2 and 4.3
[saily]

- Add travis integration
[saily]

1.0rc1 2013-01-26
-----------------

- Moved the external tool to catalog and added content attribute [ramon]

- Upgrade steps from b3 to rc1 [ramon]

- Fixed bugs on subscribers [sneridagh]

- Make import of upgrade step "to02" depend on the existence of plone.dexterity [pysailor]

- Added get_restricted_translations [ramon]

1.0b3 2012-10-04
------------------

- added TestSubscribers to test subscribers for IObjectAddedEvent,
IObjectCopiedEvent and IObjectMovedEvent [gborelli]

- Do not raise a KeyError when registering or adding a language
independent translation.
[maurits]

- Take account on the use case where user could do and do changes
on the translations groups and its members. Be sure that it does
not leaves any traces of orphan objects in the storage.
[ramon, sneridagh]

- Added Copy/Paste subscribers [ramon]

- Moved generic AddContent subscribers to check language integrity [ramon]

- Bug solving on ITranslationLocator [ramon]

- Updating language, checking translations integrity [ramon]


1.0b2 - 2012-07-09
------------------

- Change Language Independent identifier to '' [ramon]

- Fixed the uninstall profile. [maurits]


1.0b1 - 2012-04-03
------------------

- No changes.


0.2b3 - 2012-04-03
------------------

- Remove get_field_names from api. [jcbrand]

- Add IDefaultLanguageIndependentFieldsManager and adapter. [jcbrand]

- Reindex object after creation. [ramon]


0.1a2 - 2011-10-20
------------------

- Updated testing facilities to Plone Core packages style. [sneridagh]

- Migrated from bare intids to plone.uuid facilities. [sneridagh]

- Due to the previous change from this version to above, it's only
compatible with Plone 4.1 and above. [sneridagh]

- Added upgrade step and upgrade browser view to convert the 0.1a1
intids based utility to the 0.1a2 uuids based one. [sneridagh]


0.1a1 - 2011-10-03
------------------

- Initial version [ramon, awello, sneridagh]