public static function setUpBeforeClass()
{
parent::setUpBeforeClass();
$super = SecurityTestHelper::createSuperAdmin();
Yii::app()->user->userModel = $super;
$jim = UserTestHelper::createBasicUser('jim');
$values = array('Test1', 'Test2', 'Test3', 'Sample', 'Demo');
$customFieldData = CustomFieldData::getByName('ImportTestDropDown');
$customFieldData->serializedData = serialize($values);
$saved = $customFieldData->save();
assert($saved);
// Not Coding Standard
$values = array('Multi 1', 'Multi 2', 'Multi 3');
$customFieldData = CustomFieldData::getByName('ImportTestMultiDropDown');
$customFieldData->serializedData = serialize($values);
$saved = $customFieldData->save();
assert($saved);
// Not Coding Standard
$values = array('Cloud 1', 'Cloud 2', 'Cloud 3');
$customFieldData = CustomFieldData::getByName('ImportTestTagCloud');
$customFieldData->serializedData = serialize($values);
$saved = $customFieldData->save();
assert($saved);
// Not Coding Standard
//Ensure the external system id column is present.
$userTableName = User::getTableName();
ExternalSystemIdUtil::addExternalIdColumnIfMissing($userTableName);
ExternalSystemIdUtil::updateByModel($super, 'A');
ExternalSystemIdUtil::updateByModel($jim, 'B');
ExternalSystemIdUtil::addExternalIdColumnIfMissing(ImportModelTestItem::getTableName());
ExternalSystemIdUtil::addExternalIdColumnIfMissing(ImportModelTestItem2::getTableName());
ExternalSystemIdUtil::addExternalIdColumnIfMissing(ImportModelTestItem3::getTableName());
ExternalSystemIdUtil::addExternalIdColumnIfMissing(ImportModelTestItem4::getTableName());
}
public static function getUserExternalSystemIds()
{
$columnName = ExternalSystemIdUtil::EXTERNAL_SYSTEM_ID_COLUMN_NAME;
$userTableName = User::getTableName();
ExternalSystemIdUtil::addExternalIdColumnIfMissing($userTableName);
$sql = 'select ' . $columnName . ' from ' . $userTableName;
return ZurmoRedBean::getCol($sql);
}
public static function setUpBeforeClass()
{
parent::setUpBeforeClass();
$super = SecurityTestHelper::createSuperAdmin();
Yii::app()->user->userModel = $super;
$accountTableName = Account::getTableName();
$contactTableName = Contact::getTableName();
$opportunityTableName = Opportunity::getTableName();
ExternalSystemIdUtil::addExternalIdColumnIfMissing($accountTableName);
ExternalSystemIdUtil::addExternalIdColumnIfMissing($contactTableName);
ExternalSystemIdUtil::addExternalIdColumnIfMissing($opportunityTableName);
}
public static function setUpBeforeClass()
{
parent::setUpBeforeClass();
$super = SecurityTestHelper::createSuperAdmin();
Yii::app()->user->userModel = $super;
ExternalSystemIdUtil::addExternalIdColumnIfMissing(Account::getTableName());
ExternalSystemIdUtil::addExternalIdColumnIfMissing(Contact::getTableName());
ExternalSystemIdUtil::addExternalIdColumnIfMissing(Opportunity::getTableName());
$account = AccountTestHelper::createAccountByNameForOwner('testAccount', $super);
ImportTestHelper::updateModelsExternalId($account, 'ACC');
$contact = ContactTestHelper::createContactByNameForOwner('testContact', $super);
ImportTestHelper::updateModelsExternalId($contact, 'CON');
$opportunity = OpportunityTestHelper::createOpportunityByNameForOwner('testOpportunity', $super);
ImportTestHelper::updateModelsExternalId($opportunity, 'OPP');
}
/**
* Given a row of data, resolve each value of the row for import and either create or update an existing model.
* @param object $importRules
* @param array $rowData
* @param array $mappingData
* @param object $importRowDataResultsUtil
*/
public static function importByImportRulesRowData(ImportRules $importRules, $rowBean, $mappingData, ImportRowDataResultsUtil $importRowDataResultsUtil, ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions)
{
assert('$rowBean instanceof RedBean_OODBBean');
assert('is_array($mappingData)');
$makeNewModel = true;
$modelClassName = $importRules->getModelClassName();
$externalSystemId = null;
$importSanitizeResultsUtil = new ImportSanitizeResultsUtil();
$afterSaveActionsData = array();
$attributeValueData = array();
$skippedColumns = array();
$model = new $modelClassName();
$model->setScenario('importModel');
//Process the 'id' column first if available.
if (false !== ($idColumnName = static::getMappedColumnNameByMappingData('id', $mappingData))) {
$columnMappingData = $mappingData[$idColumnName];
$attributeValueData = static::getAttributeValueData($importRules, $idColumnName, $columnMappingData, $rowBean, $importSanitizeResultsUtil);
assert('count($attributeValueData) == 0 || count($attributeValueData) == 1');
if (isset($attributeValueData['id']) && $attributeValueData['id'] != null) {
$model = $modelClassName::getById($attributeValueData['id']);
} elseif (isset($attributeValueData[ExternalSystemIdUtil::EXTERNAL_SYSTEM_ID_COLUMN_NAME]) && $attributeValueData[ExternalSystemIdUtil::EXTERNAL_SYSTEM_ID_COLUMN_NAME] != null) {
$externalSystemId = $attributeValueData[ExternalSystemIdUtil::EXTERNAL_SYSTEM_ID_COLUMN_NAME];
}
$skippedColumns[] = $idColumnName;
}
//Dedupe fields processing
if (static::processDedupeAttributesToCheckForSkipIfRequired($importRules, $model, $mappingData, $rowBean, $importRowDataResultsUtil, $importSanitizeResultsUtil, $skippedColumns) !== true) {
if (null != ($matchedModel = $importSanitizeResultsUtil->getMatchedModel())) {
$model = $matchedModel;
$makeNewModel = false;
}
//Process the dedupe fields
foreach ($importRules->getDedupeAttributes() as $dedupeField) {
$sourceColumnName = static::getMappedColumnNameByMappingData($dedupeField, $mappingData);
if (false !== $sourceColumnName) {
$columnMappingData = $mappingData[$sourceColumnName];
static::processImportInformationForAttributeDataAndPopulateModel($importRules, $sourceColumnName, $columnMappingData, $rowBean, $importSanitizeResultsUtil, $model, $afterSaveActionsData);
}
}
} else {
//as the row should be skipped
return;
}
//Process the rest of the mapped colummns. ignoring owner.
foreach ($mappingData as $columnName => $columnMappingData) {
if ($columnMappingData['attributeIndexOrDerivedType'] != null && $columnMappingData['attributeIndexOrDerivedType'] != 'owner' && in_array($columnName, $skippedColumns) === false) {
static::processImportInformationForAttributeDataAndPopulateModel($importRules, $columnName, $columnMappingData, $rowBean, $importSanitizeResultsUtil, $model, $afterSaveActionsData);
}
}
//Process the owner column if present
foreach ($mappingData as $columnName => $columnMappingData) {
if ($columnMappingData['attributeIndexOrDerivedType'] != null && $columnMappingData['attributeIndexOrDerivedType'] == 'owner' && in_array($columnName, $skippedColumns) === false) {
static::processImportInformationForAttributeDataAndPopulateModel($importRules, $columnName, $columnMappingData, $rowBean, $importSanitizeResultsUtil, $model, $afterSaveActionsData);
}
}
$validated = $model->validate();
if ($validated && $importSanitizeResultsUtil->shouldSaveModel()) {
$saved = $model->save();
if ($saved) {
static::processAfterSaveActions($afterSaveActionsData, $model);
if ($externalSystemId != null) {
ExternalSystemIdUtil::updateByModel($model, $externalSystemId);
}
$importRowDataResultsUtil->addMessage(Zurmo::t('ImportModule', '{modelLabel} saved correctly: {linkToModel}', array('{modelLabel}' => $model->getModelLabelByTypeAndLanguage('Singular'), '{linkToModel}' => static::resolveLinkMessageToModel($model))));
$importRowDataResultsUtil->addMessages($importSanitizeResultsUtil->getRelatedModelMessages());
if ($makeNewModel) {
if ($model instanceof SecurableItem) {
$model->setScenario('doNotSetModifiedDateTimeOrUser');
try {
$resolved = ExplicitReadWriteModelPermissionsUtil::resolveExplicitReadWriteModelPermissions($model, $explicitReadWriteModelPermissions);
$importRowDataResultsUtil->setStatusToCreated();
if (!$resolved) {
$importRowDataResultsUtil->addMessage('The record saved, but there was a problem ' . 'setting the security permissions. It will at least be viewable by the owner.');
$importRowDataResultsUtil->setStatusToError();
}
} catch (AccessDeniedSecurityException $e) {
$importRowDataResultsUtil->addMessage('The record saved, but you do not have permissions ' . 'to set the security the way you did. The record will only be viewable by the owner.');
$importRowDataResultsUtil->setStatusToError();
}
$model->setScenario('importModel');
} else {
$importRowDataResultsUtil->setStatusToCreated();
}
} else {
$importRowDataResultsUtil->setStatusToUpdated();
}
} else {
$importRowDataResultsUtil->addMessage('The record failed to save. Reason unknown.');
$importRowDataResultsUtil->setStatusToError();
}
} else {
if (!$importSanitizeResultsUtil->shouldSaveModel()) {
$importRowDataResultsUtil->addMessages($importSanitizeResultsUtil->getMessages());
}
$messages = RedBeanModelErrorsToMessagesUtil::makeMessagesByModel($model);
if (count($messages) > 0) {
$importRowDataResultsUtil->addMessages($messages);
}
$importRowDataResultsUtil->setStatusToError();
}
}
protected function init()
{
parent::init();
$this->resolveMappingRuleDataType();
$modelClassName = $this->modelClassName;
$model = new $modelClassName(false);
$this->attributeModelClassName = $this->resolveAttributeModelClassName($model, $this->attributeName);
$this->ensureTypeValueIsValid($this->mappingRuleData["type"]);
if ($this->mappingRuleData["type"] == IdValueTypeMappingRuleForm::EXTERNAL_SYSTEM_ID) {
$modelClassName = $this->attributeModelClassName;
ExternalSystemIdUtil::addExternalIdColumnIfMissing($modelClassName::getTableName(), $this->externalSystemIdMaxLength);
}
}
/**
* Given a row of data, resolve each value of the row for import and either create or update an existing model.
* @param object $importRules
* @param array $rowData
* @param array $mappingData
* @param object $importRowDataResultsUtil
*/
public static function importByImportRulesRowData(ImportRules $importRules, $rowBean, $mappingData, ImportRowDataResultsUtil $importRowDataResultsUtil, ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions)
{
assert('$rowBean instanceof RedBean_OODBBean');
assert('is_array($mappingData)');
$makeNewModel = true;
$modelClassName = $importRules->getModelClassName();
$externalSystemId = null;
$importSanitizeResultsUtil = new ImportSanitizeResultsUtil();
$afterSaveActionsData = array();
//Process the 'id' column first if available.
if (false !== ($idColumnName = static::getIdColumnNameByMappingData($mappingData))) {
$columnMappingData = $mappingData[$idColumnName];
$attributeImportRules = AttributeImportRulesFactory::makeByImportRulesTypeAndAttributeIndexOrDerivedType($importRules::getType(), $columnMappingData['attributeIndexOrDerivedType']);
$valueReadyToSanitize = static::resolveValueToSanitizeByValueAndColumnType($rowBean->{$idColumnName}, $columnMappingData['type']);
$attributeValueData = $attributeImportRules->resolveValueForImport($valueReadyToSanitize, $columnMappingData, $importSanitizeResultsUtil);
assert('count($attributeValueData) == 0 || count($attributeValueData) == 1');
if (isset($attributeValueData['id']) && $attributeValueData['id'] != null) {
$model = $modelClassName::getById($attributeValueData['id']);
$makeNewModel = false;
} elseif (isset($attributeValueData[ExternalSystemIdUtil::EXTERNAL_SYSTEM_ID_COLUMN_NAME]) && $attributeValueData[ExternalSystemIdUtil::EXTERNAL_SYSTEM_ID_COLUMN_NAME] != null) {
$externalSystemId = $attributeValueData[ExternalSystemIdUtil::EXTERNAL_SYSTEM_ID_COLUMN_NAME];
}
}
if ($makeNewModel) {
$model = new $modelClassName();
$model->setScenario('importModel');
}
//Process the rest of the mapped colummns. ignoring owner.
foreach ($mappingData as $columnName => $columnMappingData) {
if ($columnMappingData['attributeIndexOrDerivedType'] != null && $columnMappingData['attributeIndexOrDerivedType'] != 'owner' && $idColumnName != $columnName) {
static::sanitizeValueAndPopulateModel($rowBean, $importRules, $model, $columnName, $modelClassName, $columnMappingData, $importSanitizeResultsUtil, $afterSaveActionsData);
}
}
//Process the owner column if present
foreach ($mappingData as $columnName => $columnMappingData) {
if ($columnMappingData['attributeIndexOrDerivedType'] != null && $columnMappingData['attributeIndexOrDerivedType'] == 'owner' && $idColumnName != $columnName) {
static::sanitizeValueAndPopulateModel($rowBean, $importRules, $model, $columnName, $modelClassName, $columnMappingData, $importSanitizeResultsUtil, $afterSaveActionsData);
}
}
$validated = $model->validate();
if ($validated && $importSanitizeResultsUtil->shouldSaveModel()) {
$saved = $model->save();
if ($saved) {
static::processAfterSaveActions($afterSaveActionsData, $model);
if ($externalSystemId != null) {
ExternalSystemIdUtil::updateByModel($model, $externalSystemId);
}
$importRowDataResultsUtil->addMessage(Zurmo::t('ImportModule', 'Record saved correctly.'));
if ($makeNewModel) {
if ($model instanceof SecurableItem) {
try {
$resolved = ExplicitReadWriteModelPermissionsUtil::resolveExplicitReadWriteModelPermissions($model, $explicitReadWriteModelPermissions);
$importRowDataResultsUtil->setStatusToCreated();
if (!$resolved) {
$importRowDataResultsUtil->addMessage('The record saved, but there was a problem ' . 'setting the security permissions. It will at least be viewable by the owner.');
$importRowDataResultsUtil->setStatusToError();
}
} catch (AccessDeniedSecurityException $e) {
$importRowDataResultsUtil->addMessage('The record saved, but you do not have permissions ' . 'to set the security the way you did. The record will only be viewable by the owner.');
$importRowDataResultsUtil->setStatusToError();
}
} else {
$importRowDataResultsUtil->setStatusToCreated();
}
} else {
$importRowDataResultsUtil->setStatusToUpdated();
}
} else {
$importRowDataResultsUtil->addMessage('The record failed to save. Reason unknown.');
$importRowDataResultsUtil->setStatusToError();
}
} else {
if (!$importSanitizeResultsUtil->shouldSaveModel()) {
$importRowDataResultsUtil->addMessages($importSanitizeResultsUtil->getMessages());
}
$messages = RedBeanModelErrorsToMessagesUtil::makeMessagesByModel($model);
if (count($messages) > 0) {
$importRowDataResultsUtil->addMessages($messages);
}
$importRowDataResultsUtil->setStatusToError();
}
}
public function testSanitizeValueBySanitizerTypesForUserTypeThatIsRequired()
{
$billy = UserTestHelper::createBasicUser('billy');
$jimmy = UserTestHelper::createBasicUser('jimmy');
$sally = UserTestHelper::createBasicUser('sally');
//Update the external system id.
ExternalSystemIdUtil::addExternalIdColumnIfMissing(User::getTableName());
$externalSystemIdColumnName = ExternalSystemIdUtil::EXTERNAL_SYSTEM_ID_COLUMN_NAME;
ZurmoRedBean::exec("update " . User::getTableName() . " set {$externalSystemIdColumnName} = 'K' where id = {$jimmy->id}");
//Test a required user with no value or default value.
$importSanitizeResultsUtil = new ImportSanitizeResultsUtil();
$columnMappingData = array('type' => 'importColumn', 'mappingRulesData' => array('DefaultModelNameIdMappingRuleForm' => array('defaultModelId' => null), 'UserValueTypeModelAttributeMappingRuleForm' => array('type' => UserValueTypeModelAttributeMappingRuleForm::ZURMO_USER_ID)));
$sanitizerUtilTypes = UserAttributeImportRules::getSanitizerUtilTypesInProcessingOrder();
$sanitizedValue = ImportSanitizerUtil::sanitizeValueBySanitizerTypes($sanitizerUtilTypes, 'ImportModelTestItem', 'owner', null, 'column_0', $columnMappingData, $importSanitizeResultsUtil);
$this->assertNull($sanitizedValue);
$this->assertFalse($importSanitizeResultsUtil->shouldSaveModel());
$messages = $importSanitizeResultsUtil->getMessages();
$this->assertEquals(1, count($messages));
$compareMessage = 'Import - Owner Id is required and was not specified.';
$this->assertEquals($compareMessage, $messages[0]);
//Test a required string with no value, but a valid default value, a user id.
$importSanitizeResultsUtil = new ImportSanitizeResultsUtil();
$columnMappingData = array('type' => 'importColumn', 'mappingRulesData' => array('DefaultModelNameIdMappingRuleForm' => array('defaultModelId' => $billy->id), 'UserValueTypeModelAttributeMappingRuleForm' => array('type' => UserValueTypeModelAttributeMappingRuleForm::ZURMO_USER_ID)));
$sanitizerUtilTypes = UserAttributeImportRules::getSanitizerUtilTypesInProcessingOrder();
$sanitizedValue = ImportSanitizerUtil::sanitizeValueBySanitizerTypes($sanitizerUtilTypes, 'ImportModelTestItem', 'owner', null, 'column_0', $columnMappingData, $importSanitizeResultsUtil);
$this->assertEquals($billy, $sanitizedValue);
$this->assertTrue($importSanitizeResultsUtil->shouldSaveModel());
$messages = $importSanitizeResultsUtil->getMessages();
$this->assertEquals(0, count($messages));
//Test a required string with a valid user id.
$importSanitizeResultsUtil = new ImportSanitizeResultsUtil();
$columnMappingData = array('type' => 'importColumn', 'mappingRulesData' => array('DefaultModelNameIdMappingRuleForm' => array('defaultModelId' => null), 'UserValueTypeModelAttributeMappingRuleForm' => array('type' => UserValueTypeModelAttributeMappingRuleForm::ZURMO_USER_ID)));
$sanitizerUtilTypes = UserAttributeImportRules::getSanitizerUtilTypesInProcessingOrder();
$sanitizedValue = ImportSanitizerUtil::sanitizeValueBySanitizerTypes($sanitizerUtilTypes, 'ImportModelTestItem', 'owner', $billy->id, 'column_0', $columnMappingData, $importSanitizeResultsUtil);
$this->assertEquals($billy, $sanitizedValue);
$this->assertTrue($importSanitizeResultsUtil->shouldSaveModel());
$messages = $importSanitizeResultsUtil->getMessages();
$this->assertEquals(0, count($messages));
//Test a required string with a valid external system user id.
$importSanitizeResultsUtil = new ImportSanitizeResultsUtil();
$columnMappingData = array('type' => 'importColumn', 'mappingRulesData' => array('DefaultModelNameIdMappingRuleForm' => array('defaultModelId' => null), 'UserValueTypeModelAttributeMappingRuleForm' => array('type' => UserValueTypeModelAttributeMappingRuleForm::EXTERNAL_SYSTEM_USER_ID)));
$sanitizerUtilTypes = UserAttributeImportRules::getSanitizerUtilTypesInProcessingOrder();
$sanitizedValue = ImportSanitizerUtil::sanitizeValueBySanitizerTypes($sanitizerUtilTypes, 'ImportModelTestItem', 'owner', 'K', 'column_0', $columnMappingData, $importSanitizeResultsUtil);
$this->assertEquals($jimmy, $sanitizedValue);
$this->assertTrue($importSanitizeResultsUtil->shouldSaveModel());
$messages = $importSanitizeResultsUtil->getMessages();
$this->assertEquals(0, count($messages));
//Test a required string with a valid username.
$importSanitizeResultsUtil = new ImportSanitizeResultsUtil();
$columnMappingData = array('type' => 'importColumn', 'mappingRulesData' => array('DefaultModelNameIdMappingRuleForm' => array('defaultModelId' => null), 'UserValueTypeModelAttributeMappingRuleForm' => array('type' => UserValueTypeModelAttributeMappingRuleForm::ZURMO_USERNAME)));
$sanitizerUtilTypes = UserAttributeImportRules::getSanitizerUtilTypesInProcessingOrder();
$sanitizedValue = ImportSanitizerUtil::sanitizeValueBySanitizerTypes($sanitizerUtilTypes, 'ImportModelTestItem', 'owner', 'sally', 'column_0', $columnMappingData, $importSanitizeResultsUtil);
$this->assertEquals($sally, $sanitizedValue);
$this->assertTrue($importSanitizeResultsUtil->shouldSaveModel());
$messages = $importSanitizeResultsUtil->getMessages();
$this->assertEquals(0, count($messages));
}
