Skip to content

Commit

Permalink
Merge pull request #10508 from creative-commoners/pulls/5/tinymce6
Browse files Browse the repository at this point in the history 
FIX Update config to support tinymce6
Nice job!
  • Loading branch information
@sabina-talipova
sabina-talipova authored Sep 29, 2022
2 parents 5e16b29 + ef8a02d commit 721b3cb
Show file tree
Hide file tree
Showing 4 changed files with 101 additions and 82 deletions.
133 changes: 91 additions & 42 deletions src/Forms/HTMLEditor/TinyMCEConfig.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,23 @@
class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
{
/**
* Map of locales to tinymce's supported languages
*
* @link https://www.tiny.cloud/get-tiny/language-packages/
* @config
* @var array
*/
private static $tinymce_lang = [
'ar_EG' => 'ar',
'az_AZ' => 'az',
'bg_BG' => 'bg_BG',
'ca_AD' => 'ca',
'ca_ES' => 'ca',
'cs_CZ' => 'cs',
'cy_GB' => 'cy',
'da_DK' => 'da',
'da_GL' => 'da',
'de_AT' => 'de_AT',
'de_AT' => 'de',
'de_BE' => 'de',
'de_CH' => 'de',
'de_DE' => 'de',
Expand Down Expand Up @@ -70,9 +75,12 @@ class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
'es_AD' => 'es',
'es_BZ' => 'es',
'es_US' => 'es',
'fa_AF' => 'fa_IR',
'fa_IR' => 'fa_IR',
'fa_PK' => 'fa_IR',
'et_EE' => 'et',
'eo_XX' => 'eo',
'fa_AF' => 'fa',
'fa_IR' => 'fa',
'fa_PK' => 'fa',
'ff_FI' => 'fi',
'fr_BE' => 'fr_FR',
'fr_BF' => 'fr_FR',
'fr_BI' => 'fr_FR',
Expand Down Expand Up @@ -117,10 +125,14 @@ class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
'fr_GB' => 'fr_FR',
'fr_US' => 'fr_FR',
'he_IL' => 'he_IL',
'hi_IN' => 'hi',
'hr_HR' => 'hr',
'hu_HU' => 'hu_HU',
'hu_AT' => 'hu_HU',
'hu_RO' => 'hu_HU',
'hu_RS' => 'hu_HU',
'id_ID' => 'id',
'is_IS' => 'is_IS',
'it_CH' => 'it',
'it_IT' => 'it',
'it_SM' => 'it',
Expand All @@ -132,23 +144,27 @@ class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
'ko_KP' => 'ko_KR',
'ko_KR' => 'ko_KR',
'ko_CN' => 'ko_KR',
'lt_LT' => 'lt',
'lv_LV' => 'lv',
'nb_NO' => 'nb_NO',
'nb_SJ' => 'nb_NO',
'ne_NP' => 'ne',
'nl_AN' => 'nl',
'nl_AW' => 'nl',
'nl_BE' => 'nl',
'nl_BE' => 'nl_BE',
'nl_NL' => 'nl',
'nl_SR' => 'nl',
'pl_PL' => 'pl',
'pl_UA' => 'pl',
'pt_AO' => 'pt_PT',
// Note: All of the pt_* except pt_BR should map to pt_PT but that translation isn't available for tinymce6 yet.
'pt_AO' => 'pt_BR',
'pt_BR' => 'pt_BR',
'pt_CV' => 'pt_PT',
'pt_GW' => 'pt_PT',
'pt_MZ' => 'pt_PT',
'pt_PT' => 'pt_PT',
'pt_ST' => 'pt_PT',
'pt_TL' => 'pt_PT',
'pt_CV' => 'pt_BR',
'pt_GW' => 'pt_BR',
'pt_MZ' => 'pt_BR',
'pt_PT' => 'pt_BR',
'pt_ST' => 'pt_BR',
'pt_TL' => 'pt_BR',
'ro_MD' => 'ro',
'ro_RO' => 'ro',
'ro_RS' => 'ro',
Expand All @@ -160,24 +176,27 @@ class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
'ru_UA' => 'ru',
'sk_SK' => 'sk',
'sk_RS' => 'sk',
'sl_SI' => 'sl_SI',
'sr_RS' => 'sr',
'sv_FI' => 'sv_SE',
'sv_SE' => 'sv_SE',
'th_TH' => 'th_TH',
'tr_CY' => 'tr',
'tr_TR' => 'tr_TR',
'tr_TR' => 'tr',
'tr_DE' => 'tr',
'tr_MK' => 'tr',
'uk_UA' => 'uk_UA',
'vi_VN' => 'vi_VN',
'vi_US' => 'vi_VN',
'zh_CN' => 'zh_CN',
'zh_HK' => 'zh_CN',
'zh_MO' => 'zh_CN',
'zh_SG' => 'zh_CN',
'zh_TW' => 'zh_TW',
'zh_ID' => 'zh_CN',
'zh_MY' => 'zh_CN',
'zh_TH' => 'zh_CN',
'zh_US' => 'zh_CN',
'uk_UA' => 'uk',
'vi_VN' => 'vi',
'vi_US' => 'vi',
'zh_CN' => 'zh_Hans',
'zh_HK' => 'zh_Hans',
'zh_MO' => 'zh_Hans',
'zh_SG' => 'zh_Hans',
'zh_TW' => 'zh_Hans',
'zh_ID' => 'zh_Hans',
'zh_MY' => 'zh_Hans',
'zh_TH' => 'zh_Hans',
'zh_US' => 'zh_Hans',
];

/**
Expand All @@ -193,6 +212,16 @@ class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
*/
private static $base_dir = null;

/**
* Location of tinymce translation files relative to BASE_DIR.
*
* Supports vendor/module:path
*
* @config
* @var string
*/
private static $lang_dir = null;

/**
* Extra editor.css file paths.
*
Expand Down Expand Up @@ -226,12 +255,12 @@ class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
/**
* TinyMCE JS settings
*
* @link https://www.tinymce.com/docs/configure/
* @link https://www.tiny.cloud/docs/tinymce/6/tinydrive-getting-started/#configure-the-required-tinymce-options
*
* @var array
*/
protected $settings = [
'fix_list_elements' => true, // https://www.tinymce.com/docs/configure/content-filtering/#fix_list_elements
'fix_list_elements' => true, // https://www.tiny.cloud/docs/tinymce/6/content-filtering/#fix_list_elements
'formats' => [
'alignleft' => [
[
Expand Down Expand Up @@ -275,14 +304,16 @@ class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
'browser_spellcheck' => true,
'body_class' => 'typography',
'statusbar' => true,
'elementpath' => true, // https://www.tinymce.com/docs/configure/editor-appearance/#elementpath
'elementpath' => true, // https://www.tiny.cloud/docs/tinymce/6/statusbar-configuration-options/#elementpath
'relative_urls' => true,
'remove_script_host' => true,
'convert_urls' => false, // Prevent site-root images being rewritten to base relative
'menubar' => false,
'language' => 'en',
'branding' => false,
'promotion' => false,
'upload_folder_id' => null, // Set folder ID for insert media dialog
'link_default_target' => '_blank', // https://www.tiny.cloud/docs/tinymce/6/autolink/#example-using-link_default_target
];

/**
Expand All @@ -293,18 +324,21 @@ class TinyMCEConfig extends HTMLEditorConfig implements i18nEntityProvider
protected $plugins = [
'table' => null,
'emoticons' => null,
'paste' => null,
'code' => null,
'importcss' => null,
'lists' => null,
'autolink' => null,
'searchreplace' => null,
'visualblocks' => null,
'wordcount' => null,
];

/**
* Theme name
*
* @var string
*/
protected $theme = 'modern';
protected $theme = 'silver';

/**
* Get the theme
Expand All @@ -331,7 +365,7 @@ public function setTheme($theme)
/**
* Holder list of buttons, organised by line. This array is 1-based indexed array
*
* {@link https://www.tinymce.com/docs/advanced/editor-control-identifiers/#toolbarcontrols}
* {@link https://www.tiny.cloud/docs/tinymce/6/basic-setup/#toolbar-configuration}
*
* @var array
*/
Expand All @@ -342,10 +376,10 @@ public function setTheme($theme)
'bullist', 'numlist', 'outdent', 'indent',
],
2 => [
'formatselect', '|',
'paste', 'pastetext', '|',
'blocks', '|',
'pastetext', '|',
'table', 'sslink', 'unlink', '|',
'code'
'code', 'visualblocks'
],
3 => []
];
Expand Down Expand Up @@ -396,7 +430,7 @@ public function getAttributes()
* the plugin will be loaded by tinymce.PluginManager.load() instead of through tinyMCE.init().
* Keep in mind that these externals plugins require a dash-prefix in their name.
*
* @see http://wiki.moxiecode.com/index.php/TinyMCE:API/tinymce.PluginManager/load
* @see https://www.tiny.cloud/docs/tinymce/6/editor-important-options/#external_plugins
*
* If passing in a non-associative array, the plugin name should be located in the standard tinymce
* plugins folder.
Expand Down Expand Up @@ -619,10 +653,10 @@ protected function getConfig()
{
$settings = $this->getSettings();

// https://www.tinymce.com/docs/configure/url-handling/#document_base_url
// https://www.tiny.cloud/docs/tinymce/6/url-handling/#document_base_url
$settings['document_base_url'] = Director::absoluteBaseURL();

// https://www.tinymce.com/docs/api/class/tinymce.editormanager/#baseURL
// https://www.tiny.cloud/docs/tinymce/6/apis/tinymce.root/#properties
$baseResource = $this->getTinyMCEResource();
if ($baseResource instanceof ModuleResource) {
$tinyMCEBaseURL = $baseResource->getURL();
Expand All @@ -649,12 +683,12 @@ protected function getConfig()
$plugins[$plugin] = $path;
}

// https://www.tinymce.com/docs/configure/integration-and-setup/#external_plugins
// https://www.tiny.cloud/docs/tinymce/6/editor-important-options/#external_plugins
if ($plugins) {
$settings['external_plugins'] = $plugins;
}

// https://www.tinymce.com/docs/configure/editor-appearance/#groupingtoolbarcontrols
// https://www.tiny.cloud/docs/tinymce/6/basic-setup/#toolbar-configuration
$buttons = $this->getButtons();
$settings['toolbar'] = [];
foreach ($buttons as $rowButtons) {
Expand All @@ -666,10 +700,10 @@ protected function getConfig()
}
}

// https://www.tinymce.com/docs/configure/content-appearance/#content_css
// https://www.tiny.cloud/docs/tinymce/6/add-css-options/#content_css
$settings['content_css'] = $this->getEditorCSS();

// https://www.tinymce.com/docs/configure/editor-appearance/#theme_url
// https://www.tiny.cloud/docs/tinymce/6/editor-theme/#theme_url
$theme = $this->getTheme();
if (!Director::is_absolute_url($theme)) {
$theme = Controller::join_links($tinyMCEBaseURL, "themes/{$theme}/theme.min.js");
Expand Down Expand Up @@ -821,6 +855,22 @@ public static function get_tinymce_lang()
return 'en';
}

/**
* Get the URL for the language pack of the current language
*
* @return string Language
*/
public static function get_tinymce_lang_url(): string
{
$lang = static::get_tinymce_lang();
$dir = static::config()->get('lang_dir');
if ($lang !== 'en' && !empty($dir)) {
$resource = ModuleResourceLoader::singleton()->resolveResource($dir);
return Director::absoluteURL($resource->getRelativeResource($lang . '.js')->getURL());
}
return '';
}

/**
* Returns the full filesystem path to TinyMCE resources (which could be different from the original tinymce
* location in the module).
Expand Down Expand Up @@ -893,7 +943,6 @@ protected function getAdminModule()
return ModuleLoader::getModule('silverstripe/admin');
}


/**
* Sets the upload folder name used by the insert media dialog
*
Expand Down
36 changes: 0 additions & 36 deletions src/Forms/HTMLEditor/TinyMCEGZIPGenerator.php
View file

This file was deleted.

2 changes: 1 addition & 1 deletion tests/php/Forms/HTMLEditor/HTMLEditorConfigTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public function testEnablePluginsByArrayWithPaths()
$c = new TinyMCEConfig();
$c->setTheme('modern');
$c->setOption('language', 'es');
$c->disablePlugins('table', 'emoticons', 'paste', 'code', 'link', 'importcss', 'lists');
$c->disablePlugins('table', 'emoticons', 'code', 'link', 'importcss', 'lists', 'autolink', 'searchreplace', 'visualblocks', 'wordcount');
$c->enablePlugins(
[
'plugin1' => 'mypath/plugin1.js',
Expand Down
12 changes: 9 additions & 3 deletions tests/php/Forms/HTMLEditor/TinyMCEConfigTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,20 @@ public function testEditorIdentifier()
*/
public function testLanguagesValid()
{
$configDir = TinyMCEConfig::config()->get('base_dir');
$configDir = TinyMCEConfig::config()->get('lang_dir');
if (!$configDir) {
$this->markTestSkipped("Test skipped without TinyMCE resources folder being installed");
$this->markTestSkipped("Test skipped without TinyMCE language resource folder being installed");
}

$langs = Director::baseFolder() . '/' . ModuleResourceLoader::resourcePath($configDir) . '/langs';
$langs = Director::baseFolder() . '/' . ModuleResourceLoader::resourcePath($configDir);

// Test all langs exist as real files
$checked = [];
foreach (TinyMCEConfig::config()->get('tinymce_lang') as $locale => $resource) {
// No need to check the same file twice.
if (array_key_exists($resource, $checked)) {
continue;
}
// Check valid
$this->assertFileExists(
"{$langs}/{$resource}.js",
Expand All @@ -42,6 +47,7 @@ public function testLanguagesValid()
"Locale code {$locale} doesn't map to simple {$resource}.js when a better {$locale}.js is available"
);
}
$checked[$resource] = true;
}
}

Expand Down

0 comments on commit 721b3cb

Please sign in to comment.