SettingsForm.inc.php

<?php

/**
* @file plugins/generic/markup/SettingsForm.inc.php
*
* Copyright (c) 2003-2013 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class SettingsForm
* @ingroup plugins_generic_markup
*
* @brief Form for Document Markup gateway plugin settings
*/

import('lib.pkp.classes.form.Form');

define('MARKUP_CSL_STYLE_DEFAULT', 'chicago-author-date.csl');
define('MARKUP_CSL_STYLE_NAME_DEFAULT', 'Chicago Manual of Style (author-date)');
define('MARKUP_DOCUMENT_SERVER_URL_DEFAULT', 'http://pkp-udev.lib.sfu.ca/');

class SettingsForm extends Form {

	/** @var $journalId int */
	var $journalId;

	/** @var $plugin object */
	var $plugin;

	/** @var $settings array */
	var $settings;

	/**
	 * Constructor
	 * @param $plugin mixed Plugin object
	 * @param $journalId int JournalId
	 */
	function SettingsForm(&$plugin, $journalId) {
		$this->journalId = $journalId;
		$this->plugin =& $plugin;
		$journal =& Request::getJournal();
		parent::Form($plugin->getTemplatePath() . 'settingsForm.tpl');

		// Validation checks for this form
		$this->settings = array(
			'cslStyle' => 'string',
			'cslStyleName' => 'string',
			'cssHeaderImageName' => 'string',
			'markupHostPass' => 'string',
			'markupHostURL' => 'string',
			'markupHostUser' => 'string',
			'reviewVersion' => 'bool',
		);
	}

	/**
	 * Validate the form
	 *
	 * @return bool Whether or not the form validated
	 */
	function validate() {
		$this->addCheck(new FormValidatorPost($this));
		$this->addCheck(new FormValidator($this, 'cslStyle', 'required', 'plugins.generic.markup.required.cslStyle'));
		$this->addCheck(new FormValidator($this, 'cslStyleName', 'optional', 'plugins.generic.markup.optional.cslStyleName'));
		$this->addCheck(new FormValidator($this, 'markupHostPass', 'optional', 'plugins.generic.markup.optional.markupHostPass'));
		$this->addCheck(new FormValidator($this, 'markupHostURL', 'required', 'plugins.generic.markup.required.markupHostURL'));
		$this->addCheck(new FormValidator($this, 'markupHostUser', 'optional', 'plugins.generic.markup.optional.markupHostUrl'));
		$this->addCheck(new FormValidator($this, 'reviewVersion', 'optional', 'plugins.generic.markup.optional.reviewVersion'));

		$this->addCheck(new FormValidatorCustom($this, 'cssHeaderImageName', 'optional', 'plugins.generic.markup.error', $this->_validateImage('cssHeaderImage'), true));

		return parent::validate();
	}

	/**
	 * Initialize plugin settings form
	 *
	 * @return void
	 */
	function initData() {
		$journal =& Request::getJournal();
		$journalId = $this->journalId;
		$plugin =& $this->plugin;

		// User must at least load settings page for plugin to work with defaults.
		if ($plugin->getSetting($journalId, 'cslStyle') == '') {
			$plugin->updateSetting($journalId, 'cslStyle', MARKUP_CSL_STYLE_DEFAULT);
			$plugin->updateSetting($journalId, 'cslStyleName', MARKUP_CSL_STYLE_NAME_DEFAULT);
		}
		if ($plugin->getSetting($journalId, 'markupHostURL') == '') {
			$plugin->updateSetting($journalId, 'markupHostURL', MARKUP_DOCUMENT_SERVER_URL_DEFAULT);
		}

		$this->setData('cslStyle', $plugin->getSetting($journalId, 'cslStyle'));
		$this->setData('cslStyleName', $plugin->getSetting($journalId, 'cslStyleName'));

		// This field has content only if header image actually exists in the right folder.
		$journalFileManager = $this->_getJournalFileManager($journal);
		$folderCssImage = glob($journalFileManager->filesDir . 'css/article_header.{jpg,png}', GLOB_BRACE);
		if (count($folderCssImage)) {
			$this->setData('cssHeaderImageName', basename($folderCssImage[0]));
		}

		$this->setData('markupHostUser', $plugin->getSetting($journalId, 'markupHostUser'));
		$this->setData('reviewVersion', $plugin->getSetting($journalId, 'reviewVersion'));
		$this->setData('markupHostURL', $plugin->getSetting($journalId, 'markupHostURL'));
	}

	/**
	 * Populate and display settings form
	 *
	 * @return void
	 */
	function display() {
		$templateManager =& TemplateManager::getManager();

		// Signals indicating plugin compatibility
		$templateManager->assign('curlSupport', function_exists('curl_init') ? __('plugins.generic.markup.settings.installed') : __('plugins.generic.markup.settings.notInstalled'));
		$templateManager->assign('zipSupport', extension_loaded('zlib') ? __('plugins.generic.markup.settings.installed') : __('plugins.generic.markup.settings.notInstalled'));
		$templateManager->assign('php5Support', checkPhpVersion('5.0.0') ? __('plugins.generic.markup.settings.installed') : __('plugins.generic.markup.settings.notInstalled'));
		$templateManager->assign('pathInfo', Request::isPathInfoEnabled() ? __('plugins.generic.markup.settings.enabled') : __('plugins.generic.markup.settings.disabled'));

		$templateManager->assign('additionalHeadData', '<link rel="stylesheet" type="text/css" href="' . $this->plugin->getCssPath() . 'settingsForm.css" />');

		parent::display();
	}

	/**
	 * Assign form data to user-submitted data
	 *
	 * @return void
	 */
	function readInputData() {
		$this->readUserVars(
			array(
				'cslStyle',
				'cslStyleName',
				'cssHeaderImage',
				'markupHostPass',
				'markupHostURL',
				'markupHostUser',
				'reviewVersion',
			)
		);
	}

	/**
	 * Save settings
	 *
	 * @return void
	 */
	function execute() {
		$plugin =& $this->plugin;
		$journalId = $this->journalId;

		$plugin->updateSetting($journalId, 'cslStyle', $this->getData('cslStyle'));
		$plugin->updateSetting($journalId, 'cslStyleName', $this->getData('cslStyleName'));

		$markupHostURL = $this->getData('markupHostURL');
		if ($markupHostURL) {
			if (!parse_url($markupHostURL, PHP_URL_SCHEME)) {
				$markupHostURL = 'http://' . $markupHostURL;
			}
			if (substr(parse_url($markupHostURL, PHP_URL_PATH), -1) != '/') {
				$markupHostURL .= '/';
			}
		}
		$plugin->updateSetting($journalId, 'markupHostURL', $markupHostURL);

		$plugin->updateSetting($journalId, 'markupHostUser', $this->getData('markupHostUser'));
		$plugin->updateSetting($journalId, 'markupHostPass', $this->getData('markupHostPass'));
		$plugin->updateSetting($journalId, 'reviewVersion', $this->getData('reviewVersion'));

		// Upload article header image if given. Image suffix already validated above.
		$journalFileManager = $this->_getJournalFileManager();
		$imageName = 'cssHeaderImage';
		if ($journalFileManager->uploadedFileExists($imageName)) {
			$extension = $this->_getUploadedImageFileExtension($imageName, $journalFileManager);
			$journalFileManager->uploadFile('cssHeaderImage', '/css/article_header' . $extension);
		}
	}

	/**
	 * Ensure attached header image is a jpg or png
	 *
	 * @param $imageName string File name of the uploaded image file
	 *
	 * @return bool Whether or not the image file is a jpg or png
	 */
	function _validateImage($imageName) {
		$journalFileManager = $this->_getJournalFileManager();
		if ($journalFileManager->uploadedFileExists($imageName)) {
			$extension = $this->_getUploadedImageFileExtension($imageName, $journalFileManager);
			if ($extension != '.png' && $extension != '.jpg') {
				$this->addError('coverPage', __('plugins.generic.markup.optional.cssHeaderImage'));
				return false;
			}
		}

		return true;
	}

	/**
	 * Returns the file extension of the uploaded image file
	 *
	 * @param $fileName mixed Name of the uploaded image file
	 * @param $journalFileManager mixed Journal file manager object
	 *
	 * @return string File extension
	 */
	function _getUploadedImageFileExtension($fileName, &$journalFileManager) {
		$type = $journalFileManager->getUploadedFileType($fileName);
		return $journalFileManager->getImageExtension($type);
	}

	/**
	 * Returns JournalFileManager instance
	 *
	 * @param $journal mixed Journal to get a fiel manager instance for
	 *
	 * @return mixed JournalFileManager instance
	 */
	function _getJournalFileManager($journal = null) {
		if (!$journal) { $journal =& Request::getJournal(); }
		import('classes.file.JournalFileManager');
		return new JournalFileManager($journal);
	}
}