Skip to content

bobbingwide/oik-clone

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

oik-clone

banner

Description

Clone content between sites

oik-clone provides tools to merge and synchronize content between WordPress sites.

Features:

  • push content on Update to multiple targets
  • pushes post content, post meta data and taxonomy terms
  • pushes the attached file, for attachments
    • maintains relationships: e.g. post_parent and fields referencing other content
    • maintains informal relationships: e.g. in post_content
  • reconciliation of content with a selected slave server.
  • cloning of new content to a selected slave server
  • pull content from other sites in a MultiSite installation
  • compare and update or import from self or a MultiSite site
  • clone virtual field - to display clones of current content

New for version 2.2.0

  • Capability to clone comments attached to a post. Needed for the documentation of Gutenberg comment related blocks.

New for version 2.0.0

  • Admin UI for reconciliation between the local installation and a selected slave site.
  • Also supports cloning of new content to the slave.
  • Automatically reclones content if the featured image was not previously cloned.

This was originally developed as:

    • Batch reconciliation: push and pull between the local installation and a selected slave site.
  • Per post setting to support selective cloning to slave servers

oik-clone is dependent on the oik base plugin; using the oik-plugin as a library of functions sitting on top of WordPress. Both plugins need to be installed and activated on each site.

This solution was developed to address a couple of specific problems

  • performance comparison and improvement in multiple implementations. SEO is not a consideration.
  • synchronization of multiple sites for performance analysis

Installation

  1. Upload the contents of the oik-clone plugin to the `/wp-content/plugins/oik-clone' directory
  2. Activate the oik-clone plugin through the 'Plugins' menu in WordPress
  3. Use oik options > Clone to access the admin interface

Install on both the client and server machines.

Frequently Asked Questions

Is there a beta test version?

Yes, there's a new beta test version for 2.0.0

The June version improves the cloning process. It reduces the amount of user activity required to clone new posts with newly added ( uncloned ) featured images.

The January 2020 beta version supports reconciliation of posts that have been updated in the slave and a 'Do Not Clone' capability.

What does the Slave tab do?

Use this admin page to reconcile content with a slave server or to push new content to the slave server.

What does the Multi-Site tab do?

The initial version of this plugin was designed for use on WordPress MultiSite where you have cloned an existing site into a new version, developed the new version and now want to copy the new contents back into the existing site.

What does the Self tab do?

The Self tab allows for introspection. It provides the same actions as the Multisite tab, but the source and target site is the same.

  • You can use it to look at all your content in one big listing
  • You may find duplicated content
  • You can compare similar content
  • You can duplicate content by performing Import

How does the "Clone on update" work?

This'll be documented in the FAQs on the site

Is this suitable for pushing from Staging to Production?

It depends.

  • If you have a complex content structure or a lot of new/changed content then the answer is to consider using the batch routines.
  • If you have a simple content structure - just posts and pages - then you may find this useful - to both push and pull.

To support pushing from Staging to Production requires additional work to identify the network of posts to be cloned. This can be achieved using a the [clone] shortcode in a widget.

Does this use the REST API?

Not yet, though that was the plan.

It was more complicated than I first thought. So I developed the solution as an extensible solution. For the pull model the oik-clone base logic supports

  • Self
  • Multisite

Extension plugins, yet to be published, may support

  • REST
  • WXR

For the push model the oik-clone base logic supports

  • External sites, which includes Multisite

Why is this dependent upon oik?

Some plugins use Composer to manage their dependencies, pulling in library functions from third party plugins hosted on GitHub and elsewhere.

The oik suite of plugins use common APIs from the oik base plugin. There should be little overhead. Even though oik implements over 80 shortcodes none of them are registered until shortcodes are actually needed. oik attempts to OWN the problem; Only When Necessary.

One day perhaps the lowest level of oik base functions will be exported to a library but in the mean time you have to download and activate oik to make this work.

Are there limitations?

Yes. Work is needed in the following areas.

  • Hierarchical content requires parent content to be cloned first.
  • Sometimes you need to clone the tree, update something and clone again.
  • Limitation on media file size imposed by servers

What authentication method is used?

Simple validation of an API key. Other methods will be implemented in future versions.

Screenshots

  1. Clone on update meta box - select targets
  2. Clone on update meta box - with cloned post links
  3. Clone on update meta box - Previously cloned
  4. Do Not Clone meta box
  5. Clone admin - Slave tab - Slave Post Selection
  6. Clone admin - Slave tab - Slave Post list
  7. Clone admin - Slave tab - Import new post from Slave
  8. Clone admin - Slave tab - Master posts to clone

Upgrade Notice

2.2.0

Update for the ability to clone comments attached to posts.

2.1.1

Update for empty output from clone and cloned shortcodes when OIK_APIKEY is not set.

2.1.0

Update for a fix to issue #60

2.0.1

Update for a fix to issue #56

2.0.0

Update for a fix to issue #52

2.0.0-beta-20200616

Update for an easier process to clone new content with a new featured image.

2.0.0-beta-20200127

Adds an admin interface to reconcile with a slave server and clone new content.

2.0.0-beta-20191121

Upgrade so you can clone reusable blocks.

2.0.0-beta-20191103

Upgrade for improved mapping of post IDs in block attrs

2.0.0-beta-20191011

Upgrade for logic to map IDs in block attributes and content

2.0.0-beta-20191008

Upgrade for 'Do Not Clone' capability. Currently only implemented for Push cloning.

2.0.0-beta-20190811

Upgrade for improved logic when pulling content during batch reconciliation

2.0.0-alpha-20190602

Upgrade for batch reconciliation ( push or pull) including attachments

2.0.0-alpha-20190515

Upgrade to support the batch pull capability.

1.2.0

Update for batch pull between sites in a WordPress Multi Site network. Update for batch push or new/changed posts in a selected post type.

1.1.0

Update for improved support of pull cloning on WordPress Multi Site.

1.0.2

Contains a fix for Issue #26 - links being cloned incorrectly

1.0.1

Contains a fix for Issue #22 and changes for Issue #24

1.0.0

Now depends on oik v3.2.1

1.0.0-RC2

Contains fixes for Issues 9, 11 and 12

1.0.0-RC1

Contains a fix for Issue 8

1.0.0-beta.1013

Upgrade for filtered cloning of post meta data

1.0.0-beta.0919

Upgrade to support the "cloned" date.

  • Note: Since there is an interface change you need to update both clients and servers.

1.0.0-beta.0817

Upgrade to allow attachments to be saved in the original yyyy/mm uploads directory

1.0.0-beta.0726

Upgrade to use the 'cloned' virtual field in shortcodes such as bw_table.

1.0-beta.0601

Improved discovery of target post using slug.

1.0-beta.0511

Required where the target doesn't have oik-fields active. Now partially internationalized, with support for the bbboing language ( bb_BB locale ). Depends on oik v2.6-alpha.0511 or higher

1.0-beta.0422

Improved support for larger media files. Improved mapping of informal relationships in post content.

0.9

Improved mapping of informal relationships in post content.

0.8 -

Supports mapping of informal relationships in post content.

0.7

Supports pushing of hierarchical taxonomies. For Alpha testing on oik-plugins sites.

0.6

Now supports pushing of attachments and the attached media file. Nearly ready for Beta test.

0.5

Supports mapping of post IDs in post_meta data. Not quite ready for beta test.

0.4

Now supports cloning of hiearchical content - maintaining the post_parent on updates.

0.3

Now has basic support for cloning non-hierarchical taxonomies

0.2

Prototype for cloning content on Update

0.1

Prototype for WordPress Multi Site cloned sites

Changelog

2.2.0

  • Added: Logic to clone simple ( non hierarchical ) comments,#57
  • Tested: With Gutenberg 11.9.0
  • Tested: With WordPress 5.8.2
  • Tested: With PHP 8.0

2.1.1

  • Changed: Disable clone and cloned shortcodes when OIK_APIKEY is not defined.,#61
  • Tested: With Gutenberg 10.7.1
  • Tested: With WordPress 5.7.2

2.1.0

  • Fixed: Cater for cloning images between different site IDs in WPMS,#60
  • Tested: With WordPress 5.7.1 and WordPress Multi Site
  • Tested: With Gutenberg 10.6.0-rc.1
  • Tested: With PHP 8.0
  • Tested: With PHPUnit 9

2.0.1

  • Fixed: Cater for term already exists error from wp_insert_term(),#56

2.0.0

  • Fixed: Re-unicodify serialised attributes,#52
  • Tested: With WordPress 5.6-RC2 and WordPress Multi Site
  • Tested: With Gutenberg 9.4.1
  • Tested: With PHP 7.4

2.0.0-beta-20200616

  • Added: Reclone logic run immediately after cloning content,#50
  • Tested: With WordPress 5.4.2 and WordPress Multi Site
  • Tested: With Gutenberg 8.3.0
  • Tested: With PHP 7.3 and PHP 7.4
  • Tested: With PHPUnit 8

2.0.0-beta-20200127

  • Added: Clone admin Slave tab to reconcile content and/or clone new content between master and slave,#49
  • Tested: With WordPress 5.3.2 and WordPress Multi Site
  • Tested: With Gutenberg 7.3.0
  • Tested: With PHP 7.3 and PHP 7.4
  • Tested: With PHPUnit 8

2.0.0-beta-20191121

  • Changed: map the ref attr used in the reusable blocks block,#38
  • Changed: Only expand clone/cloned shortcodes when just one thing is being displayed, #43
  • Tested: With WordPress 5.3 and WordPress Multi Site
  • Tested: With Gutenberg 6.8.0

2.0.0-beta-20191103

2.0.0-beta-20191011

  • Added: Map IDs found in block attributes and content,#38
  • Changed: Support PHPUnit 8,#42
  • Tested: With WordPress 5.2.3 and WordPress Multi Site
  • Tested: With WordPress 5.3-beta3 as a server
  • Tested: With PHP 7.3
  • Tested: With Gutenberg 6.5.0

2.0.0-beta-20191008

  • Added: Do Not Clone meta box and logic to selectively restrict cloning to slaves,#37
  • Tested: With WordPress 5.2.3 and WordPress Multi Site
  • Tested: With WordPress 5.3-beta2 as a server
  • Tested: With PHP 7.3

2.0.0-beta-20190811

  • Changed: Add support for productID parameter in shortcodes,#38
  • Fix: In oik_clone_pull_media_file use include_once for file.php
  • Changed: Perform pull when the action is '????'. This should correct the differences in the post_modified_gmt
  • Fixed: Allow for terms where the slug matches the term_id. e.g. when name is &,#33

2.0.0-alpha-20190602

  • Added: Add logic to pull (new) posts from the slave that haven't been cloned from the master, #34
  • Changed: For reconciliation: add verbose and post-type parameters. Add summarise() method.

2.0.0-alpha-20190515

  • Added: Batch reconciliation of modified posts with a selected slave server - push and pull,#34
  • Changed: Implement wp_insert_post_data and wp_insert_attachment_data filters to set required post_modified and post_modified_gmt
  • Fixes: Avoid Fatal errors cloning taxonomy terms by matching terms by slug not name, #33

1.2.0

  • Added: Add batch clone pull for MultiSite., #31
  • Added: Add batch clone push: clone new/changed posts in a selected post type., #31
  • Changed: Improve MS pull logic to perform mapping and create target folder for attachments., #29
  • Fixed: Avoid messages for corrupted cloning data. Doesn't prevent / fix the corrupted data., #14
  • Fixed: Support listing of all posts in hierarchical/inherited post types in oik-clone admin MultiSite tab
  • Fixed: cURL error 60 in local WPMS., #30
  • Tested: With Gutenberg 5.3.0

1.1.0

  • Changed: Update oik-clone admin MultiSite tab #28
  • Changed: Update MultiSite pull logic for attachments #29
  • Tested: With WordPress 5.1.1
  • Tested: With PHP 7.2
  • Tested: With Gutenberg 5.1.1

1.0.2

  • Fixed: Convert links correctly - don't lose the scheme, #26

1.0.1

  • Fixed: when creating new content call wp_slash to avoid losing backslashes, #22
  • Changed: Use oik_remote class, replaces oik-remote.inc, #24
  • Fixed: Enable cloning of Block icons by removing kses filters in the server #24
  • Tested: With WordPress 5.0.3
  • Tested: With PHP 7.2

1.0.0

  • Added: Batch facility to reload cloning information on an imported database, #17
  • Changed: Attempt to cater for corrupt data, with some trace changes for problem determination #14
  • Changed: Now depends on oik v3.2.1 #21
  • Fixed: Some [bw_link] shortcodes are being mapped to Array #13
  • Tested: With PHP 7.0 and 7.1
  • Tested: With WordPress 4.9 and WordPress Multisite

1.0.0-RC2

  • Fixed: Using [clone] failed to upload attached files #9
  • Fixed: Notice: Array to string conversion #11
  • Fixed: Using [clone] to clone attached media that's been relocated doesn't work correctly. #12

1.0.0-RC1

  • Fixed: OIK_Clone_List_Table::reset_request_uri() should not call esc_url() #8
  • Fixed: Minor tweaks to allow oik-shortcodes to produce the API reference
  • Tested: With WordPress 4.5-RC1

1.0.0-beta.1013

  • Added: [clone] shortcode - Provide a method to determine what needs to be cloned #5
  • Changed: Add $slaves parameter to oik_clone_publicize
  • Changed: Add form= parameter to [clone] shortcode. default=y
  • Changed: Add logic to build the relationships for the posts to clone
  • Changed: Add some error detection in oik_clone_load_post
  • Changed: Fixes #6 - Provide a method to clone directly from the [clone] shortcode output
  • Changed: Fixes #7 - Change from checking post_type_supports 'publicize' to 'clone'
  • Changed: Move add_filter "oik_clone_build_list" from oik_clone_relationships
  • Changed: Only add filter "oik_clone_build_list" filter once
  • Changed: Rename oik_clone_publicize() to oik_clone_clone()
  • Changed: Update [cloned] to show the clone date
  • Changed: Updated language files
  • Changed: Use bw_json_decode() to protect from Warnings and Notices returned from the server
  • Fixed: #3

1.0.0-beta.0919

  • Changed: Now supports additional information in _oik_clone_ids post meta ( Issue #4 )
  • Changed: Using trace level in some bw_trace2() calls
  • Changed: Updated docblocks
  • Fixed: Correct spelling of delimiter

1.0.0-beta.0817

  • Fixed: #2
  • Changed: oik_clone_attempt_import() determines the upload date from the _wp_attached_file post meta data
  • Changed: this is passed to oik_clone_save_media_file() in preference to the post_date.

1.0.0-beta.0726

  • Added: cloned virtual field for use in [bw_table] shortcode
  • Changed: Responds to "oik_fields_loaded" to define the "cloned" virtual field
  • Changed: First pass Internationalization of the admin pages
  • Changed: Further development to allow servers to have different API keys, and Matched to post IDs for exact clones
  • Changed: Added "page_actions" and "option_field"
  • Changed: oik-clone admin > Settings > Advanced now handles row actions and page actions
  • Changed: option field for advanced is now "bw_clone_servers"
  • TODO: Need to complete logic for Basic and Advanced servers

1.0-beta.0611

  • Changed: Added logic to find target post by slug, when not found by GUID. See oik_clone_find_target_by_slug()
  • Added: Prototype logic for improved Servers settings
  • Changed: Added sanitization when dealing with $_SERVER['REQUEST_URI']

1.0-beta.0511

  • Changed: Improved security using esc_url() around add_query_arg()
  • Fixed: is_relationship_field() method loads "includes/bw_fields.inc". Needed if oik-fields is not activated.
  • Fixed: temporary fix for multisite pull; only calls oik_clone_filter_all_post_meta if it exists.
  • Fixed: temporary fix in oik_clone_publicize(); commented out "No slaves to clone" message which was being displayed in WPMS pull
  • Added: Logic to disable heartbeat processing based on a constant "HEARTBEAT". Disables processing if HEARTBEAT is false
  • Added: Logic to force use of oik_clone_update_slave_simple(), when constant "OIK_CLONE_FORCE_SIMPLE" is set
  • Added: prototype filter function for "heartbeat_settings" to control heartbeat interval
  • Added: partially localized version in the bbboing language ( locale bb_BB )

1.0-beta.0422

  • Changed: Media files are now passed using multipart forms. See [api oik_clone_update_slave_multipart()]
  • Changed: MD5 calculation and checking is performed against the original file, not the base64 encoded version
  • Changed: [api bw_remote_post_file()]
  • Added: [api oik_clone_load_media_from_files]
  • Changed: [api OIK_clone_post_file::file_contents] handles media passed through $args['body']['media']
  • Fixed: [api OIK_clone_post_file::attach_body()] passes each top level array entry as a separate field
  • Added: [api OIK_clone_post_file::detach_media] to detect media passed through $args['body']['media']
  • Fixed: Informal relationship mapping: detect the end of query args to prevent out of context IDs from being mapped

0.9

  • Changed: Improved detection of IDs for informal relationship mapping. Only maps IDs with selected parameter names.
  • Fixed: oik_clone_add_attachment() no longer calls oik_clone_edit_attachments(); too early
  • Changed: Added logic to perform mapping of "_bw_image_link" post meta when stored as an integer, representing a post ID

0.8

  • Added: "oik_clone_apply_informal_mapping" filter and functions to apply informal relationship mapping on the target
  • Added: "oik_clone_build_list" filter and function to identify informal relationships
  • Added: OIK_clone_post_file class
  • Added: [cloned] shortcode to display cloned status of a post
  • Added: oik_clone_post_file.php - to replace current logic for posting an attached media file. Not yet integrated.
  • Changed: Increase timeout on oik_clone_update_slave() to cater for media file upload
  • Changed: oik_clone_load_media_file logic only applied for attachments
  • Fixed: Set correct description for new taxonomy terms
  • Fixed: Taxonomies should be updated on new post creation.
  • TODO: oik_clone_apply_mapping() not yet performed in the pull model
  • Added: OIK_clone_informal_relationships class
  • Added: OIK_clone_informal_relationships_source class
  • Added: OIK_clone_informal_relationships_target class
  • Tested: Up to WordPress 4.2-beta4 and MultiSite

0.7

  • Added: Pushing of hierarchical taxonomies
  • Added: Hierarchical taxonomies loaded using oik_clone_load_hierarchical_terms()
  • Added: Flat taxonomies loaded using oik_clone_load_flat_terms()
  • Added: Both routines use class OIK_clone_taxonomies
  • Added: admin/class-oik-clone-taxonomies.php
  • Changed: Now uses oik_clone_lazy_update_taxonomies2()
  • Added: Some screenshots of the Clone on update meta box

0.6

  • Added: Cloning for "attachments"
  • Added: Implements actions for "edit_attachment" and "add_attachment"
  • Added: Both actions invoke oik_clone_lazy_edit_attachment() if the attachment post type supports "publicize"
  • Added: admin/oik-clone-media.php
  • Changed: No longer populating the slaves array with defaults
  • Changed: oik_clone_publicize() now accepts $load_media parameter
  • Changed: Currently the media file is loaded regardless of the value of the $target ID
  • Changed: "media" block is also passed to the server, JSON encoded
  • Fixed: Checking of target ID for the slave
  • Changed: tracing in oik_clone_reply_with_json()
  • Changed: oik_clone_find_target_by_GUID() needs to support finding "attachment"s
  • Changed: oik_clone_attempt_import() will load the media file for attachments.
  • Changed: This is passed to the insert_post
  • Changed: After initial creation oik_clone_update_attachment_metadata() is called
  • Changed: Delete and insert all post meta does not alter _wp_attachment_metadata

0.5

  • Added: target server checks the mapping of posts and applies valid mapping updates.
  • Added: Currently hardcoded for "_thumbnail_id" and "noderef" type fields
  • Note: Not fully tested for multiple select noderef fields.
  • Note: Not tested in the Self/MultiSite tabs

0.4

  • Added: New logic for cloning relationships between posts.
  • Added: AJAX request includes the known post mapping from master to slave server
  • Added: The server tests this mapping to determine the correct post ID for the post_parent
  • Added: OIK_clone_relationships class implements client end
  • Added: OIK_clone_mapping class implements server end
  • Added: Plugins can implement "oik_clone_build_list" filter for handling client field mappings
  • Added: Base logic supports oik-fields "noderef" field type and "_thumbnail_id"
  • Note: Logic for handling relationships in post_meta data is not yet complete on the server end
  • Note: bw_trace2() calls are being used for debug tracing

0.3

  • Added: Simple message on hierarchical posts if the parent has not been cloned
  • Added: admin/oik-clone-taxonomies.php to implement logic to clone taxonomy terms
  • Changed: Should MultiSite be hypenated or spaced or neither?
  • Changed: Slaves tab now called Settings and is the default tab.
  • Changed: oik_clone_load_post loads taxonomies into post->post_taxonomies
  • Changed: oik_clone_perform_import() and oik_clone_update_target() call oik_clone_update_taxonomies()
  • Fixed: Doesn't crash for post_status 'trash'. Doesn't delete clones either.
  • Fixed: oik_clone_get_target_slaves() may not find any values

0.2

  • Added: Displays "Clone on update" meta box for post types that support 'publicize'
  • Added: Performs updates only when post status is "publish" - does not yet support "inherit" for attachments/ other CPTs
  • Added: Optionally performs cloning when content is updated.
  • Added: Client uses AJAX requests to push content to the slave servers
  • Added: Server supports AJAX requests to clone content pushed from the master to the slave
  • Added: oik-clone admin now has a Servers (Settings) tab
  • Added: Implements a very basic level of Authentication. Client accesses OIK_APIKEY constant
  • Changed: Self tab is no longer the default
  • Fixed: Quotes in the post title caused SQL messages
  • Changed: oik_clone_match_post_by_GUID() requires includes/bw_posts.inc when used in the slave server
  • Fixed: oik_clone_update_target() should not pass the post_meta array to wp_update_post()
  • Changed: oik_clone_delete_all_post_meta() and oik_clone_insert_all_post_meta() should not process "_oik_clone_ids"
  • Tested: Supported on WordPress 4.1 and WPMS 4.1 and above

0.1

  • Added: New plugin.
  • Added: Multisite capability, developed for Rathmore Financial and wp-a2z.com / subdomain.wp-a2z.org
  • Added: Self capability (default) developed for testing in a non Multisite environment
  • Added: Classes inherit from BW_List_Table, forked from WP_List_Table
  • Depends: on oik v2.4 or higher

Further reading

If you want to read more about the oik plugins then please visit the oik plugin "the oik plugin - oik information kit"