salesagility_SuiteCRM/lib/Utility/AntiMalware/FileScanner.php

<?php
/**
 *
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
 *
 * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
 * Copyright (C) 2011 - 2021 SalesAgility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * 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 Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 *
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for technical reasons, the Appropriate Legal Notices must
 * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 */

namespace SuiteCRM\Utility\AntiMalware;

use SuiteCRM\Exception\MalwareFoundException;
use SuiteCRM\Interfaces\AntiMalwareFileScanner;
use SuiteCRM\Utility\Configuration;
use SuiteCRM\Utility\SuiteLogger;

/**
 * Class FileScanner
 * @package SuiteCRM\Utility\AntiMalware
 *
 * @see /lib/Utility/AntiMalware/Providers/
 * @see anti_malware_scanners config option
 *
 */
#[\AllowDynamicProperties]
class FileScanner implements AntiMalwareFileScanner
{

    /**
     * Is the Anti-Malware FileScanner enabled
     *
     * @return bool true === yes, false === no
     */
    public function isAntiMalwareScannerAvailable(): bool
    {
        $logger = new SuiteLogger();
        $globalConfig = new Configuration();

        $configuration =
            $globalConfig['anti_malware_scanners'] ?? null;

        if (!empty($configuration)) {
            foreach ($configuration as $antiMalwareScanner => $antiMalwareScannerConfiguration) {
                if (class_exists($antiMalwareScanner)) {
                    /** @var AntiMalwareFileScanner $class */
                    $class = new $antiMalwareScanner();
                    if ($class->isAntiMalwareScannerAvailable()) {
                        return true;
                    }
                } else {
                    $logger->warning('class/namespace does not exist ' . $antiMalwareScanner);
                }
            }
        }

        return false;
    }

    /**
     * Combines configuration and available scanners to scan for malware
     *
     * @param string $path - location in the file system
     * @throws MalwareFoundException
     */
    public function scanFilePath(string $path): void
    {
        $logger = new SuiteLogger();
        $globalConfig = new Configuration();

        $configuration =
            $globalConfig['anti_malware_scanners'] ?? null;

        if (!empty($configuration)) {
            foreach ($configuration as $antiMalwareScanner => $antiMalwareScannerConfiguration) {
                if (class_exists($antiMalwareScanner)) {
                    /** @var AntiMalwareFileScanner $class */
                    $class = new $antiMalwareScanner();
                    if ($class->isAntiMalwareScannerAvailable()) {
                        $class->scanFilePath($path);
                    }
                } else {
                    $logger->warning('class/namespace does not exist ' . $antiMalwareScanner);
                }
            }
        }
    }

}