【PHP8.x】CURLKHMATCH_OK定数の使い方

Copy
1<?php
2
3/**
4 * 複数の cURL リクエストを並行して実行する関数。
5 * curl_multi_exec の基本的な使い方に加え、CURLKHMATCH_OK のような定数が
6 * SSH キーマッチングなどの高度なシナリオでどのように使われるかを概念的に示します。
7 *
8 * @param array $urls 取得する URL の配列。
9 * @return array 各 URL のレスポンスを含む配列。
10 */
11function fetchUrlsWithSshConcept(array $urls): array
12{
13    // 1. curl_multi_init(): マルチハンドルの初期化
14    $mh = curl_multi_init();
15    $chHandles = []; // 個々の cURL ハンドルの配列
16    $responses = []; // 各リクエストのレスポンスを格納する配列
17
18    // 2. 個々の cURL ハンドルの設定とマルチハンドルへの追加
19    foreach ($urls as $index => $url) {
20        $ch = curl_init();
21        curl_setopt($ch, CURLOPT_URL, $url);
22        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスを文字列で返す設定
23
24        // ここでは、SSH プロトコル（例: SFTP, SCP）を使用する URL の場合に
25        // CURLKHMATCH_OK の概念的な使用法を示します。
26        // 実際には、libcurl が SSH ハンドシェイク中にキー検証を行う際に
27        // CURLOPT_SSH_KEYFUNCTION で設定されたコールバックが呼び出され、
28        // その戻り値として CURLKHMATCH_OK が利用されます。
29        if (str_starts_with($url, 'sftp://') || str_starts_with($url, 'ssh://')) {
30            // CURLOPT_SSH_KEYFUNCTION を設定し、SSH Known Hosts のマッチングを処理。
31            // 初心者向けに、CURLKHMATCH_OK が利用される場所を示しています。
32            // このコールバックは、SSH 接続時に libcurl 内部で呼び出されます。
33            // ここでは、キーマッチングが成功したと仮定して CURLKHMATCH_OK を返します。
34            curl_setopt($ch, CURLOPT_SSH_KEYFUNCTION, function($ch_inner, $public_key, $fingerprint, $key_type) {
35                // 実際のアプリケーションでは、ここで Known Hosts ファイルなどに対する
36                // キー検証ロジックを実装します。
37                // この例では、単純に CURLKHMATCH_OK を返すことで成功をシミュレートします。
38                return CURLKHMATCH_OK; // キーマッチングが成功したと仮定 (値は 0)
39            });
40            // 注意: 実際の SSH 接続には、ユーザー名、パスワード、Known Hosts ファイルのパスなど、
41            // 追加の CURLOPT_SSH_* オプション設定が必要です。
42            // このサンプルは CURLKHMATCH_OK の文脈を示すことに焦点を当てているため、
43            // 完全な SSH 接続設定は省略しています。
44        }
45
46        curl_multi_add_handle($mh, $ch);
47        $chHandles[$index] = $ch;
48    }
49
50    // 3. curl_multi_exec(): すべてのリクエストが完了するまでループ
51    $running = null; // 現在実行中のハンドルの数
52    do {
53        // マルチハンドルのアクティビティをチェックし、リクエストを実行します。
54        // curl_multi_exec の戻り値は、現在実行中のハンドルの数 ($running) を更新します。
55        $status = curl_multi_exec($mh, $running);
56
57        // アクティビティがない場合、CPU 負荷を軽減するために少し待機します。
58        if ($running > 0) {
59            curl_multi_select($mh); // 応答があるまで待機
60        }
61    } while ($running > 0 && $status === CURLM_OK); // CURLM_OK はエラーがないことを示す
62
63    // 4. curl_multi_getcontent() / curl_getinfo(): 個々のリクエスト結果の取得
64    foreach ($chHandles as $index => $ch) {
65        $response = curl_multi_getcontent($ch); // ハンドルからレスポンスを取得
66        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); // HTTP ステータスコードを取得
67
68        if ($response === false) {
69            $responses[$urls[$index]] = 'Error fetching ' . $urls[$index] . ': ' . curl_error($ch);
70        } else {
71            // SSH 概念を示す URL の場合、処理されたことを示します。
72            if (str_starts_with($urls[$index], 'sftp://') || str_starts_with($urls[$index], 'ssh://')) {
73                 $responses[$urls[$index]] = 'SSH concept processed for ' . $urls[$index] . '. (Actual connection requires full SSH config.)';
74            } else {
75                 $responses[$urls[$index]] = 'Success [' . $httpCode . '] from ' . $urls[$index] . ': ' . substr($response, 0, 100) . '...';
76            }
77        }
78
79        // 5. curl_multi_remove_handle(): マルチハンドルからイージーハンドルを削除
80        curl_multi_remove_handle($mh, $ch);
81        // 6. curl_close(): イージーハンドルを閉じる
82        curl_close($ch);
83    }
84
85    // 7. curl_multi_close(): マルチハンドルを閉じる
86    curl_multi_close($mh);
87
88    return $responses;
89}
90
91// サンプル使用: 実際の存在する URL を指定してください。
92// ここでの SSH/SFTP URL は CURLKHMATCH_OK の概念的なデモンストレーション用です。
93// 実際に接続するには、適切な SSH サーバーと設定が必要です。
94$sampleUrls = [
95    'https://www.example.com',
96    'sftp://localhost/remote/path', // 実際の SSH 接続は行われませんが、CURLKHMATCH_OK の文脈を示します
97    'https://www.php.net',
98    'https://www.google.com',
99];
100
101$results = fetchUrlsWithSshConcept($sampleUrls);
102
103foreach ($results as $url => $result) {
104    echo "URL: " . $url . "\n";
105    echo "Result: " . $result . "\n\n";
106}

このPHPコードは、PHP 8のcURL拡張機能を用いて複数のURLからデータを並行して取得する方法と、CURLKHMATCH_OK定数の概念を示します。

CURLKHMATCH_OKは引数を持たず、整数型（int）の値を返すPHP定数です。これはSSHプロトコル通信時にCURLOPT_SSH_KEYFUNCTIONで設定されるコールバック関数が、Known Hostsとのキーマッチング成功をcURLライブラリに伝える際に使用します。

サンプルでは、curl_multi_initで初期化したマルチハンドルへ各URL用のcURLハンドルを追加します。SSHプロトコル（例:sftp://）のURLでは、CURLOPT_SSH_KEYFUNCTIONのコールバック内で、キーマッチング成功を概念的にシミュレートしCURLKHMATCH_OKを返しています。実際のキー検証や完全なSSH接続設定は本サンプルに含まれません。

curl_multi_execでリクエストを並行実行後、curl_multi_getcontentでレスポンスを取得し、使用したハンドルを適切にクローズします。

Copy
1<?php
2
3/**
4 * CURLKHMATCH_OK 定数の値を確認し、CURLE_OK を用いた cURL リクエストの例を示します。
5 *
6 * CURLKHMATCH_OK は、cURL が SSH 接続のホストキーを検証する際に
7 * 使用されるコールバック関数 (CURLOPT_SSH_HOSTKEYFUNCTION) が、
8 * ホストキーのマッチングを問題なく完了したことを示すために返す定数です。
9 * 一般的な HTTP リクエスト処理では直接使用されません。
10 *
11 * CURLE_OK は、cURL 関数がエラーなしで成功したことを示す一般的なエラーコードです。
12 * curl_errno() の戻り値と比較することで、cURL 操作の成功を判断するためによく使われます。
13 */
14function demonstrateCurlConstants(): void
15{
16    // CURLKHMATCH_OK の値を出力します。
17    // これはSSH/SFTP接続のホストキー検証における成功を示す定数です。
18    echo "CURLKHMATCH_OK の値: " . CURLKHMATCH_OK . PHP_EOL;
19
20    // 参考として、cURLの一般的な成功コードである CURLE_OK の値も出力します。
21    // 多くのcURL操作の成功を判断するために使用されます。
22    echo "CURLE_OK の値: " . CURLE_OK . PHP_EOL;
23
24    echo PHP_EOL . "--- CURLE_OK を用いた HTTP GET リクエストの実行例 ---" . PHP_EOL;
25
26    // cURL セッションを初期化
27    $ch = curl_init();
28
29    // リクエスト先のURLを設定
30    curl_setopt($ch, CURLOPT_URL, "http://example.com");
31    // レスポンスを文字列として取得する設定
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
33    // HTTPステータスコードが4xxまたは5xxの場合にcURLエラーとする設定
34    curl_setopt($ch, CURLOPT_FAILONERROR, true);
35    // タイムアウト設定 (秒)
36    curl_setopt($ch, CURLOPT_TIMEOUT, 5);
37
38    // cURL リクエストを実行
39    $response = curl_exec($ch);
40
41    // curl_errno() でエラーコードを取得し、CURLE_OK と比較して成功を判定
42    if (curl_errno($ch) === CURLE_OK) {
43        echo "cURL リクエストは正常に完了しました (エラーコード: " . CURLE_OK . ").\n";
44        // 成功した場合、レスポンスの一部を表示 (長文になる可能性があるので簡略化)
45        if ($response !== false) {
46            echo "レスポンスの先頭100文字: " . substr($response, 0, 100) . "...\n";
47        }
48    } else {
49        // エラーが発生した場合、エラーコードとメッセージを出力
50        echo "cURL リクエスト中にエラーが発生しました。\n";
51        echo "エラーコード: " . curl_errno($ch) . "\n";
52        echo "エラーメッセージ: " . curl_error($ch) . "\n";
53    }
54
55    // cURL セッションを閉じる
56    curl_close($ch);
57}
58
59// 関数を実行して、定数の値と cURL リクエストの動作を確認
60demonstrateCurlConstants();
61
62?>

PHPのcURL拡張機能は、さまざまなプロトコルを用いたデータ転送を行う際に利用されます。このサンプルコードでは、cURLに関連する二つの重要な定数であるCURLKHMATCH_OKとCURLE_OKについて、その役割と使用例を説明しています。

CURLKHMATCH_OKは、主にSSH接続でホストキーを検証する際に使用されるコールバック関数が、ホストキーのマッチングを正常に完了したことを示すために返す定数です。これはCURLOPT_SSH_HOSTKEYFUNCTIONというオプションが設定されている場合に利用され、一般的なHTTPリクエスト処理では直接使用されることはほとんどありません。この定数の戻り値は整数型（int）です。

一方、CURLE_OKは、cURL関数によるほとんどの操作がエラーなく成功したことを示す、汎用的な成功コードです。cURLリクエストの実行後にcurl_errno()関数を呼び出し、その戻り値がCURLE_OKと一致するかどうかを確認することで、操作が正常に完了したかを判断するためによく使われます。この定数の戻り値も整数型（int）です。

サンプルコードでは、まずCURLKHMATCH_OKとCURLE_OKそれぞれの具体的な値を出力して確認します。その後、CURLE_OKを用いたHTTP GETリクエストの実行例として、「http://example.com」へアクセスし、`curl_errno()`の戻り値と`CURLE_OK`を比較することで、リクエストが成功したか失敗したかを判定する方法が具体的に示されています。これにより、cURL操作の成功をプログラムで安全に確認する方法を学ぶことができます。