current_user_can() && $this->is_snippets_screen(); } /** * Enqueue the panel assets. * * @return void */ public function enqueue_assets(): void { if ( ! $this->should_render() ) { return; } wp_enqueue_style( self::STYLE_HANDLE, plugins_url( 'dist/feedback.css', PLUGIN_FILE ), [ 'wp-components' ], PLUGIN_VERSION ); wp_enqueue_script( self::SCRIPT_HANDLE, plugins_url( 'dist/feedback.js', PLUGIN_FILE ), [ 'react', 'react-dom', 'wp-components', 'wp-element', 'wp-i18n' ], PLUGIN_VERSION, true ); wp_set_script_translations( self::SCRIPT_HANDLE, 'code-snippets' ); $user = wp_get_current_user(); wp_localize_script( self::SCRIPT_HANDLE, 'CODE_SNIPPETS_FEEDBACK', [ 'restUrl' => esc_url_raw( rest_url( Feedback_REST_Controller::get_base_route() ) ), // Built here rather than appended in the browser: with plain permalinks the // route travels in a query parameter, where a path cannot simply be added. 'searchUrl' => esc_url_raw( rest_url( Feedback_REST_Controller::get_base_route() . '/search' ) ), 'nonce' => wp_create_nonce( 'wp_rest' ), 'user' => [ 'name' => $user->display_name, 'email' => $user->user_email, ], 'summary' => $this->get_cached_summary(), 'badge' => self::get_badge_label(), 'version' => PLUGIN_VERSION, 'edition' => System_Info::get_edition(), ] ); } /** * Retrieve the environment summary shown in the panel. * * Collecting it means reading the header of every installed plugin, which is too much * to repeat on every admin page load for a panel that is rarely opened. The report * itself is assembled from freshly collected details when one is sent. * * @return array */ private function get_cached_summary(): array { $summary = get_transient( self::SUMMARY_TRANSIENT ); if ( is_array( $summary ) ) { return $summary; } $summary = System_Info::get_summary( System_Info::get_system_info() ); set_transient( self::SUMMARY_TRANSIENT, $summary, self::SUMMARY_TIMEOUT ); return $summary; } /** * Print the element the panel mounts into. * * @return void */ public function render_container(): void { if ( ! $this->should_render() ) { return; } printf( '
', esc_attr( self::CONTAINER_ID ) ); } /** * Describe the build a report was sent from, when it is not a released one. * * A released build carries no badge: labeling every install as a test build would * misrepresent it. Pre-release builds are named so that a report can be read against * the build it came from. * * @param string|null $version Version to describe. Defaults to the running version. * * @return string Badge text, empty when there is nothing to say. */ public static function get_badge_label( ?string $version = null ): string { $version = null === $version ? PLUGIN_VERSION : $version; $label = ''; if ( preg_match( '/-(alpha|beta|rc)/i', $version, $matches ) ) { $names = [ 'alpha' => _x( 'Alpha', 'pre-release build', 'code-snippets' ), 'beta' => _x( 'Beta', 'pre-release build', 'code-snippets' ), 'rc' => _x( 'RC', 'pre-release build', 'code-snippets' ), ]; $label = sprintf( '%s %s', $names[ strtolower( $matches[1] ) ], $version ); } return apply_filters( 'code_snippets_feedback_badge_label', $label, $version ); } /** * Determine whether the current screen belongs to this plugin. * * Matching this plugin's own menu slugs, rather than looking for 'snippet' anywhere in * the screen identifier, keeps the reporter off screens belonging to other plugins. * * @return bool */ private function is_snippets_screen(): bool { if ( ! is_admin() ) { return false; } $slugs = []; foreach ( [ '', 'add', 'edit', 'import', 'settings', 'insights', 'welcome' ] as $menu ) { $slugs[] = code_snippets()->get_menu_slug( $menu ); } // phpcs:ignore WordPress.Security.NonceVerification.Recommended $page = isset( $_GET['page'] ) ? sanitize_key( wp_unslash( $_GET['page'] ) ) : ''; if ( $page && in_array( $page, $slugs, true ) ) { return true; } $screen = function_exists( 'get_current_screen' ) ? get_current_screen() : null; if ( ! $screen ) { return false; } foreach ( $slugs as $slug ) { if ( $slug && substr( $screen->id, -strlen( '_page_' . $slug ) ) === '_page_' . $slug ) { return true; } } return false; } }