%s', 80 | $exception->getMessage() 81 | ); 82 | } 83 | } 84 | 85 | /** 86 | * Render the nonce. 87 | * 88 | * @return string Hidden field with a nonce. 89 | */ 90 | protected function render_nonce() : string { 91 | ob_start(); 92 | 93 | wp_nonce_field( 94 | $this->get_nonce_action(), 95 | $this->get_nonce_name() 96 | ); 97 | 98 | return ob_get_clean(); 99 | } 100 | 101 | /** 102 | * Verify the nonce and return the result. 103 | * 104 | * @return bool Whether the nonce could be successfully verified. 105 | */ 106 | protected function verify_nonce() : bool { 107 | $nonce_name = $this->get_nonce_name(); 108 | 109 | if ( ! isset( $_POST[ $nonce_name ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.NoNonceVerification 110 | return false; 111 | } 112 | 113 | $nonce = sanitize_text_field( wp_unslash( $_POST[ $nonce_name ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.NoNonceVerification 114 | 115 | $result = wp_verify_nonce( 116 | $nonce, 117 | $this->get_nonce_action() 118 | ); 119 | 120 | return false !== $result; 121 | } 122 | 123 | /** 124 | * Get the action of the nonce to use. 125 | * 126 | * @return string Action of the nonce. 127 | */ 128 | protected function get_nonce_action() : string { 129 | return "{$this->get_menu_slug()}_action"; 130 | } 131 | 132 | /** 133 | * Get the name of the nonce to use. 134 | * 135 | * @return string Name of the nonce. 136 | */ 137 | protected function get_nonce_name() : string { 138 | return "{$this->get_menu_slug()}_nonce"; 139 | } 140 | 141 | /** 142 | * Get the title to use for the admin page. 143 | * 144 | * @return string The text to be displayed in the title tags of the page when the menu is selected. 145 | */ 146 | abstract protected function get_title() : string; 147 | 148 | /** 149 | * Get the menu title to use for the admin menu. 150 | * 151 | * @return string The text to be used for the menu. 152 | */ 153 | abstract protected function get_menu_title() : string; 154 | 155 | /** 156 | * Get the capability required for this menu to be displayed. 157 | * 158 | * @return string The capability required for this menu to be displayed to the user. 159 | */ 160 | abstract protected function get_capability() : string; 161 | 162 | /** 163 | * Get the menu slug. 164 | * 165 | * @return string The slug name to refer to this menu by. Should be unique for this menu page and only include lowercase alphanumeric, dashes, and underscores characters to be compatible with sanitize_key(). 166 | */ 167 | abstract protected function get_menu_slug() : string; 168 | 169 | /** 170 | * Get the URL to the icon to be used for this menu 171 | * 172 | * @return string The URL to the icon to be used for this menu. 173 | * * Pass a base64-encoded SVG using a data URI, which will be colored to match 174 | * the color scheme. This should begin with 'data:image/svg+xml;base64,'. 175 | * * Pass the name of a Dashicons helper class to use a font icon, 176 | * e.g. 'dashicons-chart-pie'. 177 | * * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS. 178 | */ 179 | protected function get_icon() : string { 180 | return 'none'; 181 | } 182 | 183 | /** 184 | * Get the position of the menu. 185 | * 186 | * @return int Number that indicates the position of the menu. 187 | * 5 - below Posts 188 | * 10 - below Media 189 | * 15 - below Links 190 | * 20 - below Pages 191 | * 25 - below comments 192 | * 60 - below first separator 193 | * 65 - below Plugins 194 | * 70 - below Users 195 | * 75 - below Tools 196 | * 80 - below Settings 197 | * 100 - below second separator 198 | */ 199 | protected function get_position() : int { 200 | return 100; 201 | } 202 | 203 | /** 204 | * Get the View URI to use for rendering the admin menu. 205 | * 206 | * @return string View URI. 207 | */ 208 | abstract protected function get_view_uri() : string; 209 | 210 | /** 211 | * Process the admin menu attributes. 212 | * 213 | * @param array|string $atts Raw admin menu attributes passed into the 214 | * admin menu function. 215 | * 216 | * @return array Processed admin menu attributes. 217 | */ 218 | abstract protected function process_attributes( $atts ) : array; 219 | } 220 | -------------------------------------------------------------------------------- /src/admin-menus/class-sniff-page.php: -------------------------------------------------------------------------------- 1 | get_active_themes(); 98 | } catch ( No_Themes_Present $e ) { 99 | $atts['error'] = esc_html( $e->getMessage() ); 100 | } 101 | 102 | $atts['standards'] = $this->get_wpcs_standards(); 103 | $atts['php_versions'] = $this->get_php_versions(); 104 | $atts['minimum_php_version'] = $this->get_minimum_php_version(); 105 | $atts['current_theme'] = \get_stylesheet(); 106 | $atts['standard_status'] = wp_list_pluck( $this->get_wpcs_standards(), 'default' ); 107 | 108 | return $atts; 109 | } 110 | } 111 | -------------------------------------------------------------------------------- /src/callback/class-base-ajax-callback.php: -------------------------------------------------------------------------------- 1 | get_action_name(); 29 | 30 | add_action( "wp_ajax_{$callback_name}", array( $this, 'callback' ) ); 31 | 32 | // Add nopriv action. 33 | if ( $this->is_public() ) { 34 | add_action( "wp_ajax_nopriv_{$callback_name}", array( $this, 'callback' ) ); 35 | } 36 | } 37 | 38 | /** 39 | * Callback method for the specific class. 40 | */ 41 | abstract public function callback(); 42 | 43 | /** 44 | * Returns true if the callback should be public 45 | * 46 | * @return boolean true if callback is public. 47 | */ 48 | abstract protected function is_public() : bool; 49 | 50 | /** 51 | * Get name of the callback action 52 | * 53 | * @return string Name of the callback action. 54 | */ 55 | abstract protected function get_action_name() : string; 56 | } 57 | -------------------------------------------------------------------------------- /src/callback/class-run-sniffer-callback.php: -------------------------------------------------------------------------------- 1 | get_wpcs_standards(); 352 | 353 | $selected_standards = array_map( 354 | 'sanitize_text_field', 355 | wp_unslash( $_POST[ self::WP_RULESETS ] ) 356 | ); 357 | 358 | $standards_array = array_map( 359 | function( $standard ) use ( $standards ) { 360 | if ( ! empty( $standards[ $standard ] ) ) { 361 | return $standards[ $standard ]['label']; 362 | } 363 | }, 364 | $selected_standards 365 | ); 366 | 367 | $args = array(); 368 | 369 | // Current theme text domain. 370 | $args[ self::TEXT_DOMAINS ] = array( self::$theme_slug ); 371 | 372 | $all_files = array( 'php' ); 373 | 374 | $theme = wp_get_theme( self::$theme_slug ); 375 | $all_files = $theme->get_files( $all_files, -1, false ); 376 | 377 | // Disallowed folders. 378 | $re = '/(\/node_modules)|(\/vendor)|(\/test)|(\/tests)/'; 379 | 380 | $files_to_sniff = array(); 381 | 382 | foreach ( $all_files as $file_name => $file_path ) { 383 | 384 | // Check for Frameworks. 385 | $allowed_frameworks = array( 386 | 'kirki' => 'kirki.php', 387 | 'hybrid-core' => 'hybrid.php', 388 | ); 389 | 390 | foreach ( $allowed_frameworks as $framework_textdomain => $identifier ) { 391 | if ( strrpos( $file_name, $identifier ) !== false && ! in_array( $framework_textdomain, $args[ self::TEXT_DOMAINS ], true ) ) { 392 | $args[ self::TEXT_DOMAINS ][] = $framework_textdomain; 393 | } 394 | } 395 | 396 | // Check if files are in disallowed folders (defined by the regex) and remove them. 397 | preg_match_all( $re, $file_path, $matches, PREG_SET_ORDER, 0 ); 398 | 399 | if ( empty( $matches ) ) { 400 | $files_to_sniff[ $file_name ] = $file_path; 401 | } 402 | } 403 | 404 | // Safeguard, but don't seems to be working correctly. 405 | $ignored = '.*/node_modules/.*,.*/vendor/.*,.*/assets/build/.*,.*/build/.*,.*/bin/.*,.*/tests/.*,.*/test/.*'; 406 | 407 | $results_arguments = array( 408 | 'extensions' => 'php', 409 | 'show_warnings' => $show_warnings, 410 | 'minimum_php_version' => $minimum_php_version, 411 | 'args' => $args, 412 | 'theme_prefixes' => $theme_prefixes, 413 | 'all_files' => $files_to_sniff, 414 | 'standards_array' => $standards_array, 415 | 'ignore_annotations' => $ignore_annotations, 416 | 'ignored' => $ignored, 417 | 'raw_output' => $raw_output, 418 | ); 419 | 420 | $sniff_results = $this->get_sniff_results( $results_arguments ); 421 | 422 | if ( $raw_output ) { 423 | $results_raw = array( 424 | self::SUCCESS => true, 425 | self::DATA => $sniff_results, 426 | ); 427 | 428 | \wp_send_json( $results_raw, 200 ); 429 | } 430 | 431 | $sniffer_results = json_decode( $sniff_results, true ); 432 | 433 | $total_errors = $sniffer_results[ self::TOTALS ][ self::ERRORS ]; 434 | $total_warning = $sniffer_results[ self::TOTALS ][ self::WARNINGS ]; 435 | $total_fixable = $sniffer_results[ self::TOTALS ][ self::FIXABLE ]; 436 | $total_files = $sniffer_results[ self::FILES ]; 437 | 438 | // Check theme headers. 439 | $theme_header_checks = $this->style_headers_check( self::$theme_slug, $theme, $show_warnings ); 440 | $screenshot_checks = $this->screenshot_check(); 441 | $readme_checks = $this->readme_check(); 442 | 443 | foreach ( $screenshot_checks as $file ) { 444 | $total_errors += $file[ self::ERRORS ]; 445 | $total_warning += $file[ self::WARNINGS ]; 446 | } 447 | 448 | $total_files += $screenshot_checks; 449 | 450 | foreach ( $readme_checks as $file ) { 451 | $total_errors += $file[ self::ERRORS ]; 452 | $total_warning += $file[ self::WARNINGS ]; 453 | } 454 | 455 | $total_files += $readme_checks; 456 | 457 | $total_errors += $theme_header_checks[ self::TOTALS ][ self::ERRORS ]; 458 | $total_warning += $theme_header_checks[ self::TOTALS ][ self::WARNINGS ]; 459 | $total_fixable += $theme_header_checks[ self::TOTALS ][ self::FIXABLE ]; 460 | $total_files += $theme_header_checks[ self::FILES ]; 461 | 462 | // Filtering the files for easier JS handling. 463 | $file_i = 0; 464 | $files = array(); 465 | 466 | foreach ( $total_files as $file_path => $file_sniff_results ) { 467 | 468 | // Allow the file list to pass any .js through for further handling, and remove all others with no errors or warnings. 469 | if ( substr( $file_path, -3 ) !== '.js' && ( $file_sniff_results[ self::ERRORS ] === 0 && $file_sniff_results[ self::WARNINGS ] === 0 ) ) { 470 | continue; 471 | } 472 | 473 | $files[ $file_i ][ self::FILE_PATH ] = $file_path; 474 | $files[ $file_i ][ self::ERRORS ] = $file_sniff_results[ self::ERRORS ]; 475 | $files[ $file_i ][ self::WARNINGS ] = $file_sniff_results[ self::WARNINGS ]; 476 | $files[ $file_i ][ self::MESSAGES ] = $file_sniff_results[ self::MESSAGES ]; 477 | $file_i++; 478 | } 479 | 480 | $results = array( 481 | self::SUCCESS => true, 482 | self::TOTALS => array( 483 | self::ERRORS => $total_errors, 484 | self::WARNINGS => $total_warning, 485 | self::FIXABLE => $total_fixable, 486 | ), 487 | self::FILES => $files, 488 | ); 489 | 490 | \wp_send_json( $results, 200 ); 491 | } 492 | 493 | /** 494 | * Method that returns the results based on a custom PHPCS Runner 495 | * 496 | * @param array ...$arguments Array of passed arguments. 497 | * @return string Sniff results string. 498 | * 499 | * @throws \PHP_CodeSniffer\Exceptions\DeepExitException Sniffer exception. 500 | */ 501 | protected function get_sniff_results( ...$arguments ) { 502 | // Unpack the arguments. 503 | $show_warnings = $arguments[0]['show_warnings']; 504 | $minimum_php_version = $arguments[0]['minimum_php_version']; 505 | $args = $arguments[0]['args']; 506 | $theme_prefixes = $arguments[0]['theme_prefixes']; 507 | $extensions = $arguments[0]['extensions']; 508 | $all_files = $arguments[0]['all_files']; 509 | $standards_array = $arguments[0]['standards_array']; 510 | $ignore_annotations = $arguments[0]['ignore_annotations']; 511 | $ignored = $arguments[0]['ignored']; 512 | $raw_output = $arguments[0]['raw_output']; 513 | 514 | // Create a custom runner. 515 | $runner = new Runner(); 516 | 517 | $config_args = array( '-s', '-p' ); 518 | 519 | if ( $show_warnings === '0' ) { 520 | $config_args[] = '-n'; 521 | } 522 | 523 | $runner->config = new Config( $config_args ); 524 | 525 | $all_files = array_values( $all_files ); 526 | 527 | if ( $extensions ) { 528 | $runner->config->extensions = array( 529 | 'php' => 'PHP', 530 | 'inc' => 'PHP', 531 | ); 532 | } 533 | 534 | $runner->config->standards = $standards_array; 535 | $runner->config->files = $all_files; 536 | $runner->config->annotations = $ignore_annotations; 537 | $runner->config->parallel = 8; 538 | $runner->config->colors = false; 539 | $runner->config->tabWidth = 0; 540 | $runner->config->reportWidth = 110; 541 | $runner->config->interactive = false; 542 | $runner->config->cache = false; 543 | $runner->config->ignored = $ignored; 544 | 545 | if ( ! $raw_output ) { 546 | $runner->config->reports = array( 'json' => null ); 547 | } 548 | 549 | $runner->init(); 550 | 551 | // Set default standard. 552 | PHPCSHelper::set_config_data( self::DEFAULT_STANDARD, $this->get_default_standard(), true ); 553 | 554 | // Ignoring warnings when generating the exit code. 555 | PHPCSHelper::set_config_data( self::IGNORE_WARNINGS_ON_EXIT, true, true ); 556 | 557 | // Set minimum supported PHP version. 558 | PHPCSHelper::set_config_data( self::TEST_VERSION, $minimum_php_version . '-', true ); 559 | 560 | // Set text domains. 561 | PHPCSHelper::set_config_data( self::TEXT_DOMAIN, implode( ',', $args[ self::TEXT_DOMAINS ] ), true ); 562 | 563 | if ( $theme_prefixes !== '' ) { 564 | // Set prefix. 565 | PHPCSHelper::set_config_data( self::PREFIXES, $theme_prefixes, true ); 566 | } 567 | 568 | $runner->reporter = new Reporter( $runner->config ); 569 | 570 | foreach ( $all_files as $file_path ) { 571 | $file = new DummyFile( file_get_contents( $file_path ), $runner->ruleset, $runner->config ); 572 | $file->path = $file_path; 573 | 574 | $runner->processFile( $file ); 575 | } 576 | 577 | ob_start(); 578 | $runner->reporter->printReports(); 579 | $report = ob_get_clean(); 580 | 581 | return $report; 582 | } 583 | 584 | /** 585 | * Perform style.css header check. 586 | * 587 | * @since 0.3.0 588 | * 589 | * @param string $theme_slug Theme slug. 590 | * @param \WP_Theme $theme WP_Theme Theme object. 591 | * @param bool $show_warnings Show warnings. 592 | * 593 | * @return bool 594 | */ 595 | protected function style_headers_check( $theme_slug, \WP_Theme $theme, $show_warnings ) { 596 | $required_headers = $this->get_required_headers(); 597 | 598 | $notices = array(); 599 | 600 | foreach ( $required_headers as $header ) { 601 | if ( $theme->get( $header ) ) { 602 | continue; 603 | } 604 | 605 | $notices[] = array( 606 | self::MESSAGE => sprintf( 607 | /* translators: 1: comment header line */ 608 | esc_html__( 'The %1$s is not defined in the style.css header.', 'theme-sniffer' ), 609 | $header 610 | ), 611 | self::SEVERITY => self::ERROR, 612 | ); 613 | } 614 | 615 | if ( strpos( $theme_slug, 'wordpress' ) || strpos( $theme_slug, 'theme' ) ) { // phpcs:ignore 616 | $notices[] = array( 617 | self::MESSAGE => esc_html__( 'The theme name cannot contain WordPress or Theme as a part of its name.', 'theme-sniffer' ), 618 | self::SEVERITY => self::ERROR, 619 | ); 620 | } 621 | 622 | if ( preg_match( '|[^\d\.]|', $theme->get( 'Version' ) ) ) { 623 | $notices[] = array( 624 | self::MESSAGE => esc_html__( 'Version strings can only contain numeric and period characters (e.g. 1.2).', 'theme-sniffer' ), 625 | self::SEVERITY => self::ERROR, 626 | ); 627 | } 628 | 629 | // Prevent duplicate URLs. 630 | $themeuri = trim( $theme->get( 'ThemeURI' ), '/\\' ); 631 | $authoruri = trim( $theme->get( 'AuthorURI' ), '/\\' ); 632 | 633 | if ( ( $themeuri === $authoruri ) && ( ! empty( $themeuri ) || ! empty( $authoruri ) ) ) { 634 | $notices[] = array( 635 | self::MESSAGE => esc_html__( 'Duplicate theme and author URLs. A theme URL is a page/site that provides details about this specific theme. An author URL is a page/site that provides information about the author of the theme. The theme and author URL are optional.', 'theme-sniffer' ), 636 | self::SEVERITY => self::ERROR, 637 | ); 638 | } 639 | 640 | if ( $theme_slug === $theme->get( 'Text Domain' ) ) { 641 | $notices[] = array( 642 | self::MESSAGE => sprintf( 643 | /* translators: %1$s: Text Domain, %2$s: Theme Slug */ 644 | esc_html__( 'The text domain "%1$s" must match the theme slug "%2$s".', 'theme-sniffer' ), 645 | $theme->get( 'TextDomain' ), 646 | $theme_slug 647 | ), 648 | self::SEVERITY => self::ERROR, 649 | ); 650 | } 651 | 652 | $registered_tags = $this->get_theme_tags(); 653 | $tags = array_map( 'strtolower', $theme->get( 'Tags' ) ); 654 | $tags_count = array_count_values( $tags ); 655 | $subject_tags_names = array(); 656 | 657 | $subject_tags = array_flip( $registered_tags['subject_tags'] ); 658 | $allowed_tags = array_flip( $registered_tags['allowed_tags'] ); 659 | 660 | foreach ( $tags as $tag ) { 661 | if ( $tags_count[ $tag ] > 1 ) { 662 | $notices[] = array( 663 | self::MESSAGE => sprintf( 664 | /* translators: %s: Theme tag */ 665 | esc_html__( 'The tag "%s" is being used more than once, please remove the duplicate.', 'theme-sniffer' ), 666 | $tag 667 | ), 668 | self::SEVERITY => self::ERROR, 669 | ); 670 | } 671 | 672 | if ( isset( $subject_tags[ $tag ] ) ) { 673 | $subject_tags_names[] = $tag; 674 | continue; 675 | } 676 | 677 | if ( ! isset( $allowed_tags[ $tag ] ) ) { 678 | $notices[] = array( 679 | self::MESSAGE => sprintf( 680 | /* translators: %s: Theme tag */ 681 | wp_kses_post( __( 'Please remove "%s" as it is not a standard tag.', 'theme-sniffer' ) ), 682 | $tag 683 | ), 684 | self::SEVERITY => self::ERROR, 685 | ); 686 | continue; 687 | } 688 | 689 | if ( 'accessibility-ready' === $tag && $show_warnings !== '0' ) { 690 | $notices[] = array( 691 | self::MESSAGE => wp_kses_post( __( 'Themes that use the "accessibility-ready" tag will need to undergo an accessibility review.', 'theme-sniffer' ) ), 692 | self::SEVERITY => self::WARNING, 693 | ); 694 | } 695 | } 696 | 697 | $subject_tags_count = count( $subject_tags_names ); 698 | 699 | if ( $subject_tags_count > 3 ) { 700 | $notices[] = array( 701 | self::MESSAGE => sprintf( 702 | /* translators: 1: Subject theme tag, 2: Tags list */ 703 | esc_html__( 'A maximum of 3 subject tags are allowed. The theme has %1$d subjects tags [%2$s]. Please remove the subject tags, which do not directly apply to the theme.', 'theme-sniffer' ), 704 | $subject_tags_count, 705 | implode( ',', $subject_tags_names ) 706 | ), 707 | self::SEVERITY => self::ERROR, 708 | ); 709 | } 710 | 711 | $error_count = 0; 712 | $warning_count = 0; 713 | $messages = array(); 714 | 715 | foreach ( $notices as $notice ) { 716 | $severity = $notice[ self::SEVERITY ]; 717 | 718 | if ( $severity === self::ERROR ) { 719 | $error_count++; 720 | } else { 721 | $warning_count++; 722 | } 723 | 724 | $messages[] = array( 725 | self::MESSAGE => $notice[ self::MESSAGE ], 726 | self::SEVERITY => $severity, 727 | self::FIXABLE => false, 728 | self::TYPE => strtoupper( $severity ), 729 | ); 730 | } 731 | 732 | $header_results = array( 733 | self::TOTALS => array( 734 | self::ERRORS => $error_count, 735 | self::WARNINGS => $warning_count, 736 | self::FIXABLE => $error_count + $warning_count, 737 | ), 738 | self::FILES => array( 739 | self::$theme_root . "/{$theme_slug}/style.css" => array( 740 | self::ERRORS => $error_count, 741 | self::WARNINGS => $warning_count, 742 | self::MESSAGES => $messages, 743 | ), 744 | ), 745 | ); 746 | 747 | return $header_results; 748 | } 749 | 750 | /** 751 | * Performs readme.txt sniffs. 752 | * 753 | * @since 1.1.0 754 | * 755 | * @return array $check Sniffer file report. 756 | */ 757 | protected function readme_check() { 758 | $validator = new Readme( self::$theme_slug ); 759 | return $validator->get_results(); 760 | } 761 | 762 | /** 763 | * Perform screenshot sniffs. 764 | * 765 | * @since 1.0.0 766 | */ 767 | protected function screenshot_check() { 768 | $validator = new Screenshot( self::$theme_slug ); 769 | return $validator->get_results(); 770 | } 771 | 772 | /** 773 | * Returns true if the callback should be public 774 | * 775 | * @return boolean true if callback is public. 776 | */ 777 | protected function is_public() : bool { 778 | return self::CB_PUBLIC; 779 | } 780 | 781 | /** 782 | * Get name of the callback action 783 | * 784 | * @return string Name of the callback action. 785 | */ 786 | protected function get_action_name() : string { 787 | return self::CALLBACK_ACTION; 788 | } 789 | } 790 | -------------------------------------------------------------------------------- /src/callback/invokable-interface.php: -------------------------------------------------------------------------------- 1 | get_prepared_service_array( $services ); 38 | $container = $this->get_di_container( $di_services ); 39 | 40 | return array_map( 41 | static function( $class ) use ( $container ) { 42 | return $container->get( $class ); 43 | }, 44 | array_keys( $di_services ) 45 | ); 46 | } 47 | 48 | /** 49 | * Return a DI container 50 | * 51 | * Build and return a DI container. 52 | * Wire all the dependencies automatically, based on the provided array of 53 | * class => dependencies from the get_di_services(). 54 | * 55 | * @param array $services Array of service. 56 | * 57 | * @return Container 58 | * 59 | * @throws \Exception Throws exception if container cannot be created. 60 | * @since 1.2.0 61 | */ 62 | private function get_di_container( array $services ) { 63 | $builder = new ContainerBuilder(); 64 | 65 | $builder->enableCompilation( __DIR__ ); 66 | 67 | $definitions = array(); 68 | 69 | foreach ( $services as $service_name => $service_dependencies ) { 70 | $definitions[ $service_name ] = \DI\create()->constructor( ...$this->get_di_dependencies( $service_dependencies ) ); 71 | } 72 | 73 | return $builder->addDefinitions( $definitions )->build(); 74 | } 75 | 76 | /** 77 | * Get dependencies from PHP-DI 78 | * 79 | * Return prepared Dependency Injection objects. 80 | * If you pass a class use PHP-DI to prepare if not just output it. 81 | * 82 | * @since 1.2.0 83 | * 84 | * @param array $dependencies Array of classes/parameters to inject in constructor. 85 | * 86 | * @return array 87 | */ 88 | private function get_di_dependencies( array $dependencies ) : array { 89 | return array_map( 90 | static function( $dependency ) { 91 | if ( class_exists( $dependency ) ) { 92 | return \DI\get( $dependency ); 93 | } 94 | return $dependency; 95 | }, 96 | $dependencies 97 | ); 98 | } 99 | 100 | /** 101 | * Prepare services array 102 | * 103 | * Takes an argument of services, which is a multidimensional array, 104 | * that has a class name for a key, and a list of dependencies as a value, or no value at all. 105 | * It then loops though this array, and if the dependencies are an array it will just add this to 106 | * the value of the $prepared_services array, and the key will be the class name. 107 | * In case that there is no dependency. 108 | * 109 | * @since 1.2.0 110 | * 111 | * @param array $services A list of classes with optional dependencies. 112 | * 113 | * @return array 114 | */ 115 | private function get_prepared_service_array( array $services ) : array { 116 | $prepared_services = array(); 117 | 118 | foreach ( $services as $class => $dependencies ) { 119 | if ( ! is_array( $dependencies ) ) { 120 | $prepared_services[ $dependencies ] = array(); 121 | } else { 122 | $prepared_services[ $class ] = $dependencies; 123 | } 124 | } 125 | 126 | return $prepared_services; 127 | } 128 | } 129 | -------------------------------------------------------------------------------- /src/class-plugin-factory.php: -------------------------------------------------------------------------------- 1 | register_services(); 60 | 61 | // Activate that which can be activated. 62 | foreach ( $this->services as $service ) { 63 | if ( $service instanceof Has_Activation ) { 64 | $service->activate(); 65 | } 66 | } 67 | 68 | \flush_rewrite_rules(); 69 | } 70 | 71 | /** 72 | * Deactivate the plugin. 73 | */ 74 | public function deactivate() { 75 | $this->register_services(); 76 | 77 | // Deactivate that which can be deactivated. 78 | foreach ( $this->services as $service ) { 79 | if ( $service instanceof Has_Deactivation ) { 80 | $service->deactivate(); 81 | } 82 | } 83 | 84 | \flush_rewrite_rules(); 85 | } 86 | 87 | /** 88 | * Register the plugin with the WordPress system. 89 | * 90 | * @throws Exception\Invalid_Service If a service is not valid. 91 | */ 92 | public function register() { 93 | $this->register_assets_manifest_data(); 94 | 95 | add_action( 'plugins_loaded', array( $this, 'register_services' ) ); 96 | add_action( 'plugin_action_links_' . PLUGIN_BASENAME, array( $this, 'plugin_settings_link' ) ); 97 | add_filter( 'extra_theme_headers', array( $this, 'add_headers' ) ); 98 | } 99 | 100 | /** 101 | * Register bundled asset manifest 102 | * 103 | * @throws Exception\Missing_Manifest Throws error if manifest is missing. 104 | * @return void 105 | */ 106 | public function register_assets_manifest_data() { 107 | 108 | $response = file_get_contents( 109 | rtrim( plugin_dir_path( __DIR__ ), '/' ) . '/assets/build/manifest.json' 110 | ); 111 | 112 | if ( ! $response ) { 113 | $error_message = esc_html__( 'manifest.json is missing. Bundle the plugin before using it.', 'developer-portal' ); 114 | throw Exception\Missing_Manifest::message( $error_message ); 115 | } 116 | 117 | define( 'ASSETS_MANIFEST', (string) $response ); 118 | } 119 | 120 | /** 121 | * Register the individual services of this plugin. 122 | * 123 | * @throws Exception\Invalid_Service If a service is not valid. 124 | */ 125 | public function register_services() { 126 | // Bail early so we don't instantiate services twice. 127 | if ( ! empty( $this->services ) ) { 128 | return; 129 | } 130 | 131 | $container = new Di_Container(); 132 | 133 | $this->services = $container->get_di_services( $this->get_service_classes() ); 134 | 135 | array_walk( 136 | $this->services, 137 | static function( $class ) { 138 | if ( ! $class instanceof Registerable ) { 139 | return; 140 | } 141 | 142 | $class->register(); 143 | } 144 | ); 145 | } 146 | 147 | /** 148 | * Add go to theme check page link on plugin page. 149 | * 150 | * @since 1.0.0 Moved to main plugin class file. 151 | * @since 0.1.3 152 | * 153 | * @param array $links Array of plugin action links. 154 | * @return array Modified array of plugin action links. 155 | */ 156 | public function plugin_settings_link( array $links ) : array { 157 | $settings_page_link = '' . esc_attr__( 'Theme Sniffer Page', 'theme-sniffer' ) . ''; 158 | array_unshift( $links, $settings_page_link ); 159 | 160 | return $links; 161 | } 162 | 163 | /** 164 | * Allow fetching custom headers. 165 | * 166 | * @since 0.1.3 167 | * 168 | * @param array $extra_headers List of extra headers. 169 | * 170 | * @return array List of extra headers. 171 | */ 172 | public static function add_headers( array $extra_headers ) : array { 173 | $extra_headers[] = 'License'; 174 | $extra_headers[] = 'License URI'; 175 | $extra_headers[] = 'Template Version'; 176 | 177 | return $extra_headers; 178 | } 179 | 180 | /** 181 | * Get the list of services to register. 182 | * 183 | * @return array
` tags which we don't want either: $text = preg_replace( "/(? ])\n/", ' ', $text );.
523 | $text = trim( $text );
524 |
525 | return $text;
526 | }
527 |
528 | /**
529 | * Sanitize text.
530 | *
531 | * @access protected
532 | *
533 | * @param string $text Text to sanitize.
534 | *
535 | * @return string $text Cleaned text.
536 | */
537 | protected function sanitize_text( $text ) {
538 | // not fancy.
539 | $text = wp_strip_all_tags( $text );
540 | $text = esc_html( $text );
541 | $text = trim( $text );
542 |
543 | return $text;
544 | }
545 |
546 | /**
547 | * Sanitize the provided stable tag to something we expect.
548 | *
549 | * @param string $stable_tag the raw Stable Tag line from the readme.
550 | *
551 | * @return string $stable_tag The sanitized stable tag.
552 | */
553 | protected function sanitize_stable_tag( $stable_tag ) {
554 | $stable_tag = trim( $stable_tag );
555 | $stable_tag = trim( $stable_tag, '"\'' );
556 | $stable_tag = preg_replace( '!^/?tags/!i', '', $stable_tag ); // Matches for: "tags/1.2.3".
557 | $stable_tag = preg_replace( '![^a-z0-9_.-]!i', '', $stable_tag );
558 |
559 | // If the stable_tag begins with a ., we treat it as 0.blah.
560 | if ( '.' === substr( $stable_tag, 0, 1 ) ) {
561 | $stable_tag = "0{$stable_tag}";
562 | }
563 |
564 | return $stable_tag;
565 | }
566 |
567 | /**
568 | * Sanitizes the Requires PHP header to ensure that it's a valid version header.
569 | *
570 | * @param string $version The version number passed in the header.
571 | *
572 | * @return string $version The sanitized version number.
573 | */
574 | protected function sanitize_requires_php( $version ) {
575 | $version = trim( $version );
576 |
577 | // x.y or x.y.z version number.
578 | if ( $version && ! preg_match( '!^\d+(\.\d+){1,2}$!', $version ) ) {
579 | $this->warnings['requires_php_header_ignored'] = true;
580 |
581 | // Ignore the readme value.
582 | $version = '';
583 | }
584 |
585 | return $version;
586 | }
587 |
588 | /**
589 | * Sanitizes the Tested header to ensure that it's a valid version header.
590 | *
591 | * @param string $version The version number from header.
592 | *
593 | * @return string $version The sanitized version number.
594 | */
595 | protected function sanitize_tested_version( $version ) {
596 | $version = trim( $version );
597 |
598 | if ( $version ) {
599 |
600 | // Handle the edge-case of 'WordPress 5.0' and 'WP 5.0' for historical purposes.
601 | $strip_phrases = [
602 | 'WordPress',
603 | 'WP',
604 | ];
605 |
606 | $version = trim( str_ireplace( $strip_phrases, '', $version ) );
607 |
608 | // Strip off any -alpha, -RC, -beta suffixes, as these complicate comparisons and are rarely used.
609 | list( $version, ) = explode( '-', $version );
610 |
611 | if (
612 |
613 | // x.y or x.y.z version number.
614 | ! preg_match( '!^\d+\.\d(\.\d+)?$!', $version ) ||
615 |
616 | // Allow plugins to mark themselves as compatible with Stable+0.1 (trunk/master) but not higher.
617 | defined( 'WP_CORE_STABLE_BRANCH' ) && ( (float) $version > (float) WP_CORE_STABLE_BRANCH + 0.1 )
618 | ) {
619 | $this->warnings['tested_header_ignored'] = true;
620 |
621 | // Ignore the readme value.
622 | $version = '';
623 | }
624 | }
625 |
626 | return $version;
627 | }
628 |
629 | /**
630 | * Sanitizes the Requires at least header to ensure that it's a valid version header.
631 | *
632 | * @param string $version The version number from header.
633 | *
634 | * @return string $version The sanitized version number.
635 | */
636 | protected function sanitize_requires_version( $version ) {
637 | $version = trim( $version );
638 |
639 | if ( $version ) {
640 |
641 | // Handle the edge-case of 'WordPress 5.0' and 'WP 5.0' for historical purposes.
642 | $strip_phrases = [
643 | 'WordPress',
644 | 'WP',
645 | 'or higher',
646 | 'and above',
647 | '+',
648 | ];
649 |
650 | $version = trim( str_ireplace( $strip_phrases, '', $version ) );
651 |
652 | // Strip off any -alpha, -RC, -beta suffixes, as these complicate comparisons and are rarely used.
653 | list( $version, ) = explode( '-', $version );
654 |
655 | if (
656 |
657 | // x.y or x.y.z version number.
658 | ! preg_match( '!^\d+\.\d(\.\d+)?$!', $version ) ||
659 |
660 | // Allow plugins to mark themselves as requiring Stable+0.1 (trunk/master) but not higher.
661 | defined( 'WP_CORE_STABLE_BRANCH' ) && ( (float) $version > (float) WP_CORE_STABLE_BRANCH + 0.1 )
662 | ) {
663 | $this->warnings['requires_header_ignored'] = true;
664 |
665 | // Ignore the readme value.
666 | $version = '';
667 | }
668 | }
669 |
670 | return $version;
671 | }
672 |
673 | /**
674 | * Parses a slice of lines from the file into an array of Heading => Content.
675 | *
676 | * We assume that every heading encountered is a new item, and not a sub heading.
677 | * We support headings which are either `= Heading`, `# Heading` or `** Heading`.
678 | *
679 | * @param string|array $lines The lines of the section to parse.
680 | *
681 | * @return array
682 | */
683 | protected function parse_section( $lines ) {
684 | $return = [];
685 | $key = $value = '';
686 |
687 | if ( ! is_array( $lines ) ) {
688 | $lines = explode( "\n", $lines );
689 | }
690 |
691 | $trimmed_lines = array_map( 'trim', $lines );
692 |
693 | /*
694 | * The heading style being matched in the block. Can be 'heading' or 'bold'.
695 | * Standard Markdown headings (## .. and == ... ==) are used, but if none are present.
696 | * full line bolding will be used as a heading style.
697 | */
698 | $heading_style = 'bold';
699 | foreach ( $trimmed_lines as $trimmed ) {
700 | if ( $trimmed && ( $trimmed[0] === '#' || $trimmed[0] === '=' ) ) {
701 | $heading_style = 'heading';
702 | break;
703 | }
704 | }
705 |
706 | $line_count = count( $lines );
707 | for ( $i = 0; $i < $line_count; $i++ ) {
708 | $line = &$lines[ $i ];
709 | $trimmed = &$trimmed_lines[ $i ];
710 | if ( ! $trimmed ) {
711 | $value .= "\n";
712 | continue;
713 | }
714 |
715 | $is_heading = false;
716 | if ( 'heading' === $heading_style && ( $trimmed[0] === '#' || $trimmed[0] === '=' ) ) {
717 | $is_heading = true;
718 | } elseif ( 'bold' === $heading_style && ( substr( $trimmed, 0, 2 ) === '**' && substr( $trimmed, -2 ) === '**' ) ) {
719 | $is_heading = true;
720 | }
721 |
722 | if ( $is_heading ) {
723 | if ( $value ) {
724 | $return[ $key ] = trim( $value );
725 | }
726 |
727 | $value = '';
728 |
729 | // Trim off the first character of the line, as we know that's the heading style we're expecting to remove.
730 | $key = trim( $line, $trimmed[0] . " \t" );
731 | continue;
732 | }
733 |
734 | $value .= $line . "\n";
735 | }
736 |
737 | if ( $key || $value ) {
738 | $return[ $key ] = trim( $value );
739 | }
740 |
741 | return $return;
742 | }
743 |
744 | /**
745 | * Parse markdown from sections.
746 | *
747 | * This isn't required as we are just wanting data, so eventually
748 | * can be removed along with Markdown dep.
749 | *
750 | * @param string $text Text to apply transformation to.
751 | *
752 | * @return string Transformed text to HTML.
753 | */
754 | protected function parse_markdown( $text ) {
755 | static $markdown = null;
756 |
757 | if ( is_null( $markdown ) ) {
758 | $markdown = new MarkdownExtra();
759 | }
760 |
761 | return $markdown->transform( $text );
762 | }
763 |
764 | /**
765 | * Determine if the readme contains unique installation instructions.
766 | *
767 | * When phrases are added here, the affected plugins will need to be reparsed to pick it up.
768 | *
769 | * @return bool Whether the instructions differ from default instructions.
770 | */
771 | protected function has_unique_installation_instructions() {
772 | if ( ! isset( $this->sections['installation'] ) ) {
773 | return false;
774 | }
775 |
776 | // If the plugin installation section contains any of these phrases, skip it as it's not useful.
777 | $common_phrases = array(
778 | 'This section describes how to install the plugin and get it working.', // Default readme.txt content.
779 | );
780 |
781 | foreach ( $common_phrases as $phrase ) {
782 | if ( false !== stripos( $this->sections['installation'], $phrase ) ) {
783 | return false;
784 | }
785 | }
786 |
787 | return true;
788 | }
789 | }
790 |
--------------------------------------------------------------------------------
/src/sniffs/readme/class-validator.php:
--------------------------------------------------------------------------------
1 | license ) && ! empty( $parser->license_uri ) ) {
61 | $parser->license_uri = (object) array(
62 | 'primary' => $parser->license,
63 | 'uri' => $parser->license_uri,
64 | );
65 | }
66 |
67 | return $parser;
68 | }
69 |
70 | /**
71 | * Runs any existing validators set on parser.
72 | *
73 | * @since 1.1.0
74 | *
75 | * @param string $file file to validate.
76 | */
77 | public function validate( $file ) {
78 |
79 | // Validate file.
80 | parent::validate( $file );
81 |
82 | // No need to continue if file validation contains error for file not existing.
83 | if ( ! empty( $this->results ) && in_array( 'error', array_column( $this->results, 'severity' ), true ) ) {
84 | return;
85 | }
86 |
87 | $parser = new Parser( $this->file );
88 | $this->parser = $this->set_defaults( $parser );
89 |
90 | foreach ( $this->parser as $name => $args ) {
91 | $class = __NAMESPACE__ . '\\' . ucwords( $name, '_' );
92 |
93 | if ( class_exists( $class ) ) {
94 | $validator = new $class( $args );
95 | $results = $validator->get_results();
96 |
97 | if ( is_array( $results ) ) {
98 | $this->results = array_merge( $this->results, $results );
99 | }
100 | }
101 | }
102 | }
103 | }
104 |
--------------------------------------------------------------------------------
/src/sniffs/screenshot/class-validator.php:
--------------------------------------------------------------------------------
1 | results ) && in_array( 'error', array_column( $this->results, 'severity' ), true ) ) {
58 | return;
59 | }
60 |
61 | // Image mime.
62 | $mime_type = wp_get_image_mime( $file );
63 |
64 | // Missing mime type.
65 | if ( ! $mime_type ) {
66 | $this->results[] = array(
67 | 'severity' => 'error',
68 | 'message' => sprintf(
69 | esc_html__( 'Screenshot mime type could not be determined, screenshots must have a mime type of "img/png" or "img/jpg".', 'theme-sniffer' ),
70 | $mime_type
71 | ),
72 | );
73 |
74 | return;
75 | }
76 |
77 | // Valid mime type returned, but not a png.
78 | if ( $mime_type !== 'image/png' ) {
79 | $this->results[] = array(
80 | 'severity' => 'warning',
81 | 'message' => sprintf(
82 | /* translators: 1: screenshot mime type found */
83 | esc_html__( 'Screenshot has mime type of "%1$s", but a mimetype of "img/png" is recommended.', 'theme-sniffer' ),
84 | $mime_type
85 | ),
86 | );
87 |
88 | return;
89 | }
90 |
91 | // Screenshot validated at this point, so check dimensions - no need for fileinfo.
92 | // props @Otto42(WP.org, GitHub) for aspect ratio logic from Theme Check: https://github.com/WordPress/theme-check/blob/master/checks/screenshot.php.
93 | list( $width, $height ) = getimagesize( $file );
94 |
95 | // Screenshot too big.
96 | if ( $width > 1200 || $height > 900 ) {
97 | $this->results[] = array(
98 | 'severity' => 'error',
99 | 'message' => sprintf(
100 | /* translators: 1: screenshot width 2: screenshot height */
101 | esc_html__( 'The size of your screenshot should not exceed 1200x900, but screenshot.png is currently %1$dx%2$d.', 'theme-sniffer' ),
102 | $width,
103 | $height
104 | ),
105 | );
106 |
107 | return;
108 | }
109 |
110 | // Aspect Ratio.
111 | if ( $height / $width !== 0.75 ) {
112 | $this->results[] = array(
113 | 'severity' => 'error',
114 | 'message' => esc_html__( 'Screenshot aspect ratio must be 4:3!', 'theme-sniffer' ),
115 | );
116 |
117 | return;
118 | }
119 |
120 | // Recommended size.
121 | if ( $width !== 1200 || $height !== 900 ) {
122 | $this->results[] = array(
123 | 'severity' => 'warning',
124 | 'message' => esc_html__( 'Screenshot size of 1200x900 is recommended to account for HiDPI displays.', 'theme-sniffer' ),
125 | );
126 |
127 | return;
128 | }
129 | }
130 | }
131 |
--------------------------------------------------------------------------------
/src/sniffs/validatable-interface.php:
--------------------------------------------------------------------------------
1 | uri = $this->validate( $uri );
57 | }
58 |
59 | /**
60 | * Render a given URI.
61 | *
62 | * @param array $context Context in which to render.
63 | *
64 | * @return string Rendered HTML.
65 | * @throws Failed_To_Load_View If the View URI could not be loaded.
66 | */
67 | public function render( array $context = array() ) : string {
68 | $context = array_filter( $context );
69 |
70 | // Add context to the current instance to make it available within the rendered view.
71 | foreach ( $context as $key => $value ) {
72 | $this->$key = $value;
73 | }
74 |
75 | // Add entire context as array to the current instance to pass onto partial views.
76 | $this->internal_context = $context;
77 |
78 | // Save current buffering level so we can backtrack in case of an error.
79 | // This is needed because the view itself might also add an unknown.
80 | // number of output buffering levels.
81 | $buffer_level = ob_get_level();
82 | ob_start();
83 |
84 | try {
85 | include $this->uri;
86 | } catch ( \Exception $exception ) {
87 | // Remove whatever levels were added up until now.
88 | while ( ob_get_level() > $buffer_level ) {
89 | ob_end_clean();
90 | }
91 | throw Failed_To_Load_View::view_exception(
92 | $this->uri,
93 | $exception
94 | );
95 | }
96 |
97 | return ob_get_clean();
98 | }
99 |
100 | /**
101 | * Render a partial view.
102 | *
103 | * This can be used from within a currently rendered view, to include
104 | * nested partials.
105 | *
106 | * The passed-in context is optional, and will fall back to the parent's
107 | * context if omitted.
108 | *
109 | * @param string $uri URI of the partial to render.
110 | * @param array|null $context Context in which to render the partial.
111 | *
112 | * @return string Rendered HTML.
113 | * @throws Invalid_URI If the provided URI was not valid.
114 | * @throws Failed_To_Load_View If the view could not be loaded.
115 | */
116 | public function render_partial( $uri, array $context = null ) : string {
117 | $view = new static( $uri );
118 |
119 | return $view->render( $context ? $context : $this->internal_context );
120 | }
121 |
122 | /**
123 | * Validate an URI.
124 | *
125 | * @param string $uri URI to validate.
126 | *
127 | * @return string Validated URI.
128 | * @throws Invalid_URI If an invalid URI was passed into the View.
129 | */
130 | protected function validate( $uri ) : string {
131 | $uri = $this->check_extension( $uri, static::VIEW_EXTENSION );
132 | $uri = trailingslashit( dirname( __DIR__, 2 ) ) . $uri;
133 |
134 | if ( ! is_readable( $uri ) ) {
135 | throw Invalid_URI::from_uri( $uri );
136 | }
137 |
138 | return $uri;
139 | }
140 |
141 | /**
142 | * Check that the URI has the correct extension.
143 | *
144 | * Optionally adds the extension if none was detected.
145 | *
146 | * @param string $uri URI to check the extension of.
147 | * @param string $extension Extension to use.
148 | *
149 | * @return string URI with correct extension.
150 | */
151 | protected function check_extension( $uri, $extension ) : string {
152 | $detected_extension = pathinfo( $uri, PATHINFO_EXTENSION );
153 |
154 | if ( $extension !== $detected_extension ) {
155 | $uri .= '.' . $extension;
156 | }
157 |
158 | return $uri;
159 | }
160 | }
161 |
--------------------------------------------------------------------------------
/src/view/class-escaped-view.php:
--------------------------------------------------------------------------------
1 | array(
29 | 'id' => true,
30 | 'class' => true,
31 | 'action' => true,
32 | 'method' => true,
33 | 'tabindex' => true,
34 | ),
35 | 'input' => array(
36 | 'id' => true,
37 | 'class' => true,
38 | 'type' => true,
39 | 'name' => true,
40 | 'value' => true,
41 | 'tabindex' => true,
42 | 'checked' => true,
43 | ),
44 | 'select' => array(
45 | 'id' => true,
46 | 'class' => true,
47 | 'type' => true,
48 | 'name' => true,
49 | 'value' => true,
50 | 'tabindex' => true,
51 | ),
52 | 'option' => array(
53 | 'id' => true,
54 | 'class' => true,
55 | 'type' => true,
56 | 'name' => true,
57 | 'value' => true,
58 | 'selected' => true,
59 | 'tabindex' => true,
60 | ),
61 | 'label' => array(
62 | 'for' => true,
63 | ),
64 | 'div' => array(
65 | 'class' => true,
66 | ),
67 | 'svg' => array(
68 | 'class' => true,
69 | 'style' => true,
70 | 'width' => true,
71 | 'height' => true,
72 | 'viewbox' => true,
73 | 'xmlns' => true,
74 | ),
75 | 'g' => array(
76 | 'fill' => true,
77 | 'fill-rule' => true,
78 | 'transform' => true,
79 | ),
80 | 'path' => array(
81 | 'd' => true,
82 | 'id' => true,
83 | 'fill' => true,
84 | 'style' => true,
85 | 'stroke' => true,
86 | 'stroke-width' => true,
87 | ),
88 | 'mask' => array(
89 | 'id' => true,
90 | 'fill' => true,
91 | ),
92 | 'rect' => array(
93 | 'transform' => true,
94 | 'fill' => true,
95 | 'width' => true,
96 | 'height' => true,
97 | 'rx' => true,
98 | 'ry' => true,
99 | 'x' => true,
100 | 'y' => true,
101 | ),
102 | 'xmlns' => array(
103 | 'xlink' => true,
104 | ),
105 | 'defs' => array(),
106 | );
107 |
108 | /**
109 | * View instance to decorate.
110 | *
111 | * @var View
112 | */
113 | private $view;
114 |
115 | /**
116 | * Tags that are allowed to pass through the escaping function.
117 | *
118 | * @var array
119 | */
120 | private $allowed_tags = array();
121 |
122 | /**
123 | * Instantiate a Escaped_View object.
124 | *
125 | * @param View $view View instance to decorate.
126 | * @param array|null $allowed_tags Optional. Array of allowed tags to let
127 | * through escaping functions. Set to sane
128 | * defaults if none provided.
129 | */
130 | public function __construct( View $view, $allowed_tags = null ) {
131 | $this->view = $view;
132 | $this->allowed_tags = null === $allowed_tags ?
133 | $this->prepare_allowed_tags( wp_kses_allowed_html( 'post' ) ) :
134 | $allowed_tags;
135 | }
136 |
137 | /**
138 | * Render a given URI.
139 | *
140 | * @param array $context Context in which to render.
141 | *
142 | * @return string Rendered HTML.
143 | * @throws Failed_To_Load_View If the View URI could not be loaded.
144 | */
145 | public function render( array $context = array() ) : string {
146 | return wp_kses( $this->view->render( $context ), $this->allowed_tags );
147 | }
148 |
149 | /**
150 | * Render a partial view.
151 | *
152 | * This can be used from within a currently rendered view, to include
153 | * nested partials.
154 | *
155 | * The passed-in context is optional, and will fall back to the parent's
156 | * context if omitted.
157 | *
158 | * @param string $uri URI of the partial to render.
159 | * @param array|null $context Context in which to render the partial.
160 | *
161 | * @return string Rendered HTML.
162 | * @throws Invalid_URI If the provided URI was not valid.
163 | * @throws Failed_To_Load_View If the view could not be loaded.
164 | */
165 | public function render_partial( $uri, array $context = null ) : string {
166 | return wp_kses(
167 | $this->view->render_partial( $uri, $context ),
168 | $this->allowed_tags
169 | );
170 | }
171 |
172 | /**
173 | * Prepare an array of allowed tags by adding form elements to the existing
174 | * array.
175 | *
176 | * This makes sure that the basic form elements always pass through the
177 | * escaping functions.
178 | *
179 | * @param array $allowed_tags Allowed tags as fetched from the WordPress
180 | * defaults.
181 | *
182 | * @return array Modified tags array.
183 | */
184 | private function prepare_allowed_tags( $allowed_tags ) : array {
185 | return array_replace_recursive( $allowed_tags, self::ALLOWED_TAGS );
186 | }
187 | }
188 |
--------------------------------------------------------------------------------
/src/view/class-post-escaped-view.php:
--------------------------------------------------------------------------------
1 | view = $view;
35 | }
36 | /**
37 | * Render a given URI.
38 | *
39 | * @param array $context Context in which to render.
40 | *
41 | * @return string Rendered HTML.
42 | * @throws Failed_To_Load_View If the View URI could not be loaded.
43 | */
44 | public function render( array $context = array() ) : string {
45 | return wp_kses_post( $this->view->render( $context ) );
46 | }
47 | /**
48 | * Render a partial view.
49 | *
50 | * This can be used from within a currently rendered view, to include
51 | * nested partials.
52 | *
53 | * The passed-in context is optional, and will fall back to the parent's
54 | * context if omitted.
55 | *
56 | * @param string $uri URI of the partial to render.
57 | * @param array|null $context Context in which to render the partial.
58 | *
59 | * @return string Rendered HTML.
60 | * @throws Invalid_URI If the provided URI was not valid.
61 | * @throws Failed_To_Load_View If the view could not be loaded.
62 | */
63 | public function render_partial( $uri, array $context = null ) : string {
64 | return wp_kses_post( $this->view->render_partial( $uri, $context ) );
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/src/view/class-templated-view.php:
--------------------------------------------------------------------------------
1 | check_extension( $uri, static::VIEW_EXTENSION );
33 |
34 | foreach ( $this->get_locations( $uri ) as $location ) {
35 | if ( is_readable( $location ) ) {
36 | return $location;
37 | }
38 | }
39 |
40 | if ( ! is_readable( $uri ) ) {
41 | throw Invalid_URI::from_uri( $uri );
42 | }
43 |
44 | return $uri;
45 | }
46 |
47 | /**
48 | * Get the possible locations for the view.
49 | *
50 | * @param string $uri URI of the view to get the locations for.
51 | *
52 | * @return array Array of possible locations.
53 | */
54 | protected function get_locations( $uri ) : array {
55 | return array(
56 | trailingslashit( \get_stylesheet_directory() ) . $uri,
57 | trailingslashit( \get_template_directory() ) . $uri,
58 | trailingslashit( dirname( __DIR__, 2 ) ) . $uri,
59 | );
60 | }
61 | }
62 |
--------------------------------------------------------------------------------
/src/view/class-view.php:
--------------------------------------------------------------------------------
1 | activate();
42 | }
43 | );
44 |
45 | /**
46 | * The code that runs during plugin deactivation.
47 | *
48 | * @since 1.0.0
49 | */
50 | register_deactivation_hook(
51 | __FILE__,
52 | function() {
53 | Plugin_Factory::create()->deactivate();
54 | }
55 | );
56 |
57 |
58 | Plugin_Factory::create()->register();
59 |
--------------------------------------------------------------------------------
/views/partials/report-notice.php:
--------------------------------------------------------------------------------
1 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
27 |
28 |
30 |
31 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
--------------------------------------------------------------------------------
/views/theme-sniffer-page.php:
--------------------------------------------------------------------------------
1 | error ) ) {
16 | ?>
17 |
18 | error ); ?>
19 |
20 | themes;
26 |
27 | if ( empty( $themes ) ) {
28 | return;
29 | }
30 |
31 | $standards = $this->standards;
32 | $php_versions = $this->php_versions;
33 | $nonce = $this->nonce_field;
34 | $current_theme = $this->current_theme;
35 |
36 | // Predefined values.
37 | $minimum_php_version = $this->minimum_php_version;
38 | $standard_status = $this->standard_status;
39 |
40 | // Defaults.
41 | $hide_warning = 0;
42 | $raw_output = 0;
43 | $ignore_annotations = 0;
44 | $check_php_only = 0;
45 | ?>
46 |
47 |
48 |
49 |
50 |
51 |
52 |
55 |
60 |
61 |
62 |
63 |
64 |
67 |
68 |
69 |
70 |
71 |
72 | $standard ) : ?>
73 |
77 |
78 |
79 |
93 |
94 | render_partial( 'views/partials/report-notice' ); // phpcs:ignore ?>
95 |
96 |
97 |
98 |
99 |
100 |
--------------------------------------------------------------------------------
/webpack.config.js:
--------------------------------------------------------------------------------
1 | const path = require( 'path' );
2 |
3 | const webpack = require( 'webpack' );
4 | const { CleanWebpackPlugin } = require( 'clean-webpack-plugin' );
5 | const MiniCssExtractPlugin = require( 'mini-css-extract-plugin' );
6 | const TerserPlugin = require( 'terser-webpack-plugin' );
7 | const ManifestPlugin = require( 'webpack-manifest-plugin' );
8 | const FileManagerPlugin = require( 'filemanager-webpack-plugin' );
9 | const CreateFileWebpack = require( 'create-file-webpack' );
10 | const Licenses = require( 'wp-license-compatibility' );
11 |
12 | const DEV = process.env.NODE_ENV !== 'production';
13 |
14 | const appPath = __dirname;
15 |
16 | // Entry.
17 | const pluginPath = '/assets';
18 | const pluginFullPath = `${appPath}${pluginPath}`;
19 | const pluginEntry = `${pluginFullPath}/dev/application.js`;
20 | const pluginPublicPath = `${pluginFullPath}/build`;
21 |
22 | // Outputs.
23 | const outputJs = 'scripts/[name]-[hash].js';
24 | const outputCss = 'styles/[name]-[hash].css';
25 |
26 | const allModules = {
27 | rules: [
28 | {
29 | test: /\.(js|jsx)$/,
30 | exclude: /node_modules/,
31 | use: 'babel-loader'
32 | },
33 | {
34 | test: /\.json$/,
35 | use: 'json-loader'
36 | },
37 | {
38 | test: /\.scss$/,
39 | use: [
40 | MiniCssExtractPlugin.loader,
41 | 'css-loader', 'sass-loader'
42 | ]
43 | }
44 | ]
45 | };
46 |
47 | const allPlugins = [
48 | new CleanWebpackPlugin(),
49 | new MiniCssExtractPlugin(
50 | {
51 | filename: outputCss
52 | }
53 | ),
54 | new webpack.ProvidePlugin(
55 | {
56 | $: 'jquery',
57 | jQuery: 'jquery'
58 | }
59 | ),
60 | new webpack.DefinePlugin(
61 | {
62 | 'process.env': {
63 | NODE_ENV: JSON.stringify( process.env.NODE_ENV || 'development' )
64 | }
65 | }
66 | ),
67 | new ManifestPlugin()
68 | ];
69 |
70 | const allOptimizations = {
71 | runtimeChunk: false,
72 | splitChunks: {
73 | cacheGroups: {
74 | commons: {
75 | test: /[\\/]node_modules[\\/]/,
76 | name: 'vendors',
77 | chunks: 'all'
78 | }
79 | }
80 | }
81 | };
82 |
83 | // Use only for production build.
84 | if ( ! DEV ) {
85 | allOptimizations.minimizer = [
86 | new TerserPlugin({
87 | cache: true,
88 | parallel: true,
89 | sourceMap: true
90 | })
91 | ];
92 |
93 | allPlugins.push(
94 | new CreateFileWebpack({
95 | path: './assets/build/',
96 | fileName: 'licenses.json',
97 | content: JSON.stringify( Licenses, null, 2 )
98 | }),
99 |
100 | new FileManagerPlugin({
101 | onEnd: [
102 | {
103 | copy: [
104 | {
105 | source: './',
106 | destination: './theme-sniffer'
107 | }
108 | ]
109 | },
110 | {
111 | delete: [
112 | './theme-sniffer/assets/dev',
113 | './theme-sniffer/node_modules',
114 | './theme-sniffer/composer.json',
115 | './theme-sniffer/composer.lock',
116 | './theme-sniffer/package.json',
117 | './theme-sniffer/package-lock.json',
118 | './theme-sniffer/phpcs.xml.dist',
119 | './theme-sniffer/webpack.config.js',
120 | './theme-sniffer/CODE_OF_CONDUCT.md',
121 | './theme-sniffer/CONTRIBUTING.md'
122 | ]
123 | },
124 | {
125 | archive: [
126 | {
127 | source: './theme-sniffer',
128 | destination: './theme-sniffer.zip',
129 | options: {
130 | gzip: true,
131 | gzipOptions: { level: 1 },
132 | globOptions: { nomount: true }
133 | }
134 | }
135 | ]
136 | },
137 | {
138 | delete: [
139 | './theme-sniffer'
140 | ]
141 | }
142 | ]
143 | })
144 | );
145 |
146 | }
147 |
148 | module.exports = [
149 | {
150 | context: path.join( appPath ),
151 |
152 | entry: {
153 | themeSniffer: [ pluginEntry ]
154 | },
155 |
156 | output: {
157 | path: pluginPublicPath,
158 | publicPath: '',
159 | filename: outputJs
160 | },
161 |
162 | externals: {
163 | jquery: 'jQuery',
164 | esprima: 'esprima'
165 | },
166 |
167 | optimization: allOptimizations,
168 |
169 | module: allModules,
170 |
171 | plugins: allPlugins
172 | }
173 | ];
174 |
--------------------------------------------------------------------------------