はじめに
Linux/Unixサーバーでファイルシステムを扱っていると、シンボリックリンク(symlink)に遭遇することがよくあります。シンボリックリンクは、別のファイルやディレクトリへの「ショートカット」のようなもので、柔軟なファイル管理を可能にします。
PHPのreadlink関数を使えば、シンボリックリンクがどのファイルを参照しているのかを簡単に調べることができます。この記事では、readlink関数の基本から実践的な使い方まで、分かりやすく解説していきます。
readlink関数とは?
readlink関数は、シンボリックリンクのリンク先(ターゲット)を取得する関数です。シンボリックリンク自体ではなく、そのリンクが指し示している実際のパスを返します。
基本的な構文
<?php
readlink(string $path): string|false
?>
- $path: シンボリックリンクのパス
- 戻り値: リンク先のパス、失敗時はfalse
最もシンプルな使用例
<?php
// /var/www/current が /var/www/releases/v1.2.3 へのシンボリックリンクの場合
$target = readlink('/var/www/current');
echo $target; // /var/www/releases/v1.2.3
?>
シンボリックリンクとは?
シンボリックリンクを理解するために、簡単に説明します。
ハードリンク vs シンボリックリンク
# ハードリンク: 同じファイルの別名
ln /path/to/original.txt hardlink.txt
# シンボリックリンク: 別のファイルへのポインタ
ln -s /path/to/original.txt symlink.txt
**readlink関数はシンボリックリンクのみに対応しています。**ハードリンクには使えません。
シンボリックリンクの確認方法
<?php
$path = 'current';
// シンボリックリンクかどうかを確認
if (is_link($path)) {
echo "{$path} はシンボリックリンクです\n";
$target = readlink($path);
echo "リンク先: {$target}\n";
} else {
echo "{$path} は通常のファイル/ディレクトリです\n";
}
?>
実践的な使用例
1. デプロイメントシステムでの利用
Webアプリケーションのデプロイでは、シンボリックリンクを使った切り替えが一般的です:
<?php
// デプロイメント情報の取得
$currentLink = '/var/www/myapp/current';
if (is_link($currentLink)) {
$deployedVersion = readlink($currentLink);
$versionNumber = basename($deployedVersion);
echo "現在のバージョン: {$versionNumber}\n";
echo "デプロイパス: {$deployedVersion}\n";
} else {
echo "currentリンクが見つかりません\n";
}
?>
2. 設定ファイルの管理
環境ごとに異なる設定ファイルをシンボリックリンクで管理:
<?php
$configLink = '/etc/myapp/config.php';
if (is_link($configLink)) {
$actualConfig = readlink($configLink);
if (strpos($actualConfig, 'production') !== false) {
echo "本番環境の設定を使用中\n";
} elseif (strpos($actualConfig, 'staging') !== false) {
echo "ステージング環境の設定を使用中\n";
} else {
echo "開発環境の設定を使用中\n";
}
echo "設定ファイル: {$actualConfig}\n";
}
?>
3. ログディレクトリの追跡
<?php
$logLink = '/var/log/myapp/latest';
if (is_link($logLink)) {
$actualLogDir = readlink($logLink);
$logDate = basename($actualLogDir);
echo "最新ログディレクトリ: {$logDate}\n";
echo "パス: {$actualLogDir}\n";
// ログファイルの一覧を表示
$files = scandir($actualLogDir);
echo "\nログファイル:\n";
foreach ($files as $file) {
if ($file !== '.' && $file !== '..') {
echo " - {$file}\n";
}
}
}
?>
4. シンボリックリンクのチェーン解決
シンボリックリンクが別のシンボリックリンクを指している場合:
<?php
function resolveSymlinkChain($path, $maxDepth = 10) {
$resolved = $path;
$depth = 0;
while (is_link($resolved) && $depth < $maxDepth) {
$target = readlink($resolved);
// 相対パスの場合は絶対パスに変換
if ($target[0] !== '/') {
$resolved = dirname($resolved) . '/' . $target;
} else {
$resolved = $target;
}
$depth++;
echo "リンク {$depth}: {$resolved}\n";
}
if ($depth >= $maxDepth) {
echo "警告: 循環参照の可能性があります\n";
return false;
}
return $resolved;
}
// 使用例
$finalPath = resolveSymlinkChain('/var/www/current');
echo "\n最終的なパス: {$finalPath}\n";
?>
5. 相対パスと絶対パスの処理
readlinkは相対パスを返すこともあるので注意が必要です:
<?php
function getAbsoluteLinkTarget($linkPath) {
if (!is_link($linkPath)) {
return false;
}
$target = readlink($linkPath);
// 絶対パスの場合はそのまま返す
if ($target[0] === '/') {
return $target;
}
// 相対パスの場合は絶対パスに変換
$linkDir = dirname($linkPath);
$absolutePath = $linkDir . '/' . $target;
// パスを正規化
return realpath($absolutePath);
}
// 使用例
$link = 'logs/current';
$absoluteTarget = getAbsoluteLinkTarget($link);
echo "絶対パス: {$absoluteTarget}\n";
?>
6. デッドリンク(壊れたリンク)の検出
<?php
function checkSymlink($linkPath) {
if (!is_link($linkPath)) {
return ['status' => 'not_a_link', 'message' => 'シンボリックリンクではありません'];
}
$target = readlink($linkPath);
if ($target === false) {
return ['status' => 'error', 'message' => 'リンクの読み取りに失敗'];
}
// 相対パスを絶対パスに変換
if ($target[0] !== '/') {
$target = dirname($linkPath) . '/' . $target;
}
// リンク先が存在するかチェック
if (file_exists($target)) {
return [
'status' => 'ok',
'target' => $target,
'message' => 'リンクは正常です'
];
} else {
return [
'status' => 'broken',
'target' => $target,
'message' => 'リンク先が存在しません(デッドリンク)'
];
}
}
// 使用例
$links = ['current', 'latest', 'backup'];
foreach ($links as $link) {
$result = checkSymlink($link);
echo "{$link}: {$result['message']}\n";
if (isset($result['target'])) {
echo " → {$result['target']}\n";
}
}
?>
readlink vs realpath の違い
似た機能を持つrealpath関数との違いを理解しましょう:
| 関数 | 処理内容 | シンボリックリンク | 戻り値 |
|---|---|---|---|
| readlink() | リンク先を1段階だけ解決 | そのまま読み取る | リンク先のパス |
| realpath() | 完全な絶対パスに解決 | すべて解決する | 実際の絶対パス |
実例で比較
<?php
// シンボリックリンクのチェーン:
// link1 -> link2 -> /actual/file.txt
// readlink: 1段階だけ解決
$target1 = readlink('link1');
echo $target1; // link2
// realpath: すべて解決
$real1 = realpath('link1');
echo $real1; // /actual/file.txt
// 用途の違い
// readlink: シンボリックリンクの構造を調べたい時
// realpath: 最終的な実ファイルのパスが欲しい時
?>
エラーハンドリング
readlink関数が失敗するケースと対処方法:
<?php
function safeReadlink($path) {
// パスが存在するかチェック
if (!file_exists($path) && !is_link($path)) {
return [
'success' => false,
'error' => 'パスが存在しません',
'path' => $path
];
}
// シンボリックリンクかチェック
if (!is_link($path)) {
return [
'success' => false,
'error' => 'シンボリックリンクではありません',
'path' => $path
];
}
// リンク先を読み取る
$target = @readlink($path);
if ($target === false) {
$error = error_get_last();
return [
'success' => false,
'error' => 'リンクの読み取りに失敗: ' . ($error['message'] ?? '不明なエラー'),
'path' => $path
];
}
return [
'success' => true,
'target' => $target,
'absolute' => ($target[0] === '/'),
'path' => $path
];
}
// 使用例
$result = safeReadlink('/var/www/current');
if ($result['success']) {
echo "リンク先: {$result['target']}\n";
echo "絶対パス: " . ($result['absolute'] ? 'はい' : 'いいえ') . "\n";
} else {
echo "エラー: {$result['error']}\n";
}
?>
パーミッションとセキュリティ
パーミッションの確認
<?php
function getLinkInfo($path) {
if (!is_link($path)) {
return null;
}
$info = [
'path' => $path,
'target' => readlink($path),
'readable' => is_readable($path),
'writable' => is_writable($path),
];
// lstat()でリンク自体の情報を取得
$stat = lstat($path);
$info['owner'] = posix_getpwuid($stat['uid'])['name'] ?? $stat['uid'];
$info['group'] = posix_getgrgid($stat['gid'])['name'] ?? $stat['gid'];
$info['permissions'] = substr(sprintf('%o', $stat['mode']), -4);
return $info;
}
// 使用例
$info = getLinkInfo('current');
if ($info) {
print_r($info);
}
?>
セキュリティ上の注意点
<?php
// ❌ 危険な例: ユーザー入力を直接使用
$userPath = $_GET['path'];
$target = readlink($userPath); // パストラバーサル攻撃の危険性
// ✅ 安全な例: ホワイトリスト方式
$allowedLinks = [
'current' => '/var/www/myapp/current',
'backup' => '/var/www/myapp/backup',
'logs' => '/var/log/myapp/latest'
];
$linkName = $_GET['link'] ?? '';
if (isset($allowedLinks[$linkName])) {
$linkPath = $allowedLinks[$linkName];
if (is_link($linkPath)) {
$target = readlink($linkPath);
echo "リンク先: {$target}\n";
} else {
echo "シンボリックリンクが見つかりません\n";
}
} else {
http_response_code(400);
echo "無効なリンク名です\n";
}
?>
実用的なシンボリックリンク管理クラス
<?php
/**
* シンボリックリンク管理クラス
*/
class SymlinkManager {
/**
* シンボリックリンクの詳細情報を取得
*/
public static function getInfo($path) {
if (!file_exists($path) && !is_link($path)) {
throw new Exception("パスが存在しません: {$path}");
}
if (!is_link($path)) {
throw new Exception("シンボリックリンクではありません: {$path}");
}
$target = readlink($path);
if ($target === false) {
throw new Exception("リンクの読み取りに失敗: {$path}");
}
// 絶対パスに変換
if ($target[0] !== '/') {
$absoluteTarget = dirname($path) . '/' . $target;
$absoluteTarget = realpath($absoluteTarget);
} else {
$absoluteTarget = realpath($target);
}
return [
'link' => $path,
'target' => $target,
'absolute_target' => $absoluteTarget,
'is_relative' => ($target[0] !== '/'),
'target_exists' => ($absoluteTarget !== false),
'target_is_file' => ($absoluteTarget && is_file($absoluteTarget)),
'target_is_dir' => ($absoluteTarget && is_dir($absoluteTarget)),
];
}
/**
* シンボリックリンクのチェーンを解決
*/
public static function resolveChain($path, $maxDepth = 10) {
$chain = [];
$current = $path;
$depth = 0;
while (is_link($current) && $depth < $maxDepth) {
$target = readlink($current);
if ($target === false) {
break;
}
$chain[] = [
'link' => $current,
'target' => $target,
'depth' => $depth
];
// 絶対パスに変換
if ($target[0] !== '/') {
$current = dirname($current) . '/' . $target;
} else {
$current = $target;
}
$depth++;
}
return [
'chain' => $chain,
'final' => $current,
'depth' => $depth,
'circular' => ($depth >= $maxDepth)
];
}
/**
* デッドリンクをチェック
*/
public static function checkBroken($directory) {
$broken = [];
$iterator = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator($directory, RecursiveDirectoryIterator::SKIP_DOTS)
);
foreach ($iterator as $file) {
$path = $file->getPathname();
if (is_link($path)) {
$info = self::getInfo($path);
if (!$info['target_exists']) {
$broken[] = $info;
}
}
}
return $broken;
}
}
// 使用例
try {
// リンク情報の取得
$info = SymlinkManager::getInfo('/var/www/current');
echo "リンク: {$info['link']}\n";
echo "リンク先: {$info['target']}\n";
echo "絶対パス: {$info['absolute_target']}\n";
echo "相対リンク: " . ($info['is_relative'] ? 'はい' : 'いいえ') . "\n";
echo "リンク先が存在: " . ($info['target_exists'] ? 'はい' : 'いいえ') . "\n";
// チェーン解決
echo "\n=== リンクチェーン ===\n";
$chain = SymlinkManager::resolveChain('/var/www/current');
foreach ($chain['chain'] as $link) {
echo "深さ {$link['depth']}: {$link['link']} → {$link['target']}\n";
}
echo "最終パス: {$chain['final']}\n";
// デッドリンクのチェック
echo "\n=== デッドリンク検出 ===\n";
$broken = SymlinkManager::checkBroken('/var/www');
if (empty($broken)) {
echo "デッドリンクは見つかりませんでした\n";
} else {
foreach ($broken as $link) {
echo "壊れたリンク: {$link['link']} → {$link['target']}\n";
}
}
} catch (Exception $e) {
echo "エラー: {$e->getMessage()}\n";
}
?>
まとめ
readlink関数のポイントをおさらいしましょう:
- シンボリックリンクのリンク先を取得する関数
- リンクを1段階だけ解決する(realpath()とは異なる)
- 相対パスを返す場合があるので絶対パス変換が必要
- デプロイメント管理や設定管理に便利
- is_link()で事前確認が重要
- セキュリティ対策としてホワイトリスト方式を使う
- デッドリンクの検出にも活用できる
シンボリックリンクは、柔軟なファイル管理を実現する強力なツールです。readlink関数を活用して、効率的なアプリケーション管理を行いましょう!
参考リンク
この記事が役に立ったら、ぜひシェアしてください!PHPに関する他の記事もお楽しみに。
