Inspection of "Add unit testing" - mprins/dokuwiki-plugin-socialcards - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#19)

by Mark

created 2016-04-23 18:01 UTC

Status

Spacing +5 added lines, -5 removed lines patch added patch discarded remove patch

@@ -15,7 +15,7 @@  discard block
 block discarded – undo
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-if (!defined('DOKU_INC')){
+if (!defined('DOKU_INC')) {
 	die();
 }
 if (!defined('DOKU_PLUGIN')) {
@@ -23,7 +23,7 @@  discard block
 block discarded – undo
 }
 
 require_once DOKU_PLUGIN . 'action.php';
-require_once(DOKU_INC.'inc/JpegMeta.php');
+require_once(DOKU_INC . 'inc/JpegMeta.php');
 /**
  * DokuWiki Plugin socialcards (Action Component).
  *
@@ -194,7 +194,7 @@  discard block
 block discarded – undo
 
 		if (empty($img)) {
 			$img = $this->getConf('fallbackImage');
-			if (substr($img, 0, 4 ) === "http") {
+			if (substr($img, 0, 4) === "http") {
 				// don't use ml() as this results in a HTTP redirect after hitting the wiki
 				return $img;
 			}
@@ -216,7 +216,7 @@  discard block
 block discarded – undo
 		$alt = "";
 
 		if (!empty($imgID)) {
-			require_once(DOKU_INC.'inc/JpegMeta.php');
+			require_once(DOKU_INC . 'inc/JpegMeta.php');
 			$jpegmeta = new JpegMeta(mediaFN($imgID));
 			$tags = array('IPTC.Caption',
 							'EXIF.UserComment',
@@ -225,7 +225,7 @@  discard block
 block discarded – undo
 							'IPTC.Headline',
 							'Xmp.dc:title'
 							);
-			$alt = media_getTag( $tags,$jpegmeta,"");
+			$alt = media_getTag($tags, $jpegmeta, "");
 		}
 		return htmlspecialchars($alt);
 	}

Please login to merge, or discard this patch.

Indentation +190 added lines, -190 removed lines patch added patch discarded remove patch

@@ -16,10 +16,10 @@  discard block
 block discarded – undo
  */
 
 if (!defined('DOKU_INC')){
-	die();
+    die();
 }
 if (!defined('DOKU_PLUGIN')) {
-	define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
+    define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
 }
 
 require_once DOKU_PLUGIN . 'action.php';
@@ -32,138 +32,138 @@  discard block
 block discarded – undo
  */
 class action_plugin_socialcards extends DokuWiki_Action_Plugin {
 
-	/**
-	 * Register our callback for the TPL_METAHEADER_OUTPUT event.
-	 *
-	 * @param $controller Doku_Event_Handler
-	 * @see DokuWiki_Action_Plugin::register()
-	 */
-	public function register(Doku_Event_Handler $controller) {
-		$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this,
-				'handle_tpl_metaheader_output');
-	}
-
-	/**
-	 * Retrieve metadata and add to the head of the page using appropriate meta
-	 * tags unless the page does not exist.
-	 *
-	 * @global string $ID page id
-	 * @global array $conf global wiki configuration
-	 * @global array $INFO
-	 * @param Doku_Event $event the DokuWiki event. $event->data is a two-dimensional
-	 *             array of all meta headers. The keys are meta, link and script.
-	 * @param mixed $param the parameters passed to register_hook when this
-	 *             handler was registered (not used)
-	 *
-	 * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
-	 */
-	public function handle_tpl_metaheader_output(Doku_Event $event, $param) {
-		global $ID, $conf, $INFO;
-
-		if (!page_exists($ID)) { return; }
-
-		// twitter card, see https://dev.twitter.com/cards/markup
-		// creat a summary card, see https://dev.twitter.com/cards/types/summary
-		$event->data['meta'][] = array('name' => 'twitter:card',
-				'content' => "summary",);
-
-		$event->data['meta'][] = array('name' => 'twitter:site',
-				'content' => $this->getConf('twitterName'),);
-
-		$event->data['meta'][] = array('name' => 'twitter:title',
-				'content' => p_get_metadata($ID, 'title', true),);
-
-		$desc = p_get_metadata($ID, 'description', true);
-		if (!empty($desc)) {
-			$desc = str_replace("\n", " ", $desc['abstract']);
-			$event->data['meta'][] = array('name' => 'twitter:description',
-					'content' => $desc,);
-		}
-
-		if ($this->getConf('twitterUserName') != '') {
-			$event->data['meta'][] = array('name' => 'twitter:creator',
-				'content' => $this->getConf('twitterUserName'),);
-		}
-
-		$event->data['meta'][] = array('name' => 'twitter:image',
-				'content' => $this->getImage(),);
-		$event->data['meta'][] = array('name' => 'twitter:image:alt',
-				'content' => $this->getImageAlt(),);
-
-		// opengraph, see http://ogp.me/
-		//
-		// to make this work properly the template should be modified adding the
-		// namespaces for a (x)html 4 template make html tag:
-		//
-		// <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="nl" lang="nl"
-		//       xmlns:og="http://ogp.me/ns#" xmlns:fb="http://ogp.me/ns/fb#"
-		//       xmlns:article="http://ogp.me/ns/article#" xmlns:place="http://ogp.me/ns/place#">
-		//
-		// and for a (x)html 5 template make head tag:
-		//
-		// <head prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb# article: http://ogp.me/ns/article# place: http://ogp.me/ns/place#">
-
-		// og namespace http://ogp.me/ns#
-		$event->data['meta'][] = array('property' => 'og:locale',
-				'content' => $this->getConf('languageTerritory'),);
-		$event->data['meta'][] = array('property' => 'og:site_name',
-				'content' => $conf['title'],);
-		$event->data['meta'][] = array('property' => 'og:url',
-				'content' => wl($ID, '', true),);
-		$event->data['meta'][] = array('property' => 'og:title',
-				'content' => p_get_metadata($ID, 'title', true),);
-		if (!empty($desc)) {
-			$event->data['meta'][] = array('property' => 'og:description',
-					'content' => $desc,);
-		}
-		$event->data['meta'][] = array('property' => 'og:type',
-				'content' => "article",);
-		$ogImage = $this->getImage();
-		$secure = substr($ogImage, 0, 5) === 'https' ? ':secure_url' : '';
-		$event->data['meta'][] = array('property' => 'og:image' . $secure,
-				'content' => $ogImage,);
-
-		// article namespace http://ogp.me/ns/article#
-		$_dates = p_get_metadata($ID, 'date', true);
-		$event->data['meta'][] = array('property' => 'article:published_time',
-				'content' => dformat($_dates['created']),);
-		$event->data['meta'][] = array('property' => 'article:modified_time',
-				'content' => dformat($_dates['modified']),);
-		$event->data['meta'][] = array('property' => 'article:author',
-				'content' => $INFO['editor'],);
-		// $event->data['meta'][] = array('property' => 'article:author','content' => p_get_metadata($ID,'creator',true),);
-		// $event->data['meta'][] = array('property' => 'article:author','content' => p_get_metadata($ID,'user',true),);
-		$_subject = p_get_metadata($ID, 'subject', true);
-		if (!empty($_subject)) {
-			if (!is_array($_subject)) {
-				$_subject = array($_subject);
-			}
-			foreach ($_subject as $tag) {
-				$event->data['meta'][] = array('property' => 'article:tag',
-						'content' => $tag,);
-			}
-		}
-
-		// place namespace http://ogp.me/ns/place#
-		$geotags = p_get_metadata($ID, 'geo', true);
-		$lat = $geotags['lat'];
-		$lon = $geotags['lon'];
-		if (!(empty($lat) && empty($lon))) {
-			$event->data['meta'][] = array('property' => 'place:location:latitude',
-					'content' => $lat,);
-			$event->data['meta'][] = array('property' => 'place:location:longitude',
-					'content' => $lon,);
-		}
-		// see https://developers.facebook.com/docs/opengraph/property-types/#geopoint
-		$alt = $geotags['alt'];
-		if (!empty($alt)) {
-			// facebook expects feet...
-			$alt = $alt * 3.2808;
-			$event->data['meta'][] = array('property' => 'place:location:altitude',
-					'content' => $alt,);
-		}
-
-		/* these are not valid for the GeoPoint type..
+    /**
+     * Register our callback for the TPL_METAHEADER_OUTPUT event.
+     *
+     * @param $controller Doku_Event_Handler
+     * @see DokuWiki_Action_Plugin::register()
+     */
+    public function register(Doku_Event_Handler $controller) {
+        $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this,
+                'handle_tpl_metaheader_output');
+    }
+
+    /**
+     * Retrieve metadata and add to the head of the page using appropriate meta
+     * tags unless the page does not exist.
+     *
+     * @global string $ID page id
+     * @global array $conf global wiki configuration
+     * @global array $INFO
+     * @param Doku_Event $event the DokuWiki event. $event->data is a two-dimensional
+     *             array of all meta headers. The keys are meta, link and script.
+     * @param mixed $param the parameters passed to register_hook when this
+     *             handler was registered (not used)
+     *
+     * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
+     */
+    public function handle_tpl_metaheader_output(Doku_Event $event, $param) {
+        global $ID, $conf, $INFO;
+
+        if (!page_exists($ID)) { return; }
+
+        // twitter card, see https://dev.twitter.com/cards/markup
+        // creat a summary card, see https://dev.twitter.com/cards/types/summary
+        $event->data['meta'][] = array('name' => 'twitter:card',
+                'content' => "summary",);
+
+        $event->data['meta'][] = array('name' => 'twitter:site',
+                'content' => $this->getConf('twitterName'),);
+
+        $event->data['meta'][] = array('name' => 'twitter:title',
+                'content' => p_get_metadata($ID, 'title', true),);
+
+        $desc = p_get_metadata($ID, 'description', true);
+        if (!empty($desc)) {
+            $desc = str_replace("\n", " ", $desc['abstract']);
+            $event->data['meta'][] = array('name' => 'twitter:description',
+                    'content' => $desc,);
+        }
+
+        if ($this->getConf('twitterUserName') != '') {
+            $event->data['meta'][] = array('name' => 'twitter:creator',
+                'content' => $this->getConf('twitterUserName'),);
+        }
+
+        $event->data['meta'][] = array('name' => 'twitter:image',
+                'content' => $this->getImage(),);
+        $event->data['meta'][] = array('name' => 'twitter:image:alt',
+                'content' => $this->getImageAlt(),);
+
+        // opengraph, see http://ogp.me/
+        //
+        // to make this work properly the template should be modified adding the
+        // namespaces for a (x)html 4 template make html tag:
+        //
+        // <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="nl" lang="nl"
+        //       xmlns:og="http://ogp.me/ns#" xmlns:fb="http://ogp.me/ns/fb#"
+        //       xmlns:article="http://ogp.me/ns/article#" xmlns:place="http://ogp.me/ns/place#">
+        //
+        // and for a (x)html 5 template make head tag:
+        //
+        // <head prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb# article: http://ogp.me/ns/article# place: http://ogp.me/ns/place#">
+
+        // og namespace http://ogp.me/ns#
+        $event->data['meta'][] = array('property' => 'og:locale',
+                'content' => $this->getConf('languageTerritory'),);
+        $event->data['meta'][] = array('property' => 'og:site_name',
+                'content' => $conf['title'],);
+        $event->data['meta'][] = array('property' => 'og:url',
+                'content' => wl($ID, '', true),);
+        $event->data['meta'][] = array('property' => 'og:title',
+                'content' => p_get_metadata($ID, 'title', true),);
+        if (!empty($desc)) {
+            $event->data['meta'][] = array('property' => 'og:description',
+                    'content' => $desc,);
+        }
+        $event->data['meta'][] = array('property' => 'og:type',
+                'content' => "article",);
+        $ogImage = $this->getImage();
+        $secure = substr($ogImage, 0, 5) === 'https' ? ':secure_url' : '';
+        $event->data['meta'][] = array('property' => 'og:image' . $secure,
+                'content' => $ogImage,);
+
+        // article namespace http://ogp.me/ns/article#
+        $_dates = p_get_metadata($ID, 'date', true);
+        $event->data['meta'][] = array('property' => 'article:published_time',
+                'content' => dformat($_dates['created']),);
+        $event->data['meta'][] = array('property' => 'article:modified_time',
+                'content' => dformat($_dates['modified']),);
+        $event->data['meta'][] = array('property' => 'article:author',
+                'content' => $INFO['editor'],);
+        // $event->data['meta'][] = array('property' => 'article:author','content' => p_get_metadata($ID,'creator',true),);
+        // $event->data['meta'][] = array('property' => 'article:author','content' => p_get_metadata($ID,'user',true),);
+        $_subject = p_get_metadata($ID, 'subject', true);
+        if (!empty($_subject)) {
+            if (!is_array($_subject)) {
+                $_subject = array($_subject);
+            }
+            foreach ($_subject as $tag) {
+                $event->data['meta'][] = array('property' => 'article:tag',
+                        'content' => $tag,);
+            }
+        }
+
+        // place namespace http://ogp.me/ns/place#
+        $geotags = p_get_metadata($ID, 'geo', true);
+        $lat = $geotags['lat'];
+        $lon = $geotags['lon'];
+        if (!(empty($lat) && empty($lon))) {
+            $event->data['meta'][] = array('property' => 'place:location:latitude',
+                    'content' => $lat,);
+            $event->data['meta'][] = array('property' => 'place:location:longitude',
+                    'content' => $lon,);
+        }
+        // see https://developers.facebook.com/docs/opengraph/property-types/#geopoint
+        $alt = $geotags['alt'];
+        if (!empty($alt)) {
+            // facebook expects feet...
+            $alt = $alt * 3.2808;
+            $event->data['meta'][] = array('property' => 'place:location:altitude',
+                    'content' => $alt,);
+        }
+
+        /* these are not valid for the GeoPoint type..
 
 		$region=$geotags['region'];
 		$country=$geotags['country'];
@@ -173,61 +173,61 @@  discard block
 block discarded – undo
 		if (!empty($country))   {$event->data['meta'][] = array('property' => 'place:location:country-name','content' => $country,);}
 		*/
 
-		// optional facebook app ID
-		$appId = $this->getConf('fbAppId');
-		if (!empty($appId)) {
-			$event->data['meta'][] = array('property' => 'fb:app_id',
-					'content' => $appId,);
-		}
-	}
-
-	/**
-	 * Gets the canonical image path for this page.
-	 *
-	 * @global string $ID page id
-	 * @return string the url to the image to use for this page
-	 */
-	private function getImage() {
-		global $ID;
-		$rel = p_get_metadata($ID, 'relation', true);
-		$img = $rel['firstimage'];
-
-		if (empty($img)) {
-			$img = $this->getConf('fallbackImage');
-			if (substr($img, 0, 4 ) === "http") {
-				// don't use ml() as this results in a HTTP redirect after hitting the wiki
-				return $img;
-			}
-		}
-
-		return ml($img, array(), true, '&amp;', true);
-	}
-
-	/**
-	 * Gets the alt text for this page image.
-	 *
-	 * @global string $ID page id
-	 * @return string alt text
-	 */
-	private function getImageAlt() {
-		global $ID;
-		$rel = p_get_metadata($ID, 'relation', true);
-		$imgID = $rel['firstimage'];
-		$alt = "";
-
-		if (!empty($imgID)) {
-			require_once(DOKU_INC.'inc/JpegMeta.php');
-			$jpegmeta = new JpegMeta(mediaFN($imgID));
-			$tags = array('IPTC.Caption',
-							'EXIF.UserComment',
-							'EXIF.TIFFImageDescription',
-							'EXIF.TIFFUserComment',
-							'IPTC.Headline',
-							'Xmp.dc:title'
-							);
-			$alt = media_getTag( $tags,$jpegmeta,"");
-		}
-		return htmlspecialchars($alt);
-	}
+        // optional facebook app ID
+        $appId = $this->getConf('fbAppId');
+        if (!empty($appId)) {
+            $event->data['meta'][] = array('property' => 'fb:app_id',
+                    'content' => $appId,);
+        }
+    }
+
+    /**
+     * Gets the canonical image path for this page.
+     *
+     * @global string $ID page id
+     * @return string the url to the image to use for this page
+     */
+    private function getImage() {
+        global $ID;
+        $rel = p_get_metadata($ID, 'relation', true);
+        $img = $rel['firstimage'];
+
+        if (empty($img)) {
+            $img = $this->getConf('fallbackImage');
+            if (substr($img, 0, 4 ) === "http") {
+                // don't use ml() as this results in a HTTP redirect after hitting the wiki
+                return $img;
+            }
+        }
+
+        return ml($img, array(), true, '&amp;', true);
+    }
+
+    /**
+     * Gets the alt text for this page image.
+     *
+     * @global string $ID page id
+     * @return string alt text
+     */
+    private function getImageAlt() {
+        global $ID;
+        $rel = p_get_metadata($ID, 'relation', true);
+        $imgID = $rel['firstimage'];
+        $alt = "";
+
+        if (!empty($imgID)) {
+            require_once(DOKU_INC.'inc/JpegMeta.php');
+            $jpegmeta = new JpegMeta(mediaFN($imgID));
+            $tags = array('IPTC.Caption',
+                            'EXIF.UserComment',
+                            'EXIF.TIFFImageDescription',
+                            'EXIF.TIFFUserComment',
+                            'IPTC.Headline',
+                            'Xmp.dc:title'
+                            );
+            $alt = media_getTag( $tags,$jpegmeta,"");
+        }
+        return htmlspecialchars($alt);
+    }
 
 }

Please login to merge, or discard this patch.

conf/metadata.php 1 patch

Spacing +5 added lines, -5 removed lines patch added patch discarded remove patch

@@ -21,8 +21,8 @@
 block discarded – undo
  * @license BSD license
  * @author  Mark C. Prins <[email protected]>
  */
-$meta['twitterName'] = array ('string');
-$meta['twitterUserName'] = array ('string');
-$meta['fallbackImage'] = array ('string');
-$meta['languageTerritory'] = array ('multichoice','_choices' => array('be_BY','bn_IN','cs_CZ','da_DK','de_CH','de_DE','el_GR','en_AU','en_CA','en_GB','en_HK','en_IN','en_NZ','en_PH','en_SG','en_US','en_ZA','es_AR','es_BO','es_CL','es_CO','es_CR','es_DO','es_EC','es_ES','es_GT','es_HN','es_MX','es_NI','es_PA','es_PE','es_PR','es_PY','es_SV','es_US','es_UY','es_VE','fi_FI','fr_BE','fr_CA','fr_CH','fr_FR','gu_IN','he_IL','hi_IN','hr_HR','hu_HU','id_ID','it_CH','it_IT','iw_IL','ja_JP','kk_KZ','ko_KR','mr_IN','ms_MY','nl_NL','no_NO','pa_IN','pl_PL','pt_BR','pt_PT','ro_RO','ru_RU','sk_SK','sl_SI','sv_SE','ta_IN','te_IN','th_TH','tr_TR','zh_CN','zh_HKS','zh_HKT','zh_SGS','zh_TW'));
-$meta['fbAppId'] = array ('string');
+$meta['twitterName'] = array('string');
+$meta['twitterUserName'] = array('string');
+$meta['fallbackImage'] = array('string');
+$meta['languageTerritory'] = array('multichoice', '_choices' => array('be_BY', 'bn_IN', 'cs_CZ', 'da_DK', 'de_CH', 'de_DE', 'el_GR', 'en_AU', 'en_CA', 'en_GB', 'en_HK', 'en_IN', 'en_NZ', 'en_PH', 'en_SG', 'en_US', 'en_ZA', 'es_AR', 'es_BO', 'es_CL', 'es_CO', 'es_CR', 'es_DO', 'es_EC', 'es_ES', 'es_GT', 'es_HN', 'es_MX', 'es_NI', 'es_PA', 'es_PE', 'es_PR', 'es_PY', 'es_SV', 'es_US', 'es_UY', 'es_VE', 'fi_FI', 'fr_BE', 'fr_CA', 'fr_CH', 'fr_FR', 'gu_IN', 'he_IL', 'hi_IN', 'hr_HR', 'hu_HU', 'id_ID', 'it_CH', 'it_IT', 'iw_IL', 'ja_JP', 'kk_KZ', 'ko_KR', 'mr_IN', 'ms_MY', 'nl_NL', 'no_NO', 'pa_IN', 'pl_PL', 'pt_BR', 'pt_PT', 'ro_RO', 'ru_RU', 'sk_SK', 'sl_SI', 'sv_SE', 'ta_IN', 'te_IN', 'th_TH', 'tr_TR', 'zh_CN', 'zh_HKS', 'zh_HKT', 'zh_SGS', 'zh_TW'));
+$meta['fbAppId'] = array('string');

Please login to merge, or discard this patch.

_test/general.test.php 1 patch

Spacing +1 added lines, -1 removed lines patch added patch discarded remove patch

@@ -11,7 +11,7 @@
 block discarded – undo
      * Simple test to make sure the plugin.info.txt is in correct format
      */
     public function test_plugininfo() {
-        $file = __DIR__.'/../plugin.info.txt';
+        $file = __DIR__ . '/../plugin.info.txt';
         $this->assertFileExists($file);
 
         $info = confToHash($file);

Please login to merge, or discard this patch.

_test/action.test.php 2 patches

Indentation +2 added lines, -2 removed lines patch added patch discarded remove patch

@@ -23,9 +23,9 @@
 block discarded – undo
  */
 class action_plugin_socialcards_test extends DokuWikiTest {
 
-   protected $pluginsEnabled = array('socialcards');
+    protected $pluginsEnabled = array('socialcards');
 
-   function setUp(){
+    function setUp(){
         global $conf;
 
         parent::setUp();

Please login to merge, or discard this patch.

Spacing +2 added lines, -2 removed lines patch added patch discarded remove patch

@@ -25,7 +25,7 @@  discard block
 block discarded – undo
 
    protected $pluginsEnabled = array('socialcards');
 
-   function setUp(){
+   function setUp() {
         global $conf;
 
         parent::setUp();
@@ -39,7 +39,7 @@  discard block
 block discarded – undo
 
     public function testHeaders() {
         $request = new TestRequest();
-        $response = $request->get(array('id'=>'wiki:dokuwiki'),'/doku.php');
+        $response = $request->get(array('id'=>'wiki:dokuwiki'), '/doku.php');
 
         print_r($response);
 

Please login to merge, or discard this patch.

		@@ -25,7 +25,7 @@ discard block
		block discarded – undo
25	25
26	26	protected $pluginsEnabled = array('socialcards');
27	27
28		- function setUp(){
	28	+ function setUp() {
29	29	global $conf;
30	30
31	31	parent::setUp();
		@@ -39,7 +39,7 @@ discard block
		block discarded – undo
39	39
40	40	public function testHeaders() {
41	41	$request = new TestRequest();
42		- $response = $request->get(array('id'=>'wiki:dokuwiki'),'/doku.php');
	42	+ $response = $request->get(array('id'=>'wiki:dokuwiki'), '/doku.php');
43	43
44	44	print_r($response);
45	45

		@@ -15,7 +15,7 @@ discard block
		block discarded – undo
15	15	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16	16	*/
17	17
18		-if (!defined('DOKU_INC')){
	18	+if (!defined('DOKU_INC')) {
19	19	die();
20	20	}
21	21	if (!defined('DOKU_PLUGIN')) {
		@@ -23,7 +23,7 @@ discard block
		block discarded – undo
23	23	}
24	24
25	25	require_once DOKU_PLUGIN . 'action.php';
26		-require_once(DOKU_INC.'inc/JpegMeta.php');
	26	+require_once(DOKU_INC . 'inc/JpegMeta.php');
27	27	/**
28	28	* DokuWiki Plugin socialcards (Action Component).
29	29	*
		@@ -194,7 +194,7 @@ discard block
		block discarded – undo
194	194
195	195	if (empty($img)) {
196	196	$img = $this->getConf('fallbackImage');
197		- if (substr($img, 0, 4 ) === "http") {
	197	+ if (substr($img, 0, 4) === "http") {
198	198	// don't use ml() as this results in a HTTP redirect after hitting the wiki
199	199	return $img;
200	200	}
		@@ -216,7 +216,7 @@ discard block
		block discarded – undo
216	216	$alt = "";
217	217
218	218	if (!empty($imgID)) {
219		- require_once(DOKU_INC.'inc/JpegMeta.php');
	219	+ require_once(DOKU_INC . 'inc/JpegMeta.php');
220	220	$jpegmeta = new JpegMeta(mediaFN($imgID));
221	221	$tags = array('IPTC.Caption',
222	222	'EXIF.UserComment',
		@@ -225,7 +225,7 @@ discard block
		block discarded – undo
225	225	'IPTC.Headline',
226	226	'Xmp.dc:title'
227	227	);
228		- $alt = media_getTag( $tags,$jpegmeta,"");
	228	+ $alt = media_getTag($tags, $jpegmeta, "");
229	229	}
230	230	return htmlspecialchars($alt);
231	231	}

		@@ -16,10 +16,10 @@ discard block
		block discarded – undo
16	16	*/
17	17
18	18	if (!defined('DOKU_INC')){
19		- die();
	19	+ die();
20	20	}
21	21	if (!defined('DOKU_PLUGIN')) {
22		- define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
	22	+ define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
23	23	}
24	24
25	25	require_once DOKU_PLUGIN . 'action.php';
		@@ -32,138 +32,138 @@ discard block
		block discarded – undo
32	32	*/
33	33	class action_plugin_socialcards extends DokuWiki_Action_Plugin {
34	34
35		- /**
36		- * Register our callback for the TPL_METAHEADER_OUTPUT event.
37		- *
38		- * @param $controller Doku_Event_Handler
39		- * @see DokuWiki_Action_Plugin::register()
40		- */
41		- public function register(Doku_Event_Handler $controller) {
42		- $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this,
43		- 'handle_tpl_metaheader_output');
44		- }
45		-
46		- /**
47		- * Retrieve metadata and add to the head of the page using appropriate meta
48		- * tags unless the page does not exist.
49		- *
50		- * @global string $ID page id
51		- * @global array $conf global wiki configuration
52		- * @global array $INFO
53		- * @param Doku_Event $event the DokuWiki event. $event->data is a two-dimensional
54		- * array of all meta headers. The keys are meta, link and script.
55		- * @param mixed $param the parameters passed to register_hook when this
56		- * handler was registered (not used)
57		- *
58		- * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
59		- */
60		- public function handle_tpl_metaheader_output(Doku_Event $event, $param) {
61		- global $ID, $conf, $INFO;
62		-
63		- if (!page_exists($ID)) { return; }
64		-
65		- // twitter card, see https://dev.twitter.com/cards/markup
66		- // creat a summary card, see https://dev.twitter.com/cards/types/summary
67		- $event->data['meta'][] = array('name' => 'twitter:card',
68		- 'content' => "summary",);
69		-
70		- $event->data['meta'][] = array('name' => 'twitter:site',
71		- 'content' => $this->getConf('twitterName'),);
72		-
73		- $event->data['meta'][] = array('name' => 'twitter:title',
74		- 'content' => p_get_metadata($ID, 'title', true),);
75		-
76		- $desc = p_get_metadata($ID, 'description', true);
77		- if (!empty($desc)) {
78		- $desc = str_replace("\n", " ", $desc['abstract']);
79		- $event->data['meta'][] = array('name' => 'twitter:description',
80		- 'content' => $desc,);
81		- }
82		-
83		- if ($this->getConf('twitterUserName') != '') {
84		- $event->data['meta'][] = array('name' => 'twitter:creator',
85		- 'content' => $this->getConf('twitterUserName'),);
86		- }
87		-
88		- $event->data['meta'][] = array('name' => 'twitter:image',
89		- 'content' => $this->getImage(),);
90		- $event->data['meta'][] = array('name' => 'twitter:image:alt',
91		- 'content' => $this->getImageAlt(),);
92		-
93		- // opengraph, see http://ogp.me/
94		- //
95		- // to make this work properly the template should be modified adding the
96		- // namespaces for a (x)html 4 template make html tag:
97		- //
98		- // <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="nl" lang="nl"
99		- // xmlns:og="http://ogp.me/ns#" xmlns:fb="http://ogp.me/ns/fb#"
100		- // xmlns:article="http://ogp.me/ns/article#" xmlns:place="http://ogp.me/ns/place#">
101		- //
102		- // and for a (x)html 5 template make head tag:
103		- //
104		- // <head prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb# article: http://ogp.me/ns/article# place: http://ogp.me/ns/place#">
105		-
106		- // og namespace http://ogp.me/ns#
107		- $event->data['meta'][] = array('property' => 'og:locale',
108		- 'content' => $this->getConf('languageTerritory'),);
109		- $event->data['meta'][] = array('property' => 'og:site_name',
110		- 'content' => $conf['title'],);
111		- $event->data['meta'][] = array('property' => 'og:url',
112		- 'content' => wl($ID, '', true),);
113		- $event->data['meta'][] = array('property' => 'og:title',
114		- 'content' => p_get_metadata($ID, 'title', true),);
115		- if (!empty($desc)) {
116		- $event->data['meta'][] = array('property' => 'og:description',
117		- 'content' => $desc,);
118		- }
119		- $event->data['meta'][] = array('property' => 'og:type',
120		- 'content' => "article",);
121		- $ogImage = $this->getImage();
122		- $secure = substr($ogImage, 0, 5) === 'https' ? ':secure_url' : '';
123		- $event->data['meta'][] = array('property' => 'og:image' . $secure,
124		- 'content' => $ogImage,);
125		-
126		- // article namespace http://ogp.me/ns/article#
127		- $_dates = p_get_metadata($ID, 'date', true);
128		- $event->data['meta'][] = array('property' => 'article:published_time',
129		- 'content' => dformat($_dates['created']),);
130		- $event->data['meta'][] = array('property' => 'article:modified_time',
131		- 'content' => dformat($_dates['modified']),);
132		- $event->data['meta'][] = array('property' => 'article:author',
133		- 'content' => $INFO['editor'],);
134		- // $event->data['meta'][] = array('property' => 'article:author','content' => p_get_metadata($ID,'creator',true),);
135		- // $event->data['meta'][] = array('property' => 'article:author','content' => p_get_metadata($ID,'user',true),);
136		- $_subject = p_get_metadata($ID, 'subject', true);
137		- if (!empty($_subject)) {
138		- if (!is_array($_subject)) {
139		- $_subject = array($_subject);
140		- }
141		- foreach ($_subject as $tag) {
142		- $event->data['meta'][] = array('property' => 'article:tag',
143		- 'content' => $tag,);
144		- }
145		- }
146		-
147		- // place namespace http://ogp.me/ns/place#
148		- $geotags = p_get_metadata($ID, 'geo', true);
149		- $lat = $geotags['lat'];
150		- $lon = $geotags['lon'];
151		- if (!(empty($lat) && empty($lon))) {
152		- $event->data['meta'][] = array('property' => 'place:location:latitude',
153		- 'content' => $lat,);
154		- $event->data['meta'][] = array('property' => 'place:location:longitude',
155		- 'content' => $lon,);
156		- }
157		- // see https://developers.facebook.com/docs/opengraph/property-types/#geopoint
158		- $alt = $geotags['alt'];
159		- if (!empty($alt)) {
160		- // facebook expects feet...
161		- $alt = $alt * 3.2808;
162		- $event->data['meta'][] = array('property' => 'place:location:altitude',
163		- 'content' => $alt,);
164		- }
165		-
166		- /* these are not valid for the GeoPoint type..
	35	+ /**
	36	+ * Register our callback for the TPL_METAHEADER_OUTPUT event.
	37	+ *
	38	+ * @param $controller Doku_Event_Handler
	39	+ * @see DokuWiki_Action_Plugin::register()
	40	+ */
	41	+ public function register(Doku_Event_Handler $controller) {
	42	+ $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this,
	43	+ 'handle_tpl_metaheader_output');
	44	+ }
	45	+
	46	+ /**
	47	+ * Retrieve metadata and add to the head of the page using appropriate meta
	48	+ * tags unless the page does not exist.
	49	+ *
	50	+ * @global string $ID page id
	51	+ * @global array $conf global wiki configuration
	52	+ * @global array $INFO
	53	+ * @param Doku_Event $event the DokuWiki event. $event->data is a two-dimensional
	54	+ * array of all meta headers. The keys are meta, link and script.
	55	+ * @param mixed $param the parameters passed to register_hook when this
	56	+ * handler was registered (not used)
	57	+ *
	58	+ * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
	59	+ */
	60	+ public function handle_tpl_metaheader_output(Doku_Event $event, $param) {
	61	+ global $ID, $conf, $INFO;
	62	+
	63	+ if (!page_exists($ID)) { return; }
	64	+
	65	+ // twitter card, see https://dev.twitter.com/cards/markup
	66	+ // creat a summary card, see https://dev.twitter.com/cards/types/summary
	67	+ $event->data['meta'][] = array('name' => 'twitter:card',
	68	+ 'content' => "summary",);
	69	+
	70	+ $event->data['meta'][] = array('name' => 'twitter:site',
	71	+ 'content' => $this->getConf('twitterName'),);
	72	+
	73	+ $event->data['meta'][] = array('name' => 'twitter:title',
	74	+ 'content' => p_get_metadata($ID, 'title', true),);
	75	+
	76	+ $desc = p_get_metadata($ID, 'description', true);
	77	+ if (!empty($desc)) {
	78	+ $desc = str_replace("\n", " ", $desc['abstract']);
	79	+ $event->data['meta'][] = array('name' => 'twitter:description',
	80	+ 'content' => $desc,);
	81	+ }
	82	+
	83	+ if ($this->getConf('twitterUserName') != '') {
	84	+ $event->data['meta'][] = array('name' => 'twitter:creator',
	85	+ 'content' => $this->getConf('twitterUserName'),);
	86	+ }
	87	+
	88	+ $event->data['meta'][] = array('name' => 'twitter:image',
	89	+ 'content' => $this->getImage(),);
	90	+ $event->data['meta'][] = array('name' => 'twitter:image:alt',
	91	+ 'content' => $this->getImageAlt(),);
	92	+
	93	+ // opengraph, see http://ogp.me/
	94	+ //
	95	+ // to make this work properly the template should be modified adding the
	96	+ // namespaces for a (x)html 4 template make html tag:
	97	+ //
	98	+ // <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="nl" lang="nl"
	99	+ // xmlns:og="http://ogp.me/ns#" xmlns:fb="http://ogp.me/ns/fb#"
	100	+ // xmlns:article="http://ogp.me/ns/article#" xmlns:place="http://ogp.me/ns/place#">
	101	+ //
	102	+ // and for a (x)html 5 template make head tag:
	103	+ //
	104	+ // <head prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb# article: http://ogp.me/ns/article# place: http://ogp.me/ns/place#">
	105	+
	106	+ // og namespace http://ogp.me/ns#
	107	+ $event->data['meta'][] = array('property' => 'og:locale',
	108	+ 'content' => $this->getConf('languageTerritory'),);
	109	+ $event->data['meta'][] = array('property' => 'og:site_name',
	110	+ 'content' => $conf['title'],);
	111	+ $event->data['meta'][] = array('property' => 'og:url',
	112	+ 'content' => wl($ID, '', true),);
	113	+ $event->data['meta'][] = array('property' => 'og:title',
	114	+ 'content' => p_get_metadata($ID, 'title', true),);
	115	+ if (!empty($desc)) {
	116	+ $event->data['meta'][] = array('property' => 'og:description',
	117	+ 'content' => $desc,);
	118	+ }
	119	+ $event->data['meta'][] = array('property' => 'og:type',
	120	+ 'content' => "article",);
	121	+ $ogImage = $this->getImage();
	122	+ $secure = substr($ogImage, 0, 5) === 'https' ? ':secure_url' : '';
	123	+ $event->data['meta'][] = array('property' => 'og:image' . $secure,
	124	+ 'content' => $ogImage,);
	125	+
	126	+ // article namespace http://ogp.me/ns/article#
	127	+ $_dates = p_get_metadata($ID, 'date', true);
	128	+ $event->data['meta'][] = array('property' => 'article:published_time',
	129	+ 'content' => dformat($_dates['created']),);
	130	+ $event->data['meta'][] = array('property' => 'article:modified_time',
	131	+ 'content' => dformat($_dates['modified']),);
	132	+ $event->data['meta'][] = array('property' => 'article:author',
	133	+ 'content' => $INFO['editor'],);
	134	+ // $event->data['meta'][] = array('property' => 'article:author','content' => p_get_metadata($ID,'creator',true),);
	135	+ // $event->data['meta'][] = array('property' => 'article:author','content' => p_get_metadata($ID,'user',true),);
	136	+ $_subject = p_get_metadata($ID, 'subject', true);
	137	+ if (!empty($_subject)) {
	138	+ if (!is_array($_subject)) {
	139	+ $_subject = array($_subject);
	140	+ }
	141	+ foreach ($_subject as $tag) {
	142	+ $event->data['meta'][] = array('property' => 'article:tag',
	143	+ 'content' => $tag,);
	144	+ }
	145	+ }
	146	+
	147	+ // place namespace http://ogp.me/ns/place#
	148	+ $geotags = p_get_metadata($ID, 'geo', true);
	149	+ $lat = $geotags['lat'];
	150	+ $lon = $geotags['lon'];
	151	+ if (!(empty($lat) && empty($lon))) {
	152	+ $event->data['meta'][] = array('property' => 'place:location:latitude',
	153	+ 'content' => $lat,);
	154	+ $event->data['meta'][] = array('property' => 'place:location:longitude',
	155	+ 'content' => $lon,);
	156	+ }
	157	+ // see https://developers.facebook.com/docs/opengraph/property-types/#geopoint
	158	+ $alt = $geotags['alt'];
	159	+ if (!empty($alt)) {
	160	+ // facebook expects feet...
	161	+ $alt = $alt * 3.2808;
	162	+ $event->data['meta'][] = array('property' => 'place:location:altitude',
	163	+ 'content' => $alt,);
	164	+ }
	165	+
	166	+ /* these are not valid for the GeoPoint type..
167	167
168	168	$region=$geotags['region'];
169	169	$country=$geotags['country'];
		@@ -173,61 +173,61 @@ discard block
		block discarded – undo
173	173	if (!empty($country)) {$event->data['meta'][] = array('property' => 'place:location:country-name','content' => $country,);}
174	174	*/
175	175
176		- // optional facebook app ID
177		- $appId = $this->getConf('fbAppId');
178		- if (!empty($appId)) {
179		- $event->data['meta'][] = array('property' => 'fb:app_id',
180		- 'content' => $appId,);
181		- }
182		- }
183		-
184		- /**
185		- * Gets the canonical image path for this page.
186		- *
187		- * @global string $ID page id
188		- * @return string the url to the image to use for this page
189		- */
190		- private function getImage() {
191		- global $ID;
192		- $rel = p_get_metadata($ID, 'relation', true);
193		- $img = $rel['firstimage'];
194		-
195		- if (empty($img)) {
196		- $img = $this->getConf('fallbackImage');
197		- if (substr($img, 0, 4 ) === "http") {
198		- // don't use ml() as this results in a HTTP redirect after hitting the wiki
199		- return $img;
200		- }
201		- }
202		-
203		- return ml($img, array(), true, '&', true);
204		- }
205		-
206		- /**
207		- * Gets the alt text for this page image.
208		- *
209		- * @global string $ID page id
210		- * @return string alt text
211		- */
212		- private function getImageAlt() {
213		- global $ID;
214		- $rel = p_get_metadata($ID, 'relation', true);
215		- $imgID = $rel['firstimage'];
216		- $alt = "";
217		-
218		- if (!empty($imgID)) {
219		- require_once(DOKU_INC.'inc/JpegMeta.php');
220		- $jpegmeta = new JpegMeta(mediaFN($imgID));
221		- $tags = array('IPTC.Caption',
222		- 'EXIF.UserComment',
223		- 'EXIF.TIFFImageDescription',
224		- 'EXIF.TIFFUserComment',
225		- 'IPTC.Headline',
226		- 'Xmp.dc:title'
227		- );
228		- $alt = media_getTag( $tags,$jpegmeta,"");
229		- }
230		- return htmlspecialchars($alt);
231		- }
	176	+ // optional facebook app ID
	177	+ $appId = $this->getConf('fbAppId');
	178	+ if (!empty($appId)) {
	179	+ $event->data['meta'][] = array('property' => 'fb:app_id',
	180	+ 'content' => $appId,);
	181	+ }
	182	+ }
	183	+
	184	+ /**
	185	+ * Gets the canonical image path for this page.
	186	+ *
	187	+ * @global string $ID page id
	188	+ * @return string the url to the image to use for this page
	189	+ */
	190	+ private function getImage() {
	191	+ global $ID;
	192	+ $rel = p_get_metadata($ID, 'relation', true);
	193	+ $img = $rel['firstimage'];
	194	+
	195	+ if (empty($img)) {
	196	+ $img = $this->getConf('fallbackImage');
	197	+ if (substr($img, 0, 4 ) === "http") {
	198	+ // don't use ml() as this results in a HTTP redirect after hitting the wiki
	199	+ return $img;
	200	+ }
	201	+ }
	202	+
	203	+ return ml($img, array(), true, '&', true);
	204	+ }
	205	+
	206	+ /**
	207	+ * Gets the alt text for this page image.
	208	+ *
	209	+ * @global string $ID page id
	210	+ * @return string alt text
	211	+ */
	212	+ private function getImageAlt() {
	213	+ global $ID;
	214	+ $rel = p_get_metadata($ID, 'relation', true);
	215	+ $imgID = $rel['firstimage'];
	216	+ $alt = "";
	217	+
	218	+ if (!empty($imgID)) {
	219	+ require_once(DOKU_INC.'inc/JpegMeta.php');
	220	+ $jpegmeta = new JpegMeta(mediaFN($imgID));
	221	+ $tags = array('IPTC.Caption',
	222	+ 'EXIF.UserComment',
	223	+ 'EXIF.TIFFImageDescription',
	224	+ 'EXIF.TIFFUserComment',
	225	+ 'IPTC.Headline',
	226	+ 'Xmp.dc:title'
	227	+ );
	228	+ $alt = media_getTag( $tags,$jpegmeta,"");
	229	+ }
	230	+ return htmlspecialchars($alt);
	231	+ }
232	232
233	233	}

		@@ -21,8 +21,8 @@
		block discarded – undo
21	21	* @license BSD license
22	22	* @author Mark C. Prins <[email protected]>
23	23	*/
24		-$meta['twitterName'] = array ('string');
25		-$meta['twitterUserName'] = array ('string');
26		-$meta['fallbackImage'] = array ('string');
27		-$meta['languageTerritory'] = array ('multichoice','_choices' => array('be_BY','bn_IN','cs_CZ','da_DK','de_CH','de_DE','el_GR','en_AU','en_CA','en_GB','en_HK','en_IN','en_NZ','en_PH','en_SG','en_US','en_ZA','es_AR','es_BO','es_CL','es_CO','es_CR','es_DO','es_EC','es_ES','es_GT','es_HN','es_MX','es_NI','es_PA','es_PE','es_PR','es_PY','es_SV','es_US','es_UY','es_VE','fi_FI','fr_BE','fr_CA','fr_CH','fr_FR','gu_IN','he_IL','hi_IN','hr_HR','hu_HU','id_ID','it_CH','it_IT','iw_IL','ja_JP','kk_KZ','ko_KR','mr_IN','ms_MY','nl_NL','no_NO','pa_IN','pl_PL','pt_BR','pt_PT','ro_RO','ru_RU','sk_SK','sl_SI','sv_SE','ta_IN','te_IN','th_TH','tr_TR','zh_CN','zh_HKS','zh_HKT','zh_SGS','zh_TW'));
28		-$meta['fbAppId'] = array ('string');
	24	+$meta['twitterName'] = array('string');
	25	+$meta['twitterUserName'] = array('string');
	26	+$meta['fallbackImage'] = array('string');
	27	+$meta['languageTerritory'] = array('multichoice', '_choices' => array('be_BY', 'bn_IN', 'cs_CZ', 'da_DK', 'de_CH', 'de_DE', 'el_GR', 'en_AU', 'en_CA', 'en_GB', 'en_HK', 'en_IN', 'en_NZ', 'en_PH', 'en_SG', 'en_US', 'en_ZA', 'es_AR', 'es_BO', 'es_CL', 'es_CO', 'es_CR', 'es_DO', 'es_EC', 'es_ES', 'es_GT', 'es_HN', 'es_MX', 'es_NI', 'es_PA', 'es_PE', 'es_PR', 'es_PY', 'es_SV', 'es_US', 'es_UY', 'es_VE', 'fi_FI', 'fr_BE', 'fr_CA', 'fr_CH', 'fr_FR', 'gu_IN', 'he_IL', 'hi_IN', 'hr_HR', 'hu_HU', 'id_ID', 'it_CH', 'it_IT', 'iw_IL', 'ja_JP', 'kk_KZ', 'ko_KR', 'mr_IN', 'ms_MY', 'nl_NL', 'no_NO', 'pa_IN', 'pl_PL', 'pt_BR', 'pt_PT', 'ro_RO', 'ru_RU', 'sk_SK', 'sl_SI', 'sv_SE', 'ta_IN', 'te_IN', 'th_TH', 'tr_TR', 'zh_CN', 'zh_HKS', 'zh_HKT', 'zh_SGS', 'zh_TW'));
	28	+$meta['fbAppId'] = array('string');

		@@ -11,7 +11,7 @@
		block discarded – undo
11	11	* Simple test to make sure the plugin.info.txt is in correct format
12	12	*/
13	13	public function test_plugininfo() {
14		- $file = __DIR__.'/../plugin.info.txt';
	14	+ $file = __DIR__ . '/../plugin.info.txt';
15	15	$this->assertFileExists($file);
16	16
17	17	$info = confToHash($file);

		@@ -23,9 +23,9 @@
		block discarded – undo
23	23	*/
24	24	class action_plugin_socialcards_test extends DokuWikiTest {
25	25
26		- protected $pluginsEnabled = array('socialcards');
	26	+ protected $pluginsEnabled = array('socialcards');
27	27
28		- function setUp(){
	28	+ function setUp(){
29	29	global $conf;
30	30
31	31	parent::setUp();

mprins / dokuwiki-plugin-socialcards

Pull Request — master (#19)

Status

Category

Spacing +5 added lines, -5 removed lines patch added patch discarded remove patch

Indentation +190 added lines, -190 removed lines patch added patch discarded remove patch

Spacing +5 added lines, -5 removed lines patch added patch discarded remove patch

Spacing +1 added lines, -1 removed lines patch added patch discarded remove patch

Indentation +2 added lines, -2 removed lines patch added patch discarded remove patch

Spacing +2 added lines, -2 removed lines patch added patch discarded remove patch