Merge pull request #151 from dshanske/refreshicons1219

Refresh Icons

Author: dshanske

Gruntfile.js

@@ -85,7 +85,7 @@ module.exports = function (grunt) {
 
   grunt.loadNpmTasks('grunt-wp-readme-to-markdown');
   grunt.loadNpmTasks('grunt-wp-i18n');
-  grunt.loadNpmTasks('grunt-sass');
+  grunt.loadNpmTasks('grunt-contrib-sass');
   grunt.loadNpmTasks('grunt-checktextdomain');
   grunt.loadNpmTasks('grunt-execute');
   grunt.loadNpmTasks('grunt-contrib-copy');

includes/class-general-settings.php

@@ -134,15 +134,14 @@ public static function identity_options_callback() {
 		echo '<p>';
 		esc_html_e(
 			'Using rel=me on a link indicates the link represents the same person or entity as
-				the current page. On a site with a single author, rel=me links from their user profile will
-				appear on the homepage. On a site with multiple authors rel=me will appear in the links on the author page only.',
+				the current page. On a site with a single author, links to other profiles from their user profile will
+				appear on the homepage. On a site with multiple authors these links will appear on the author page only.',
 			'indieweb'
 		);
 		echo '</p>';
 		echo '<p>';
 		esc_html_e(
-			'The Default Author is the one whose that will be used on the home pages and archive pages. The default author setting is also used
-			by the IndieAuth plugin to identify the primary author of a site. If the single author setting is not set,
+			'The Default Author is the one whose that will be used on the home pages and archive pages.  If the single author setting is not set,
 				on all other pages, the post author links will be used. To display the links, add the
 				widget, otherwise they will remain hidden. ',
 			'indieweb'

includes/class-hcard-user.php

@@ -72,6 +72,10 @@ public static function silos() {
 				'baseurl' => 'https://www.flickr.com/people/%s',
 				'display' => __( 'Flickr username', 'indieweb' ),
 			),
+			'mastodon'  => array(
+				'baseurl' => '%s',
+				'display' => __( 'Mastodon Server (URL)', 'indieweb' ),
+			),
 		);
 		return apply_filters( 'wp_relme_silos', $silos );
 	}
@@ -160,7 +164,7 @@ public static function extended_user_profile( $user ) {
 		foreach ( self::extra_fields() as $key => $value ) {
 			self::extended_profile_text_field( $user, $key, $value['title'], $value['description'] );
 		}
-		self::extended_profile_textarea_field( $user, 'relme', __( 'Other Sites', 'indieweb' ), __( 'Sites not listed in the profile to add to rel-me (One URL per line)', 'indieweb' ) );
+		self::extended_profile_textarea_field( $user, 'relme', __( 'Other Sites', 'indieweb' ), __( 'Other profiles without their own field in your user profile (One URL per line)', 'indieweb' ) );
 		echo '</table>';
 	}
 
@@ -214,6 +218,7 @@ public static function save_profile( $user_id ) {
 				delete_user_meta( $user_id, 'relme' );
 			}
 		}
+		delete_transient( 'indieweb_mastodon' );
 	}
 
 	/**
@@ -230,7 +235,7 @@ public static function clean_url( $string ) {
 		}
 		// Rewrite these to https as needed
 		$secure = apply_filters( 'iwc_rewrite_secure', array( 'facebook.com', 'twitter.com', 'github.com' ) );
-		if ( in_array( self::extract_domain_name( $url ), $secure, true ) ) {
+		if ( in_array( preg_replace( '/^www\./', '', wp_parse_url( $url, PHP_URL_HOST ) ), $secure, true ) ) {
 			$url = preg_replace( '/^http:/i', 'https:', $url );
 		}
 		$url = esc_url_raw( $url );
@@ -251,104 +256,6 @@ public static function clean_urls( $urls ) {
 		return array_filter( array_unique( $array ) );
 	}
 
-	/**
-	 * Returns the Domain Name out of a URL.
-	 *
-	 * @param string $url URL.
-	 *
-	 * @return string domain name
-	 */
-	public static function extract_domain_name( $url ) {
-		$host = wp_parse_url( $url, PHP_URL_HOST );
-		$host = preg_replace( '/^www\./', '', $host );
-		return $host;
-	}
-
-	// Try to get the correct icon for the majority of sites by dropping
-	public static function split_domain( $string ) {
-		// Strip things we know we dont want. Not every TLD but the common ones in the fontset
-		$unwanted = array( '-', '.com', '.org', '.net', '.io', '.in', '.tv', '.fm', '.social' );
-		// Strip these
-		$string = str_replace( $unwanted, '', $string );
-		// Strip the dot if it is a TLD other than the above
-		$string = str_replace( '.', '', $string );
-		return strtolower( $string );
-	}
-
-	public static function url_to_name( $url ) {
-		$scheme  = wp_parse_url( $url, PHP_URL_SCHEME );
-		$strings = array_keys( simpleicons_iw_get_names() );
-		if ( ( 'http' === $scheme ) || ( 'https' === $scheme ) ) {
-			$domain = self::extract_domain_name( $url );
-			$strip  = self::split_domain( $domain );
-			if ( in_array( $strip, array_keys( $strings ), true ) ) {
-				return $strip;
-			}
-			// Special Cases
-			if ( false !== stripos( $url, 'plus.google.com' ) ) {
-				return 'googleplus';
-			}
-
-			if ( false !== stripos( $url, 'lanyard' ) ) {
-				return 'lanyrd';
-			}
-
-			if ( false !== stripos( $url, 'micro.blog' ) ) {
-				return 'micro-dot-blog';
-			}
-			// Anything with WordPress in the name that is not matched return WordPress
-			if ( false !== stripos( $domain, 'WordPress' ) ) {
-				return 'WordPress';
-			}
-			// Some domains have the word app in them check for matches with that
-			$strip = str_replace( 'app', '', $strip );
-			if ( in_array( $strip, $strings, true ) ) {
-				return $strip;
-			}
-			return apply_filters( 'indieweb_links_url_to_name', 'website', $url );
-		}
-		if ( in_array( $scheme, array_keys( $strings ), true ) ) {
-			return apply_filters( 'indieweb_links_url_to_name', $strings[ $scheme ], $url );
-		}
-		if ( 'sms' === $scheme ) {
-			return 'phone';
-		}
-		if ( 'mailto' === $scheme ) {
-			return 'mail';
-		}
-		if ( 'gtalk' === $scheme ) {
-			return 'googlehangouts';
-		}
-		// Not sure why someone would do a scheme other than web
-		return 'notice';
-	}
-
-	public static function get_title( $name ) {
-		$strings = simpleicons_iw_get_names();
-		if ( isset( $strings[ $name ] ) ) {
-			return $strings[ $name ];
-		}
-		return $name;
-	}
-
-	/**
-	 * Return a marked up SVG icon..
-	 *
-	 * @param string $name name.
-	 *
-	 * @return string svg icon
-	 */
-	public static function get_icon( $name ) {
-		$svg = sprintf( '%1$s/static/svg/%2$s.svg', plugin_dir_path( __DIR__ ), $name );
-		if ( file_exists( $svg ) ) {
-			$icon = file_get_contents( $svg );
-			if ( $icon ) {
-				return sprintf( '<span class="svg-icon svg-%1$s" aria-hidden="true" aria-label="%2$s" title="%2$s" >%3$s</span>', esc_attr( $name ), esc_attr( $name ), $icon );
-			}
-		}
-		return '';
-	}
-
 	/**
 	 * returns an array of links from the user profile to be used as rel-me
 	 */
@@ -389,7 +296,7 @@ public static function get_rel_me( $author_id = null ) {
 			}
 			$relme = self::clean_urls( $relme );
 			foreach ( $relme as $url ) {
-				$list[ self::extract_domain_name( $url ) ] = $url;
+				$list[ preg_replace( '/^www\./', '', wp_parse_url( $url, PHP_URL_HOST ) ) ] = $url;
 			}
 		}
 		return array_unique( $list );
@@ -413,15 +320,11 @@ public static function get_rel_me_list( $author_id = null, $include_rel = false
 		$author_name = get_the_author_meta( 'display_name', $author_id );
 		$r           = array();
 		foreach ( $list as $silo => $profile_url ) {
-			$name = self::url_to_name( $profile_url );
-			if ( in_array( $name, array( 'notice', 'website' ), true ) ) {
-				$title = self::extract_domain_name( $profile_url );
-			} else {
-				$title = self::get_title( $name );
-			}
+			$name       = Rel_Me_Domain_Icon_Map::url_to_name( $profile_url );
+			$title      = Rel_Me_Domain_Icon_Map::get_title( $name );
 			$r[ $silo ] = '<a ' . ( $include_rel ? 'rel="me" ' : '' ) . 'class="icon-' .
 				$silo . ' url u-url" href="' . esc_url( $profile_url ) . '" title="' . esc_attr( $author_name ) . ' @ ' .
-				esc_attr( $title ) . '"><span class="relmename">' . esc_attr( $silo ) . '</span>' . self::get_icon( $name ) . '</a>';
+				esc_attr( $title ) . '"><span class="relmename">' . esc_attr( $silo ) . '</span>' . Rel_Me_Domain_Icon_Map::get_icon( $name ) . '</a>';
 		}
 
 		$r = "<div class='relme'><ul>\n<li>" . join( "</li>\n<li>", $r ) . "</li>\n</ul></div>";

includes/class-plugin-installer.php

@@ -124,11 +124,14 @@ public static function render_template( $plugin, $api, $button_text, $button_cla
 				$icon = $api->icons['default'];
 			}
 
-			$install_url = add_query_arg( array(
-				'action'   => 'install-plugin',
-				'plugin'   => $api->slug,
-				'_wpnonce' => wp_create_nonce( 'install-plugin_' . $api->slug ),
-			), get_admin_url( null, '/update.php' ) );
+			$install_url = add_query_arg(
+				array(
+					'action'   => 'install-plugin',
+					'plugin'   => $api->slug,
+					'_wpnonce' => wp_create_nonce( 'install-plugin_' . $api->slug ),
+				),
+				get_admin_url( null, '/update.php' )
+			);
 			?>
 			<div class="plugin">
 				<div class="plugin-wrap">

includes/class-relme-domain-icon-map.php

@@ -0,0 +1,165 @@
+<?php
+/* Maps domain names to icons from the provided SVG fontset
+ */
+class Rel_Me_Domain_Icon_Map {
+
+	// Common mappings and custom mappings
+	private static $map = array(
+		'twitter.com'         => 'twitter',
+		'facebook.com'        => 'facebook',
+		'swarmapp.com'        => 'swarm',
+		'instagram.com'       => 'instagram',
+		'play.google.com'     => 'googleplay',
+		'plus.google.com'     => 'googleplus',
+		'podcasts.google.com' => 'googlepodcasts',
+		'podcasts.apple.com'  => 'applepodcasts',
+		'indieweb.xyz'        => 'info',
+		'getpocket.com'       => 'pocket',
+		'flip.it'             => 'flipboard',
+		'micro.blog'          => 'micro-dot-blog',
+		'wordpress.org'       => 'wordpress',
+		'wordpress.com'       => 'wordpress',
+		'itunes.apple.com'    => 'applemusic',
+		'reading.am'          => 'book',
+
+	);
+
+	// Try to get the correct icon for the majority of sites
+	public static function split_domain( $string ) {
+		$explode = explode( '.', $string );
+		if ( 2 === count( $explode ) ) {
+			return $explode[0];
+		}
+		if ( 3 === count( $explode ) ) {
+			return $explode[1];
+		}
+		return $string;
+	}
+
+	// Return the filename of an icon based on name if the file exists
+	public static function get_icon_filename( $name ) {
+		$svg = sprintf( '%1$s/static/svg/%2$s.svg', plugin_dir_path( __DIR__ ), $name );
+		if ( file_exists( $svg ) ) {
+			return $svg;
+		}
+		return null;
+	}
+
+	// Return the retrieved svg based on name
+	public static function get_icon_svg( $name ) {
+		$file = self::get_icon_filename( $name );
+		if ( $file ) {
+			$icon = file_get_contents( $file ); // phpcs:ignore
+			if ( $icon ) {
+				return $icon;
+			}
+		}
+		return null;
+	}
+
+	public static function get_icon( $name ) {
+		$icon  = self::get_icon_svg( $name );
+		$title = self::get_title( $name );
+		if ( $icon ) {
+			return sprintf( '<span class="svg-icon svg-%1$s" aria-hidden="true" aria-label="%2$s" title="%2$s" >%3$s</span>', esc_attr( $name ), esc_attr( $title ), $icon );
+		}
+		return $name;
+	}
+
+	public static function get_title( $name ) {
+		$strings = simpleicons_iw_get_names();
+		if ( isset( $strings[ $name ] ) ) {
+			return $strings[ $name ];
+		}
+		return $name;
+	}
+
+	public static function mastodon_url() {
+		$mastodon = get_transient( 'indieweb_mastodon' );
+		if ( false !== $mastodon ) {
+			return $mastodon;
+		}
+		$args    = array(
+			'number'      => 1,
+			'count_total' => false,
+			'meta_query'  => array(
+				array(
+					'key'     => 'mastodon',
+					'compare' => 'EXISTS',
+				),
+			),
+		);
+		$query   = new WP_User_Query( $args );
+		$results = $query->get_results();
+		if ( empty( $results ) ) {
+			$value = false;
+		} else {
+			$user  = $results[0];
+			$value = get_user_meta( $user->ID, 'mastodon', true );
+			if ( ! empty( $value ) && is_string( $value ) ) {
+				$value = wp_parse_url( $value, PHP_URL_HOST );
+			}
+		}
+		set_transient( 'indieweb_mastodon', $value );
+	}
+
+	public static function url_to_name( $url ) {
+		$scheme = wp_parse_url( $url, PHP_URL_SCHEME );
+		// The default if not an http link is to return notice
+		$return = 'notice';
+		if ( ( 'http' === $scheme ) || ( 'https' === $scheme ) ) {
+			$return = 'website'; // default for web links
+			$url    = strtolower( $url );
+			$domain = wp_parse_url( $url, PHP_URL_HOST );
+
+			$domain = str_replace( 'www.', '', $domain ); // Always remove www
+
+			// If the domain is already on the pre-loaded list then use that
+			if ( array_key_exists( $domain, self::$map ) ) {
+				$return = self::$map[ $domain ];
+			} elseif ( self::mastodon_url() === $domain ) {
+				$return = 'mastodon';
+			} else {
+				// Remove extra info and try to map it to an icon
+				$strip = self::split_domain( $domain );
+				if ( self::get_icon_filename( $strip ) ) {
+					$return = $strip;
+				} elseif ( self::get_icon_filename( str_replace( '.', '-dot-', $domain ) ) ) {
+					$return = str_replace( '.', '-dot-', $domain );
+				} elseif ( self::get_icon_filename( str_replace( '.', '', $domain ) ) ) {
+					$return = str_replace( '.', '', $domain );
+				} else if ( false !== stripos( $domain, 'wordpress' ) ) { // phpcs:ignore
+					// Anything with WordPress in the name that is not matched return WordPress
+					$return = 'wordpress'; // phpcs:ignore
+				} else if ( false !== stripos( $domain, 'read' ) ) { // phpcs:ignore
+					// Anything with read in the name that is not matched return a book
+					$return = 'book'; // phpcs:ignore
+				} else if ( false !== stripos( $domain, 'news' ) ) { // phpcs:ignore
+					// Anything with news in the name that is not matched return the summary icon
+					$return = 'summary'; // phpcs:ignore
+				} else {
+					// Some domains have the word app in them check for matches with that
+					$strip = str_replace( 'app', '', $strip );
+					if ( self::get_icon_filename( $strip ) ) {
+						$return = $strip;
+					}
+				}
+			}
+		}
+		if ( 'sms' === $scheme ) {
+			return 'phone';
+		}
+		if ( 'mailto' === $scheme ) {
+			return 'mail';
+		}
+		if ( 'gtalk' === $scheme ) {
+			return 'googlehangouts';
+		}
+		// Save the determined mapping into the map so that it will not have to look again on the same page load
+		self::$map[ $domain ] = $return;
+		$return               = apply_filters( 'indieweb_links_url_to_name', $return, $url );
+		return $return;
+	}
+
+}
+

includes/class-relme-widget.php

@@ -11,7 +11,7 @@ class RelMe_Widget extends WP_Widget {
 	public function __construct() {
 		parent::__construct(
 			'RelMe_Widget',
-			__( 'Rel=Me Links', 'indieweb' ),
+			__( 'Show My Profiles on Other Sites', 'indieweb' ),
 			array(
 				'description' => __( 'Adds automatic rel-me URLs based on default author profile information. Rel=me links are links to your presence on other websites and visually appear like many social link widgets', 'indieweb' ),
 			)