Merge pull request #13 from samwilson/commons-captions

Use structured data captions for Commons files
samwilson · Oct 19, 2019 · c7cad97 · c7cad97
2 parents d170beb + 9bcfb65
commit c7cad97
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 14 deletions.
diff --git a/resources/blocks.js b/resources/blocks.js
@@ -57,7 +57,7 @@
 				isDefault: true,
 				onClick: function () {
 					props.setAttributes( { embed_html: i18n.__( 'Loading...' ) } );
-					var apiUrl = '/embed-wikimedia/v1/commons/' + encodeURI( props.attributes.filename ) + '?width=700';
+					var apiUrl = '/embed-wikimedia/v1/commons/File:' + encodeURI( props.attributes.filename ) + '?width=700';
 					fetchEmbedHtml( apiUrl, props );
 				}
 			},

diff --git a/src/Commons.php b/src/Commons.php
@@ -33,32 +33,76 @@ public function embed( $matches, $attr, $url, $rawattr ) {
 
 	/**
 	 * {@inheritDoc}
+	 *
+	 * @param string $title The file title from the URL, with 'File:' at the beginning.
 	 */
 	public function html( $title, $attrs = [] ) {
+		// Get basic file information from Commons.
+		$info_url_format   = 'https://commons.wikimedia.org/w/api.php?action=query&format=json&prop=info&inprop=url&titles=%s';
+		$info_url          = sprintf( $info_url_format, str_replace( ' ', '_', wp_unslash( $title ) ) );
+		$image_info_result = $this->get_data( $info_url );
+		if ( ! isset( $image_info_result['query'] ) || ! isset( $image_info_result['query']['pages'] ) ) {
+			// translators: Error message shown when unable to retrieve Commons API data.
+			$msg_format = __( 'Unable to fetch file information for: %s', 'embed-wikimedia' );
+			return '<p class="error">' . sprintf( $msg_format, $title ) . '</p>';
+		}
+		$image_info = array_shift( $image_info_result['query']['pages'] );
+		$file_url   = $image_info['canonicalurl'];
+		$file_title = substr( wp_unslash( $image_info['title'] ), strlen( 'File:' ) );
+		$file_name  = str_replace( ' ', '_', $file_title );
+
+		// First get data from the commonsapi tool. The 'image' param must not have a File prefix.
 		$url_format = 'https://tools.wmflabs.org/magnus-toolserver/commonsapi.php?image=%s&thumbwidth=%s';
-		$rest_url   = sprintf( $url_format, $title, $attrs['width'] );
+		$rest_url   = sprintf( $url_format, $file_name, $attrs['width'] );
+
 		try {
 			$info = $this->get_data( $rest_url, 'xml' );
 		} catch ( Exception $exception ) {
 			return '<p class="error">' . $exception->getMessage() . '</p>';
 		}
-		$link_format = '<a href="%s"><img src="%s" alt="%s" /></a>';
 		if ( isset( $info['error'] ) ) {
 			return '<p class="error">' . $info['error'] . '</p>';
 		}
-		$url           = 'https://commons.wikimedia.org/wiki/File:' . $title;
-		$img_link      = sprintf( $link_format, $url, $info['file']['urls']['thumbnail'], $info['file']['name'] );
-		$date          = isset( $info['file']['date'] ) && ! is_array( $info['file']['date'] ) ? $info['file']['date'] : '';
-		$author        = isset( $info['file']['author'] ) ? $info['file']['author'] : '';
-		$license       = isset( $info['licenses']['license'][0] ) ? $info['licenses']['license'][0] : $info['licenses']['license'];
-		$description   = isset( $info['description']['language'] ) ? $info['description']['language'] : '';
-		$caption       = sprintf(
-			'%1$s (%2$s) by %3$s, %4$s. %5$s',
-			$info['file']['title'],
+
+		// Then see if there's a caption.
+		$media_url_pattern = 'https://commons.wikimedia.org/w/api.php?action=wbgetentities&format=json&ids=%s';
+		$media_id          = 'M' . $image_info['pageid'];
+		$media_info_result = $this->get_data( sprintf( $media_url_pattern, $media_id ) );
+		$description       = '';
+		if ( isset( $media_info_result['entities'] ) && count( $media_info_result['entities'] ) >= 1 ) {
+			$entity = array_shift( $media_info_result['entities'] );
+			// @TODO Handle language fallbacks more correctly.
+			$lang_code      = get_bloginfo( 'language' );
+			$base_lang_code = substr( $lang_code, 0, strpos( $lang_code, '-' ) );
+			$lang_codes     = [ $lang_code, $base_lang_code, 'en' ];
+			foreach ( $lang_codes as $code ) {
+				if ( isset( $entity['labels'][ $code ]['value'] ) ) {
+					$description = $entity['labels'][ $code ]['value'];
+					break;
+				}
+			}
+		}
+		if ( '' === $description
+			&& isset( $info['description']['language'] ) && ! is_array( $info['description']['language'] )
+		) {
+			$description = $info['description']['language'];
+		}
+
+		// Put it all together.
+		$link_format = '<a href="%s"><img src="%s" alt="%s" /></a>';
+		$img_link    = sprintf( $link_format, $file_url, $info['file']['urls']['thumbnail'], $file_name );
+		$date        = isset( $info['file']['date'] ) && ! is_array( $info['file']['date'] ) ? $info['file']['date'] : '';
+		$author      = isset( $info['file']['author'] ) ? $info['file']['author'] : '';
+		$license     = isset( $info['licenses']['license'][0] ) ? $info['licenses']['license'][0] : $info['licenses']['license'];
+		$caption     = sprintf(
+			// translators: Format for the Commons image caption. 1: caption; 2: Commons URL; 3: Commons file title; 4: date; 5: author; 6: license code.
+			__( '%1$s &mdash; <a href="%2$s">%3$s</a> (%4$s) by %5$s, %6$s.', 'embed-wikimedia' ),
+			$description,
+			$file_url,
+			$file_title,
 			$date,
 			$author,
-			$license['name'],
-			$description
+			$license['name']
 		);
 		$caption_attrs = [
 			'caption' => $caption,