YetiForceCompany/YetiForceCRM

<?php
/* +***********************************************************************************
 * The contents of this file are subject to the vtiger CRM Public License Version 1.0
 * ("License"); You may not use this file except in compliance with the License
 * The Original Code is:  vtiger CRM Open Source
 * The Initial Developer of the Original Code is vtiger.
 * Portions created by vtiger are Copyright (C) vtiger.
 * All Rights Reserved.
 * Contributor(s): YetiForce S.A.
 * *********************************************************************************** */

class Import_Utils_Helper
{
    public static $AUTO_MERGE_NONE = 0;
    public static $AUTO_MERGE_IGNORE = 1;
    public static $AUTO_MERGE_OVERWRITE = 2;
    public static $AUTO_MERGE_MERGEFIELDS = 3;
    public static $supportedFileExtensions = ['csv', 'vcf', 'ical', 'xml', 'ics'];
    public static $supportedFileExtensionsByModule = ['Contacts' => ['csv', 'vcf'], 'Calendar' => ['csv', 'ical', 'ics'], 'Default' => ['csv', 'xml', 'zip']];

    public static function getSupportedFileExtensions($moduleName = null)
    {
        if (!$moduleName) {
            return self::$supportedFileExtensions;
        }
        switch ($moduleName) {
                case 'Contacts':
                case 'Calendar':
                    return self::$supportedFileExtensionsByModule[$moduleName];
                default:
                    return self::$supportedFileExtensionsByModule['Default'];
            }
    }

    /**
     * Get supported file extensions description.
     *
     * @param string $moduleName
     *
     * @return string
     */
    public static function getSupportedFileExtensionsDescription(string $moduleName)
    {
        $supportedFileTypes = self::getSupportedFileExtensions($moduleName);
        $description = [];
        foreach ($supportedFileTypes as $fileType) {
            $description[] = '.' . strtoupper($fileType);
        }
        return implode(', ', $description);
    }

    /**
     * The function takes the path of the file to be imported.
     *
     * @param \App\User $user
     *
     * @return string
     */
    public static function getImportFilePath(App\User $user)
    {
        return App\Fields\File::getTmpPath() . 'IMPORT_' . $user->getId();
    }

    public static function showErrorPage($errorMessage, $errorDetails = false, $customActions = false)
    {
        $viewer = new Vtiger_Viewer();
        $viewer->assign('ERROR_MESSAGE', $errorMessage);
        $viewer->assign('ERROR_DETAILS', $errorDetails);
        $viewer->assign('CUSTOM_ACTIONS', $customActions);
        $viewer->assign('MODULE_NAME', 'Import');
        $viewer->view('ImportError.tpl', 'Import');
    }

    public static function showImportLockedError($lockInfo)
    {
        $errorMessage = \App\Language::translate('ERR_MODULE_IMPORT_LOCKED', 'Import');
        $errorDetails = [\App\Language::translate('LBL_MODULE_NAME', 'Import') => \App\Module::getModuleName($lockInfo['tabid']),
            \App\Language::translate('LBL_USER_NAME', 'Import') => \App\Fields\Owner::getUserLabel($lockInfo['userid']),
            \App\Language::translate('LBL_LOCKED_TIME', 'Import') => $lockInfo['locked_since'], ];

        self::showErrorPage($errorMessage, $errorDetails);
    }

    /**
     * Shows import errors in the table.
     *
     * @param string $moduleName
     */
    public static function showImportTableBlockedError($moduleName)
    {
        $errorMessage = \App\Language::translate('ERR_UNIMPORTED_RECORDS_EXIST', 'Import');
        $customActions = ['LBL_CLEAR_DATA' => "location.href='index.php?module={$moduleName}&view=Import&mode=clearCorruptedData'"];

        self::showErrorPage($errorMessage, '', $customActions);
    }

    public static function getAssignedToUserList($module)
    {
        $cache = Vtiger_Cache::getInstance();
        if ($cache->getUserList($module, \App\User::getCurrentUserId())) {
            return $cache->getUserList($module, \App\User::getCurrentUserId());
        }
        $userList = \App\Fields\Owner::getInstance($module)->getAccessibleUsers('', 'owner');
        $cache->setUserList($module, $userList, \App\User::getCurrentUserId());

        return $userList;
    }

    public static function getAssignedToGroupList($module)
    {
        $cache = Vtiger_Cache::getInstance();
        if ($cache->getGroupList($module, \App\User::getCurrentUserId())) {
            return $cache->getGroupList($module, \App\User::getCurrentUserId());
        }
        $groupList = \App\Fields\Owner::getInstance()->getGroups(false);
        $cache->setGroupList($module, $groupList, \App\User::getCurrentUserId());

        return $groupList;
    }

    public static function hasAssignPrivilege($moduleName, $assignToUserId)
    {
        $assignableUsersList = self::getAssignedToUserList($moduleName);
        if (\array_key_exists($assignToUserId, $assignableUsersList)) {
            return true;
        }
        $assignableGroupsList = self::getAssignedToGroupList($moduleName);
        if (\array_key_exists($assignToUserId, $assignableGroupsList)) {
            return true;
        }
        return false;
    }

    /**
     * Validates uploads file.
     *
     * @param \App\Request $request
     *
     * @return bool
     */
    public static function validateFileUpload(App\Request $request)
    {
        $currentUser = \App\User::getCurrentUserModel();

        $uploadMaxSize = \App\Config::getMaxUploadSize();
        $importDirectory = App\Fields\File::getTmpPath();
        $temporaryFileName = self::getImportFilePath($currentUser);
        if ($_FILES['import_file']['error']) {
            $request->set('error_message', \App\Fields\File::getErrorMessage($_FILES['import_file']['error']));
            return false;
        }
        if (!is_uploaded_file($_FILES['import_file']['tmp_name'])) {
            $request->set('error_message', \App\Language::translate('LBL_FILE_UPLOAD_FAILED', 'Import'));
            return false;
        }
        if ($_FILES['import_file']['size'] > $uploadMaxSize) {
            $request->set('error_message', \App\Language::translate('LBL_IMPORT_ERROR_LARGE_FILE', 'Import') .
                $uploadMaxSize . ' ' . \App\Language::translate('LBL_IMPORT_CHANGE_UPLOAD_SIZE', 'Import'));
            return false;
        }
        if (!is_writable($importDirectory)) {
            $request->set('error_message', \App\Language::translate('LBL_IMPORT_DIRECTORY_NOT_WRITABLE', 'Import'));
            return false;
        }
        $fileInstance = \App\Fields\File::loadFromRequest($_FILES['import_file']);
        if ('zip' !== $fileInstance->getExtension(true) && $fileInstance->getEncoding() !== strtoupper($request->getByType('file_encoding', 'Text'))) {
            $request->set('error_message', \App\Language::translateArgs('LBL_IMPORT_FILE_DIFFERENT_ENCODING', 'Import', $fileInstance->getEncoding()));
            return false;
        }
        if (!$fileInstance->moveFile($temporaryFileName)) {
            $request->set('error_message', \App\Language::translate('LBL_IMPORT_FILE_COPY_FAILED', 'Import'));
            return false;
        }
        $fileReader = Import_Module_Model::getFileReader($request, $currentUser);
        if (null === $fileReader) {
            $request->set('error_message', \App\Language::translate('LBL_INVALID_FILE', 'Import'));
            return false;
        }
        $firstRow = $fileReader->getFirstRowData($fileReader->hasHeader());
        if (false === $firstRow) {
            $request->set('error_message', \App\Language::translate('LBL_NO_ROWS_FOUND', 'Import'));
            return false;
        }
        return true;
    }
}