8889841cObfuscator.php 0000644 00000003407 15043730706 0007375 0 ustar 00 prefixes = $prefixes;
}
/**
* Whether a value should be obfuscated or not.
*
* @param string $key
*
* @return bool
*/
public function should_obfuscate( $key ) {
foreach ( $this->prefixes as $prefix ) {
if ( strpos( $key, $prefix ) === 0 ) {
return true;
}
}
return false;
}
/**
* Conditionally obfuscates a string value.
*
* @param string $key
* @param mixed $string_value
*
* @return mixed Either the obfuscated string or the original value if not a string.
*/
public function obfuscate( $key, $string_value ) {
if ( ! is_string( $string_value ) ) {
return $string_value;
}
if ( ! $this->should_obfuscate( $key ) ) {
return $string_value;
}
$length = strlen( $string_value );
if ( $length <= 3 ) {
return preg_replace( "/./", "#", $string_value );
} elseif ( $length > 3 && $length <= 5 ) {
return preg_replace( '/^(.{1}).*$/', '$1' . str_repeat( '#', $length - 1 ) . '$2', $string_value );
} elseif ( $length > 5 && $length <= 9 ) {
return preg_replace( '/^(.{1}).*(.{1})$/', '$1' . str_repeat( '#', $length - 2 ) . '$2', $string_value );
} elseif ( $length > 9 && $length <= 19 ) {
return preg_replace( '/^(.{2}).*(.{2})$/', '$1' . str_repeat( '#', $length - 4 ) . '$2', $string_value );
} elseif ( $length > 19 && $length <= 31 ) {
return preg_replace( '/^(.{3}).*(.{3})$/', '$1' . str_repeat( '#', $length - 6 ) . '$2', $string_value );
}
return preg_replace( '/^(.{4}).*(.{4})$/', '$1' . str_repeat( '#', $length - 8 ) . '$2', $string_value );
}
}
Template_Checker_Report.php 0000644 00000007406 15043730706 0012023 0 ustar 00 $plugin_template_system ) {
self::generate_for( $plugin_name, $plugin_template_system );
}
self::wrap_report();
return self::$complete_report;
}
protected static function registered_plugins() {
/**
* Provides a mechanism for plugins to register information about their template/view
* setups.
*
* This should be done by adding an entry to $registere_template_systems where the key
* should be the plugin name and the element an array structured as follows:
*
* [
* plugin_version,
* path_to_included_views,
* path_to_theme_overrides
* ]
*
* @var array $registered_template_systems
*/
return apply_filters( 'tribe_support_registered_template_systems', [] );
}
/**
* Creates a report for the specified plugin.
*
* @param string $plugin_name
* @param array $template_system
*/
protected static function generate_for( $plugin_name, array $template_system ) {
$report = '' . esc_html( $plugin_name ) . '';
$scanner = new Tribe__Support__Template_Checker(
$template_system[ self::VERSION_INDEX ],
$template_system[ self::INCLUDED_VIEWS_INDEX ],
$template_system[ self::THEME_OVERRIDES_INDEX ]
);
$newly_introduced_or_updated = $scanner->get_views_tagged_this_release();
$outdated_or_unknown = $scanner->get_outdated_overrides( true );
if ( empty( $newly_introduced_or_updated ) && empty( $outdated_or_unknown ) ) {
$report .= '' . __( 'No notable changes detected', 'tribe-common' ) . '';
}
if ( ! empty( $newly_introduced_or_updated ) ) {
$report .= '' . sprintf( __( 'Templates introduced or updated with this release (%s):', 'tribe-common' ), $template_system[ self::VERSION_INDEX ] ) . '
';
foreach ( $newly_introduced_or_updated as $view_name => $version ) {
$report .= '- ' . esc_html( $view_name ) . '
';
}
$report .= '
';
}
if ( ! empty( $outdated_or_unknown ) ) {
$report .= '' . __( 'Existing theme overrides that may need revision:', 'tribe-common' ) . '
';
foreach ( $outdated_or_unknown as $view_name => $version ) {
$version_note = empty( $version )
? __( 'version data missing from override', 'tribe-common' )
: sprintf( __( 'based on %s version', 'tribe-common' ), $version );
$report .= '- ' . esc_html( $view_name ) . ' (' . $version_note . ')
';
}
$report .= '
';
}
self::$plugin_reports[ $plugin_name ] = $report;
}
/**
* Wraps the individual plugin template reports ready for display.
*/
protected static function wrap_report() {
if ( empty( self::$plugin_reports ) ) {
self::$complete_report = '' . __( 'No notable template changes detected.', 'tribe-common' ) . '
';
} else {
self::$complete_report = '' . __( 'Information about recent template changes and potentially impacted template overrides is provided below.', 'tribe-common' ) . '
'
. '' . join( ' ', self::$plugin_reports ) . '
';
}
}
}
Template_Checker.php 0000644 00000016715 15043730706 0010473 0 ustar 00 plugin_version = $this->base_version_number( $plugin_version );
$this->plugin_views_dir = $plugin_views_dir;
$this->theme_views_dir = $theme_views_dir;
$this->scan_view_directory();
$this->scan_for_overrides();
}
/**
* Given a version number with an alpha/beta type suffix, strips that suffix and
* returns the "base" version number.
*
* For example, given "9.8.2beta1" this method will return "9.8.2".
*
* The utility of this is that if the author of a template change sets the
* version tag in the template header to 9.8.2 (to continue the same example) we
* don't need to worry about updating that for each alpha, beta or RC we put out.
*
* @param string $version_number
*
* @return string
*/
protected function base_version_number( $version_number ) {
return preg_replace( '/[a-z]+[a-z0-9]*$/i', '', $version_number );
}
/**
* Recursively scans the plugin's view directory and examines the template headers
* of each file it finds within.
*/
protected function scan_view_directory() {
// If the provided directory is invalid flag the problem and go no further
if ( $this->bad_directory( $this->plugin_views_dir ) ) {
return;
}
$view_directory = new RecursiveDirectoryIterator( $this->plugin_views_dir );
$directory_list = new RecursiveIteratorIterator( $view_directory );
foreach ( $directory_list as $file ) {
$this->scan_view( $file );
}
}
/**
* Scans an individual view file, adding it's version number (if found) to the
* $this->views array.
*
* @param SplFileInfo $file
*/
protected function scan_view( SplFileInfo $file ) {
if ( ! $file->isFile() || ! $file->isReadable() ) {
return;
}
$version = $this->get_template_version( $file->getPathname() );
$this->originals[ $this->short_name( $file->getPathname() ) ] = $version;
}
protected function scan_for_overrides() {
// If the provided directory is invalid flag the problem and go no further
if ( $this->bad_directory( $this->theme_views_dir ) ) {
return;
}
foreach ( $this->originals as $view_file => $current_version ) {
$override_path = trailingslashit( $this->theme_views_dir ) . $view_file;
if ( ! is_file( $override_path ) || ! is_readable( $override_path ) ) {
continue;
}
$this->overrides[ $view_file ] = $this->get_template_version( $override_path );
}
}
/**
* Tests to ensure the provided view directory path is invalid or unreadable.
*
* @param string $directory
* @return bool
*/
protected function bad_directory( $directory ) {
if ( is_dir( $directory ) && is_readable( $directory ) ) {
return false;
}
return true;
}
/**
* Inspects the template header block within the specified file and extracts the
* version number, if one can be found.
*
* @param string $template_filepath
* @return string
*/
protected function get_template_version( $template_filepath ) {
if ( ! is_file( $template_filepath ) || ! is_readable( $template_filepath ) ) {
return '';
}
$view_content = file_get_contents( $template_filepath );
if ( ! preg_match( '/^\s*\*\s*@version\s*([0-9\.]+)/mi', $view_content, $matches ) ) {
return '';
}
return $matches[1];
}
/**
* Given a full filepath (ie, to a view file), chops off the base path found
* in $this->plugin_views_dir.
*
* For example, given:
*
* $this->plugin_views_dir = '/srv/project/wp-content/plugins/my-plugin/views'
* $full_filepath = '/srv/project/wp-content/plugins/my-plugin/views/modules/icon.php'
*
* Returns:
*
* 'modules/icon.php'
*
* @param string $full_filepath
* @return string
*/
protected function short_name( $full_filepath ) {
if ( 0 === strpos( $full_filepath, $this->plugin_views_dir ) ) {
return trim( substr( $full_filepath, strlen( $this->plugin_views_dir ) ), DIRECTORY_SEPARATOR );
}
return $full_filepath;
}
/**
* Returns an array of the plugin's shipped view files, where each key is the
* view filename and the value is the version it was last updated.
*
* @return array
*/
public function get_views() {
return $this->originals;
}
/**
* Returns an array of any or all of the plugin's shipped view files that contain
* a version field in their header blocks.
*
* @see $this->get_views() for format of returned array
*
* @return array
*/
public function get_versioned_views() {
$versioned_views = [];
foreach ( $this->originals as $key => $version ) {
if ( ! empty( $version ) ) {
$versioned_views[ $key ] = $version;
}
}
return $versioned_views;
}
/**
* Returns an array of any shipped plugin views that were updated or introduced
* with the current release (as specified by $this->plugin_version).
*
* @see $this->get_views() for format of returned array
*
* @return array
*/
public function get_views_tagged_this_release() {
$currently_tagged_views = [];
foreach ( $this->get_versioned_views() as $key => $version ) {
if ( $version === $this->plugin_version ) {
$currently_tagged_views[ $key ] = $version;
}
}
return $currently_tagged_views;
}
/**
* Returns an array of theme overrides, where each key is the view filename and the
* value is the version it was last updated (may be empty).
*
* @return array
*/
public function get_overrides() {
return $this->overrides;
}
/**
* Returns an array of any or all theme overrides that contain a version field in their
* header blocks.
*
* @see $this->get_overrides() for format of returned array
*
* @return array
*/
public function get_versioned_overrides() {
$versioned_views = [];
foreach ( $this->overrides as $key => $version ) {
if ( ! empty( $version ) ) {
$versioned_views[ $key ] = $version;
}
}
return $versioned_views;
}
/**
* Returns an array of any or all theme overrides that seem to be based on an earlier
* version than that which currently ships with the plugin.
*
* If optional param $include_unknown is set to true, the list will include theme
* overrides where the version could not be determined (for instance, this might result
* in theme overrides where the template header - or version tag - was removed being
* included).
*
* @see $this->get_overrides() for format of returned array
*
* @param bool $include_unknown = false
* @return array
*/
public function get_outdated_overrides( $include_unknown = false ) {
$outdated = [];
$originals = $this->get_versioned_views();
$overrides = $include_unknown
? $this->get_overrides()
: $this->get_versioned_overrides();
foreach ( $overrides as $view => $override_version ) {
if ( empty( $originals[ $view ] ) ) {
continue;
}
$shipped_version = $originals[ $view ];
if ( version_compare( $shipped_version, $override_version, '>' ) ) {
$outdated[ $view ] = $override_version;
}
}
return $outdated;
}
}