Automattic /
jetpack
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Jetpack_Twitter_Cards often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Jetpack_Twitter_Cards, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 11 | class Jetpack_Twitter_Cards { |
||
| 12 | |||
| 13 | static function twitter_cards_tags( $og_tags ) { |
||
| 14 | global $post; |
||
| 15 | |||
| 16 | if ( post_password_required() ) { |
||
| 17 | return $og_tags; |
||
| 18 | } |
||
| 19 | |||
| 20 | /** This action is documented in class.jetpack.php */ |
||
| 21 | if ( apply_filters( 'jetpack_disable_twitter_cards', false ) ) { |
||
| 22 | return $og_tags; |
||
| 23 | } |
||
| 24 | |||
| 25 | /* |
||
| 26 | * These tags apply to any page (home, archives, etc) |
||
| 27 | */ |
||
| 28 | |||
| 29 | $site_tag = self::site_tag(); |
||
| 30 | /** This action is documented in modules/sharedaddy/sharing-sources.php */ |
||
| 31 | $site_tag = apply_filters( 'jetpack_sharing_twitter_via', $site_tag, ( is_singular() ? $post->ID : null ) ); |
||
| 32 | /** This action is documented in modules/sharedaddy/sharing-sources.php */ |
||
| 33 | $site_tag = apply_filters( 'jetpack_twitter_cards_site_tag', $site_tag, $og_tags ); |
||
| 34 | if ( ! empty( $site_tag ) ) { |
||
| 35 | $og_tags['twitter:site'] = self::sanitize_twitter_user( $site_tag ); |
||
| 36 | } |
||
| 37 | |||
| 38 | if ( ! is_singular() || ! empty( $og_tags['twitter:card'] ) ) { |
||
| 39 | return $og_tags; |
||
| 40 | } |
||
| 41 | |||
| 42 | /* |
||
| 43 | * The following tags only apply to single pages. |
||
| 44 | */ |
||
| 45 | |||
| 46 | $card_type = 'summary'; |
||
| 47 | |||
| 48 | // Try to give priority to featured images |
||
| 49 | if ( class_exists('Jetpack_PostImages') ) { |
||
| 50 | $featured = Jetpack_PostImages::from_thumbnail( $post->ID, 240, 240 ); |
||
| 51 | if ( !empty( $featured ) && count( $featured ) > 0 ) { |
||
| 52 | if ( (int) $featured[0]['src_width'] >= 280 && (int) $featured[0]['src_height'] >= 150 ) { |
||
| 53 | $card_type = 'summary_large_image'; |
||
| 54 | $og_tags['twitter:image'] = esc_url( add_query_arg( 'w', 640, $featured[0]['src'] ) ); |
||
| 55 | } else { |
||
| 56 | $og_tags['twitter:image'] = esc_url( add_query_arg( 'w', 240, $featured[0]['src'] ) ); |
||
| 57 | } |
||
| 58 | } |
||
| 59 | } |
||
| 60 | |||
| 61 | // Only proceed with media analysis if a featured image has not superseded it already. |
||
| 62 | if ( empty( $og_tags['twitter:image'] ) && empty( $og_tags['twitter:image:src'] ) ) { |
||
| 63 | View Code Duplication | if ( ! class_exists( 'Jetpack_Media_Summary' ) && defined('IS_WPCOM') && IS_WPCOM ) { |
|
| 64 | include( WP_CONTENT_DIR . '/lib/class.wpcom-media-summary.php' ); |
||
| 65 | } |
||
| 66 | |||
| 67 | // Test again, class should already be auto-loaded in Jetpack. |
||
| 68 | // If not, skip extra media analysis and stick with a summary card |
||
| 69 | if ( class_exists( 'Jetpack_Media_Summary' ) ) { |
||
| 70 | $extract = Jetpack_Media_Summary::get( $post->ID ); |
||
| 71 | |||
| 72 | if ( 'gallery' == $extract['type'] ) { |
||
| 73 | list( $og_tags, $card_type ) = self::twitter_cards_define_type_based_on_image_count( $og_tags, $extract ); |
||
| 74 | } elseif ( 'video' == $extract['type'] ) { |
||
| 75 | // Leave as summary, but with large pict of poster frame (we know those comply to Twitter's size requirements) |
||
| 76 | $card_type = 'summary_large_image'; |
||
| 77 | $og_tags['twitter:image'] = esc_url( add_query_arg( 'w', 640, $extract['image'] ) ); |
||
| 78 | } else { |
||
| 79 | list( $og_tags, $card_type ) = self::twitter_cards_define_type_based_on_image_count( $og_tags, $extract ); |
||
| 80 | } |
||
| 81 | } |
||
| 82 | } |
||
| 83 | |||
| 84 | $og_tags['twitter:card'] = $card_type; |
||
| 85 | |||
| 86 | // If we have information on the author/creator, then include that as well |
||
| 87 | if ( ! empty( $post ) && ! empty( $post->post_author ) ) { |
||
| 88 | /** This action is documented in modules/sharedaddy/sharing-sources.php */ |
||
| 89 | $handle = apply_filters( 'jetpack_sharing_twitter_via', '', $post->ID ); |
||
| 90 | if ( ! empty( $handle ) && 'wordpressdotcom' != $handle && 'jetpack' != $handle ) { |
||
| 91 | $og_tags['twitter:creator'] = self::sanitize_twitter_user( $handle ); |
||
| 92 | } |
||
| 93 | } |
||
| 94 | |||
| 95 | // Make sure we have a description for Twitter, their validator isn't happy without some content (single space not valid). |
||
| 96 | if ( ! isset( $og_tags['og:description'] ) || '' == trim( $og_tags['og:description'] ) || __('Visit the post for more.', 'jetpack') == $og_tags['og:description'] ) { // empty( trim( $og_tags['og:description'] ) ) isn't valid php |
||
| 97 | $has_creator = ( ! empty($og_tags['twitter:creator']) && '@wordpressdotcom' != $og_tags['twitter:creator'] ) ? true : false; |
||
| 98 | if ( ! empty( $extract ) && 'video' == $extract['type'] ) { // use $extract['type'] since $card_type is 'summary' for video posts |
||
|
|
|||
| 99 | $og_tags['twitter:description'] = ( $has_creator ) ? sprintf( __('Video post by %s.', 'jetpack'), $og_tags['twitter:creator'] ) : __('Video post.', 'jetpack'); |
||
| 100 | } else { |
||
| 101 | $og_tags['twitter:description'] = ( $has_creator ) ? sprintf( __('Post by %s.', 'jetpack'), $og_tags['twitter:creator'] ) : __('Visit the post for more.', 'jetpack'); |
||
| 102 | } |
||
| 103 | } |
||
| 104 | |||
| 105 | return $og_tags; |
||
| 106 | } |
||
| 107 | |||
| 108 | static function sanitize_twitter_user( $str ) { |
||
| 111 | |||
| 112 | static function prioritize_creator_over_default_site( $site_tag, $og_tags = array() ) { |
||
| 113 | if ( ! empty( $og_tags['twitter:creator'] ) && in_array( $site_tag, array( '@wordpressdotcom', '@jetpack' ) ) ) { |
||
| 114 | $site_tag = $og_tags['twitter:creator']; |
||
| 115 | } |
||
| 116 | return $site_tag; |
||
| 117 | } |
||
| 118 | |||
| 119 | static function twitter_cards_define_type_based_on_image_count( $og_tags, $extract ) { |
||
| 120 | $card_type = 'summary'; |
||
| 121 | $img_count = $extract['count']['image']; |
||
| 122 | |||
| 123 | if ( empty( $img_count ) ) { |
||
| 124 | |||
| 125 | // No images, use Blavatar as a thumbnail for the summary type. |
||
| 126 | if ( function_exists('blavatar_domain') ) { |
||
| 127 | $blavatar_domain = blavatar_domain( site_url() ); |
||
| 128 | if ( blavatar_exists( $blavatar_domain ) ) { |
||
| 129 | $og_tags['twitter:image'] = blavatar_url( $blavatar_domain, 'img', 240 ); |
||
| 130 | } |
||
| 131 | } |
||
| 132 | |||
| 133 | // Second fall back, Site Logo |
||
| 134 | if ( empty( $og_tags['twitter:image'] ) && ( function_exists( 'jetpack_has_site_logo' ) && jetpack_has_site_logo() ) ) { |
||
| 135 | $og_tags['twitter:image'] = jetpack_get_site_logo( 'url' ); |
||
| 136 | } |
||
| 137 | |||
| 138 | // Third fall back, Site Icon |
||
| 139 | if ( empty( $og_tags['twitter:image'] ) && ( function_exists( 'jetpack_has_site_icon' ) && jetpack_has_site_icon() ) ) { |
||
| 140 | $og_tags['twitter:image'] = jetpack_site_icon_url( null, '240' ); |
||
| 141 | } |
||
| 142 | |||
| 143 | // Not falling back on Gravatar, because there's no way to know if we end up with an auto-generated one. |
||
| 144 | |||
| 145 | } elseif ( $img_count && ( 'image' == $extract['type'] || 'gallery' == $extract['type'] ) ) { |
||
| 146 | // Test for $extract['type'] to limit to image and gallery, so we don't send a potential fallback image like a Gravatar as a photo post. |
||
| 147 | $card_type = 'summary_large_image'; |
||
| 148 | $og_tags['twitter:image'] = esc_url( add_query_arg( 'w', 1400, ( empty( $extract['images'] ) ) ? $extract['image'] : $extract['images'][0]['url'] ) ); |
||
| 149 | } |
||
| 150 | |||
| 151 | return array( $og_tags, $card_type ); |
||
| 152 | } |
||
| 153 | |||
| 154 | static function twitter_cards_output( $og_tag ) { |
||
| 157 | |||
| 158 | static function settings_init() { |
||
| 159 | add_settings_section( 'jetpack-twitter-cards-settings', 'Twitter Cards', '__return_false', 'sharing' ); |
||
| 160 | add_settings_field( |
||
| 161 | 'jetpack-twitter-cards-site-tag', |
||
| 162 | __( 'Twitter Site Tag', 'jetpack' ), |
||
| 163 | array( __CLASS__, 'settings_field' ), |
||
| 164 | 'sharing', |
||
| 165 | 'jetpack-twitter-cards-settings', |
||
| 166 | array( |
||
| 167 | 'label_for' => 'jetpack-twitter-cards-site-tag', |
||
| 168 | ) |
||
| 169 | ); |
||
| 170 | } |
||
| 171 | |||
| 172 | static function sharing_global_options() { |
||
| 175 | |||
| 176 | static function site_tag() { |
||
| 187 | |||
| 188 | static function settings_field() { |
||
| 189 | wp_nonce_field( 'jetpack-twitter-cards-settings', 'jetpack_twitter_cards_nonce', false ); |
||
| 190 | ?> |
||
| 191 | <input type="text" id="jetpack-twitter-cards-site-tag" class="regular-text" name="jetpack-twitter-cards-site-tag" value="<?php echo esc_attr( get_option( 'jetpack-twitter-cards-site-tag' ) ); ?>" /> |
||
| 195 | |||
| 196 | static function settings_validate() { |
||
| 201 | |||
| 202 | static function init() { |
||
| 211 | } |
||
| 212 | |||
| 214 |
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.