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

Copy
1<?php
2
3/**
4 * 指定されたURLからコンテンツを取得する関数。
5 *
6 * この関数はPHPのcURL拡張機能を使用し、ウェブサイトからHTMLなどのコンテンツを
7 * 文字列として取得します。特に、以下のオプションを使用しています。
8 * - CURLOPT_RETURNTRANSFER: 取得したコンテンツを直接出力せず、関数の戻り値として文字列で返します。
9 * - CURLOPT_FOLLOWLOCATION: サーバーがリダイレクトを指示した場合、自動的にその新しいURLを追跡します。
10 * - CURLOPT_REDIR_PROTOCOLS_STR: リダイレクトを許可するプロトコルを文字列で指定します。
11 *   これにより、セキュリティを考慮し、特定のプロトコル（例: HTTPとHTTPS）のみにリダイレクトを制限できます。
12 *
13 * @param string $url 取得したいウェブページのURL。
14 * @return string|null 取得したコンテンツの文字列、またはエラーが発生した場合はnull。
15 */
16function fetchUrlContent(string $url): ?string
17{
18    // cURLセッションを初期化
19    $ch = curl_init();
20
21    // cURLセッションの初期化に失敗した場合
22    if ($ch === false) {
23        error_log('cURL初期化エラー: ' . curl_error($ch));
24        return null;
25    }
26
27    // オプションを設定
28    // 1. 取得するURLを指定
29    curl_setopt($ch, CURLOPT_URL, $url);
30
31    // 2. 実行結果を文字列として返すように設定（キーワード: CURLOPT_RETURNTRANSFER）
32    //    これをtrueにしないと、curl_exec()はコンテンツを直接出力します。
33    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
34
35    // 3. リダイレクトがあった場合に自動でその新しいURLを追跡するように設定
36    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
37
38    // 4. リダイレクトを許可するプロトコルを文字列で指定（リファレンス情報: CURLOPT_REDIR_PROTOCOLS_STR）
39    //    この例では、HTTPとHTTPSへのリダイレクトのみを許可します。
40    curl_setopt($ch, CURLOPT_REDIR_PROTOCOLS_STR, 'http,https');
41
42    // 5. 接続のタイムアウトを10秒に設定（オプション）
43    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
44
45    // cURLセッションを実行し、コンテンツを取得
46    $response = curl_exec($ch);
47
48    // cURL実行中にエラーが発生した場合
49    if (curl_errno($ch)) {
50        error_log('cURL実行エラー: ' . curl_error($ch));
51        $response = null; // エラー時は結果をnullとする
52    }
53
54    // cURLセッションを閉じる
55    curl_close($ch);
56
57    return $response;
58}
59
60// --- サンプルコードの実行例 ---
61// 実際に存在するURLを指定してください。リダイレクトを含むURLだとCURLOPT_REDIR_PROTOCOLS_STRの動作が確認しやすいです。
62$targetUrl = 'https://example.com'; 
63
64echo "URL: {$targetUrl} からコンテンツを取得中...\n";
65
66$content = fetchUrlContent($targetUrl);
67
68if ($content !== null) {
69    echo "--- 取得したコンテンツの最初の200文字 --- \n";
70    // マルチバイト文字列対応のためにmb_substrを使用
71    echo mb_substr($content, 0, 200) . "...\n";
72    echo "--- コンテンツ取得完了 --- \n";
73    // var_dump($content); // 全てのコンテンツを表示したい場合はコメントアウトを外す
74} else {
75    echo "URLからコンテンツを取得できませんでした。エラーログを確認してください。\n";
76}

このサンプルコードは、PHPのcURL拡張機能を利用して、指定されたURLからウェブコンテンツを安全に取得する方法を示しています。fetchUrlContent関数は、引数として取得したいウェブページのURL（$url）を受け取り、そのページのHTMLなどのコンテンツを文字列として返します。コンテンツの取得に失敗した場合やエラーが発生した場合は、nullを返します。

関数内ではまずcurl_init()でcURLセッションを初期化し、その後curl_setopt()関数を使って様々な動作オプションを設定します。CURLOPT_URLで取得対象のURLを指定し、CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果が直接出力されず、関数の戻り値として文字列で取得できるようになります。また、CURLOPT_FOLLOWLOCATIONをtrueに設定すると、サーバーがリダイレクトを指示した場合に、cURLが自動的に新しいURLを追跡してコンテンツを取得します。

ここで特に注目すべきはCURLOPT_REDIR_PROTOCOLS_STRオプションです。このオプションは、リダイレクトを許可するプロトコルをカンマ区切りの文字列で指定します。このサンプルコードでは「http,https」と設定されており、これによりHTTPとHTTPSプロトコルへのリダイレクトのみが許可され、セキュリティ上の理由から、予期せぬプロトコル（例えばFTPなど）へのリダイレクトを防ぐことができます。

全てのオプションを設定した後、curl_exec()でHTTPリクエストを実行しコンテンツを取得します。実行中にエラーが発生した場合はcurl_errno()でエラーを確認し、エラーログに記録します。最終的にcurl_close()でcURLセッションを閉じ、取得したコンテンツを呼び出し元に返します。サンプル実行部分では、取得したコンテンツの最初の200文字を表示して、正常に動作することを確認しています。

Copy
1<?php
2
3/**
4 * 指定されたURLからコンテンツを取得し、リダイレクトを自動的に処理します。
5 *
6 * この関数はCURL拡張機能を使用してHTTPリクエストを送信し、
7 * リダイレクトが発生した場合に自動的に追跡します。
8 *
9 * @param string $url 取得するターゲットURL。
10 * @param int $maxRedirects 追跡する最大リダイレクト回数。デフォルトは5回。
11 * @return string|false 成功した場合は取得したコンテンツの文字列、失敗した場合はfalse。
12 */
13function fetchUrlWithRedirectHandling(string $url, int $maxRedirects = 5): string|false
14{
15    // cURLセッションを初期化します。
16    $ch = curl_init();
17
18    // cURLオプションを設定します。
19    // ターゲットURLを指定します。
20    curl_setopt($ch, CURLOPT_URL, $url);
21    // curl_exec() が結果を文字列として返すように設定します。
22    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
23    // リダイレクトが発生した場合に自動的に追跡するように設定します。（キーワードに関連）
24    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
25    // 追跡するリダイレクトの最大回数を設定します。
26    curl_setopt($ch, CURLOPT_MAXREDIRS, $maxRedirects);
27
28    // リファレンス情報に基づく定数: CURLOPT_REDIR_PROTOCOLS_STR
29    // この定数はPHP 8.2で導入されましたが、同時に非推奨となり、PHP 8.3で削除されました。
30    // そのため、PHP 8.2以外のPHP 8系では存在しない可能性があります。
31    // 許可するリダイレクトプロトコルをカンマ区切りの文字列で指定します（例: 'http,https'）。
32    if (defined('CURLOPT_REDIR_PROTOCOLS_STR')) {
33        curl_setopt($ch, CURLOPT_REDIR_PROTOCOLS_STR, 'http,https');
34    }
35
36    // SSL証明書の検証を無効化する設定（開発/テスト環境でのみ使用し、本番環境では非推奨です）。
37    // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
38    // curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
39
40    // cURLリクエストを実行し、結果を取得します。
41    $response = curl_exec($ch);
42
43    // cURLエラーが発生したかチェックします。
44    if (curl_errno($ch)) {
45        // エラーが発生した場合、エラーログに出力します。
46        error_log('cURL Error (' . curl_errno($ch) . '): ' . curl_error($ch));
47        $response = false;
48    }
49
50    // cURLセッションを閉じ、リソースを解放します。
51    curl_close($ch);
52
53    return $response;
54}
55
56// --- サンプル使用例 ---
57
58// 1回リダイレクトするHTTPbinのテストURL
59$targetUrl = 'https://httpbin.org/redirect/1'; 
60
61// リダイレクトしないURLの例
62// $targetUrl = 'https://example.com'; 
63
64echo "URLへのアクセスを開始します: " . $targetUrl . PHP_EOL;
65$content = fetchUrlWithRedirectHandling($targetUrl);
66
67if ($content !== false) {
68    echo "URLコンテンツの取得に成功しました。取得した文字数: " . strlen($content) . PHP_EOL;
69    // 取得したコンテンツの一部を表示することも可能です。
70    // echo "--- 取得コンテンツの冒頭500バイト ---" . PHP_EOL;
71    // echo substr($content, 0, 500) . "..." . PHP_EOL;
72} else {
73    echo "URLコンテンツの取得に失敗しました: " . $targetUrl . PHP_EOL;
74    echo "エラーについてはサーバーのエラーログを確認してください。" . PHP_EOL;
75}

このサンプルコードは、PHPのcURL拡張機能を用いて、指定されたURLからWebコンテンツを取得し、必要に応じてリダイレクトを自動的に処理するfetchUrlWithRedirectHandling関数を示しています。この関数は、取得したいURLを$url引数として受け取り、追跡する最大リダイレクト回数を$maxRedirects引数（デフォルトは5回）で設定できます。関数内部では、まずcurl_init()でcURLセッションを開始し、curl_setopt()で様々なオプションを設定します。特に、CURLOPT_URLでターゲットURLを指定し、CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果が文字列として返されるようにします。キーワードであるCURLOPT_FOLLOWLOCATIONをtrueに設定することで、サーバーからリダイレクト応答があった際に自動的にそのリダイレクト先へ追跡するように動作します。また、CURLOPT_MAXREDIRSで追跡するリダイレクトの最大回数を指定できます。リファレンス情報にあるCURLOPT_REDIR_PROTOCOLS_STRは、許可するリダイレクトプロトコルを文字列で指定する定数ですが、PHP 8.2で導入と同時に非推奨となり、PHP 8.3で削除されたため、存在する場合のみ設定するようになっています。リクエストの実行後、エラーが発生していればerror_logに出力し、最終的に取得したコンテンツの文字列、または失敗時にはfalseを返します。これにより、Webサイトの情報を効率的に取得できます。