ojsErcPlugin.inc.php

<?php

// import of genericPlugin
import('lib.pkp.classes.plugins.GenericPlugin');
import('lib.pkp.classes.submission.SubmissionFile');
			
use phpDocumentor\Reflection\Types\Null_;
use \PKP\components\forms\FormComponent;
use \PKP\components\forms\FieldHTML; // needed for function extendScheduleForPublication
use PKP\submission\SubmissionFile;
use PKP\core\JSONMessage; // needed otherwise the JSONMessage in the manage-function is not possible 
use APP\facades\Repo; // needed to get publication information 
use PKP\db\DAORegistry; // needed to interact with the GenreDAO 
use Illuminate\Support\Facades\DB; // needed to interact with the OJS database 
use PKP\config\Config; // needed to get the directory of the uploaded files 

/**
 * ojsErcPlugin, a generic Plugin for enabling geospatial properties in OJS 
 */
class ojsErcPlugin extends GenericPlugin
{
	public function register($category, $path, $mainContextId = NULL)
	{
		// Register the plugin even when it is not enabled
		$success = parent::register($category, $path, $mainContextId);
		// important to check if plugin is enabled before registering the hook, cause otherwise plugin will always run no matter enabled or disabled! 
		if ($success && $this->getEnabled()) {			
			/*
			Load the build of the o2r api release version (if it is not already there), which is specified by the user in the plugin settings.
			If there is no version specified by the user, then $releaseUrlStandard is used, which means at the moment version 0.5.6. 
			*/
			$o2rBuildAlreadyThere = is_dir($this->getPluginPath() . '/' . 'build');

			if ($o2rBuildAlreadyThere === false) {

				$contextId = Application::get()->getRequest()->getContext()->getId();
				$releaseVersionFromSettings = $this->getSetting($contextId, 'releaseVersion'); 

				$releaseUrlStandard= "https://github.com/o2r-project/o2r-UI/releases/download/0.5.6/build.zip"; 

				/*
				If there is no release version available from the plugin settings the standard releaseUrl is used and correspondingly set in the database (ojs-erc-plugin settings) as version.
				Otherwise the version specified by the user in the settings is used. 
				*/
				if ($releaseVersionFromSettings === null || $releaseVersionFromSettings === '') {

					$releaseUrl = $releaseUrlStandard;

					$pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');
					$pluginSettingsDAO->updateSetting($contextId, "ojsercplugin", "releaseVersion", '0.5.6');
				}
				else {
					$releaseUrl = 'https://github.com/o2r-project/o2r-UI/releases/download/' . $releaseVersionFromSettings . '/build.zip'; 
				}

				$file_name = basename($releaseUrl);

				$temporaryDirectory = sys_get_temp_dir(); // directory to store the zip-file 

				$pathZip = $temporaryDirectory . '/' . $file_name; // path in the temporary directory
				$pathNoZip = $this->getPluginPath() . '/' . 'build'; // final path in the plugin structure 

				// store unzipped build at final destination 
				if(file_put_contents($pathZip, file_get_contents($releaseUrl))) {

					$zip = new ZipArchive;
					if ($zip->open($pathZip) === TRUE) {
  					  	$zip->extractTo($pathNoZip);
  					  	$zip->close();

						unlink($pathZip); // delete temporary file 

					} else {
 			 	  		//echo 'error';
					}
				}
				else {
		   	 	//echo "File downloading failed.";
				}
				
				/*
				Update the config.js of the build in terms of the baseURL specified in the plugin settings and set the ojsView to true. 
				It is here important to differ between two baseUrl the "baseUrl" which is the URL of the OJS server and 
				"baseUrlErc" which is the BaseUrl of the Erc server. 
				*/
				$pathConfigJs = $this->getPluginPath() . '/build/config.js'; 

				$rawConfigFile = fopen($pathConfigJs, "r+");
				$readConfigFile = fread($rawConfigFile, filesize($pathConfigJs)); 

				$contextId = Application::get()->getRequest()->getContext()->getId();
				$baseUrlErcFromSettings = $this->getSetting($contextId, 'serverURL'); 

				$baseUrlErcStandard= "https://o2r.uni-muenster.de/api/v1/";
				
				// if there is no url available from the plugin settings the standard url is used and correspondingly set in the database (ojs-erc-plugin settings) 
				if ($baseUrlErcFromSettings === null || $baseUrlErcFromSettings === '') {
					$baseUrlErc = $baseUrlErcStandard;

					$pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');
					$pluginSettingsDAO->updateSetting($contextId, "ojsercplugin", "serverURL", $baseUrlErc);
				}
				else {
					$baseUrlErc = $baseUrlErcFromSettings;
				}

				/**
				 * The url is adjusted accordingly in config.js as well. 
				 * Additionally the ERCGalleyPrimaryColour is written in the config.js
				 * It is checked if the user has set an ERCGalleyColour in the ojs-erc-plugin settings, 
				 * if this is the case it is written into the config.js. If this is not the case, 
				 * the baseColour of the default theme plugin is written to the config.js, and to the variable ERCGalleyColour of the ojs-erc-plugin in the OJS database (ojs-erc-plugin settings).
				 * If no colour is set via the ojs-erc-plugin and default theme plugin, for example because another theme plugin is used, the OJS default colour is used, written to the config.js, 
				 * and to the variable ERCGalleyColour of the ojs-erc-plugin in the OJS database (ojs-erc-plugin settings).				 
				 * */
				// baseUrl
				preg_match('/"baseUrl":\s"[^,]*"/', $readConfigFile, $configOld);        
				$configNew = '"baseUrl": "' . $baseUrlErc . '"'; 
				$adaptedConfig = str_replace($configOld[0], $configNew, $readConfigFile);
				$adaptedOjsView = str_replace("false", "true", $adaptedConfig);

				// colour 
				$pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');
				$context = PKPApplication::getRequest()->getContext();
				$contextId = $context ? $context->getId() : 0;
				$defaultThemePluginSettings = $pluginSettingsDAO->getPluginSettings($contextId, 'DefaultThemePlugin');
				$OJSERCPluginSettings = $pluginSettingsDAO->getPluginSettings($contextId, 'ojsercplugin');

				if ($OJSERCPluginSettings[ERCGalleyColour] === '' || $OJSERCPluginSettings[ERCGalleyColour] === null || isset($OJSERCPluginSettings[ERCGalleyColour]) === false ) {
					
					if ($defaultThemePluginSettings[baseColour] !== '' && $defaultThemePluginSettings[baseColour] !== null && isset($defaultThemePluginSettings[baseColour])) {
						$colour = $defaultThemePluginSettings[baseColour]; 
					}
					else {
					$colour = "#1E6292"; // OJS default colour 
					}

					$pluginSettingsDAO->updateSetting($contextId, "ojsercplugin", "ERCGalleyColour", $colour);

				}
				else {
					$colour = $OJSERCPluginSettings[ERCGalleyColour]; 
				}

				$positionColour = strpos($adaptedOjsView, 'ojsView') + 16; 
				$colourOption = '"ERCGalleyPrimaryColour": "' . $colour . '"'; 
				$insertColourOption = substr_replace($adaptedOjsView, $colourOption, $positionColour, 0);

				file_put_contents($pathConfigJs, $insertColourOption);
				fclose($rawConfigFile);

				/*
				Update the index.html of the build in terms of the users path for the css-, js-, logo-, and manifest-file(s). 
				*/
				$request = Application::get()->getRequest();
				$baseUrl = $request->getBaseUrl();

				$pluginPath = $this->getPluginPath(); 
				$pathHtml = $this->getPluginPath() . '/build/index.html'; 

				$rawHtmlFile = fopen($pathHtml, "r+");
				$readHtmlFile = fread($rawHtmlFile, filesize($pathHtml)); 

				/**
				 * Function that updates for a html file for all given regular expressions all paths concerning basUrl and pluginPath. 
				 */
				function updatePath($regularExpressions, $readHtmlFile, $baseUrl, $pluginPath)
  				{
					$adaptedHtml = $readHtmlFile;

					if (!preg_match('/http:\/\/ojs/', $adaptedHtml)){
						
					foreach ($regularExpressions as $key => $value) {

						$oldHtmlFile = $adaptedHtml; 
						preg_match($value, $oldHtmlFile, $oldPath);
					   	$newPath = $baseUrl . '/' . $pluginPath . '/build/' . substr($oldPath[0], 1);
					   	$adaptedHtml = str_replace($oldPath[0], $newPath, $oldHtmlFile);						
						}
					}

					return $adaptedHtml; 
				}

				$regularExpressions = array(
					'staticCss' => '"\/static\/css\/2\.chunk\.css"',
					'staticCssMain' => '"\/static\/css\/main\.chunk\.css"',
					'staticJs' => '"\/static\/js\/2\.chunk\.js"',
					'staticJsMain' => '"\/static\/js\/main\.chunk\.js"', 
					'logo' => '"\/logo\.png"', 
					'manifest' => '"\/manifest\.json"', 
					'configJs' => '"\/config\.js"', 
				);

				file_put_contents($pathHtml, updatePath($regularExpressions, $readHtmlFile, $baseUrl, $pluginPath));
				fclose($rawHtmlFile);
			}



			/*
			Create ERC genre for submissions 
			*/
			$request = Application::get()->getRequest();
			$context_id = $request->getContext()->getId(); 

            $genreDAO = DAORegistry::getDAO('GenreDAO'); // classes/submission/GenreDAO.inc.php 
			$allExistingGenres = $genreDAO->getByContextId($request->getContext()->getId())->toArray(); // not needed at the moment but interesting 
			$ercGenreExists = $genreDAO->keyExists('ERC', $request->getContext()->getId()); 

			/**
			 * If there is no ERC genre already existing it is created 
			 */
			if ($ercGenreExists === false) { 

				$ercGenre = $genreDAO->newDataObject();

				$ercGenre->setKey("ERC");
				$ercGenre->setContextId($request->getContext()->getId());
				$ercGenre->setCategory(0);
				$ercGenre->setDependent(0);
				$ercGenre->setSupplementary(0);
				$ercGenre->setSequence(0);
				$ercGenre->setEnabled(1);

				$primaryLocale = $request->getContext()->getPrimaryLocale();

                $ercGenre->setName("Executable Research Compendium", $primaryLocale);

				$genreDAO->insertObject($ercGenre);
				
				$genreId = $ercGenre->getId(); 

				$genreDAO->getDataObjectSettings('genre_settings', 'genre_id', $genreId, $genre);
			}


			/* 
			Hooks are the possibility to intervene the application. By the corresponding function which is named in the HookRegistery, the application
			can be changed. 
			Further information here: https://docs.pkp.sfu.ca/dev/plugin-guide/en/categories#generic 
			*/
		
			// Hooks for creating and setting a new field in the database 
			/* both functions below are not needed, as the database entries are done directly without schema (addToSchema) and 
			function editPublication is integrated in the function publishCompendium. 
			*/ 
			######HookRegistry::register('Schema::get::publication', array($this, 'addToSchema')); 
			######HookRegistry::register('Publication::edit', array($this, 'editPublication')); // Take care, hook is called twice, first during Submission Workflow and also before Schedule for Publication in the Review Workflow!!!

			// Hooks for uploading, publishing and updating a workspace.zip uploaded in the submission process o2r API
			HookRegistry::register('submissionsubmitstep2form::execute', array($this, 'uploadCompendium'));
						
			HookRegistry::register('Publication::edit', array($this, 'updateCompendium'));

			$request = Application::get()->getRequest();
			$templateMgr = TemplateManager::getManager($request);

			// main js scripts
			$templateMgr->assign('pluginSettingsJS', $request->getBaseUrl() . '/' . $this->getPluginPath() . '/js/pluginSettings.js');
			//$templateMgr->assign('submissionMetadataFormFieldsJS', $request->getBaseUrl() . '/' . $this->getPluginPath() . '/js/submissionMetadataFormFields.js'); // Template is not used at the moment, but could be used to implement a possibility for the user to insert an ID of an existing ERC and connect it to a submission.

		}
		return $success;
	}

	/**
	 * Function which uploads a workspace.zip to the o2r service and requests/integrates the metadata of the newly created compendium candidate 
	 * in the submission step 3.   
	 * @param hook submissionsubmitstep2form::execute
	 */
	
	public function uploadCompendium($hookName, $params) 
	{
		// loading OJS ERC plugin settings 
		$pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');
		$context = PKPApplication::getRequest()->getContext();
		$contextId = $context ? $context->getId() : 0;
		$OJSERCPluginSettings = $pluginSettingsDAO->getPluginSettings($contextId, 'ojsercplugin');
		$serverCookie = "Cookie: connect.sid=" . $OJSERCPluginSettings[serverCookie];

		// get the genreId of the genre "ERC"
		$genreDAO = DAORegistry::getDAO('GenreDAO'); // classes/submission/GenreDAO.inc.php 
		$genreIdErc = $genreDAO->getByKey("ERC")->_data[id];

		// id of current submission 
		$submissionId = $params[0]->submissionId; 

		/*
		Request to the database table 'submission_files' to get the file id for the current submission 
		where the genre is ERC. So to get the file id of the workspace-zip file. 
		There was the need for a direct request to the database, as there was no OJS function available to search 
		for the file ids of a corresponding submission.
		*/
		$databaseRequestFileId = DB::table('submission_files')
			->where('submission_id', '=', $submissionId)
			->where('genre_id', '=', $genreIdErc)
			->get('file_id');

		$fileIdOfWorkspaceZip = $databaseRequestFileId[0]->file_id; 

		// if a workspace-zip with the genre ERC exists, then it is uploaded to the o2r server 
		if ($fileIdOfWorkspaceZip !== null) {
			/*
			Request to the database table 'files' to get the path of the corresponding file id. So to get the path 
			of the workspace-zip file. 
			There was the need for a direct request to the database, as the OJS function which should be used for this 
			shown here below, is not delivering the path for the current submission, only for the ones created before.

			$submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO');  
			$test = $submissionFileDao->getById($fileIdOfWorkspaceZip); 
			*/ 
			$databaseRequestPath = DB::table('files')
				->where('file_id', '=', $fileIdOfWorkspaceZip)
				->get('path');

			$directoryOfWorkspaceZip = $databaseRequestPath[0]->path; 

			$uploadedFilesDirectory = Config::getVar('files', 'files_dir'); 
			$fullDirectoryOfWorkspaceZip = $uploadedFilesDirectory . '/' . $directoryOfWorkspaceZip; 
			
			// Request to upload zip 
			$headers = array(
				$serverCookie,
				'Content-type: multipart/form-data'
			); 

			$url = 'http://localhost/api/v1/compendium';
    
			$csv_file = new CURLFile($fullDirectoryOfWorkspaceZip, 'application/zip');
   
			$post_data = array(
   			   "compendium" => $csv_file,
			   "content_type" => 'workspace'
   			);
    
			$curl = curl_init();
			curl_setopt($curl, CURLOPT_VERBOSE, true); # needed? 
			curl_setopt($curl, CURLOPT_HEADER, false); # needed? 
			curl_setopt($curl, CURLOPT_POST, true);
			curl_setopt($curl, CURLOPT_URL, $url);
			curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);
			curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
			curl_setopt($curl,CURLOPT_RETURNTRANSFER, true);
			$responseCompendium = curl_exec($curl);
			$statusCompendium = curl_getinfo($curl, CURLINFO_HTTP_CODE);
			curl_close($curl); 			
		

			$compendiumId = json_decode($responseCompendium)->id;

			if ($statusCompendium === 200) {
				// request for metadata of the candidate compendium 
				$headers = array(
					$serverCookie,
				); 

				$url = 'http://localhost/api/v1/compendium/' . $compendiumId . '/metadata';
			
				$curl = curl_init();
				curl_setopt($curl, CURLOPT_URL, $url);
				curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
				curl_setopt($curl,CURLOPT_RETURNTRANSFER, true);
				$responseGetMetadata = curl_exec($curl);
				$statusGetMetadata = curl_getinfo($curl, CURLINFO_HTTP_CODE);
				curl_close($curl); 
			}

			// store metadata of the candidate compendium in the OJS database, so that they can be displayed in submission step 3 
			$metadata = json_decode($responseGetMetadata);

			$compendiumTitle = $metadata->metadata->o2r->title; 
			$compendiumAbstract = $metadata->metadata->o2r->description; 

			$submissionId = $params[0]->submissionId; 

			$request = Application::get()->getRequest();
			$primaryLocale = $request->getContext()->getPrimaryLocale();

			/*
			The usual step to adapt the metadata (shown at the bottom of this comment) is not working here, 
			it works only one step later with hook 'Publication::edit' in submission step 3. 
			Thus there was the need to make a direct entry into the database.

			$currentPublication = $params[0];
			$currentPublication->setData('title', $compendiumTitle, $primaryLocale); 
			*/

			// store title in the database 
			DB::table('publication_settings')->insert([
				'publication_id' => $submissionId,
				'locale' => $primaryLocale, 
				'setting_name' => 'title',
				'setting_value' => $compendiumTitle, 
			]); 

			// store abstract in the database 
			DB::table('publication_settings')->insert([
				'publication_id' => $submissionId,
				'locale' => $primaryLocale, 
				'setting_name' => 'abstract',
				'setting_value' => $compendiumAbstract, 
			]); 

			// store compendiumId in the database 
			DB::table('publication_settings')->insert([
				'publication_id' => $submissionId,
				'locale' => $primaryLocale, 
				'setting_name' => 'ojsErcPlugin::candidateCompendiumId',
				'setting_value' => $compendiumId, 
			]); 

			// create job - example request 
			/*
			$postfields = array();
			$postfields['compendium_id'] = '6Ajod';
			$ch = curl_init();
			curl_setopt($ch,CURLOPT_URL, 'http://localhost/api/v1/job');
			curl_setopt($ch, CURLOPT_HTTPHEADER, array("Cookie: connect.sid=s%3AvpspzYFC46nMVxx66OzFXAmYzxw6gP-e.zY%2F%2F8rObqc5ku%2BPwNUbY9YssR5PGzFmQOokBiI8GkAQ"));
			curl_setopt($ch,CURLOPT_POST, true);
			curl_setopt($ch,CURLOPT_POSTFIELDS, $postfields);
			curl_setopt($ch,CURLOPT_RETURNTRANSFER, true);
			$result = curl_exec($ch);
			echo $result;
			*/ 
		}
	}

	/**
	 * Function which updates the metadata of a compendium candidate and publishs the candidate on the o2r service 
	 * in the submission step 3.   
	 * @param hook Publication::edit
	 */
	public function updateCompendium($hookname, $params)
	{
		// loading OJS ERC plugin settings 
		$pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');
		$context = PKPApplication::getRequest()->getContext();
		$contextId = $context ? $context->getId() : 0;
		$OJSERCPluginSettings = $pluginSettingsDAO->getPluginSettings($contextId, 'ojsercplugin');
		$serverCookie = "Cookie: connect.sid=" . $OJSERCPluginSettings[serverCookie];

 		$request = Application::get()->getRequest();
		$context = $request->getContext();
		
		$submissionId = $request->getUserVar('submissionId');

		// get compendiumId of the compendium of the current submission 
		$compendiumIdDatabaseRequest = DB::table('publication_settings')
			->where('publication_id', '=', $submissionId)
			->where('setting_name', '=', 'ojsErcPlugin::candidateCompendiumId')
			->get('setting_value');

		$compendiumId = $compendiumIdDatabaseRequest->toArray()[0]->setting_value;

		if ($compendiumId !== null && $compendiumId !== "") {

			/*
			Request metadata of the compendium 
			*/
			$headers = array(
				$serverCookie,
			); 

			$url = 'http://localhost/api/v1/compendium/' . $compendiumId . '/metadata';
			
			$curl = curl_init();
			curl_setopt($curl, CURLOPT_URL, $url);
			curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
			curl_setopt($curl,CURLOPT_RETURNTRANSFER, true);
			$responseGetMetadata = curl_exec($curl);
			$statusGetMetadata = curl_getinfo($curl, CURLINFO_HTTP_CODE);
			curl_close($curl); 
			
			$responseGetMetadataDecoded = json_decode($responseGetMetadata);

			$metadata = $responseGetMetadataDecoded->metadata;

			/*
			Adapt metadata to the changes done in OJS submission step 3 
			*/
			// get by the user adapted variables 
			$title = $params[2][title][en_US];  
			$abstractWithP = $params[2]['abstract'][en_US];  
			$abstract = substr($abstractWithP, 3, -4); 

			// adapt metadata element of compendium 
			$metadata->o2r->title = $title;
			$metadata->o2r->description = $abstract; 
			
			/*
			Publish compendium with adapted metadata 
			*/ 

			$headers = array(
				$serverCookie,
				'Content-type: application/json'
			); 

			$url = 'http://localhost/api/v1/compendium/' . $compendiumId . '/metadata';

			$post_data = json_encode($metadata);

			$curl = curl_init();
			curl_setopt($curl, CURLOPT_VERBOSE, true); # needed? 
			curl_setopt($curl, CURLOPT_HEADER, false); # needed? 
			curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT");
			curl_setopt($curl, CURLOPT_URL, $url);
			curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data); 
			curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
			curl_setopt($curl,CURLOPT_RETURNTRANSFER, true);
			$responseCompendium = curl_exec($curl);
			$statusCompendium = curl_getinfo($curl, CURLINFO_HTTP_CODE);
			curl_close($curl); 	

			$ErcId = $compendiumId; 

			$newPublication = $params[0];

			/**
			* If an ErcId exists, there are two galleys created. In the first one, the displayfile/ main html of the ERC is shown. 
			* In the second one the ERC in the classical o2r-ui is shown. 
			* This is only done, if the corresponding galley option is not disabled in the OJS ERC plugin settings. 
			*/
			if ($ErcId !== null && $ErcId !== "") {

				// ERC html displayfile galley
				if ($OJSERCPluginSettings[ERCHTMLGalley] === NULL) { 
	
					/* 
					Request to the o2r API, to get to know the filename of the displayfile of the ERC 
					*/
					$url = $OJSERCPluginSettings[serverURL] . 'compendium/' . $ErcId; 

					$curl = curl_init($url);
					curl_setopt($curl, CURLOPT_URL, $url);
					curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

					//for debug only!
					curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
					curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

					$resp = curl_exec($curl);
					curl_close($curl);

					$jsonData = json_decode($resp);
					$nameDisplayfile = $jsonData->metadata->o2r->displayfile;

					/*
					Request to the o2r API, to get the displayFile. Then the file gets stored in a temporary directory. 
					*/
					$url = $OJSERCPluginSettings[serverURL] . 'compendium/' . $ErcId . '/data/' . $nameDisplayfile; 

					$curl = curl_init($url);
					curl_setopt($curl, CURLOPT_URL, $url);
					curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

					//for debug only!
					curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
					curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

					$resp = curl_exec($curl);
					curl_close($curl);

					$temporaryDirectory = sys_get_temp_dir(); // directory to store the zip-file 
					$temporaryIndexHtmlPath = $temporaryDirectory . '/' . $nameDisplayfile; // path in the temporary directory

					file_put_contents($temporaryIndexHtmlPath, $resp);

					// create corresponding submission file and galley 
					$this->createSubmissionFileAndGalley($temporaryIndexHtmlPath, $ErcId, 'ERC-HTML', $newPublication);
				}

				// ERC o2r-ui galley 
				if ($OJSERCPluginSettings[ERCo2ruiGalley] === NULL) { 

					// get path were the initial html file for the galley is stored
					$pathHtmlFile = $this->getPluginPath() . '/ERCGalleyInitial.html'; 
				
					$ErcHtmlFileName = 'ERCGalley-' . $ErcId . '.html'; 
				
					/*
					Update the index.html of the build in terms of the ErcId and store it at a temporary location  
					*/
					$pathIndexHtml = $this->getPluginPath() . '/build/index.html'; 

					$temporaryDirectory = sys_get_temp_dir(); // directory to store the zip-file 
					$temporaryIndexHtmlPath = $temporaryDirectory . '/' . $ErcHtmlFileName; // path in the temporary directory

					copy($pathIndexHtml, $temporaryIndexHtmlPath);  

					$rawHtmlFile = fopen($temporaryIndexHtmlPath, "r+");
					$readHtmlFile = fread($rawHtmlFile, filesize($temporaryIndexHtmlPath)); 

					$positionConfigJs = strrpos($readHtmlFile, 'config.js"></script>'); // The ErcId must be inserted after the config.js, to overwrite the Id set in the config.js
					$positionConfigErcID = $positionConfigJs + 20; 

					$scriptErcId = '<script>config.ercID =  "' . $ErcId . '"; </script>'; 

					$adaptedErcId = substr_replace($readHtmlFile, $scriptErcId, $positionConfigErcID, 0);

					file_put_contents($temporaryIndexHtmlPath, $adaptedErcId);
					fclose($rawHtmlFile);

					// create corresponding submission file and galley 
					$this->createSubmissionFileAndGalley($temporaryIndexHtmlPath, $ErcId, 'ERC-Galley', $newPublication);
				}
			}
		}
	}

	/**
	 * not needed, as the ErcId is stored directly in the database as ojsErcPlugin::candidateCompendiumId 
	 * 
	 * Function which extends the schema of the publication_settings table in the database. 
	 * There are two further rows in the table one for the spatial properties, and one for the timestamp. 
	 * @param hook Schema::get::publication
	 */
	public function addToSchema($hookName, $params)
	{
		// possible types: integer, string, text 
		$schema = $params[0];

		$ErcId = '{
			"type": "string",
			"multilingual": false,
			"apiSummary": true,
			"validation": [
				"nullable"
			]
		}';
		$ErcIdDecoded = json_decode($ErcId);
		$schema->properties->{'ojsErcPlugin::ErcId'} = $ErcIdDecoded;
	}

	/**
	 * not needed, as the function is integrated in function updateCompendium 
	 * 
	 * Function which fills the new fields (created by the function addToSchema) in the schema. 
	 * The data is collected using the 'submissionMetadataFormFields.js', then passed as input to the 'submissionMetadataFormFields.tpl'
	 * and requested from it in this php script by a POST-method. 
	 * Additional a html galley and o2r-ui galley is created if an ErcId input is given by the user, and if the function is not disabled in the plugin settings. 
	 * Take care, function is called twice, first during Submission Workflow and also before Schedule for Publication in the Review Workflow!!!
	 * @param hook Publication::edit
	 */
	
	function editPublication(string $hookname, array $params)
	{
		$newPublication = $params[0];
		$params = $params[2];

		$ErcId = $_POST['ErcId'];

		$testErcId = 'geQfc'; 

		// loading OJS ERC plugin settings 
		$pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');
		$context = PKPApplication::getRequest()->getContext();
		$contextId = $context ? $context->getId() : 0;
		$OJSERCPluginSettings = $pluginSettingsDAO->getPluginSettings($contextId, 'ojsercplugin');



		/**
		* If an ErcId exists, there are two galleys created. In the first one, the displayfile/ main html of the ERC is shown. 
		* In the second one the ERC in the classical o2r-ui is shown. 
		* This is only done, if the corresponding galley option is not disabled in the OJS ERC plugin settings. 
		*/
		if ($ErcId !== null && $ErcId !== "") {

			// store ErcId in the database
			$newPublication->setData('ojsErcPlugin::ErcId', $ErcId);

			// ERC html displayfile galley
			if ($OJSERCPluginSettings[ERCHTMLGalley] === NULL) { 
 
				/* 
				Request to the o2r API, to get to know the filename of the displayfile of the ERC 
				*/
				$url = 'https://o2r.uni-muenster.de/api/v1/compendium/' . $ErcId; 

				$curl = curl_init($url);
				curl_setopt($curl, CURLOPT_URL, $url);
				curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

				//for debug only!
				curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
				curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

				$resp = curl_exec($curl);
				curl_close($curl);

				$jsonData = json_decode($resp);
				$nameDisplayfile = $jsonData->metadata->o2r->displayfile;

				/*
				Request to the o2r API, to get the displayFile. Then the file gets stored in a temporary directory. 
				*/
				$url = 'https://o2r.uni-muenster.de/api/v1/compendium/' . $ErcId . '/data/' . $nameDisplayfile; 

				$curl = curl_init($url);
				curl_setopt($curl, CURLOPT_URL, $url);
				curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

				//for debug only!
				curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
				curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

				$resp = curl_exec($curl);
				curl_close($curl);

				$temporaryDirectory = sys_get_temp_dir(); // directory to store the zip-file 
				$temporaryIndexHtmlPath = $temporaryDirectory . '/' . $nameDisplayfile; // path in the temporary directory

				file_put_contents($temporaryIndexHtmlPath, $resp);

				// create corresponding submission file and galley 
				$this->createSubmissionFileAndGalley($temporaryIndexHtmlPath, $ErcId, 'ERC-HTML', $newPublication);
			}

			// ERC o2r-ui galley 
			if ($OJSERCPluginSettings[ERCo2ruiGalley] === NULL) { 

				// get path were the initial html file for the galley is stored
				$pathHtmlFile = $this->getPluginPath() . '/ERCGalleyInitial.html'; 
			
				$ErcHtmlFileName = 'ERCGalley-' . $ErcId . '.html'; 
			
				/*
				Update the index.html of the build in terms of the ErcId and store it at a temporary location  
				*/
				$pathIndexHtml = $this->getPluginPath() . '/build/index.html'; 

				$temporaryDirectory = sys_get_temp_dir(); // directory to store the zip-file 
				$temporaryIndexHtmlPath = $temporaryDirectory . '/' . $ErcHtmlFileName; // path in the temporary directory

				copy($pathIndexHtml, $temporaryIndexHtmlPath);  

				$rawHtmlFile = fopen($temporaryIndexHtmlPath, "r+");
				$readHtmlFile = fread($rawHtmlFile, filesize($temporaryIndexHtmlPath)); 

				$positionConfigJs = strrpos($readHtmlFile, 'config.js"></script>'); // The ErcId must be inserted after the config.js, to overwrite the Id set in the config.js
				$positionConfigErcID = $positionConfigJs + 20; 

				$scriptErcId = '<script>config.ercID =  "' . $ErcId . '"; </script>'; 

				$adaptedErcId = substr_replace($readHtmlFile, $scriptErcId, $positionConfigErcID, 0);

				file_put_contents($temporaryIndexHtmlPath, $adaptedErcId);
				fclose($rawHtmlFile);

				// create corresponding submission file and galley 
				$this->createSubmissionFileAndGalley($temporaryIndexHtmlPath, $ErcId, 'ERC-Galley', $newPublication);
			}
		} 		
	}

	/**
	 * Function to create from a given file a submission file and corresponding galley in the OJS article view.
	 * @param $temporaryIndexHtmlPath path of the html file in the temporary folder 
	 * @param $ErcId given ErcId entered by the user 
	 * @param $ERCGalleyType There are two galley types possible at the moment either the ''ERC-HTML'', where only the displayfile of the ERC is shown, 
	 * or the 'ERC-Galley' where the o2r-ui is shown 
	 * @param $newPublication information about the current publication 
	 */
	public function createSubmissionFileAndGalley($temporaryIndexHtmlPath, $ErcId, $ERCGalleyType, $newPublication)
	{
		$request = Application::get()->getRequest();
		$context = $request->getContext();
		$contextId = $context->getId(); 

		// id of the new created publication 
		$submissionId = $newPublication->_data['id']; 

		// get path were the submission files are stored for this new submission 
		$pathSubmissionFiles = Services::get('submissionFile')->getSubmissionDir($contextId, $submissionId);

		// store/ create new file 
		$fileId = Services::get('file')->add($temporaryIndexHtmlPath, $pathSubmissionFiles . '/' . $ERCGalleyType . '-' . $ErcId . '.html');
	
		unlink($temporaryIndexHtmlPath); 

		// get userId 
		$userId = Application::get()->getRequest()->getUser()->getId(); 

		// get language properties 
		$primaryLocale = $request->getContext()->getPrimaryLocale();
		$allowedLocales = $request->getContext()->getData('supportedSubmissionLocales');


		// set properties for the new submission file 
		$params = [
			'fileStage' => 2, // better use the constant PKP\submission\SubmissionFile::SUBMISSION_FILE_SUBMISSION, but dont know how 
			'fileId' => $fileId,
			'name' => [
				$primaryLocale => $ERCGalleyType . '-' . $ErcId . '.html',
			],
			'submissionId' => $submissionId,
			'uploaderUserId' => $userId,
			'genreId' => 1
		];

		// proof properties on errors 
		$errors = Services::get('submissionFile')->validate(VALIDATE_ACTION_ADD, $params, $allowedLocales, $primaryLocale);

		// create the new submission file 
		if (empty($errors)) {
			$submissionFile = DAORegistry::getDao('SubmissionFileDAO')->newDataObject();
			$submissionFile->setAllData($params);
			$submissionFile = Services::get('submissionFile')->add($submissionFile, $request);
		}

		/*
		Create galley with the before uploaded submission file 
		*/ 
		$submissionFileId = $submissionFile->_data['id']; 
		$articleGalleyDAO = DAORegistry::getDAO('ArticleGalleyDAO');
		$galley = $articleGalleyDAO->newDataObject();

		$galley->setData('submissionFileId', $submissionFileId); 
		$galley->setLocale('en_US');
		$galley->setData('publicationId', $submissionId);
		$galley->setLabel($ERCGalleyType);
		$galley->setSequence(1);
		$galley->setData('urlPath', $ERCGalleyType . '-' . $ErcId);
		$articleGalleyDAO->insertObject($galley);
	}

	/**
	 * @copydoc Plugin::getActions() - https://docs.pkp.sfu.ca/dev/plugin-guide/en/settings
	 * Function needed for Plugin Settings.
	 */
	public function getActions($request, $actionArgs)
	{

		// Get the existing actions
		$actions = parent::getActions($request, $actionArgs);
		if (!$this->getEnabled()) {
			return $actions;
		}

		// Create a LinkAction that will call the plugin's
		// `manage` method with the `settings` verb.
		$router = $request->getRouter();
		import('lib.pkp.classes.linkAction.request.AjaxModal');
		$linkAction = new LinkAction(
			'settings',
			new AjaxModal(
				$router->url(
					$request,
					null,
					null,
					'manage',
					null,
					array(
						'verb' => 'settings',
						'plugin' => $this->getName(),
						'category' => 'generic'
					)
				),
				$this->getDisplayName()
			),
			__('manager.plugins.settings'),
			null
		);

		// Add the LinkAction to the existing actions.
		// Make it the first action to be consistent with
		// other plugins.
		array_unshift($actions, $linkAction);

		return $actions;
	}

	/**
	 * @copydoc Plugin::manage() - https://docs.pkp.sfu.ca/dev/plugin-guide/en/settings#the-form-class 
	 * Function needed for Plugin Settings. 
	 */
	public function manage($args, $request)
	{
		switch ($request->getUserVar('verb')) {
			case 'settings':

				// Load the custom form
				$this->import('ojsErcPluginSettingsForm');
				$form = new ojsErcPluginSettingsForm($this);

				// Fetch the form the first time it loads, before
				// the user has tried to save it
				if (!$request->getUserVar('save')) {
					$form->initData();
					return new JSONMessage(true, $form->fetch($request));
				}

				// Validate and execute the form
				$form->readInputData();
				if ($form->validate()) {
					$form->execute();
					return new JSONMessage(true);
				}
		}
		return parent::manage($args, $request);
	}

	/**
	 * Provide a name for this plugin (plugin gallery)
	 *
	 * The name will appear in the Plugin Gallery where editors can
	 * install, enable and disable plugins.
	 */
	public function getDisplayName()
	{
		return __('plugins.generic.ojsErcPlugin.name');
	}

	/**
	 * Provide a description for this plugin (plugin gallery) 
	 *
	 * The description will appear in the Plugin Gallery where editors can
	 * install, enable and disable plugins.
	 */
	public function getDescription()
	{
		return __('plugins.generic.ojsErcPlugin.description');
	}
}