From 222a51e9912094b7d6030a07cf223a1ba10da32f Mon Sep 17 00:00:00 2001
From: Matthias Schmidt <gravatronics@live.com>
Date: Sun, 8 Apr 2018 11:50:13 +0200
Subject: [PATCH] Add API to save added/edited PIP entries via GUI in database

See #2545
---
 ...TXmlGuiPackageInstallationPlugin.class.php | 48 +++++++++++++++++--
 1 file changed, 44 insertions(+), 4 deletions(-)

diff --git a/wcfsetup/install/files/lib/system/devtools/pip/TXmlGuiPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/devtools/pip/TXmlGuiPackageInstallationPlugin.class.php
index cde3709774..ade5ffe3c8 100644
--- a/wcfsetup/install/files/lib/system/devtools/pip/TXmlGuiPackageInstallationPlugin.class.php
+++ b/wcfsetup/install/files/lib/system/devtools/pip/TXmlGuiPackageInstallationPlugin.class.php
@@ -4,6 +4,7 @@ namespace wcf\system\devtools\pip;
 use wcf\data\devtools\project\DevtoolsProject;
 use wcf\system\form\builder\field\IFormField;
 use wcf\system\form\builder\IFormDocument;
+use wcf\system\WCF;
 use wcf\util\DOMUtil;
 use wcf\util\StringUtil;
 use wcf\util\XML;
@@ -36,7 +37,7 @@ trait TXmlGuiPackageInstallationPlugin {
 		$xml = $this->getProjectXml();
 		$document = $xml->getDocument();
 		
-		$this->writeEntry($document, $form);
+		$newElement = $this->writeEntry($document, $form);
 		$this->sortDocument($document);
 		
 		/** @var DevtoolsProject $project */
@@ -45,6 +46,8 @@ trait TXmlGuiPackageInstallationPlugin {
 		// TODO: while creating/testing the gui, write into a temporary file
 		// $xml->write($this->getXmlFileLocation($project));
 		$xml->write($project->path . ($project->getPackage()->package === 'com.woltlab.wcf' ? 'com.woltlab.wcf/' : '') . 'tmp_' . static::getDefaultFilename());
+		
+		$this->saveObject($newElement);
 	}
 	
 	/**
@@ -56,7 +59,7 @@ trait TXmlGuiPackageInstallationPlugin {
 	 * @param	string			$identifier
 	 * @return	string			new identifier
 	 */
-	public function editEntry(IFormDocument $form, string $identifier): string{
+	public function editEntry(IFormDocument $form, string $identifier): string {
 		$xml = $this->getProjectXml();
 		$document = $xml->getDocument();
 		
@@ -75,6 +78,8 @@ trait TXmlGuiPackageInstallationPlugin {
 		// $xml->write($this->getXmlFileLocation($project));
 		$xml->write($project->path . ($project->getPackage()->package === 'com.woltlab.wcf' ? 'com.woltlab.wcf/' : '') . 'tmp_' . static::getDefaultFilename());
 		
+		$this->saveObject($newEntry, $element);
+		
 		return $this->getElementIdentifier($newEntry);
 	}
 	
@@ -96,6 +101,7 @@ trait TXmlGuiPackageInstallationPlugin {
 	/**
 	 * Returns the `import` element with the given identifier.
 	 * 
+	 * @param	XML	$xml
 	 * @param	string	$identifier
 	 * @return	\DOMElement|null
 	 */
@@ -109,6 +115,14 @@ trait TXmlGuiPackageInstallationPlugin {
 		return null;
 	}
 	
+	/**
+	 * Extracts the PIP object data from the given XML element.
+	 *
+	 * @param	\DOMElement	$element
+	 * @return	array
+	 */
+	abstract protected function getElementData(\DOMElement $element): array;
+	
 	/**
 	 * Returns the identifier of the given `import` element.
 	 * 
@@ -141,7 +155,7 @@ XML;
 	 * 
 	 * @return	XML
 	 */
-	protected function getProjectXml() {
+	protected function getProjectXml(): XML {
 		$fileLocation = $this->getXmlFileLocation();
 		
 		$xml = new XML();
@@ -160,13 +174,39 @@ XML;
 	 * 
 	 * @return	string
 	 */
-	protected function getXmlFileLocation() {
+	protected function getXmlFileLocation(): string {
 		/** @var DevtoolsProject $project */
 		$project = $this->installation->getProject();
 		
 		return $project->path . ($project->getPackage()->package === 'com.woltlab.wcf' ? 'com.woltlab.wcf/' : '') . static::getDefaultFilename();
 	}
 	
+	/**
+	 * Saves an object represented by an XML element in the database by either
+	 * creating a new element (if `$oldElement = null`) or updating an existing
+	 * element.
+	 *
+	 * @param	\DOMElement		$newElement	XML element with new data
+	 * @param	\DOMElement|null	$oldElement	XML element with old data
+	 */
+	protected function saveObject(\DOMElement $newElement, \DOMElement $oldElement = null) {
+		$newElementData = $this->getElementData($newElement);
+		
+		if ($oldElement === null) {
+			call_user_func([$this->className, 'create'], $newElementData);
+		}
+		else {
+			$sqlData = $this->findExistingItem($this->getElementData($oldElement));
+			
+			$statement = WCF::getDB()->prepareStatement($sqlData['sql']);
+			$statement->execute($sqlData['parameters']);
+			
+			$baseClass = call_user_func([$this->className, 'getBaseClass']);
+			$itemEditor = new $this->className(new $baseClass(null, $statement->fetchArray()));
+			$itemEditor->update($newElementData);
+		}
+	}
+	
 	/**
 	 * Informs the pip of the identifier of the edited entry if the form to
 	 * edit that entry has been submitted.
-- 
2.20.1