<?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
*/
/**
* @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;
+ }
}
projects / GitHub / WoltLab / WCF.git / commitdiff