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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * cURLを使用してHTTPクッキーの送受信を実演する関数。
7 *
8 * この関数は、CURLOPT_COOKIEJARオプションを使ってサーバーからクッキーを受信しファイルに保存し、
9 * 次にCURLOPT_COOKIEとCURLOPT_COOKIEFILEオプションを使ってクッキーを送信する方法を示します。
10 *
11 * @param string $cookieJarPath クッキーを保存および読み込むための一時ファイルパス
12 */
13function demonstrateCurlCookieHandling(string $cookieJarPath = 'cookies.txt'): void
14{
15    echo "--- ステップ1: クッキーの受信 (CURLOPT_COOKIEJAR を使用) ---\n";
16
17    // サーバーにクッキーを設定させるURL
18    $setCookieUrl = 'http://httpbin.org/cookies/set?session_id=abc123&user_name=phpuser';
19    $ch1 = curl_init($setCookieUrl);
20
21    if ($ch1 === false) {
22        echo "エラー: cURL初期化に失敗しました。\n";
23        return;
24    }
25
26    curl_setopt($ch1, CURLOPT_RETURNTRANSFER, true);
27    // 受信したSet-Cookieヘッダーのクッキーをファイルに保存する
28    // この定数は、クッキーファイルを指定し、受信したクッキーをそのファイルに保存します。
29    curl_setopt($ch1, CURLOPT_COOKIEJAR, $cookieJarPath);
30
31    echo "{$setCookieUrl} へリクエストし、受信クッキーを {$cookieJarPath} に保存します。\n";
32    curl_exec($ch1); // レスポンス内容はここでは主要目的ではないため表示しない
33    if (curl_errno($ch1)) {
34        echo "エラー: クッキー受信リクエスト失敗: " . curl_error($ch1) . "\n";
35        curl_close($ch1);
36        return;
37    }
38    curl_close($ch1);
39
40    if (file_exists($cookieJarPath)) {
41        echo "クッキーファイル {$cookieJarPath} が作成されました。内容:\n";
42        echo file_get_contents($cookieJarPath) . "\n\n";
43    } else {
44        echo "警告: クッキーファイル {$cookieJarPath} が作成されませんでした。\n\n";
45    }
46
47    echo "--- ステップ2: クッキーの送信 (CURLOPT_COOKIE および CURLOPT_COOKIEFILE を使用) ---\n";
48
49    // 送信されたクッキーを確認するためのURL
50    $checkCookieUrl = 'http://httpbin.org/get';
51    $ch2 = curl_init($checkCookieUrl);
52
53    if ($ch2 === false) {
54        echo "エラー: cURL初期化に失敗しました。\n";
55        // ステップ1で作成された可能性のあるクッキーファイルを削除
56        if (file_exists($cookieJarPath)) {
57            unlink($cookieJarPath);
58        }
59        return;
60    }
61
62    curl_setopt($ch2, CURLOPT_RETURNTRANSFER, true);
63
64    // CURLOPT_COOKIE: リクエストヘッダーに直接クッキー文字列を設定する
65    // この定数は、送信するクッキーの文字列 (例: "name=value; name2=value2") を設定します。
66    $manualCookie = 'manual_cookie=manual_value; another_custom_cookie=test_data';
67    curl_setopt($ch2, CURLOPT_COOKIE, $manualCookie);
68    echo "CURLOPT_COOKIE で '{$manualCookie}' を送信します。\n";
69
70    // CURLOPT_COOKIEFILE: 指定されたファイルからクッキーを読み込んでリクエストヘッダーに含める
71    if (file_exists($cookieJarPath)) {
72        curl_setopt($ch2, CURLOPT_COOKIEFILE, $cookieJarPath);
73        echo "CURLOPT_COOKIEFILE で {$cookieJarPath} から保存済みクッキーを読み込み、送信します。\n";
74    } else {
75        echo "警告: クッキーファイル {$cookieJarPath} が見つからないため、CURLOPT_COOKIEFILE は使用されません。\n";
76    }
77
78    echo "{$checkCookieUrl} へリクエストを送信し、送信されたクッキーを確認します。\n";
79    $response2 = curl_exec($ch2);
80    if (curl_errno($ch2)) {
81        echo "エラー: クッキー送信リクエスト失敗: " . curl_error($ch2) . "\n";
82    } else {
83        echo "レスポンス (送信したクッキーを確認):\n";
84        $jsonResponse = json_decode($response2, true);
85        if (isset($jsonResponse['headers']['Cookie'])) {
86            echo "HTTPリクエストヘッダーの 'Cookie': " . $jsonResponse['headers']['Cookie'] . "\n";
87        } elseif (isset($jsonResponse['cookies'])) { // 一部のhttpbin.orgバージョンでは'cookies'セクション
88            print_r($jsonResponse['cookies']);
89        } else {
90            echo "クッキー情報がレスポンスから見つかりませんでした。\n";
91        }
92    }
93    curl_close($ch2);
94
95    // クリーンアップ: 作成した一時クッキーファイルを削除
96    if (file_exists($cookieJarPath)) {
97        unlink($cookieJarPath);
98        echo "\nクリーンアップ: 一時クッキーファイル {$cookieJarPath} を削除しました。\n";
99    }
100}
101
102// 関数を実行し、クッキーハンドリングのデモンストレーションを開始します。
103demonstrateCurlCookieHandling();

PHP 8におけるCURLOPT_COOKIEは、cURL拡張機能でHTTPリクエストを送信する際に、サーバーに送るクッキー情報を文字列として直接指定するための定数です。curl_setopt関数にこの定数とクッキー文字列（例: "name=value; name2=value2"）を渡すことで、指定したクッキーがリクエストヘッダーのCookie:フィールドとして含まれて送信されます。

サンプルコードでは、まずCURLOPT_COOKIEJARオプションを使ってサーバーから受信したクッキーをファイルに保存する方法を実演しています。これにより、次のリクエストでそのクッキーを再利用できるようになります。その後、CURLOPT_COOKIEオプションを使って手動で特定のクッキー文字列を設定して送信する様子と、CURLOPT_COOKIEFILEオプションを使って保存されたファイルからクッキーを読み込んで送信する方法を合わせて示しています。

CURLOPT_COOKIEは、特定のクッキーを手動で設定して送信したい場合に特に便利です。一方、CURLOPT_COOKIEFILEは、以前の通信で受け取ったクッキーをファイルから読み込んで自動的に再送信したい場合に利用されます。この定数自体に引数や戻り値はなく、curl_setopt関数に渡す設定値の一つとして機能し、Webアプリケーションなどでログインセッションの維持など、クッキーを使った状態管理を可能にします。

Copy
1<?php
2
3/**
4 * cURLを使って指定されたURLにクッキーを送信し、その応答と受信・管理されたクッキーのリストを表示する。
5 *
6 * この関数は、CURLOPT_COOKIE を用いてリクエストにクッキーを含める方法と、
7 * CURLINFO_COOKIELIST を用いてサーバーから受信した、またはcURLが管理しているクッキーのリストを
8 * 取得する方法を示します。
9 *
10 * @param string $url リクエストを送信するURL。
11 * @param string $cookieString 送信するクッキー文字列 (例: "my_cookie=my_value; another_cookie=another_value")。
12 *                              複数のクッキーはセミコロンで区切ります。
13 * @return void
14 */
15function handleCurlWithCookies(string $url, string $cookieString): void
16{
17    // cURLセッションを初期化します。
18    $ch = curl_init();
19
20    if ($ch === false) {
21        echo "エラー: cURLセッションの初期化に失敗しました。\n";
22        return;
23    }
24
25    // リクエストオプションを設定します。
26    curl_setopt($ch, CURLOPT_URL, $url);
27    // レスポンスを直接出力せず、文字列として取得するように設定します。
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29    // レスポンスヘッダーも取得するように設定します (Set-Cookieヘッダーなどを確認するため)。
30    curl_setopt($ch, CURLOPT_HEADER, true);
31
32    // CURLOPT_COOKIE を使用してHTTPリクエストヘッダーにクッキーを設定します。
33    // これは、クライアントからサーバーへ特定のクッキーを送信するために使われる定数です。
34    // 例: "user_id=123; session_token=abcdefg" のような形式で指定します。
35    curl_setopt($ch, CURLOPT_COOKIE, $cookieString);
36
37    echo "--- cURLリクエスト実行 ---\n";
38    echo "ターゲットURL: " . $url . "\n";
39    echo "送信するクッキー: " . ($cookieString ?: "[なし]") . "\n\n";
40
41    // リクエストを実行し、サーバーからの応答を取得します。
42    $response = curl_exec($ch);
43
44    if ($response === false) {
45        echo "エラー: cURLリクエストの実行中にエラーが発生しました: " . curl_error($ch) . "\n";
46        // エラー発生時はセッションをクローズして終了します。
47        curl_close($ch);
48        return;
49    }
50
51    echo "--- サーバーからの応答 ---\n";
52    echo $response . "\n\n";
53
54    // CURLINFO_COOKIELIST を使用して、cURLが受信または内部で管理しているクッキーのリストを取得します。
55    // これは CURLOPT_COOKIE とは異なり、サーバーから Set-Cookie ヘッダーで返されたクッキーや、
56    // CURLOPT_COOKIEJAR / CURLOPT_COOKIEFILE などでcURLが管理しているクッキーの情報を得るために使われます。
57    // この機能は PHP 8.0 以降で利用可能です。
58    $receivedCookies = curl_getinfo($ch, CURLINFO_COOKIELIST);
59
60    if (!empty($receivedCookies)) {
61        echo "--- cURLが受信または管理しているクッキーのリスト ---\n";
62        foreach ($receivedCookies as $cookie) {
63            echo "- " . $cookie . "\n";
64        }
65        echo "\n";
66    } else {
67        echo "--- cURLが受信または管理しているクッキーはありませんでした ---\n\n";
68    }
69
70    // cURLセッションを閉じ、リソースを解放します。
71    curl_close($ch);
72}
73
74// --- サンプル使用例 ---
75
76// 例 1: CURLOPT_COOKIE を使ってクッキーを送信し、サーバーがそのクッキーを受け取ったか確認する。
77// httpbin.org の /cookies エンドポイントは、送信されたクッキーをJSON形式で応答ボディに含めて返します。
78echo "## 例 1: クッキーを送信し、サーバーからの応答で確認する\n";
79$url1 = "https://httpbin.org/cookies";
80$cookiesToSend1 = "user_id=123; session_token=abcdefg";
81handleCurlWithCookies($url1, $cookiesToSend1);
82
83echo "\n\n------------------------------------------------\n\n";
84
85// 例 2: サーバーから Set-Cookie ヘッダーでクッキーを受信し、CURLINFO_COOKIELIST でそのリストを確認する。
86// この URL は、レスポンスヘッダーに 'Set-Cookie' を含めるように設定されています。
87// cURLは受信したクッキーを内部的に管理し、CURLINFO_COOKIELIST でその情報を取得できます。
88echo "## 例 2: サーバーからクッキーを受信し、そのリストを取得する\n";
89$url2 = "https://httpbin.org/response-headers?Set-Cookie=my_session=xyz123;Path=/;HttpOnly&Set-Cookie=my_pref=darkmode;Expires=Wed, 21 Oct 2070 07:28:00 GMT";
90$cookiesToSend2 = ""; // このリクエストでは、特定のクッキーは送信しません。
91handleCurlWithCookies($url2, $cookiesToSend2);
92

このPHPコードは、cURLライブラリを用いてHTTPリクエストでクッキーを送信する方法と、サーバーから受信したクッキーの情報を取得する方法を示しています。

メインとなる関数handleCurlWithCookiesは、指定されたURLへリクエストを送り、その際に特定のクッキー情報を一緒に送ります。CURLOPT_COOKIEは、このリクエストに含めるクッキー文字列を設定するためのcURLオプション定数です。例えば、ログイン情報やユーザー設定など、クライアントからサーバーへ伝えたいクッキーデータを「name=value; another_name=another_value」といった形式で指定します。

関数はまずcURLセッションを初期化し、CURLOPT_URLで送信先URLを、そしてCURLOPT_COOKIEで送信したいクッキーを設定します。リクエストを実行してサーバーからの応答を受け取った後、CURLINFO_COOKIELISTオプションを使って、サーバーが「Set-Cookie」ヘッダーで返してきたクッキーや、cURLが内部で管理しているクッキーの一覧を取得し表示します。これはCURLOPT_COOKIEが送信するクッキーを定義するのに対し、CURLINFO_COOKIELISTは受信・管理されたクッキーの情報を得る点で異なります。

この関数は、リクエスト先のURLを$url、送信するクッキーの文字列を$cookieStringとして引数に受け取ります。処理が完了しても、特定の値を呼び出し元に返すことはありません（戻り値はvoidです）。これにより、ウェブアプリケーションがクッキーを使ってどのようにサーバーとやり取りするかの基本的な仕組みを理解できます。