<?php
/* ----------------------------------------------------------------------
 * app/plugins/ULANPlugin.php :
 * ----------------------------------------------------------------------
 * CollectiveAccess
 * Open-source collections management software
 * ----------------------------------------------------------------------
 *
 * Software by Whirl-i-Gig (http://www.whirl-i-gig.com)
 * Copyright 2014-2016 Whirl-i-Gig
 *
 * For more information visit http://www.CollectiveAccess.org
 *
 * This program is free software; you may redistribute it and/or modify it under
 * the terms of the provided license as published by Whirl-i-Gig
 *
 * CollectiveAccess is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTIES whatsoever, including any implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
 *
 * This source code is free and modifiable under the terms of 
 * GNU General Public License. (http://www.gnu.org/copyleft/gpl.html). See
 * the "license.txt" file for details, or visit the CollectiveAccess web site at
 * http://www.CollectiveAccess.org
 *
 * ----------------------------------------------------------------------
 */

class ULANPlugin extends BaseApplicationPlugin {
	# -------------------------------------------------------
	/**
	 *
	 */
	protected $description = null;

	/**
	 *
	 */
	private $opo_config;

	/**
	 *
	 */
	private $ops_plugin_path;
	# -------------------------------------------------------
	public function __construct($ps_plugin_path) {
		$this->ops_plugin_path = $ps_plugin_path;
		$this->description = _t('Imports artist records from ULAN');

		parent::__construct();

		$this->opo_config = Configuration::load($ps_plugin_path.'/conf/ulan.conf');
	}
	# -------------------------------------------------------
	/**
	 * Override checkStatus() to return true - the statisticsViewerPlugin always initializes ok... (part to complete)
	 */
	public function checkStatus() {
		return array(
			'description' => $this->getDescription(),
			'errors' => array(),
			'warnings' => array(),
			'available' => ((bool)$this->opo_config->get('enabled'))
		);
	}
	# -------------------------------------------------------
	/**
	 * Insert activity menu
	 */
	public function hookRenderMenuBar($pa_menu_bar) {
		if ($o_req = $this->getRequest()) {
			if (!$o_req->user->canDoAction('can_import_ulan')) { return $pa_menu_bar; }
			if(!(bool)$this->opo_config->get('enabled')) { return $pa_menu_bar; }

			if (isset($pa_menu_bar['Import'])) {
				$va_menu_items = $pa_menu_bar['Import']['navigation'];
				if (!is_array($va_menu_items)) { $va_menu_items = array(); }
			} else {
				$va_menu_items = array();
			}

			$va_menu_items['ulan_import'] = array(
				'displayName' => _t('ULAN'),
				"default" => array(
					'module' => 'ULAN',
					'controller' => 'Import',
					'action' => 'Index'
				)
			);

			if (isset($pa_menu_bar['Import'])) {
				$pa_menu_bar['Import']['navigation'] = $va_menu_items;
			} else {
				$pa_menu_bar['Import'] = array(
					'displayName' => _t('Import'),
					'navigation' => $va_menu_items
				);
			}
		}

		return $pa_menu_bar;
	}
	# -------------------------------------------------------
	/**
	 * Add plugin user actions
	 */
	static function getRoleActionList() {
		return array(
			'can_import_ulan' => array(
				'label' => _t('Can use ULAN import functions'),
				'description' => _t('User can import ULAN data.')
			)
		);
	}
	# -------------------------------------------------------
}
