@@ -117,29 +117,29 @@ discard block |
||
| 117 | 117 | |
| 118 | 118 | function wpinv_get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) { |
| 119 | 119 | if ( ! empty( $args ) && is_array( $args ) ) { |
| 120 | - extract( $args ); |
|
| 121 | - } |
|
| 120 | + extract( $args ); |
|
| 121 | + } |
|
| 122 | 122 | |
| 123 | - $located = wpinv_locate_template( $template_name, $template_path, $default_path ); |
|
| 124 | - if ( ! file_exists( $located ) ) { |
|
| 123 | + $located = wpinv_locate_template( $template_name, $template_path, $default_path ); |
|
| 124 | + if ( ! file_exists( $located ) ) { |
|
| 125 | 125 | _doing_it_wrong( __FUNCTION__, sprintf( '<code>%s</code> does not exist.', $located ), '2.1' ); |
| 126 | - return; |
|
| 127 | - } |
|
| 126 | + return; |
|
| 127 | + } |
|
| 128 | 128 | |
| 129 | - // Allow 3rd party plugin filter template file from their plugin. |
|
| 130 | - $located = apply_filters( 'wpinv_get_template', $located, $template_name, $args, $template_path, $default_path ); |
|
| 129 | + // Allow 3rd party plugin filter template file from their plugin. |
|
| 130 | + $located = apply_filters( 'wpinv_get_template', $located, $template_name, $args, $template_path, $default_path ); |
|
| 131 | 131 | |
| 132 | - do_action( 'wpinv_before_template_part', $template_name, $template_path, $located, $args ); |
|
| 132 | + do_action( 'wpinv_before_template_part', $template_name, $template_path, $located, $args ); |
|
| 133 | 133 | |
| 134 | - include( $located ); |
|
| 134 | + include( $located ); |
|
| 135 | 135 | |
| 136 | - do_action( 'wpinv_after_template_part', $template_name, $template_path, $located, $args ); |
|
| 136 | + do_action( 'wpinv_after_template_part', $template_name, $template_path, $located, $args ); |
|
| 137 | 137 | } |
| 138 | 138 | |
| 139 | 139 | function wpinv_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) { |
| 140 | - ob_start(); |
|
| 141 | - wpinv_get_template( $template_name, $args, $template_path, $default_path ); |
|
| 142 | - return ob_get_clean(); |
|
| 140 | + ob_start(); |
|
| 141 | + wpinv_get_template( $template_name, $args, $template_path, $default_path ); |
|
| 142 | + return ob_get_clean(); |
|
| 143 | 143 | } |
| 144 | 144 | |
| 145 | 145 | function wpinv_locate_template( $template_name, $template_path = '', $default_path = '' ) { |
@@ -169,120 +169,120 @@ discard block |
||
| 169 | 169 | } |
| 170 | 170 | |
| 171 | 171 | function wpinv_get_template_part( $slug, $name = null, $load = true ) { |
| 172 | - do_action( 'get_template_part_' . $slug, $slug, $name ); |
|
| 172 | + do_action( 'get_template_part_' . $slug, $slug, $name ); |
|
| 173 | 173 | |
| 174 | - // Setup possible parts |
|
| 175 | - $templates = array(); |
|
| 176 | - if ( isset( $name ) ) |
|
| 177 | - $templates[] = $slug . '-' . $name . '.php'; |
|
| 178 | - $templates[] = $slug . '.php'; |
|
| 174 | + // Setup possible parts |
|
| 175 | + $templates = array(); |
|
| 176 | + if ( isset( $name ) ) |
|
| 177 | + $templates[] = $slug . '-' . $name . '.php'; |
|
| 178 | + $templates[] = $slug . '.php'; |
|
| 179 | 179 | |
| 180 | - // Allow template parts to be filtered |
|
| 181 | - $templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name ); |
|
| 180 | + // Allow template parts to be filtered |
|
| 181 | + $templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name ); |
|
| 182 | 182 | |
| 183 | - // Return the part that is found |
|
| 184 | - return wpinv_locate_tmpl( $templates, $load, false ); |
|
| 183 | + // Return the part that is found |
|
| 184 | + return wpinv_locate_tmpl( $templates, $load, false ); |
|
| 185 | 185 | } |
| 186 | 186 | |
| 187 | 187 | function wpinv_locate_tmpl( $template_names, $load = false, $require_once = true ) { |
| 188 | - // No file found yet |
|
| 189 | - $located = false; |
|
| 188 | + // No file found yet |
|
| 189 | + $located = false; |
|
| 190 | 190 | |
| 191 | - // Try to find a template file |
|
| 192 | - foreach ( (array)$template_names as $template_name ) { |
|
| 191 | + // Try to find a template file |
|
| 192 | + foreach ( (array)$template_names as $template_name ) { |
|
| 193 | 193 | |
| 194 | - // Continue if template is empty |
|
| 195 | - if ( empty( $template_name ) ) |
|
| 196 | - continue; |
|
| 194 | + // Continue if template is empty |
|
| 195 | + if ( empty( $template_name ) ) |
|
| 196 | + continue; |
|
| 197 | 197 | |
| 198 | - // Trim off any slashes from the template name |
|
| 199 | - $template_name = ltrim( $template_name, '/' ); |
|
| 198 | + // Trim off any slashes from the template name |
|
| 199 | + $template_name = ltrim( $template_name, '/' ); |
|
| 200 | 200 | |
| 201 | - // try locating this template file by looping through the template paths |
|
| 202 | - foreach( wpinv_get_theme_template_paths() as $template_path ) { |
|
| 201 | + // try locating this template file by looping through the template paths |
|
| 202 | + foreach( wpinv_get_theme_template_paths() as $template_path ) { |
|
| 203 | 203 | |
| 204 | - if( file_exists( $template_path . $template_name ) ) { |
|
| 205 | - $located = $template_path . $template_name; |
|
| 206 | - break; |
|
| 207 | - } |
|
| 208 | - } |
|
| 204 | + if( file_exists( $template_path . $template_name ) ) { |
|
| 205 | + $located = $template_path . $template_name; |
|
| 206 | + break; |
|
| 207 | + } |
|
| 208 | + } |
|
| 209 | 209 | |
| 210 | - if( $located ) { |
|
| 211 | - break; |
|
| 212 | - } |
|
| 213 | - } |
|
| 210 | + if( $located ) { |
|
| 211 | + break; |
|
| 212 | + } |
|
| 213 | + } |
|
| 214 | 214 | |
| 215 | - if ( ( true == $load ) && ! empty( $located ) ) |
|
| 216 | - load_template( $located, $require_once ); |
|
| 215 | + if ( ( true == $load ) && ! empty( $located ) ) |
|
| 216 | + load_template( $located, $require_once ); |
|
| 217 | 217 | |
| 218 | - return $located; |
|
| 218 | + return $located; |
|
| 219 | 219 | } |
| 220 | 220 | |
| 221 | 221 | function wpinv_get_theme_template_paths() { |
| 222 | - $template_dir = wpinv_get_theme_template_dir_name(); |
|
| 222 | + $template_dir = wpinv_get_theme_template_dir_name(); |
|
| 223 | 223 | |
| 224 | - $file_paths = array( |
|
| 225 | - 1 => trailingslashit( get_stylesheet_directory() ) . $template_dir, |
|
| 226 | - 10 => trailingslashit( get_template_directory() ) . $template_dir, |
|
| 227 | - 100 => wpinv_get_templates_dir() |
|
| 228 | - ); |
|
| 224 | + $file_paths = array( |
|
| 225 | + 1 => trailingslashit( get_stylesheet_directory() ) . $template_dir, |
|
| 226 | + 10 => trailingslashit( get_template_directory() ) . $template_dir, |
|
| 227 | + 100 => wpinv_get_templates_dir() |
|
| 228 | + ); |
|
| 229 | 229 | |
| 230 | - $file_paths = apply_filters( 'wpinv_template_paths', $file_paths ); |
|
| 230 | + $file_paths = apply_filters( 'wpinv_template_paths', $file_paths ); |
|
| 231 | 231 | |
| 232 | - // sort the file paths based on priority |
|
| 233 | - ksort( $file_paths, SORT_NUMERIC ); |
|
| 232 | + // sort the file paths based on priority |
|
| 233 | + ksort( $file_paths, SORT_NUMERIC ); |
|
| 234 | 234 | |
| 235 | - return array_map( 'trailingslashit', $file_paths ); |
|
| 235 | + return array_map( 'trailingslashit', $file_paths ); |
|
| 236 | 236 | } |
| 237 | 237 | |
| 238 | 238 | function wpinv_get_theme_template_dir_name() { |
| 239 | - return trailingslashit( apply_filters( 'wpinv_templates_dir', 'wpinv_templates' ) ); |
|
| 239 | + return trailingslashit( apply_filters( 'wpinv_templates_dir', 'wpinv_templates' ) ); |
|
| 240 | 240 | } |
| 241 | 241 | |
| 242 | 242 | function wpinv_checkout_meta_tags() { |
| 243 | 243 | |
| 244 | - $pages = array(); |
|
| 245 | - $pages[] = wpinv_get_option( 'success_page' ); |
|
| 246 | - $pages[] = wpinv_get_option( 'failure_page' ); |
|
| 247 | - $pages[] = wpinv_get_option( 'invoice_history_page' ); |
|
| 244 | + $pages = array(); |
|
| 245 | + $pages[] = wpinv_get_option( 'success_page' ); |
|
| 246 | + $pages[] = wpinv_get_option( 'failure_page' ); |
|
| 247 | + $pages[] = wpinv_get_option( 'invoice_history_page' ); |
|
| 248 | 248 | |
| 249 | - if( !wpinv_is_checkout() && !is_page( $pages ) ) { |
|
| 250 | - return; |
|
| 251 | - } |
|
| 249 | + if( !wpinv_is_checkout() && !is_page( $pages ) ) { |
|
| 250 | + return; |
|
| 251 | + } |
|
| 252 | 252 | |
| 253 | - echo '<meta name="robots" content="noindex,nofollow" />' . "\n"; |
|
| 253 | + echo '<meta name="robots" content="noindex,nofollow" />' . "\n"; |
|
| 254 | 254 | } |
| 255 | 255 | add_action( 'wp_head', 'wpinv_checkout_meta_tags' ); |
| 256 | 256 | |
| 257 | 257 | function wpinv_add_body_classes( $class ) { |
| 258 | - $classes = (array)$class; |
|
| 258 | + $classes = (array)$class; |
|
| 259 | 259 | |
| 260 | - if( wpinv_is_checkout() ) { |
|
| 261 | - $classes[] = 'wpinv-checkout'; |
|
| 262 | - $classes[] = 'wpinv-page'; |
|
| 263 | - } |
|
| 260 | + if( wpinv_is_checkout() ) { |
|
| 261 | + $classes[] = 'wpinv-checkout'; |
|
| 262 | + $classes[] = 'wpinv-page'; |
|
| 263 | + } |
|
| 264 | 264 | |
| 265 | - if( wpinv_is_success_page() ) { |
|
| 266 | - $classes[] = 'wpinv-success'; |
|
| 267 | - $classes[] = 'wpinv-page'; |
|
| 268 | - } |
|
| 265 | + if( wpinv_is_success_page() ) { |
|
| 266 | + $classes[] = 'wpinv-success'; |
|
| 267 | + $classes[] = 'wpinv-page'; |
|
| 268 | + } |
|
| 269 | 269 | |
| 270 | - if( wpinv_is_failed_transaction_page() ) { |
|
| 271 | - $classes[] = 'wpinv-failed-transaction'; |
|
| 272 | - $classes[] = 'wpinv-page'; |
|
| 273 | - } |
|
| 270 | + if( wpinv_is_failed_transaction_page() ) { |
|
| 271 | + $classes[] = 'wpinv-failed-transaction'; |
|
| 272 | + $classes[] = 'wpinv-page'; |
|
| 273 | + } |
|
| 274 | 274 | |
| 275 | - if( wpinv_is_invoice_history_page() ) { |
|
| 276 | - $classes[] = 'wpinv-history'; |
|
| 277 | - $classes[] = 'wpinv-page'; |
|
| 278 | - } |
|
| 275 | + if( wpinv_is_invoice_history_page() ) { |
|
| 276 | + $classes[] = 'wpinv-history'; |
|
| 277 | + $classes[] = 'wpinv-page'; |
|
| 278 | + } |
|
| 279 | 279 | |
| 280 | - if( wpinv_is_test_mode() ) { |
|
| 281 | - $classes[] = 'wpinv-test-mode'; |
|
| 282 | - $classes[] = 'wpinv-page'; |
|
| 283 | - } |
|
| 280 | + if( wpinv_is_test_mode() ) { |
|
| 281 | + $classes[] = 'wpinv-test-mode'; |
|
| 282 | + $classes[] = 'wpinv-page'; |
|
| 283 | + } |
|
| 284 | 284 | |
| 285 | - return array_unique( $classes ); |
|
| 285 | + return array_unique( $classes ); |
|
| 286 | 286 | } |
| 287 | 287 | add_filter( 'body_class', 'wpinv_add_body_classes' ); |
| 288 | 288 | |
@@ -1442,7 +1442,7 @@ discard block |
||
| 1442 | 1442 | add_action( 'wpinv_checkout_cart', 'wpinv_checkout_cart', 10 ); |
| 1443 | 1443 | |
| 1444 | 1444 | function wpinv_empty_cart_message() { |
| 1445 | - return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' ); |
|
| 1445 | + return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' ); |
|
| 1446 | 1446 | } |
| 1447 | 1447 | |
| 1448 | 1448 | /** |
@@ -1452,7 +1452,7 @@ discard block |
||
| 1452 | 1452 | * @return void |
| 1453 | 1453 | */ |
| 1454 | 1454 | function wpinv_empty_checkout_cart() { |
| 1455 | - echo wpinv_empty_cart_message(); |
|
| 1455 | + echo wpinv_empty_cart_message(); |
|
| 1456 | 1456 | } |
| 1457 | 1457 | add_action( 'wpinv_cart_empty', 'wpinv_empty_checkout_cart' ); |
| 1458 | 1458 | |
@@ -1588,11 +1588,11 @@ discard block |
||
| 1588 | 1588 | $chosen_gateway = wpinv_get_chosen_gateway( $invoice_id ); |
| 1589 | 1589 | |
| 1590 | 1590 | if(!empty($gateways)){ |
| 1591 | - foreach ( $gateways as $gateway_id => $gateway ) { |
|
| 1592 | - $checked = checked( $gateway_id, $chosen_gateway, false ); |
|
| 1593 | - $button_label = wpinv_get_gateway_button_label( $gateway_id ); |
|
| 1594 | - $description = wpinv_get_gateway_description( $gateway_id ); |
|
| 1595 | - ?> |
|
| 1591 | + foreach ( $gateways as $gateway_id => $gateway ) { |
|
| 1592 | + $checked = checked( $gateway_id, $chosen_gateway, false ); |
|
| 1593 | + $button_label = wpinv_get_gateway_button_label( $gateway_id ); |
|
| 1594 | + $description = wpinv_get_gateway_description( $gateway_id ); |
|
| 1595 | + ?> |
|
| 1596 | 1596 | <div class="list-group-item"> |
| 1597 | 1597 | <div class="radio"> |
| 1598 | 1598 | <label><input type="radio" data-button-text="<?php echo esc_attr( $button_label );?>" value="<?php echo esc_attr( $gateway_id ) ;?>" <?php echo $checked ;?> id="wpi_gateway_<?php echo esc_attr( $gateway_id );?>" name="wpi-gateway" class="wpi-pmethod"><?php echo esc_html( $gateway['checkout_label'] ); ?></label> |
@@ -1605,9 +1605,9 @@ discard block |
||
| 1605 | 1605 | </div> |
| 1606 | 1606 | </div> |
| 1607 | 1607 | <?php |
| 1608 | - } |
|
| 1608 | + } |
|
| 1609 | 1609 | }else{ |
| 1610 | - echo '<div class="alert alert-warning">'. __('No payment gateway active','invoicing') .'</div>'; |
|
| 1610 | + echo '<div class="alert alert-warning">'. __('No payment gateway active','invoicing') .'</div>'; |
|
| 1611 | 1611 | } |
| 1612 | 1612 | |
| 1613 | 1613 | do_action( 'wpinv_payment_mode_after_gateways' ); |
@@ -140,8 +140,8 @@ discard block |
||
| 140 | 140 | |
| 141 | 141 | function wpinv_get_default_labels() { |
| 142 | 142 | $defaults = array( |
| 143 | - 'singular' => __( 'Invoice', 'invoicing' ), |
|
| 144 | - 'plural' => __( 'Invoices', 'invoicing' ) |
|
| 143 | + 'singular' => __( 'Invoice', 'invoicing' ), |
|
| 144 | + 'plural' => __( 'Invoices', 'invoicing' ) |
|
| 145 | 145 | ); |
| 146 | 146 | |
| 147 | 147 | return apply_filters( 'wpinv_default_invoices_name', $defaults ); |
@@ -160,20 +160,20 @@ discard block |
||
| 160 | 160 | } |
| 161 | 161 | |
| 162 | 162 | function wpinv_change_default_title( $title ) { |
| 163 | - if ( !is_admin() ) { |
|
| 163 | + if ( !is_admin() ) { |
|
| 164 | 164 | $label = wpinv_get_label_singular(); |
| 165 | 165 | $title = sprintf( __( 'Enter %s name here', 'invoicing' ), $label ); |
| 166 | 166 | return $title; |
| 167 | - } |
|
| 167 | + } |
|
| 168 | 168 | |
| 169 | - $screen = get_current_screen(); |
|
| 169 | + $screen = get_current_screen(); |
|
| 170 | 170 | |
| 171 | - if ( 'wpi_invoice' == $screen->post_type ) { |
|
| 171 | + if ( 'wpi_invoice' == $screen->post_type ) { |
|
| 172 | 172 | $label = wpinv_get_label_singular(); |
| 173 | 173 | $title = sprintf( __( 'Enter %s name here', 'invoicing' ), $label ); |
| 174 | - } |
|
| 174 | + } |
|
| 175 | 175 | |
| 176 | - return $title; |
|
| 176 | + return $title; |
|
| 177 | 177 | } |
| 178 | 178 | add_filter( 'enter_title_here', 'wpinv_change_default_title' ); |
| 179 | 179 | |
@@ -166,13 +166,13 @@ |
||
| 166 | 166 | $is_writeable = $is_dir && is_writeable( $this->export_dir ); |
| 167 | 167 | |
| 168 | 168 | if ( $is_dir && $is_writeable ) { |
| 169 | - return true; |
|
| 169 | + return true; |
|
| 170 | 170 | } else if ( $is_dir && !$is_writeable ) { |
| 171 | - if ( !$this->wp_filesystem->chmod( $this->export_dir, FS_CHMOD_DIR ) ) { |
|
| 172 | - return wp_sprintf( __( 'Filesystem ERROR: Export location %s is not writable, check your file permissions.', 'invoicing' ), $this->export_dir ); |
|
| 173 | - } |
|
| 171 | + if ( !$this->wp_filesystem->chmod( $this->export_dir, FS_CHMOD_DIR ) ) { |
|
| 172 | + return wp_sprintf( __( 'Filesystem ERROR: Export location %s is not writable, check your file permissions.', 'invoicing' ), $this->export_dir ); |
|
| 173 | + } |
|
| 174 | 174 | |
| 175 | - return true; |
|
| 175 | + return true; |
|
| 176 | 176 | } else { |
| 177 | 177 | if ( !$this->wp_filesystem->mkdir( $this->export_dir, FS_CHMOD_DIR ) ) { |
| 178 | 178 | return wp_sprintf( __( 'Filesystem ERROR: Could not create directory %s. This is usually due to inconsistent file permissions.', 'invoicing' ), $this->export_dir ); |
@@ -437,7 +437,7 @@ |
||
| 437 | 437 | } |
| 438 | 438 | |
| 439 | 439 | function wpinv_get_php_arg_separator_output() { |
| 440 | - return ini_get( 'arg_separator.output' ); |
|
| 440 | + return ini_get( 'arg_separator.output' ); |
|
| 441 | 441 | } |
| 442 | 442 | |
| 443 | 443 | function wpinv_rgb_from_hex( $color ) { |
@@ -5,12 +5,12 @@ |
||
| 5 | 5 | // @codingStandardsIgnoreFile |
| 6 | 6 | |
| 7 | 7 | /** |
| 8 | - * This interface exists to provide backwards compatibility with PHP 5.3 |
|
| 9 | - * |
|
| 10 | - * This should _not_ be used by any third-party code. |
|
| 11 | - * |
|
| 12 | - * @ignore |
|
| 13 | - */ |
|
| 8 | + * This interface exists to provide backwards compatibility with PHP 5.3 |
|
| 9 | + * |
|
| 10 | + * This should _not_ be used by any third-party code. |
|
| 11 | + * |
|
| 12 | + * @ignore |
|
| 13 | + */ |
|
| 14 | 14 | if (interface_exists('JsonSerializable')) { |
| 15 | 15 | interface JsonSerializable extends \JsonSerializable |
| 16 | 16 | { |
@@ -9,780 +9,780 @@ |
||
| 9 | 9 | * @author Roman Ožana <[email protected]> |
| 10 | 10 | */ |
| 11 | 11 | class Emogrifier { |
| 12 | - /** |
|
| 13 | - * @var string |
|
| 14 | - */ |
|
| 15 | - const ENCODING = 'UTF-8'; |
|
| 16 | - |
|
| 17 | - /** |
|
| 18 | - * @var integer |
|
| 19 | - */ |
|
| 20 | - const CACHE_KEY_CSS = 0; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * @var integer |
|
| 24 | - */ |
|
| 25 | - const CACHE_KEY_SELECTOR = 1; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * @var integer |
|
| 29 | - */ |
|
| 30 | - const CACHE_KEY_XPATH = 2; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @var integer |
|
| 34 | - */ |
|
| 35 | - const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * for calculating nth-of-type and nth-child selectors. |
|
| 39 | - * |
|
| 40 | - * @var integer |
|
| 41 | - */ |
|
| 42 | - const INDEX = 0; |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * for calculating nth-of-type and nth-child selectors. |
|
| 46 | - * |
|
| 47 | - * @var integer |
|
| 48 | - */ |
|
| 49 | - const MULTIPLIER = 1; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 54 | - const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @var string |
|
| 58 | - */ |
|
| 59 | - const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * @var string |
|
| 63 | - */ |
|
| 64 | - private $html = ''; |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @var string |
|
| 68 | - */ |
|
| 69 | - private $css = ''; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * @var array<string> |
|
| 73 | - */ |
|
| 74 | - private $unprocessableHtmlTags = array('wbr'); |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * @var array<array> |
|
| 78 | - */ |
|
| 79 | - private $caches = array( |
|
| 80 | - self::CACHE_KEY_CSS => array(), |
|
| 81 | - self::CACHE_KEY_SELECTOR => array(), |
|
| 82 | - self::CACHE_KEY_XPATH => array(), |
|
| 83 | - self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
| 84 | - ); |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * the visited nodes with the XPath paths as array keys. |
|
| 88 | - * |
|
| 89 | - * @var array<\DOMNode> |
|
| 90 | - */ |
|
| 91 | - private $visitedNodes = array(); |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
| 95 | - * as key/value pairs for the inner array. |
|
| 96 | - * |
|
| 97 | - * @var array<array><string> |
|
| 98 | - */ |
|
| 99 | - private $styleAttributesForNodes = array(); |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * This attribute applies to the case where you want to preserve your original text encoding. |
|
| 103 | - * |
|
| 104 | - * By default, emogrifier translates your text into HTML entities for two reasons: |
|
| 105 | - * |
|
| 106 | - * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
| 107 | - * |
|
| 108 | - * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
| 109 | - * |
|
| 110 | - * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
| 111 | - * |
|
| 112 | - * @var boolean |
|
| 113 | - */ |
|
| 114 | - public $preserveEncoding = false; |
|
| 115 | - |
|
| 116 | - public static $_media = ''; |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * The constructor. |
|
| 120 | - * |
|
| 121 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 122 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 123 | - */ |
|
| 124 | - public function __construct($html = '', $css = '') { |
|
| 125 | - $this->setHtml($html); |
|
| 126 | - $this->setCss($css); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * The destructor. |
|
| 131 | - */ |
|
| 132 | - public function __destruct() { |
|
| 133 | - $this->purgeVisitedNodes(); |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Sets the HTML to emogrify. |
|
| 138 | - * |
|
| 139 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 140 | - */ |
|
| 141 | - public function setHtml($html = '') { |
|
| 142 | - $this->html = $html; |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Sets the CSS to merge with the HTML. |
|
| 147 | - * |
|
| 148 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 149 | - */ |
|
| 150 | - public function setCss($css = '') { |
|
| 151 | - $this->css = $css; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Clears all caches. |
|
| 156 | - */ |
|
| 157 | - private function clearAllCaches() { |
|
| 158 | - $this->clearCache(self::CACHE_KEY_CSS); |
|
| 159 | - $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
| 160 | - $this->clearCache(self::CACHE_KEY_XPATH); |
|
| 161 | - $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Clears a single cache by key. |
|
| 166 | - * |
|
| 167 | - * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
| 168 | - * |
|
| 169 | - * @throws InvalidArgumentException |
|
| 170 | - */ |
|
| 171 | - private function clearCache($key) { |
|
| 172 | - $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 173 | - if (!in_array($key, $allowedCacheKeys, true)) { |
|
| 174 | - throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - $this->caches[$key] = array(); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Purges the visited nodes. |
|
| 182 | - */ |
|
| 183 | - private function purgeVisitedNodes() { |
|
| 184 | - $this->visitedNodes = array(); |
|
| 185 | - $this->styleAttributesForNodes = array(); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Marks a tag for removal. |
|
| 190 | - * |
|
| 191 | - * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
| 192 | - * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
| 193 | - * |
|
| 194 | - * Note: The tags will not be removed if they have any content. |
|
| 195 | - * |
|
| 196 | - * @param string $tagName the tag name, e.g., "p" |
|
| 197 | - */ |
|
| 198 | - public function addUnprocessableHtmlTag($tagName) { |
|
| 199 | - $this->unprocessableHtmlTags[] = $tagName; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * Drops a tag from the removal list. |
|
| 204 | - * |
|
| 205 | - * @param string $tagName the tag name, e.g., "p" |
|
| 206 | - */ |
|
| 207 | - public function removeUnprocessableHtmlTag($tagName) { |
|
| 208 | - $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
| 209 | - if ($key !== false) { |
|
| 210 | - unset($this->unprocessableHtmlTags[$key]); |
|
| 211 | - } |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Applies the CSS you submit to the HTML you submit. |
|
| 216 | - * |
|
| 217 | - * This method places the CSS inline. |
|
| 218 | - * |
|
| 219 | - * @return string |
|
| 220 | - * |
|
| 221 | - * @throws BadMethodCallException |
|
| 222 | - */ |
|
| 223 | - public function emogrify() { |
|
| 224 | - if ($this->html === '') { |
|
| 225 | - throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - $xmlDocument = $this->createXmlDocument(); |
|
| 229 | - $xpath = new DOMXPath($xmlDocument); |
|
| 230 | - $this->clearAllCaches(); |
|
| 231 | - |
|
| 232 | - // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
| 233 | - // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
| 234 | - // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
| 235 | - $this->purgeVisitedNodes(); |
|
| 236 | - |
|
| 237 | - $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
| 238 | - if ($nodesWithStyleAttributes !== false) { |
|
| 239 | - /** @var $nodeWithStyleAttribute DOMNode */ |
|
| 240 | - foreach ($nodesWithStyleAttributes as $node) { |
|
| 241 | - $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
| 242 | - |
|
| 243 | - // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
| 244 | - $nodePath = $node->getNodePath(); |
|
| 245 | - if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
| 246 | - $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
| 247 | - $this->visitedNodes[$nodePath] = $node; |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - $node->setAttribute('style', $normalizedOriginalStyle); |
|
| 251 | - } |
|
| 252 | - } |
|
| 253 | - |
|
| 254 | - // grab any existing style blocks from the html and append them to the existing CSS |
|
| 255 | - // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
| 256 | - $allCss = $this->css; |
|
| 257 | - |
|
| 258 | - $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
| 259 | - |
|
| 260 | - $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
| 261 | - self::$_media = ''; // reset |
|
| 262 | - |
|
| 263 | - $cssKey = md5($cssParts['css']); |
|
| 264 | - if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
| 265 | - // process the CSS file for selectors and definitions |
|
| 266 | - preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
| 267 | - |
|
| 268 | - $allSelectors = array(); |
|
| 269 | - foreach ($matches as $key => $selectorString) { |
|
| 270 | - // if there is a blank definition, skip |
|
| 271 | - if (!strlen(trim($selectorString[2]))) { |
|
| 272 | - continue; |
|
| 273 | - } |
|
| 274 | - |
|
| 275 | - // else split by commas and duplicate attributes so we can sort by selector precedence |
|
| 276 | - $selectors = explode(',', $selectorString[1]); |
|
| 277 | - foreach ($selectors as $selector) { |
|
| 278 | - // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
| 279 | - if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
| 280 | - continue; |
|
| 281 | - } |
|
| 282 | - |
|
| 283 | - $allSelectors[] = array('selector' => trim($selector), |
|
| 284 | - 'attributes' => trim($selectorString[2]), |
|
| 285 | - // keep track of where it appears in the file, since order is important |
|
| 286 | - 'line' => $key, |
|
| 287 | - ); |
|
| 288 | - } |
|
| 289 | - } |
|
| 290 | - |
|
| 291 | - // now sort the selectors by precedence |
|
| 292 | - usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
| 293 | - |
|
| 294 | - $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
| 298 | - // query the body for the xpath selector |
|
| 299 | - $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
| 300 | - |
|
| 301 | - /** @var $node \DOMNode */ |
|
| 302 | - foreach ($nodesMatchingCssSelectors as $node) { |
|
| 303 | - // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
| 304 | - if ($node->hasAttribute('style')) { |
|
| 305 | - // break it up into an associative array |
|
| 306 | - $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 307 | - } else { |
|
| 308 | - $oldStyleDeclarations = array(); |
|
| 309 | - } |
|
| 310 | - $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
| 311 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
| 312 | - } |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - // now iterate through the nodes that contained inline styles in the original HTML |
|
| 316 | - foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
| 317 | - $node = $this->visitedNodes[$nodePath]; |
|
| 318 | - $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 319 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - // This removes styles from your email that contain display:none. |
|
| 323 | - // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
| 324 | - // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
| 325 | - // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
| 326 | - $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
| 327 | - // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
| 328 | - // we don't try to call removeChild on a nonexistent child node |
|
| 329 | - if ($nodesWithStyleDisplayNone->length > 0) { |
|
| 330 | - /** @var $node \DOMNode */ |
|
| 331 | - foreach ($nodesWithStyleDisplayNone as $node) { |
|
| 332 | - if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
| 333 | - $node->parentNode->removeChild($node); |
|
| 334 | - } |
|
| 335 | - } |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
| 339 | - |
|
| 340 | - if ($this->preserveEncoding) { |
|
| 341 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 342 | - return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
| 343 | - } else { |
|
| 344 | - return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
| 345 | - } |
|
| 346 | - } else { |
|
| 347 | - return $xmlDocument->saveHTML(); |
|
| 348 | - } |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - public function strtolower(array $m) { |
|
| 352 | - return strtolower($m[0]); |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * This method merges old or existing name/value array with new name/value array. |
|
| 358 | - * and then generates a string of the combined style suitable for placing inline. |
|
| 359 | - * This becomes the single point for CSS string generation allowing for consistent. |
|
| 360 | - * CSS output no matter where the CSS originally came from. |
|
| 361 | - * @param array $oldStyles |
|
| 362 | - * @param array $newStyles |
|
| 363 | - * @return string |
|
| 364 | - */ |
|
| 365 | - private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
| 366 | - $combinedStyles = array_merge($oldStyles, $newStyles); |
|
| 367 | - $style = ''; |
|
| 368 | - foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
| 369 | - $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
| 370 | - } |
|
| 371 | - return trim($style); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - |
|
| 375 | - /** |
|
| 376 | - * Copies the media part from CSS array parts to $xmlDocument. |
|
| 377 | - * |
|
| 378 | - * @param array $cssParts |
|
| 379 | - * @param DOMDocument $xmlDocument |
|
| 380 | - */ |
|
| 381 | - public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
| 382 | - if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
| 383 | - $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
| 384 | - } |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Returns CSS content. |
|
| 389 | - * |
|
| 390 | - * @param DOMXPath $xpath |
|
| 391 | - * @return string |
|
| 392 | - */ |
|
| 393 | - private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
| 394 | - $styleNodes = $xpath->query('//style'); |
|
| 395 | - |
|
| 396 | - if ($styleNodes === false) { |
|
| 397 | - return ''; |
|
| 398 | - } |
|
| 399 | - |
|
| 400 | - $css = ''; |
|
| 401 | - /** @var $styleNode DOMNode */ |
|
| 402 | - foreach ($styleNodes as $styleNode) { |
|
| 403 | - $css .= "\n\n" . $styleNode->nodeValue; |
|
| 404 | - $styleNode->parentNode->removeChild($styleNode); |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - return $css; |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * Adds a style element with $css to $document. |
|
| 412 | - * |
|
| 413 | - * @param DOMDocument $document |
|
| 414 | - * @param string $css |
|
| 415 | - */ |
|
| 416 | - private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
| 417 | - $styleElement = $document->createElement('style', $css); |
|
| 418 | - $styleAttribute = $document->createAttribute('type'); |
|
| 419 | - $styleAttribute->value = 'text/css'; |
|
| 420 | - $styleElement->appendChild($styleAttribute); |
|
| 421 | - |
|
| 422 | - $head = $this->getOrCreateHeadElement($document); |
|
| 423 | - $head->appendChild($styleElement); |
|
| 424 | - } |
|
| 425 | - |
|
| 426 | - /** |
|
| 427 | - * Returns the existing or creates a new head element in $document. |
|
| 428 | - * |
|
| 429 | - * @param DOMDocument $document |
|
| 430 | - * @return DOMNode the head element |
|
| 431 | - */ |
|
| 432 | - private function getOrCreateHeadElement(DOMDocument $document) { |
|
| 433 | - $head = $document->getElementsByTagName('head')->item(0); |
|
| 434 | - |
|
| 435 | - if ($head === null) { |
|
| 436 | - $head = $document->createElement('head'); |
|
| 437 | - $html = $document->getElementsByTagName('html')->item(0); |
|
| 438 | - $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
| 439 | - } |
|
| 440 | - |
|
| 441 | - return $head; |
|
| 442 | - } |
|
| 443 | - |
|
| 444 | - /** |
|
| 445 | - * Splits input CSS code to an array where: |
|
| 446 | - * |
|
| 447 | - * - key "css" will be contains clean CSS code. |
|
| 448 | - * - key "media" will be contains all valuable media queries. |
|
| 449 | - * |
|
| 450 | - * Example: |
|
| 451 | - * |
|
| 452 | - * The CSS code. |
|
| 453 | - * |
|
| 454 | - * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
| 455 | - * |
|
| 456 | - * will be parsed into the following array: |
|
| 457 | - * |
|
| 458 | - * "css" => "h1 { color:red; }" |
|
| 459 | - * "media" => "@media { h1 {}}" |
|
| 460 | - * |
|
| 461 | - * @param string $css |
|
| 462 | - * @return array |
|
| 463 | - */ |
|
| 464 | - private function splitCssAndMediaQuery($css) { |
|
| 465 | - $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
| 466 | - |
|
| 467 | - // filter the CSS |
|
| 468 | - $search = array( |
|
| 469 | - // get rid of css comment code |
|
| 470 | - '/\\/\\*.*\\*\\//sU', |
|
| 471 | - // strip out any import directives |
|
| 472 | - '/^\\s*@import\\s[^;]+;/misU', |
|
| 473 | - // strip remains media enclosures |
|
| 474 | - '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
| 475 | - ); |
|
| 476 | - |
|
| 477 | - $replace = array( |
|
| 478 | - '', |
|
| 479 | - '', |
|
| 480 | - '', |
|
| 481 | - ); |
|
| 482 | - |
|
| 483 | - // clean CSS before output |
|
| 484 | - $css = preg_replace($search, $replace, $css); |
|
| 485 | - |
|
| 486 | - return array('css' => $css, 'media' => self::$_media); |
|
| 487 | - } |
|
| 488 | - |
|
| 489 | - private function _media_concat( $matches ) { |
|
| 490 | - self::$_media .= $matches[0]; |
|
| 491 | - } |
|
| 492 | - |
|
| 493 | - /** |
|
| 494 | - * Creates a DOMDocument instance with the current HTML. |
|
| 495 | - * |
|
| 496 | - * @return DOMDocument |
|
| 497 | - */ |
|
| 498 | - private function createXmlDocument() { |
|
| 499 | - $xmlDocument = new DOMDocument; |
|
| 500 | - $xmlDocument->encoding = self::ENCODING; |
|
| 501 | - $xmlDocument->strictErrorChecking = false; |
|
| 502 | - $xmlDocument->formatOutput = true; |
|
| 503 | - $libXmlState = libxml_use_internal_errors(true); |
|
| 504 | - $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
| 505 | - libxml_clear_errors(); |
|
| 506 | - libxml_use_internal_errors($libXmlState); |
|
| 507 | - $xmlDocument->normalizeDocument(); |
|
| 508 | - |
|
| 509 | - return $xmlDocument; |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - /** |
|
| 513 | - * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
| 514 | - * |
|
| 515 | - * @return string the unified HTML |
|
| 516 | - * |
|
| 517 | - * @throws BadMethodCallException |
|
| 518 | - */ |
|
| 519 | - private function getUnifiedHtml() { |
|
| 520 | - if (!empty($this->unprocessableHtmlTags)) { |
|
| 521 | - $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
| 522 | - $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
| 523 | - } else { |
|
| 524 | - $bodyWithoutUnprocessableTags = $this->html; |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 528 | - return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
| 529 | - } else { |
|
| 530 | - return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
| 531 | - } |
|
| 532 | - } |
|
| 533 | - |
|
| 534 | - /** |
|
| 535 | - * @param array $a |
|
| 536 | - * @param array $b |
|
| 537 | - * |
|
| 538 | - * @return integer |
|
| 539 | - */ |
|
| 540 | - private function sortBySelectorPrecedence(array $a, array $b) { |
|
| 541 | - $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
| 542 | - $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
| 543 | - |
|
| 544 | - // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
| 545 | - // selectors with greater precedence get sorted last. |
|
| 546 | - // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
| 547 | - // arithmetic operators. |
|
| 548 | - // @see http://forge.typo3.org/issues/55605 |
|
| 549 | - $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
| 550 | - $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
| 551 | - return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
| 552 | - } |
|
| 553 | - |
|
| 554 | - /** |
|
| 555 | - * @param string $selector |
|
| 556 | - * |
|
| 557 | - * @return integer |
|
| 558 | - */ |
|
| 559 | - private function getCssSelectorPrecedence($selector) { |
|
| 560 | - $selectorKey = md5($selector); |
|
| 561 | - if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
| 562 | - $precedence = 0; |
|
| 563 | - $value = 100; |
|
| 564 | - // ids: worth 100, classes: worth 10, elements: worth 1 |
|
| 565 | - $search = array('\\#','\\.',''); |
|
| 566 | - |
|
| 567 | - foreach ($search as $s) { |
|
| 568 | - if (trim($selector == '')) { |
|
| 569 | - break; |
|
| 570 | - } |
|
| 571 | - $number = 0; |
|
| 572 | - $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
| 573 | - $precedence += ($value * $number); |
|
| 574 | - $value /= 10; |
|
| 575 | - } |
|
| 576 | - $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
| 577 | - } |
|
| 578 | - |
|
| 579 | - return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
| 580 | - } |
|
| 581 | - |
|
| 582 | - /** |
|
| 583 | - * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
| 584 | - * |
|
| 585 | - * @see http://plasmasturm.org/log/444/ |
|
| 586 | - * |
|
| 587 | - * @param string $paramCssSelector |
|
| 588 | - * |
|
| 589 | - * @return string |
|
| 590 | - */ |
|
| 591 | - private function translateCssToXpath($paramCssSelector) { |
|
| 592 | - $cssSelector = ' ' . $paramCssSelector . ' '; |
|
| 593 | - $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
| 594 | - $cssSelector = trim($cssSelector); |
|
| 595 | - $xpathKey = md5($cssSelector); |
|
| 596 | - if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
| 597 | - // returns an Xpath selector |
|
| 598 | - $search = array( |
|
| 599 | - // Matches any element that is a child of parent. |
|
| 600 | - '/\\s+>\\s+/', |
|
| 601 | - // Matches any element that is an adjacent sibling. |
|
| 602 | - '/\\s+\\+\\s+/', |
|
| 603 | - // Matches any element that is a descendant of an parent element element. |
|
| 604 | - '/\\s+/', |
|
| 605 | - // first-child pseudo-selector |
|
| 606 | - '/([^\\/]+):first-child/i', |
|
| 607 | - // last-child pseudo-selector |
|
| 608 | - '/([^\\/]+):last-child/i', |
|
| 609 | - // Matches attribute only selector |
|
| 610 | - '/^\\[(\\w+)\\]/', |
|
| 611 | - // Matches element with attribute |
|
| 612 | - '/(\\w)\\[(\\w+)\\]/', |
|
| 613 | - // Matches element with EXACT attribute |
|
| 614 | - '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
| 615 | - ); |
|
| 616 | - $replace = array( |
|
| 617 | - '/', |
|
| 618 | - '/following-sibling::*[1]/self::', |
|
| 619 | - '//', |
|
| 620 | - '*[1]/self::\\1', |
|
| 621 | - '*[last()]/self::\\1', |
|
| 622 | - '*[@\\1]', |
|
| 623 | - '\\1[@\\2]', |
|
| 624 | - '\\1[@\\2="\\3"]', |
|
| 625 | - ); |
|
| 626 | - |
|
| 627 | - $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
| 628 | - |
|
| 629 | - $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
| 630 | - $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
| 631 | - |
|
| 632 | - // Advanced selectors are going to require a bit more advanced emogrification. |
|
| 633 | - // When we required PHP 5.3, we could do this with closures. |
|
| 634 | - $cssSelector = preg_replace_callback( |
|
| 635 | - '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 636 | - array($this, 'translateNthChild'), $cssSelector |
|
| 637 | - ); |
|
| 638 | - $cssSelector = preg_replace_callback( |
|
| 639 | - '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 640 | - array($this, 'translateNthOfType'), $cssSelector |
|
| 641 | - ); |
|
| 642 | - |
|
| 643 | - $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
| 644 | - } |
|
| 645 | - return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
| 646 | - } |
|
| 647 | - |
|
| 648 | - /** |
|
| 649 | - * @param array $match |
|
| 650 | - * |
|
| 651 | - * @return string |
|
| 652 | - */ |
|
| 653 | - private function matchIdAttributes(array $match) { |
|
| 654 | - return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * @param array $match |
|
| 659 | - * |
|
| 660 | - * @return string |
|
| 661 | - */ |
|
| 662 | - private function matchClassAttributes(array $match) { |
|
| 663 | - return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
| 664 | - implode( |
|
| 665 | - '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
| 666 | - explode('.', substr($match[2], 1)) |
|
| 667 | - ) . '"," "))]'; |
|
| 668 | - } |
|
| 669 | - |
|
| 670 | - /** |
|
| 671 | - * @param array $match |
|
| 672 | - * |
|
| 673 | - * @return string |
|
| 674 | - */ |
|
| 675 | - private function translateNthChild(array $match) { |
|
| 676 | - $result = $this->parseNth($match); |
|
| 677 | - |
|
| 678 | - if (isset($result[self::MULTIPLIER])) { |
|
| 679 | - if ($result[self::MULTIPLIER] < 0) { |
|
| 680 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 681 | - return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 682 | - } else { |
|
| 683 | - return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 684 | - } |
|
| 685 | - } else { |
|
| 686 | - return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
| 687 | - } |
|
| 688 | - } |
|
| 689 | - |
|
| 690 | - /** |
|
| 691 | - * @param array $match |
|
| 692 | - * |
|
| 693 | - * @return string |
|
| 694 | - */ |
|
| 695 | - private function translateNthOfType(array $match) { |
|
| 696 | - $result = $this->parseNth($match); |
|
| 697 | - |
|
| 698 | - if (isset($result[self::MULTIPLIER])) { |
|
| 699 | - if ($result[self::MULTIPLIER] < 0) { |
|
| 700 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 701 | - return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 702 | - } else { |
|
| 703 | - return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 704 | - } |
|
| 705 | - } else { |
|
| 706 | - return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
| 707 | - } |
|
| 708 | - } |
|
| 709 | - |
|
| 710 | - /** |
|
| 711 | - * @param array $match |
|
| 712 | - * |
|
| 713 | - * @return array |
|
| 714 | - */ |
|
| 715 | - private function parseNth(array $match) { |
|
| 716 | - if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
| 717 | - $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
| 718 | - return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
| 719 | - } elseif (stripos($match[2], 'n') === false) { |
|
| 720 | - // if there is a multiplier |
|
| 721 | - $index = intval(str_replace(' ', '', $match[2])); |
|
| 722 | - return array(self::INDEX => $index); |
|
| 723 | - } else { |
|
| 724 | - if (isset($match[3])) { |
|
| 725 | - $multipleTerm = str_replace($match[3], '', $match[2]); |
|
| 726 | - $index = intval(str_replace(' ', '', $match[3])); |
|
| 727 | - } else { |
|
| 728 | - $multipleTerm = $match[2]; |
|
| 729 | - $index = 0; |
|
| 730 | - } |
|
| 731 | - |
|
| 732 | - $multiplier = str_ireplace('n', '', $multipleTerm); |
|
| 733 | - |
|
| 734 | - if (!strlen($multiplier)) { |
|
| 735 | - $multiplier = 1; |
|
| 736 | - } elseif ($multiplier == 0) { |
|
| 737 | - return array(self::INDEX => $index); |
|
| 738 | - } else { |
|
| 739 | - $multiplier = intval($multiplier); |
|
| 740 | - } |
|
| 741 | - |
|
| 742 | - while ($index < 0) { |
|
| 743 | - $index += abs($multiplier); |
|
| 744 | - } |
|
| 745 | - |
|
| 746 | - return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
| 747 | - } |
|
| 748 | - } |
|
| 749 | - |
|
| 750 | - /** |
|
| 751 | - * Parses a CSS declaration block into property name/value pairs. |
|
| 752 | - * |
|
| 753 | - * Example: |
|
| 754 | - * |
|
| 755 | - * The declaration block. |
|
| 756 | - * |
|
| 757 | - * "color: #000; font-weight: bold;". |
|
| 758 | - * |
|
| 759 | - * will be parsed into the following array: |
|
| 760 | - * |
|
| 761 | - * "color" => "#000" |
|
| 762 | - * "font-weight" => "bold" |
|
| 763 | - * |
|
| 764 | - * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
| 765 | - * |
|
| 766 | - * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
| 767 | - */ |
|
| 768 | - private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
| 769 | - if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
| 770 | - return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
| 771 | - } |
|
| 772 | - |
|
| 773 | - $properties = array(); |
|
| 774 | - $declarations = explode(';', $cssDeclarationBlock); |
|
| 775 | - foreach ($declarations as $declaration) { |
|
| 776 | - $matches = array(); |
|
| 777 | - if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
| 778 | - continue; |
|
| 779 | - } |
|
| 780 | - $propertyName = strtolower($matches[1]); |
|
| 781 | - $propertyValue = $matches[2]; |
|
| 782 | - $properties[$propertyName] = $propertyValue; |
|
| 783 | - } |
|
| 784 | - $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
| 785 | - |
|
| 786 | - return $properties; |
|
| 787 | - } |
|
| 12 | + /** |
|
| 13 | + * @var string |
|
| 14 | + */ |
|
| 15 | + const ENCODING = 'UTF-8'; |
|
| 16 | + |
|
| 17 | + /** |
|
| 18 | + * @var integer |
|
| 19 | + */ |
|
| 20 | + const CACHE_KEY_CSS = 0; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * @var integer |
|
| 24 | + */ |
|
| 25 | + const CACHE_KEY_SELECTOR = 1; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * @var integer |
|
| 29 | + */ |
|
| 30 | + const CACHE_KEY_XPATH = 2; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @var integer |
|
| 34 | + */ |
|
| 35 | + const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * for calculating nth-of-type and nth-child selectors. |
|
| 39 | + * |
|
| 40 | + * @var integer |
|
| 41 | + */ |
|
| 42 | + const INDEX = 0; |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * for calculating nth-of-type and nth-child selectors. |
|
| 46 | + * |
|
| 47 | + * @var integer |
|
| 48 | + */ |
|
| 49 | + const MULTIPLIER = 1; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | + const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @var string |
|
| 58 | + */ |
|
| 59 | + const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * @var string |
|
| 63 | + */ |
|
| 64 | + private $html = ''; |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @var string |
|
| 68 | + */ |
|
| 69 | + private $css = ''; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * @var array<string> |
|
| 73 | + */ |
|
| 74 | + private $unprocessableHtmlTags = array('wbr'); |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * @var array<array> |
|
| 78 | + */ |
|
| 79 | + private $caches = array( |
|
| 80 | + self::CACHE_KEY_CSS => array(), |
|
| 81 | + self::CACHE_KEY_SELECTOR => array(), |
|
| 82 | + self::CACHE_KEY_XPATH => array(), |
|
| 83 | + self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
| 84 | + ); |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * the visited nodes with the XPath paths as array keys. |
|
| 88 | + * |
|
| 89 | + * @var array<\DOMNode> |
|
| 90 | + */ |
|
| 91 | + private $visitedNodes = array(); |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
| 95 | + * as key/value pairs for the inner array. |
|
| 96 | + * |
|
| 97 | + * @var array<array><string> |
|
| 98 | + */ |
|
| 99 | + private $styleAttributesForNodes = array(); |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * This attribute applies to the case where you want to preserve your original text encoding. |
|
| 103 | + * |
|
| 104 | + * By default, emogrifier translates your text into HTML entities for two reasons: |
|
| 105 | + * |
|
| 106 | + * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
| 107 | + * |
|
| 108 | + * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
| 109 | + * |
|
| 110 | + * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
| 111 | + * |
|
| 112 | + * @var boolean |
|
| 113 | + */ |
|
| 114 | + public $preserveEncoding = false; |
|
| 115 | + |
|
| 116 | + public static $_media = ''; |
|
| 117 | + |
|
| 118 | + /** |
|
| 119 | + * The constructor. |
|
| 120 | + * |
|
| 121 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 122 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 123 | + */ |
|
| 124 | + public function __construct($html = '', $css = '') { |
|
| 125 | + $this->setHtml($html); |
|
| 126 | + $this->setCss($css); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * The destructor. |
|
| 131 | + */ |
|
| 132 | + public function __destruct() { |
|
| 133 | + $this->purgeVisitedNodes(); |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Sets the HTML to emogrify. |
|
| 138 | + * |
|
| 139 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
| 140 | + */ |
|
| 141 | + public function setHtml($html = '') { |
|
| 142 | + $this->html = $html; |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Sets the CSS to merge with the HTML. |
|
| 147 | + * |
|
| 148 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
| 149 | + */ |
|
| 150 | + public function setCss($css = '') { |
|
| 151 | + $this->css = $css; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Clears all caches. |
|
| 156 | + */ |
|
| 157 | + private function clearAllCaches() { |
|
| 158 | + $this->clearCache(self::CACHE_KEY_CSS); |
|
| 159 | + $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
| 160 | + $this->clearCache(self::CACHE_KEY_XPATH); |
|
| 161 | + $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Clears a single cache by key. |
|
| 166 | + * |
|
| 167 | + * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
| 168 | + * |
|
| 169 | + * @throws InvalidArgumentException |
|
| 170 | + */ |
|
| 171 | + private function clearCache($key) { |
|
| 172 | + $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
| 173 | + if (!in_array($key, $allowedCacheKeys, true)) { |
|
| 174 | + throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + $this->caches[$key] = array(); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Purges the visited nodes. |
|
| 182 | + */ |
|
| 183 | + private function purgeVisitedNodes() { |
|
| 184 | + $this->visitedNodes = array(); |
|
| 185 | + $this->styleAttributesForNodes = array(); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Marks a tag for removal. |
|
| 190 | + * |
|
| 191 | + * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
| 192 | + * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
| 193 | + * |
|
| 194 | + * Note: The tags will not be removed if they have any content. |
|
| 195 | + * |
|
| 196 | + * @param string $tagName the tag name, e.g., "p" |
|
| 197 | + */ |
|
| 198 | + public function addUnprocessableHtmlTag($tagName) { |
|
| 199 | + $this->unprocessableHtmlTags[] = $tagName; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * Drops a tag from the removal list. |
|
| 204 | + * |
|
| 205 | + * @param string $tagName the tag name, e.g., "p" |
|
| 206 | + */ |
|
| 207 | + public function removeUnprocessableHtmlTag($tagName) { |
|
| 208 | + $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
| 209 | + if ($key !== false) { |
|
| 210 | + unset($this->unprocessableHtmlTags[$key]); |
|
| 211 | + } |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Applies the CSS you submit to the HTML you submit. |
|
| 216 | + * |
|
| 217 | + * This method places the CSS inline. |
|
| 218 | + * |
|
| 219 | + * @return string |
|
| 220 | + * |
|
| 221 | + * @throws BadMethodCallException |
|
| 222 | + */ |
|
| 223 | + public function emogrify() { |
|
| 224 | + if ($this->html === '') { |
|
| 225 | + throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + $xmlDocument = $this->createXmlDocument(); |
|
| 229 | + $xpath = new DOMXPath($xmlDocument); |
|
| 230 | + $this->clearAllCaches(); |
|
| 231 | + |
|
| 232 | + // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
| 233 | + // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
| 234 | + // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
| 235 | + $this->purgeVisitedNodes(); |
|
| 236 | + |
|
| 237 | + $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
| 238 | + if ($nodesWithStyleAttributes !== false) { |
|
| 239 | + /** @var $nodeWithStyleAttribute DOMNode */ |
|
| 240 | + foreach ($nodesWithStyleAttributes as $node) { |
|
| 241 | + $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
| 242 | + |
|
| 243 | + // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
| 244 | + $nodePath = $node->getNodePath(); |
|
| 245 | + if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
| 246 | + $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
| 247 | + $this->visitedNodes[$nodePath] = $node; |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + $node->setAttribute('style', $normalizedOriginalStyle); |
|
| 251 | + } |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + // grab any existing style blocks from the html and append them to the existing CSS |
|
| 255 | + // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
| 256 | + $allCss = $this->css; |
|
| 257 | + |
|
| 258 | + $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
| 259 | + |
|
| 260 | + $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
| 261 | + self::$_media = ''; // reset |
|
| 262 | + |
|
| 263 | + $cssKey = md5($cssParts['css']); |
|
| 264 | + if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
| 265 | + // process the CSS file for selectors and definitions |
|
| 266 | + preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
| 267 | + |
|
| 268 | + $allSelectors = array(); |
|
| 269 | + foreach ($matches as $key => $selectorString) { |
|
| 270 | + // if there is a blank definition, skip |
|
| 271 | + if (!strlen(trim($selectorString[2]))) { |
|
| 272 | + continue; |
|
| 273 | + } |
|
| 274 | + |
|
| 275 | + // else split by commas and duplicate attributes so we can sort by selector precedence |
|
| 276 | + $selectors = explode(',', $selectorString[1]); |
|
| 277 | + foreach ($selectors as $selector) { |
|
| 278 | + // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
| 279 | + if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
| 280 | + continue; |
|
| 281 | + } |
|
| 282 | + |
|
| 283 | + $allSelectors[] = array('selector' => trim($selector), |
|
| 284 | + 'attributes' => trim($selectorString[2]), |
|
| 285 | + // keep track of where it appears in the file, since order is important |
|
| 286 | + 'line' => $key, |
|
| 287 | + ); |
|
| 288 | + } |
|
| 289 | + } |
|
| 290 | + |
|
| 291 | + // now sort the selectors by precedence |
|
| 292 | + usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
| 293 | + |
|
| 294 | + $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
| 298 | + // query the body for the xpath selector |
|
| 299 | + $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
| 300 | + |
|
| 301 | + /** @var $node \DOMNode */ |
|
| 302 | + foreach ($nodesMatchingCssSelectors as $node) { |
|
| 303 | + // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
| 304 | + if ($node->hasAttribute('style')) { |
|
| 305 | + // break it up into an associative array |
|
| 306 | + $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 307 | + } else { |
|
| 308 | + $oldStyleDeclarations = array(); |
|
| 309 | + } |
|
| 310 | + $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
| 311 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
| 312 | + } |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + // now iterate through the nodes that contained inline styles in the original HTML |
|
| 316 | + foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
| 317 | + $node = $this->visitedNodes[$nodePath]; |
|
| 318 | + $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
| 319 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + // This removes styles from your email that contain display:none. |
|
| 323 | + // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
| 324 | + // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
| 325 | + // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
| 326 | + $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
| 327 | + // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
| 328 | + // we don't try to call removeChild on a nonexistent child node |
|
| 329 | + if ($nodesWithStyleDisplayNone->length > 0) { |
|
| 330 | + /** @var $node \DOMNode */ |
|
| 331 | + foreach ($nodesWithStyleDisplayNone as $node) { |
|
| 332 | + if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
| 333 | + $node->parentNode->removeChild($node); |
|
| 334 | + } |
|
| 335 | + } |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
| 339 | + |
|
| 340 | + if ($this->preserveEncoding) { |
|
| 341 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 342 | + return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
| 343 | + } else { |
|
| 344 | + return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
| 345 | + } |
|
| 346 | + } else { |
|
| 347 | + return $xmlDocument->saveHTML(); |
|
| 348 | + } |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + public function strtolower(array $m) { |
|
| 352 | + return strtolower($m[0]); |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * This method merges old or existing name/value array with new name/value array. |
|
| 358 | + * and then generates a string of the combined style suitable for placing inline. |
|
| 359 | + * This becomes the single point for CSS string generation allowing for consistent. |
|
| 360 | + * CSS output no matter where the CSS originally came from. |
|
| 361 | + * @param array $oldStyles |
|
| 362 | + * @param array $newStyles |
|
| 363 | + * @return string |
|
| 364 | + */ |
|
| 365 | + private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
| 366 | + $combinedStyles = array_merge($oldStyles, $newStyles); |
|
| 367 | + $style = ''; |
|
| 368 | + foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
| 369 | + $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
| 370 | + } |
|
| 371 | + return trim($style); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + |
|
| 375 | + /** |
|
| 376 | + * Copies the media part from CSS array parts to $xmlDocument. |
|
| 377 | + * |
|
| 378 | + * @param array $cssParts |
|
| 379 | + * @param DOMDocument $xmlDocument |
|
| 380 | + */ |
|
| 381 | + public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
| 382 | + if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
| 383 | + $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
| 384 | + } |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Returns CSS content. |
|
| 389 | + * |
|
| 390 | + * @param DOMXPath $xpath |
|
| 391 | + * @return string |
|
| 392 | + */ |
|
| 393 | + private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
| 394 | + $styleNodes = $xpath->query('//style'); |
|
| 395 | + |
|
| 396 | + if ($styleNodes === false) { |
|
| 397 | + return ''; |
|
| 398 | + } |
|
| 399 | + |
|
| 400 | + $css = ''; |
|
| 401 | + /** @var $styleNode DOMNode */ |
|
| 402 | + foreach ($styleNodes as $styleNode) { |
|
| 403 | + $css .= "\n\n" . $styleNode->nodeValue; |
|
| 404 | + $styleNode->parentNode->removeChild($styleNode); |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + return $css; |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * Adds a style element with $css to $document. |
|
| 412 | + * |
|
| 413 | + * @param DOMDocument $document |
|
| 414 | + * @param string $css |
|
| 415 | + */ |
|
| 416 | + private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
| 417 | + $styleElement = $document->createElement('style', $css); |
|
| 418 | + $styleAttribute = $document->createAttribute('type'); |
|
| 419 | + $styleAttribute->value = 'text/css'; |
|
| 420 | + $styleElement->appendChild($styleAttribute); |
|
| 421 | + |
|
| 422 | + $head = $this->getOrCreateHeadElement($document); |
|
| 423 | + $head->appendChild($styleElement); |
|
| 424 | + } |
|
| 425 | + |
|
| 426 | + /** |
|
| 427 | + * Returns the existing or creates a new head element in $document. |
|
| 428 | + * |
|
| 429 | + * @param DOMDocument $document |
|
| 430 | + * @return DOMNode the head element |
|
| 431 | + */ |
|
| 432 | + private function getOrCreateHeadElement(DOMDocument $document) { |
|
| 433 | + $head = $document->getElementsByTagName('head')->item(0); |
|
| 434 | + |
|
| 435 | + if ($head === null) { |
|
| 436 | + $head = $document->createElement('head'); |
|
| 437 | + $html = $document->getElementsByTagName('html')->item(0); |
|
| 438 | + $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
| 439 | + } |
|
| 440 | + |
|
| 441 | + return $head; |
|
| 442 | + } |
|
| 443 | + |
|
| 444 | + /** |
|
| 445 | + * Splits input CSS code to an array where: |
|
| 446 | + * |
|
| 447 | + * - key "css" will be contains clean CSS code. |
|
| 448 | + * - key "media" will be contains all valuable media queries. |
|
| 449 | + * |
|
| 450 | + * Example: |
|
| 451 | + * |
|
| 452 | + * The CSS code. |
|
| 453 | + * |
|
| 454 | + * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
| 455 | + * |
|
| 456 | + * will be parsed into the following array: |
|
| 457 | + * |
|
| 458 | + * "css" => "h1 { color:red; }" |
|
| 459 | + * "media" => "@media { h1 {}}" |
|
| 460 | + * |
|
| 461 | + * @param string $css |
|
| 462 | + * @return array |
|
| 463 | + */ |
|
| 464 | + private function splitCssAndMediaQuery($css) { |
|
| 465 | + $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
| 466 | + |
|
| 467 | + // filter the CSS |
|
| 468 | + $search = array( |
|
| 469 | + // get rid of css comment code |
|
| 470 | + '/\\/\\*.*\\*\\//sU', |
|
| 471 | + // strip out any import directives |
|
| 472 | + '/^\\s*@import\\s[^;]+;/misU', |
|
| 473 | + // strip remains media enclosures |
|
| 474 | + '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
| 475 | + ); |
|
| 476 | + |
|
| 477 | + $replace = array( |
|
| 478 | + '', |
|
| 479 | + '', |
|
| 480 | + '', |
|
| 481 | + ); |
|
| 482 | + |
|
| 483 | + // clean CSS before output |
|
| 484 | + $css = preg_replace($search, $replace, $css); |
|
| 485 | + |
|
| 486 | + return array('css' => $css, 'media' => self::$_media); |
|
| 487 | + } |
|
| 488 | + |
|
| 489 | + private function _media_concat( $matches ) { |
|
| 490 | + self::$_media .= $matches[0]; |
|
| 491 | + } |
|
| 492 | + |
|
| 493 | + /** |
|
| 494 | + * Creates a DOMDocument instance with the current HTML. |
|
| 495 | + * |
|
| 496 | + * @return DOMDocument |
|
| 497 | + */ |
|
| 498 | + private function createXmlDocument() { |
|
| 499 | + $xmlDocument = new DOMDocument; |
|
| 500 | + $xmlDocument->encoding = self::ENCODING; |
|
| 501 | + $xmlDocument->strictErrorChecking = false; |
|
| 502 | + $xmlDocument->formatOutput = true; |
|
| 503 | + $libXmlState = libxml_use_internal_errors(true); |
|
| 504 | + $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
| 505 | + libxml_clear_errors(); |
|
| 506 | + libxml_use_internal_errors($libXmlState); |
|
| 507 | + $xmlDocument->normalizeDocument(); |
|
| 508 | + |
|
| 509 | + return $xmlDocument; |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + /** |
|
| 513 | + * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
| 514 | + * |
|
| 515 | + * @return string the unified HTML |
|
| 516 | + * |
|
| 517 | + * @throws BadMethodCallException |
|
| 518 | + */ |
|
| 519 | + private function getUnifiedHtml() { |
|
| 520 | + if (!empty($this->unprocessableHtmlTags)) { |
|
| 521 | + $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
| 522 | + $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
| 523 | + } else { |
|
| 524 | + $bodyWithoutUnprocessableTags = $this->html; |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
| 528 | + return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
| 529 | + } else { |
|
| 530 | + return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
| 531 | + } |
|
| 532 | + } |
|
| 533 | + |
|
| 534 | + /** |
|
| 535 | + * @param array $a |
|
| 536 | + * @param array $b |
|
| 537 | + * |
|
| 538 | + * @return integer |
|
| 539 | + */ |
|
| 540 | + private function sortBySelectorPrecedence(array $a, array $b) { |
|
| 541 | + $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
| 542 | + $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
| 543 | + |
|
| 544 | + // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
| 545 | + // selectors with greater precedence get sorted last. |
|
| 546 | + // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
| 547 | + // arithmetic operators. |
|
| 548 | + // @see http://forge.typo3.org/issues/55605 |
|
| 549 | + $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
| 550 | + $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
| 551 | + return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
| 552 | + } |
|
| 553 | + |
|
| 554 | + /** |
|
| 555 | + * @param string $selector |
|
| 556 | + * |
|
| 557 | + * @return integer |
|
| 558 | + */ |
|
| 559 | + private function getCssSelectorPrecedence($selector) { |
|
| 560 | + $selectorKey = md5($selector); |
|
| 561 | + if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
| 562 | + $precedence = 0; |
|
| 563 | + $value = 100; |
|
| 564 | + // ids: worth 100, classes: worth 10, elements: worth 1 |
|
| 565 | + $search = array('\\#','\\.',''); |
|
| 566 | + |
|
| 567 | + foreach ($search as $s) { |
|
| 568 | + if (trim($selector == '')) { |
|
| 569 | + break; |
|
| 570 | + } |
|
| 571 | + $number = 0; |
|
| 572 | + $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
| 573 | + $precedence += ($value * $number); |
|
| 574 | + $value /= 10; |
|
| 575 | + } |
|
| 576 | + $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
| 577 | + } |
|
| 578 | + |
|
| 579 | + return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
| 580 | + } |
|
| 581 | + |
|
| 582 | + /** |
|
| 583 | + * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
| 584 | + * |
|
| 585 | + * @see http://plasmasturm.org/log/444/ |
|
| 586 | + * |
|
| 587 | + * @param string $paramCssSelector |
|
| 588 | + * |
|
| 589 | + * @return string |
|
| 590 | + */ |
|
| 591 | + private function translateCssToXpath($paramCssSelector) { |
|
| 592 | + $cssSelector = ' ' . $paramCssSelector . ' '; |
|
| 593 | + $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
| 594 | + $cssSelector = trim($cssSelector); |
|
| 595 | + $xpathKey = md5($cssSelector); |
|
| 596 | + if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
| 597 | + // returns an Xpath selector |
|
| 598 | + $search = array( |
|
| 599 | + // Matches any element that is a child of parent. |
|
| 600 | + '/\\s+>\\s+/', |
|
| 601 | + // Matches any element that is an adjacent sibling. |
|
| 602 | + '/\\s+\\+\\s+/', |
|
| 603 | + // Matches any element that is a descendant of an parent element element. |
|
| 604 | + '/\\s+/', |
|
| 605 | + // first-child pseudo-selector |
|
| 606 | + '/([^\\/]+):first-child/i', |
|
| 607 | + // last-child pseudo-selector |
|
| 608 | + '/([^\\/]+):last-child/i', |
|
| 609 | + // Matches attribute only selector |
|
| 610 | + '/^\\[(\\w+)\\]/', |
|
| 611 | + // Matches element with attribute |
|
| 612 | + '/(\\w)\\[(\\w+)\\]/', |
|
| 613 | + // Matches element with EXACT attribute |
|
| 614 | + '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
| 615 | + ); |
|
| 616 | + $replace = array( |
|
| 617 | + '/', |
|
| 618 | + '/following-sibling::*[1]/self::', |
|
| 619 | + '//', |
|
| 620 | + '*[1]/self::\\1', |
|
| 621 | + '*[last()]/self::\\1', |
|
| 622 | + '*[@\\1]', |
|
| 623 | + '\\1[@\\2]', |
|
| 624 | + '\\1[@\\2="\\3"]', |
|
| 625 | + ); |
|
| 626 | + |
|
| 627 | + $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
| 628 | + |
|
| 629 | + $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
| 630 | + $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
| 631 | + |
|
| 632 | + // Advanced selectors are going to require a bit more advanced emogrification. |
|
| 633 | + // When we required PHP 5.3, we could do this with closures. |
|
| 634 | + $cssSelector = preg_replace_callback( |
|
| 635 | + '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 636 | + array($this, 'translateNthChild'), $cssSelector |
|
| 637 | + ); |
|
| 638 | + $cssSelector = preg_replace_callback( |
|
| 639 | + '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
| 640 | + array($this, 'translateNthOfType'), $cssSelector |
|
| 641 | + ); |
|
| 642 | + |
|
| 643 | + $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
| 644 | + } |
|
| 645 | + return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
| 646 | + } |
|
| 647 | + |
|
| 648 | + /** |
|
| 649 | + * @param array $match |
|
| 650 | + * |
|
| 651 | + * @return string |
|
| 652 | + */ |
|
| 653 | + private function matchIdAttributes(array $match) { |
|
| 654 | + return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * @param array $match |
|
| 659 | + * |
|
| 660 | + * @return string |
|
| 661 | + */ |
|
| 662 | + private function matchClassAttributes(array $match) { |
|
| 663 | + return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
| 664 | + implode( |
|
| 665 | + '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
| 666 | + explode('.', substr($match[2], 1)) |
|
| 667 | + ) . '"," "))]'; |
|
| 668 | + } |
|
| 669 | + |
|
| 670 | + /** |
|
| 671 | + * @param array $match |
|
| 672 | + * |
|
| 673 | + * @return string |
|
| 674 | + */ |
|
| 675 | + private function translateNthChild(array $match) { |
|
| 676 | + $result = $this->parseNth($match); |
|
| 677 | + |
|
| 678 | + if (isset($result[self::MULTIPLIER])) { |
|
| 679 | + if ($result[self::MULTIPLIER] < 0) { |
|
| 680 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 681 | + return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 682 | + } else { |
|
| 683 | + return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
| 684 | + } |
|
| 685 | + } else { |
|
| 686 | + return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
| 687 | + } |
|
| 688 | + } |
|
| 689 | + |
|
| 690 | + /** |
|
| 691 | + * @param array $match |
|
| 692 | + * |
|
| 693 | + * @return string |
|
| 694 | + */ |
|
| 695 | + private function translateNthOfType(array $match) { |
|
| 696 | + $result = $this->parseNth($match); |
|
| 697 | + |
|
| 698 | + if (isset($result[self::MULTIPLIER])) { |
|
| 699 | + if ($result[self::MULTIPLIER] < 0) { |
|
| 700 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
| 701 | + return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 702 | + } else { |
|
| 703 | + return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
| 704 | + } |
|
| 705 | + } else { |
|
| 706 | + return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
| 707 | + } |
|
| 708 | + } |
|
| 709 | + |
|
| 710 | + /** |
|
| 711 | + * @param array $match |
|
| 712 | + * |
|
| 713 | + * @return array |
|
| 714 | + */ |
|
| 715 | + private function parseNth(array $match) { |
|
| 716 | + if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
| 717 | + $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
| 718 | + return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
| 719 | + } elseif (stripos($match[2], 'n') === false) { |
|
| 720 | + // if there is a multiplier |
|
| 721 | + $index = intval(str_replace(' ', '', $match[2])); |
|
| 722 | + return array(self::INDEX => $index); |
|
| 723 | + } else { |
|
| 724 | + if (isset($match[3])) { |
|
| 725 | + $multipleTerm = str_replace($match[3], '', $match[2]); |
|
| 726 | + $index = intval(str_replace(' ', '', $match[3])); |
|
| 727 | + } else { |
|
| 728 | + $multipleTerm = $match[2]; |
|
| 729 | + $index = 0; |
|
| 730 | + } |
|
| 731 | + |
|
| 732 | + $multiplier = str_ireplace('n', '', $multipleTerm); |
|
| 733 | + |
|
| 734 | + if (!strlen($multiplier)) { |
|
| 735 | + $multiplier = 1; |
|
| 736 | + } elseif ($multiplier == 0) { |
|
| 737 | + return array(self::INDEX => $index); |
|
| 738 | + } else { |
|
| 739 | + $multiplier = intval($multiplier); |
|
| 740 | + } |
|
| 741 | + |
|
| 742 | + while ($index < 0) { |
|
| 743 | + $index += abs($multiplier); |
|
| 744 | + } |
|
| 745 | + |
|
| 746 | + return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
| 747 | + } |
|
| 748 | + } |
|
| 749 | + |
|
| 750 | + /** |
|
| 751 | + * Parses a CSS declaration block into property name/value pairs. |
|
| 752 | + * |
|
| 753 | + * Example: |
|
| 754 | + * |
|
| 755 | + * The declaration block. |
|
| 756 | + * |
|
| 757 | + * "color: #000; font-weight: bold;". |
|
| 758 | + * |
|
| 759 | + * will be parsed into the following array: |
|
| 760 | + * |
|
| 761 | + * "color" => "#000" |
|
| 762 | + * "font-weight" => "bold" |
|
| 763 | + * |
|
| 764 | + * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
| 765 | + * |
|
| 766 | + * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
| 767 | + */ |
|
| 768 | + private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
| 769 | + if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
| 770 | + return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
| 771 | + } |
|
| 772 | + |
|
| 773 | + $properties = array(); |
|
| 774 | + $declarations = explode(';', $cssDeclarationBlock); |
|
| 775 | + foreach ($declarations as $declaration) { |
|
| 776 | + $matches = array(); |
|
| 777 | + if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
| 778 | + continue; |
|
| 779 | + } |
|
| 780 | + $propertyName = strtolower($matches[1]); |
|
| 781 | + $propertyValue = $matches[2]; |
|
| 782 | + $properties[$propertyName] = $propertyValue; |
|
| 783 | + } |
|
| 784 | + $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
| 785 | + |
|
| 786 | + return $properties; |
|
| 787 | + } |
|
| 788 | 788 | } |
@@ -8,151 +8,151 @@ |
||
| 8 | 8 | */ |
| 9 | 9 | class WP_Session_Command extends \WP_CLI_Command { |
| 10 | 10 | |
| 11 | - /** |
|
| 12 | - * Count the total number of sessions stored in the database. |
|
| 13 | - * |
|
| 14 | - * |
|
| 15 | - * ## EXAMPLES |
|
| 16 | - * |
|
| 17 | - * wp session count |
|
| 18 | - * |
|
| 19 | - * @global wpdb $wpdb |
|
| 20 | - * |
|
| 21 | - * @param array $args |
|
| 22 | - * @param array $assoc_args |
|
| 23 | - */ |
|
| 24 | - public function count( $args, $assoc_args ) { |
|
| 25 | - $sessions = WP_Session_Utils::count_sessions(); |
|
| 26 | - |
|
| 27 | - \WP_CLI::line( sprintf( '%d sessions currently exist.', absint( $sessions ) ) ); |
|
| 28 | - } |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * Delete sessions from the database. |
|
| 32 | - * |
|
| 33 | - * ## OPTIONS |
|
| 34 | - * |
|
| 35 | - * [--all] |
|
| 36 | - * : Flag whether or not to purge all sessions from the database. |
|
| 37 | - * |
|
| 38 | - * [--batch=<batch>] |
|
| 39 | - * : Set the batch size for deleting old sessions |
|
| 40 | - * |
|
| 41 | - * [--limit=<limit>] |
|
| 42 | - * : Delete just this number of old sessions |
|
| 43 | - * |
|
| 44 | - * ## EXAMPLES |
|
| 45 | - * |
|
| 46 | - * wp session delete |
|
| 47 | - * wp session delete [--batch=<batch>] |
|
| 48 | - * wp session delete [--limit=<limit>] |
|
| 49 | - * wp session delete [--all] |
|
| 50 | - * |
|
| 51 | - * @synopsis [--all] [--batch=<batch>] [--limit=<limit>] |
|
| 52 | - * |
|
| 53 | - * @param array $args |
|
| 54 | - * @param array $assoc_args |
|
| 55 | - */ |
|
| 56 | - public function delete( $args, $assoc_args ) { |
|
| 57 | - if ( isset( $assoc_args['limit'] ) ) { |
|
| 58 | - $limit = absint( $assoc_args['limit'] ); |
|
| 59 | - |
|
| 60 | - $count = WP_Session_Utils::delete_old_sessions( $limit ); |
|
| 61 | - |
|
| 62 | - if ( $count > 0 ) { |
|
| 63 | - \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
| 64 | - } |
|
| 65 | - |
|
| 66 | - // Clear memory |
|
| 67 | - self::free_up_memory(); |
|
| 68 | - return; |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - // Determine if we're deleting all sessions or just a subset. |
|
| 72 | - $all = isset( $assoc_args['all'] ); |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Determine the size of each batch for deletion. |
|
| 76 | - * |
|
| 77 | - * @param int |
|
| 78 | - */ |
|
| 79 | - $batch = isset( $assoc_args['batch'] ) ? absint( $assoc_args['batch'] ) : apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
| 80 | - |
|
| 81 | - switch ( $all ) { |
|
| 82 | - case true: |
|
| 83 | - $count = WP_Session_Utils::delete_all_sessions(); |
|
| 84 | - |
|
| 85 | - \WP_CLI::line( sprintf( 'Deleted all %d sessions.', $count ) ); |
|
| 86 | - break; |
|
| 87 | - case false: |
|
| 88 | - do { |
|
| 89 | - $count = WP_Session_Utils::delete_old_sessions( $batch ); |
|
| 90 | - |
|
| 91 | - if ( $count > 0 ) { |
|
| 92 | - \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - // Clear memory |
|
| 96 | - self::free_up_memory(); |
|
| 97 | - } while ( $count > 0 ); |
|
| 98 | - break; |
|
| 99 | - } |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * Generate a number of dummy sessions for testing purposes. |
|
| 104 | - * |
|
| 105 | - * ## OPTIONS |
|
| 106 | - * |
|
| 107 | - * <count> |
|
| 108 | - * : Number of sessions to create. |
|
| 109 | - * |
|
| 110 | - * [--expires=<date>] |
|
| 111 | - * : Optional expiration time tagged for each session. Will use WordPress' local time. |
|
| 112 | - * |
|
| 113 | - * ## EXAMPLES |
|
| 114 | - * |
|
| 115 | - * wp session generate 5000 |
|
| 116 | - * wp session generate 5000 --expires="2014-11-09T08:00" |
|
| 117 | - * |
|
| 118 | - * @synopsis <count> [--expires=<date>] |
|
| 119 | - * |
|
| 120 | - * @param array $args |
|
| 121 | - * @param array $assoc_args |
|
| 122 | - */ |
|
| 123 | - public function generate( $args, $assoc_args ) { |
|
| 124 | - $count = absint( $args[0] ); |
|
| 125 | - $date = isset( $assoc_args['expires'] ) ? $assoc_args['expires'] : null; |
|
| 126 | - |
|
| 127 | - $notify = \WP_CLI\Utils\make_progress_bar( 'Generating sessions', $count ); |
|
| 128 | - |
|
| 129 | - for ( $i = 0; $i < $count; $i ++ ) { |
|
| 130 | - WP_Session_Utils::create_dummy_session( $date ); |
|
| 131 | - $notify->tick(); |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - $notify->finish(); |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * Free up memory |
|
| 139 | - * |
|
| 140 | - * @global WP_Object_Cache $wp_object_cache |
|
| 141 | - * @global wpdb $wpdb |
|
| 142 | - */ |
|
| 143 | - private function free_up_memory() { |
|
| 144 | - global $wp_object_cache, $wpdb; |
|
| 145 | - $wpdb->queries = array(); |
|
| 146 | - |
|
| 147 | - if ( ! is_object( $wp_object_cache ) ) { |
|
| 148 | - return; |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - $wp_object_cache->group_ops = array(); |
|
| 152 | - $wp_object_cache->stats = array(); |
|
| 153 | - $wp_object_cache->memcache_debug = array(); |
|
| 154 | - $wp_object_cache->cache = array(); |
|
| 155 | - } |
|
| 11 | + /** |
|
| 12 | + * Count the total number of sessions stored in the database. |
|
| 13 | + * |
|
| 14 | + * |
|
| 15 | + * ## EXAMPLES |
|
| 16 | + * |
|
| 17 | + * wp session count |
|
| 18 | + * |
|
| 19 | + * @global wpdb $wpdb |
|
| 20 | + * |
|
| 21 | + * @param array $args |
|
| 22 | + * @param array $assoc_args |
|
| 23 | + */ |
|
| 24 | + public function count( $args, $assoc_args ) { |
|
| 25 | + $sessions = WP_Session_Utils::count_sessions(); |
|
| 26 | + |
|
| 27 | + \WP_CLI::line( sprintf( '%d sessions currently exist.', absint( $sessions ) ) ); |
|
| 28 | + } |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * Delete sessions from the database. |
|
| 32 | + * |
|
| 33 | + * ## OPTIONS |
|
| 34 | + * |
|
| 35 | + * [--all] |
|
| 36 | + * : Flag whether or not to purge all sessions from the database. |
|
| 37 | + * |
|
| 38 | + * [--batch=<batch>] |
|
| 39 | + * : Set the batch size for deleting old sessions |
|
| 40 | + * |
|
| 41 | + * [--limit=<limit>] |
|
| 42 | + * : Delete just this number of old sessions |
|
| 43 | + * |
|
| 44 | + * ## EXAMPLES |
|
| 45 | + * |
|
| 46 | + * wp session delete |
|
| 47 | + * wp session delete [--batch=<batch>] |
|
| 48 | + * wp session delete [--limit=<limit>] |
|
| 49 | + * wp session delete [--all] |
|
| 50 | + * |
|
| 51 | + * @synopsis [--all] [--batch=<batch>] [--limit=<limit>] |
|
| 52 | + * |
|
| 53 | + * @param array $args |
|
| 54 | + * @param array $assoc_args |
|
| 55 | + */ |
|
| 56 | + public function delete( $args, $assoc_args ) { |
|
| 57 | + if ( isset( $assoc_args['limit'] ) ) { |
|
| 58 | + $limit = absint( $assoc_args['limit'] ); |
|
| 59 | + |
|
| 60 | + $count = WP_Session_Utils::delete_old_sessions( $limit ); |
|
| 61 | + |
|
| 62 | + if ( $count > 0 ) { |
|
| 63 | + \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
| 64 | + } |
|
| 65 | + |
|
| 66 | + // Clear memory |
|
| 67 | + self::free_up_memory(); |
|
| 68 | + return; |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + // Determine if we're deleting all sessions or just a subset. |
|
| 72 | + $all = isset( $assoc_args['all'] ); |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Determine the size of each batch for deletion. |
|
| 76 | + * |
|
| 77 | + * @param int |
|
| 78 | + */ |
|
| 79 | + $batch = isset( $assoc_args['batch'] ) ? absint( $assoc_args['batch'] ) : apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
| 80 | + |
|
| 81 | + switch ( $all ) { |
|
| 82 | + case true: |
|
| 83 | + $count = WP_Session_Utils::delete_all_sessions(); |
|
| 84 | + |
|
| 85 | + \WP_CLI::line( sprintf( 'Deleted all %d sessions.', $count ) ); |
|
| 86 | + break; |
|
| 87 | + case false: |
|
| 88 | + do { |
|
| 89 | + $count = WP_Session_Utils::delete_old_sessions( $batch ); |
|
| 90 | + |
|
| 91 | + if ( $count > 0 ) { |
|
| 92 | + \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + // Clear memory |
|
| 96 | + self::free_up_memory(); |
|
| 97 | + } while ( $count > 0 ); |
|
| 98 | + break; |
|
| 99 | + } |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * Generate a number of dummy sessions for testing purposes. |
|
| 104 | + * |
|
| 105 | + * ## OPTIONS |
|
| 106 | + * |
|
| 107 | + * <count> |
|
| 108 | + * : Number of sessions to create. |
|
| 109 | + * |
|
| 110 | + * [--expires=<date>] |
|
| 111 | + * : Optional expiration time tagged for each session. Will use WordPress' local time. |
|
| 112 | + * |
|
| 113 | + * ## EXAMPLES |
|
| 114 | + * |
|
| 115 | + * wp session generate 5000 |
|
| 116 | + * wp session generate 5000 --expires="2014-11-09T08:00" |
|
| 117 | + * |
|
| 118 | + * @synopsis <count> [--expires=<date>] |
|
| 119 | + * |
|
| 120 | + * @param array $args |
|
| 121 | + * @param array $assoc_args |
|
| 122 | + */ |
|
| 123 | + public function generate( $args, $assoc_args ) { |
|
| 124 | + $count = absint( $args[0] ); |
|
| 125 | + $date = isset( $assoc_args['expires'] ) ? $assoc_args['expires'] : null; |
|
| 126 | + |
|
| 127 | + $notify = \WP_CLI\Utils\make_progress_bar( 'Generating sessions', $count ); |
|
| 128 | + |
|
| 129 | + for ( $i = 0; $i < $count; $i ++ ) { |
|
| 130 | + WP_Session_Utils::create_dummy_session( $date ); |
|
| 131 | + $notify->tick(); |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + $notify->finish(); |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * Free up memory |
|
| 139 | + * |
|
| 140 | + * @global WP_Object_Cache $wp_object_cache |
|
| 141 | + * @global wpdb $wpdb |
|
| 142 | + */ |
|
| 143 | + private function free_up_memory() { |
|
| 144 | + global $wp_object_cache, $wpdb; |
|
| 145 | + $wpdb->queries = array(); |
|
| 146 | + |
|
| 147 | + if ( ! is_object( $wp_object_cache ) ) { |
|
| 148 | + return; |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + $wp_object_cache->group_ops = array(); |
|
| 152 | + $wp_object_cache->stats = array(); |
|
| 153 | + $wp_object_cache->memcache_debug = array(); |
|
| 154 | + $wp_object_cache->cache = array(); |
|
| 155 | + } |
|
| 156 | 156 | } |
| 157 | 157 | |
| 158 | 158 | \WP_CLI::add_command( 'session', 'WP_Session_Command' ); |
| 159 | 159 | \ No newline at end of file |
@@ -16,16 +16,16 @@ discard block |
||
| 16 | 16 | * @return int |
| 17 | 17 | */ |
| 18 | 18 | function wp_session_cache_expire() { |
| 19 | - $wp_session = WP_Session::get_instance(); |
|
| 19 | + $wp_session = WP_Session::get_instance(); |
|
| 20 | 20 | |
| 21 | - return $wp_session->cache_expiration(); |
|
| 21 | + return $wp_session->cache_expiration(); |
|
| 22 | 22 | } |
| 23 | 23 | |
| 24 | 24 | /** |
| 25 | 25 | * Alias of wp_session_write_close() |
| 26 | 26 | */ |
| 27 | 27 | function wp_session_commit() { |
| 28 | - wp_session_write_close(); |
|
| 28 | + wp_session_write_close(); |
|
| 29 | 29 | } |
| 30 | 30 | |
| 31 | 31 | /** |
@@ -34,9 +34,9 @@ discard block |
||
| 34 | 34 | * @param string $data |
| 35 | 35 | */ |
| 36 | 36 | function wp_session_decode( $data ) { |
| 37 | - $wp_session = WP_Session::get_instance(); |
|
| 37 | + $wp_session = WP_Session::get_instance(); |
|
| 38 | 38 | |
| 39 | - return $wp_session->json_in( $data ); |
|
| 39 | + return $wp_session->json_in( $data ); |
|
| 40 | 40 | } |
| 41 | 41 | |
| 42 | 42 | /** |
@@ -45,9 +45,9 @@ discard block |
||
| 45 | 45 | * @return string |
| 46 | 46 | */ |
| 47 | 47 | function wp_session_encode() { |
| 48 | - $wp_session = WP_Session::get_instance(); |
|
| 48 | + $wp_session = WP_Session::get_instance(); |
|
| 49 | 49 | |
| 50 | - return $wp_session->json_out(); |
|
| 50 | + return $wp_session->json_out(); |
|
| 51 | 51 | } |
| 52 | 52 | |
| 53 | 53 | /** |
@@ -58,11 +58,11 @@ discard block |
||
| 58 | 58 | * @return bool |
| 59 | 59 | */ |
| 60 | 60 | function wp_session_regenerate_id( $delete_old_session = false ) { |
| 61 | - $wp_session = WP_Session::get_instance(); |
|
| 61 | + $wp_session = WP_Session::get_instance(); |
|
| 62 | 62 | |
| 63 | - $wp_session->regenerate_id( $delete_old_session ); |
|
| 63 | + $wp_session->regenerate_id( $delete_old_session ); |
|
| 64 | 64 | |
| 65 | - return true; |
|
| 65 | + return true; |
|
| 66 | 66 | } |
| 67 | 67 | |
| 68 | 68 | /** |
@@ -73,13 +73,13 @@ discard block |
||
| 73 | 73 | * @return bool |
| 74 | 74 | */ |
| 75 | 75 | function wp_session_start() { |
| 76 | - $wp_session = WP_Session::get_instance(); |
|
| 77 | - do_action( 'wp_session_start' ); |
|
| 76 | + $wp_session = WP_Session::get_instance(); |
|
| 77 | + do_action( 'wp_session_start' ); |
|
| 78 | 78 | |
| 79 | - return $wp_session->session_started(); |
|
| 79 | + return $wp_session->session_started(); |
|
| 80 | 80 | } |
| 81 | 81 | if ( ! defined( 'WP_CLI' ) || false === WP_CLI ) { |
| 82 | - add_action( 'plugins_loaded', 'wp_session_start' ); |
|
| 82 | + add_action( 'plugins_loaded', 'wp_session_start' ); |
|
| 83 | 83 | } |
| 84 | 84 | |
| 85 | 85 | /** |
@@ -88,35 +88,35 @@ discard block |
||
| 88 | 88 | * @return int |
| 89 | 89 | */ |
| 90 | 90 | function wp_session_status() { |
| 91 | - $wp_session = WP_Session::get_instance(); |
|
| 91 | + $wp_session = WP_Session::get_instance(); |
|
| 92 | 92 | |
| 93 | - if ( $wp_session->session_started() ) { |
|
| 94 | - return PHP_SESSION_ACTIVE; |
|
| 95 | - } |
|
| 93 | + if ( $wp_session->session_started() ) { |
|
| 94 | + return PHP_SESSION_ACTIVE; |
|
| 95 | + } |
|
| 96 | 96 | |
| 97 | - return PHP_SESSION_NONE; |
|
| 97 | + return PHP_SESSION_NONE; |
|
| 98 | 98 | } |
| 99 | 99 | |
| 100 | 100 | /** |
| 101 | 101 | * Unset all session variables. |
| 102 | 102 | */ |
| 103 | 103 | function wp_session_unset() { |
| 104 | - $wp_session = WP_Session::get_instance(); |
|
| 104 | + $wp_session = WP_Session::get_instance(); |
|
| 105 | 105 | |
| 106 | - $wp_session->reset(); |
|
| 106 | + $wp_session->reset(); |
|
| 107 | 107 | } |
| 108 | 108 | |
| 109 | 109 | /** |
| 110 | 110 | * Write session data and end session |
| 111 | 111 | */ |
| 112 | 112 | function wp_session_write_close() { |
| 113 | - $wp_session = WP_Session::get_instance(); |
|
| 113 | + $wp_session = WP_Session::get_instance(); |
|
| 114 | 114 | |
| 115 | - $wp_session->write_data(); |
|
| 116 | - do_action( 'wp_session_commit' ); |
|
| 115 | + $wp_session->write_data(); |
|
| 116 | + do_action( 'wp_session_commit' ); |
|
| 117 | 117 | } |
| 118 | 118 | if ( ! defined( 'WP_CLI' ) || false === WP_CLI ) { |
| 119 | - add_action( 'shutdown', 'wp_session_write_close' ); |
|
| 119 | + add_action( 'shutdown', 'wp_session_write_close' ); |
|
| 120 | 120 | } |
| 121 | 121 | |
| 122 | 122 | /** |
@@ -127,24 +127,24 @@ discard block |
||
| 127 | 127 | * of a scheduled task or cron job. |
| 128 | 128 | */ |
| 129 | 129 | function wp_session_cleanup() { |
| 130 | - if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
| 131 | - return; |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - if ( ! defined( 'WP_INSTALLING' ) ) { |
|
| 135 | - /** |
|
| 136 | - * Determine the size of each batch for deletion. |
|
| 137 | - * |
|
| 138 | - * @param int |
|
| 139 | - */ |
|
| 140 | - $batch_size = apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
| 141 | - |
|
| 142 | - // Delete a batch of old sessions |
|
| 143 | - WP_Session_Utils::delete_old_sessions( $batch_size ); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - // Allow other plugins to hook in to the garbage collection process. |
|
| 147 | - do_action( 'wp_session_cleanup' ); |
|
| 130 | + if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
| 131 | + return; |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + if ( ! defined( 'WP_INSTALLING' ) ) { |
|
| 135 | + /** |
|
| 136 | + * Determine the size of each batch for deletion. |
|
| 137 | + * |
|
| 138 | + * @param int |
|
| 139 | + */ |
|
| 140 | + $batch_size = apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
| 141 | + |
|
| 142 | + // Delete a batch of old sessions |
|
| 143 | + WP_Session_Utils::delete_old_sessions( $batch_size ); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + // Allow other plugins to hook in to the garbage collection process. |
|
| 147 | + do_action( 'wp_session_cleanup' ); |
|
| 148 | 148 | } |
| 149 | 149 | add_action( 'wp_session_garbage_collection', 'wp_session_cleanup' ); |
| 150 | 150 | |
@@ -152,8 +152,8 @@ discard block |
||
| 152 | 152 | * Register the garbage collector as a twice daily event. |
| 153 | 153 | */ |
| 154 | 154 | function wp_session_register_garbage_collection() { |
| 155 | - if ( ! wp_next_scheduled( 'wp_session_garbage_collection' ) ) { |
|
| 156 | - wp_schedule_event( time(), 'hourly', 'wp_session_garbage_collection' ); |
|
| 157 | - } |
|
| 155 | + if ( ! wp_next_scheduled( 'wp_session_garbage_collection' ) ) { |
|
| 156 | + wp_schedule_event( time(), 'hourly', 'wp_session_garbage_collection' ); |
|
| 157 | + } |
|
| 158 | 158 | } |
| 159 | 159 | add_action( 'wp', 'wp_session_register_garbage_collection' ); |
@@ -17,215 +17,215 @@ |
||
| 17 | 17 | * @since 3.7.0 |
| 18 | 18 | */ |
| 19 | 19 | final class WP_Session extends Recursive_ArrayAccess { |
| 20 | - /** |
|
| 21 | - * ID of the current session. |
|
| 22 | - * |
|
| 23 | - * @var string |
|
| 24 | - */ |
|
| 25 | - public $session_id; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * Unix timestamp when session expires. |
|
| 29 | - * |
|
| 30 | - * @var int |
|
| 31 | - */ |
|
| 32 | - protected $expires; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * Unix timestamp indicating when the expiration time needs to be reset. |
|
| 36 | - * |
|
| 37 | - * @var int |
|
| 38 | - */ |
|
| 39 | - protected $exp_variant; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * Singleton instance. |
|
| 43 | - * |
|
| 44 | - * @var bool|WP_Session |
|
| 45 | - */ |
|
| 46 | - private static $instance = false; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * Retrieve the current session instance. |
|
| 50 | - * |
|
| 51 | - * @param bool $session_id Session ID from which to populate data. |
|
| 52 | - * |
|
| 53 | - * @return bool|WP_Session |
|
| 54 | - */ |
|
| 55 | - public static function get_instance() { |
|
| 56 | - if ( ! self::$instance ) { |
|
| 57 | - self::$instance = new self(); |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - return self::$instance; |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Default constructor. |
|
| 65 | - * Will rebuild the session collection from the given session ID if it exists. Otherwise, will |
|
| 66 | - * create a new session with that ID. |
|
| 67 | - * |
|
| 68 | - * @param $session_id |
|
| 69 | - * @uses apply_filters Calls `wp_session_expiration` to determine how long until sessions expire. |
|
| 70 | - */ |
|
| 71 | - protected function __construct() { |
|
| 72 | - if ( isset( $_COOKIE[WP_SESSION_COOKIE] ) ) { |
|
| 73 | - $cookie = stripslashes( $_COOKIE[WP_SESSION_COOKIE] ); |
|
| 74 | - $cookie_crumbs = explode( '||', $cookie ); |
|
| 20 | + /** |
|
| 21 | + * ID of the current session. |
|
| 22 | + * |
|
| 23 | + * @var string |
|
| 24 | + */ |
|
| 25 | + public $session_id; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Unix timestamp when session expires. |
|
| 29 | + * |
|
| 30 | + * @var int |
|
| 31 | + */ |
|
| 32 | + protected $expires; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * Unix timestamp indicating when the expiration time needs to be reset. |
|
| 36 | + * |
|
| 37 | + * @var int |
|
| 38 | + */ |
|
| 39 | + protected $exp_variant; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * Singleton instance. |
|
| 43 | + * |
|
| 44 | + * @var bool|WP_Session |
|
| 45 | + */ |
|
| 46 | + private static $instance = false; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * Retrieve the current session instance. |
|
| 50 | + * |
|
| 51 | + * @param bool $session_id Session ID from which to populate data. |
|
| 52 | + * |
|
| 53 | + * @return bool|WP_Session |
|
| 54 | + */ |
|
| 55 | + public static function get_instance() { |
|
| 56 | + if ( ! self::$instance ) { |
|
| 57 | + self::$instance = new self(); |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + return self::$instance; |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Default constructor. |
|
| 65 | + * Will rebuild the session collection from the given session ID if it exists. Otherwise, will |
|
| 66 | + * create a new session with that ID. |
|
| 67 | + * |
|
| 68 | + * @param $session_id |
|
| 69 | + * @uses apply_filters Calls `wp_session_expiration` to determine how long until sessions expire. |
|
| 70 | + */ |
|
| 71 | + protected function __construct() { |
|
| 72 | + if ( isset( $_COOKIE[WP_SESSION_COOKIE] ) ) { |
|
| 73 | + $cookie = stripslashes( $_COOKIE[WP_SESSION_COOKIE] ); |
|
| 74 | + $cookie_crumbs = explode( '||', $cookie ); |
|
| 75 | 75 | |
| 76 | 76 | $this->session_id = preg_replace("/[^A-Za-z0-9_]/", '', $cookie_crumbs[0] ); |
| 77 | 77 | $this->expires = absint( $cookie_crumbs[1] ); |
| 78 | 78 | $this->exp_variant = absint( $cookie_crumbs[2] ); |
| 79 | 79 | |
| 80 | - // Update the session expiration if we're past the variant time |
|
| 81 | - if ( time() > $this->exp_variant ) { |
|
| 82 | - $this->set_expiration(); |
|
| 83 | - delete_option( "_wp_session_expires_{$this->session_id}" ); |
|
| 84 | - add_option( "_wp_session_expires_{$this->session_id}", $this->expires, '', 'no' ); |
|
| 85 | - } |
|
| 86 | - } else { |
|
| 87 | - $this->session_id = WP_Session_Utils::generate_id(); |
|
| 88 | - $this->set_expiration(); |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - $this->read_data(); |
|
| 92 | - |
|
| 93 | - $this->set_cookie(); |
|
| 94 | - |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - /** |
|
| 98 | - * Set both the expiration time and the expiration variant. |
|
| 99 | - * |
|
| 100 | - * If the current time is below the variant, we don't update the session's expiration time. If it's |
|
| 101 | - * greater than the variant, then we update the expiration time in the database. This prevents |
|
| 102 | - * writing to the database on every page load for active sessions and only updates the expiration |
|
| 103 | - * time if we're nearing when the session actually expires. |
|
| 104 | - * |
|
| 105 | - * By default, the expiration time is set to 30 minutes. |
|
| 106 | - * By default, the expiration variant is set to 24 minutes. |
|
| 107 | - * |
|
| 108 | - * As a result, the session expiration time - at a maximum - will only be written to the database once |
|
| 109 | - * every 24 minutes. After 30 minutes, the session will have been expired. No cookie will be sent by |
|
| 110 | - * the browser, and the old session will be queued for deletion by the garbage collector. |
|
| 111 | - * |
|
| 112 | - * @uses apply_filters Calls `wp_session_expiration_variant` to get the max update window for session data. |
|
| 113 | - * @uses apply_filters Calls `wp_session_expiration` to get the standard expiration time for sessions. |
|
| 114 | - */ |
|
| 115 | - protected function set_expiration() { |
|
| 116 | - $this->exp_variant = time() + (int) apply_filters( 'wp_session_expiration_variant', 24 * 60 ); |
|
| 117 | - $this->expires = time() + (int) apply_filters( 'wp_session_expiration', 30 * 60 ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * Set the session cookie |
|
| 122 | - * @uses apply_filters Calls `wp_session_cookie_secure` to set the $secure parameter of setcookie() |
|
| 123 | - * @uses apply_filters Calls `wp_session_cookie_httponly` to set the $httponly parameter of setcookie() |
|
| 124 | - */ |
|
| 125 | - protected function set_cookie() { |
|
| 126 | - if ( !defined( 'WPI_TESTING_MODE' ) ) { |
|
| 127 | - try { |
|
| 128 | - $secure = apply_filters('wp_session_cookie_secure', false); |
|
| 129 | - $httponly = apply_filters('wp_session_cookie_httponly', false); |
|
| 130 | - setcookie( WP_SESSION_COOKIE, $this->session_id . '||' . $this->expires . '||' . $this->exp_variant , $this->expires, COOKIEPATH, COOKIE_DOMAIN, $secure, $httponly ); |
|
| 131 | - } catch(Exception $e) { |
|
| 132 | - error_log( 'Set Cookie Error: ' . $e->getMessage() ); |
|
| 133 | - } |
|
| 134 | - } |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * Read data from a transient for the current session. |
|
| 139 | - * |
|
| 140 | - * Automatically resets the expiration time for the session transient to some time in the future. |
|
| 141 | - * |
|
| 142 | - * @return array |
|
| 143 | - */ |
|
| 144 | - protected function read_data() { |
|
| 145 | - $this->container = get_option( "_wp_session_{$this->session_id}", array() ); |
|
| 146 | - |
|
| 147 | - return $this->container; |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * Write the data from the current session to the data storage system. |
|
| 152 | - */ |
|
| 153 | - public function write_data() { |
|
| 154 | - $option_key = "_wp_session_{$this->session_id}"; |
|
| 80 | + // Update the session expiration if we're past the variant time |
|
| 81 | + if ( time() > $this->exp_variant ) { |
|
| 82 | + $this->set_expiration(); |
|
| 83 | + delete_option( "_wp_session_expires_{$this->session_id}" ); |
|
| 84 | + add_option( "_wp_session_expires_{$this->session_id}", $this->expires, '', 'no' ); |
|
| 85 | + } |
|
| 86 | + } else { |
|
| 87 | + $this->session_id = WP_Session_Utils::generate_id(); |
|
| 88 | + $this->set_expiration(); |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + $this->read_data(); |
|
| 92 | + |
|
| 93 | + $this->set_cookie(); |
|
| 94 | + |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + /** |
|
| 98 | + * Set both the expiration time and the expiration variant. |
|
| 99 | + * |
|
| 100 | + * If the current time is below the variant, we don't update the session's expiration time. If it's |
|
| 101 | + * greater than the variant, then we update the expiration time in the database. This prevents |
|
| 102 | + * writing to the database on every page load for active sessions and only updates the expiration |
|
| 103 | + * time if we're nearing when the session actually expires. |
|
| 104 | + * |
|
| 105 | + * By default, the expiration time is set to 30 minutes. |
|
| 106 | + * By default, the expiration variant is set to 24 minutes. |
|
| 107 | + * |
|
| 108 | + * As a result, the session expiration time - at a maximum - will only be written to the database once |
|
| 109 | + * every 24 minutes. After 30 minutes, the session will have been expired. No cookie will be sent by |
|
| 110 | + * the browser, and the old session will be queued for deletion by the garbage collector. |
|
| 111 | + * |
|
| 112 | + * @uses apply_filters Calls `wp_session_expiration_variant` to get the max update window for session data. |
|
| 113 | + * @uses apply_filters Calls `wp_session_expiration` to get the standard expiration time for sessions. |
|
| 114 | + */ |
|
| 115 | + protected function set_expiration() { |
|
| 116 | + $this->exp_variant = time() + (int) apply_filters( 'wp_session_expiration_variant', 24 * 60 ); |
|
| 117 | + $this->expires = time() + (int) apply_filters( 'wp_session_expiration', 30 * 60 ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * Set the session cookie |
|
| 122 | + * @uses apply_filters Calls `wp_session_cookie_secure` to set the $secure parameter of setcookie() |
|
| 123 | + * @uses apply_filters Calls `wp_session_cookie_httponly` to set the $httponly parameter of setcookie() |
|
| 124 | + */ |
|
| 125 | + protected function set_cookie() { |
|
| 126 | + if ( !defined( 'WPI_TESTING_MODE' ) ) { |
|
| 127 | + try { |
|
| 128 | + $secure = apply_filters('wp_session_cookie_secure', false); |
|
| 129 | + $httponly = apply_filters('wp_session_cookie_httponly', false); |
|
| 130 | + setcookie( WP_SESSION_COOKIE, $this->session_id . '||' . $this->expires . '||' . $this->exp_variant , $this->expires, COOKIEPATH, COOKIE_DOMAIN, $secure, $httponly ); |
|
| 131 | + } catch(Exception $e) { |
|
| 132 | + error_log( 'Set Cookie Error: ' . $e->getMessage() ); |
|
| 133 | + } |
|
| 134 | + } |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * Read data from a transient for the current session. |
|
| 139 | + * |
|
| 140 | + * Automatically resets the expiration time for the session transient to some time in the future. |
|
| 141 | + * |
|
| 142 | + * @return array |
|
| 143 | + */ |
|
| 144 | + protected function read_data() { |
|
| 145 | + $this->container = get_option( "_wp_session_{$this->session_id}", array() ); |
|
| 146 | + |
|
| 147 | + return $this->container; |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * Write the data from the current session to the data storage system. |
|
| 152 | + */ |
|
| 153 | + public function write_data() { |
|
| 154 | + $option_key = "_wp_session_{$this->session_id}"; |
|
| 155 | 155 | |
| 156 | - if ( false === get_option( $option_key ) ) { |
|
| 157 | - add_option( "_wp_session_{$this->session_id}", $this->container, '', 'no' ); |
|
| 158 | - add_option( "_wp_session_expires_{$this->session_id}", $this->expires, '', 'no' ); |
|
| 159 | - } else { |
|
| 160 | - delete_option( "_wp_session_{$this->session_id}" ); |
|
| 161 | - add_option( "_wp_session_{$this->session_id}", $this->container, '', 'no' ); |
|
| 162 | - } |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * Output the current container contents as a JSON-encoded string. |
|
| 167 | - * |
|
| 168 | - * @return string |
|
| 169 | - */ |
|
| 170 | - public function json_out() { |
|
| 171 | - return json_encode( $this->container ); |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - /** |
|
| 175 | - * Decodes a JSON string and, if the object is an array, overwrites the session container with its contents. |
|
| 176 | - * |
|
| 177 | - * @param string $data |
|
| 178 | - * |
|
| 179 | - * @return bool |
|
| 180 | - */ |
|
| 181 | - public function json_in( $data ) { |
|
| 182 | - $array = json_decode( $data ); |
|
| 183 | - |
|
| 184 | - if ( is_array( $array ) ) { |
|
| 185 | - $this->container = $array; |
|
| 186 | - return true; |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - return false; |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * Regenerate the current session's ID. |
|
| 194 | - * |
|
| 195 | - * @param bool $delete_old Flag whether or not to delete the old session data from the server. |
|
| 196 | - */ |
|
| 197 | - public function regenerate_id( $delete_old = false ) { |
|
| 198 | - if ( $delete_old ) { |
|
| 199 | - delete_option( "_wp_session_{$this->session_id}" ); |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - $this->session_id = WP_Session_Utils::generate_id(); |
|
| 203 | - |
|
| 204 | - $this->set_cookie(); |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * Check if a session has been initialized. |
|
| 209 | - * |
|
| 210 | - * @return bool |
|
| 211 | - */ |
|
| 212 | - public function session_started() { |
|
| 213 | - return !!self::$instance; |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - /** |
|
| 217 | - * Return the read-only cache expiration value. |
|
| 218 | - * |
|
| 219 | - * @return int |
|
| 220 | - */ |
|
| 221 | - public function cache_expiration() { |
|
| 222 | - return $this->expires; |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * Flushes all session variables. |
|
| 227 | - */ |
|
| 228 | - public function reset() { |
|
| 229 | - $this->container = array(); |
|
| 230 | - } |
|
| 156 | + if ( false === get_option( $option_key ) ) { |
|
| 157 | + add_option( "_wp_session_{$this->session_id}", $this->container, '', 'no' ); |
|
| 158 | + add_option( "_wp_session_expires_{$this->session_id}", $this->expires, '', 'no' ); |
|
| 159 | + } else { |
|
| 160 | + delete_option( "_wp_session_{$this->session_id}" ); |
|
| 161 | + add_option( "_wp_session_{$this->session_id}", $this->container, '', 'no' ); |
|
| 162 | + } |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * Output the current container contents as a JSON-encoded string. |
|
| 167 | + * |
|
| 168 | + * @return string |
|
| 169 | + */ |
|
| 170 | + public function json_out() { |
|
| 171 | + return json_encode( $this->container ); |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + /** |
|
| 175 | + * Decodes a JSON string and, if the object is an array, overwrites the session container with its contents. |
|
| 176 | + * |
|
| 177 | + * @param string $data |
|
| 178 | + * |
|
| 179 | + * @return bool |
|
| 180 | + */ |
|
| 181 | + public function json_in( $data ) { |
|
| 182 | + $array = json_decode( $data ); |
|
| 183 | + |
|
| 184 | + if ( is_array( $array ) ) { |
|
| 185 | + $this->container = $array; |
|
| 186 | + return true; |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + return false; |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * Regenerate the current session's ID. |
|
| 194 | + * |
|
| 195 | + * @param bool $delete_old Flag whether or not to delete the old session data from the server. |
|
| 196 | + */ |
|
| 197 | + public function regenerate_id( $delete_old = false ) { |
|
| 198 | + if ( $delete_old ) { |
|
| 199 | + delete_option( "_wp_session_{$this->session_id}" ); |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + $this->session_id = WP_Session_Utils::generate_id(); |
|
| 203 | + |
|
| 204 | + $this->set_cookie(); |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * Check if a session has been initialized. |
|
| 209 | + * |
|
| 210 | + * @return bool |
|
| 211 | + */ |
|
| 212 | + public function session_started() { |
|
| 213 | + return !!self::$instance; |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + /** |
|
| 217 | + * Return the read-only cache expiration value. |
|
| 218 | + * |
|
| 219 | + * @return int |
|
| 220 | + */ |
|
| 221 | + public function cache_expiration() { |
|
| 222 | + return $this->expires; |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * Flushes all session variables. |
|
| 227 | + */ |
|
| 228 | + public function reset() { |
|
| 229 | + $this->container = array(); |
|
| 230 | + } |
|
| 231 | 231 | } |