TypesetPlugin.inc.php

<?php

/**
 * @file plugins/generic/typeset/TypesetPlugin.inc.php
 *
 * @brief main class of the Converter Plugin
 */

import('lib.pkp.classes.plugins.GenericPlugin');

/**
 * Class TypesetPlugin
 */
class TypesetPlugin extends GenericPlugin {

	/**
	 * Register the plugin
	 *
	 * @param $category string Plugin category
	 * @param $path string Plugin path
	 * @param $mainContextId
	 * @return bool True on successful registration false otherwise
	 */
	public function register($category, $path, $mainContextId = NULL) {
		// Register the plugin
		$success = parent::register($category, $path);
		if ($success && $this->getEnabled()) {
			HookRegistry::register('TemplateManager::fetch', array($this, 'templateFetchCallback'));
			HookRegistry::register('LoadHandler', array($this, 'callbackLoadHandler'));
			$this->_registerTemplateResource();

		}
		return $success;
	}


	//Callbacks

	/**
	 * @param $hookName
	 * @param $args
	 * @return bool
	 */
	public function callbackLoadHandler($hookName, $args) {
		$page = $args[0];
		$op = $args[1];

		switch ("$page/$op") {
			case 'typeset/createGalley':
			case 'typeset/createGalleyForm':
			case 'typeset/convert':
				define('HANDLER_CLASS', 'TypesetHandler');
				define('TYPESET_PLUGIN_NAME', $this->getName());
				$args[2] = $this->getPluginPath() . '/' . 'TypesetHandler.inc.php';
		}

		return false;
	}

	/**
	 * Adds links to submission files grid row
	 * @param $hookName string The name of the invoked hook
	 * @param $args array Hook parameters
	 */
	public function templateFetchCallback($hookName, $args) {
		$request = $this->getRequest();
		$dispatcher = $request->getDispatcher();

		$templateMgr = $args[0];
		$resourceName = $args[1];
		if ($resourceName == 'controllers/grid/gridRow.tpl') {

			$row = $templateMgr->get_template_vars('row');
			$data = $row->getData();
			$stageId = (int)$request->getUserVar('stageId');

			if ($stageId == WORKFLOW_STAGE_ID_PRODUCTION) {
				if (is_array($data) && (isset($data['submissionFile']))) {
					$submissionFile = $data['submissionFile'];
					$fileExtension = strtolower($submissionFile->getExtension());

					if ($fileExtension == 'docx' || $fileExtension == 'odt') {

						$path = $dispatcher->url($request, ROUTE_PAGE, null, basename($this->getPluginPath()), 'convert', null,
							array(
								'submissionId' => $submissionFile->getSubmissionId(),
								'fileId' => $submissionFile->getFileId(),
								'fileExtension' => $fileExtension,
								'stageId' => $stageId
							));
						$pathRedirect = $dispatcher->url($request, ROUTE_PAGE, null, 'workflow', 'access',
							array(
								'submissionId' => $submissionFile->getSubmissionId(),
								'fileId' => $submissionFile->getFileId(),
								'stageId' => $stageId
							));

						import('lib.pkp.classes.linkAction.request.AjaxAction');
						$linkAction = new LinkAction(
							'parse',
							new PostAndRedirectAction($path, $pathRedirect),
							__('plugins.generic.typeset.button.createXML')
						);
						$row->addAction($linkAction);
					}

					$pluginSettingsDao = DAORegistry::getDAO('PluginSettingsDAO');
					$context = $request->getContext();
					if (!$pluginSettingsDao->settingExists($context->getId(), 'texture', 'enabled')) {

						$actionArgs = array(
							'submissionId' => $submissionFile->getSubmissionId(),
							'stageId' => $stageId,
							'fileId' => $submissionFile->getFileId()
						);
						import('lib.pkp.classes.linkAction.request.AjaxAction');
						$row->addAction(new LinkAction(
							'createGalleyForm',
							new AjaxModal(
								$dispatcher->url(
									$request, ROUTE_PAGE, null,
									'typeset',
									'createGalleyForm', null,
									$actionArgs
								),
								__('submission.layout.newGalley')
							),
							__('plugins.generic.typeset.links.createGalley'),
							null
						));
					}
				}
			}
		}
	}

	/**
	 * @copydoc Plugin::getActions()
	 */
	function getActions($request, $actionArgs) {
		$router = $request->getRouter();
		import('lib.pkp.classes.linkAction.request.AjaxModal');
		return array_merge(
			$this->getEnabled() ? array(
				new LinkAction(
					'settings',
					new AjaxModal(
						$router->url($request, null, null, 'manage', null, array_merge($actionArgs, array('verb' => 'settings'))),
						$this->getDisplayName()
					),
					__('manager.plugins.settings'),
					null
				),
			) : array(),
			parent::getActions($request, $actionArgs)
		);
	}

	/**
	 * @copydoc Plugin::getDisplayName()
	 */
	function getDisplayName() {
		return __('plugins.generic.typeset.displayName');
	}

	/**
	 * @copydoc Plugin::getDescription()
	 */
	function getDescription() {
		return __('plugins.generic.typeset.description');
	}


	/**
	 * Get plugin URL
	 * @param $request PKPRequest
	 * @return string
	 */
	function getPluginUrl($request) {
		return $request->getBaseUrl() . '/' . $this->getPluginPath();
	}

	/**
	 * Get context wide setting. If the context or the setting does not exist,
	 * get the site wide setting.
	 * @param $context Context
	 * @param $name Setting name
	 * @return mixed
	 */
	function _getPluginSetting($context, $name) {
		$pluginSettingsDao = DAORegistry::getDAO('PluginSettingsDAO');
		if ($context && $pluginSettingsDao->settingExists($context->getId(), $this->getName(), $name)) {
			return $this->getSetting($context->getId(), $name);
		} else {
			return $this->getSetting(CONTEXT_ID_NONE, $name);
		}
	}

	/**
	 * @return string
	 */
	function getToolPath() {
		$toolPath = Config::getVar('cli', 'meTypeset');
		return $toolPath;
	}

	/**
	 * Get python virtual environment
	 * @return string
	 */
	function getPythonVM() {
		$toolPath = Config::getVar('cli', 'python_vm');
		return $toolPath;
	}


	/**
	 * @param array $args
	 * @param PKPRequest $request
	 * @return JSONMessage
	 */
	function manage($args, $request) {
		$this->import('TypesetSettingsForm');
		$context = Request::getContext();
		switch ($request->getUserVar('verb')) {
			case 'settings':
				$settingsForm = new TypesetSettingsForm($this, $context->getId());
				$settingsForm->initData();
				return new JSONMessage(true, $settingsForm->fetch($request));
			case 'save':
				$settingsForm = new TypesetSettingsForm($this, $context->getId());
				$settingsForm->readInputData();
				if ($settingsForm->validate()) {
					if ($settingsForm->execute()) {
						$notificationManager = new NotificationManager();
						$notificationManager->createTrivialNotification(
							$request->getUser()->getId(),
							NOTIFICATION_TYPE_SUCCESS,
							array('contents' => __('plugins.generic.typeset.settings.saved'))
						);
						return new JSONMessage(true);
					}
				}
				return new JSONMessage(true, $settingsForm->fetch($request));
		}
		return parent::manage($args, $request);
	}


}