Preserve your Setka Editor content after the service shutdown
This is a step-by-step guide on ensuring your content created with Setka Editor is safe in WordPress after Setka Editor infrastructure shutdown.
Introduction
To ensure robust content preservation on WordPress after the Setka Editor infrastructure shutdown this guide will do two things:
Explain which assets rely on Setka Editor CDN
Describe the steps needed to migrate mentioned assets to a different CDN
What are "assets"?
Posts created in Setka Editor use and depend on CSS files, custom fonts and icons. These files are assets.
Do assets include my media files (photos, videos)?
No. These files are media files and they always stored in your wp-content/uploads folder (the real full path used by Setka WordPress plugin comes from wp_upload_dir()).
What is "assets sync"?
Most of the assets can be synced (downloaded) to WordPress from Setka CDN automatically by Setka WordPress plugin. However some of them are always stored on Setka CDN. And because of Setka CDN is going to shutdown you will need to do:
Ensure that auto synced assets are downloaded to your WordPress site successfully.
Download some assets manually.
Prepare your site for disabling of Setka CDN because otherwise the plugin will generates errors.
Assets that rely on Setka Editor CDN
The official Setka plugin for WordPress may be configured in two ways:
Most of assets are stored on your server.
All the assets are stored on Setka CDN.
You can check which configuration you are using by following these steps:
Go to Admin panel > Plugins > Installed Plugins > Setka Editor > Settings > Settings tab.
Scroll down to the Enable Setka CDN files checkbox.
If Enable Setka CDN files checkbox is disabled — Most of assets are stored on your server.
If Enable Setka CDN files checkbox is enabled — All the assets are stored on Setka CDN.
The option selected by Setka plugin as default value depends on multiple factors including your hosting platform and constants in your wp-config.php and can also be changed it in the plugin settings.
This table represents where the different files are stored, depending on settings:
Files
Setka CDN is disabled
Setka CDN is enabled
HTML code
Your server
Your server
CSS files of Setka styles and grids
Your server
Setka CDN
Fonts, Icons
Your server
Setka CDN
JS files of interactive elements (public.js)
Setka CDN
Setka CDN
Images, Videos
/wp-content/uploads
/wp-content/uploads
Setka Editor JS file
Setka CDN
Setka CDN
Setka Editor JSON file
Your Server
Setka CDN
Setka Editor CSS file
Setka CDN
Setka CDN
3 types of CSS files
On the frontend side WordPress plugin can use 3 different sets of CSS files for different needs:
Here we will give a brief description of these files to save you time, however if you need more detail you can read about them here.
Combined CSS file. This single file includes CSS for all your Setka Themes and Layouts.
Standalone CSS files. These files contain 1 theme or layout per 1 file + Common files.
AMP CSS. Used as replacement for first 2 types of CSS on AMP pages.
How to check which CSS file type is enabled?
AMP
AMP styles are always used only on AMP pages and can be used with the https://amp-wp.org/ WordPress plugin. If you have AMP pages built with Setka editor, these pages will use AMP CSS files. For more details on AMP check this page.
Standalone (default), Combined (legacy)
Go to the Admin panel > Plugins > Installed Plugins > Setka Editor > Settings > Settings tab on your site and find the "Styles" setting. Depending on which radio button is selected, you will have different modes enabled.
If Default radio button is selected then your site will use Standalone styles if possible (= they successfully synced).
If Legacy radio button is selected then your site will use Combined CSS file.
In case of incomplete sync or if no radio button is selected, then the plugin will use combined styles.
How to check the current sync status?
AMP
If you don't have AMP pages on your site you can skip the AMP sync.
Use the wp setka-editor amp status command in WP CLI to see your current sync status. If the sync is completed successfully then you will see the results as shown below.
The values from setka_editor_amp_styles_id and setka_editor_amp_styles have different values and depend on your themes and layouts configuration in Setka Editor Configurator.
The last thing on the list that needs to be downloaded from Setka CDN and stored on your server is the JS files of interactive elements, or simply public.js. Here is how to download the file:
First step — go to your server with WordPress and create a download-public.php with the following content (bellow).
<?php
$container = $GLOBALS['WPSetkaEditorPlugin']->getContainer();
/**
* @var $themePluginsJS \Setka\Editor\Admin\Options\ThemePluginsJSOption
*/
$themePluginsJS = $container->get(\Setka\Editor\Admin\Options\ThemePluginsJSOption::class);
$downloader = new \Setka\Editor\Admin\Service\FilesSync\WordPressDownloader();
$fileSystem = \Setka\Editor\Admin\Service\Filesystem\FilesystemFactory::create();
// Download the file to a temporary location.
$tmpFile = $downloader->download($themePluginsJS->get())->getResult();
$basePath = path_join(
call_user_func($container->getParameter('wp.plugins.setka_editor.dynamic.storage_path')),
$container->getParameter('wp.plugins.setka_editor.storage_basename')
);
$urlPath = parse_url($themePluginsJS->get(), PHP_URL_PATH);
$dstFolderPath = trim(dirname($urlPath), '/\\');
$dstPathFragments = explode('/', $dstFolderPath);
$_a = $basePath;
foreach ($dstPathFragments as $dstPathFragment) {
$_a = path_join($_a, $dstPathFragment);
if (!$fileSystem->exists($_a)) {
$fileSystem->mkdir($_a);
}
}
$dstFile = path_join($_a, basename($urlPath));
try {
$fileSystem->move($tmpFile, $dstFile);
} catch (\Exception $exception) {
echo 'The file haven\'t moved from the temporary folder to the destination. The destination file may already exists. Check the path, delete the file and try run this script again.' . PHP_EOL .
'The file you tried to download and save: ' . $themePluginsJS->get() . PHP_EOL .
'The destination path: ' . $dstFile . PHP_EOL;
exit(1);
}
$dstUrl = path_join(
path_join(
$container->getParameter('wp.plugins.setka_editor.storage_url'),
$container->getParameter('wp.plugins.setka_editor.storage_basename')
),
ltrim($urlPath, '/\\')
);
$themePluginsJS->updateValue($dstUrl);
Second — run the command wp eval-file download-public.php.
Disabling Setka sync through Cron events
Why you need disable sync?
Because Setka CDN will not be accessible and your site (with Setka Editor WordPress plugin) will not able download assets. If cron events are not disabled by the time Setka CDN shuts down, the plugin will start producing errors.
As an extra safe step you can manually check that all Setka-realted events were removed by using wp cron event list command. If there are, for some reasons, events still exists you may remove them manually with wp cron event delete EVENT_NAME command.
All Setka-related Cron events have the hook name starting with setka_editor_*.
WARNING: if someone clicks "Manual Sync" or "Change license key" all of the sync functionality will be re-enabled and you will need to disable cron events again after a successful sync.
Checking if your data is preserved
Prerequisites
By this time you should have the necessary assets synced with your WordPress server, public.js stored on your server and cron events disabled.
Checking for assets relying on Setka Editor CDN
Check if your Setka posts use any assets, stored on Setka CDN (Keep in mind that this method will show only assets loaded after the Network tab was opened):
Open the browser's developer tools (CMD+ALT+I on Mac OS or F12 on Windows).
Switch to the Network tab of developer tools.
Filter the list а files by ceditor.setka.io and reload the page.
If files are showing up in the list, they were not saved on your server and continue to load from Setka CDN.
Using information in the guide above, download assets from Setka CDN to your server.
Questions and additional support
If you have technical questions on the documentation above, please contact our support team at support@tiny.cloud with the topic "Preserving Setka Editor content after the service shutdown".
