sysinfotools.php

<?php
/**
 *
 * @author G. Giunta
 * @copyright (C) G. Giunta 2008-2017
 * @license Licensed under GNU General Public License v2.0. See file license.txt
 */

class sysInfoTools implements ezSysinfoReport
{

    /// @todo move to a dedicated class ?
    public static function runTests()
    {
        $results = array();

        // allow basic tests to be loaded even when extension is not activated.
        // This is needed for every class exposed as report
        $testClasses =  ezInactiveExtensionLoader::getIniValue( 'sysinfo.ini', 'ModuleSettings', 'TestsList', ezInactiveExtensionLoader::TYPE_ARRAY );

        foreach( $testClasses as $class )
        {
            /// @todo check that interface is implemented
            $results = array_merge( $results, call_user_func( array( $class, 'runTests' ) ) );
        }
        return $results;
    }

    public function getReport()
    {
        return self::runTests();
    }

    public function getDescription()
    {
        return array(
            'tag' => 'systemstatus',
            'title' => 'System status checks (1=OK, 0=KO, X=NA)',
            'executingString' => 'Executing system status checks...',
            'format' => 'byrow'
        );
    }

    static function countFilesInDir( $cachedir )
    {
        if (  eZSys::osType() != 'win32' )
        {
            /// @todo use a command that escapes newlines in file names?
            exec( "find \"$cachedir\" -type f | wc -l", $result );
            /// @todo test properly to see if we have received a number or an error...
            return $result[0];
        }
        else
        {
            $return = 0;
            $files = @scandir( $cachedir );
            if ( $files === false )
                return false;
            foreach( $files as $file )
            {
                if ( $file != '.' && $file != '..' )
                {
                    if ( is_dir( $cachedir . '/' . $file ) )
                    {
                        $return += self::countFilesInDir( $cachedir . '/' . $file );
                    }
                    else
                    {
                        $return++;
                    }
                }
            }
            return $return;
        }
    }

    static function countFilesSizeInDir( $cachedir )
    {
        if (  eZSys::osType() != 'win32' )
        {
            /// @todo verify that we got no error?
            exec( "du -b -c -s \"$cachedir\"", $result );
            $result = @preg_split( '/[\s]+/', $result[1] );
            return $result[0];
        }
        else
        {
            $return = 0;
            $files = @scandir( $cachedir );
            if ( $files === false )
                return false;
            foreach( $files as $file )
            {
                if ( $file != '.' && $file != '..' )
                {
                    if ( is_dir( $cachedir . '/' . $file ) )
                    {
                        $return += sysInfoTools::countFilesSizeInDir( $cachedir . '/' . $file );
                    }
                    else
                    {
                        $return += filesize( $cachedir . '/' . $file );
                    }
                }
            }
            return $return;
        }
    }

    /**
     * Search text in files using regexps (recursively through folders).
     * Assumes egrep is available if not on windows
     */
    static function searchInFiles( $searchtext, $cachedir, $is_regexp = true )
    {
        //$fileHandler = eZClusterFileHandler::instance();
        $result = array();

        if (  eZSys::osType() != 'win32' )
        {
            if ( $is_regexp )
            {
                exec( 'egrep -s -R -l "' . str_replace( '"', '\"', $searchtext ) . "\" \"$cachedir\"", $result );
            }
            else
            {
                exec( 'fgrep -s -R -l "' . str_replace( '"', '\"', $searchtext ) . "\" \"$cachedir\"", $result );
            }
        }
        else
        {
            $files = @scandir( $cachedir );
            if ( $files === false )
                return array();
            foreach( $files as $file )
            {
                if ( $file != '.' && $file != '..' )
                {
                    if ( is_dir( $cachedir . '/' . $file ) )
                    {
                        $result = array_merge( $result, sysInfoTools::searchInFiles( $searchtext, $cachedir . '/' . $file, $is_regexp ) );
                    }
                    else
                    {
                        $txt = @file_get_contents( $cachedir. '/'. $file );
                        /// @todo escape properly #
                        if ( $is_regexp )
                        {
                            if( preg_match( "#". $searchtext . "#", $txt ) )
                            {
                                $result[] = $cachedir. '/'. $file;
                            }
                        }
                        else
                        {
                            if( strpos( $txt, $searchtext ) !== false )
                            {
                                $result[] = $cachedir. '/'. $file;
                            }
                        }
                        $txt = false; // free memory asap
                    }
                }
            }
        }

        return $result;
    }

    static function isHTTP200( $data )
    {
        // Support "web-proxy-tunelling" connections for https through proxies
        if( preg_match( '/^HTTP\/1\.[0-1] 200 Connection established/', $data ) )
        {
            // Look for CR/LF or simple LF as line separator,
            // (even though it is not valid http)
            $pos = strpos( $data, "\r\n\r\n" );
            if( $pos || is_int( $pos ) )
            {
                $bd = $pos+4;
            }
            else
            {
                $pos = strpos( $data, "\n\n" );
                if( $pos || is_int( $pos ) )
                {
                    $bd = $pos+2;
                }
                else
                {
                    // No separation between response headers and body: fault?
                    $bd = 0;
                }
            }
            if ( $bd )
            {
                // this filters out all http headers from proxy.
                // maybe we could take them into account, too?
                $data = substr( $data, $bd );
            }
            else
            {
                //continue; // next web server
            }
        }
        // Strip HTTP 1.1 100 Continue header if present
        while( preg_match( '/^HTTP\/1\.1 1[0-9]{2} /', $data) )
        {
            $pos = strpos( $data, 'HTTP', 12 );
            if( !$pos && !is_int( $pos ) ) // works fine in php 3, 4 and 5
            {
                // server sent a Continue header without any (valid) content following...
                break;
            }
            $data = substr( $data, $pos );
        }
        if ( preg_match( '/^HTTP\/[0-9.]+ 200 /', $data ) )
        {
            return true;
        }

        return false;
    }

    static function ezgeshiAvailable()
    {
        if ( in_array( 'ezsh', eZExtension::activeExtensions() ) )
        {
            $info = eZExtension::extensionInfo( 'ezsh' );
            // since ezp 4.4, we have a lowercase version info
            return ( version_compare( @$info['Version'], '1.3' ) >= 0 || version_compare( @$info['version'], '1.3' ) >= 0 );
        }
        return false;
    }

    /**
    * Return array of all php classes registered for autoload.
    * Class ezpAutoloader does not help us here...
    */
    static function autoloadClasses()
    {
        if ( !is_array( self::$ezpClasses ) )
        {
            self::$ezpClasses = include 'autoload/ezp_kernel.php';
            if ( file_exists( 'var/autoload/ezp_extension.php' ) )
            {
                self::$ezpClasses = array_merge( self::$ezpClasses, include 'var/autoload/ezp_extension.php' );
            }
            if ( defined( 'EZP_AUTOLOAD_ALLOW_KERNEL_OVERRIDE' ) and EZP_AUTOLOAD_ALLOW_KERNEL_OVERRIDE )
            {
                if ( $ezpKernelOverrideClasses = include 'var/autoload/ezp_override.php' )
                {
                    self::$ezpClasses = array_merge( self::$ezpClasses, $ezpKernelOverrideClasses );
                }
            }
        }
        return self::$ezpClasses;
    }

    /**
    * Returns true for eZP versions which have a known github tag
    * @param string $version
    * @return boolean
    */
    static function sourceCodeAvailable( $version )
    {
        $ini = eZINI::instance( 'sysinfo.ini' );
        $excluded = $ini->variable( 'GeneralSettings', 'MissingSourceVersions' );
        // exclude CP installs, as there is no online tag for those
        $majorversion = explode( '.', $version );
        $majorversion = $majorversion[0];
        return ( !in_array( $version, $excluded ) && $majorversion < 2011 );
    }

    /**
    * Given a (known) tpl operator name, returns its subfolder in the online docs
    * @param string $operator
    * @return array or false
    *
    * @todo move list to ini ?
    */
    static function operatorDocFolders( $operator )
    {
        $out = false;
        $folders = array(
            'Arrays' => array( 'append', 'array', 'array_sum', 'begins_with', 'compare', 'contains', 'ends_with', 'explode', 'extract', 'extract_left', 'extract_right', 'hash', 'implode', 'insert', 'merge', 'prepend', 'remove', 'repeat', 'replace', 'reverse', 'unique' ),
            'Data-and-information-extraction' => array( 'currentdate', 'ezhttp', 'ezhttp_hasvariable', 'ezini', 'ezini_hasvariable', 'ezmodule', 'ezpreference', 'ezsys', 'fetch', 'module_params' ),
            'Formatting-and-internationalization' => array( 'd18n', 'datetime', 'i18n', 'l10n', 'si' ),
            'Images' => array( 'image', 'imagefile', 'texttoimage' ),
            'Logical-operations' => array( 'and', 'choose', 'cond', 'eq', 'false', 'first_set', 'ge', 'gt', 'le', 'lt', 'ne', 'not', 'null', 'or', 'true' ),
            'Mathematics' => array( 'abs', 'ceil', 'dec', 'div', 'floor', 'inc', 'max', 'min', 'mod', 'mul', 'rand', 'round', 'sub', 'sum' ),
            'Miscellaneous' => array( 'action_icon', 'attribute', 'classgroup_icon', 'class_icon', 'content_structure_tree', 'ezpackage', 'flag_icon', 'gettime', 'icon_info', 'makedate', 'maketime', 'mimetype_icon', 'month_overview', 'pdf', 'roman', 'topmenu', 'treemenu' ),
            'Strings' => array( 'append', 'autolink', 'begins_with', 'break', 'chr', 'compare', 'concat', 'contains', 'count_chars', 'count_words', 'crc32', 'downcase', 'ends_with', 'explode', 'extract', 'extract_left', 'extract_right', 'indent', 'insert', 'md5', 'nl2br', 'ord', 'pad', 'prepend', 'remove', 'repeat', 'replace', 'reverse', 'rot13', 'shorten', 'simpletags', 'simplify', 'trim', 'upcase', 'upfirst', 'upword', 'wash', 'wordtoimage', 'wrap' ),
            'URLs' => array( 'exturl', 'ezdesign', 'ezimage', 'ezroot', 'ezurl' ),
            'Variable-and-type-handling' => array('count', 'float', 'get_class', 'get_type', 'int', 'is_array', 'is_boolean', 'is_class', 'is_float', 'is_integer', 'is_null', 'is_numeric', 'is_object', 'is_set', 'is_string', 'is_unset' )
        );
        foreach ( $folders as $fname => $folder )
        {
            if ( in_array( $operator, $folder ) )
            {
                $out[] = $fname;
            }
        }
        return $out;
    }

    /**
     * Wrapper method to translate labels and eventually takes advantage of new 4.3 i18n API
     * @param $context
     * @param $message
     * @param $comment
     * @param $argument
     * @return string
     */
    public static function ezpI18ntr( $context, $message, $comment = null, $argument = null )
    {
        // eZ Publish < 4.3 => use old i18n system
        if( eZPublishSDK::majorVersion() == 4 && eZPublishSDK::minorVersion() < 3 )
        {
            include_once( 'kernel/common/i18n.php' );
            return ezi18n( $context, $message, $comment, $argument );
        }
        else
        {
            return ezpI18n::tr( $context, $message, $comment, $argument );
        }
    }

    /**
     * Wrapper method to initialize a template and eventually takes advantage of new 4.3 TPL API
     * @return eZTemplate
     */
    public static function eZTemplateFactory()
    {
        if( eZPublishSDK::majorVersion() == 4 && eZPublishSDK::minorVersion() < 3 )
        {
            include_once( 'kernel/common/template.php' );
            return templateInit();
        }
        else
        {
            return eZTemplate::factory();
        }
    }

    static $ezpClasses = false;
}