AdminPageFramework_WPUtility_File::download() - Code Metrics - michaeluno/admin-page-framework - Measure and Improve Code Quality continuously with Scrutinizer

AdminPageFramework_WPUtility_File::download() B
last analyzed 2022-04-15 19:26 UTC

↳ Parent: AdminPageFramework_WPUtility_File
Complexity

Conditions	7
Paths	7
Size

Total Lines	40
Code Lines	24
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	24
dl	0
loc	40
rs	8.6026
c	0
b	0
f	0
cc	7
nc	7
nop	2
<?php
/**
 * Admin Page Framework
 *
 * http://admin-page-framework.michaeluno.jp/
 * Copyright (c) 2013-2022, Michael Uno; Licensed MIT
 *
 */

/**
 * Provides utility methods regarding reading file which use WordPress built-in functions and classes.
 *
 * @since       2.0.0
 * @extends     AdminPageFramework_Utility
 * @package     AdminPageFramework/Utility
 * @internal
 */
class AdminPageFramework_WPUtility_File extends AdminPageFramework_WPUtility_Hook {

    /**
     * Returns an array of plugin data from the given path.
     *
     * An alternative to get_plugin_data() as some users change the location of the wp-admin directory.
     *
     * @since   2.0.0
     * @since   3.0.0       Changed the scope to public and become static.
     * @since   3.6.2       Supported a text content to be passed to the first parameter.
     * @access  public
     */
    static public function getScriptData( $sPathOrContent, $sType='plugin', $aDefaultHeaderKeys=array() ) {

        $_aHeaderKeys = $aDefaultHeaderKeys + array(
            // storing array key =>    the comment entry header label
            'sName'         => 'Name',
            'sURI'          => 'URI',
            'sScriptName'   => 'Script Name',
            'sLibraryName'  => 'Library Name',
            'sLibraryURI'   => 'Library URI',
            'sPluginName'   => 'Plugin Name',
            'sPluginURI'    => 'Plugin URI',
            'sThemeName'    => 'Theme Name',
            'sThemeURI'     => 'Theme URI',
            'sVersion'      => 'Version',
            'sDescription'  => 'Description',
            'sAuthor'       => 'Author',
            'sAuthorURI'    => 'Author URI',
            'sTextDomain'   => 'Text Domain',
            'sDomainPath'   => 'Domain Path',
            'sNetwork'      => 'Network',
            // Site Wide Only is deprecated in favour of Network.
            '_sitewide'     => 'Site Wide Only',
        );

        $aData = file_exists( $sPathOrContent )
            ? get_file_data(
                $sPathOrContent,
                $_aHeaderKeys,
                $sType // context
            )
            : self::getScriptDataFromContents(
                $sPathOrContent,
                $sType,
                $_aHeaderKeys
            );

        switch ( trim( $sType ) ) {
            case 'theme':
                $aData['sName'] = $aData['sThemeName'];
                $aData['sURI'] = $aData['sThemeURI'];
                break;
            case 'library':
                $aData['sName'] = $aData['sLibraryName'];
                $aData['sURI'] = $aData['sLibraryURI'];
                break;
            case 'script':
                $aData['sName'] = $aData['sScriptName'];
                break;
            case 'plugin':
                $aData['sName'] = $aData['sPluginName'];
                $aData['sURI'] = $aData['sPluginURI'];
                break;
            default:
                break;
        }

        return $aData;

    }

    /**
     * Returns an array of plugin data from the given text content.
     * @since       3.6.2
     * @return      array       The script data
     */
    static public function getScriptDataFromContents( $sContent, $sType='plugin', $aDefaultHeaderKeys=array() ) {

        // Make sure we catch CR-only line endings.
        $sContent = str_replace( "\r", "\n", $sContent );

        $_aHeaders      = $aDefaultHeaderKeys;
        if ( $sType ) {
            $_aExtraHeaders = apply_filters( "extra_{$sType}_headers", array() );
            if ( ! empty( $_aExtraHeaders ) ) {
                $_aExtraHeaders = array_combine( $_aExtraHeaders, $_aExtraHeaders ); // keys equal values
                $_aHeaders      = array_merge( $_aExtraHeaders, ( array ) $aDefaultHeaderKeys );
            }
        }

        foreach ( $_aHeaders as $_sHeaderKey => $_sRegex ) {
            $_bFound = preg_match( '/^[ \t\/*#@]*' . preg_quote( $_sRegex, '/' ) . ':(.*)$/mi', $sContent, $_aMatch );
            $_aHeaders[ $_sHeaderKey ] = $_bFound && $_aMatch[ 1 ]
                ? _cleanup_header_comment( $_aMatch[ 1 ] )
                : '';
        }

        return $_aHeaders;

    }

    /**
     * Downloads a file by the given URL.
     *
     * @remark      The downloaded file should be unlinked(deleted) after it is ued as this function does not do it.
     * @since       3.4.2
     * @see         download_url() in file.php in core.
     */
    static public function download( $sURL, $iTimeOut=300 ) {

        if ( false === filter_var( $sURL, FILTER_VALIDATE_URL ) ) {
            return false;
        }

        $_sTmpFileName = self::setTempPath( self::getBaseNameOfURL( $sURL ) );
        if ( ! $_sTmpFileName ) {
            return false;
        }

        $_aoResponse = wp_safe_remote_get(
            $sURL,
            array(
                'timeout'   => $iTimeOut,
                'stream'    => true,
                'filename'  => $_sTmpFileName
            )
        );

        if ( is_wp_error( $_aoResponse ) ) {
            unlink( $_sTmpFileName );
            return false;
        }

        if ( 200 != wp_remote_retrieve_response_code( $_aoResponse ) ){
            unlink( $_sTmpFileName );
            return false;
        }

        $_sContent_md5 = wp_remote_retrieve_header( $_aoResponse, 'content-md5' );
        if ( $_sContent_md5 ) {
            $_boIsMD5 = verify_file_md5( $_sTmpFileName, $_sContent_md5 );
            $_boIsMD5 = verify_file_md5( $_sTmpFileName, /** @scrutinizer ignore-type */ $_sContent_md5 );
            if ( is_wp_error( $_boIsMD5 ) ) {
                unlink( $_sTmpFileName );
                return false;
            }
        }

        return $_sTmpFileName;
    }

    /**
     * Sets a temporary file in the system temporary directory and return the file path.
     *
     * This function respects the file name passed to the parameter.
     *
     * @since       3.4.2
     * @return      string      The set file path.
     */
    static public function setTempPath( $sFilePath='' ) {

        $_sDir = get_temp_dir();

        $sFilePath = basename( $sFilePath );
        if ( empty( $sFilePath ) ) {
            $sFilePath = time() . '.tmp';
        }

        $sFilePath = $_sDir . wp_unique_filename( $_sDir, $sFilePath );
        touch( $sFilePath );
        return $sFilePath;

    }

    /**
     * Returns the base name of a URL.
     *
     * @since       3.4.2
     */
    static public function getBaseNameOfURL( $sURL ) {

        $_sPath         = parse_url( $sURL, PHP_URL_PATH );
        $_sFileBaseName = basename( $_sPath );
        return $_sFileBaseName;

    }

}

michaeluno / admin-page-framework

AdminPageFramework_WPUtility_File::download() B last analyzed 2022-04-15 19:26 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AdminPageFramework_WPUtility_File::download() B
last analyzed 2022-04-15 19:26 UTC
