【PHP8.x】link()関数の使い方

Copy
1<?php
2
3/**
4 * 指定されたファイルをターゲットとしてハードリンクを作成し、動作を確認する関数。
5 *
6 * link()関数はディレクトリへのハードリンクは作成できません。
7 * この関数は一時的なディレクトリとファイルを生成し、ハードリンクの作成と動作の検証を行います。
8 *
9 * @param string $workingDirPrefix 一時ディレクトリのプレフィックス
10 * @return bool 成功した場合はtrue、失敗した場合はfalseを返します。
11 */
12function demonstrateHardLink(string $workingDirPrefix = 'hard_link_test_') : bool
13{
14    // 一時的な作業ディレクトリをシステムの一時ディレクトリ内に生成
15    $workingDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid($workingDirPrefix);
16    $sourceFileName = 'original_file.txt';
17    $linkFileName = 'hard_link_to_original.txt';
18
19    $sourceFilePath = $workingDir . DIRECTORY_SEPARATOR . $sourceFileName;
20    $linkFilePath = $workingDir . DIRECTORY_SEPARATOR . $linkFileName;
21
22    echo "--- ハードリンク作成のデモンストレーション --- \n";
23    echo "作業ディレクトリ: {$workingDir}\n";
24
25    // 1. 作業ディレクトリの作成
26    if (!mkdir($workingDir, 0777, true)) {
27        echo "エラー: 作業ディレクトリ '{$workingDir}' の作成に失敗しました。\n";
28        return false;
29    }
30    echo "作業ディレクトリ '{$workingDir}' を作成しました。\n";
31
32    // 2. リンク元ファイルの作成
33    $originalContent = "これは元のファイルの内容です。\n";
34    if (file_put_contents($sourceFilePath, $originalContent) === false) {
35        echo "エラー: 元ファイル '{$sourceFileName}' の作成に失敗しました。\n";
36        // エラー時は後でクリーンアップ
37        cleanup($workingDir);
38        return false;
39    }
40    echo "元ファイル '{$sourceFileName}' を作成し、内容を書き込みました。\n";
41    echo "元のファイルの内容: " . file_get_contents($sourceFilePath);
42
43    // 3. link() 関数によるハードリンクの作成
44    echo "ハードリンク '{$linkFileName}' を '{$sourceFileName}' へ作成します...\n";
45    if (link($sourceFilePath, $linkFilePath)) {
46        echo "成功: ハードリンク '{$linkFileName}' が作成されました。\n";
47        echo "ハードリンクは元のファイルと同じInode（データの実体）を指すため、内容を共有します。\n";
48        echo "リンクされたファイルの内容: " . file_get_contents($linkFilePath);
49
50        // 4. 元ファイルを削除しても、ハードリンクからアクセス可能であることを確認
51        echo "元のファイル '{$sourceFileName}' を削除します...\n";
52        if (unlink($sourceFilePath)) {
53            echo "元のファイルは削除されました。\n";
54            echo "しかし、リンクされたファイル '{$linkFileName}' からはまだデータにアクセスできます。\n";
55            echo "リンクされたファイル '{$linkFileName}' の内容 (元のファイル削除後): " . file_get_contents($linkFilePath);
56        } else {
57            echo "警告: 元ファイルの削除に失敗しました。\n";
58        }
59        $success = true;
60    } else {
61        echo "エラー: ハードリンク '{$linkFileName}' の作成に失敗しました。\n";
62        // エラーの原因（権限不足など）をより詳しく表示
63        $error = error_get_last();
64        if ($error) {
65            echo "詳細: " . $error['message'] . "\n";
66        }
67        $success = false;
68    }
69
70    // 5. クリーンアップ
71    echo "\nクリーンアップを開始します。\n";
72    cleanup($workingDir);
73    echo "クリーンアップが完了しました。\n";
74    echo "--- デモンストレーション終了 --- \n";
75
76    return $success;
77}
78
79/**
80 * 指定されたディレクトリとその内容を再帰的に削除するヘルパー関数。
81 *
82 * @param string $dirPath 削除するディレクトリのパス
83 * @return void
84 */
85function cleanup(string $dirPath) : void
86{
87    if (!is_dir($dirPath)) {
88        return;
89    }
90
91    // ディレクトリ内のファイルとサブディレクトリをスキャン
92    $items = array_diff(scandir($dirPath), array('.', '..'));
93    foreach ($items as $item) {
94        $itemPath = $dirPath . DIRECTORY_SEPARATOR . $item;
95        if (is_file($itemPath)) {
96            if (unlink($itemPath)) {
97                echo "ファイル '{$item}' を削除しました。\n";
98            } else {
99                echo "警告: ファイル '{$item}' の削除に失敗しました。\n";
100            }
101        } elseif (is_dir($itemPath)) {
102            cleanup($itemPath); // サブディレクトリの場合は再帰的に削除
103        }
104    }
105
106    // ディレクトリが空になったら削除
107    if (rmdir($dirPath)) {
108        echo "ディレクトリ '{$dirPath}' を削除しました。\n";
109    } else {
110        echo "警告: ディレクトリ '{$dirPath}' の削除に失敗しました。\n";
111    }
112}
113
114// スクリプトが実行されたときに demonstrateHardLink 関数を呼び出す
115demonstrateHardLink();

PHPのlink関数は、指定したファイルに対し「ハードリンク」と呼ばれる別名（エイリアス）を作成します。引数$targetは既存のリンク元ファイルのパスを、$linkは新しく作成するハードリンクのパスを指定します。処理成功でtrueを、失敗でfalseを返します。ハードリンクは、元のファイルと同じデータの実体（inode）を共有するため、元のファイルを削除してもハードリンクを通じてデータにアクセス可能です。一方を編集すればもう一方にも変更が反映されます。重要な点として、link関数はディレクトリへのハードリンクは作成できません。ファイルに対してのみ有効です。このサンプルコードは、一時的なファイルとディレクトリを作成し、link関数の動作を示しています。元のファイル作成、ハードリンク生成、元のファイル削除後もハードリンクから内容が読めることを確認することで、ハードリンクの特性を分かりやすく示しています。最後に、作成した一時リソースをクリーンアップしています。

Copy
1<?php
2
3/**
4 * ファイルシステムのハードリンクを作成します。
5 * 既存のファイルへの新しいパスを作成し、その新しいパス（リンク名）で元のファイルと同じコンテンツにアクセスできるようにします。
6 * これはWebページのハイパーリンクとは異なり、ファイルシステムレベルで機能します。
7 *
8 * @param string $target 元となるファイルパス (例: 'source.php')
9 * @param string $link 作成する新しいリンクのファイルパス (例: 'another_page.php')
10 * @return bool 成功した場合は true、失敗した場合は false
11 */
12function createPageLink(string $target, string $link): bool
13{
14    // ターゲットファイルが存在するか確認します
15    if (!file_exists($target)) {
16        echo "エラー: ターゲットファイル '{$target}' が見つかりません。\n";
17        return false;
18    }
19
20    // 作成しようとしているリンク名が既に存在するか確認します
21    if (file_exists($link)) {
22        echo "エラー: リンク名 '{$link}' は既に存在します。上書きは行いません。\n";
23        return false;
24    }
25
26    // link() 関数を使用してハードリンクを作成します
27    if (link($target, $link)) {
28        echo "ハードリンク '{$link}' を '{$target}' に作成しました。\n";
29        // これにより、Webサーバー経由で '{$link}' にアクセスすると '{$target}' と同じ内容が表示されます。
30        return true;
31    } else {
32        echo "エラー: ハードリンク '{$link}' の作成に失敗しました。\n";
33        return false;
34    }
35}
36
37// --- サンプルコードの実行例 ---
38
39// ハードリンクの元となるターゲットファイルを作成します
40$targetFileName = 'original_content.php';
41// ファイルにPHPコードを書き込みます
42file_put_contents($targetFileName, '<?php echo "これは元のページの内容です。"; ?>');
43echo "ターゲットファイル '{$targetFileName}' を作成しました。\n";
44
45// このターゲットファイルへのハードリンクを作成します
46// これにより、'another_page.php' という名前で 'original_content.php' と同じ内容にアクセスできるようになります
47$linkedPageName = 'another_page_link.php';
48$success = createPageLink($targetFileName, $linkedPageName);
49
50// リンク作成が成功した場合、Webサーバーでの動作についてヒントを表示します
51if ($success) {
52    echo "Webサーバーを起動し、ブラウザで 'http://localhost/{$linkedPageName}' (またはあなたのWebサーバー設定に応じたパス) にアクセスしてみてください。\n";
53    echo "表示される内容は '{$targetFileName}' に直接アクセスした場合と同じです。\n";
54}
55
56// --- クリーンアップ (オプション) ---
57// サンプルコード実行後に作成したファイルを削除する場合は、以下の行のコメントを解除してください。
58// 実際のシステムでは、作成したファイルを自動で削除することは通常ありません。
59// if (file_exists($targetFileName)) {
60//     unlink($targetFileName);
61//     echo "ターゲットファイル '{$targetFileName}' を削除しました。\n";
62// }
63// if (file_exists($linkedPageName)) {
64//     unlink($linkedPageName);
65//     echo "リンクファイル '{$linkedPageName}' を削除しました。\n";
66// }
67
68?>

PHPのlink関数は、ファイルシステム上でハードリンクを作成するための関数です。ハードリンクとは、既存のファイルに新しい名前（パス）を割り当てることで、両方のパスからディスク上の同じコンテンツにアクセスできるようにする仕組みです。これはWebページ間のハイパーリンクとは異なり、ファイルシステムレベルで動作します。

引数$targetにはハードリンクの元となる既存のファイルパスを、$linkには新しく作成するハードリンクのファイルパスを指定します。関数が成功した場合はtrueが、失敗した場合はfalseが戻り値として返されます。

サンプルコードでは、createPageLink関数を使ってlink関数の利用方法を示しています。まずoriginal_content.phpというPHPファイルを生成し、そのファイル内容を記述します。次に、another_page_link.phpという名前でoriginal_content.phpへのハードリンクを作成します。このリンクが成功すると、Webサーバー経由でanother_page_link.phpにアクセスした場合、original_content.phpと全く同じ内容が表示されます。これは、ファイルシステムの観点から両方のファイルパスが同じ物理的なデータブロックを指しているためで、これにより、複数の異なる名前で同じコンテンツを効率的に提供することが可能です。

Copy
1<?php
2
3/**
4 * PHPのlink関数を使用して、既存のファイルへのハードリンクを作成するサンプルです。
5 * この例では、PDFファイルへのハードリンク作成を想定しています。
6 * link関数はファイルシステムレベルでの「ハードリンク」を作成します。
7 * これは、Webブラウザで開くハイパーリンクとは異なります。
8 *
9 * @param string $sourceFilePath 元となる既存のファイルのパス
10 * @param string $linkFilePath 作成するハードリンクのパス
11 * @return bool リンクの作成に成功した場合はtrue、失敗した場合はfalse
12 */
13function createPdfHardLink(string $sourceFilePath, string $linkFilePath): bool
14{
15    // link関数は、既存のファイルに対する新しい名前（ハードリンク）を作成します。
16    // ハードリンクは、元のファイルと同じiノードを指すため、実体は同じファイルです。
17    // 主にLinux/Unix系のファイルシステムで利用されます。WindowsではNTFSで可能です。
18
19    // 元ファイルが存在するか確認します。存在しないとハードリンクは作成できません。
20    if (!file_exists($sourceFilePath)) {
21        echo "エラー: 元ファイル '{$sourceFilePath}' が見つかりません。\n";
22        return false;
23    }
24
25    // リンクファイル名がすでに存在するか確認します。
26    // 存在する場合、link関数はエラーとなるため、事前に確認するのが安全です。
27    if (file_exists($linkFilePath)) {
28        echo "注意: リンクファイル '{$linkFilePath}' は既に存在します。上書きは行いません。\n";
29        return false;
30    }
31
32    // link関数を呼び出してハードリンクを作成します。
33    // 成功した場合はtrue、失敗した場合はfalseを返します。
34    // 失敗の原因としては、パーミッション不足や異なるファイルシステム間でのリンク試行などがあります。
35    if (link($sourceFilePath, $linkFilePath)) {
36        echo "成功: '{$sourceFilePath}' から '{$linkFilePath}' へのハードリンクを作成しました。\n";
37        return true;
38    } else {
39        echo "エラー: ハードリンクの作成に失敗しました ('{$sourceFilePath}' -> '{$linkFilePath}').\n";
40        return false;
41    }
42}
43
44// --- 単体で動作可能なサンプルコード ---
45
46// 1. ハードリンクの元となるダミーのPDFファイルを作成します。
47//    実際には、ここに既存のPDFファイルのパスを指定してください。
48$originalPdfName = 'example_original.pdf';
49$linkPdfName = 'example_hardlink.pdf';
50
51// ダミーファイルのコンテンツ (PDFの要件を満たす必要はないが、ファイルとして存在させる)
52$dummyContent = "%PDF-1.4\n1 0 obj\n<< /Type /Catalog /Pages 2 0 R >>\nendobj\n2 0 obj\n<< /Type /Pages /Count 0 >>\nendobj\nxref\n0 3\n0000000000 65535 f\n0000000009 00000 n\n0000000055 00000 n\ntrailer\n<< /Size 3 /Root 1 0 R >>\nstartxref\n104\n%%EOF";
53
54// ダミーの元ファイルを作成
55if (file_put_contents($originalPdfName, $dummyContent) === false) {
56    echo "エラー: ダミーの元ファイル '{$originalPdfName}' の作成に失敗しました。\n";
57    exit(1);
58}
59echo "ダミーの元ファイル '{$originalPdfName}' を作成しました。\n";
60
61// 2. 作成した関数を使ってハードリンクを作成します。
62if (createPdfHardLink($originalPdfName, $linkPdfName)) {
63    echo "ハードリンクの作成プロセスが完了しました。\n";
64
65    // ハードリンクが成功した場合、元のファイルとリンクファイルは同じiノードを指します。
66    // これを確認するには、stat() 関数などを使用できます。
67    // var_dump(stat($originalPdfName)['ino'], stat($linkPdfName)['ino']);
68} else {
69    echo "ハードリンクの作成に失敗しました。詳細を確認してください。\n";
70}
71
72// 3. クリーンアップ (オプション): サンプルファイルの削除
73//    スクリプトの実行ごとにファイルが残らないようにするための処理です。
74//    本番環境での利用時には、必要に応じて削除してください。
75if (file_exists($originalPdfName)) {
76    unlink($originalPdfName);
77    echo "元ファイル '{$originalPdfName}' を削除しました。\n";
78}
79if (file_exists($linkPdfName)) {
80    unlink($linkPdfName);
81    echo "リンクファイル '{$linkPdfName}' を削除しました。\n";
82}
83
84?>

PHPのlink関数は、既存のファイルに対して新しい名前（「ハードリンク」）を作成する機能です。ハードリンクは、元のファイルと同じiノードを指し、ファイルシステム上で同じファイルの実体を参照します。これにより、両方のファイル名から同じデータにアクセスでき、片方を削除してもデータは維持されます。これは、Webブラウザで開くハイパーリンクとは異なる、ファイルシステムが提供する機能です。

このサンプルコードは、PDFファイルへのハードリンクを作成する例を示しています。createPdfHardLink関数は、第一引数$sourceFilePathで元となる既存ファイルのパスを、第二引数$linkFilePathで作成するハードリンクのパスを受け取ります。処理が成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。

関数内では、ハードリンク作成前に元ファイルが存在するか、および指定されたリンクファイル名が既に存在しないかを検証しています。これにより、エラー発生を防ぎ、安全に操作を実行できます。ハードリンクの作成が失敗する主な原因としては、ファイルへのアクセス権限不足や、異なるファイルシステム間でのリンク試行などが考えられます。実際にハードリンクを作成するため、ダミーのPDFファイルを用意し、そのファイルに対してリンクを作成した後、クリーンアップとして作成したファイルを削除する一連の処理が含まれています。