SearchWP Documentation

インストールガイドを表示したり、ナレッジベースを参照したり、SearchWPの多くのフックについて確認したりできます。

Xpdf連携

現在のバージョン: 1.3.2

警告: この拡張機能は exec() の使用を必要とし、Xpdf コマンドラインツールの自己インストールも必要とします。

SearchWP は、WordPress ウェブサイトにアップロードされた PDF ファイルからプレーンテキストを抽出するというユニークな機能を提供します。標準では、SearchWP は PHP のみを使用してこれを試みますが、PDF フォーマットの複雑さと多様性により、コンテンツが正確に抽出されない場合があります。そこで Xpdf の出番です。

Xpdf にはコマンドラインツールのセットがあり、この拡張機能が機能するためにはサーバーにインストールされている必要があります。手順はこちらに含まれています。

Xpdf 連携拡張機能を使用すると、PHP が PDF ファイルを処理するために行うすべての作業を、Xpdf のコマンドラインツールにオフロードできます。これらのツールは、PDF からコンテンツを抽出する際に非常に高速で正確です。拡張機能を有効にした後、インストール手順に従う必要があります。インストールが完了すると、SearchWP は PDF コンテンツ抽出プロセスを Xpdf にオフロードします。

Xpdf コマンドラインツールのインストール

この拡張機能を使用すると、Xpdf を利用して PDF からコンテンツを抽出できます。

重要: Xpdf コマンドラインツールは、この拡張機能のダウンロードには含まれていません。コマンドラインツールをダウンロードし、非公開 (Web ルートの外) の場所にアップロードする手順に必ず従ってください。

Windows および Linux の Xpdf コマンドラインツールは、http://www.xpdfreader.com/download.html からダウンロードできます。

インストール

サーバーの種類に合わせてコマンドラインツールをダウンロードしたら:

  1. xpdf-tools-linux-4.03.tar.gz を展開します (バージョン番号は異なる場合があります)
  2. pdftotext バイナリ (展開後、サーバーのアーキテクチャに応じて bin32 または bin64 ディレクトリにあります) を、Web ルートの外の非公開の場所にアップロードします
  3. pdfinfo バイナリ (展開後、サーバーのアーキテクチャに応じて bin32 または bin64 ディレクトリにあります) を、Web ルートの外の非公開の場所にアップロードします
  4. pdftotextpdfinfo の両方に、サーバー上の PHP ユーザーに対する実行権限があることを確認してください

最後のステップは、SearchWP Xpdf Integration に pdftotextpdfinfo をどこにインストールしたかを伝えることです。これを行うには:

以下のコードを SearchWP カスタマイズ プラグインに追加します。/path/to/pdftotext を、サーバー上のpdftotext および pdfinfo バイナリへの実際のパス (フォルダではなく)置き換えてください。

// Tell SearchWP the location of the pdftotext binary.
add_filter( 'searchwp_xpdf_path', function() {
    return '/home/johndoe/pdftotext'; // Full absolute path to the binary NOT A FOLDER, NOT A URL.
} );

// Tell SearchWP the location of the pdfinfo binary.
add_filter( 'searchwp_pdfinfo_path', function() {
    return '/home/johndoe/pdfinfo'; // Full absolute path to the binary NOT A FOLDER, NOT A URL.
} );

これで完了です!

Xpdf 連携での PDF パスワードサポートの追加

Xpdf  searchwp_xpdf_commandフィルターを使用して、パスワード保護された(読み取り専用:暗号化されていない)PDFの解析をサポートしています。このフィルターを使用すると、Xpdfを実行するコマンドを直接操作できるため、Xpdfがパスワードを含めるオプションをサポートしていることから、次のように実行できます。

<?php
function my_searchwp_xpdf_command( $cmd, $filename ) {
return $cmd . ' -upw password';
}
add_filter( 'searchwp_xpdf_command', 'my_searchwp_xpdf_command', 10, 2 );

Xpdf統合の手動テスト

Xpdf統合拡張機能をアップロードして有効にし、pdftotextへのパスを指定した後、メディアライブラリにアップロードされた特定のPDFでXpdfのテキスト抽出が期待どおりに機能していることを手動で確認できます。まず、SearchWP設定画面(設定 > SearchWP)に移動し、SearchWP設定画面の拡張機能でXpdf統合リンクを見つけます。

Xpdf統合テスト画面で、テストしたいPDFのIDを入力できます。

スクリーンショット 2013-12-09 午前11時34分24秒

IDは、メディアセクションに移動してからPDFの編集リンクをクリックすることで見つけることができます。IDはURLに表示され、post=の後に続きます。

有効なIDを送信すると、Xpdf統合拡張機能が実行した手順の詳細なログと、発生した可能性のある失敗点が示されます。また、XpdfがPDFから抽出した正確なコンテンツも表示されます。

スクリーンショット 2013-12-09 午前11時36分16秒

ログに失敗点が表示された場合は、提出するサポートリクエストに含めてください。

Xpdf統合エラーコード

Xpdfの実行に問題があった場合、以下のいずれかのエラーコードがログに表示されます。

終了コード説明
0コマンドは正常に実行されました
1指定されていないエラーのキャッチオール
2権限の問題。www-data(またはお使いのWebサーバーユーザー)にpdftotextを実行する権限があることを確認してください。
11セグメンテーション違反。お使いのサーバー環境に適したXpdfバイナリを使用していますか?
126Webサーバーユーザーからpdftotextを実行する際に権限の問題があります。ホストに適切な権限があるか確認してください。
127サーバーがpdftotextを実行できませんでした。ホストにWebサーバーユーザーがpdftotextを実行できるか確認してください。
139Webサーバーユーザーからpdftotextを実行する際に権限の問題があります。ホストに適切な権限があるか確認してください。

変更履歴

1.3.2

  • [改善] シェルコマンド引数にエスケープを追加
  • [修正] 拡張機能ドキュメントへのリンクを修正

1.3.1

  • [修正] PHP 8.2以降で非推奨となった動的プロパティの作成

1.3.0

  • [新規] PDFメタデータを抽出するためのpdfinfoのサポートを追加
  • [更新] アップデーターを更新しました

1.2.0

  • [新規] SearchWP 4のサポートを追加

1.1.6

  • [新規] exec()が利用できない場合に通知を表示(必要不可欠なため)
  • [更新] アップデーターを更新しました

1.1.5

  • [変更] XpdfがXpdfReaderに変更されたため、コマンドのフォーマットが変更されました。pdftotextも更新する必要があります。更新されたバージョンをダウンロードするには、XpdfReaderのWebサイトへのリンクについてはXpdf統合ドキュメントを参照してください。
  • [更新] アップデーターを更新しました

1.1.3

  • [更新] アップデーターを更新しました
  • [変更] 最小必須SearchWPバージョンを更新

1.1.2

  • [改善] 終了コードの処理を改善

1.1.1

  • [新規] 新しいフィルター:searchwp_xpdf_command(Xpdfコマンドの操作を許可)

1.1

  • [改善] SearchWPライセンスキーに基づく自動更新のサポートを追加しました

0.7.2

  • [修正] Windowsのディレクトリ区切り文字の処理を改善しました

0.7

  • 初回リリース

今日からより良いWordPress検索エクスペリエンスを作成しましょう

役に立たない検索結果で訪問者を失うことはもうありません。SearchWPを使用すると、独自のスマートなWordPress検索をすばやく簡単に作成できます。

Get SearchWP Now
複数の検索エンジンアイコン