Googleでログイン

勉強を兼ねて「Google Identity」の認証サービスを使用し、WordPressで構築されたサイトにログインするプラグインを作ってみた。

「Google Identity」の認証サービスではさまざま実装が可能となっており、今回は認証後にリダイレクトするのではなく、フロント側(のコールバック)で受け取ったトークンをサーバー側に送り、サーバー側ではトークンの検証を行う方法を採用した。

なお『「Google でログイン」JavaScript API リファレンス』には次のような一文がある。

トークンを検証して得られるユーザー情報のsubフィールドをユーザーメタ情報に保持し、それにマッチするユーザーのみログインできるようにした。

今回のプラグインで影響を与えたページは次の通り。

  • ログインページ
  • 一般設定ページ
  • ユーザープロフィールページ

ログインページでは、login_headアクションでクライアント ライブラリを読み込み、login_formアクションでボタン部分のスクリプトを出力する。

一般設定ページでは、「Google Identity」のクライアントID用の入力フィールドをadd_settings_section/add_settings_field関数を使って追加する。

ユーザープロフィールページでは、show_user_profileアクションでGoogleアカウントと紐づけるsubフィールドとログイン時と同じGoogleのログインボタンを追加する。

またログインページとユーザープロフィールページ向けにAJAXのレスポンスを返すアクションを追加し、それぞれ「Google Identity」の認証サービスから返ってきたトークンの検証し、適宜内部処理を行った。方針が決まるまで少し時間がかかったが、自分がコーディングしたコードはそれほど多くない。

さてGoogleはトークンの検証機能を含んだライブラリを提供しており、これが約72MBと小さくはない。どこかにトークンの検証機能に絞り込んだライブラリがあるとよいのだが。。。

joyokanji.infoのメンテでやらかした件

昨年末にjoyokanji.infoサーバーのメンテナンスを実施し、PHP 8.1へバージョンアップしました。当日は軽くいくつかのページを閲覧しただけで済ませてしまい不具合の発見が遅れてしまった。

存在しないテーブルのクエリー

PHP(PHP-FPM)のエラーログには次の内容が出力される。

Table 'データベース名.テーブル名' doesn't exist

これま見たままのエラーで、以前はPHP Fatal errorではなかったのでしょう。対応としては、テーブルが存在する場合のみクエリーを実行するようにしました。

get_magic_quotes_gpc関数の呼び出し

エラーログの内容は次の通り。

Call to undefined function get_magic_quotes_gpc()

PHP 8.0.0で削除された関数を数か所で呼び出していました。対応としては、本関数が存在しない場合は呼び出さないように修正しました。

空のIN句を含んだクエリー

エラーログは以下の通り。

You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near ') ORDER BY id'

該当のソースコードから次のようなIN句が原因でした。

IN () ORDER BY id

本来マッチした漢字のリストが入るもので、これをマッチした漢字がなくてもクエリーを実行していたことが原因でした。対応としてはマッチした漢字がない場合はクエリーを実行しないように修正しました。

mb_convert_encoding関数で’auto’を指定

エラーログに次の内容が複数回出力されていました。

mb_convert_encoding(): Unable to detect character encoding

これは文書として指定されたものを内部でUTF-8に変換する際、mb_convert_encoding関数を呼び出していたのですが、第3パラメータ$from_encodingに’auto’が含まれていたことが原因でした。暫定的な対応として$from_encodingの内容を見直し、’auto’を含めないように修正しました。

usort関数のコールバックで勘違い

エラーログは次の通り。

usort(): Returning bool from comparison function is deprecated, return an integer less than, equal to, or greater than zero

これはコールバックの戻り値を返すところで、次のように記述していたことが原因でした。

return $a->id > $b->id;

bool値が返ることが原因だったので、次のように修正しました。

return $a->id - $b->id;

まだ気になるところも残っているが…

この週末にエラーログを見ながらいくつか調整。フォームから入力された内容を検証処理を追加したり、文書のUTF-8変換処理を調整したりしました。mb_convert_encoding関数に指定する$from_encodingの最適解を知りたい。

elearn.jpサーバーのメンテナンス

何気に年を越してしまったが、elearn.jpサーバーのメンテナンスを昨晩実施しました。古くなっていたOSを入れ替え、PHPも8.1に更新。サーバー構成は昨年末に実施したjoyokanji.infoとほぼ同じ。

今回の所要時間は約75分。WordPressを使っているのでエラーはなかったのですが、ファイルを丸ごとバックアップし、レストアしようとしたため予想よりも時間がかかってしまった感じ。

PHP 8.1のセキュリティサポートが2024/11/25なので、その頃には8.2か8.3にアップデートしないとね。。。

joyokanji.infoサーバーのメンテナンス

昨日、joyokanji.infoのサーバーメンテナンスを実施しました。

OSとPHPが古くなっており、これらをバージョンアップするのが目的で、OSはCentOS Stream 9に、PHPは8.1になりました。

OSが変わったことに伴い、MySQLが8.0に。別環境の構築でGRANT文でユーザー作成できないことは知っていたのですが、Webアプリケーションで使用していたアカウントのパスワードが強度不足でそのまま使用できず、再設定してWebアプリケーション側の設定を書き換え、ちょっとだけ時間ロスに。

これで問題なくなったかと思い、ブラウザでjoyokanji.infoにアクセスすると、ステータス「500」。エラーログを確認すべく、/var/log/php_error.logを確認する原因さしきものはなく、ちょっと焦る。あらためて/var/log/を見てみると、php-fpmディレクトリがあったので、その中のerror.logを確認するが、中身は空。次にwww-error.logを確認し、ようやくエラー原因を特定。存在しないテーブルに対してSELECT文を実行した際、Fatal errorになっていました。取り急ぎ、問題部分を修正し、無事サイトが立ち上がりました。

https://joyokanji.info/

今回のメンテナンスに要した時間は約3時間。自分の中での予定では2時間くらいを想定していたので、ちょっとオーバーです(告知していた時間内にはおさまっていますが)。

WordPress 6.4「Shirley」リリース

今日は予定通り「WordPress 6.4」がリリースされました。今回もコントリビューターリストに名前が記載されておりました。今日は手持ちのサイトを順次アップデートしていきます。

これに関連して昨日は、「Login rebuilder 2.8.2」をリリースしました(昨日1日のダウンロード数は3,377)。主な変更点は次の通りで、アップデートを推奨します。

  • 「ログインファイル キーワード」を保存する際のサニタイズ処理を強化しました(キーワードからいくつかの記号を除外など)。
  • ウィジェット向けにユーザーのログイン情報を取得できなかった際、エラーを回避するように調整しました。

後者は先週末にサポートに投稿された不具合に対応したものです。ChatworkやBacklogをメインに使うようになり、メールの確認がおろそかになったことで通知メールに気づくのが遅くなってしまいました。なんとかWordPress 6.4のリリース前に修正版を公開できてよかったと思います。

WordPress 6.3「Lionel」リリース

予定通りWordPress 6.3「Lionel」がリリースされました。久しぶりのメジャーアップデートですね。

メジャーアップデートの「contributors」に名前が記載されたのはずいぶん久しぶりな感じがします。

ベータ版をテストした際、6.3 Beta1からどうも悪い設定が残ってしまったらしく謎の不具合に遭遇したのですが、クリーンインストールしなおしたことで何事もなかったかのように解消。自前のプラグインは改修せずに済みました。

サポートするPHPバージョンは結局「7.0.0」に落ち着き、ツールバーやリストビューの改善、テーマ・プラグインのアップデート失敗時のリカバリー機能の導入なんかも気になりますね。

画像ブロックのメディアライブラリにカスタムタクソノミーを追加

画像ブロックですでにアップロード済みの画像を再利用する際、「メディアライブラリ」を開いてその中から選択するが、画像が多くなったら「日付」だけで絞り込むのはしんどい感じがしたので、カスタムタクソノミーを追加したいと思ったのが、先月くらい。Googleで検索してもそれっぽい内容を検索できず、ChatGPTで問い合わせしても意図した通りの挙動にはならず、ちょっと時間がかかってしまった。

メディアライブラリにカスタムタクソノミー「グループ」を追加したところ

ChatGPT(無料版)でやりとりしている中でちょっと意外だったのが、現時点で対応しているWordPressのバージョンは「5.8」ということ。5.9のリリースは2022年1月になるので、WordPressに関しては2021年以前の情報がベースになるらしい。分野によってどの程度違いがあるのか少し気になる。。。

さて本題も戻すと、「メディア」-「ライブラリ」で表示される内容は、リスト表示とグリッド表示の2種類があり、画像ブロックで表示される「メディアライブラリ」はグリッド表示とほぼ同じふるまいになっていた。拡張方法は、2つの表示内容でまったく異なっており、リスト表示はPHPだけで済むが、グリッド表示のほうはJavaScriptも用意する必要がある。

グリッド表示で今回使用したのが、admin_enqueue_scriptsアクションのほか、ajax_query_attachments_args、media_view_settings、media_view_stringsフィルターになる。media_view_settingsとmedia_view_stringsフィルターはwp_enqueue_media関数内で呼び出されるもので、JavaScript側ではwp.media.view.settingsとwp.media.view.l10nのプロパティからそれぞれのデータを参照できる。JavaScript側へデータを渡す汎用的な方法としてはwp_add_inline_script関数を使用すうこともできるが、メディアライブラリ用のJavaScriptであれば、media_view_settingsおよびmedia_view_stringsフィルターを使うほうがよいと判断した。

admin_enqueue_scriptsアクションのコールバック関数のポイントは、第1パラメータをチェックする際、投稿編集ページも含めること。post.phpだけでなく、post-new.phpも指定する。

if ( in_array( $hook_suffix, [ 'upload.php', 'post.php', 'post-new.php' ] ) ) {

ajax_query_attachments_argsフィルターのコールバック関数ではカスタムタクソノミー「グループ」を検索条件に追加する処理を行う。プルダウンメニューの選択が変わる度にこのフィルターは呼び出されており、$query[‘tax_query’]に検索条件を設定することになる。

今回予想以上に時間がかかってしまったが、想定通りに動いてくれればその苦労も報われた。既存ブロックのちょっとした拡張はなかなか面白い。

ログインページにHTTP認証を

WordPress 6.2が無事リリースされ、手持ちのサイトを順番にアップデート中。公開しているプラグインは今回はバージョンアップせず、readme.txtに動作検証結果を反映させる予定だ。

実のところ、「Login rebuilder」についてはネタ切れ中で、まれに見かけるログインページにHTTP認証を実装するところまではできているのだけど、いまひとつ気がのらない。

今回実装したのは、BASIC認証ではなく、ダイジェスト認証であり、機能的には問題ないレベルになっている。WordPressでは$_SERVERもスラッシュでクォートされているため検証がちょっと面倒だったり、設定ページでパスワード生成や強度表示を実装してみたりと勉強になることもあったが、使い勝手がしっくりこない感じだ。

というわけで、ゴールデンウイークくらいまでは自サイトで使ってみて最終的に公開するか決定しようと思う。

画像ブロックに効果を付与

投稿記事の表現を強化しようと思い画像ブロックに4つの効果を付与した。効果は画像ブロックの実態となるdiv要素かfigure要素のclass属性に追加される。

フレーム

画像の外側に空きを作って昔の写真(紙焼き)っぽい見た目にする。

ドロップシャドウ

画像の背後に薄い影を付ける。

輪郭をぼかす

画像の輪郭を背景色でぼかす。

モノクローム

画像にモノクロームフィルターを適用する。セピアフィルターをあるがとりあえずはこちらのみ。

それぞれの効果は組み合わせ可能で、バリエーションはそれなりの数になる。今後もよさそうな効果があったら追加していきたい。

さて、スタイルは効果に応じてdiv要素(またはfigure要素)と内包するimg要素に指定した。テーマによって背景色などのカスタムプロパティ名が異なるので、汎用的なプラグインにするにはちょっと工夫が必要だ。

registerFormatTypeでルビ

そんなに使うわけではないのだが、ルビの入力を何とかしたかった。そんなわけで次のような2つのボタンを追加してルビ入力支援を実装した。

ツールバーのリンクボタンの左側に2つのボタンを追加

リンクボタンのすぐ左がrtタグ用ボタン、さらにその左がrubyタグ用ボタンとなる。ボタンのイメージはdashiconsではなく、「Tabler Icons」のSVGを使ってみた。

このボタンを実際に使ったのが、挨拶あいさつ。「挨拶あいさつ」とタイプした後でそれらを選択し、rubyタグ用ボタンをクリック。続いて「あいさつ」を選択してrtタグ用ボタンをクリックする。rtタグ用ボタンについていくつか制御を検討したのだが、読みの部分を入力するタイミングはユーザー任せでいいかなと思い、rubyタグ内のみ有効にするといった制限については今回見送った。

理想的には、rtタグで囲むタイミングでrpタグを自動的に挿入したかったのだが、うまく対応する方法がわからなかった。かといってrpタグ用ボタンを追加するのも野暮ったいので、とりあえずはこんな感じに。

RichTextToolbarButtonのiconプロパティにdashiconsではなくSVGを指定するわけだが、JavaScript(ES5)の場合はcreateElement関数を使う必要があるのでちょっとだけ面倒かも!?(svgタグをそのまま記述できるJSXの方が楽だよね)