1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view 
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Forms\Validators;

/**
 * Responsibility: Validate everything necessary for uploaded files and check 
 *                 files by `accept` attribute rules by magic bytes.
 * @see http://php.net/manual/en/features.file-upload.php
 * @see http://php.net/manual/en/features.file-upload.common-pitfalls.php
 */
interface IFiles {

    /**
     * @see https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
     */
    const WIN_RESERVED_FILENAMES = 'CON,PRN,AUX,NUL,COM1,COM2,COM3,COM4,COM5,COM6,COM7,COM8,COM9,LPT1,LPT2,LPT3,LPT4,LPT5,LPT6,LPT7,LPT8,LPT9';

    /**
     * MvcCore extension class nam to get 
     * mimetype by file extension and backwards.
     * @see https://github.com/mvccore/ext-tool-mimetype-extension
     */
    const MVCCORE_EXT_TOOLS_MIMES_EXTS_CLASS = '\\MvcCore\\Ext\\Tools\\MimeTypesExtensions';
    
    const UPLOAD_ERR_MIN_FILES      =  9;
    const UPLOAD_ERR_MAX_FILES      = 10;
    const UPLOAD_ERR_NOT_POSTED     = 11; 
    const UPLOAD_ERR_NOT_FILE       = 12;
    const UPLOAD_ERR_EMPTY_FILE     = 13;
    const UPLOAD_ERR_TOO_LARGE_FILE = 14;
    const UPLOAD_ERR_MIN_SIZE       = 15;
    const UPLOAD_ERR_MAX_SIZE       = 16;
    const UPLOAD_ERR_NO_FILEINFO    = 17;                       
    const UPLOAD_ERR_NO_MIMES_EXT   = 18;
    const UPLOAD_ERR_UNKNOWN_ACCEPT = 19;
    const UPLOAD_ERR_UNKNOWN_EXT    = 20;
    const UPLOAD_ERR_UNKNOWN_MIME   = 21;
    const UPLOAD_ERR_RESERVED_NAME  = 22;
    const UPLOAD_ERR_NOT_ACCEPTED   = 23;
    const UPLOAD_ERR_FILE_BOMB      = 24;

    /**
     * Set maximum number of allowed files count inside 
     * single uploaded archive file. If uploaded archive 
     * has more files inside than this number, it's 
     * proclaimed as archive bomb and it's not uploaded.
     * Default value is `1000`.
     * @param int $archiveMaxItems Default `1000`.
     * @return \MvcCore\Ext\Forms\Validators\Files
     */
    public function SetArchiveMaxItems ($archiveMaxItems = 1000);
    
    /**
     * Get maximum number of allowed files count inside 
     * single uploaded archive file. If uploaded archive 
     * has more files inside than this number, it's 
     * proclaimed as archive bomb and it's not uploaded.
     * Default value is `1000`.
     * @return int
     */
    public function GetArchiveMaxItems ();

    /**
     * Maximum number of allowed ZIP archive levels inside.
     * If uploaded archive contains another zip archive and
     * those archive another and another, this is maximum
     * level for nested ZIP archives. If Archive contains 
     * more levels than this, it's proclaimed as archive 
     * bomb and it's not uploaded. Default value is `3`.
     * @param int $archiveMaxLevels Default `3`.
     * @return \MvcCore\Ext\Forms\Validators\Files
     */
    public function SetArchiveMaxLevels ($archiveMaxLevels = 3);
    
    /**
     * Maximum number of allowed ZIP archive levels inside.
     * If uploaded archive contains another zip archive and
     * those archive another and another, this is maximum
     * level for nested ZIP archives. If Archive contains 
     * more levels than this, it's proclaimed as archive 
     * bomb and it's not uploaded. Default value is `3`.
     * @return int
     */
    public function GetArchiveMaxLevels ();

    /**
     * Set maximum archive compression percentage.
     * If archive file has lower percentage size
     * than all archive file items together, 
     * it's proclaimed as archive bomb and it's 
     * not uploaded.
     * @param float $archiveMaxCompressPercentage Default `10.0`.
     * @return \MvcCore\Ext\Forms\Validators\Files
     */
    public function SetArchiveMaxCompressPercentage ($archiveMaxCompressPercentage = 10.0);
    
    /**
     * Get maximum archive compression percentage.
     * If archive file has lower percentage size
     * than all archive file items together, 
     * it's proclaimed as archive bomb and it's 
     * not uploaded.
     * @return float
     */
    public function GetArchiveMaxCompressPercentage ();

    /**
     * PNG image maximum width or maximum height.
     * PNG images use ZIP compression and that's why 
     * those images could be used as ZIP bombs.
     * This limit helps to prevent file bombs 
     * based on PNG images. Default value is `10000`.
     * @param int $pngImageMaxWidthHeight Default `10.0`.
     * @return \MvcCore\Ext\Forms\Validators\Files
     */
    public function SetPngImageMaxWidthHeight ($pngImageMaxWidthHeight = 10000);
    
    /**
     * PNG image maximum width or maximum height.
     * PNG images use ZIP compression and that's why 
     * those images could be used as ZIP bombs.
     * This limit helps to prevent file bombs 
     * based on PNG images. Default value is `10000`.
     * @return int
     */
    public function GetPngImageMaxWidthHeight ();

    /**
     * Add bomb scanner class(es) to scan uploaded files for file bombs.
     * All classes in this list must implement interface:
     * `\MvcCore\Ext\Forms\Validators\Files\Validations\IBombScanner`.
     * @param \string[] $bombScannerClasses
     * @return \MvcCore\Ext\Forms\Validators\Files
     */
    public function AddBombScanners ();
    
    /**
     * Set bomb scanner class(es) to scan uploaded files for file bombs.
     * All classes in this list must implement interface:
     * `\MvcCore\Ext\Forms\Validators\Files\Validations\IBombScanner`.
     * @param \string[] $bombScannerClasses
     * @return \MvcCore\Ext\Forms\Validators\Files
     */
    public function SetBombScanners ();

    /**
     * Get bomb scanner class(es) to scan uploaded files for file bombs.
     * All classes in this list must implement interface:
     * `\MvcCore\Ext\Forms\Validators\Files\Validations\IBombScanner`.
     * @return \string[]
     */
    public function GetBombScanners ();

    /**
     * Complete uploaded files temporary directory.
     * @return string
     */
    public function GetUploadsTmpDir ();
}