<?php

// ------------------------------------------------------------------------- //
//  XooNIps - Neuroinformatics Base Platform System                          //
//  Copyright (C) 2005-2013 RIKEN, Japan All rights reserved.                //
//  http://xoonips.sourceforge.jp/                                           //
// ------------------------------------------------------------------------- //
//  This program is free software; you can redistribute it and/or modify     //
//  it under the terms of the GNU General Public License as published by     //
//  the Free Software Foundation; either version 2 of the License, or        //
//  (at your option) any later version.                                      //
//                                                                           //
//  You may not change or alter any portion of this comment or credits       //
//  of supporting developers from this source code or any supporting         //
//  source code which is considered copyrighted (c) material of the          //
//  original comment or credit authors.                                      //
//                                                                           //
//  This program is distributed in the hope that it will be useful,          //
//  but WITHOUT ANY WARRANTY; without even the implied warranty of           //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            //
//  GNU General Public License for more details.                             //
//                                                                           //
//  You should have received a copy of the GNU General Public License        //
//  along with this program; if not, write to the Free Software              //
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA //
// ------------------------------------------------------------------------- //
defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');

$itemtype_path = dirname(__DIR__);
$itemtype_dirname = basename($itemtype_path);
$xoonips_path = dirname($itemtype_path).'/xoonips';

$langman = &xoonips_getutility('languagemanager');
$langman->read('main.php', $itemtype_dirname);

/**
 * return an array ov available simulator types.<br/>
 * that structue is shown below.<br/>
 * array( value of simulator type for processing => value of simulator type for displaying, ... )<br/>
 * values of displaying are defined by _MD_XNPSIMULATOR_SIMULATOR_TYPE_SELECT.<br/>
 * _MD_XNPSIMULATOR_SIMULATOR_TYPE_SELECT is tab(\t) separated value.<br/>
 * _MD_XNPSIMULATOR_SIMULATOR_TYPE_SELECT has four values which correspond to values for displaying as below.<br/>
 * matlab, mathematica, program, other
 * <br/>
 * number of values for displaying != number of values for processing then return false.<br/>
 * <br/>.
 */
function xnpsimulator_get_type_array()
{
    $key = array(
    'matlab',
    'mathematica',
    'program',
    'other',
    );
    $value = explode("\t", _MD_XNPSIMULATOR_SIMULATOR_TYPE_SELECT);
    $ret = array();
    if (count($key) != count($value)) {
        return false;
    }
    for ($i = 0; $i < count($key); ++$i) {
        $ret[$key[$i]] = $value[$i];
    }

    return $ret;
}

/**
 * retrieve Detail Information that specified by item_id
 * return array(only keys, no values) if item_id is wrong.
 *
 * @return array as result
 * @return false if failed
 */
function xnpsimulatorGetDetailInformation($item_id)
{
    global $xoopsDB;

    $xnpsid = $_SESSION['XNPSID'];
    $item = array();

    $result = $xoopsDB->query('select * from '.$xoopsDB->prefix('xnpsimulator_item_detail')." where simulator_id=$item_id");
    $item = $xoopsDB->fetchArray($result);

    $simulator_types = xnpsimulator_get_type_array();

    return array('simulator_type' => array(
    'value' => $item['simulator_type'],
    'select' => xnpsimulator_get_type_array(),
    'display_value' => $simulator_types[$item['simulator_type']],
    ), 'readme' => array(
    'value' => $item['readme'],
    ), 'rights' => array(
    'value' => $item['rights'],
    ), 'use_cc' => array(
    'value' => $item['use_cc'],
    ), 'cc_commercial_use' => array(
    'value' => $item['cc_commercial_use'],
    ), 'cc_modification' => array(
    'value' => $item['cc_modification'],
    ), 'attachment_dl_limit' => array(
    'value' => $item['attachment_dl_limit'],
    ), 'attachment_dl_notify' => array(
    'value' => $item['attachment_dl_notify'],
    ));

    return false;
}

function xnpsimulatorGetListBlock($item_basic)
{
    // get uid
    global $xoopsUser;
    $myuid = is_object($xoopsUser) ? $xoopsUser->getVar('uid', 'n') : UID_GUEST;

    // set to template
    global $xoopsTpl;

    $tpl = new XoopsTpl();
    // copy variables in $xoopsTpl to $tpl
    $tpl->assign($xoopsTpl->get_template_vars());

    $xnpsimulator_handler = &xoonips_getormcompohandler('xnpsimulator', 'item');
    $tpl->assign('xoonips_item', $xnpsimulator_handler->getTemplateVar(XOONIPS_TEMPLATE_TYPE_ITEM_LIST, $item_basic['item_id'], $myuid));

    // return as HTML
    return $tpl->fetch('db:xnpsimulator_list_block.html');
}

function xnpsimulatorGetPrinterFriendlyListBlock($item_basic)
{
    return xnpsimulatorGetListBlock($item_basic);
}

function xnpsimulatorGetDetailBlock($item_id)
{
    // get uid
    global $xoopsUser;
    $myuid = is_object($xoopsUser) ? $xoopsUser->getVar('uid', 'n') : UID_GUEST;

    global $xoopsTpl;

    // get DetailInformation
    $detail_handler = &xoonips_getormhandler('xnpsimulator', 'item_detail');
    $detail_orm = &$detail_handler->get($item_id);
    if (!$detail_orm) {
        return '';
    }

    // set to template
    $tpl = new XoopsTpl();
    // copy variables in $xoopsTpl to $tpl
    $tpl->assign($xoopsTpl->get_template_vars());

    $tpl->assign('editable', xnp_get_item_permission($_SESSION['XNPSID'], $item_id, OP_MODIFY));
    $tpl->assign('basic', xnpGetBasicInformationDetailBlock($item_id));
    $tpl->assign('index', xnpGetIndexDetailBlock($item_id));
    $tpl->assign('preview', xnpGetPreviewDetailBlock($item_id));
    $tpl->assign('simulator_data', xnpGetAttachmentDetailBlock($item_id, 'simulator_data'));
    $tpl->assign('readme', xnpGetTextFileDetailBlock($item_id, 'readme', $detail_orm->getVar('readme', 'n')));
    $tpl->assign('rights', xnpGetRightsDetailBlock($item_id, $detail_orm->getVar('use_cc', 'n'), $detail_orm->getVar('rights', 'n'), $detail_orm->getVar('cc_commercial_use', 'n'), $detail_orm->getVar('cc_modification', 'n')));

    $xnpsimulator_handler = &xoonips_getormcompohandler('xnpsimulator', 'item');
    $tpl->assign('xoonips_item', $xnpsimulator_handler->getTemplateVar(XOONIPS_TEMPLATE_TYPE_ITEM_DETAIL, $item_id, $myuid));

    // return as HTML
    return $tpl->fetch('db:xnpsimulator_detail_block.html');
}

function xnpsimulatorGetDownloadConfirmationBlock($item_id, $download_file_id)
{
    $detail = xnpsimulatorGetDetailInformation($item_id);

    return xnpGetDownloadConfirmationBlock($item_id, $download_file_id, $detail['attachment_dl_notify']['value'], true, $detail['use_cc']['value'], $detail['cc_commercial_use']['value'], $detail['cc_modification']['value'], $detail['rights']['value']);
}

function xnpsimulatorGetDownloadConfirmationRequired($item_id)
{
    return true;
}

function xnpsimulatorGetPrinterFriendlyDetailBlock($item_id)
{
    // get uid
    global $xoopsUser;
    $myuid = is_object($xoopsUser) ? $xoopsUser->getVar('uid', 'n') : UID_GUEST;

    global $xoopsTpl;

    // get DetailInformation
    $detail_handler = &xoonips_getormhandler('xnpsimulator', 'item_detail');
    $detail_orm = &$detail_handler->get($item_id);
    if (!$detail_orm) {
        return '';
    }

    // set to template
    $tpl = new XoopsTpl();
    // copy variables in $xoopsTpl to $tpl
    $tpl->assign($xoopsTpl->get_template_vars());

    $tpl->assign('editable', xnp_get_item_permission($_SESSION['XNPSID'], $item_id, OP_MODIFY));
    $tpl->assign('basic', xnpGetBasicInformationPrinterFriendlyBlock($item_id));
    $tpl->assign('index', xnpGetIndexPrinterFriendlyBlock($item_id));
    $tpl->assign('preview', xnpGetPreviewPrinterFriendlyBlock($item_id));
    $tpl->assign('simulator_data', xnpGetAttachmentPrinterFriendlyBlock($item_id, 'simulator_data'));
    $tpl->assign('readme', xnpGetTextFilePrinterFriendlyBlock($item_id, 'readme', $detail_orm->getVar('readme', 'n')));
    $tpl->assign('rights', xnpGetRightsPrinterFriendlyBlock($item_id, $detail_orm->getVar('use_cc', 'n'), $detail_orm->getVar('rights', 'n'), $detail_orm->getVar('cc_commercial_use', 'n'), $detail_orm->getVar('cc_modification', 'n')));

    $xnpsimulator_handler = &xoonips_getormcompohandler('xnpsimulator', 'item');
    $tpl->assign('xoonips_item', $xnpsimulator_handler->getTemplateVar(XOONIPS_TEMPLATE_TYPE_ITEM_DETAIL, $item_id, $myuid));

    // return as HTML
    return $tpl->fetch('db:xnpsimulator_detail_block.html');
}

function xnpsimulatorGetRegisterBlock()
{
    $formdata = &xoonips_getutility('formdata');

    // retrieve detail information
    $detail = array();
    $simulator_types = xnpsimulator_get_type_array();
    $post_id = $formdata->getValue('get', 'post_id', 's', false);
    if (is_null($post_id)) {
        $simulator_type = false;
    } else {
        $simulator_type = $formdata->getValue('post', 'simulator_type', 's', false);
    }
    if (false == $simulator_type) {
        $simulator_type = array_key_first($simulator_types);
    }
    $detail['simulator_type'] = array(
    'value' => $simulator_type,
    'display_value' => $simulator_types[$simulator_type],
    'select' => $simulator_types,
    );

    // retrieve blocks of BasicInformation / Preview / Readme / License / index
    $basic = xnpGetBasicInformationRegisterBlock();
    $preview = xnpGetPreviewRegisterBlock();
    $index = xnpGetIndexRegisterBlock();
    $attachment = xnpGetAttachmentRegisterBlock('simulator_data');
    $readme = xnpGetTextFileRegisterBlock('readme');
    $rights = xnpGetRightsRegisterBlock();

    // assign to template
    global $xoopsTpl;

    $tpl = new XoopsTpl();
    // variables assigned to xoopsTpl are copied to tpl
    $tpl->assign($xoopsTpl->get_template_vars());

    $tpl->assign('basic', $basic);
    $tpl->assign('preview', $preview);
    $tpl->assign('index', $index);
    $tpl->assign('attachment', $attachment);
    $tpl->assign('attachment_dl_limit', xnpGetDownloadLimitationOptionRegisterBlock('xnpsimulator'));
    $tpl->assign('attachment_dl_notify', xnpGetDownloadNotificationOptionRegisterBlock('xnpsimulator'));
    $tpl->assign('detail', $detail);
    $tpl->assign('readme', $readme);
    $tpl->assign('rights', $rights);
    if (isset($simulator_date)) {
        $tpl->assign('gmtime', mktime(0, 0, 0, $simulator_date['Date_Month'], $simulator_date['Date_Day'], $simulator_date['Date_Year']));
    } else {
        $tpl->assign('gmtime', time());
    }
    $tpl->assign('xnpsimulator_developer', xoonips_get_multiple_field_template_vars(xoonips_get_orm_from_post('xnpsimulator', 'developer'), 'xnpsimulator', 'developer'));

    // return HTML content
    return $tpl->fetch('db:xnpsimulator_register_block.html');
}

function xnpsimulatorGetEditBlock($item_id)
{
    $formdata = &xoonips_getutility('formdata');

    // retrieve detail information
    $detail = xnpsimulatorGetDetailInformation($item_id);
    $simulator_types = xnpsimulator_get_type_array();
    $post_id = $formdata->getValue('get', 'post_id', 's', false);
    if (!is_null($post_id)) {
        $simulator_type = $formdata->getValue('post', 'simulator_type', 's', false);
        if (false == $simulator_type) {
            $simulator_type = array_key_first($simulator_types);
        }
        $detail['simulator_type'] = array(
        'value' => $simulator_type,
        'display_value' => $simulator_types[$simulator_type],
        'select' => $simulator_types,
        );
    }

    // retrieve blocks of BasicInformation / Preview / index block
    $basic = xnpGetBasicInformationEditBlock($item_id);

    $preview = xnpGetPreviewEditBlock($item_id);
    $index = xnpGetIndexEditBlock($item_id);
    $attachment = xnpGetAttachmentEditBlock($item_id, 'simulator_data');

    $readme = xnpGetTextFileEditBlock($item_id, 'readme', $detail['readme']['value']);
    $rights = xnpGetRightsEditBlock($item_id, $detail['use_cc']['value'], $detail['rights']['value'], $detail['cc_commercial_use']['value'], $detail['cc_modification']['value']);

    // assign to template
    global $xoopsTpl;

    $tpl = new XoopsTpl();
    // variables assigned to xoopsTpl are copied to tpl
    $tpl->assign($xoopsTpl->get_template_vars());

    $tpl->assign('basic', $basic);
    $tpl->assign('preview', $preview);
    $tpl->assign('index', $index);
    $tpl->assign('attachment', $attachment);
    $tpl->assign('attachment_dl_limit', xnpGetDownloadLimitationOptionEditBlock('xnpsimulator', xnpsimulatorGetAttachmentDownloadLimitOption($item_id)));
    $tpl->assign('attachment_dl_notify', xnpGetDownloadNotificationOptionEditBlock('xnpsimulator', xnpsimulatorGetAttachmentDownloadNotifyOption($item_id)));
    $tpl->assign('detail', $detail);
    $tpl->assign('readme', $readme);
    $tpl->assign('rights', $rights);

    if (!$formdata->getValue('get', 'post_id', 's', false)) {
        $detail_handler = &xoonips_getormhandler('xnpsimulator', 'item_detail');
        $detail_orm = &$detail_handler->get($item_id);
        $tpl->assign('xnpsimulator_developer', xoonips_get_multiple_field_template_vars($detail_orm->getDevelopers(), 'xnpsimulator', 'developer'));
    } else {
        $tpl->assign('xnpsimulator_developer', xoonips_get_multiple_field_template_vars(xoonips_get_orm_from_post('xnpsimulator', 'developer'), 'xnpsimulator', 'developer'));
    }

    // return HTML content
    return $tpl->fetch('db:xnpsimulator_register_block.html');
}

function xnpsimulatorGetConfirmBlock($item_id)
{
    $textutil = &xoonips_getutility('text');
    $formdata = &xoonips_getutility('formdata');
    $developer_handler = &xoonips_getormhandler('xnpsimulator', 'developer');
    $developer_objs = &$formdata->getObjectArray('post', $developer_handler->getTableName(), $developer_handler, false);

    // retrive detail information
    $detail = array();
    $simulator_type = $formdata->getValue('post', 'simulator_type', 's', false);
    if (false !== $simulator_type) {
        $simulator_types = xnpsimulator_get_type_array();
        $detail['simulator_type'] = array(
        'value' => $textutil->html_special_chars($simulator_type),
        'display_value' => $textutil->html_special_chars($simulator_types[$simulator_type]),
        );
    }

    // retrieve blocks of BasicInformation / Preview / index block
    $basic = xnpGetBasicInformationConfirmBlock($item_id);
    xnpConfirmHtml($detail, 'xnpsimulator_item_detail', array_keys($detail), _CHARSET);
    $preview = xnpGetPreviewConfirmBlock($item_id);
    $attachment = xnpGetAttachmentConfirmBlock($item_id, 'simulator_data');
    $index = xnpGetIndexConfirmBlock($item_id);
    $lengths = xnpGetColumnLengths('xnpsimulator_item_detail');
    $readme = xnpGetTextFileConfirmBlock($item_id, 'readme', $lengths['readme']);
    $rights = xnpGetRightsConfirmBlock($item_id, $lengths['rights']);

    if (xnpHasWithout($basic) || xnpHasWithout($detail) || xnpHasWithout($preview) || xnpHasWithout($attachment) || xnpHasWithout($readme) || xnpHasWithout($rights) || xoonips_is_multiple_field_too_long($developer_objs, 'xnpsimulator', 'developer')) {
        global $system_message;
        $system_message = $system_message."\n<br /><font color='#ff0000'>"._MD_XOONIPS_ITEM_WARNING_FIELD_TRIM.'</font><br />';
    }

    // assign to template
    global $xoopsTpl;

    $tpl = new XoopsTpl();
    // variables assigned to xoopsTpl are copied to tpl
    $tpl->assign($xoopsTpl->get_template_vars());

    $tpl->assign('basic', $basic);
    $tpl->assign('preview', $preview);
    $tpl->assign('index', $index);
    $tpl->assign('attachment', $attachment);
    $tpl->assign('attachment_dl_limit', xnpGetDownloadLimitationOptionConfirmBlock('xnpsimulator'));
    $tpl->assign('attachment_dl_notify', xnpGetDownloadNotificationOptionConfirmBlock('xnpsimulator'));
    $tpl->assign('detail', $detail);
    $tpl->assign('readme', $readme);
    $tpl->assign('rights', $rights);
    if (isset($simulator_date)) {
        $tpl->assign('simulator_date', $simulator_date);
        if ($simulator_date['Date_Year']) {
            $tpl->assign('system_message', $tpl->get_template_vars('system_message').'<br/><font color=\'#ff0000\'>'._MD_XOONIPS_ITEM_TITLE_REQUIRED.'</font>');
        }
    }
    $tpl->assign('xnpsimulator_developer', xoonips_get_multiple_field_template_vars($developer_objs, 'xnpsimulator', 'developer'));

    // return HTML content
    return $tpl->fetch('db:xnpsimulator_confirm_block.html');
}

function xnpsimulatorInsertItem(&$item_id)
{
    global $xoopsDB;
    $formdata = &xoonips_getutility('formdata');

    $xnpsid = $_SESSION['XNPSID'];

    // retister BasicInformation, Index and Attachment
    $item_id = 0;
    $result = xnpInsertBasicInformation($item_id);
    if ($result) {
        $result = xnpUpdateIndex($item_id);
        if ($result) {
            $result = xnpUpdatePreview($item_id);
            if ($result) {
                $result = xnpUpdateAttachment($item_id, 'simulator_data');
                if ($result) {
                }
            }
        }
        if (!$result) {
            xnpDeleteBasicInformation($xnpsid, $item_id);
        }
    }
    if (!$result) {
        return false;
    }

    // register detail information
    list($rights, $use_cc, $cc_commercial_use, $cc_modification) = xnpGetRights();

    // it makes string with constant length
    $ar = array(
    'simulator_type' => $formdata->getValue('post', 'simulator_type', 's', false),
    'readme' => xnpGetTextFile('readme'),
    'rights' => $rights,
    );
    xnpTrimColumn($ar, 'xnpsimulator_item_detail', array_keys($ar), _CHARSET);

    $keys = implode(',', array('simulator_type', 'readme', 'rights', 'use_cc', 'cc_commercial_use', 'cc_modification', 'attachment_dl_limit', 'attachment_dl_notify'));
    $attachment_dl_limit = $formdata->getValue('post', 'attachment_dl_limit', 'i', false);
    $attachment_dl_notify = $formdata->getValue('post', 'attachment_dl_notify', 'i', false);
    $vals = implode('\',\'', array(addslashes($ar['simulator_type']), addslashes($ar['readme']), addslashes($ar['rights']), $use_cc, $cc_commercial_use, $cc_modification, $attachment_dl_limit, $attachment_dl_limit ? $attachment_dl_notify : 0));

    $sql = 'insert into '.$xoopsDB->prefix('xnpsimulator_item_detail')." ( simulator_id, $keys ) values ( $item_id, '$vals' ) ";
    $result = $xoopsDB->queryF($sql);
    if (false == $result) {
        echo 'cannot insert item_detail: '.$xoopsDB->error();

        return false;
    }

    // insert developer
    $formdata = &xoonips_getutility('formdata');
    $developer_handler = &xoonips_getormhandler('xnpsimulator', 'developer');
    $developer_objs = &$formdata->getObjectArray('post', $developer_handler->getTableName(), $developer_handler, false);
    if (!$developer_handler->updateAllObjectsByForeignKey('simulator_id', $item_id, $developer_objs)) {
        return false;
    }

    return true;
}

function xnpsimulatorUpdateItem($simulator_id)
{
    global $xoopsDB;
    $formdata = &xoonips_getutility('formdata');

    $xnpsid = $_SESSION['XNPSID'];

    // modify BasicInformation, Index, Preview and Attachment.
    $result = xnpUpdateBasicInformation($simulator_id);
    if ($result) {
        $result = xnpUpdateIndex($simulator_id);
        if ($result) {
            $result = xnpUpdatePreview($simulator_id);
            if ($result) {
                $result = xnpUpdateAttachment($simulator_id, 'simulator_data');
                if ($result) {
                    $result = xnp_insert_change_log($xnpsid, $simulator_id, $formdata->getValue('post', 'change_log', 's', false));
                    $result = !$result;
                    if (!$result) {
                        echo ' xnp_insert_change_log failed.';
                    }
                } else {
                    echo ' xnpUpdateAttachment failed.';
                }
            } else {
                echo ' xnpUpdatePreview failed.';
            }
        } else {
            echo ' xnpUpdateIndex failed.';
        }
    } else {
        echo ' xnpUpdateBasicInformation failed.';
    }
    if (!$result) {
        return false;
    }

    list($rights, $use_cc, $cc_commercial_use, $cc_modification) = xnpGetRights();

    // it makes string with constant length
    $ar = array(
    'simulator_type' => $formdata->getValue('post', 'simulator_type', 's', false),
    'readme' => xnpGetTextFile('readme'),
    'rights' => $rights,
    );
    xnpTrimColumn($ar, 'xnpsimulator_item_detail', array_keys($ar), _CHARSET);
    $attachment_dl_limit = $formdata->getValue('post', 'attachment_dl_limit', 'i', false);
    $attachment_dl_notify = $formdata->getValue('post', 'attachment_dl_notify', 'i', false);
    $keyval = array(
    'simulator_type=\''.addslashes($ar['simulator_type']).'\'',
    'readme=\''.addslashes($ar['readme']).'\'',
    'rights=\''.addslashes($ar['rights']).'\'',
    'use_cc=\''.$use_cc.'\'',
    'cc_commercial_use=\''.$cc_commercial_use.'\'',
    'cc_modification=\''.$cc_modification.'\'',
    'attachment_dl_limit'.'=\''.$attachment_dl_limit.'\'',
    'attachment_dl_notify'.'=\''.($attachment_dl_limit ? $attachment_dl_notify : 0).'\'',
    );

    // modify detail information
    $sql = 'update '.$xoopsDB->prefix('xnpsimulator_item_detail').' set '.implode(', ', $keyval)." where simulator_id=$simulator_id";
    $result = $xoopsDB->queryF($sql);
    if (false == $result) {
        echo 'cannot update item_detail';

        return false;
    }

    // insert/update developer
    $developer_handler = &xoonips_getormhandler('xnpsimulator', 'developer');
    $developer_objs = &$formdata->getObjectArray('post', $developer_handler->getTableName(), $developer_handler, false);
    if (!$developer_handler->updateAllObjectsByForeignKey('simulator_id', $simulator_id, $developer_objs)) {
        return false;
    }

    return true;
}

function xnpsimulatorGetSearchBlock($item_id)
{
    // todo: details to be defnied
}

function xnpsimulatorCheckRegisterParameters(&$msg)
{
    $formdata = &xoonips_getutility('formdata');
    $xnpsid = $_SESSION['XNPSID'];
    $result = true;
    $developer = xoonips_get_multi_field_array_from_post('xnpsimulator', 'developer');
    $simulator_data = $formdata->getFile('simulator_data', false);
    $simulator_dataFileID = $formdata->getValue('post', 'simulator_dataFileID', 'i', false);
    $xoonipsCheckedXID = $formdata->getValue('post', 'xoonipsCheckedXID', 's', false);

    if (empty($developer)) {
        // developer is not filled
        $msg = $msg.'<br/><font color=\'#ff0000\'>'._MD_XNPSIMULATOR_DEVELOPER_REQUIRED.'</font>';
        $result = false;
    }
    if ((empty($simulator_data) || '' == $simulator_data['name']) && '' == $simulator_dataFileID) {
        // simulator_data is not filled
        $msg = $msg.'<br/><font color=\'#ff0000\'>'._MD_XNPSIMULATOR_SIMULATOR_FILE_REQUIRED.'</font>';
        $result = false;
    }
    // notify that license statement is required when register into public indexes.
    $xids = explode(',', $xoonipsCheckedXID);
    $indexes = array();
    if ($xids[0] != $xoonipsCheckedXID) {
        foreach ($xids as $i) {
            $index = array();
            if (RES_OK == xnp_get_index($xnpsid, $i, $index)) {
                $indexes[] = $index;
            } else {
                $msg = $msg.'<br/><font color=\'#ff0000\'>'.xnp_get_last_error_string().'</font>';
                $result = false;
                break;
            }
        }
    }
    if (count($indexes) > 0) {
        foreach ($indexes as $i) {
            if ($i['open_level'] <= OL_GROUP_ONLY) {
                $readmeEncText = $formdata->getValue('post', 'readmeEncText', 's', false);
                $rightsEncText = $formdata->getValue('post', 'rightsEncText', 's', false);
                $rightsUseCC = $formdata->getValue('post', 'rightsUseCC', 'i', false);
                if ('' == $readmeEncText) {
                    // readme is not filled
                    $msg = $msg.'<br/><font color=\'#ff0000\'>'._MD_XNPSIMULATOR_README_REQUIRED.'</font>';
                    $result = false;
                }
                if ('' == $rightsEncText && '0' == $rightsUseCC) {
                    // license is not filled
                    $msg = $msg.'<br/><font color=\'#ff0000\'>'._MD_XNPSIMULATOR_RIGHTS_REQUIRED.'</font>';
                    $result = false;
                }
                break;
            }
        }
    }

    return $result;
}

function xnpsimulatorCheckEditParameters(&$msg)
{
    return xnpsimulatorCheckRegisterParameters($msg);
}

function xnpsimulatorGetMetaInformation($item_id)
{
    $ret = array();
    $developer_array = array();

    $basic = xnpGetBasicInformationArray($item_id);
    $detail = xnpsimulatorGetDetailInformation($item_id);

    if (!empty($basic)) {
        $ret[_MD_XOONIPS_ITEM_TITLE_LABEL] = implode("\n", $basic['titles']);
        $ret[_MD_XOONIPS_ITEM_CONTRIBUTOR_LABEL] = $basic['contributor'];
        $ret[_MD_XOONIPS_ITEM_KEYWORDS_LABEL] = implode("\n", $basic['keywords']);
        $ret[_MD_XOONIPS_ITEM_DESCRIPTION_LABEL] = $basic['description'];
        $ret[_MD_XOONIPS_ITEM_DOI_LABEL] = $basic['doi'];
        $ret[_MD_XOONIPS_ITEM_LAST_UPDATE_DATE_LABEL] = $basic['last_update_date'];
        $ret[_MD_XOONIPS_ITEM_CREATION_DATE_LABEL] = $basic['creation_date'];
        $ret[_MD_XNPSIMULATOR_DATE_LABEL] = xnpDate($basic['publication_year'], $basic['publication_month'], $basic['publication_mday']);
    }
    if (!empty($detail)) {
        $ret[_MD_XNPSIMULATOR_SIMULATOR_TYPE_LABEL] = $detail['simulator_type']['display_value'];
        $ret[_MD_XOONIPS_ITEM_README_LABEL] = $detail['readme']['value'];
        $ret[_MD_XOONIPS_ITEM_RIGHTS_LABEL] = $detail['rights']['value'];
    }

    $xnpsimulator_handler = &xoonips_getormcompohandler('xnpsimulator', 'item');
    $xnpsimulator = &$xnpsimulator_handler->get($item_id);
    foreach ($xnpsimulator->getVar('developer') as $developer) {
        $developer_array[] = $developer->getVar('developer', 'n');
    }
    $ret[_MD_XNPSIMULATOR_DEVELOPER_LABEL] = implode("\n", $developer_array);

    return $ret;
}

function xnpsimulatorGetAdvancedSearchBlock(&$search_var)
{
    $basic = xnpGetBasicInformationAdvancedSearchBlock('xnpsimulator', $search_var);

    $search_var[] = 'xnpsimulator_simulator_type';
    $search_var[] = 'xnpsimulator_developer';
    $search_var[] = 'xnpsimulator_caption';

    // assign to template
    global $xoopsTpl;

    $tpl = new XoopsTpl();
    // variables assigned to xoopsTpl are copied to tpl
    $tpl->assign($xoopsTpl->get_template_vars());
    $tpl->assign('basic', $basic);
    $tpl->assign('module_name', 'xnpsimulator');
    $simulator_type = xnpsimulator_get_type_array();
    $tpl->assign('simulator_type_option', $simulator_type);
    $tpl->assign('module_display_name', xnpGetItemTypeDisplayNameByDirname(basename(dirname(__DIR__)), 's'));

    // return HTML content
    return $tpl->fetch('db:xnpsimulator_search_block.html');
}

function xnpsimulatorGetAdvancedSearchQuery(&$where, &$join)
{
    global $xoopsDB;
    $simulator_table = $xoopsDB->prefix('xnpsimulator_item_detail');
    $simulator_developer_table = $xoopsDB->prefix('xnpsimulator_developer');
    $file_table = $xoopsDB->prefix('xoonips_file');

    $wheres = array();
    $joins = array();
    $w = xnpGetBasicInformationAdvancedSearchQuery('xnpsimulator');
    if ($w) {
        $wheres[] = $w;
    }
    $w = xnpGetKeywordQuery($simulator_table.'.simulator_type', 'xnpsimulator_simulator_type');
    if ($w) {
        $wheres[] = $w;
    }
    $w = xnpGetKeywordQuery($simulator_developer_table.'.developer', 'xnpsimulator_developer');
    if ($w) {
        $wheres[] = $w;
    }
    $w = xnpGetKeywordQuery($file_table.'.caption', 'xnpsimulator_caption');
    if ($w) {
        $wheres[] = $w;
        $wheres[] = " $file_table.file_type_id = 1";
    }
    $where = implode(' and ', $wheres);
    $join = " join $simulator_developer_table on ".$simulator_developer_table.'.simulator_id  = '.$xoopsDB->prefix('xoonips_item_basic').'.item_id ';
}

function xnpsimulatorGetDetailInformationQuickSearchQuery(&$wheres, &$join, $keywords)
{
    global $xoopsDB;
    $simulator_table = $xoopsDB->prefix('xnpsimulator_item_detail');
    $simulator_developer_table = $xoopsDB->prefix('xnpsimulator_developer');
    $file_table = $xoopsDB->prefix('xoonips_file');

    $colnames = array(
    "$simulator_developer_table.developer",
    "$file_table.caption",
    );
    $wheres = xnpGetKeywordsQueries($colnames, $keywords);
    $join = " join $simulator_developer_table on ".$simulator_developer_table.'.simulator_id  = '.$xoopsDB->prefix('xoonips_item_basic').'.item_id ';

    return true;
}

function xnpsimulatorGetDetailInformationTotalSize($iids)
{
    return xnpGetTotalFileSize($iids);
}

function xnpsimulatorGetLicenseRequired($item_id)
{
    global $xoopsDB;

    // retrieve detail information
    $result = $xoopsDB->query('select * from '.$xoopsDB->prefix('xnpsimulator_item_detail')." where simulator_id=$item_id");
    if (!$result) {
        return null;
    }
    $detail = $xoopsDB->fetchArray($result);

    return isset($detail['rights']) && (1 == $detail['use_cc'] || '' != $detail['rights']);
}

function xnpsimulatorGetLicenseStatement($item_id)
{
    global $xoopsDB;

    // retrieve detail information
    $result = $xoopsDB->query('select * from '.$xoopsDB->prefix('xnpsimulator_item_detail')." where simulator_id=$item_id");
    if (!$result) {
        return null;
    }
    $detail = $xoopsDB->fetchArray($result);

    return isset($detail['rights']) ? array($detail['rights'], $detail['use_cc'], $detail['cc_commercial_use'], $detail['cc_modification']) : array('', 0, 0, 0);
}

/**
 * create XML for expoting detail information.
 *
 * @see xnpExportItem
 *
 * @param string   $export_path folder that export file is written to
 * @param resource $fhdl        handle that items are exported to
 * @param int      $item_id     item id that is exported
 * @param bool     $attachment  true if attachement files are exported, else false
 *
 * @return bool false if failure
 */
function xnpsimulatorExportItem($export_path, $fhdl, $item_id, $attachment)
{
    // get DetailInformation
    if (!$fhdl) {
        return false;
    }

    $handler = &xoonips_getormhandler('xnpsimulator', 'item_detail');
    $detail = &$handler->get($item_id);
    if (!$detail) {
        return false;
    }

    $developers = '';
    foreach ($detail->getDevelopers() as $developer) {
        $developers .= '<developer>'.$developer->getVar('developer', 's').'</developer>';
    }

    if (!fwrite($fhdl, "<detail id=\"${item_id}\" version=\"1.03\">\n".'<simulator_type>'.$detail->getVar('simulator_type', 's')."</simulator_type>\n"."<developers>{$developers}</developers>\n".'<readme>'.$detail->getVar('readme', 's')."</readme>\n".'<rights>'.$detail->getVar('rights', 's')."</rights>\n".'<use_cc>'.intval($detail->get('use_cc', 's'))."</use_cc>\n".'<cc_commercial_use>'.intval($detail->get('cc_commercial_use'))."</cc_commercial_use>\n".'<cc_modification>'.intval($detail->get('cc_modification'))."</cc_modification>\n".'<attachment_dl_limit>'.intval($detail->get('attachment_dl_limit'))."</attachment_dl_limit>\n".'<attachment_dl_notify>'.intval($detail->get('attachment_dl_notify'))."</attachment_dl_notify>\n")) {
        return false;
    }
    if (!($attachment ? xnpExportFile($export_path, $fhdl, $item_id) : true)) {
        return false;
    }
    if (!fwrite($fhdl, "</detail>\n")) {
        return false;
    }

    return true;
}

function xnpsimulatorGetModifiedFields($item_id)
{
    $ret = array();
    $formdata = &xoonips_getutility('formdata');
    $basic = xnpGetBasicInformationArray($item_id);
    if ($basic) {
        $publicationDateYear = $formdata->getValue('post', 'publicationDateYear', 'i', false);
        $publicationDateMonth = $formdata->getValue('post', 'publicationDateMonth', 'i', false);
        $publicationDateDay = $formdata->getValue('post', 'publicationDateDay', 'i', false);
        if (intval($basic['publication_month']) != intval($publicationDateMonth) || intval($basic['publication_mday']) != intval($publicationDateDay) || intval($basic['publication_year']) != intval($publicationDateYear)) {
            array_push($ret, _MD_XNPSIMULATOR_DATE_LABEL);
        }
    }
    $detail = xnpsimulatorGetDetailInformation($item_id);
    if ($detail) {
        foreach (array('simulator_type' => _MD_XNPSIMULATOR_SIMULATOR_TYPE) as $k => $v) {
            $tmp = $formdata->getValue('post', $k, 's', false);
            if (!array_key_exists($k, $detail) || null === $tmp) {
                continue;
            }
            if ($detail[$k]['value'] != $tmp) {
                array_push($ret, $v);
            }
        }
        // is readme modified ?
        foreach (array('readme' => _MD_XOONIPS_ITEM_README_LABEL) as $k => $v) {
            $tmp = $formdata->getValue('post', "${k}EncText", 's', false);
            if (!array_key_exists($k, $detail) || null === $tmp) {
                continue;
            }
            if ($detail[$k]['value'] != $tmp) {
                array_push($ret, $v);
            }
        }

        // is rights modified ?
        $rightsUseCC = $formdata->getValue('post', 'rightsUseCC', 'i', false);
        $rightsEncText = $formdata->getValue('post', 'rightsEncText', 's', false);
        if (null !== $rightsUseCC) {
            if ($rightsUseCC != $detail['use_cc']['value']) {
                array_push($ret, _MD_XOONIPS_ITEM_RIGHTS_LABEL);
            } else {
                if (0 == $rightsUseCC) {
                    if (array_key_exists('rights', $detail) && null != $rightsEncText && $rightsEncText != $detail['rights']['value']) {
                        array_push($ret, _MD_XOONIPS_ITEM_RIGHTS_LABEL);
                    }
                } elseif (1 == $rightsUseCC) {
                    foreach (array('rightsCCCommercialUse' => 'cc_commercial_use', 'rightsCCModification' => 'cc_modification') as $k => $v) {
                        $tmp = $formdata->getValue('post', $k, 'i', false);
                        if (!array_key_exists($v, $detail) || null === $tmp) {
                            continue;
                        }
                        if ($tmp != $detail[$v]['value']) {
                            array_push($ret, _MD_XOONIPS_ITEM_RIGHTS_LABEL);
                            break;
                        }
                    }
                }
            }
        }

        // is modified data files ?
        if (xnpIsAttachmentModified('simulator_data', $item_id)) {
            array_push($ret, _MD_XNPSIMULATOR_SIMULATOR_FILE);
        }

        $developer_handler = &xoonips_getormhandler('xnpsimulator', 'developer');
        $developer_objs = &$formdata->getObjectArray('post', $developer_handler->getTableName(), $developer_handler, false);
        $detail_handler = &xoonips_getormhandler('xnpsimulator', 'item_detail');
        $detail_orm = &$detail_handler->get($item_id);
        $developer_old_objs = &$detail_orm->getDevelopers();
        if (!xoonips_is_same_objects($developer_old_objs, $developer_objs)) {
            array_push($ret, _MD_XNPSIMULATOR_DEVELOPER_LABEL);
        }
    }

    return $ret;
}

function xnpsimulatorGetTopBlock($itemtype)
{
    return xnpGetTopBlock($itemtype['name'], $itemtype['display_name'], 'images/icon_simulator.gif', _MD_XNPSIMULATOR_EXPLANATION, 'xnpsimulator_simulator_type', xnpsimulator_get_type_array());
}

// return 1 if downloadable for login user only
// return 0 if downloadable for everyone
function xnpsimulatorGetAttachmentDownloadLimitOption($item_id)
{
    global $xoopsDB;
    $sql = 'select attachment_dl_limit from '.$xoopsDB->prefix('xnpsimulator_item_detail')." where simulator_id=${item_id}";
    $result = $xoopsDB->query($sql);
    if ($result) {
        list($option) = $xoopsDB->fetchRow($result);

        return $option;
    }

    return 0;
}

// return 1 if downloading is notified
// return 0 if downloading is not notified
function xnpsimulatorGetAttachmentDownloadNotifyOption($item_id)
{
    global $xoopsDB;
    $sql = 'select attachment_dl_notify from '.$xoopsDB->prefix('xnpsimulator_item_detail')." where simulator_id=${item_id}";
    $result = $xoopsDB->query($sql);
    if ($result) {
        list($notify) = $xoopsDB->fetchRow($result);

        return $notify;
    }

    return 0;
}

function xnpsimulatorSupportMetadataFormat($metadataPrefix, $item_id)
{
    if ('oai_dc' == $metadataPrefix || 'junii2' == $metadataPrefix) {
        return true;
    }

    return false;
}

function xnpsimulatorGetMetadata($prefix, $item_id)
{
    $mydirpath = dirname(__DIR__);
    $mydirname = basename($mydirpath);
    if (!in_array($prefix, array('oai_dc', 'junii2'))) {
        return false;
    }
    // detail information
    $detail_handler = &xoonips_getormhandler($mydirname, 'item_detail');
    $developer_handler = &xoonips_getormhandler($mydirname, 'developer');
    $detail_obj = &$detail_handler->get($item_id);
    if (empty($detail_obj)) {
        return false;
    }
    $detail = $detail_obj->getArray();
    $criteria = new Criteria('simulator_id', $item_id);
    $criteria->setSort('developer_order');
    $developer_objs = &$developer_handler->getObjects($criteria);
    $detail['developers'] = array();
    foreach ($developer_objs as $developer_obj) {
        $detail['developers'][] = $developer_obj->get('developer');
    }
    $types = xnpsimulator_get_type_array();
    $detail['simulator_type_display'] = $types[$detail['simulator_type']];
    // basic information
    $basic = xnpGetBasicInformationArray($item_id);
    $basic['publication_date_iso8601'] = xnpISO8601($basic['publication_year'], $basic['publication_month'], $basic['publication_mday']);
    // indexes
    $indexes = array();
    if (RES_OK == xnp_get_index_id_by_item_id($_SESSION['XNPSID'], $item_id, $xids)) {
        foreach ($xids as $xid) {
            if (RES_OK == xnp_get_index($_SESSION['XNPSID'], $xid, $index)) {
                $indexes[] = xnpGetIndexPathServerString($_SESSION['XNPSID'], $xid);
            }
        }
    }
    // files
    $files = array();
    $mimetypes = array();
    $file_handler = &xoonips_gethandler('xoonips', 'file');
    if (0 == $detail['attachment_dl_limit']) {
        $files = $file_handler->getFilesInfo($item_id, 'simulator_data');
        foreach ($files as $file) {
            if (!in_array($file['mime_type'], $mimetypes)) {
                $mimetypes[] = $file['mime_type'];
            }
        }
    }
    $previews = $file_handler->getFilesInfo($item_id, 'preview');
    // rights
    $detail['rights_cc_url'] = '';
    if (1 == $detail['use_cc']) {
        $cond = 'by';
        if (0 == $detail['cc_commercial_use']) {
            $cond .= '-nc';
        }
        if (0 == $detail['cc_modification']) {
            $cond .= '-nd';
        } elseif (1 == $detail['cc_modification']) {
            $cond .= '-sa';
        }
        $detail['rights_cc_url'] = sprintf('http://creativecommons.org/licenses/%s/4.0/', $cond);
    }
    // related to
    $related_to_handler = &xoonips_getormhandler('xoonips', 'related_to');
    $related_to_ids = $related_to_handler->getChildItemIds($item_id);
    $related_tos = array();
    foreach ($related_to_ids as $related_to_id) {
        $related_tos[] = array(
        'item_id' => $related_to_id,
        'item_url' => XOOPS_URL.'/modules/xoonips/detail.php?item_id='.$related_to_id,
        );
    }
    // repository configs
    $xconfig_handler = &xoonips_getormhandler('xoonips', 'config');
    $myxoopsConfigMetaFooter = &xoonips_get_xoops_configs(XOOPS_CONF_METAFOOTER);
    $repository = array(
    'download_file_compression' => $xconfig_handler->getValue('download_file_compression'),
    'nijc_code' => $xconfig_handler->getValue('repository_nijc_code'),
    'publisher' => $xconfig_handler->getValue('repository_publisher'),
    'institution' => $xconfig_handler->getValue('repository_institution'),
    'meta_author' => $myxoopsConfigMetaFooter['meta_author'],
    );
    // assign template
    global $xoopsTpl;
    $tpl = new XoopsTpl();
    $tpl->plugins_dir[] = XOONIPS_PATH.'/class/smarty/plugins';
    $tpl->assign($xoopsTpl->get_template_vars());
    $tpl->assign('basic', $basic);
    $tpl->assign('detail', $detail);
    $tpl->assign('indexes', $indexes);
    $tpl->assign('files', $files);
    $tpl->assign('mimetypes', $mimetypes);
    $tpl->assign('previews', $previews);
    $tpl->assign('related_tos', $related_tos);
    $tpl->assign('repository', $repository);
    $xml = $tpl->fetch('db:'.$mydirname.'_oaipmh_'.$prefix.'.xml');

    return $xml;
}
