Merge branch '2.4' into 2

DOC Add a warnign about support for translatable

.github/workflows/main.yml

@@ -0,0 +1,14 @@
+name: Build Docs
+on:
+  push:
+    branches:
+      - '2.1'
+    paths:
+      - 'docs/en/userguide/**'
+jobs:
+  build:
+    name: build-docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run build hook
+        run: curl -X POST -d {} https://api.netlify.com/build_hooks/${{ secrets.NETLIFY_BUILD_HOOK }}

.travis.yml

@@ -1,29 +1,26 @@
-# See https://github.com/silverstripe-labs/silverstripe-travis-support for setup details
+# See https://github.com/silverstripe/silverstripe-travis-support for setup details
 
 language: php
 
-php:
-  - 5.3
-
-env:
-  - DB=MYSQL CORE_RELEASE=3
+dist: trusty
 
 matrix:
   include:
-    - php: 5.4
-      env: DB=PGSQL CORE_RELEASE=3
-    - php: 5.5
-      env: DB=MYSQL CORE_RELEASE=3.2
-    - php: 5.6
-      env: DB=MYSQL CORE_RELEASE=3.2
+    - php: '7.1'
+      env: DB=PGSQL CORE_RELEASE=3.7
+    - php: '7.1'
+      env: DB=MYSQL CORE_RELEASE=3.7
+    - php: '7.2'
+      env: DB=MYSQL CORE_RELEASE=3.7
+    - php: '7.3'
+      env: DB=MYSQL CORE_RELEASE=3.7
 
 before_script:
- - pear -q install --onlyreqdeps pear/PHP_CodeSniffer
  - phpenv rehash
- - git clone git://github.com/silverstripe-labs/silverstripe-travis-support.git ~/travis-support
+ - git clone git://github.com/silverstripe/silverstripe-travis-support.git ~/travis-support
  - php ~/travis-support/travis_setup.php --source `pwd` --target ~/builds/ss
  - cd ~/builds/ss
 
 script:
- - vendor/bin/phpunit translatable/tests/
- - phpcs --encoding=utf-8 --tab-width=4 --standard=translatable/tests/phpcs -np translatable
+ - vendor/bin/phpunit translatable/tests
+ - vendor/bin/phpcs --encoding=utf-8 --tab-width=4 --standard=translatable/tests/phpcs -np translatable

README.md

@@ -1,6 +1,13 @@
+# IMPORTANT NOTE
+
+Silverstripe Translatable is only compatible with Silverstripe CMS 3. [Silverstripe CMS 3 has entered limited support in June 2018](https://www.silverstripe.org/blog/update-on-silverstripe-5-x/). This means we'll only be fixing critical bugs and security issues for Silverstripe CMS 3 going forward. This applies to _Translatable_ as well.
+
+[`silverstripe/fluent`](https://github.com/tractorcow-farm/silverstripe-fluent) is the recommended alternative for Silverstripe CMS 4.
+
 # Translatable module for SilverStripe CMS #
 
 [![Build Status](https://secure.travis-ci.org/silverstripe/silverstripe-translatable.png?branch=2.1)](http://travis-ci.org/silverstripe/silverstripe-translatable)
+[![SilverStripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
 
 ## Introduction ##
 
@@ -27,7 +34,7 @@ third party translation interface, transifex.com.
 Newly added strings will be periodically uploaded there for translation,
 and any new translations will be merged back to the project source code.
 
-Please use [https://www.transifex.com/projects/p/silverstripe-translatable/](https://www.transifex.com/projects/p/silverstripe-translatable/) to contribute translations,
+Please use [https://www.transifex.com/silverstripe/silverstripe-translatable/](https://www.transifex.com/projects/p/silverstripe-translatable/) to contribute translations,
 rather than sending pull requests with YAML files.
 
-See the ["i18n" topic](http://doc.silverstripe.org/framework/en/trunk/topics/i18n) on doc.silverstripe.org for more details.
+See the ["i18n" topic](https://docs.silverstripe.org/en/3/developer_guides/i18n/) on doc.silverstripe.org for more details.

code/forms/LanguageDropdownField.php

@@ -21,7 +21,7 @@ class LanguageDropdownField extends GroupedDropdownField {
 	 * @param string $list Indicates the source language list. 
 	 *               Can be either Common-English, Common-Native, Locale-English, Locale-Native
 	 */
-	function __construct($name, $title, $excludeLocales = array(), 
+	public function __construct($name, $title = null, $excludeLocales = array(), 
 		$translatingClass = 'SiteTree', $list = 'Common-English', $instance = null
 	) {
 		$usedLocalesWithTitle = Translatable::get_existing_content_languages($translatingClass);

code/model/Translatable.php

@@ -743,7 +743,12 @@ class Translatable extends DataExtension implements PermissionProvider {
 					if(!$obj || $obj->ObsoleteClassName) continue;
 
 					$obj->Locale = Translatable::default_locale();
-					$obj->writeToStage($stage);
+
+					$oldMode = Versioned::get_reading_mode();
+					Versioned::reading_stage($stage);
+					$obj->writeWithoutVersion();
+					Versioned::set_reading_mode($oldMode);
+
 					$obj->addTranslationGroup($obj->ID);
 					$obj->destroy();
 					unset($obj);
@@ -928,13 +933,7 @@ class Translatable extends DataExtension implements PermissionProvider {
 				// This is to prevent the overhead of writing all translations when
 				// the class didn't actually change.
 				$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
-				$currentStage = Versioned::current_stage();
-				$fresh = Versioned::get_one_by_stage(
-					$baseDataClass,
-					Versioned::current_stage(),
-					'"'.$baseDataClass.'"."ID" = ' . $this->owner->ID,
-					null
-				);
+				$fresh = DataObject::get($baseDataClass)->byId($this->owner->ID);
 				if ($fresh) {
 					$changed = $changedFields['ClassName']['after'] != $fresh->ClassName;
 				}
@@ -1295,20 +1294,16 @@ class Translatable extends DataExtension implements PermissionProvider {
 			// exclude the language of the current owner
 			$filter .= sprintf(' AND "%s"."Locale" != \'%s\'', $baseDataClass, $this->owner->Locale);
 		}
-		$currentStage = Versioned::current_stage();
 		$joinOnClause = sprintf('"%s_translationgroups"."OriginalID" = "%s"."ID"', $baseDataClass, $baseDataClass);
-		if($this->owner->hasExtension("Versioned")) {
-			if($stage) Versioned::reading_stage($stage);
+		if($this->owner->hasExtension("Versioned") && $stage) {
 			$translations = Versioned::get_by_stage(
 				$baseDataClass,
-				Versioned::current_stage(), 
+				$stage,
 				$filter, 
 				null
 			)->leftJoin("{$baseDataClass}_translationgroups", $joinOnClause);
-			if($stage) Versioned::reading_stage($currentStage);
 		} else {
-			$class = $this->owner->class;
-			$translations = $baseDataClass::get()
+			$translations = DataObject::get($baseDataClass)
 				->where($filter)
 				->leftJoin("{$baseDataClass}_translationgroups", $joinOnClause);
 		}
@@ -1478,6 +1473,11 @@ class Translatable extends DataExtension implements PermissionProvider {
 			$urlSegment = $newTranslation->URLSegment;
 		}
 
+		if (URLSegmentFilter::singleton()->getAllowMultibyte()) {
+			// Decode the URL segment, it will be re-encoded again on write
+			$urlSegment = rawurldecode($urlSegment);
+		}
+
 		// Only make segment unique if it should be enforced
 		if(Config::inst()->get('Translatable', 'enforce_global_unique_urls')) {
 			$newTranslation->URLSegment = $urlSegment . '-' . i18n::convert_rfc1766($locale);	
@@ -1586,6 +1586,22 @@ class Translatable extends DataExtension implements PermissionProvider {
 				);
 			}
 		}
+		else {
+			// Added to comply with current Google recommendations
+			// If no translations found for this page, add a self referencing hreflang tag so Google does not complain
+			// Language and Local tag
+			$tags .= sprintf($template,
+				Convert::raw2xml($this->owner->Title),
+				i18n::convert_rfc1766($this->owner->Locale),
+				$this->owner->AbsoluteLink()
+			);
+			// Language only tag
+			$tags .= sprintf($template,
+				Convert::raw2xml($this->owner->Title),
+				i18n::get_lang_from_locale($this->owner->Locale),
+				$this->owner->AbsoluteLink()
+			);
+		}
 	}
 	
 	function providePermissions() {

composer.json

@@ -1,44 +1,39 @@
 {
-	"name": "silverstripe/translatable",
-	"type": "silverstripe-module",
-	"description": "Allows translation of DataObject and SiteTree records into multiple languages ",
-	"keywords": [
-		"silverstripe",
-		"cms",
-		"i18n",
-		"localization",
-		"globalization"
-	],
-	"license": "BSD-3-Clause",
-	"homepage": "https://github.com/silverstripe/silverstripe-translatable/",
-	"authors": [
-		{
-			"name": "Ingo Schommer",
-			"homepage": "http://chillu.com",
-			"email": "ingo@silverstripe.com"
-		}
-	],
-	"require": {
-		"php": ">=5.3.2",
-		"silverstripe/framework": "~3.2",
-		"silverstripe/cms": "~3.2"
-	},
-	"require-dev": {
-		"silverstripe/postgresql": "*",
-		"silverstripe/sqlite3": "*",
-		"silverstripe/mssql": "*",
-		"phpunit/PHPUnit": "~3.7@stable"
-	},
-	"extra": {
-		"screenshots": [
-			"http://www.silverstripe.org/assets/Uploads/translatable4-small.png"
-		],
-		"branch-alias": {
-			"2.x-dev": "2.2.x-dev"
-		}
-	},
-	"support": {
-		"issues": "https://github.com/silverstripe/silverstripe-translatable/issues?state=open"
-	},
-	"minimum-stability": "dev"
+    "name": "silverstripe/translatable",
+    "type": "silverstripe-module",
+    "description": "Allows translation of DataObject and SiteTree records into multiple languages ",
+    "keywords": [
+        "silverstripe",
+        "cms",
+        "i18n",
+        "localization",
+        "globalization"
+    ],
+    "license": "BSD-3-Clause",
+    "homepage": "https://github.com/silverstripe/silverstripe-translatable/",
+    "authors": [
+        {
+            "name": "Ingo Schommer",
+            "homepage": "http://chillu.com",
+            "email": "ingo@silverstripe.com"
+        }
+    ],
+    "require": {
+        "php": ">=5.3.2",
+        "silverstripe/framework": "~3.2",
+        "silverstripe/cms": "~3.2"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5.7",
+        "squizlabs/php_codesniffer": "^3.0"
+    },
+    "extra": {
+        "screenshots": [
+            "http://www.silverstripe.org/assets/Uploads/translatable4-small.png"
+        ]
+    },
+    "support": {
+        "issues": "https://github.com/silverstripe/silverstripe-translatable/issues?state=open"
+    },
+    "minimum-stability": "dev"
 }

docs/en/userguide/about-translatable.md

@@ -2,11 +2,11 @@
 
 The SilverStripe Translatable module allows you to create and edit multiple pages in various languages. This module also adds the ability for your users to select which language of a page they wish to view.
 
-<div class="note" markdown="1">
+[note]
 Notes:
 
 The SilverStripe Translatable module does not translate content automatically, content authors will need to enter the translated content manually for each translated page.
-</div>
+[/note]
 
 To begin translating content select a page in your site tree from the "Pages" admin. You can see in the below image:
 

docs/en/userguide/index.md

@@ -1,5 +1,7 @@
+---
 title: Working with translations
 summary: Adding translated content to your website.
+---
 
 # Working with translations
 

lang/ar.yml

@@ -16,7 +16,7 @@ ar:
     TRANSLATEALLPERMISSION: 'ترجم إلى جميع اللغات المتاحة'
     TRANSLATEPERMISSION: 'ترجم %s'
     TRANSLATEVIEWLANGS: 'أعرض قائمة اللغات'
-    TRANSLATIONS: تراجم
+    TRANSLATIONS: 'تراجم'
   Translatable_Transform:
     OriginalCheckboxLabel: 'الأصلية: {قيمة}'
     OriginalFieldLabel: 'الأصلي {عنوان}'

lang/fa_IR.yml

@@ -16,7 +16,7 @@ fa_IR:
     TRANSLATEALLPERMISSION: 'ترجمه به تمام زبان های موجود'
     TRANSLATEPERMISSION: 'ترجمه %s'
     TRANSLATEVIEWLANGS: 'نمایش منوی زبان'
-    TRANSLATIONS: ترجمه
+    TRANSLATIONS: 'ترجمه'
   Translatable_Transform:
     CheckboxValueNo: خیر
     CheckboxValueYes: بله

lang/ja.yml

@@ -7,13 +7,13 @@ ja:
     LANGAOTHER: 他の言語
     LANGAVAIL: 利用可能な言語
   Translatable:
-    ALLCREATED: 許可された翻訳全てが作成されました。
+    ALLCREATED: '許可された翻訳全てが作成されました。'
     CREATE: 新しい翻訳を行う
     CREATEBUTTON: 作成
     EXISTING: 現存中の翻訳
     NEWLANGUAGE: 新しい言語
-    NOTICENEWPAGE: 翻訳を作成する前にこのページを保存してください
-    TRANSLATEALLPERMISSION: 全ての利用可能言語に翻訳
+    NOTICENEWPAGE: '翻訳を作成する前にこのページを保存してください'
+    TRANSLATEALLPERMISSION: '全ての利用可能言語に翻訳'
     TRANSLATEPERMISSION: '%sを翻訳'
     TRANSLATEVIEWLANGS: 言語ドロップダウンを表示
     TRANSLATIONS: 翻訳

lang/sv.yml

@@ -18,5 +18,7 @@ sv:
     TRANSLATEVIEWLANGS: 'Visa språk listan'
     TRANSLATIONS: Översättningar
   Translatable_Transform:
+    CheckboxValueNo: Nej
+    CheckboxValueYes: Ja
     OriginalCheckboxLabel: 'Original: {value}'
     OriginalFieldLabel: 'Original {title}'

lang/zh.yml

@@ -4,15 +4,15 @@ zh:
   CMSMain_left:
     GO: 前往
   Form:
-    LANGAOTHER: 其它语言
+    LANGAOTHER: '其它语言'
     LANGAVAIL: 可用的语言
   Translatable:
-    ALLCREATED: 所有允许的翻译均已创建。
+    ALLCREATED: '所有允许的翻译均已创建。'
     CREATE: 创建新的翻译
     CREATEBUTTON: 创建
     EXISTING: 现存的翻译
     NEWLANGUAGE: 新语言
-    NOTICENEWPAGE: 创建翻译前，请先保存本页面。
+    NOTICENEWPAGE: '创建翻译前，请先保存本页面。'
     TRANSLATEALLPERMISSION: 翻译成所有可用语言
     TRANSLATEPERMISSION: '翻译 %s'
     TRANSLATEVIEWLANGS: 查看语言下拉菜单

tests/unit/TranslatableSiteConfigTest.php

@@ -22,6 +22,9 @@ class TranslatableSiteConfigTest extends SapphireTest {
 				
 		$this->origLocale = Translatable::default_locale();
 		Translatable::set_default_locale("en_US");
+
+		// Delete any default records created outside of fixtures
+		SiteConfig::get()->exclude('ID', $this->allFixtureIDs('SiteConfig'))->removeAll();
 	}
 	
 	function tearDown() {

tests/unit/TranslatableTest.php

@@ -459,7 +459,32 @@ class TranslatableTest extends FunctionalTest {
 		Config::inst()->update('Translatable', 'enforce_global_unique_urls', true);
 		Translatable::set_current_locale('en_US');
 	}
-	
+
+	public function testMultibyteUrlsWorkWhenTranslated()
+	{
+		Config::inst()->update('URLSegmentFilter', 'default_allow_multibyte', true);
+
+		$page = new Page();
+		$page->URLSegment = 'schön-döner';
+		$page->Content = 'Kebabs in Berlin are amazing.';
+		$page->write();
+		$page->doPublish();
+
+		$translatedPage = $page->createTranslation('de_DE');
+		$translatedPage->Content = 'Döner in Berlin sind unglaublich';
+		$translatedPage->doPublish();
+		$this->assertSame('schön-döner-de-de', rawurldecode($translatedPage->URLSegment));
+
+		// Test pinging the page on the frontend
+		$pageResult = $this->get('schön-döner');
+		$this->assertEquals(200, $pageResult->getStatusCode());
+		$this->assertContains('Kebabs in Berlin', (string) $pageResult->getBody());
+
+		$translatedPageResult = $this->get('schön-döner-de-de');
+		$this->assertEquals(200, $translatedPageResult->getStatusCode());
+		$this->assertContains('Döner in Berlin', (string) $translatedPageResult->getBody());
+	}
+
 	function testUpdateCMSFieldsOnSiteTree() {
 		$pageOrigLang = new TranslatableTest_Page();
 		$pageOrigLang->write();