From 1479120734f82888793fb27f7fa58a9b9f8a0480 Mon Sep 17 00:00:00 2001
From: Matthias Schmidt <gravatronics@live.com>
Date: Sun, 9 Sep 2018 15:12:14 +0200
Subject: [PATCH] Add GUI support for smiley package installation plugin

See #2545
---
 .../SmileyPackageInstallationPlugin.class.php | 228 +++++++++++++++++-
 wcfsetup/install/lang/en.xml                  |  13 +
 2 files changed, 238 insertions(+), 3 deletions(-)

diff --git a/wcfsetup/install/files/lib/system/package/plugin/SmileyPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/SmileyPackageInstallationPlugin.class.php
index d51a5e2105..f9bd5e8c46 100644
--- a/wcfsetup/install/files/lib/system/package/plugin/SmileyPackageInstallationPlugin.class.php
+++ b/wcfsetup/install/files/lib/system/package/plugin/SmileyPackageInstallationPlugin.class.php
@@ -1,18 +1,31 @@
 <?php
 namespace wcf\system\package\plugin;
 use wcf\data\smiley\SmileyEditor;
-use wcf\system\devtools\pip\IIdempotentPackageInstallationPlugin;
+use wcf\data\smiley\SmileyList;
+use wcf\system\devtools\pip\IDevtoolsPipEntryList;
+use wcf\system\devtools\pip\IGuiPackageInstallationPlugin;
+use wcf\system\devtools\pip\TXmlGuiPackageInstallationPlugin;
+use wcf\system\form\builder\field\IntegerFormField;
+use wcf\system\form\builder\field\ItemListFormField;
+use wcf\system\form\builder\field\TextFormField;
+use wcf\system\form\builder\field\TitleFormField;
+use wcf\system\form\builder\field\validation\FormFieldValidationError;
+use wcf\system\form\builder\field\validation\FormFieldValidator;
+use wcf\system\form\builder\IFormDocument;
 use wcf\system\WCF;
+use wcf\util\StringUtil;
 
 /**
  * Installs, updates and deletes smilies.
  * 
- * @author	Marcel Werk
+ * @author	Matthias Schmidt, Marcel Werk
  * @copyright	2001-2018 WoltLab GmbH
  * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package	WoltLabSuite\Core\Acp\Package\Plugin
  */
-class SmileyPackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin implements IIdempotentPackageInstallationPlugin {
+class SmileyPackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin implements IGuiPackageInstallationPlugin {
+	use TXmlGuiPackageInstallationPlugin;
+	
 	/**
 	 * @inheritDoc
 	 */
@@ -81,8 +94,217 @@ class SmileyPackageInstallationPlugin extends AbstractXMLPackageInstallationPlug
 	
 	/**
 	 * @inheritDoc
+	 * @since	3.1
 	 */
 	public static function getSyncDependencies() {
 		return [];
 	}
+	
+	/**
+	 * @inheritDoc
+	 * @since	3.2
+	 */
+	public function addFormFields(IFormDocument $form) {
+		/** @var FormContainer $dataContainer */
+		$dataContainer = $form->getNodeById('data');
+		
+		$fileValidator = new FormFieldValidator('fileExists', function(TextFormField $formField) {
+			if (!file_exists(WCF_DIR . $formField->getValue())) {
+				$formField->addValidationError(
+					new FormFieldValidationError(
+						'fileDoesNotExist',
+						'wcf.acp.pip.smiley.smileyPath.error.fileDoesNotExist'
+					)
+				);
+			}
+		});
+		
+		$smileyList = new SmileyList();
+		$smileyList->readObjects();
+		
+		$smileyCodes = [];
+		foreach ($smileyList as $smiley) {
+			$smileyCodes[] = $smiley->smileyCode;
+			$smileyCodes = array_merge($smileyCodes, $smiley->getAliases());
+		}
+		
+		// add fields
+		$dataContainer->appendChildren([
+			TextFormField::create('smileyCode')
+				->objectProperty('name')
+				->label('wcf.acp.pip.smiley.smileyCode')
+				->description('wcf.acp.pip.smiley.smileyCode.description')
+				->required()
+				->maximumLength(255)
+				->addValidator(new FormFieldValidator('uniqueness', function(TextFormField $formField) use ($smileyCodes) {
+					if (
+						$formField->getDocument()->getFormMode() === IFormDocument::FORM_MODE_CREATE ||
+						$this->editedEntry->getAttribute('name') !== $formField->getSaveValue()
+					) {
+						if (in_array($formField->getValue(), $smileyCodes)) {
+							$formField->addValidationError(
+								new FormFieldValidationError(
+									'notUnique',
+									'wcf.acp.pip.smiley.smileyCode.error.notUnique'
+								)
+							);
+						}
+					}
+				})),
+			
+			TitleFormField::create('smileyTitle')
+				->objectProperty('title')
+				->required()
+				->maximumLength(255),
+			
+			ItemListFormField::create('aliases')
+				->label('wcf.acp.pip.smiley.aliases')
+				->description('wcf.acp.pip.smiley.aliases.description')
+				->saveValueType(ItemListFormField::SAVE_VALUE_TYPE_NSV)
+				->addValidator(new FormFieldValidator('uniqueness', function(ItemListFormField $formField) use ($smileyCodes) {
+					if (empty($formField->getValue())) {
+						return;
+					}
+					
+					if (
+						$formField->getDocument()->getFormMode() === IFormDocument::FORM_MODE_CREATE ||
+						$this->editedEntry->getAttribute('aliases') !== $formField->getSaveValue()
+					) {
+						$notUniqueCodes = [];
+						foreach ($formField->getValue() as $alias) {
+							if (in_array($alias, $smileyCodes)) {
+								$notUniqueCodes[] = $alias;
+							}
+						}
+						
+						if (!empty($notUniqueCodes)) {
+							$formField->addValidationError(
+								new FormFieldValidationError(
+									'notUnique',
+									'wcf.acp.pip.smiley.aliases.error.notUnique',
+									['notUniqueCodes' => $notUniqueCodes]
+								)
+							);
+						}
+					}
+				})),
+			
+			IntegerFormField::create('showOrder')
+				->objectProperty('showorder')
+				->label('wcf.acp.pip.smiley.showOrder')
+				->description('wcf.acp.pip.smiley.showOrder.description')
+				->nullable(),
+			
+			TextFormField::create('smileyPath')
+				->objectProperty('path')
+				->label('wcf.acp.pip.smiley.smileyPath')
+				->description('wcf.acp.pip.smiley.smileyPath.description')
+				->required()
+				->maximumLength(255)
+				->addValidator($fileValidator),
+			
+			TextFormField::create('smileyPath2x')
+				->objectProperty('path2x')
+				->label('wcf.acp.pip.smiley.smileyPath2x')
+				->description('wcf.acp.pip.smiley.smileyPath2x.description')
+				->maximumLength(255)
+				->addValidator($fileValidator)
+		]);
+	}
+	
+	/**
+	 * @inheritDoc
+	 * @since	3.2
+	 */
+	protected function getElementData(\DOMElement $element, $saveData = false) {
+		$data = [
+			'packageID' => $this->installation->getPackage()->packageID,
+			'smileyCode' => $element->getAttribute('name'),
+			'smileyPath' => $element->getElementsByTagName('path')->item(0)->nodeValue,
+			'smileyTitle' => $element->getElementsByTagName('title')->item(0)->nodeValue
+		];
+		
+		$optionalElements = [
+			'aliases' => 'aliases',
+			'smileyPath2x' => 'path2x',
+			'showOrder' => 'showOrder'
+		];
+		foreach ($optionalElements as $arrayKey => $elementName) {
+			$child = $element->getElementsByTagName($elementName)->item(0);
+			if ($child !== null) {
+				$data[$arrayKey] = $child->nodeValue;
+			}
+		}
+		
+		return $data;
+	}
+	
+	/**
+	 * @inheritDoc
+	 * @since	3.2
+	 */
+	public function getElementIdentifier(\DOMElement $element) {
+		return $element->getAttribute('name');
+	}
+	
+	/**
+	 * @inheritDoc
+	 * @since	3.2
+	 */
+	protected function setEntryListKeys(IDevtoolsPipEntryList $entryList) {
+		$entryList->setKeys([
+			'smileyCode' => 'wcf.acp.pip.smiley.smileyCode',
+			'smileyTitle' => 'wcf.global.title'
+		]);
+	}
+	
+	/**
+	 * @inheritDoc
+	 * @since	3.2
+	 */
+	protected function sortDocument(\DOMDocument $document) {
+		$this->sortImportDelete($document);
+		
+		$compareFunction = static::getSortFunction([
+			'showOrder',
+			[
+				'isAttribute' => 1,
+				'name' => 'name'
+			]
+		]);
+		
+		$this->sortChildNodes($document->getElementsByTagName('import'), $compareFunction);
+		$this->sortChildNodes($document->getElementsByTagName('delete'), $compareFunction);
+	}
+	
+	/**
+	 * @inheritDoc
+	 * @since	3.2
+	 */
+	protected function writeEntry(\DOMDocument $document, IFormDocument $form) {
+		$data = $form->getData()['data'];
+		
+		$bbcode = $document->createElement($this->tagName);
+		$bbcode->setAttribute('name', $data['name']);
+		
+		foreach (['title', 'path', 'path2x'] as $element) {
+			$bbcode->appendChild($document->createElement($element, $data[$element]));
+		}
+		
+		if ($data['aliases'] !== '') {
+			$aliases = $document->createElement('aliases');
+			$aliases->appendChild($document->createCDATASection(
+				StringUtil::escapeCDATA(StringUtil::unifyNewlines($data['aliases']))
+			));
+			$bbcode->appendChild($aliases);
+		}
+		
+		if ($data['showorder'] !== null) {
+			$bbcode->appendChild($document->createElement('showorder', $data['showorder']));
+		}
+		
+		$document->getElementsByTagName('import')->item(0)->appendChild($bbcode);
+		
+		return $bbcode;
+	}
 }
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
index ea0f4997c1..f84600a3d9 100644
--- a/wcfsetup/install/lang/en.xml
+++ b/wcfsetup/install/lang/en.xml
@@ -2170,6 +2170,19 @@ If you have <strong>already bought the licenses for the listed apps</strong>, th
 		<item name="wcf.acp.pip.bbcode.iconPath.description"><![CDATA[The entered path has to be relative to <code>{'WCF_DIR'|constant}icon/</code>.]]></item>
 		<item name="wcf.acp.pip.bbcode.iconPath.error.fileDoesNotExist"><![CDATA[The entered file does not exist.]]></item>
 		<item name="wcf.acp.pip.bbcode.wysiwygIcon"><![CDATA[Icon]]></item>
+		<item name="wcf.acp.pip.smiley.smileyCode"><![CDATA[Primary Smiley Code]]></item>
+		<item name="wcf.acp.pip.smiley.smileyCode.description"><![CDATA[Primary code that is converted into this smiley.]]></item>
+		<item name="wcf.acp.pip.smiley.smileyCode.error.notUnique"><![CDATA[The entered identifier is already used by another smiley.]]></item>
+		<item name="wcf.acp.pip.smiley.aliases"><![CDATA[Secondary Smiley Codes]]></item>
+		<item name="wcf.acp.pip.smiley.aliases.description"><![CDATA[Secondary codes that are converted into this smiley.]]></item>
+		<item name="wcf.acp.pip.smiley.aliases.error.notUnique"><![CDATA[The following aliases are already used by another smiley: {implode from=$notUniqueCodes item=notUniqueCode}<code>{$notUniqueCode}</code>{/implode}.]]></item>
+		<item name="wcf.acp.pip.smiley.showOrder"><![CDATA[Display Order]]></item>
+		<item name="wcf.acp.pip.smiley.showOrder.description"><![CDATA[The entered value determines in which order the smiley are shown.]]></item>
+		<item name="wcf.acp.pip.smiley.smileyPath"><![CDATA[Smiley Path]]></item>
+		<item name="wcf.acp.pip.smiley.smileyPath.description"><![CDATA[The entered path has to be relative to <code>{'WCF_DIR'|constant}</code>.]]></item>
+		<item name="wcf.acp.pip.smiley.smileyPath.error.fileDoesNotExist"><![CDATA[The entered file does not exist.]]></item>
+		<item name="wcf.acp.pip.smiley.smileyPath2x"><![CDATA[HD Smiley Path]]></item>
+		<item name="wcf.acp.pip.smiley.smileyPath2x.description"><![CDATA[The entered path has to be relative to <code>{'WCF_DIR'|constant}</code>.]]></item>
 	</category>
 	
 	<category name="wcf.acp.reactionType">
-- 
2.20.1