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

Copy
1<?php
2
3/**
4 * CURLOPT_AUTOREFERER オプションを有効にしてHTTPリクエストを送信するサンプル関数。
5 *
6 * このオプションをtrueに設定すると、cURLはHTTPリダイレクト発生時に
7 * 自動的にRefererヘッダをセットします。
8 * これは、ウェブサイトがリダイレクトを処理する際に、元のページがどこであったかを
9 * サーバーに伝える必要がある場合に役立ちます。
10 *
11 * @param string $url リクエストを送信するURL。
12 * @return string|false 成功した場合はレスポンスデータ、失敗した場合はfalse。
13 */
14function sendHttpRequestWithAutoReferer(string $url): string|false
15{
16    // cURLハンドルの初期化
17    // HTTPリクエストを行うための準備をします。
18    $ch = curl_init();
19
20    // ハンドルが正常に初期化されたかを確認
21    if ($ch === false) {
22        echo "エラー: cURLハンドルの初期化に失敗しました。\n";
23        return false;
24    }
25
26    // オプションの設定
27    // cURLリクエストの様々な動作をここで定義します。
28
29    // 取得するURLを設定します。
30    curl_setopt($ch, CURLOPT_URL, $url);
31
32    // 実行結果を文字列として返すように設定します。
33    // これをtrueにしないと、curl_exec()は直接結果を出力してしまいます。
34    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
35
36    // HTTPリダイレクトが発生した場合に、cURLが自動的に新しいロケーションを追跡するように設定します。
37    // CURLOPT_AUTOREFERERはCURLOPT_FOLLOWLOCATIONがtrueの場合にのみ意味を持ちます。
38    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
39
40    // CURLOPT_AUTOREFERERをtrueに設定します。
41    // これにより、cURLがリダイレクトを追跡する際に、自動的にRefererヘッダを生成し送信します。
42    // 例えば、ページAからページBへリダイレクトされた場合、ページBへのリクエストにはRefererとしてページAのURLがセットされます。
43    // このオプションの効果は、リクエスト先のサーバーで送信されたRefererヘッダを確認することで確認できます。
44    curl_setopt($ch, CURLOPT_AUTOREFERER, true);
45
46    // HTTPリクエストの実行
47    // 設定したオプションに基づいて、実際に通信を行います。
48    $response = curl_exec($ch);
49
50    // エラーチェック
51    // リクエスト中に問題が発生しなかったかを確認します。
52    if (curl_errno($ch)) {
53        echo 'cURLエラーが発生しました (' . curl_errno($ch) . '): ' . curl_error($ch) . "\n";
54        curl_close($ch);
55        return false;
56    }
57
58    // cURLハンドルのクローズ
59    // 使用したリソースを解放し、リクエストを終了します。
60    curl_close($ch);
61
62    return $response;
63}
64
65// --- サンプル使用例 ---
66// cURLオプション CURLOPT_AUTOREFERER の動作を確認するためのテストURL。
67// httpbin.org/redirect/N はN回リダイレクトするテスト用のエンドポイントです。
68// ここでは、3回リダイレクトするURLを設定します。
69$testUrl = "http://httpbin.org/redirect/3";
70
71echo "指定されたURLへのHTTPリクエストを開始します: " . $testUrl . "\n";
72
73// sendHttpRequestWithAutoReferer関数を呼び出してリクエストを送信
74$result = sendHttpRequestWithAutoReferer($testUrl);
75
76if ($result !== false) {
77    echo "リクエストが成功しました。受信したデータの一部を表示します:\n";
78    // 受信したデータが非常に長い場合があるので、最初の500文字だけを表示します。
79    echo mb_substr($result, 0, 500) . "...\n";
80} else {
81    echo "リクエストが失敗しました。エラーメッセージを確認してください。\n";
82}

このPHPサンプルコードは、HTTPリクエストを送信する際にCURLOPT_AUTOREFERERオプションを有効にする方法を示しています。CURLOPT_AUTOREFERERは、cURLがHTTPリダイレクトを処理する際に、自動的にRefererヘッダを生成し送信するための定数です。これにより、リダイレクト先のサーバーは、どのURLからリクエストが来たのかを知ることができます。

サンプル内のsendHttpRequestWithAutoReferer関数は、指定された$urlに対してHTTPリクエストを実行します。この関数は引数としてリクエスト対象のURL（文字列）を受け取り、リクエストが成功した場合はサーバーからのレスポンスデータ（文字列）を、失敗した場合はfalseを返します。

関数内では、まずcurl_init()でcURLセッションを初期化し、各種オプションを設定しています。特に、CURLOPT_FOLLOWLOCATIONをtrueに設定することで、HTTPリダイレクトがあった場合にcURLが自動的に新しい場所へ追跡するようにしています。そして、curl_setopt($ch, CURLOPT_AUTOREFERER, true);と設定することで、このリダイレクトの追跡時に、前のページのURLがRefererヘッダとして自動的に追加されるようになります。これは、ウェブサーバーがリダイレクトの流れを把握したり、アクセス元に基づく処理を行う場合に役立ちます。

最後に、curl_exec()でリクエストを実行し、結果を返しています。サンプル使用例では、リダイレクトを伴うテストURLを用いて、このオプションが正しく動作することを確認しています。

Copy
1<?php
2
3/**
4 * 指定されたURLに対してcURLリクエストを実行し、
5 * CURLOPT_AUTOREFERERオプションの使用例を示します。
6 *
7 * この関数は、リダイレクトが発生した場合にRefererヘッダーを自動的に更新するようcURLを設定します。
8 * 複数のcURLオプションを一度に設定するためにcurl_setopt_array()を使用します。
9 *
10 * @param string $url アクセスするターゲットURL。
11 * @return string|false リクエストが成功した場合は取得したコンテンツ、失敗した場合はfalse。
12 */
13function executeCurlRequestWithAutoReferer(string $url)
14{
15    // 1. cURLセッションを初期化します。
16    // cURLリクエストを行うためのハンドルを取得します。
17    $ch = curl_init();
18
19    // 2. cURLオプションを連想配列で定義します。
20    // ここでCURLOPT_AUTOREFERERを含む、必要なオプションを設定します。
21    $options = [
22        CURLOPT_URL            => $url,             // アクセスするURL
23        CURLOPT_RETURNTRANSFER => true,             // 実行結果を文字列として返すように設定（trueの場合、echoではなく変数に代入される）
24        CURLOPT_FOLLOWLOCATION => true,             // サーバーがリダイレクトを返した場合に、リダイレクト先を自動的に追跡する
25        CURLOPT_AUTOREFERER    => true,             // CURLOPT_FOLLOWLOCATIONが有効な場合、リダイレクト追跡時にRefererヘッダーを自動更新する
26        CURLOPT_TIMEOUT        => 30,               // 接続試行に許可される最大秒数
27        CURLOPT_MAXREDIRS      => 5,                // リダイレクトの最大回数
28        // その他のcURLオプションが必要な場合はここに追加します。
29    ];
30
31    // 3. curl_setopt_array() を使用して、定義した複数のオプションを一度に設定します。
32    // これにより、curl_setopt() を複数回呼び出すよりもコードが簡潔になります。
33    if (!curl_setopt_array($ch, $options)) {
34        // オプションの設定に失敗した場合のエラーハンドリング
35        error_log("cURLオプションの設定に失敗しました: " . curl_error($ch));
36        curl_close($ch);
37        return false;
38    }
39
40    // 4. cURLリクエストを実行し、結果を取得します。
41    $response = curl_exec($ch);
42
43    // 5. エラーチェックを行います。
44    // cURLの実行中にエラーが発生した場合は、その情報を取得してログに出力します。
45    if (curl_errno($ch)) {
46        error_log("cURLエラーが発生しました: " . curl_error($ch));
47        $response = false; // エラーがあった場合はfalseを返す
48    }
49
50    // 6. cURLセッションを終了し、リソースを解放します。
51    curl_close($ch);
52
53    return $response;
54}
55
56// ----------------------------------------------------
57// サンプルコードの実行部分
58// ----------------------------------------------------
59
60// アクセスするターゲットURLを指定します。
61// 例として、Googleのトップページを使用します。
62$targetUrl = "https://www.google.com/";
63
64echo "cURLリクエストを開始します: " . $targetUrl . PHP_EOL;
65
66// 定義した関数を呼び出してcURLリクエストを実行します。
67$result = executeCurlRequestWithAutoReferer($targetUrl);
68
69if ($result !== false) {
70    echo "cURLリクエストが成功しました。" . PHP_EOL;
71    echo "取得したコンテンツの最初の200文字を表示します:" . PHP_EOL;
72    echo substr($result, 0, 200) . "..." . PHP_EOL; // 取得したコンテンツの一部を表示
73} else {
74    echo "cURLリクエストが失敗しました。詳細についてはエラーログを確認してください。" . PHP_EOL;
75}
76
77?>

このPHPサンプルコードは、cURLライブラリを用いて指定されたURLへHTTPリクエストを送信する方法と、CURLOPT_AUTOREFERERオプションの具体的な利用方法を示しています。特に、複数のcURLオプションを効率的に一度に設定できるcurl_setopt_array()関数の使い方を学ぶことができます。

CURLOPT_AUTOREFERERは、CURLOPT_FOLLOWLOCATIONオプションが有効な場合、ウェブサイトがリダイレクトを指示した際に、cURLが自動的に元のページのURLをRefererヘッダーとして新しいリクエストに含めるように設定する定数です。これにより、リダイレクト後のページでも参照元情報が正しく伝達されます。サンプルコードでは、CURLOPT_AUTOREFERER => trueと設定することでこの機能を有効にしています。

コードはまずcurl_init()でcURLセッションを開始し、HTTPリクエストを実行するための準備をします。次に、アクセスするURL（CURLOPT_URL）、レスポンスを文字列として返す設定（CURLOPT_RETURNTRANSFER）、リダイレクトを自動追跡する設定（CURLOPT_FOLLOWLOCATION）、そして前述のCURLOPT_AUTOREFERERを含む必要なオプションを連想配列として定義します。この連想配列をcurl_setopt_array()関数の第2引数に渡すことで、これらのオプションを一括でcURLセッションに適用しています。これにより、個別にcurl_setopt()を呼び出す手間を省き、コードの可読性と保守性を高めています。

オプション設定後、curl_exec()で実際にリクエストを実行し、その結果を取得します。リクエスト中にエラーが発生した場合は、curl_errno()でエラーを検出し、適切なエラー処理を行います。最後に、curl_close()でcURLセッションを閉じ、使用したリソースを解放します。

executeCurlRequestWithAutoReferer関数は、引数としてアクセス先のURL（$url）を受け取り、成功すれば取得したコンテンツを文字列として、失敗すればfalseを戻り値として返します。これにより、簡単にHTTPリクエスト処理を再利用できます。