mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-13 15:34:12 +01:00
6859326646
Also fixed the display/download links on documents that were both doing exactly the same thing ! SVN:trunk[1443]
418 lines
15 KiB
PHP
418 lines
15 KiB
PHP
<?php
|
|
// Copyright (C) 2010 Combodo SARL
|
|
//
|
|
// 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; version 3 of the License.
|
|
//
|
|
// 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
|
|
|
|
/**
|
|
* Specific to the interactive csv import
|
|
*
|
|
* @author Erwan Taloc <erwan.taloc@combodo.com>
|
|
* @author Romain Quetiez <romain.quetiez@combodo.com>
|
|
* @author Denis Flaven <denis.flaven@combodo.com>
|
|
* @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
|
|
*/
|
|
|
|
require_once('../approot.inc.php');
|
|
require_once(APPROOT.'/application/application.inc.php');
|
|
require_once(APPROOT.'/application/webpage.class.inc.php');
|
|
require_once(APPROOT.'/application/ajaxwebpage.class.inc.php');
|
|
require_once(APPROOT.'/application/wizardhelper.class.inc.php');
|
|
require_once(APPROOT.'/application/ui.linkswidget.class.inc.php');
|
|
require_once(APPROOT.'/application/csvpage.class.inc.php');
|
|
|
|
/**
|
|
* Determines if the name of the field to be mapped correspond
|
|
* to the name of an external key or an Id of the given class
|
|
* @param string $sClassName The name of the class
|
|
* @param string $sFieldCode The attribute code of the field , or empty if no match
|
|
* @return bool true if the field corresponds to an id/External key, false otherwise
|
|
*/
|
|
function IsIdField($sClassName, $sFieldCode)
|
|
{
|
|
$bResult = false;
|
|
if (!empty($sFieldCode))
|
|
{
|
|
if ($sFieldCode == 'id')
|
|
{
|
|
$bResult = true;
|
|
}
|
|
else if (strpos($sFieldCode, '->') === false)
|
|
{
|
|
$oAttDef = MetaModel::GetAttributeDef($sClassName, $sFieldCode);
|
|
$bResult = $oAttDef->IsExternalKey();
|
|
}
|
|
}
|
|
return $bResult;
|
|
}
|
|
|
|
/**
|
|
* Get all the fields xxx->yyy based on the field xxx which is an external key
|
|
* @param string $sExtKeyAttCode Attribute code of the external key
|
|
* @param AttributeDefinition $oExtKeyAttDef Attribute definition of the external key
|
|
* @param bool $bAdvanced True if advanced mode
|
|
* @return Ash List of codes=>display name: xxx->yyy where yyy are the reconciliation keys for the object xxx
|
|
*/
|
|
function GetMappingsForExtKey($sAttCode, AttributeDefinition $oExtKeyAttDef, $bAdvanced)
|
|
{
|
|
$aResult = array();
|
|
$sTargetClass = $oExtKeyAttDef->GetTargetClass();
|
|
foreach(MetaModel::ListAttributeDefs($sTargetClass) as $sTargetAttCode => $oTargetAttDef)
|
|
{
|
|
if (MetaModel::IsReconcKey($sTargetClass, $sTargetAttCode))
|
|
{
|
|
$bExtKey = $oTargetAttDef->IsExternalKey();
|
|
$sSuffix = '';
|
|
if ($bExtKey)
|
|
{
|
|
$sSuffix = '->id';
|
|
}
|
|
if ($bAdvanced || !$bExtKey)
|
|
{
|
|
// When not in advanced mode do not allow to use reconciliation keys (on external keys) if they are themselves external keys !
|
|
$aResult[$sAttCode.'->'.$sTargetAttCode] = $oExtKeyAttDef->GetLabel().'->'.$oTargetAttDef->GetLabel().$sSuffix;
|
|
}
|
|
}
|
|
}
|
|
return $aResult;
|
|
}
|
|
|
|
/**
|
|
* Helper function to build the mapping drop-down list for a field
|
|
* Spec: Possible choices are "writable" fields in this class plus external fields that are listed as reconciliation keys
|
|
* for any class pointed to by an external key in the current class.
|
|
* If not in advanced mode, all "id" fields (id and external keys) must be mapped to ":none:" (i.e -- ignore this field --)
|
|
* External fields that do not correspond to a reconciliation key must be mapped to ":none:"
|
|
* Otherwise, if a field equals either the 'code' or the 'label' (translated) of a field, then it's mapped automatically
|
|
* @param string $sClassName Name of the class used for the mapping
|
|
* @param string $sFieldName Name of the field, as it comes from the data file (header line)
|
|
* @param integer $iFieldIndex Number of the field in the sequence
|
|
* @param bool $bAdvancedMode Whether or not advanced mode was chosen
|
|
* @return string The HTML code corresponding to the drop-down list for this field
|
|
*/
|
|
function GetMappingForField($sClassName, $sFieldName, $iFieldIndex, $bAdvancedMode = false)
|
|
{
|
|
$aChoices = array('' => Dict::S('UI:CSVImport:MappingSelectOne'));
|
|
$aChoices[':none:'] = Dict::S('UI:CSVImport:MappingNotApplicable');
|
|
$sFieldCode = ''; // Code of the attribute, if there is a match
|
|
$aMatches = array();
|
|
if (preg_match('/^(.+)\*$/', $sFieldName, $aMatches))
|
|
{
|
|
// Remove any trailing "star" character.
|
|
// A star character at the end can be used to indicate a mandatory field
|
|
$sFieldName = $aMatches[1];
|
|
}
|
|
if ($sFieldName == 'id')
|
|
{
|
|
$sFieldCode = 'id';
|
|
}
|
|
if ($bAdvancedMode)
|
|
{
|
|
$aChoices['id'] = Dict::S('UI:CSVImport:idField');
|
|
}
|
|
foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
|
|
{
|
|
$sStar = '';
|
|
if ($oAttDef->IsExternalKey())
|
|
{
|
|
if ( ($sFieldName == $oAttDef->GetLabel()) || ($sFieldName == $sAttCode))
|
|
{
|
|
$sFieldCode = $sAttCode;
|
|
}
|
|
if ($bAdvancedMode)
|
|
{
|
|
$aChoices[$sAttCode] = $oAttDef->GetLabel();
|
|
}
|
|
$oExtKeyAttDef = MetaModel::GetAttributeDef($sClassName, $oAttDef->GetKeyAttCode());
|
|
if (!$oExtKeyAttDef->IsNullAllowed())
|
|
{
|
|
$sStar = '*';
|
|
}
|
|
// Get fields of the external class that are considered as reconciliation keys
|
|
$sTargetClass = $oAttDef->GetTargetClass();
|
|
foreach(MetaModel::ListAttributeDefs($sTargetClass) as $sTargetAttCode => $oTargetAttDef)
|
|
{
|
|
if (MetaModel::IsReconcKey($sTargetClass, $sTargetAttCode))
|
|
{
|
|
$bExtKey = $oTargetAttDef->IsExternalKey();
|
|
$sSuffix = '';
|
|
if ($bExtKey)
|
|
{
|
|
$sSuffix = '->id';
|
|
}
|
|
if ($bAdvancedMode || !$bExtKey)
|
|
{
|
|
|
|
// When not in advanced mode do not allow to use reconciliation keys (on external keys) if they are themselves external keys !
|
|
$aChoices[$sAttCode.'->'.$sTargetAttCode] = $oAttDef->GetLabel().'->'.$oTargetAttDef->GetLabel().$sSuffix.$sStar;
|
|
if ((strcasecmp($sFieldName, $oAttDef->GetLabel().'->'.$oTargetAttDef->GetLabel().$sSuffix) == 0) || (strcasecmp($sFieldName, ($sAttCode.'->'.$sTargetAttCode.$sSuffix)) == 0) )
|
|
{
|
|
$sFieldCode = $sAttCode.'->'.$sTargetAttCode;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
else if ($oAttDef->IsWritable() && (!$oAttDef->IsLinkset() || ($bAdvancedMode && $oAttDef->IsIndirect())))
|
|
{
|
|
|
|
if (!$oAttDef->IsNullAllowed())
|
|
{
|
|
$sStar = '*';
|
|
}
|
|
$aChoices[$sAttCode] = $oAttDef->GetLabel().$sStar;
|
|
if ( ($sFieldName == $oAttDef->GetLabel()) || ($sFieldName == $sAttCode))
|
|
{
|
|
$sFieldCode = $sAttCode;
|
|
}
|
|
}
|
|
}
|
|
asort($aChoices);
|
|
|
|
$sHtml = "<select id=\"mapping_{$iFieldIndex}\" name=\"field[$iFieldIndex]\">\n";
|
|
$bIsIdField = IsIdField($sClassName, $sFieldCode);
|
|
foreach($aChoices as $sAttCode => $sLabel)
|
|
{
|
|
$sSelected = '';
|
|
if ($bIsIdField && (!$bAdvancedMode)) // When not in advanced mode, ID are mapped to n/a
|
|
{
|
|
if ($sAttCode == ':none:')
|
|
{
|
|
$sSelected = ' selected';
|
|
}
|
|
}
|
|
else if (empty($sFieldCode) && (strpos($sFieldName, '->') !== false))
|
|
{
|
|
if ($sAttCode == ':none:')
|
|
{
|
|
$sSelected = ' selected';
|
|
}
|
|
}
|
|
else if ($sFieldCode == $sAttCode) // Otherwise map by default if there is a match
|
|
{
|
|
$sSelected = ' selected';
|
|
}
|
|
|
|
$sHtml .= "<option value=\"$sAttCode\"$sSelected>$sLabel</option>\n";
|
|
}
|
|
$sHtml .= "</select>\n";
|
|
return $sHtml;
|
|
}
|
|
|
|
try
|
|
{
|
|
require_once(APPROOT.'/application/startup.inc.php');
|
|
|
|
require_once(APPROOT.'/application/loginwebpage.class.inc.php');
|
|
LoginWebPage::DoLogin(); // Check user rights and prompt if needed
|
|
|
|
|
|
$sOperation = utils::ReadParam('operation', '');
|
|
|
|
switch($sOperation)
|
|
{
|
|
case 'parser_preview':
|
|
$oPage = new ajax_page("");
|
|
$oPage->no_cache();
|
|
$oPage->SetContentType('text/html');
|
|
$sSeparator = utils::ReadParam('separator', ',', false, 'raw_data');
|
|
if ($sSeparator == 'tab') $sSeparator = "\t";
|
|
$sTextQualifier = utils::ReadParam('qualifier', '"', false, 'raw_data');
|
|
$iLinesToSkip = utils::ReadParam('nb_lines_skipped', 0);
|
|
$bFirstLineAsHeader = utils::ReadParam('header_line', true);
|
|
$sEncoding = utils::ReadParam('encoding', 'UTF-8');
|
|
$sData = stripslashes(utils::ReadParam('csvdata', true, false, 'raw_data'));
|
|
$oCSVParser = new CSVParser($sData, $sSeparator, $sTextQualifier);
|
|
$aData = $oCSVParser->ToArray($iLinesToSkip);
|
|
$iTarget = count($aData);
|
|
if ($iTarget == 0)
|
|
{
|
|
$oPage->p(Dict::S('UI:CSVImport:NoData'));
|
|
}
|
|
else
|
|
{
|
|
$sMaxLen = (strlen(''.$iTarget) < 3) ? 3 : strlen(''.$iTarget); // Pad line numbers to the appropriate number of chars, but at least 3
|
|
$sFormat = '%0'.$sMaxLen.'d';
|
|
$oPage->p("<h3>".Dict::S('UI:Title:DataPreview')."</h3>\n");
|
|
$oPage->p("<div style=\"overflow-y:auto\" class=\"white\">\n");
|
|
$oPage->add("<table cellspacing=\"0\" style=\"overflow-y:auto\">");
|
|
$iMaxIndex= 10; // Display maximum 10 lines for the preview
|
|
$index = 1;
|
|
foreach($aData as $aRow)
|
|
{
|
|
$sCSSClass = 'csv_row'.($index % 2);
|
|
if ( ($bFirstLineAsHeader) && ($index == 1))
|
|
{
|
|
$oPage->add("<tr class=\"$sCSSClass\"><td style=\"border-left:#999 3px solid;padding-right:10px;padding-left:10px;\">".sprintf($sFormat, $index)."</td><th>");
|
|
$oPage->add(implode('</th><th>', $aRow));
|
|
$oPage->add("</th></tr>\n");
|
|
$iNbCols = count($aRow);
|
|
|
|
}
|
|
else
|
|
{
|
|
if ($index == 1) $iNbCols = count($aRow);
|
|
$oPage->add("<tr class=\"$sCSSClass\"><td style=\"border-left:#999 3px solid;padding-right:10px;padding-left:10px;\">".sprintf($sFormat, $index)."</td><td>");
|
|
$oPage->add(implode('</td><td>', $aRow));
|
|
$oPage->add("</td></tr>\n");
|
|
}
|
|
$index++;
|
|
if ($index > $iMaxIndex) break;
|
|
}
|
|
$oPage->add("</table>\n");
|
|
$oPage->add("</div>\n");
|
|
if($iNbCols == 1)
|
|
{
|
|
$oPage->p('<img src="../images/error.png"> '.Dict::S('UI:CSVImport:ErrorOnlyOneColumn'));
|
|
}
|
|
else
|
|
{
|
|
$oPage->p(' ');
|
|
}
|
|
}
|
|
break;
|
|
|
|
case 'display_mapping_form':
|
|
$oPage = new ajax_page("");
|
|
$oPage->no_cache();
|
|
$oPage->SetContentType('text/html');
|
|
$sSeparator = utils::ReadParam('separator', ',', false, 'raw_data');
|
|
$sTextQualifier = utils::ReadParam('qualifier', '"', false, 'raw_data');
|
|
$iLinesToSkip = utils::ReadParam('nb_lines_skipped', 0);
|
|
$bFirstLineAsHeader = utils::ReadParam('header_line', false);
|
|
$sData = stripslashes(utils::ReadParam('csvdata', '', false, 'raw_data'));
|
|
$sClassName = utils::ReadParam('class_name', '');
|
|
$bAdvanced = utils::ReadParam('advanced', false);
|
|
$sEncoding = utils::ReadParam('encoding', 'UTF-8');
|
|
$oCSVParser = new CSVParser($sData, $sSeparator, $sTextQualifier);
|
|
$aData = $oCSVParser->ToArray($iLinesToSkip);
|
|
$iTarget = count($aData);
|
|
if ($iTarget == 0)
|
|
{
|
|
$oPage->p(Dict::S('UI:CSVImport:NoData'));
|
|
}
|
|
else
|
|
{
|
|
$oPage->add("<table>");
|
|
$aFirstLine = $aData[0]; // Use the first row to determine the number of columns
|
|
$iStartLine = 0;
|
|
$iNbColumns = count($aFirstLine);
|
|
if ($bFirstLineAsHeader)
|
|
{
|
|
$iStartLine = 1;
|
|
foreach($aFirstLine as $sField)
|
|
{
|
|
$aHeader[] = $sField;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Build some conventional name for the fields: field1...fieldn
|
|
$index= 1;
|
|
foreach($aFirstLine as $sField)
|
|
{
|
|
$aHeader[] = Dict::Format('UI:CSVImport:FieldName', $index);
|
|
$index++;
|
|
}
|
|
}
|
|
$oPage->add("<table>\n");
|
|
$oPage->add('<tr>');
|
|
$oPage->add('<th>'.Dict::S('UI:CSVImport:HeaderFields').'</th><th>'.Dict::S('UI:CSVImport:HeaderMappings').'</th><th> </th><th>'.Dict::S('UI:CSVImport:HeaderSearch').'</th><th>'.Dict::S('UI:CSVImport:DataLine1').'</th><th>'.Dict::S('UI:CSVImport:DataLine2').'</th>');
|
|
$oPage->add('</tr>');
|
|
$index = 1;
|
|
foreach($aHeader as $sField)
|
|
{
|
|
$oPage->add('<tr>');
|
|
$oPage->add("<th>$sField</th>");
|
|
$oPage->add('<td>'.GetMappingForField($sClassName, $sField, $index, $bAdvanced).'</td>');
|
|
$oPage->add('<td> </td>');
|
|
$oPage->add('<td><input id="search_'.$index.'" type="checkbox" name="search_field['.$index.']" value="1" /></td>');
|
|
$oPage->add('<td>'.(isset($aData[$iStartLine][$index-1]) ? htmlentities($aData[$iStartLine][$index-1], ENT_QUOTES, 'UTF-8') : ' ').'</td>');
|
|
$oPage->add('<td>'.(isset($aData[$iStartLine+1][$index-1]) ? htmlentities($aData[$iStartLine+1][$index-1], ENT_QUOTES, 'UTF-8') : ' ').'</td>');
|
|
$oPage->add('</tr>');
|
|
$index++;
|
|
}
|
|
$oPage->add("</table>\n");
|
|
$aReconciliationKeys = MetaModel::GetReconcKeys($sClassName);
|
|
$aMoreReconciliationKeys = array(); // Store: key => void to automatically remove duplicates
|
|
foreach($aReconciliationKeys as $sAttCode)
|
|
{
|
|
$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
|
|
if ($oAttDef->IsExternalKey())
|
|
{
|
|
// An external key is specified as a reconciliation key: this means that all the reconciliation
|
|
// keys of this class are proposed to identify the target object
|
|
$aMoreReconciliationKeys = array_merge($aMoreReconciliationKeys, GetMappingsForExtKey($sAttCode, $oAttDef, $bAdvanced));
|
|
}
|
|
elseif($oAttDef->IsExternalField())
|
|
{
|
|
// An external field is specified as a reconciliation key, translate the field into a field on the target class
|
|
// since external fields are not writable, and thus never appears in the mapping form
|
|
$sKeyAttCode = $oAttDef->GetKeyAttCode();
|
|
$sTargetAttCode = $oAttDef->GetExtAttCode();
|
|
$aMoreReconciliationKeys[$sKeyAttCode.'->'.$sTargetAttCode] = '';
|
|
}
|
|
}
|
|
$sDefaultKeys = '"'.implode('", "',array_merge($aReconciliationKeys, array_keys($aMoreReconciliationKeys))).'"';
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$('select[name^=field]').change( DoCheckMapping );
|
|
aDefaultKeys = new Array($sDefaultKeys);
|
|
DoCheckMapping();
|
|
EOF
|
|
);
|
|
}
|
|
break;
|
|
|
|
case 'get_csv_template':
|
|
$sClassName = utils::ReadParam('class_name');
|
|
if (MetaModel::IsValidClass($sClassName))
|
|
{
|
|
$oSearch = new DBObjectSearch($sClassName);
|
|
$oSearch->AddCondition('id', 0, '='); // Make sure we create an empty set
|
|
$oSet = new CMDBObjectSet($oSearch);
|
|
$sResult = cmdbAbstractObject::GetSetAsCSV($oSet, array('showMandatoryFields' => true));
|
|
|
|
$sClassDisplayName = MetaModel::GetName($sClassName);
|
|
$sDisposition = utils::ReadParam('disposition', 'inline');
|
|
if ($sDisposition == 'attachment')
|
|
{
|
|
$oPage = new CSVPage("");
|
|
$oPage->add_header("Content-type: text/csv; charset=utf-8");
|
|
$oPage->add_header("Content-disposition: attachment; filename=\"{$sClassDisplayName}.csv\"");
|
|
$oPage->no_cache();
|
|
$oPage->add($sResult);
|
|
}
|
|
else
|
|
{
|
|
$oPage = new ajax_page("");
|
|
$oPage->no_cache();
|
|
$oPage->add('<p style="text-align:center"><a style="text-decoration:none" href="'.utils::GetAbsoluteUrlAppRoot().'pages/ajax.csvimport.php?operation=get_csv_template&disposition=attachment&class_name='.$sClassName.'"><img border="0" src="../images/csv.png"><br/>'.$sClassDisplayName.'.csv</a></p>');
|
|
$oPage->add('<p><textarea rows="5" cols="100">'.$sResult.'</textarea></p>');
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$oPage = new ajax_page("");
|
|
}
|
|
break;
|
|
}
|
|
$oPage->output();
|
|
}
|
|
catch (Exception $e)
|
|
{
|
|
IssueLog::Error($e->getMessage());
|
|
}
|
|
|
|
?>
|