← All changes | modules/widgets/goodreads.php +239 -0 16.2-beta → 16.3 View file →

		@@ -1,0 +1,239 @@
	1	+<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
	2	+
	3	+if ( ! defined( 'ABSPATH' ) ) {
	4	+ exit( 0 );
	5	+}
	6	+
	7	+// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
	8	+
	9	+add_action( 'widgets_init', 'jetpack_goodreads_widget_init' );
	10	+/**
	11	+ * Register the widget for use in Appearance -> Widgets
	12	+ */
	13	+function jetpack_goodreads_widget_init() {
	14	+ register_widget( 'WPCOM_Widget_Goodreads' );
	15	+}
	16	+
	17	+/**
	18	+ * Goodreads widget class
	19	+ * Display a user's Goodreads shelf.
	20	+ * Customize user_id, title, and shelf
	21	+ */
	22	+class WPCOM_Widget_Goodreads extends WP_Widget {
	23	+ /**
	24	+ * Widget ID based on Goodreads user ID and shelf.
	25	+ *
	26	+ * @var int
	27	+ */
	28	+ private $goodreads_widget_id = 0;
	29	+
	30	+ /**
	31	+ * WPCOM_Widget_Goodreads constructor.
	32	+ */
	33	+ public function __construct() {
	34	+ parent::__construct(
	35	+ 'wpcom-goodreads',
	36	+ /** This filter is documented in modules/widgets/facebook-likebox.php */
	37	+ apply_filters( 'jetpack_widget_name', __( 'Goodreads', 'jetpack' ) ),
	38	+ array(
	39	+ 'classname' => 'widget_goodreads',
	40	+ 'description' => __( 'Display your books from Goodreads', 'jetpack' ),
	41	+ 'customize_selective_refresh' => true,
	42	+ 'show_instance_in_rest' => true,
	43	+ )
	44	+ );
	45	+ // For user input sanitization and display.
	46	+ $this->shelves = array(
	47	+ 'read' => _x( 'Read', 'past participle: books I have read', 'jetpack' ),
	48	+ 'currently-reading' => __( 'Currently Reading', 'jetpack' ),
	49	+ 'to-read' => _x( 'To Read', 'my list of books to read', 'jetpack' ),
	50	+ );
	51	+
	52	+ add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) );
	53	+ }
	54	+
	55	+ /**
	56	+ * Remove the "Goodreads" widget from the Legacy Widget block
	57	+ *
	58	+ * @param array $widget_types List of widgets that are currently removed from the Legacy Widget block.
	59	+ * @return array $widget_types New list of widgets that will be removed.
	60	+ */
	61	+ public function hide_widget_in_block_editor( $widget_types ) {
	62	+ $widget_types[] = 'wpcom-goodreads';
	63	+ return $widget_types;
	64	+ }
	65	+
	66	+ /**
	67	+ * Enqueue widget styles.
	68	+ */
	69	+ public function enqueue_style() {
	70	+ wp_enqueue_style(
	71	+ 'goodreads-widget',
	72	+ plugins_url( 'goodreads/css/goodreads.css', __FILE__ ),
	73	+ array(),
	74	+ JETPACK__VERSION
	75	+ );
	76	+ wp_style_add_data( 'goodreads-widget', 'rtl', 'replace' );
	77	+ }
	78	+
	79	+ /**
	80	+ * Display the widget.
	81	+ *
	82	+ * @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
	83	+ * @param array $instance The settings for the particular instance of the widget.
	84	+ */
	85	+ public function widget( $args, $instance ) {
	86	+ /** This action is documented in modules/widgets/gravatar-profile.php */
	87	+ do_action( 'jetpack_stats_extra', 'widget_view', 'goodreads' );
	88	+
	89	+ /** This filter is documented in core/src/wp-includes/default-widgets.php */
	90	+ $title = apply_filters( 'widget_title', $instance['title'] ?? '' );
	91	+
	92	+ if ( empty( $instance['user_id'] ) || 'invalid' === $instance['user_id'] ) {
	93	+ if ( current_user_can( 'edit_theme_options' ) ) {
	94	+ echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	95	+ echo '<p>' . sprintf(
	96	+ wp_kses(
	97	+ /* translators: %1$s: link to the widget settings page. %2$s: support article URL for Goodreads widget. */
	98	+ __( 'You need to enter your numeric user ID for the <a href="%1$s">Goodreads Widget</a> to work correctly. <a href="%2$s" target="_blank">Full instructions</a>.', 'jetpack' ),
	99	+ array(
	100	+ 'a' => array(
	101	+ 'href' => array(),
	102	+ 'target' => array(),
	103	+ ),
	104	+ )
	105	+ ),
	106	+ esc_url( admin_url( 'widgets.php' ) ),
	107	+ 'https://wordpress.com/support/widgets/goodreads-widget/#set-up-the-widget'
	108	+ ) . '</p>';
	109	+ echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	110	+ }
	111	+ return;
	112	+ }
	113	+
	114	+ if ( ! array_key_exists( $instance['shelf'], $this->shelves ) ) {
	115	+ return;
	116	+ }
	117	+
	118	+ // Enqueue front end assets.
	119	+ $this->enqueue_style();
	120	+
	121	+ $instance['user_id'] = absint( $instance['user_id'] );
	122	+
	123	+ // Set widget ID based on shelf.
	124	+ $this->goodreads_widget_id = $instance['user_id'] . '_' . $instance['shelf'];
	125	+ $this->goodreads_widget_id = str_replace( '-', '_', $this->goodreads_widget_id ); // Goodreads' custom widget does not like dashes.
	126	+
	127	+ if ( empty( $title ) ) {
	128	+ $title = esc_html__( 'Goodreads', 'jetpack' );
	129	+ }
	130	+
	131	+ echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	132	+ echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	133	+
	134	+ $goodreads_url = 'https://www.goodreads.com/review/custom_widget/' . rawurlencode( (string) $instance['user_id'] ) . '.' . rawurlencode( $instance['title'] ) . ':%20' . rawurlencode( $instance['shelf'] ) . '?cover_position=&cover_size=small&num_books=5&order=d&shelf=' . rawurlencode( $instance['shelf'] ) . '&sort=date_added&widget_bg_transparent=&widget_id=' . rawurlencode( $this->goodreads_widget_id );
	135	+
	136	+ echo '<div class="jetpack-goodreads-legacy-widget gr_custom_widget" id="gr_custom_widget_' . esc_attr( $this->goodreads_widget_id ) . '"></div>' . "\n";
	137	+ echo '<script src="' . esc_url( $goodreads_url ) . '"></script>' . "\n"; // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedScript
	138	+
	139	+ echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	140	+ }
	141	+
	142	+ /**
	143	+ * Check if given Goodreads user ID exists.
	144	+ *
	145	+ * @param string $user_id User ID.
	146	+ */
	147	+ public function goodreads_user_id_exists( $user_id ) {
	148	+ $url = "https://www.goodreads.com/user/show/$user_id/";
	149	+ $response = wp_remote_head(
	150	+ $url,
	151	+ array(
	152	+ 'httpversion' => '1.1',
	153	+ 'timeout' => 10,
	154	+ 'redirection' => 2,
	155	+ )
	156	+ );
	157	+ if ( 200 === wp_remote_retrieve_response_code( $response ) ) {
	158	+ return true;
	159	+ } else {
	160	+ return false;
	161	+ }
	162	+ }
	163	+
	164	+ /**
	165	+ * Update widget.
	166	+ *
	167	+ * @see WP_Widget::update()
	168	+ *
	169	+ * @param array $new_instance New widget instance data.
	170	+ * @param array $old_instance Old widget instance data.
	171	+ */
	172	+ public function update( $new_instance, $old_instance ) {
	173	+ $instance = $old_instance;
	174	+
	175	+ $instance['user_id'] = trim( wp_kses( stripslashes( $new_instance['user_id'] ?? '' ), array() ) );
	176	+ if ( ! empty( $instance['user_id'] ) && ( ! isset( $old_instance['user_id'] ) || $instance['user_id'] !== $old_instance['user_id'] ) ) {
	177	+ if ( ! $this->goodreads_user_id_exists( $instance['user_id'] ) ) {
	178	+ $instance['user_id'] = 'invalid';
	179	+ }
	180	+ }
	181	+ $instance['title'] = wp_kses( stripslashes( $new_instance['title'] ?? '' ), array() );
	182	+ $shelf = wp_kses( stripslashes( $new_instance['shelf'] ?? '' ), array() );
	183	+ if ( array_key_exists( $shelf, $this->shelves ) ) {
	184	+ $instance['shelf'] = $shelf;
	185	+ }
	186	+
	187	+ return $instance;
	188	+ }
	189	+
	190	+ /**
	191	+ * Outputs the widget settings form.
	192	+ *
	193	+ * @param array $instance Current settings.
	194	+ * @return string|void
	195	+ */
	196	+ public function form( $instance ) {
	197	+ // Defaults.
	198	+ $instance = wp_parse_args(
	199	+ (array) $instance,
	200	+ array(
	201	+ 'user_id' => '',
	202	+ 'title' => 'Goodreads',
	203	+ 'shelf' => 'read',
	204	+ )
	205	+ );
	206	+
	207	+ echo '<p><label for="' . esc_attr( $this->get_field_id( 'title' ) ) . '">' . esc_html__( 'Title:', 'jetpack' ) . '
	208	+ <input class="widefat" id="' . esc_attr( $this->get_field_id( 'title' ) ) . '" name="' . esc_attr( $this->get_field_name( 'title' ) ) . '" type="text" value="' . esc_attr( $instance['title'] ) . '" />
	209	+ </label></p>
	210	+ <p><label for="' . esc_attr( $this->get_field_id( 'user_id' ) ) . '">';
	211	+ printf(
	212	+ wp_kses(
	213	+ /* translators: %s: support article URL for Goodreads widget. */
	214	+ __( 'Goodreads numeric user ID <a href="%s" target="_blank">(instructions)</a>:', 'jetpack' ),
	215	+ array(
	216	+ 'a' => array(
	217	+ 'href' => array(),
	218	+ 'target' => array(),
	219	+ ),
	220	+ )
	221	+ ),
	222	+ 'https://wordpress.com/support/widgets/goodreads-widget/#set-up-the-widget'
	223	+ );
	224	+ if ( 'invalid' === $instance['user_id'] ) {
	225	+ printf( '<br /><small class="error">%s</small>&nbsp;', esc_html( __( 'Invalid User ID, please verify and re-enter your Goodreads numeric user ID.', 'jetpack' ) ) );
	226	+ $instance['user_id'] = '';
	227	+ }
	228	+ echo '<input class="widefat" id="' . esc_attr( $this->get_field_id( 'user_id' ) ) . '" name="' . esc_attr( $this->get_field_name( 'user_id' ) ) . '" type="text" value="' . esc_attr( $instance['user_id'] ) . '" />
	229	+ </label></p>
	230	+ <p><label for="' . esc_attr( $this->get_field_id( 'shelf' ) ) . '">' . esc_html__( 'Shelf:', 'jetpack' ) . '
	231	+ <select class="widefat" id="' . esc_attr( $this->get_field_id( 'shelf' ) ) . '" name="' . esc_attr( $this->get_field_name( 'shelf' ) ) . '" >';
	232	+ foreach ( $this->shelves as $_shelf_value => $_shelf_display ) {
	233	+ echo "\t<option value='" . esc_attr( $_shelf_value ) . "'" . selected( $_shelf_value, $instance['shelf'], false ) . '>' . $_shelf_display . "</option>\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	234	+ }
	235	+ echo '</select>
	236	+ </label></p>
	237	+ ';
	238	+ }
	239	+}