ck.sh

#!/bin/bash

set -e

function usage() {
	echo
	echo "Usage: ck.sh COMMAND [OPTIONS]"
	echo
	echo "  Where COMMAND is either:"
	echo
	echo "  🔧 setup: prepare your local clone for patching, building or updating"
	echo "  💉 patch: recreate \"patches/\" contents based on current \"liferay\" branch"
	echo "  🔥 build: build CKEditor, writing output to the \"ckeditor/\" directory"
	echo "  🌶  update: update the CKEditor base version"
	echo "  🎭  createskin: create a new custom skin based on moono-lisa"
	echo
	echo
}

function downloadPlugin() {
	local NAME=$1
	local VERSION=$2
	local DESTINATION=$3
	local OUTPUT
	OUTPUT=$(mktemp -d)
	local ZIPPED_PLUGIN
	ZIPPED_PLUGIN="${NAME}_${VERSION}.zip"

	curl \
		"https://ckeditor.com/cke4/sites/default/files/${NAME}/releases/${NAME}_${VERSION}.zip" \
		-o "${OUTPUT}/${ZIPPED_PLUGIN}"

	unzip "${OUTPUT}/${ZIPPED_PLUGIN}" -d "${OUTPUT}/${NAME}"
	cp -r "${OUTPUT}/${NAME}/${NAME}/"* "${DESTINATION}"
}

# Check arguments
if [ $# -ne 1 ]; then
	usage
	exit 1
fi

trap "echo \"\n\nAborting.\n\"; exit" SIGHUP SIGINT SIGTERM

COMMAND=$1

case "$COMMAND" in
	build)
		echo
		echo "⚠️  WARNING"
		echo

		echo "This will generate a patched version of CKEditor"
		
		if [ -z "$CI" ]; then
			read -r -p "Are you sure you want to continue? [y/n] " yn
		else
			yn=y
		fi

		case $yn in
			[Yy]*)
				# Store the CKEDITOR version to download the corresponding extra plugins
				cd ckeditor-dev
				VERSION=$(git describe --tags --abbrev=0)
				cd ..

				# Clean and make a temporary copy of ckeditor-dev to work with
				rm -rf temp
				cp -r ckeditor-dev temp

				# Copy custom skins
				cp -r skins temp

				# Copy custom plugins
				cp -r plugins temp

				cd temp

				# Copy plugin dependencies
				pluginsWithDeps=$(find plugins -maxdepth 2 -mindepth 2 -type f -name deps.json)
				for pluginDepsFile in $pluginsWithDeps ; do
					pluginDir=$(dirname "$pluginDepsFile")

					node ../support/copyPluginDependencies.js $pluginDir
				done

				# Download extra plugins for current version
				echo
				echo "Downloading plugins for v$VERSION"
				echo

				downloadPlugin scayt "$VERSION" plugins/scayt

				# Copy lang files from image plugin to imagespacingbox
				cp -r plugins/image/lang plugins/imagespacingbox

				# Generate SVG icons CSS Classes in custom skins
				skinsWithIcons=$(find skins -maxdepth 2 -mindepth 2 -type f -name icons.json)
				for iconsFile in $skinsWithIcons ; do
					skinDir=$(dirname "$iconsFile")

					node ../support/iconsClassesGenerator.js $iconsFile $skinDir/icons.css
				done

				# Build ckeditor
				if [ -n "$DEBUG" ]; then
					dev/builder/build.sh --build-config ../../../support/build-config.js \
						--leave-css-unminified --leave-js-unminified --no-ie-checks
				else
					dev/builder/build.sh --build-config ../../../support/build-config.js \
						--no-ie-checks
				fi

				# Remove old build files.
				rm -rf ../ckeditor/*

				# Replace with new build files.
				cp -r dev/builder/release/ckeditor/* ../ckeditor/

				cd ..

				# Remove temporary directory
				rm -rf temp

				if [ -n "$DEBUG" ]; then
					echo
					echo "✅ DONE"
					echo
					echo "⚠️  WARNING"
					echo
					echo "Updated build artifacts have NOT been committed, because this is a DEBUG build."
					echo
				else
					if [ -z "$CI" ]; then
						git add ckeditor

						git commit -m 'chore: update ckeditor build artifacts' \
							-m 'This commit autogenerated with "./ck.sh".'
					fi

					echo
					echo "✅ DONE"
					echo

					if [ -z "$CI" ]; then
						echo "Updated build artifacts have been committed."
						echo
						echo "Please review them with \`git show\`"
						echo
					fi
				fi
				;;
			*)
				echo
				echo "Aborting."
				echo
				exit
		esac
		;;

	createskin)
		read -r -p "What is the name of the new skin? " skinName

		baseSkin="moono-lisa"

		# Create folder for the new skin
		mkdir skins/"$skinName"

		# Create a copy of the selected skin.
		cp -r ckeditor-dev/skins/"$baseSkin"/* skins/"$skinName"/

		# Replace name of the base skin with new one
		sed -i -e "s/$baseSkin/$skinName/g" skins/"$skinName"/skin.js
		sed -i -e "s/$baseSkin/$skinName/g" skins/"$skinName"/dialog.css
		sed -i -e "s/$baseSkin/$skinName/g" skins/"$skinName"/readme.md
		sed -i -e "s/$baseSkin/$skinName/g" skins/"$skinName"/dev/locations.json

		git add skins/"$skinName"
		;;

	patch)
		# Make sure submodule is registered and up-to-date.
		git submodule update --init

		cd ckeditor-dev

		if ! git rev-parse --verify liferay &>/dev/null; then
			echo
			echo "❌ ERROR"
			echo
			echo "It seems that there's no 'liferay' branch in the 'ckeditor-dev' submodule."
			echo
			echo "Please run './ck.sh setup' to set up everything correctly."
			echo
			exit 1
		fi

		cd ..

		# Save SHA1 for later
		sha1=$(git submodule status --cached -- ckeditor-dev | awk '{print $1}' | sed -e s/[^0-9a-f]//)

		cd ckeditor-dev

		git checkout liferay --quiet

		# Check for existing patches
		if ! ls ../patches/*.patch &>/dev/null ; then
			echo
			echo "No patches found."
			echo
		else
			echo
			echo "⚠️  WARNING"
			echo
			echo "This will reset the \"patches\" directory and replace these patches:"
			echo
			find ../patches -name '*.patch'
			echo
			echo "with patches corresponding to these commits:"
			echo
			git log --oneline "$sha1"..HEAD
			echo

			# Prompt the user to confirm he wants to delete existing patches
			read -r -p "Are you sure you want to continue? [y/n] " yn
			case $yn in
				[Yy]*)
					echo
					echo "Removing existing patches."
					echo

					mkdir -p ../patches
					rm -rf ../patches/*
					;;
				*)
					echo
					echo "Aborting."
					echo
					exit
					;;
			esac
		fi

		echo "Generating patches."
		echo

		git format-patch --diff-algorithm=histogram --no-numbered --no-signature "$sha1" -o ../patches

		echo
		echo "✅ DONE"
		echo
		echo "You can now build CKEditor with your patches."
		echo
		echo "Here are the steps to follow:"
		echo
		echo "1. Run './ck.sh build' to generate a patched version."
		echo
		;;

	setup)
		echo
		echo "⚠️  WARNING"
		echo
		echo "❗ This will reset any changes you currently have in the 'ckeditor-dev' submodule"
		echo
		echo
		read -r -p "Are you sure you want to continue? [y/n] " yn
		case $yn in
			[Yy]*)
				yarn

				# Make sure submodule is registered and up-to-date.
				git submodule update --init

				# Fetch remote changes.
				cd ckeditor-dev

				# Make sure our working copy is clean.
				git reset --hard HEAD --quiet
				git clean -fdx
				git checkout --detach HEAD --quiet
				git branch -f liferay HEAD
				git checkout liferay --quiet

				VERSION=$(git describe --tags --abbrev=0)

				echo
				echo "Checking for existing patches"
				echo

				if ! ls ../patches/*.patch; then
					echo "There doesn't seem to be any patch"
				else
					echo
					echo "Applying patches from \"patches/\" directory."
					echo

					if ! git am ../patches/*; then
						echo
						echo "❌ There was a problem applying patches:"
						echo
						echo "To retry manually and fix:"
						echo
						echo "  cd ckeditor-dev"
						echo "  git am --abort"
						echo "  git am ../patches/*"
						echo
						echo "Once you are happy with the result, run './ck.sh patch' to update the contents of \"patches/\"."
						echo
						exit 1
					fi
				fi

				echo
				echo "✅ DONE"
				echo
				echo
				echo "You can now start working on your patch(es)."
				echo
				echo
				echo "Here are the steps to follow:"
				echo
				echo "1. Navigate to the ckeditor-dev submodule directory (\`cd ckeditor-dev\`)"
				echo "2. Work on your changes"
				echo "3. Commit your changes"
				echo "4. Return to the repository root (\`cd ..\`)"
				echo "5. Run './ck.sh patch' to generate updated patches"
				echo
				;;
			*)
				echo
				echo "Aborting."
				echo
				exit
				;;
		esac
		;;

	update)
		git submodule update --init
		cd ckeditor-dev
		git fetch

		echo
		echo "Listing current tags: "

		tags=$(git tag -l --sort=creatordate | grep -v ee- | grep -v liferay | \
			sort -t. -k 1,1nr -k 2,2nr -k 3,3nr -k 4,4nr | head -6)

		echo "$tags"
		echo

		read -r -p "Please enter the tag you want to update to: " tag

		if ! git describe --exact-match --tags "$tag" &>/dev/null ; then
			echo
			echo "❌ ERROR"
			echo
			echo "Sorry, the \`$tag\` tag does not exist."
			echo
			exit 1
		fi


		echo
		echo "⚠️  WARNING"
		echo
		echo "This will update the \`ckeditor-dev\` submodule to point to the $tag tag"
		echo

		read -r -p "Are you sure you want to continue? [y/n] " yn
		case $yn in
			[Yy]*)
				git reset --hard HEAD
				git clean -fdx
				git checkout "$tag"

				commitmsg=$(git log -1 --pretty=format:"chore: update ckeditor-dev to $tag%n%n%h (tag: $tag) %s")

				cd ..
				git add -f ckeditor-dev
				git commit -m "$commitmsg"

				echo "Do you want to rebase the updated ckeditor submodule with the liferay branch?"
				echo
				echo "⚠️  WARNING"
				echo
				echo "This might cause conflicts, which will have to be solved manually"
				echo

				read -r -p "Are you sure you want to continue? [y/n] " yn
				case $yn in
					[Yy]*)
						cd ckeditor-dev

						git rebase HEAD liferay

						echo
						echo "✅ DONE"
						echo
						;;
					*)
						echo
						echo "Aborting."
						echo
						exit
						;;
				esac
				;;
			*)
				echo
				echo "Aborting."
				echo
				exit
				;;
		esac
		;;

	*)
		usage
		;;

esac