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