owncloud/core

<?php
/**
 * @author Lukas Reschke <lukas@statuscode.ch>
 * @author Victor Dubiniuk <dubiniuk@owncloud.com>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code 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.
 *
 * 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\IntegrityCheck\Iterator;

/**
 * Class ExcludeFileByNameFilterIterator provides a custom iterator which excludes
 * entries with the specified file name or name part from the file list.
 *
 * @package OC\Integritycheck\Iterator
 */
class ExcludeFileByNameFilterIterator extends \RecursiveFilterIterator {
    /**
     * Array of excluded file names. Those are not scanned by the integrity checker.
     * This is used to exclude files which administrators could upload by mistakes
     * such as .DS_Store files.
     *
     * @var array
     */
    private $excludedFilenames = [
        '.DS_Store', // Mac OS X
        'Thumbs.db', // Microsoft Windows
        '.directory', // Dolphin (KDE)
        '.webapp', // Gentoo/Funtoo & derivatives use a tool known as webapp-config to manage wep-apps.
    ];

    /**
     * Array of excluded file name parts. Those are not scanned by the integrity checker.
     * These strings are regular expressions and any file names
     * matching these expressions are ignored.
     *
     * @var array
     */
    private $excludedFileNamePatterns = [
        '/^\.webapp-owncloud-.*/', // Gentoo/Funtoo & derivatives use a tool known as webapp-config to manage wep-apps.
    ];
    
    /**
     * Array of excluded path and file name parts. Those are not scanned by the integrity checker.
     * These strings are regular expressions and any filepath
     * matching these expressions are ignored.
     *
     * @var array
     */
    private $excludedFilePathPatterns = [
        '|/core/js/mimetypelist.js$|', // this file can be regenerated with additional entries with occ maintenance:mimetype:update-js
    ];

    /**
     * @return bool
     */
    public function accept() {
        /** @var \SplFileInfo $current */
        $current = $this->current();

        if ($current->isDir()) {
            return true;
        }

        $currentFileName = $current->getFilename();
        if (\in_array($currentFileName, $this->excludedFilenames, true)) {
            return false;
        }

        foreach ($this->excludedFileNamePatterns as $pattern) {
            if (\preg_match($pattern, $currentFileName) > 0) {
                return false;
            }
        }
        
        $currentFilePath = $current->getPathname();
        foreach ($this->excludedFilePathPatterns as $pattern) {
            if (\preg_match($pattern, $currentFilePath) > 0) {
                return false;
            }
        }

        return true;
    }
}