diff options
Diffstat (limited to 'plugins/jetpack/class.jetpack-modules-list-table.php')
| -rw-r--r-- | plugins/jetpack/class.jetpack-modules-list-table.php | 199 |
1 files changed, 155 insertions, 44 deletions
diff --git a/plugins/jetpack/class.jetpack-modules-list-table.php b/plugins/jetpack/class.jetpack-modules-list-table.php index 004a2dff..bfc4d040 100644 --- a/plugins/jetpack/class.jetpack-modules-list-table.php +++ b/plugins/jetpack/class.jetpack-modules-list-table.php @@ -1,4 +1,9 @@ -<?php +<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName +/** + * Jetpack modules list table. + * + * @package automattic/jetpack + */ use Automattic\Jetpack\Assets; @@ -6,9 +11,13 @@ if ( ! class_exists( 'WP_List_Table' ) ) { require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; } +/** + * Jetpack modules list table. + */ class Jetpack_Modules_List_Table extends WP_List_Table { - function __construct() { + /** Constructor. */ + public function __construct() { parent::__construct(); Jetpack::init(); @@ -28,7 +37,8 @@ class Jetpack_Modules_List_Table extends WP_List_Table { $this->items = $this->all_items; $this->items = $this->filter_displayed_table_items( $this->items ); $this->_column_headers = array( $this->get_columns(), array(), array(), 'name' ); - $modal_info = isset( $_GET['info'] ) ? $_GET['info'] : false; + // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Nonce: This is a view, not a model or controller. InputNotSanitized: Sanitized below via `$this->module_info_check()`. + $modal_info = isset( $_GET['info'] ) ? wp_unslash( $_GET['info'] ) : false; wp_register_script( 'models.jetpack-modules', @@ -37,7 +47,8 @@ class Jetpack_Modules_List_Table extends WP_List_Table { '_inc/jetpack-modules.models.js' ), array( 'backbone', 'underscore' ), - JETPACK__VERSION + JETPACK__VERSION, + false // @todo Can this be put in the footer? ); wp_register_script( 'views.jetpack-modules', @@ -46,7 +57,8 @@ class Jetpack_Modules_List_Table extends WP_List_Table { '_inc/jetpack-modules.views.js' ), array( 'backbone', 'underscore', 'wp-util' ), - JETPACK__VERSION + JETPACK__VERSION, + false // @todo Can this be put in the footer? ); wp_register_script( 'jetpack-modules-list-table', @@ -90,7 +102,10 @@ class Jetpack_Modules_List_Table extends WP_List_Table { add_action( 'admin_footer', apply_filters( 'jetpack_modules_list_table_js_template_callback', array( $this, 'js_templates' ) ), 9 ); } - function js_templates() { + /** + * Output row template. + */ + public function js_templates() { ?> <script type="text/html" id="tmpl-Jetpack_Modules_List_Table_Template"> <# var i = 0; @@ -108,9 +123,9 @@ class Jetpack_Modules_List_Table extends WP_List_Table { <span class='configure'>{{{ item.configurable }}}</span> <# } #> <# if ( item.activated && 'vaultpress' !== item.module && item.available ) { #> - <span class='delete'><a href="<?php echo admin_url( 'admin.php' ); ?>?page=jetpack&action=deactivate&module={{{ item.module }}}&_wpnonce={{{ item.deactivate_nonce }}}"><?php _e( 'Deactivate', 'jetpack' ); ?></a></span> + <span class='delete'><a href="<?php echo esc_url( admin_url( 'admin.php' ) ); ?>?page=jetpack&action=deactivate&module={{{ item.module }}}&_wpnonce={{{ item.deactivate_nonce }}}"><?php esc_html_e( 'Deactivate', 'jetpack' ); ?></a></span> <# } else if ( item.available ) { #> - <span class='activate'><a href="<?php echo admin_url( 'admin.php' ); ?>?page=jetpack&action=activate&module={{{ item.module }}}&_wpnonce={{{ item.activate_nonce }}}"><?php _e( 'Activate', 'jetpack' ); ?></a></span> + <span class='activate'><a href="<?php echo esc_url( admin_url( 'admin.php' ) ); ?>?page=jetpack&action=activate&module={{{ item.module }}}&_wpnonce={{{ item.activate_nonce }}}"><?php esc_html_e( 'Activate', 'jetpack' ); ?></a></span> <# } #> <# if ( ! item.available ) { #> <span class='unavailable_reason'>{{{ item.unavailable_reason }}}</span> @@ -132,7 +147,12 @@ class Jetpack_Modules_List_Table extends WP_List_Table { <?php } - function get_views() { + /** + * Get views data. + * + * @return array Maps identifier to display HTML. + */ + public function get_views() { /** This filter is already documented in class.jetpack-modules-list-table.php */ $modules = apply_filters( 'jetpack_modules_list_table_items', Jetpack_Admin::init()->get_modules() ); $array_of_module_tags = wp_list_pluck( $modules, 'module_tags' ); @@ -140,10 +160,11 @@ class Jetpack_Modules_List_Table extends WP_List_Table { $module_tags_unique = array_count_values( $module_tags ); ksort( $module_tags_unique ); - $format = '<a href="%3$s"%4$s data-title="%1$s">%1$s <span class="count">(%2$s)</span></a>'; - $title = __( 'All', 'jetpack' ); - $count = count( $modules ); - $url = esc_url( remove_query_arg( 'module_tag' ) ); + $format = '<a href="%3$s"%4$s data-title="%1$s">%1$s <span class="count">(%2$s)</span></a>'; + $title = __( 'All', 'jetpack' ); + $count = count( $modules ); + $url = esc_url( remove_query_arg( 'module_tag' ) ); + // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This is a view, not a model or controller. $current = empty( $_GET['module_tag'] ) ? ' class="current all"' : ' class="all"'; $views = array( 'all' => sprintf( $format, $title, $count, $url, $current ), @@ -151,9 +172,10 @@ class Jetpack_Modules_List_Table extends WP_List_Table { foreach ( $module_tags_unique as $title => $count ) { $key = sanitize_title( $title ); $display_title = esc_html( wptexturize( $title ) ); - $url = esc_url( add_query_arg( 'module_tag', urlencode( $title ) ) ); + $url = esc_url( add_query_arg( 'module_tag', rawurlencode( $title ) ) ); $current = ''; - if ( ! empty( $_GET['module_tag'] ) && $title == $_GET['module_tag'] ) { + // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This is a view, not a model or controller. + if ( ! empty( $_GET['module_tag'] ) && $title === $_GET['module_tag'] ) { $current = ' class="current"'; } $views[ $key ] = sprintf( $format, $display_title, $count, $url, $current ); @@ -161,26 +183,43 @@ class Jetpack_Modules_List_Table extends WP_List_Table { return $views; } - function views() { + /** + * Output views HTML. + */ + public function views() { $views = $this->get_views(); echo "<ul class='subsubsub'>\n"; foreach ( $views as $class => $view ) { $views[ $class ] = "\t<li class='$class'>$view</li>"; } - echo implode( "\n", $views ) . "\n"; + echo implode( "\n", $views ) . "\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Is HTML. Escaping happens in get_views(). echo '</ul>'; } - function filter_displayed_table_items( $modules ) { + /** + * Filter a modules array for displayed items. + * + * @param array $modules Modules. + * @return array Displayed modules. + */ + public function filter_displayed_table_items( $modules ) { return array_filter( $modules, array( $this, 'is_module_displayed' ) ); } - static function is_module_displayed( $module ) { + /** + * Determine if a module is displayed. + * + * @param array $module Module data. + * @return bool + */ + public static function is_module_displayed( $module ) { // Handle module tag based filtering. + // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This is a view, not a model or controller. if ( ! empty( $_REQUEST['module_tag'] ) ) { - $module_tag = sanitize_text_field( $_REQUEST['module_tag'] ); - if ( ! in_array( $module_tag, $module['module_tags'] ) ) { + // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This is a view, not a model or controller. + $module_tag = sanitize_text_field( wp_unslash( $_REQUEST['module_tag'] ) ); + if ( ! in_array( $module_tag, $module['module_tags'], true ) ) { return false; } } @@ -189,8 +228,15 @@ class Jetpack_Modules_List_Table extends WP_List_Table { return true; } - static function sort_requires_connection_last( $module1, $module2 ) { - if ( $module1['requires_connection'] == $module2['requires_connection'] ) { + /** + * Sort callback to put modules with `requires_connection` last. + * + * @param array $module1 Module data. + * @param array $module2 Module data. + * @return int Indicating the relative ordering of module1 and module2. + */ + public static function sort_requires_connection_last( $module1, $module2 ) { + if ( (bool) $module1['requires_connection'] === (bool) $module2['requires_connection'] ) { return 0; } if ( $module1['requires_connection'] ) { @@ -203,7 +249,12 @@ class Jetpack_Modules_List_Table extends WP_List_Table { return 0; } - function get_columns() { + /** + * Get table columns. + * + * @return string[] Column name to header HTML. + */ + public function get_columns() { $columns = array( 'cb' => '<input type="checkbox" />', 'name' => __( 'Name', 'jetpack' ), @@ -211,7 +262,12 @@ class Jetpack_Modules_List_Table extends WP_List_Table { return $columns; } - function get_bulk_actions() { + /** + * Get bulk actions for the table. + * + * @return string[] Actions, code => text. + */ + public function get_bulk_actions() { $actions = array( 'bulk-activate' => __( 'Activate', 'jetpack' ), 'bulk-deactivate' => __( 'Deactivate', 'jetpack' ), @@ -219,9 +275,14 @@ class Jetpack_Modules_List_Table extends WP_List_Table { return $actions; } - function single_row( $item ) { + /** + * Print a single row of the table. + * + * @param object|array $item Item. + */ + public function single_row( $item ) { static $i = 0; - $row_class = ( ++$i % 2 ) ? ' alternate' : ''; + $row_class = ( ( ++$i ) % 2 ) ? ' alternate' : ''; if ( ! empty( $item['activated'] ) ) { $row_class .= ' active'; @@ -236,11 +297,22 @@ class Jetpack_Modules_List_Table extends WP_List_Table { echo '</tr>'; } - function get_table_classes() { + /** + * Table classes. + * + * @return string[] HTML. + */ + public function get_table_classes() { return array( 'table', 'table-bordered', 'wp-list-table', 'widefat', 'fixed', 'jetpack-modules' ); } - function column_cb( $item ) { + /** + * Column checkbox. + * + * @param object|array $item Item. + * @return string HTML. + */ + public function column_cb( $item ) { if ( ! Jetpack_Admin::is_module_available( $item ) ) { return ''; } @@ -248,13 +320,19 @@ class Jetpack_Modules_List_Table extends WP_List_Table { return sprintf( '<input type="checkbox" name="modules[]" value="%s" />', $item['module'] ); } - function column_icon( $item ) { - $badge_text = $free_text = ''; + /** + * Column icon. + * + * @return string HTML. + */ + public function column_icon() { + $badge_text = ''; + $free_text = ''; ob_start(); ?> <a href="#TB_inline?width=600&height=550&inlineId=more-info-module-settings-modal" class="thickbox"> <div class="module-image"> - <p><span class="module-image-badge"><?php echo $badge_text; ?></span><span class="module-image-free" style="display: none"><?php echo $free_text; ?></span></p> + <p><span class="module-image-badge"><?php echo esc_html( $badge_text ); ?></span><span class="module-image-free" style="display: none"><?php echo esc_html( $free_text ); ?></span></p> </div> </a> <?php @@ -262,7 +340,13 @@ class Jetpack_Modules_List_Table extends WP_List_Table { } - function column_name( $item ) { + /** + * Column name. + * + * @param object|array $item Item. + * @return string HTML. + */ + public function column_name( $item ) { $actions = array( 'info' => sprintf( '<a href="%s" target="blank">%s</a>', esc_url( $item['learn_more_button'] ), esc_html__( 'Feature Info', 'jetpack' ) ), ); @@ -300,8 +384,15 @@ class Jetpack_Modules_List_Table extends WP_List_Table { return $this->row_actions( $actions ) . wptexturize( $item['name'] ); } - function column_description( $item ) { + /** + * Column description. + * + * @param object|array $item Item. + * @return string HTML. + */ + public function column_description( $item ) { ob_start(); + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped /** This action is documented in class.jetpack-admin.php */ echo apply_filters( 'jetpack_short_module_description', $item['description'], $item['module'] ); /** This action is documented in class.jetpack-admin.php */ @@ -310,31 +401,52 @@ class Jetpack_Modules_List_Table extends WP_List_Table { /** This action is documented in class.jetpack-admin.php */ do_action( 'jetpack_module_more_info_' . $item['module'] ); echo '</div>'; + // phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped return ob_get_clean(); } - function column_module_tags( $item ) { + /** + * Return module tags HTML. + * + * @param object|array $item Item. + * @return string HTML. + */ + public function column_module_tags( $item ) { $module_tags = array(); foreach ( $item['module_tags'] as $module_tag ) { - $module_tags[] = sprintf( '<a href="%3$s" data-title="%2$s">%1$s</a>', esc_html( $module_tag ), esc_attr( $module_tag ), esc_url( add_query_arg( 'module_tag', urlencode( $module_tag ) ) ) ); + $module_tags[] = sprintf( '<a href="%3$s" data-title="%2$s">%1$s</a>', esc_html( $module_tag ), esc_attr( $module_tag ), esc_url( add_query_arg( 'module_tag', rawurlencode( $module_tag ) ) ) ); } return implode( ', ', $module_tags ); } - function column_default( $item, $column_name ) { + /** + * Column default value. + * + * @param object|array $item Item. + * @param string $column_name Column name. + * @return string + */ + public function column_default( $item, $column_name ) { switch ( $column_name ) { case 'icon': case 'name': case 'description': - break; + return ''; default: + // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r return print_r( $item, true ); } } - // Check if the info parameter provided in the URL corresponds to an actual module - function module_info_check( $info, $modules ) { - if ( false == $info ) { + /** + * Check if the info parameter provided in the URL corresponds to an actual module. + * + * @param string|false $info Info parameter. + * @param array $modules Modules array. + * @return string|false + */ + public function module_info_check( $info, $modules ) { + if ( ! $info ) { return false; } elseif ( array_key_exists( $info, $modules ) ) { return $info; @@ -347,11 +459,10 @@ class Jetpack_Modules_List_Table extends WP_List_Table { * * @see https://github.com/WordPress/WordPress/commit/d28f6344de97616de8ece543ed290c4ba2383622 * - * @param string $which - * + * @param string $which Which nav table to display. * @return mixed */ - function unprotected_display_tablenav( $which = 'top' ) { + public function unprotected_display_tablenav( $which = 'top' ) { return $this->display_tablenav( $which ); } |