You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
455 lines
16 KiB
455 lines
16 KiB
<?php
|
|
/**
|
|
* TablePress CSS Class
|
|
*
|
|
* @package TablePress
|
|
* @subpackage CSS
|
|
* @author Tobias Bäthge
|
|
* @since 1.1.0
|
|
*/
|
|
|
|
// Prohibit direct script loading.
|
|
defined( 'ABSPATH' ) || die( 'No direct script access allowed!' );
|
|
|
|
/**
|
|
* TablePress CSS Class
|
|
*
|
|
* @package TablePress
|
|
* @subpackage CSS
|
|
* @author Tobias Bäthge
|
|
* @since 1.1.0
|
|
*/
|
|
class TablePress_CSS {
|
|
|
|
/**
|
|
* Sanitize and tidy a string of CSS.
|
|
*
|
|
* @since 1.1.0
|
|
*
|
|
* @param string $css CSS code.
|
|
* @return string Sanitized and tidied CSS code.
|
|
*/
|
|
public function sanitize_css( string $css ): string {
|
|
$csstidy = TablePress::load_class( 'TablePress_CSSTidy', 'class.csstidy.php', 'libraries/csstidy' );
|
|
|
|
// Sanitization and not just tidying for users without enough privileges.
|
|
if ( ! current_user_can( 'unfiltered_html' ) ) {
|
|
// Let "arrows" survive, otherwise this might be recognized as the beginning of an HTML tag and removed with other stuff behind it.
|
|
$css = str_replace( '<=', '<=', $css );
|
|
// Remove all HTML tags.
|
|
$css = wp_kses( $css, 'strip' );
|
|
// KSES replaces single ">" with ">", but ">" is valid in CSS selectors.
|
|
$css = str_replace( '>', '>', $css );
|
|
// strip_tags again, because of the just added ">" (KSES for a second time would again bring the ">" problem).
|
|
$css = strip_tags( $css );
|
|
}
|
|
|
|
$csstidy->set_cfg( 'remove_bslash', false );
|
|
$csstidy->set_cfg( 'compress_colors', false );
|
|
$csstidy->set_cfg( 'compress_font-weight', false );
|
|
$csstidy->set_cfg( 'lowercase_s', false );
|
|
$csstidy->set_cfg( 'optimise_shorthands', false );
|
|
$csstidy->set_cfg( 'remove_last_;', false );
|
|
$csstidy->set_cfg( 'case_properties', false );
|
|
$csstidy->set_cfg( 'sort_properties', false );
|
|
$csstidy->set_cfg( 'sort_selectors', false );
|
|
$csstidy->set_cfg( 'discard_invalid_selectors', false );
|
|
$csstidy->set_cfg( 'discard_invalid_properties', true );
|
|
$csstidy->set_cfg( 'merge_selectors', false );
|
|
$csstidy->set_cfg( 'css_level', 'CSS3.0' );
|
|
$csstidy->set_cfg( 'preserve_css', true );
|
|
$csstidy->set_cfg( 'timestamp', false );
|
|
$csstidy->set_cfg( 'template', 'default' );
|
|
|
|
$csstidy->parse( $css );
|
|
return $csstidy->print->plain();
|
|
}
|
|
|
|
/**
|
|
* Minify a string of CSS code, that should have been sanitized/tidied before.
|
|
*
|
|
* @since 1.1.0
|
|
*
|
|
* @param string $css CSS code.
|
|
* @return string Minified CSS code.
|
|
*/
|
|
public function minify_css( string $css ): string {
|
|
$csstidy = TablePress::load_class( 'TablePress_CSSTidy', 'class.csstidy.php', 'libraries/csstidy' );
|
|
$csstidy->set_cfg( 'remove_bslash', false );
|
|
$csstidy->set_cfg( 'compress_colors', true );
|
|
$csstidy->set_cfg( 'compress_font-weight', true );
|
|
$csstidy->set_cfg( 'lowercase_s', false );
|
|
$csstidy->set_cfg( 'optimise_shorthands', 1 );
|
|
$csstidy->set_cfg( 'remove_last_;', true );
|
|
$csstidy->set_cfg( 'case_properties', false );
|
|
$csstidy->set_cfg( 'sort_properties', false );
|
|
$csstidy->set_cfg( 'sort_selectors', false );
|
|
$csstidy->set_cfg( 'discard_invalid_selectors', false );
|
|
$csstidy->set_cfg( 'discard_invalid_properties', true );
|
|
$csstidy->set_cfg( 'merge_selectors', false );
|
|
$csstidy->set_cfg( 'css_level', 'CSS3.0' );
|
|
$csstidy->set_cfg( 'preserve_css', false );
|
|
$csstidy->set_cfg( 'timestamp', false );
|
|
$csstidy->set_cfg( 'template', 'highest' );
|
|
|
|
$csstidy->parse( $css );
|
|
return $csstidy->print->plain();
|
|
}
|
|
|
|
/**
|
|
* Get the location (file path or URL) of the "Custom CSS" file, depending on whether it's a Multisite install or not.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $type "normal" version, "minified" version, or "combined" (with TablePress Default CSS) version.
|
|
* @param string $location "path" or "url", for file path or URL.
|
|
* @return string Full file path or full URL for the "Custom CSS" file.
|
|
*/
|
|
public function get_custom_css_location( string $type, string $location ): string {
|
|
switch ( $type ) {
|
|
case 'combined':
|
|
$file = 'tablepress-combined.min.css';
|
|
break;
|
|
case 'minified':
|
|
$file = 'tablepress-custom.min.css';
|
|
break;
|
|
case 'normal':
|
|
default:
|
|
$file = 'tablepress-custom.css';
|
|
break;
|
|
}
|
|
|
|
if ( is_multisite() ) {
|
|
// Multisite installation: Use /wp-content/uploads/sites/<ID>/.
|
|
$upload_location = wp_upload_dir();
|
|
} else {
|
|
// Singlesite installation: Use /wp-content/.
|
|
$upload_location = array(
|
|
'basedir' => WP_CONTENT_DIR,
|
|
'baseurl' => content_url(),
|
|
);
|
|
}
|
|
|
|
switch ( $location ) {
|
|
case 'url':
|
|
$url = set_url_scheme( $upload_location['baseurl'] . '/' . $file );
|
|
/**
|
|
* Filters the URL from which the "Custom CSS" file is loaded.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $url URL of the "Custom CSS" file.
|
|
* @param string $file File name of the "Custom CSS" file.
|
|
* @param string $type Type of the "Custom CSS" file ("normal", "minified", or "combined").
|
|
*/
|
|
$url = apply_filters( 'tablepress_custom_css_url', $url, $file, $type );
|
|
return $url;
|
|
// break; // unreachable.
|
|
case 'path':
|
|
$path = $upload_location['basedir'] . '/' . $file;
|
|
/**
|
|
* Filters the file path on the server from which the "Custom CSS" file is loaded.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $path File path of the "Custom CSS" file.
|
|
* @param string $file File name of the "Custom CSS" file.
|
|
* @param string $type Type of the "Custom CSS" file ("normal", "minified", or "combined").
|
|
*/
|
|
$path = apply_filters( 'tablepress_custom_css_file_name', $path, $file, $type );
|
|
return $path;
|
|
// break; // unreachable.
|
|
default:
|
|
// Return an empty string if no valid location was provided.
|
|
return '';
|
|
// break; // unreachable.
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load the contents of the file with the "Custom CSS".
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $type Optional. Whether to load "normal" version or "minified" version. Default "normal".
|
|
* @return string|false Custom CSS on success, false on error.
|
|
*/
|
|
public function load_custom_css_from_file( string $type = 'normal' ) /* : string|false */ {
|
|
$filename = $this->get_custom_css_location( $type, 'path' );
|
|
// Check if file name is valid (0 means yes).
|
|
if ( 0 !== validate_file( $filename ) ) {
|
|
return false;
|
|
}
|
|
if ( ! @is_file( $filename ) ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
|
|
return false;
|
|
}
|
|
if ( ! @is_readable( $filename ) ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
|
|
return false;
|
|
}
|
|
return file_get_contents( $filename );
|
|
}
|
|
|
|
/**
|
|
* Loads the contents of the file with the TablePress Default CSS,
|
|
* either for left-to-right (LTR) or right-to-left (RTL), in minified form.
|
|
*
|
|
* @since 1.1.0
|
|
* @since 2.0.0 Added the `$load_rtl` parameter.
|
|
*
|
|
* @param bool $load_rtl Optional. Whether to load LTR or RTL version. Default LTR.
|
|
* @return string|false TablePress Default CSS on success, false on error.
|
|
*/
|
|
public function load_default_css_from_file( bool $load_rtl = false ) /* : string|false */ {
|
|
$rtl = $load_rtl ? '-rtl' : '';
|
|
$filename = TABLEPRESS_ABSPATH . "css/build/default{$rtl}.css";
|
|
// Check if file name is valid (0 means yes).
|
|
if ( 0 !== validate_file( $filename ) ) {
|
|
return false;
|
|
}
|
|
if ( ! @is_file( $filename ) ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
|
|
return false;
|
|
}
|
|
if ( ! @is_readable( $filename ) ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
|
|
return false;
|
|
}
|
|
return file_get_contents( $filename );
|
|
}
|
|
|
|
/**
|
|
* Try to save "Custom CSS" to a file (requires "direct" method in WP_Filesystem, or stored FTP credentials).
|
|
*
|
|
* @since 1.1.0
|
|
*
|
|
* @param string $custom_css_normal Custom CSS code to be saved.
|
|
* @param string $custom_css_minified Minified CSS code to be saved.
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
public function save_custom_css_to_file( string $custom_css_normal, string $custom_css_minified ): bool {
|
|
/**
|
|
* Filters whether the "Custom CSS" code shall be saved to a file on the server.
|
|
*
|
|
* @since 1.1.0
|
|
*
|
|
* @param bool $save Whether to save the "Custom CSS" to a file. Default true.
|
|
*/
|
|
if ( ! apply_filters( 'tablepress_save_custom_css_to_file', true ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Start capturing the output, to later prevent it.
|
|
ob_start();
|
|
$credentials = request_filesystem_credentials( '', '', false, '', null, false );
|
|
|
|
/*
|
|
* Do we have credentials already? (Otherwise the form will have been rendered, which is not supported here.)
|
|
* Or, if we have credentials, are they valid?
|
|
*/
|
|
if ( false === $credentials || ! WP_Filesystem( $credentials ) ) { // @phpstan-ignore-line
|
|
ob_end_clean();
|
|
return false;
|
|
}
|
|
|
|
// We have valid access to the filesystem now -> try to save the files.
|
|
return $this->_custom_css_save_helper( $custom_css_normal, $custom_css_minified );
|
|
}
|
|
|
|
/**
|
|
* Save "Custom CSS" to files, delete "Custom CSS" files, or return HTML for the credentials form.
|
|
*
|
|
* Only used from "Plugin Options" screen, save_custom_css_to_file() is used in cases where no form output/redirection is possible (e.g. during plugin updates).
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $custom_css_normal Custom CSS code to be saved. If empty, files will be deleted.
|
|
* @param string $custom_css_minified Minified CSS code to be saved.
|
|
* @return bool|string True on success, false on failure, or string of HTML for the credentials form for the WP_Filesystem API, if necessary.
|
|
*/
|
|
public function save_custom_css_to_file_plugin_options( string $custom_css_normal, string $custom_css_minified ) /* : bool|string */ {
|
|
/** This filter is documented in classes/class-css.php */
|
|
if ( ! apply_filters( 'tablepress_save_custom_css_to_file', true ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Start capturing the output, to get HTML of the credentials form (if needed).
|
|
ob_start();
|
|
$credentials = request_filesystem_credentials( '', '', false, '', null, false );
|
|
// Do we have credentials already? Otherwise the form will have been rendered already.
|
|
if ( false === $credentials ) {
|
|
$form_data = ob_get_clean();
|
|
$form_data = str_replace( 'name="upgrade" id="upgrade" class="button"', 'name="upgrade" id="upgrade" class="button button-primary button-large"', $form_data ); // @phpstan-ignore-line
|
|
return $form_data;
|
|
}
|
|
|
|
// We have received credentials, but don't know if they are valid yet.
|
|
if ( ! WP_Filesystem( $credentials ) ) { // @phpstan-ignore-line
|
|
// Credentials failed, so ask again (with $error flag true).
|
|
request_filesystem_credentials( '', '', true, '', null, false );
|
|
$form_data = ob_get_clean();
|
|
$form_data = str_replace( 'name="upgrade" id="upgrade" class="button"', 'name="upgrade" id="upgrade" class="button button-primary button-large"', $form_data ); // @phpstan-ignore-line
|
|
return $form_data;
|
|
}
|
|
|
|
// We have valid access to the filesystem now -> try to save the files, or delete them if the "Custom CSS" is empty.
|
|
if ( '' !== $custom_css_normal ) {
|
|
return $this->_custom_css_save_helper( $custom_css_normal, $custom_css_minified );
|
|
} else {
|
|
return $this->_custom_css_delete_helper();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save "Custom CSS" to files, if validated access to the WP_Filesystem exists.
|
|
*
|
|
* Helper function to prevent code duplication.
|
|
*
|
|
* @since 1.1.0
|
|
*
|
|
* @global WP_Filesystem_* $wp_filesystem WordPress file system abstraction object.
|
|
* @see save_custom_css_to_file()
|
|
* @see save_custom_css_to_file_plugin_options()
|
|
*
|
|
* @param string $custom_css_normal Custom CSS code to be saved.
|
|
* @param string $custom_css_minified Minified CSS code to be saved.
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
protected function _custom_css_save_helper( string $custom_css_normal, string $custom_css_minified ): bool {
|
|
global $wp_filesystem;
|
|
|
|
/*
|
|
* WP_CONTENT_DIR and (FTP-)Content-Dir can be different (e.g. if FTP working dir is /).
|
|
* We need to account for that by replacing the path difference in the filename.
|
|
*/
|
|
$path_difference = str_replace( $wp_filesystem->wp_content_dir(), '', trailingslashit( WP_CONTENT_DIR ) );
|
|
|
|
$css_types = array( 'normal', 'minified', 'combined' );
|
|
|
|
$default_css_minified = $this->load_default_css_from_file( false );
|
|
if ( false === $default_css_minified ) {
|
|
$default_css_minified = '';
|
|
} else {
|
|
// Change relative URLs to web font files to absolute URLs, as combining the CSS files and saving to another directory breaks the relative URLs.
|
|
$absolute_path = plugins_url( 'css/build/tablepress.', TABLEPRESS__FILE__ );
|
|
// Make the absolute URL protocol-relative to prevent mixed content warnings.
|
|
$absolute_path = str_replace( array( 'http:', 'https:' ), '', $absolute_path );
|
|
$default_css_minified = str_replace( 'url(tablepress.', 'url(' . $absolute_path, $default_css_minified );
|
|
}
|
|
$file_content = array(
|
|
'normal' => $custom_css_normal,
|
|
'minified' => $custom_css_minified,
|
|
'combined' => $default_css_minified . $custom_css_minified,
|
|
);
|
|
|
|
$total_result = true; // Whether all files were saved successfully.
|
|
foreach ( $css_types as $css_type ) {
|
|
$filename = $this->get_custom_css_location( $css_type, 'path' );
|
|
// Check if filename is valid (0 means yes).
|
|
if ( 0 !== validate_file( $filename ) ) {
|
|
$total_result = false;
|
|
continue;
|
|
}
|
|
if ( '' !== $path_difference ) {
|
|
$filename = str_replace( $path_difference, '', $filename );
|
|
}
|
|
$result = $wp_filesystem->put_contents( $filename, $file_content[ $css_type ], FS_CHMOD_FILE );
|
|
$total_result = ( $total_result && $result );
|
|
}
|
|
|
|
$this->_flush_caching_plugins_css_minify_caches();
|
|
|
|
return $total_result;
|
|
}
|
|
|
|
/**
|
|
* Delete the "Custom CSS" files, if possible.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
public function delete_custom_css_files(): bool {
|
|
// Start capturing the output, to later prevent it.
|
|
ob_start();
|
|
$credentials = request_filesystem_credentials( '', '', false, '', null, false );
|
|
|
|
/*
|
|
* Do we have credentials already? (Otherwise the form will have been rendered, which is not supported here.)
|
|
* Or, if we have credentials, are they valid?
|
|
*/
|
|
if ( false === $credentials || ! WP_Filesystem( $credentials ) ) { // @phpstan-ignore-line
|
|
ob_end_clean();
|
|
return false;
|
|
}
|
|
|
|
// We have valid access to the filesystem now -> try to delete the files.
|
|
return $this->_custom_css_delete_helper();
|
|
}
|
|
|
|
/**
|
|
* Delete "Custom CSS" files, if validated access to the WP_Filesystem exists.
|
|
*
|
|
* Helper function to prevent code duplication
|
|
*
|
|
* @since 1.1.0
|
|
*
|
|
* @global WP_Filesystem_* $wp_filesystem WordPress file system abstraction object.
|
|
* @see delete_custom_css_files()
|
|
* @see save_custom_css_to_file_plugin_options()
|
|
*
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
protected function _custom_css_delete_helper(): bool {
|
|
global $wp_filesystem;
|
|
|
|
/*
|
|
* WP_CONTENT_DIR and (FTP-)Content-Dir can be different (e.g. if FTP working dir is /).
|
|
* We need to account for that by replacing the path difference in the filename.
|
|
*/
|
|
$path_difference = str_replace( $wp_filesystem->wp_content_dir(), '', trailingslashit( WP_CONTENT_DIR ) );
|
|
|
|
$css_types = array( 'normal', 'minified', 'combined' );
|
|
$total_result = true; // Whether all files were deleted successfully.
|
|
foreach ( $css_types as $css_type ) {
|
|
$filename = $this->get_custom_css_location( $css_type, 'path' );
|
|
// Check if filename is valid (0 means yes).
|
|
if ( 0 !== validate_file( $filename ) ) {
|
|
$total_result = false;
|
|
continue;
|
|
}
|
|
if ( '' !== $path_difference ) {
|
|
$filename = str_replace( $path_difference, '', $filename );
|
|
}
|
|
// We have valid access to the filesystem now -> try to delete the file.
|
|
if ( $wp_filesystem->exists( $filename ) ) {
|
|
$result = $wp_filesystem->delete( $filename );
|
|
$total_result = ( $total_result && $result );
|
|
}
|
|
}
|
|
|
|
$this->_flush_caching_plugins_css_minify_caches();
|
|
|
|
return $total_result;
|
|
}
|
|
|
|
/**
|
|
* Flush the CSS minification caches of common caching plugins.
|
|
*
|
|
* @since 1.4.0
|
|
*/
|
|
protected function _flush_caching_plugins_css_minify_caches(): void {
|
|
/** This filter is documented in models/model-table.php */
|
|
if ( ! apply_filters( 'tablepress_flush_caching_plugins_caches', true ) ) {
|
|
return;
|
|
}
|
|
|
|
// W3 Total Cache.
|
|
if ( function_exists( 'w3tc_minify_flush' ) ) {
|
|
w3tc_minify_flush();
|
|
}
|
|
// WP Fastest Cache.
|
|
if ( isset( $GLOBALS['wp_fastest_cache'] ) && is_callable( array( $GLOBALS['wp_fastest_cache'], 'deleteCache' ) ) ) {
|
|
$GLOBALS['wp_fastest_cache']->deleteCache( true ); // @phpstan-ignore-line
|
|
}
|
|
}
|
|
|
|
} // class TablePress_CSS
|