カテゴリ:カスタマイズ プラグイン改造

変更箇所のまとめ

  • XSS対策
  • ベースネーム表示機能の追加。
  • 画像非表示機能の追加。
  • ページ名からリンクを作成する機能を追加。 (内部リンクのみ)
  • 画像保存機能の廃止。

変更の詳細

XSS対策を施す

そのまま使うとXSSの危険性があったためいくつか修正を施す。

URLが不正であった場合にエラーを返すようにする

デフォルトだとURL先のページが存在しなかった場合でもカードの作成に入ってしまうので、そこを修正する。

    $graph = OpenGraph::fetch($ogpurl[0]);
    if ($graph) {
      ...
-   }
+   } else return '#ogp Error: Page not found.';

カード作成前にサニタイズする

例えばリンク先がWikiだった場合、存在しないページでも編集画面に繋がってしまう。
そのため上記修正のみだと不十分なため、return前の適当な場所で引数をサニタイズしておく。

  $imgtag = 'img class="ogp-img"' ;
}

+ $ogpurl[0] = htmlspecialchars($ogpurl[0]);

  return <<<EOD

修正箇所を2つ挙げたものの、XSS対策としては2つ目 (サニタイズ) のみでも大丈夫。多分。

ベースネーム表示と画像非表示オプションを追加

ベースネーム表示機能
Wikiだとページ名が "AAA/BBB/CCC" のように階層化されている場合がある。
この "CCC" に当たる部分がベースネーム。
階層が深くなりすぎると、ページ名が長すぎて行数制限内に収まりきらないことがあるため、オプションでベースネームのみを表示するように指定できるようにする。
画像非表示機能
デフォルトだとリンク先のOGPタグに画像が指定されていないと表示が崩れるため、画像そのものを非表示にする機能を追加する。

最後の方にあるampオプションの処理部分を改変する。

-if($ogpurl[1] == "amp"){
-    $imgtag = 'amp-img class="ogp-img" layout="fill"' ;
-} else {
-    $imgtag = 'img class="ogp-img"' ;
-}
+foreach ($ogpurl as $param) {
+	switch ($param) {
+		case 'amp': // amp
+			$imgtag = 'amp-img class="ogp-img" layout="fill"' ;
+			break;
+		case 'noimg': // 画像なし
+			$imgtag = 'img class="ogp-noimg"';
+			break;
+		case 'base': // ページのbasenameのみを表示 (Wiki系のサイト用)
+			$title = array_pop(explode('/',$title));
+	}
+}
+if (!isset($imgtag)) $imgtag = 'img class="ogp-img"';

CSSに以下を追加。

img.ogp-noimg { display: none; }

画像を保存しないようにする

当方の環境だとcacheフォルダ内に保存した.imgファイルが正常に表示できなかったため、リンク先のサイトの画像URLをそのまま使うことにした。

まずは.imgを作成する部分を削除。

 $datcache = CACHE_DIR . 'ogp/' . $ogpurlmd . '.dat';
-$imgcache = CACHE_DIR . 'ogp/' . $ogpurlmd . '.img';

キャッシュがある場合の処理を改変。

	$description = $ogpcachearray[1];
-	$src = $imgcache ;
+	$src = $ogpcachearray[2];
 } else {

キャッシュがない場合の処理を改変

-	$imgfile = file_get_contents($src);
-	$imginfo = pathinfo($src);
-	/* $imgname = $imginfo['basename']; */
-	file_put_contents($datcache, $title . '<>' . $description . '<>' . $ogpurl[0]);
+	file_put_contents($datcache, $title . '<>' . $description . '<>' . $src);
-	file_put_contents($imgcache, $imgfile);

これで画像を保存しなくても表示できるようになる。
ページの表示速度も保存した場合と特に変わらず。


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

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

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