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

Copy
1<?php
2
3/**
4 * CURLOPT_COOKIEFILE を使用して、指定されたクッキーファイルからクッキーを読み込み、
5 * そのクッキーを含めてHTTPリクエストを実行する例です。
6 *
7 * @param string $url アクセスするターゲットURL。
8 * @param string $cookieFilePath クッキーファイルを保存/読み込むためのパス。
9 * @return string|false リクエストの生レスポンス (ヘッダーとボディを含む)、または失敗した場合は false。
10 */
11function sendRequestWithCookieFile(string $url, string $cookieFilePath): string|false
12{
13    // 初心者向けに、クッキーファイルが存在しない場合にダミーの内容を生成します。
14    // 実際のアプリケーションでは、このファイルは通常、以前のリクエストで
15    // CURLOPT_COOKIEJAR を使って保存されたものや、他のシステムから提供されたものです。
16    if (!file_exists($cookieFilePath)) {
17        // Netscape HTTP Cookie File Format の例
18        // ドメイン  サブドメインを含むか(TRUE/FALSE)  パス  セキュアか(TRUE/FALSE)  有効期限(UNIXタイムスタンプ)  名前  値
19        $dummyCookieContent = "# Netscape HTTP Cookie File\n";
20        $dummyCookieContent .= "example.com\tFALSE\t/\tFALSE\t" . (time() + 3600) . "\tmy_test_cookie\tmy_test_value\n";
21        $dummyCookieContent .= "example.com\tFALSE\t/\tFALSE\t" . (time() + 3600) . "\tanother_cookie\tanother_value\n";
22        
23        if (file_put_contents($cookieFilePath, $dummyCookieContent) === false) {
24            error_log("Error: Could not create dummy cookie file at " . $cookieFilePath);
25            return false;
26        }
27        echo "Info: Created a dummy cookie file for demonstration at: " . $cookieFilePath . "\n\n";
28    }
29
30    // cURL セッションを初期化します。
31    $ch = curl_init();
32
33    if ($ch === false) {
34        error_log("Error: Failed to initialize cURL.");
35        return false;
36    }
37
38    // cURL オプションを設定します。
39    curl_setopt($ch, CURLOPT_URL, $url);                  // リクエストを送信するURL。
40    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);       // レスポンスを文字列として返します。
41    curl_setopt($ch, CURLOPT_HEADER, true);               // レスポンスヘッダも結果に含めます。
42    
43    // ここが CURLOPT_COOKIEFILE の使用例です。
44    // 指定されたファイルからクッキーを読み込み、それらをHTTPリクエストに含めて送信します。
45    curl_setopt($ch, CURLOPT_COOKIEFILE, $cookieFilePath);
46
47    // cURL セッションを実行し、レスポンスを取得します。
48    $response = curl_exec($ch);
49
50    // エラーチェック。
51    if (curl_errno($ch)) {
52        $errorMsg = curl_error($ch);
53        error_log("cURL Error: " . $errorMsg);
54        curl_close($ch);
55        return false;
56    }
57
58    // cURL セッションを閉じます。
59    curl_close($ch);
60
61    return $response;
62}
63
64// --- サンプルコードの実行部分 ---
65
66// 送信されたクッキーを表示するテスト用のURLを使用します。
67// 例: https://httpbin.org/cookies は、受け取ったクッキーをJSON形式で返します。
68$targetUrl = "https://httpbin.org/cookies";
69
70// 一時的なクッキーファイルを作成するためのパス。
71// __DIR__ は現在のスクリプトがあるディレクトリを指します。
72$tempCookieFile = __DIR__ . '/temp_curl_cookiefile.txt';
73
74echo "Sending request to: " . $targetUrl . "\n";
75echo "Using cookie file: " . $tempCookieFile . "\n\n";
76
77// 関数を呼び出してリクエストを実行し、結果を取得します。
78$response = sendRequestWithCookieFile($targetUrl, $tempCookieFile);
79
80if ($response !== false) {
81    echo "--- HTTP Response ---\n";
82    echo $response;
83    echo "\n----------------------\n";
84    echo "上記のレスポンス内に 'my_test_cookie' や 'another_cookie' が含まれていれば、\n";
85    echo "CURLOPT_COOKIEFILE が正常に機能し、クッキーが送信されたことを示します。\n";
86} else {
87    echo "Error: cURL request failed.\n";
88}
89
90// 使用後に一時ファイルを削除します（オプション）。
91if (file_exists($tempCookieFile)) {
92    unlink($tempCookieFile);
93    echo "\nInfo: Cleaned up temporary cookie file: " . $tempCookieFile . "\n";
94}

このサンプルコードは、PHPのcURLライブラリを用いてHTTPリクエストを送信する際に、CURLOPT_COOKIEFILEオプションを使って、ファイルからクッキーを読み込み、リクエストに含める方法を解説しています。CURLOPT_COOKIEFILEは、指定されたパスのファイルからクッキー情報を読み取り、そのクッキーをウェブサーバーへのリクエストと共に送信するようにcURLに指示する定数です。

コードの中心となるsendRequestWithCookieFile関数は、アクセスする$urlと、クッキーが格納されている$cookieFilePathの二つの引数を受け取ります。この関数は、cURLセッションを初期化し、CURLOPT_COOKIEFILEオプションに$cookieFilePathを設定することで、ファイルからクッキーを読み込む設定を有効にしています。もし指定されたクッキーファイルが存在しない場合は、デモンストレーションのために自動的に仮のクッキー情報を含むファイルを生成します。

リクエストの実行後、この関数はサーバーからの応答内容（HTTPヘッダーとボディを含む）を文字列として返しますが、もしリクエストが失敗した場合はfalseを返します。実行例では、受け取ったクッキーを表示するテスト用のURLに対してリクエストを送信し、ファイルから読み込んだクッキーが正しく送られていることを確認しています。これにより、既存のクッキーファイルを利用してウェブサービスにアクセスするシナリオを理解できます。