Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tractorcow/silverstripe-legacyimport

Help you import a SilverStripe 2.4 site DB to 3.1
https://github.com/tractorcow/silverstripe-legacyimport

Last synced: 3 months ago
JSON representation

Help you import a SilverStripe 2.4 site DB to 3.1

Awesome Lists containing this project

README 

        
# Legacy Importer



Import your 2.x sites into 3.x!



## Setting up DB credentials



You'll need to set the following in your `_ss_environment.php` file to point to the old site's database:



 * SS_REMOTE_DATABASE_SERVER

 * SS_REMOTE_DATABASE_USERNAME

 * SS_REMOTE_DATABASE_PASSWORD

 * SS_REMOTE_DATABASE_NAME

 * SS_REMOTE_DATABASE_CLASS (optional, defaults to MySQLDatabase)

 * SS_REMOTE_DATABASE_PORT (optional)

 * SS_REMOTE_DATABASE_SCHEMA (optional)

 * SS_REMOTE_DATABASE_TIMEZONE (optional)

 * SS_REMOTE_DATABASE_PATH (optional)



## Running the importer



You can run this as a dev task using the following



`./framework/sake dev/tasks/LegacyImportTask flush=all`



The import itself is made up of several steps, with each step focusing on importing a single object type.



The actual import itself is broken down into several passes, within each pass a different method on each step

is invoked. For example if your import configuration looks like the below:



```yaml

---

Name: mylegacyimport

---

LegacyImportTask:

  tasks:

    - importer: DataObjectImporter

      class: Group

      # Don't update groups, but identify links

      strategy:

        - Identify

      # Identify matching groups by code

      idcolumns:

        - Code

    - importer: SiteTreeImporter

      # Just import top level pages, but don't try to update pages with existing url segments

      strategy:

        - Add

        - Update

      class: ForumHolder

      where:

		- '"ParentID" = 0'

    - importer: DataObjectImporter

      class: Member

      strategy:

        - Add

        - Identify

      idcolumns:

        - Email

```



The actual process will perform the following tasks



* identify groups

* identify pages

* identify members

* import pages (add or update)

* import members (only add new ones)

* link page relations

* link member relations



## Running task groups



If you want to setup different groups of tasks to run, just replace the 'tasks' in the config with 

another key and use the `tasks=mytasks` querystring parameter instead.



```yaml

---

Name: mylegacyimport

---

LegacyImportTask:

  fixpermissions:

    - importer: DataObjectImporter

      class: Group

      strategy:

        - Update

```



This could be run with the following command.



`./framework/sake dev/tasks/LegacyImportTask flush=all tasks=fixpermissions`



## Running just a single pass



If you want to run a single pass you can skip to one using the 'pass' param.



`./framework/sake dev/tasks/LegacyImportTask flush=all pass=identify`



Warning: Some steps may rely on identification being performed up front, and you should not begin an import

at a later step if prior steps have not been completed.



The passes are as follows:



### identify



Remote objects are selected and compared to all local objects used specified criterea. Then a mapping of all

identified objects is created.



### import



All objects are created (as allowed) or updated (as allowed). Some relations will be hooked up (has_one) as long

as all necessary related objects are available, and have been identified in prior tasks.



### link



A final check-all objects task is run to hook up many_many relations and any other outstanding has_ones.



## Importers



These are the following importers and their supported strategies:



### DataObjectImporter



This is the basic importer, and can import just about any object.



You can use one or more of the following strategies:



* Add - New objects which don't exist locally are added. If doing Add without Identify, then

  you don't need to use idcolumns, since no comparisons will be made.

* Identify - Determine any mapping between local and remote objects. This pass will use the 'idcolumns'

  config to identify matches between objects. Note that if you use relations (E.g. ParentID) then be careful

  where objects might have different IDs across databases. This is ok if using ParentID = 0 as a filter.

* Update - If a record is found it is updated. Will not work by itself, since it either needs Identify or Add

  in either the same, or a prior task. If used with Identify it will update all matching records. If used with Add

  it will update all records which were originally added, but were changed since the last import.



### AssetImporter



This importer loads assets into your site, and has only two specific strategies.



#### Preload



All assets will be downloaded to the local server under a temporary directory prior to synchronisation



For asset transfers also please specify the appropriate rsync or scp command to use.

You will also need to set a holding directory for downloaded assets, which should be outside of your webroot.



rsync command (preferred)



```php

define(

	'SS_REMOTE_SYNC_COMMAND',

	'rsync -rz -e \'ssh -p 2222\' --progress [email protected]:/sites/myoldsite/www/assets /sites/mynewsite/importedfiles'

);

```



scp command (if rsync is not available)



```php

define(

	'SS_REMOTE_SYNC_COMMAND',

	'scp -rP 2222 [email protected]:/sites/myoldsite/www/assets /sites/mynewsite/importedfiles'

);

```



Specify location of assets directory once the above command has executed.



```php

define('SS_REMOTE_SYNC_STORE', '/sites/mynewsite/importedfiles/assets');

```



#### OnDemand



Files will be downloaded as needed. You must define a remote site root to determine this.



```php

define('SS_REMOTE_SITE', 'http://www.myoldsite.com');

```