class-wpml-tm-validate-html.php 11.9 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
<?php

/**
 * Class WPML_TM_Validate_HTML
 */
class WPML_TM_Validate_HTML {

	/** @var string Validated html */
	private $html = '';

	/** @var array Tags currently open */
	private $tags = array();

	/** @var int Number of errors */
	private $error_count = 0;

	/**
	 * Get validated html.
	 *
	 * @return string
	 */
	public function get_html() {
		return $this->html;
	}

	/**
	 * Validate html.
	 *
	 * @param string $html HTML to process.
	 *
	 * @return int Number of errors.
	 */
	public function validate( $html ) {
		$html = $this->hide_wp_bugs( $html );
		$html = $this->hide_cdata( $html );
		$html = $this->hide_comments( $html );
		$html = $this->hide_self_closing_tags( $html );
		$html = $this->hide_scripts( $html );
		$html = $this->hide_styles( $html );

		$processed_html = '';
		$html_arr       = array(
			'processed' => $processed_html,
			'next'      => $html,
		);
		while ( '' !== $html_arr['next'] ) {
			$html_arr = $this->validate_next( $html_arr['next'] );
			if ( $html_arr ) {
				$processed_html .= $html_arr['processed'];
			}
		}

		$html = $processed_html;

		$html = $this->restore_styles( $html );
		$html = $this->restore_scripts( $html );
		$html = $this->restore_self_closing_tags( $html );
		$html = $this->restore_comments( $html );
		$html = $this->restore_wp_bugs( $html );

		$this->html = $html;

		return $this->error_count;
	}

	/**
	 * Validate first tag in html flow and return processed html and rest.
	 * In processed part broken html is replaced by wpml comment.
	 *
	 * @param string $html HTML to process.
	 *
	 * @return array|null
	 */
	private function validate_next( $html ) {
		$regs = array();

		// Get first opening or closing tag.
		$pattern = '<\s*?([a-z]+|/[a-z]+)((?:.|\s)*?)>';
		mb_eregi( $pattern, $html, $regs );

		if ( $regs ) {
			$full_tag  = $regs[0];
			$pos       = mb_strpos( $html, $full_tag );
			$next_html = mb_substr( $html, $pos + mb_strlen( $full_tag ) );

			$tag    = $regs[1];
			$result = true;
			if ( '/' === mb_substr( $tag, 0, 1 ) ) {
				$result = $this->close_tag( mb_substr( $tag, 1 ) );
			} else {
				$this->open_tag( $tag );
			}

			if ( $result ) {
				$processed_html = mb_substr( $html, 0, $pos + mb_strlen( $full_tag ) );
			} else {
				$processed_html = mb_substr( $html, 0, (int) $pos ) . '<!-- wpml:html_fragment ' . $full_tag . ' -->';
			}

			return array(
				'processed' => $processed_html,
				'next'      => $next_html,
			);
		}

		return array(
			'processed' => $html,
			'next'      => '',
		);
	}

	/**
	 * Convert WP bugs into wpml commented bugs.
	 *
	 * @param string $html HTML to process.
	 *
	 * @return string
	 */
	private function hide_wp_bugs( $html ) {
		// WP bug fix for comments - in case you REALLY meant to type '< !--'
		$html = str_replace( '< !--', '<    !--', $html );
		// WP bug fix for LOVE <3 (and other situations with '<' before a number)
		$pattern = '<([0-9]{1})';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'hide_wp_bug_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert WP bugs into wpml commented bugs.
	 *
	 * @param array $matches
	 *
	 * @return string
	 */
	public function hide_wp_bug_callback( $matches ) {
		return '<!-- wpml:wp_bug ' . $matches[0] . ' -->';
	}

	/**
	 * Convert wpml commented bugs to WP bugs.
	 *
	 * @param $html
	 *
	 * @return string
	 */
	private function restore_wp_bugs( $html ) {
		$pattern  = '<!-- wpml:wp_bug (.*?) -->';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'restore_bug_callback' ), $html, 'msri' );
		$html     = $filtered === false ? $html : $filtered;
		$html     = str_replace( '<    !--', '< !--', $html );

		return $html;
	}

	/**
	 * Callback to convert wpml commented bugs to WP bugs.
	 *
	 * @param array $matches
	 *
	 * @return mixed
	 */
	public function restore_bug_callback( $matches ) {
		return $matches[1];
	}

	/**
	 * Convert HTML comments into wpml comments.
	 *
	 * @param string $html HTML to process.
	 *
	 * @return string
	 */
	private function hide_comments( $html ) {
		$pattern  = '<!--(.*?)-->';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'hide_comment_callback' ), $html, 'msri' );
		$html     = $filtered === false ? $html : $filtered;

		$pattern  = '<!((?!-- wpml:).*?)>';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'hide_declaration_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert HTML comment to wpml comment.
	 *
	 * @param array $matches
	 *
	 * @return string
	 */
	public function hide_comment_callback( $matches ) {
		return '<!-- wpml:html_comment ' . base64_encode( $matches[0] ) . ' -->';
	}

	/**
	 * Callback to convert HTML declaration to wpml declaration.
	 *
	 * @param array $matches
	 *
	 * @return string
	 */
	public function hide_declaration_callback( $matches ) {
		return '<!-- wpml:html_declaration ' . base64_encode( $matches[0] ) . ' -->';
	}

	/**
	 * Convert wpml comments to HTML comments.
	 *
	 * @param string $html
	 *
	 * @return string
	 */
	private function restore_comments( $html ) {
		$pattern  = '<!-- wpml:html_comment (.*?) -->';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'restore_encoded_content_callback' ), $html, 'msri' );
		$html     = $filtered === false ? $html : $filtered;

		$pattern  = '<!-- wpml:html_declaration (.*?) -->';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'restore_encoded_content_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert wpml base64 encoded content.
	 *
	 * @param array $matches
	 *
	 * @return string
	 */
	public function restore_encoded_content_callback( $matches ) {
		return base64_decode( $matches[1] );
	}

	/**
	 * Convert self-closing tags to wpml self-closing tags.
	 *
	 * @param string $html HTML to process.
	 *
	 * @return string
	 */
	private function hide_self_closing_tags( $html ) {
		$self_closing_tags = array(
			'area',
			'base',
			'basefont',
			'br',
			'col',
			'command',
			'embed',
			'frame',
			'hr',
			'img',
			'input',
			'isindex',
			'link',
			'meta',
			'param',
			'source',
			'track',
			'wbr',
			'command',
			'keygen',
			'menuitem',
			'path',
			'polyline',
		);
		foreach ( $self_closing_tags as $self_closing_tag ) {
			$pattern  = '<\s*?' . $self_closing_tag . '((?:.|\s)*?)(>|/>)';
			$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'hide_sct_callback' ), $html, 'msri' );
			$html = $filtered === false ? $html : $filtered;
		}

		$pattern = '<\s*?[^>]*/>';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'hide_sct_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert self-closing tags to wpml self-closing tags.
	 *
	 * @param $matches
	 *
	 * @return string
	 */
	public function hide_sct_callback( $matches ) {
		return '<!-- wpml:html_self_closing_tag ' . str_replace( array( '<', '>' ), '', $matches[0] ) . ' -->';
	}

	/**
	 * Convert wpml self-closing tags to HTML self-closing tags.
	 *
	 * @param $html
	 *
	 * @return string
	 */
	private function restore_self_closing_tags( $html ) {
		$pattern = '<!-- wpml:html_self_closing_tag (.*?) -->';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'restore_sct_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert wpml self-closing tags to self-closing tags.
	 *
	 * @param $matches
	 *
	 * @return string
	 */
	public function restore_sct_callback( $matches ) {
		return '<' . $matches[1] . '>';
	}

	/**
	 * Convert wpml comments to initial HTML.
	 *
	 * @param $html
	 *
	 * @return false|string
	 */
	public function restore_html( $html ) {
		$html = $this->restore_cdata( $html );
		$html = $this->restore_html_fragments( $html );
		return $html;
	}
	/**
	 * Convert wpml fragments to HTML fragments.
	 *
	 * @param $html
	 *
	 * @return false|string
	 */
	private function restore_html_fragments( $html ) {
		$pattern  = '<!-- wpml:html_fragment (.*?) -->';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'restore_html_fragment_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert wpml fragment to HTML fragment.
	 *
	 * @param $matches
	 *
	 * @return string
	 */
	public function restore_html_fragment_callback( $matches ) {
		return $matches[1];
	}

	/**
	 * Convert scripts to wpml scripts.
	 *
	 * @param string $html HTML to process.
	 *
	 * @return string
	 */
	private function hide_scripts( $html ) {
		$pattern  = '<\s*?script\s*?>((?:.|\s)*?)</script\s*?>';
		$filtered = mb_ereg_replace_callback( $pattern, array( $this, 'hide_script_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert script to wpml script.
	 *
	 * @param array $matches
	 *
	 * @return string
	 */
	public function hide_script_callback( $matches ) {
		return '<!-- wpml:script ' . base64_encode( $matches[0] ) . ' -->';
	}

	/**
	 * Convert wpml scripts to scripts.
	 *
	 * @param $html
	 *
	 * @return string
	 */
	private function restore_scripts( $html ) {
		$pattern = '<!-- wpml:script (.*?) -->';
		$filtered    = mb_ereg_replace_callback( $pattern, array( $this, 'restore_encoded_content_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Convert CDATA to wpml cdata.
	 *
	 * @param string $html HTML to process.
	 *
	 * @return string
	 */
	private function hide_cdata( $html ) {
		$pattern = '<!\[CDATA\[((?:.|\s)*?)\]\]>';
		$filtered    = mb_ereg_replace_callback( $pattern, array( $this, 'hide_cdata_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert CDATA to wpml cdata.
	 *
	 * @param array $matches
	 *
	 * @return string
	 */
	public function hide_cdata_callback( $matches ) {
		return '<!-- wpml:cdata ' . base64_encode( $matches[0] ) . ' -->';
	}

	/**
	 * Convert wpml cdata to CDATA.
	 *
	 * @param $html
	 *
	 * @return string
	 */
	private function restore_cdata( $html ) {
		$pattern = '<!-- wpml:cdata (.*?) -->';
		$filtered    = mb_ereg_replace_callback( $pattern, array( $this, 'restore_encoded_content_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Convert styles to wpml scripts.
	 *
	 * @param string $html HTML to process.
	 *
	 * @return string
	 */
	private function hide_styles( $html ) {
		$pattern = '<\s*?style\s*?>((?:.|\s)*?)</style\s*?>';
		$filtered    = mb_ereg_replace_callback( $pattern, array( $this, 'hide_style_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Callback to convert style to wpml style.
	 *
	 * @param array $matches
	 *
	 * @return string
	 */
	public function hide_style_callback( $matches ) {
		return '<!-- wpml:style ' . base64_encode( $matches[0] ) . ' -->';
	}

	/**
	 * Convert wpml styles to styles.
	 *
	 * @param $html
	 *
	 * @return string
	 */
	private function restore_styles( $html ) {
		$pattern = '<!-- wpml:style (.*?) -->';
		$filtered    = mb_ereg_replace_callback( $pattern, array( $this, 'restore_encoded_content_callback' ), $html, 'msri' );

		return $filtered === false ? $html : $filtered;
	}

	/**
	 * Open tag encountered in html.
	 *
	 * @param string $tag Tag name.
	 */
	private function open_tag( $tag ) {
		$tag = mb_strtolower( $tag );
		array_push( $this->tags, $tag );
	}

	/**
	 * Close tag encountered in html.
	 *
	 * @param string $tag Tag name.
	 *
	 * @return bool Closed successfully.
	 */
	private function close_tag( $tag ) {
		$tag      = mb_strtolower( $tag );
		$last_tag = end( $this->tags );
		if ( $last_tag === $tag ) {
			array_pop( $this->tags );

			return true;
		} else {
			$this->error_count ++;
			if ( in_array( $tag, $this->tags, true ) ) {
				do {
					array_pop( $this->tags );
				} while ( $this->tags && end( $this->tags ) !== $tag );
				array_pop( $this->tags );
			}

			return false;
		}
	}
}