プラグインの変更箇所/ogp.inc.php

2021-03-28 (日) 14:07:13

変更箇所のまとめ

  • ページ名からリンクを作成する機能を追加。 (内部リンクのみ)
  • ベースネーム表示機能の追加。
  • 画像のキャッシュ方法を変更。
  • その他細かい変更。

変更の詳細

ページ名からリンクを作成する

内部リンクの場合、いちいち自身のサイトのURLを貼るのも面倒なので、ページ名指定ができるようにする。また、このサイトではURL短縮ライブラリを導入しているため、合わせてそれにも対応する。

 	$args = func_get_args();
-	$uri = get_script_uri();
-	$ogpurl = (explode('://', $args[0]));
+	$uri = array_shift($args);
+    if (strpos($uri, '://') === false) {
+        $uri = get_base_uri(PKWK_URI_ABSOLUTE) . get_short_url_from_pagename($uri);
+    }
+	$ogpurl = (explode('://', $uri));

ついでに元のプラグインだと$uri (と$url) が使われていなかったため、第一引数に置き換えて$args[0]になっている箇所全てと入れ替えた。

ベースネーム表示機能を追加

ベースネーム表示機能
Wikiだとページ名が "AAA/BBB/CCC" のように階層化されている場合がある。
この "CCC" に当たる部分がベースネーム。
階層が深くなりすぎると、ページ名が長すぎて行数制限内に収まりきらないことがあるため、オプションでベースネームのみを表示するように指定できるようにする。
	$is_amp = (in_array('amp', $args) || PLUGIN_OGP_AMP );
	$is_noimg = (in_array('noimg', $args) || filesize($imgcache) == 0 );
 	$is_prefetch = in_array('prefetch', $args);
+	$is_base = in_array('base', $args);
 	} else {
 		$prefetch = '';
 	}
 
+	if($is_base) {
+		$title = array_pop(explode('/', $title));
+	}

画像のキャッシュ方法を変更

元のプラグインだと拡張子ごとに変数を用意して一つ一つチェックしていたが、個人的にもうちょっとスマートにしたかったので処理を変えていく。

まず$webp以外の拡張子用の変数を省略する。

 	$ogpurlmd = md5($ogpurl[1]);
 	$datcache = CACHE_DIR . 'ogp/' . $ogpurlmd . '.dat';
-	$gifcache = CACHE_DIR . 'ogp/' . $ogpurlmd . '.gif';
-	$jpgcache = CACHE_DIR . 'ogp/' . $ogpurlmd . '.jpg';
-	$pngcache = CACHE_DIR . 'ogp/' . $ogpurlmd . '.png';
	if(PLUGIN_OGP_WEBP_FALLBACK) {
	$webpcache = CACHE_DIR . 'ogp/' . $ogpurlmd . '.webp'; //webp対応
	}

キャッシュの有無の判別、およびキャッシュがある場合の処理を変える。

-	if(file_exists($pngcache)) { $imgcache = $pngcache ; }
-	else if(file_exists($gifcache)) { $imgcache = $gifcache ; }
-	else { $imgcache = $jpgcache ; }
-	
-	if(file_exists($datcache) && file_exists($imgcache)) {
+	if(file_exists($datcache)) {
 		$ogpcache = file_get_contents($datcache);
 		$ogpcachearray = explode("<>", $ogpcache);
 		$title = $ogpcachearray[0];
 		$description = $ogpcachearray[1];
-		$src = $imgcache ;
-		$imgfile = file_get_contents($imgcache) ;
+		$src = $ogpcachearray[2];
 	} else {
 	    require_once(PLUGIN_DIR.'opengraph.php');
-	    $graph = OpenGraph::fetch($args[0]);    
+	    $graph = OpenGraph::fetch($uri);    
 	    if ($graph) {
 	        $title = $graph->title;
-	        $url = $graph->url;
 	        $description = $graph->description;
 	        $src = $graph->image;

キャッシュがない場合の処理を変える。

 		        $description = mb_convert_encoding($description, 'UTF-8', mb_detect_encoding($description, $detects, true));
 		    }
 		    
+			// 画像キャッシュ生成
 			$imgfile = file_get_contents($src);
-			$imginfo = getimagesize($src);
-			file_put_contents($datcache, $title . '<>' . $description . '<>' . $args[0]);
-			$filetype = $imginfo[2];
-			if( $filetype == 1 ){
-				file_put_contents($gifcache, $imgfile) ;
-			} else if ( $filetype == 3 ){
-				file_put_contents($pngcache, $imgfile) ;
-			} else {
-				file_put_contents($jpgcache, $imgfile) ;
-			} //どの拡張子でもない場合どうするか(webp,gzip)、jpg拡張子に偽装したgzファイルなどでエラーが出る
+			$fileinfo = pathinfo($src);
+			$imgcache = CACHE_DIR . 'ogp/' . $ogpurlmd . '.' . $fileinfo['extension'];
+			file_put_contents ($imgcache, $imgfile);
+
+			// OGPキャッシュ生成
+			file_put_contents($datcache, $title . '<>' . $description . '<>' . $imgcache . '<>' . $uri);
 		} else return '#ogp Error: Page not found.';
 	}

一応元に倣って$uri ($args[0]) も保存しているが、今のところどこにも使ってないので消してもいいかもしれない。

その他細かい変更点

PukiWiki1.5.3の仕様に合わせる

htmlspesialchars -> htmlsc

-	$args[0] = htmlspecialchars($args[0]);
+	$uri = htmlsc($uri);

noimg判定の修正

filesizeがローカルでしか使えないらしく、$imgcacheの扱い変更に伴って判定方法を下記のように変更する。

-	$is_noimg = (in_array('noimg', $args) || filesize($imgcache) == 0 );
+	$is_noimg = (in_array('noimg', $args) || filesize($src) === 0 || empty($src) );

もしくは画像キャッシュ生成した後に$srcに$imgcacheを代入する。

更新履歴

2021-03-28
プラグイン本体の方が更新されていたので、それに対応し記述を修正。
XSS対策やnoimgオプションを取り込んでいただけたようで、嬉しい反面自身もコーディングに自信があるわけではないのでちょっとドキドキする。

プラグイン配布元

pukiwikiカスタマイズ箇所/ogp.inc.php - 腫瘍学レ点ノート

コメント

質問や指摘などあればどうぞ。


コメントはありません。 コメント/プラグインの変更箇所/ogp.inc.php