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: 

<?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\Files\Validations;

interface IBombScanner {

    /**
     * Return `TRUE` if given first 4 file 
     * magic bytes belongs to the file type.
     * @param string $firstFourBytes
     * @return bool
     */
    public static function MatchMagicBytes ($firstFourBytes);
    
    /**
     * Return `TRUE`, if bomb validator validates archive file.
     * @return bool
     */
    public static function IsArchive();
    
    /**
     * Return if required PHP extension(s) for validation is/are installed.
     * @return bool
     */
    public static function IsSupported();
    
    /**
     * Return error message when required extension(s) is/are not installed.
     * @return string
     */
    public static function GetNotSupportedError();
    
    /**
     * Create and instance of uploaded file or file extracted 
     * from any uploaded archove or sub-archive.
     * @param \MvcCore\Ext\Forms\Validators\Files $validator
     * @param \SplFileObject $spl
     * @return void
     */
    public function __construct (\MvcCore\Ext\Forms\Validators\IFiles $validator, \SplFileObject $spl);
    
    /**
     * Open archive and return success if archive is OK.
     * For iage bombs - open and check the image.
     * @return bool
     */
    public function Open ();
    
    /**
     * Return any error thrown when openning an archive or checking an image.
     * @return string
     */
    public function GetError ();
    
    /**
     * Return files size by `\SplFileObject` instance.
     * @return int
     */
    public function GetCompressedSize ();
    
    /**
     * Close the archive pointer.
     * @return void
     */
    public function Close ();
    
    /**
     * Move into next entry in archive.
     * @return boolean
     */
    public function Move ();
    
    /**
     * Return archive entry size (in bytes).
     * @return int
     */
    public function GetEntrySize ();
    
    /**
     * Return archive entry name (relative path).
     * @return string
     */
    public function GetEntryName ();
    
    /**
     * Extract archive entry into given full path.
     * @param string $destinationFullPath
     * @return string|NULL
     */
    public function ExtractEntry ($destinationFullPath);
}