collective.exportimport 1.5

Export

Use the form with the URL /@@export_content, and select what you want to export:

You can export one or more types and a whole site or only a specific path in a site. Since items are exported ordered by path importing them will create the same structure as you had originally.

The downloaded json-file will have the name of the path you exported from, e.g. Plone.json.

The exports for members, relations, localroles and relations are linked to in this form but can also be called individually: /@@export_members, /@@export_relations, /@@export_localroles, /@@export_translations, /@@export_ordering, /@@export_discussion.

Import

Use the form with the URL /@@import_content, and upload a json-file that you want to import:

The imports for members, relations, localroles and relations are linked to in this form but can also be called individually: /@@import_members, /@@import_relations, /@@import_localroles, /@@import_translations, /@@import_ordering, /@@import_discussion.

As a last step in a migration there is another view @@reset_modified_date that resets the modified date on imported content to the date initially contained in the imported json-file. This is necessary since varous changes during a migration will likely result in a updated modified-date. During import the original is stored as obj.modification_date_migrated on each new object and this view sets this date.

Migrations

When a in-place-migration is not required you can choose this addon to migrate the most important parts of your site to json and then import it into a new Plone instance of your targeted version:

• Export content from a Plone site (it supports Plone 4 and 5, Archetypes and Dexterity, Python 2 and 3).

• Import the exported content into a new site (Plone 5.2+, Dexterity, Python 3)

• Export and import relations, translations, users, groups and local roles.

It does not support any of the following data from your database:

• content revisions

• registry-settings

• portlets

• theme

• installed addons

Other

You can use this addon to

• Archive your content as json

• Export data to prepare a migration to another system

• Combine content from mutiple plone-sites into one.

• Import a plone-site as a subsite into another.

• Import content from other systems as long as it fits the required format.

• Update or replace existing data

• …

Export content

Exporting content is basically a wrapper for the serializers of plone.restapi:

from plone.restapi.interfaces import ISerializeToJson
from zope.component import getMultiAdapter

serializer = getMultiAdapter((obj, request), ISerializeToJson)
data = serializer(include_items=False)

Import content

Importing content is a elaborate wrapper for the deserializers of plone.restapi:

from plone.restapi.interfaces import IDeserializeFromJson
from zope.component import getMultiAdapter

container.invokeFactory(item['@type'], item['id'])
deserializer = getMultiAdapter((new, self.request), IDeserializeFromJson)
new = deserializer(validate_all=False, data=item)

Use for migrations

A main use-case of this package is migration from one Plone-Version to another.

Exporting Archetypes content and importing that as Dexterity content works fine but due to changes in field-names some settings would get lost. For example the setting to exclude content from the navigation was renamed from excludeFromNav to exclude_from_nav.

To fix this you can check the checkbox “Modify exported data for migrations”. This will modify the data during export:

• Drop unused data (e.g. next_item and components)

• Remove all relationfields

• Change some fieldnames that changed between AT and DX

  • excludeFromNav → exclude_from_nav

  • allowDiscussion → allow_discussion

  • subject → subjects

  • expirationDate → expires

  • effectiveDate → effective

  • creation_date → created

  • modification_date → modified

  • startDate → start

  • endDate → end

  • openEnd → open_end

  • wholeDay → whole_day

  • contactEmail → contact_email

  • contactName → contact_name

  • contactPhone → contact_phone

• Update view names on Folders and Collection

• Export ATTopic and their criteria to Collections with querystrings

• Update Collection-criteria (TODO)

• Fix image links and scales (TODO)

Control creating imported content

You can choose between four options how to deal with content that already exists:

• Skip: Don’t import at all

• Replace: Delete item and create new

• Update: Reuse and only overwrite imported data

• Ignore: Create with a new id

Imported content is initially created with invokeFactory using portal_type and id of the exported item before deserialing the rest of the data. You can set additional values by specifying a dict factory_kwargs that will be passed to the facory. Like this you can set values on the imported object that are expected to be there by subscribers to IObjectAddedEvent.

Export versioned content

Exporting versions of Archetypes content will not work because of a bug in plone.restapi (https://github.com/plone/plone.restapi/issues/1335). For export to work you need to use a version between 7.7.0 and 8.0.0 (if released) or a source-checkout of the branch 7.x.x.

Export Example

from collective.exportimport.export_content import ExportContent

class CustomExportContent(ExportContent):

    QUERY = {
        'Document': {'review_state': ['published', 'pending']},
    }

    DROP_PATHS = [
        '/Plone/userportal',
        '/Plone/en/obsolete_content',
    ]

    DROP_UIDS = [
        '71e3e0a6f06942fea36536fbed0f6c42',
    ]

    def update(self):
        """Use this to override stuff befor ethe export starts
        (e.g. force a specific language in the request)."""
        return

    def global_obj_hook(self, obj):
        """Inspect the content item before serialisation data.
        Bad: Changing the content-item is a horrible idea.
        Good: Return None if you want to skip this particular object.
        """
        return obj

    def global_dict_hook(self, item, obj):
        """Use this to modify or skip the serialized data.
        Return None if you want to skip this particular object.
        """
        return item

    def dict_hook_document(self, item, obj):
        """Use this to modify or skip the serialized data by type.
        Return the modified dict (item) or None if you want to skip this particular object.
        """
        return item

Register it with your own browserlayer to override the default:

<browser:page
    name="export_content"
    for="zope.interface.Interface"
    class=".custom_export.CustomExportContent"
    layer="My.Custom.IBrowserlayer"
    permission="cmf.ManagePortal"
    />

Import Example

from collective.exportimport.import_content import ImportContent

class CustomImportContent(ImportContent):

    CONTAINER = {'Event': '/imported-events'}

    # These fields will be ignored
    DROP_FIELDS = ['relatedItems']

    # Items with these uid will be ignored
    DROP_UIDS = ['04d1477583c74552a7fcd81a9085c620']

    # These paths will be ignored
    DROP_PATHS = ['/Plone/doormat/', '/Plone/import_files/']

    # Default values for some fields
    DEFAULTS = {'which_price': 'normal'}

    def start(self):
        """Hook to do something before importing one file."""

    def finish(self):
        """Hook to do something after importing one file."""

    def global_dict_hook(self, item):
        if isinstance(item.get('description', None), dict):
            item['description'] = item['description']['data']
        if isinstance(item.get('rights', None), dict):
            item['rights'] = item['rights']['data']
        return item

    def dict_hook_customtype(self, item):
        # change the type
        item['@type'] = 'anothertype'
        # drop a field
        item.pop('experiences', None)
        return item

    def handle_file_container(self, item):
        """Use this to specify the container in which to create the item in.
        Return the container for this particular object.
        """
        return return self.portal['imported_files']

Register it:

<browser:page
    name="import_content"
    for="zope.interface.Interface"
    class=".custom_import.CustomImportContent"
    layer="My.Custom.IBrowserlayer"
    permission="cmf.ManagePortal"
    />

Use in code

It is possible to import data in a setuphandler or upgrade-step:

from pathlib import Path
from plone import api

def full_import():
    portal = api.portal.get()
    request = aq_get(portal, 'REQUEST')

    import_content = api.content.get_view('import_content', portal, request)
    path = Path(os.path.dirname(__file__)) / 'mydata.json'
    import_content(jsonfile=path.read_text(), return_json=True)

    import_translations = api.content.get_view('import_translations', portal, request)
    path = Path(os.path.dirname(__file__)) / 'translations.json'
    import_translations(jsonfile=path.read_text())

    import_relations = api.content.get_view('import_relations', portal, request)
    path = Path(os.path.dirname(__file__)) / 'relations.json'
    import_relations(jsonfile=path.read_text())

    import_members = api.content.get_view('import_members', portal, request)
    path = Path(os.path.dirname(__file__)) / 'members.json'
    import_members(jsonfile=path.read_text())

    import_ordering = api.content.get_view('import_ordering', portal, request)
    path = Path(os.path.dirname(__file__)) / 'ordering.json'
    import_ordering(jsonfile=path.read_text())

    import_defaultpages = api.content.get_view('import_defaultpages', portal, request)
    path = Path(os.path.dirname(__file__)) / 'defaultpages.json'
    import_defaultpages(jsonfile=path.read_text())

    reset_modified = api.content.get_view('reset_modified_date', portal, request)
    reset_modified()

Save all content to var/instance/:

from plone import api
from Products.Five import BrowserView

class ExportAll(BrowserView):

    def __call__(self):
        export_content = api.content.get_view('export_content', self.context, self.request)
        self.request.form['form.submitted'] = True
        export_content(portal_type=['Folder', 'Document', 'Event'], include_blobs=2, download_to_server=True)
        # Important! Redirect to prevent infinite export loop :)
        return self.request.response.redirect(self.context.absolute_url())

Import all content from var/instance/import/:

from App.config import getConfiguration
from pathlib import Path
from plone import api
from plone.protect.interfaces import IDisableCSRFProtection
from Products.Five import BrowserView
from zope.interface import alsoProvides

import os

class ImportAll(BrowserView):

    def __call__(self):
        alsoProvides(self.request, IDisableCSRFProtection)
        instance_path = getConfiguration().clienthome
        import_content = api.content.get_view('import_content', self.context, self.request)
        self.request.form['form.submitted'] = True
        path = Path(instance_path) / 'import/my_data.json'
        import_content(jsonfile=path.read_text(), return_json=True)

Written by

Installation

Install collective.exportimport by adding it to your buildout:

[buildout]

...

eggs =
    collective.exportimport

and then running bin/buildout

You don’t need to activate the add-on in the Site Setup Add-ons control panel to be able to use the forms @@export_content and @@import_content in your site.

You do need to add it to your buildout configuration and run buildout to make these features available at all. See https://docs.plone.org/manage/installing/installing_addons.html for details.

Contribute

• Issue Tracker: https://github.com/collective/collective.exportimport/issues

• Source Code: https://github.com/collective/collective.exportimport

Support

If you are having issues, please let us know.

License

The project is licensed under the GPLv2.

1.5 (2022-04-26)

• Fix AttributeError for getPhysicalPath when checking parent, issue 123. [maurits]

• Export and import redirection tool data. [gotcha, Michael Penninck]

• Serialize Products.TALESField fields as raw instead of evaluated expression. (useful to export PFG overrides) [sauzher]

• Make sure we never change a acquired modification_date or creation_date. [pbauer]

• Export and import workflow_history. [pbauer]

• Fail gracefully on errors during importing portlets. [pbauer]

• Ignore containers where content should be imported to that are non-folderish. [pbauer]

• Use catalog instead of ZopeFindAndApply and better logging for export_discussion. [pbauer]

• Add converter for long ints (py2 only). [pbauer]

• By default no not export linkintegrity relations. [pbauer]

• Log detailed exception when exporting content fails. [pbauer]

• Add start and finish hooks for export of content. [pbauer]

• Rewrite export/import of default pages: Use uuid of default-page instead of id. Rewrite getting default_page to fix various issues with translated content. [pbauer]

• Add export and import of versions/revisions of content (#105). [pbauer]

1.4 (2022-01-07)

• Fix debug flag in ExportRelations [petschki]

• Deserialize portlet-data using restapi to fix importing RichText. [pbauer]

• Fix importing richtext with html-entities. Fixes #99 [pbauer]

• Preserve links to browser-views by using a custom find_object. Fixes #97 [pbauer]

• Ignore linkintegrity when importing items with replace-strategy. [pbauer]

• Add tests for fix_html. [pbauer]

1.3 (2021-12-08)

• Handle default page of the site root object. [fulv]

• Optionally (checkbox) skip existing content on import instead of generating it new with a randomized id. [petschki]

• Fix UnboundLocalError when calling import_content with return_json and server_file. [petschki]

• Add option to make a commit every x items. [pbauer]

• Improve logging during import in vairous cases. [pbauer]

• Work around case where api.content.get(path=parent_path) raises NotFound instead of returning None. [pbauer]

• Keep value of import_to_current_folder. [pbauer]

• Fix html unescape in py3. [pbauer]

• Fix serializing ATNewsItem image field content. [gotcha]

• Migrate eventUrl to event_url (AT to DX). [ThibautBorn]

• Log items that cannot be serialized instead of aborting the export. [ThibautBorn]

• Add a item_hook to export_localroles. [ThibautBorn]

• Fix handling of checkboxes for skip_existing_content and import_to_current_folder. [pbauer]

• Move intermediary commit code into commit_hook method to allow overriding. [pbauer]

• Add hook global_obj_hook_before_deserializing to modify the created obj before deserializing the data. [pbauer]

• Add support to update and to replace existing content during import (#76) [pbauer]

• Reindex permissions after importing local roles. [pbauer]

• Add export/import for constrains but import content without checking constrains or permissions (#71). [pbauer]

1.2 (2021-10-11)

• Prevent creating content in a different Plone Site in the same database (#52). In general, cleanup parent paths when in development on localhost. [maurits]

• Read environment variable COLLECTIVE_EXPORTIMPORT_CENTRAL_DIRECTORY (#51). When set, this is used for storing an export file and getting an import file. This is useful for sharing content between multiple Plone Sites on the same server. [maurits]

• Unescape html entities and line-breaks when importing comments (#43). [pbauer]

• Export and import complete sites or content trees with configurable types, depth and path (#40). [pbauer]

• Added option to export blobs as blob paths (#50). [pbauer, maurits]

• Fixed creating missing folder structure (#45). [maurits]

• Export and import portlets (#39). [pbauer]

• Export content and write to file using a generator/yield. This avoids memory ballooning to the size of the exported file (#41). [fredvd]

1.1 (2021-08-02)

• Add option to import file from server. [maurits]

• Missing </form> closing tag in export_content.pt [petschki]

• Support disabled aquisition of local roles during export/import of local roles. [pbauer]

• Use unrestrictedSearchResults to actually export all content. [pbauer]

• Add commit message after importing one type. [pbauer]

• Fix getting container for some cases. [pbauer]

• Fix use in Plone 4.3 without dexterity, zc.relation or plone.app.contenttypes. [pbauer]

• Fix @id of collections and parents of subcollections. Fix #30 [pbauer]

• Fix use in Plone 4.3 with dexterity but without z3c.relationfield. [maurits]

• Add export and import for discussions/comments. [pbauer]

• Add option to fix collection queries after import. [thomasmassmann]

• Reset Creation Date. Fix #29 [pbauer]

• Remove custom serializer for relations beacuse of ConfigurationConflictError with restapi. Relations are dropped anyway in update_data_for_migration when using the default setting. [pbauer]

• Migrate batch size for topics. [pbauer]

• Fix issue of reusing the previous container when no container for a item could be found. [pbauer]

• Add hook self.finish() to do things after importing one file. [pbauer]

• Fix installation with older versions of setuptools (#35) [pbauer]

• Fix installation using pip (#36) [ericof]

• Do not constrain exportable FTIs to allow export of types as CalendarXFolder or ATTopic Criteria. [pbauer]

• Add hook self.start() to do things after importing one file. [pbauer]

1.0 (2021-04-27)

• Support setting values with factory_kwargs when creating instances during import. This can be used to set values that need to be there during subscribers to IObjectAddedEvent. [pbauer]

1.0b1 (2021-03-26)

• Add option to save export on server. [pbauer]

• Fix issues in import_relations and import_ordering. [pbauer]

• Use links to other exports in export_content for easier override. [pbauer]

• Add support for exporting LinguaPlone translations. [pbauer]

1.0a2 (2021-03-11)

• Simplify package structure and remove all unneeded files [pbauer]

• Add export/import for position in parent [pbauer]

1.0a1 (2021-03-10)

• Initial release. [pbauer]