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

Copy
1<?php
2
3/**
4 * 指定されたURLからコンテンツをフェッチし、受信したCookieをファイルに保存します。
5 * システムエンジニアを目指す初心者向けに、CURLOPT_COOKIEJARの基本的な使い方をデモンストレーションします。
6 *
7 * @param string $url フェッチするURL。
8 * @param string $cookieJarPath Cookieを保存するファイルのパス。
9 * @return string|false 成功した場合はレスポンスボディ、失敗した場合はfalse。
10 */
11function fetchUrlAndSaveCookies(string $url, string $cookieJarPath): string|false
12{
13    // cURLセッションを初期化します。
14    $ch = curl_init();
15
16    // cURL初期化が失敗した場合はエラーメッセージを出力し、falseを返します。
17    if ($ch === false) {
18        echo "エラー: cURLの初期化に失敗しました。\n";
19        return false;
20    }
21
22    // フェッチするURLを設定します。
23    curl_setopt($ch, CURLOPT_URL, $url);
24
25    // CURLOPT_RETURNTRANSFER を true に設定すると、cURL_exec() は結果を直接出力するのではなく、文字列として返します。
26    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
27
28    // CURLOPT_COOKIEJAR を使用して、受信したCookieを保存するファイルのパスを指定します。
29    // 指定されたファイルが存在しない場合は作成され、存在する場合は上書きされるか、Cookieが追記されます。
30    // このオプションは、以降のリクエストでこれらのCookieを使用するための「Cookieジャー（Cookieの貯蔵庫）」を作成します。
31    curl_setopt($ch, CURLOPT_COOKIEJAR, $cookieJarPath);
32
33    // cURLセッションを実行し、レスポンスを取得します。
34    $response = curl_exec($ch);
35
36    // cURL実行中にエラーが発生した場合は、エラーメッセージを出力します。
37    if ($response === false) {
38        echo "cURLエラー: " . curl_error($ch) . "\n";
39    } else {
40        echo "URL: '{$url}' のフェッチに成功しました。\n";
41        echo "Cookieはファイル '{$cookieJarPath}' に保存されました。\n";
42    }
43
44    // cURLセッションを閉じ、リソースを解放します。
45    curl_close($ch);
46
47    return $response;
48}
49
50// --- サンプルコードの実行例 ---
51
52// Cookieを保存する一時ファイルのパスを定義します。
53// __DIR__ は現在のスクリプトがあるディレクトリを指します。
54$cookieJarFile = __DIR__ . '/my_session_cookies.txt';
55
56// 以前の実行で残ったCookieジャーファイルがあれば削除し、クリーンな状態から開始します。
57if (file_exists($cookieJarFile)) {
58    unlink($cookieJarFile);
59}
60
61// Cookieを設定するテスト用の公開URLを使用します。
62// https://httpbin.org はHTTPリクエスト/レスポンスのテストに便利なサービスです。
63$targetUrl = 'https://httpbin.org/cookies/set?mycookie=testvalue123&anothercookie=hello_world';
64
65echo "--- URLをフェッチしてCookieを保存する試行を開始します ---\n";
66
67// 関数を呼び出し、URLをフェッチしてCookieをファイルに保存します。
68$content = fetchUrlAndSaveCookies($targetUrl, $cookieJarFile);
69
70if ($content !== false) {
71    echo "\n--- Cookieジャーファイル '{$cookieJarFile}' の内容 ---\n";
72    if (file_exists($cookieJarFile)) {
73        echo file_get_contents($cookieJarFile);
74    } else {
75        echo "エラー: Cookieジャーファイルが見つかりません。\n";
76    }
77}
78
79// 使用後、作成した一時ファイルをクリーンアップ（削除）します。
80if (file_exists($cookieJarFile)) {
81    unlink($cookieJarFile);
82    echo "\n一時Cookieファイル '{$cookieJarFile}' は削除されました。\n";
83}
84
85?>

PHPのCURLOPT_COOKIEJARは、cURLを利用してWebサイトと通信する際に、サーバーから受信したHTTP Cookieをファイルに保存するための定数です。このオプションを設定することで、後続のcURLリクエストで保存したCookieを再利用し、Webサイトとのセッションを継続できるようになります。

提供されたサンプルコードでは、fetchUrlAndSaveCookies関数を通してCURLOPT_COOKIEJARの基本的な使い方をデモンストレーションしています。この関数は、指定されたURLにHTTPリクエストを送信し、その際にサーバーから返されるCookieを、引数として渡されたファイルパスに保存します。具体的には、curl_setopt($ch, CURLOPT_COOKIEJAR, $cookieJarPath); のように記述することで、cURLがCookieの保存先ファイルを認識します。curl_exec()の実行後、受信したCookieは指定されたファイルに自動的に書き込まれ、「Cookieジャー」として機能します。

fetchUrlAndSaveCookies関数は、フェッチする$urlとCookieを保存する$cookieJarPathの二つの文字列を引数に取ります。処理が成功した場合はWebサイトのレスポンスボディを文字列として返し、何らかのエラーが発生した場合はfalseを返します。この機能は、ログインが必要なWebサービスとの連携や、特定のセッション状態を維持しながら複数のリクエストを行う際に非常に役立ちます。