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

Copy
1<?php
2
3/**
4 * 指定されたURLのリモートファイルの最終変更時刻を取得します。
5 *
6 * CURLOPT_FILETIME オプションを使用して、HTTPヘッダーからファイルタイムスタンプを取得します。
7 *
8 * @param string $url 最終変更時刻を取得したいファイルのURL。
9 * @return string|null ファイルの最終変更時刻 (YYYY-MM-DD HH:MM:SS 形式) を返すか、
10 *                     取得に失敗した場合は null を返します。
11 */
12function getRemoteFileModifiedTime(string $url): ?string
13{
14    // cURLセッションを初期化
15    $ch = curl_init();
16
17    // cURL初期化に失敗した場合のハンドリング
18    if ($ch === false) {
19        error_log("cURLセッションの初期化に失敗しました。");
20        return null;
21    }
22
23    // 転送オプションを設定
24    // 1. リモートファイルの最終変更時刻を取得するように指示
25    curl_setopt($ch, CURLOPT_FILETIME, true);
26    // 2. 取得対象のURLを設定
27    curl_setopt($ch, CURLOPT_URL, $url);
28    // 3. レスポンスの本体ではなく、ヘッダーのみを取得する (ファイルのダウンロードをしないため)
29    curl_setopt($ch, CURLOPT_NOBODY, true);
30    // 4. cURL_exec() の結果を文字列として返します (標準出力には出力しません)
31    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
32
33    // cURLセッションを実行
34    $success = curl_exec($ch);
35
36    $fileTime = null;
37    if ($success) {
38        // cURLINFO_FILETIME を使って、取得したファイル変更時刻 (UNIXタイムスタンプ) を取得
39        // CURLOPT_FILETIME が true に設定されている場合に利用可能
40        $unixTimestamp = curl_getinfo($ch, CURLINFO_FILETIME);
41
42        // 時刻が有効な場合 (通常は -1 ではない)
43        if ($unixTimestamp !== -1) {
44            // UNIXタイムスタンプを読みやすい日付形式に変換
45            $fileTime = date('Y-m-d H:i:s', $unixTimestamp);
46        } else {
47            error_log("URL: " . $url . " のリモートファイル変更時刻は利用できません。");
48        }
49    } else {
50        // cURL実行中にエラーが発生した場合
51        $error = curl_error($ch);
52        error_log("URL: " . $url . " のcURLエラー: " . $error);
53    }
54
55    // cURLセッションを閉じる
56    curl_close($ch);
57
58    return $fileTime;
59}
60
61// --- 使用例 ---
62// 実際に存在するURLを設定してください。HTTP HEADリクエストに応答するURLが適しています。
63$targetUrl = 'https://www.example.com/';
64$modifiedTime = getRemoteFileModifiedTime($targetUrl);
65
66if ($modifiedTime !== null) {
67    echo "URL: " . $targetUrl . "\n";
68    echo "最終変更時刻: " . $modifiedTime . "\n";
69} else {
70    echo "URL: " . $targetUrl . " の最終変更時刻を取得できませんでした。\n";
71}

このPHPサンプルコードは、cURL拡張機能を利用して、指定されたURLのリモートファイルの最終変更時刻を取得する方法を示しています。

コードの中心となるCURLOPT_FILETIME定数は、cURLオプションの一つで、これをtrueに設定することで、cURLはHTTPヘッダーからリモートファイルの最終変更時刻を取得するようになります。これにより、ファイルのダウンロードを行わずに、更新日時のみを確認できます。

getRemoteFileModifiedTime関数は、最終変更時刻を取得したいファイルのURLを文字列型の引数$urlとして受け取ります。関数内では、まずcURLセッションを初期化し、CURLOPT_FILETIMEをtrueに、対象URLをCURLOPT_URLに設定します。さらに、CURLOPT_NOBODYをtrueに設定することで、ファイル本体ではなくヘッダー情報のみを取得し、効率的な処理を実現しています。

cURLセッションの実行後、curl_getinfo関数とCURLINFO_FILETIME定数を使って、取得した最終変更時刻をUNIXタイムスタンプ形式で取得します。このタイムスタンプが有効な場合（通常は-1以外の場合）、date関数を用いて「YYYY-MM-DD HH:MM:SS」形式の読みやすい文字列に変換して返します。

もしcURLの実行に失敗したり、最終変更時刻が取得できなかったりした場合は、関数はnullを返します。この機能は、対象のウェブサーバーがHTTPのLast-Modifiedヘッダーを提供している場合に利用可能です。

Copy
1<?php
2
3/**
4 * 指定されたURLからコンテンツを安全に取得するサンプルコードです。
5 *
6 * システムエンジニアを目指す初心者向けに、PHPのCURL拡張機能を用いた
7 * ウェブリソースへのアクセス方法と、特に「CURLOPT_TIMEOUT」定数を
8 * 使ったタイムアウト設定の基本を説明します。
9 *
10 * @param string $url 取得するウェブページのURL。
11 * @param int $timeoutSeconds 接続とデータ転送の合計許容秒数。この時間を超えるとCURLは中止されます。
12 * @return void
13 */
14function fetchUrlWithTimeout(string $url, int $timeoutSeconds): void
15{
16    // 1. CURLセッションの初期化
17    // `curl_init()` は新しいCURLセッションを開始し、そのセッションを操作するためのハンドルを返します。
18    // ウェブページへのアクセスを開始する前に、必ずこの関数を呼び出します。
19    $ch = curl_init();
20
21    // 初期化が失敗した場合の処理
22    if ($ch === false) {
23        echo "エラー: CURLセッションの初期化に失敗しました。\n";
24        return;
25    }
26
27    // 2. CURLオプションの設定
28    // `curl_setopt()` は、初期化したCURLセッションのさまざまな動作をカスタマイズするために使用されます。
29    // PHP 8では型ヒントや名前付き引数がより活用されますが、ここでは従来の書き方で記述します。
30
31    // 取得するURLを設定します。
32    curl_setopt($ch, CURLOPT_URL, $url);
33
34    // 取得した結果を直接出力するのではなく、文字列として関数に返すように設定します。
35    // これがない場合、`curl_exec()` の結果は直接ウェブサーバーに出力されます。
36    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
37
38    // キーワードに最も関連するオプション「CURLOPT_TIMEOUT」を設定します。
39    // このオプションは、CURLが操作を完了するために許容する合計時間を秒単位で設定します。
40    // 例えば、30秒に設定すると、CURLは30秒以内に接続、データ転送を試み、
41    // それを超えるとエラーを発生させて中止します。
42    curl_setopt($ch, CURLOPT_TIMEOUT, $timeoutSeconds);
43
44    // ウェブサーバーからのリダイレクト（例: HTTP 301, 302）を自動的に追跡するように設定します。
45    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
46
47    // 3. CURLセッションの実行
48    // `curl_exec()` は、設定されたオプションに基づいてCURL操作を実行します。
49    // `CURLOPT_RETURNTRANSFER` が `true` の場合、取得したウェブページの内容が文字列として返されます。
50    // そうでない場合、成功すれば `true`、失敗すれば `false` が返されます。
51    $response = curl_exec($ch);
52
53    // 4. エラーの確認と結果の表示
54    // `curl_errno()` は、直前のCURL操作で発生したエラーの番号を返します。0はエラーがないことを意味します。
55    if (curl_errno($ch)) {
56        // `curl_error()` は、直前のCURL操作で発生したエラーのメッセージを返します。
57        $error_message = curl_error($ch);
58        echo "エラー: CURL操作中に問題が発生しました（URL: {$url}、タイムアウト: {$timeoutSeconds}秒）。\n";
59        echo "エラーメッセージ: {$error_message}\n";
60    } else {
61        // 成功した場合、取得したコンテンツの最初の500文字を表示します。
62        // （コンテンツ全体を表示すると長くなりすぎる場合があるため）
63        echo "成功: URL '{$url}' からの応答（タイムアウト: {$timeoutSeconds}秒）。\n";
64        echo "--- 応答コンテンツ（一部） ---\n";
65        echo mb_substr($response, 0, 500);
66        if (mb_strlen($response) > 500) {
67            echo "...\n";
68        } else {
69            echo "\n";
70        }
71        echo "---------------------------\n";
72    }
73
74    // 5. CURLセッションのクローズ
75    // `curl_close()` はCURLセッションを閉じ、関連付けられたすべてのリソースを解放します。
76    // プログラムのメモリを効率的に管理するために、操作が完了したら必ず呼び出すべきです。
77    curl_close($ch);
78}
79
80// --- サンプル使用例 ---
81
82echo "--- 正常な接続とコンテンツ取得のテスト（タイムアウト10秒）---\n";
83// 存在するURLに対して十分なタイムアウトを設定し、成功を期待します。
84fetchUrlWithTimeout("https://example.com", 10);
85echo "\n";
86
87echo "--- 意図的に短いタイムアウトでエラーを発生させるテスト（タイムアウト0.1秒）---\n";
88// 処理が完了する前にタイムアウトが発生するように、非常に短い時間を設定します。
89// これにより、CURLがエラーメッセージを出力する動作を確認できます。
90fetchUrlWithTimeout("https://example.com", 0.1);
91echo "\n";
92
93echo "--- 存在しないURLへのアクセスとタイムアウトのテスト（タイムアウト5秒）---\n";
94// 存在しないドメインや不正なURLへのアクセスも、タイムアウト設定が役立ちます。
95fetchUrlWithTimeout("http://nonexistent-domain-php-test-12345.com", 5);
96
97?>

PHPのCURL拡張機能は、ウェブサイトからコンテンツを取得するために使用される強力なツールです。このサンプルコードは、CURLを用いたウェブコンテンツの安全な取得方法と、特に「CURLOPT_TIMEOUT」定数によるタイムアウト設定の基本を、システムエンジニアを目指す初心者向けに説明します。

fetchUrlWithTimeout関数は、コンテンツを取得するウェブページのURLを$urlとして、CURL操作全体の最大許容時間を秒単位で$timeoutSecondsとして受け取ります。この関数は戻り値を持たず（void）、処理結果を直接画面に出力します。

関数内部では、curl_init()でCURLセッションを開始し、curl_setopt()で動作をカスタマイズします。CURLOPT_TIMEOUTは、接続からデータ転送までの合計時間を制限し、指定した時間を超えた場合にCURL操作を中止させる重要なオプションです。これにより、サーバーからの応答が遅い、または応答がない場合でもプログラムが長時間停止するのを防ぎます。CURLOPT_URLで取得先URLを、CURLOPT_RETURNTRANSFERで結果を文字列として返すよう設定後、curl_exec()で実行します。処理後、curl_errno()やcurl_error()で問題を確認し、curl_close()でリソースを解放します。サンプルコードでは、様々なタイムアウト設定でCURLの挙動を試すことができます。