| 1 |
<?php |
| 2 |
/** |
| 3 |
* Shortcode handler for [bandcamp], which inserts a bandcamp.com |
| 4 |
* music player (iframe, html5) |
| 5 |
* |
| 6 |
* [bandcamp album=119385304] |
| 7 |
* [bandcamp album=3462839126 bgcol=FFFFFF linkcol=4285BB size=venti] |
| 8 |
* [bandcamp track=2446959313] |
| 9 |
* |
| 10 |
* @package automattic/jetpack |
| 11 |
*/ |
| 12 |
|
| 13 |
/** |
| 14 |
* Display the Bandcamp shortcode. |
| 15 |
* |
| 16 |
* @param array $atts Shortcode attributes. |
| 17 |
*/ |
| 18 |
function shortcode_handler_bandcamp( $atts ) { |
| 19 |
// there are no default values, but specify here anyway to explicitly list supported atts. |
| 20 |
$attributes = shortcode_atts( |
| 21 |
array( |
| 22 |
'album' => null, // integer album id. |
| 23 |
'track' => null, // integer track id. |
| 24 |
'video' => null, // integer track id for video player. |
| 25 |
'size' => 'venti', // one of the supported sizes. |
| 26 |
'bgcol' => 'FFFFFF', // hex, no '#' prefix. |
| 27 |
'linkcol' => null, // hex, no '#' prefix. |
| 28 |
'layout' => null, // encoded layout url. |
| 29 |
'width' => null, // integer with optional "%". |
| 30 |
'height' => null, // integer with optional "%". |
| 31 |
'notracklist' => null, // may be string "true" (defaults false). |
| 32 |
'tracklist' => null, // may be string "false" (defaults true). |
| 33 |
// phpcs:ignore Squiz.PHP.CommentedOutCode.Found -- false positive |
| 34 |
'artwork' => null, // may be string "false" (alternately: "none") or "small" (default is large). |
| 35 |
'minimal' => null, // may be string "true" (defaults false). |
| 36 |
'theme' => null, // may be theme identifier string ("light"|"dark" so far). |
| 37 |
'package' => null, // integer package id. |
| 38 |
't' => null, // integer track number. |
| 39 |
'tracks' => null, // comma separated list of allowed tracks. |
| 40 |
'esig' => null, // hex, no '#' prefix. |
| 41 |
), |
| 42 |
$atts, |
| 43 |
'bandcamp' |
| 44 |
); |
| 45 |
|
| 46 |
$sizes = array( |
| 47 |
'venti' => array( |
| 48 |
'width' => 400, |
| 49 |
'height' => 100, |
| 50 |
), |
| 51 |
'grande' => array( |
| 52 |
'width' => 300, |
| 53 |
'height' => 100, |
| 54 |
), |
| 55 |
'grande2' => array( |
| 56 |
'width' => 300, |
| 57 |
'height' => 355, |
| 58 |
), |
| 59 |
'grande3' => array( |
| 60 |
'width' => 300, |
| 61 |
'height' => 415, |
| 62 |
), |
| 63 |
'tall_album' => array( |
| 64 |
'width' => 150, |
| 65 |
'height' => 295, |
| 66 |
), |
| 67 |
'tall_track' => array( |
| 68 |
'width' => 150, |
| 69 |
'height' => 270, |
| 70 |
), |
| 71 |
'tall2' => array( |
| 72 |
'width' => 150, |
| 73 |
'height' => 450, |
| 74 |
), |
| 75 |
'short' => array( |
| 76 |
'width' => 46, |
| 77 |
'height' => 23, |
| 78 |
), |
| 79 |
'large' => array( |
| 80 |
'width' => 350, |
| 81 |
'height' => 470, |
| 82 |
), |
| 83 |
'medium' => array( |
| 84 |
'width' => 450, |
| 85 |
'height' => 120, |
| 86 |
), |
| 87 |
'small' => array( |
| 88 |
'width' => 350, |
| 89 |
'height' => 42, |
| 90 |
), |
| 91 |
); |
| 92 |
|
| 93 |
$sizekey = $attributes['size']; |
| 94 |
$height = null; |
| 95 |
$width = null; |
| 96 |
|
| 97 |
$is_video = false; |
| 98 |
|
| 99 |
/* |
| 100 |
* Build iframe url. For audio players, args are appended as |
| 101 |
* extra path segments for historical reasons having to |
| 102 |
* do with an IE-only flash bug which required this URL |
| 103 |
* to contain no querystring. Delay the actual joining |
| 104 |
* of args into a string until after we decide if it's |
| 105 |
* a video player or an audio player |
| 106 |
*/ |
| 107 |
$argparts = array(); |
| 108 |
|
| 109 |
if ( ! isset( $attributes['album'] ) && ! isset( $attributes['track'] ) && ! isset( $attributes['video'] ) ) { |
| 110 |
return "[bandcamp: shortcode must include 'track', 'album', or 'video' param]"; |
| 111 |
} |
| 112 |
|
| 113 |
if ( isset( $attributes['track'] ) && is_numeric( $attributes['track'] ) ) { |
| 114 |
$track = esc_attr( $attributes['track'] ); |
| 115 |
array_push( $argparts, "track={$track}" ); |
| 116 |
} elseif ( isset( $attributes['video'] ) && is_numeric( $attributes['video'] ) ) { |
| 117 |
$track = esc_attr( $attributes['video'] ); // videos are referenced by track id. |
| 118 |
$url = '//bandcamp.com/EmbeddedPlayer/v=2'; |
| 119 |
$is_video = true; |
| 120 |
array_push( $argparts, "track={$track}" ); |
| 121 |
} |
| 122 |
if ( isset( $attributes['album'] ) && is_numeric( $attributes['album'] ) ) { |
| 123 |
$album = esc_attr( $attributes['album'] ); |
| 124 |
array_push( $argparts, "album={$album}" ); |
| 125 |
} |
| 126 |
|
| 127 |
if ( 'tall' === $sizekey ) { |
| 128 |
if ( isset( $attributes['album'] ) ) { |
| 129 |
$sizekey .= '_album'; |
| 130 |
} else { |
| 131 |
$sizekey .= '_track'; |
| 132 |
} |
| 133 |
} |
| 134 |
|
| 135 |
// if size specified that we don't recognize, fall back on venti. |
| 136 |
if ( empty( $sizes[ $sizekey ] ) ) { |
| 137 |
$sizekey = 'venti'; |
| 138 |
$attributes['size'] = 'venti'; |
| 139 |
} |
| 140 |
|
| 141 |
/* |
| 142 |
* use strict regex for digits + optional % instead of absint for height/width |
| 143 |
* 'width' and 'height' params in the iframe url get the exact string from the shortcode |
| 144 |
* args, whereas the inline style attribute must have "px" added to it if it has no "%" |
| 145 |
*/ |
| 146 |
if ( isset( $attributes['width'] ) && preg_match( '|^([0-9]+)(%)?$|', $attributes['width'], $matches ) ) { |
| 147 |
$width = $attributes['width']; |
| 148 |
$csswidth = $attributes['width']; |
| 149 |
if ( count( $matches ) < 3 ) { |
| 150 |
$csswidth .= 'px'; |
| 151 |
} |
| 152 |
} |
| 153 |
if ( isset( $attributes['height'] ) && preg_match( '|^([0-9]+)(%)?$|', $attributes['height'], $matches ) ) { |
| 154 |
$height = $attributes['height']; |
| 155 |
$cssheight = $attributes['height']; |
| 156 |
if ( count( $matches ) < 3 ) { |
| 157 |
$cssheight .= 'px'; |
| 158 |
} |
| 159 |
} |
| 160 |
|
| 161 |
if ( ! $height ) { |
| 162 |
$height = $sizes[ $sizekey ]['height']; |
| 163 |
$cssheight = $height . 'px'; |
| 164 |
} |
| 165 |
|
| 166 |
if ( ! $width ) { |
| 167 |
$width = $sizes[ $sizekey ]['width']; |
| 168 |
$csswidth = $width . 'px'; |
| 169 |
} |
| 170 |
|
| 171 |
if ( isset( $attributes['layout'] ) ) { |
| 172 |
array_push( $argparts, "layout={$attributes['layout']}" ); |
| 173 |
} elseif ( isset( $attributes['size'] ) && preg_match( '|^[a-zA-Z0-9]+$|', $attributes['size'] ) ) { |
| 174 |
array_push( $argparts, "size={$attributes['size']}" ); |
| 175 |
} |
| 176 |
|
| 177 |
if ( isset( $attributes['bgcol'] ) && preg_match( '|^[0-9A-Fa-f]+$|', $attributes['bgcol'] ) ) { |
| 178 |
array_push( $argparts, "bgcol={$attributes['bgcol']}" ); |
| 179 |
} |
| 180 |
|
| 181 |
if ( isset( $attributes['linkcol'] ) && preg_match( '|^[0-9A-Fa-f]+$|', $attributes['linkcol'] ) ) { |
| 182 |
array_push( $argparts, "linkcol={$attributes['linkcol']}" ); |
| 183 |
} |
| 184 |
|
| 185 |
if ( isset( $attributes['package'] ) && preg_match( '|^[0-9]+$|', $attributes['package'] ) ) { |
| 186 |
array_push( $argparts, "package={$attributes['package']}" ); |
| 187 |
} |
| 188 |
|
| 189 |
if ( isset( $attributes['t'] ) && preg_match( '|^[0-9]+$|', $attributes['t'] ) ) { |
| 190 |
array_push( $argparts, "t={$attributes['t']}" ); |
| 191 |
} |
| 192 |
|
| 193 |
if ( 'true' === $attributes['notracklist'] ) { |
| 194 |
array_push( $argparts, 'notracklist=true' ); |
| 195 |
} |
| 196 |
|
| 197 |
// 'tracklist' arg deprecates 'notracklist=true' to be less weird. note, behavior |
| 198 |
// if both are specified is undefined |
| 199 |
switch ( $attributes['tracklist'] ) { |
| 200 |
case 'false': |
| 201 |
case 'none': |
| 202 |
array_push( $argparts, 'tracklist=false' ); |
| 203 |
break; |
| 204 |
} |
| 205 |
|
| 206 |
switch ( $attributes['artwork'] ) { |
| 207 |
case 'false': |
| 208 |
case 'none': |
| 209 |
case 'small': |
| 210 |
array_push( $argparts, 'artwork=' . $attributes['artwork'] ); |
| 211 |
break; |
| 212 |
} |
| 213 |
|
| 214 |
if ( 'true' === $attributes['minimal'] ) { |
| 215 |
array_push( $argparts, 'minimal=true' ); |
| 216 |
} |
| 217 |
|
| 218 |
if ( isset( $attributes['theme'] ) && preg_match( '|^[a-zA-Z_]+$|', $attributes['theme'] ) ) { |
| 219 |
array_push( $argparts, "theme={$attributes['theme']}" ); |
| 220 |
} |
| 221 |
|
| 222 |
// param 'tracks' is signed digest param 'esig'. |
| 223 |
if ( isset( $attributes['tracks'] ) && preg_match( '|^[0-9\,]+$|', $attributes['tracks'] ) ) { |
| 224 |
if ( isset( $attributes['esig'] ) && preg_match( '|^[0-9A-Fa-f]+$|', $attributes['esig'] ) ) { |
| 225 |
array_push( $argparts, "tracks={$attributes['tracks']}" ); |
| 226 |
array_push( $argparts, "esig={$attributes['esig']}" ); |
| 227 |
} |
| 228 |
} |
| 229 |
|
| 230 |
if ( $is_video ) { |
| 231 |
$url = '//bandcamp.com/VideoEmbed?' . join( '&', $argparts ); |
| 232 |
$extra_attrs = " mozallowfullscreen='1' webkitallowfullscreen='1' allowfullscreen='1'"; |
| 233 |
} else { |
| 234 |
$url = '//bandcamp.com/EmbeddedPlayer/v=2/' . join( '/', $argparts ) . '/'; |
| 235 |
$extra_attrs = ''; |
| 236 |
} |
| 237 |
|
| 238 |
$iframe = '<iframe width="%s" height="%s" style="position: relative; display: block; width: %s; height: %s;" src="%s" allowtransparency="true" frameborder="0"%s></iframe>'; |
| 239 |
$iframe = sprintf( $iframe, esc_attr( $width ), esc_attr( $height ), esc_attr( $csswidth ), esc_attr( $cssheight ), esc_url( $url ), $extra_attrs ); |
| 240 |
|
| 241 |
return $iframe; |
| 242 |
} |
| 243 |
|
| 244 |
add_shortcode( 'bandcamp', 'shortcode_handler_bandcamp' ); |
| 245 |
|
