［PHP］is_writable関数の使い方と実例 – ファイル・ディレクトリの書き込み権限をチェックする方法

PHPでファイルやディレクトリに対して安全に書き込み処理を行いたい場合、事前に書き込み権限があるかどうかを確認することが重要です。そんな時に活用できるのがis_writable関数です。この記事では、is_writable関数の基本的な使い方から実践的な応用例まで、詳しく解説していきます。

is_writable関数とは？

is_writable関数は、指定されたファイルまたはディレクトリが書き込み可能かどうかを判定するPHPの組み込み関数です。ファイルシステムの権限をチェックし、書き込み処理を実行する前の安全性確認に使用されます。

基本構文

bool is_writable(string $filename)

パラメータ:

• $filename: チェックしたいファイルまたはディレクトリのパス

戻り値:

• true: 書き込み可能
• false: 書き込み不可能、またはファイル/ディレクトリが存在しない

基本的な使用例

ファイルの書き込み権限をチェック

<?php
$filename = '/path/to/your/file.txt';

if (is_writable($filename)) {
    echo "ファイルは書き込み可能です";
    // ファイルに安全に書き込み処理を実行
    file_put_contents($filename, "新しいデータ");
} else {
    echo "ファイルは書き込み不可能です";
}
?>

ディレクトリの書き込み権限をチェック

<?php
$directory = '/path/to/your/directory';

if (is_writable($directory)) {
    echo "ディレクトリは書き込み可能です";
    // 新しいファイルを作成
    file_put_contents($directory . '/new_file.txt', "データ");
} else {
    echo "ディレクトリは書き込み不可能です";
}
?>

実践的な活用例

ログファイルの書き込み処理

<?php
function writeLog($message) {
    $logFile = '/var/log/myapp.log';
    
    // ログファイルが存在しない場合は親ディレクトリをチェック
    if (!file_exists($logFile)) {
        $logDir = dirname($logFile);
        if (!is_writable($logDir)) {
            throw new Exception("ログディレクトリに書き込み権限がありません: " . $logDir);
        }
    } else {
        // ファイルが存在する場合は直接チェック
        if (!is_writable($logFile)) {
            throw new Exception("ログファイルに書き込み権限がありません: " . $logFile);
        }
    }
    
    $timestamp = date('Y-m-d H:i:s');
    file_put_contents($logFile, "[$timestamp] $message\n", FILE_APPEND | LOCK_EX);
}

// 使用例
try {
    writeLog("アプリケーションが開始されました");
} catch (Exception $e) {
    echo "エラー: " . $e->getMessage();
}
?>

ファイルアップロード処理での活用

<?php
function handleFileUpload($uploadedFile) {
    $uploadDir = '/uploads/';
    
    // アップロードディレクトリの権限チェック
    if (!is_writable($uploadDir)) {
        return [
            'success' => false,
            'error' => 'アップロードディレクトリに書き込み権限がありません'
        ];
    }
    
    $filename = basename($uploadedFile['name']);
    $targetPath = $uploadDir . $filename;
    
    // ファイルが既に存在する場合の権限チェック
    if (file_exists($targetPath) && !is_writable($targetPath)) {
        return [
            'success' => false,
            'error' => '同名ファイルが存在し、上書き権限がありません'
        ];
    }
    
    if (move_uploaded_file($uploadedFile['tmp_name'], $targetPath)) {
        return ['success' => true, 'path' => $targetPath];
    } else {
        return ['success' => false, 'error' => 'ファイルの移動に失敗しました'];
    }
}
?>

注意点とベストプラクティス

セキュリティに関する注意点

is_writable関数を使用する際は、以下の点に注意してください：

<?php
// 悪い例：ユーザー入力を直接使用
$userPath = $_GET['path']; // 危険！
if (is_writable($userPath)) {
    // セキュリティリスクあり
}

// 良い例：パスの検証とサニタイズ
function validatePath($path) {
    // 相対パス（../）を含む場合は拒否
    if (strpos($path, '..') !== false) {
        return false;
    }
    
    // 許可されたディレクトリ内かチェック
    $allowedDir = '/safe/upload/directory/';
    $realPath = realpath($allowedDir . $path);
    
    return $realPath && strpos($realPath, $allowedDir) === 0;
}

$userPath = $_GET['path'];
if (validatePath($userPath)) {
    $safePath = '/safe/upload/directory/' . $userPath;
    if (is_writable($safePath)) {
        // 安全な処理
    }
}
?>

パフォーマンス最適化

<?php
// ファイル状態をキャッシュして重複チェックを避ける
class FilePermissionChecker {
    private $cache = [];
    
    public function isWritable($path) {
        if (!isset($this->cache[$path])) {
            $this->cache[$path] = is_writable($path);
        }
        return $this->cache[$path];
    }
    
    public function clearCache($path = null) {
        if ($path) {
            unset($this->cache[$path]);
        } else {
            $this->cache = [];
        }
    }
}
?>

エラーハンドリングの改善

<?php
function safeWriteFile($filename, $data) {
    // 存在チェックと権限チェックを組み合わせ
    if (!file_exists($filename)) {
        $dir = dirname($filename);
        if (!is_dir($dir)) {
            throw new Exception("ディレクトリが存在しません: $dir");
        }
        if (!is_writable($dir)) {
            throw new Exception("ディレクトリに書き込み権限がありません: $dir");
        }
    } else {
        if (!is_writable($filename)) {
            throw new Exception("ファイルに書き込み権限がありません: $filename");
        }
    }
    
    $result = file_put_contents($filename, $data, LOCK_EX);
    if ($result === false) {
        throw new Exception("ファイル書き込みに失敗しました: $filename");
    }
    
    return $result;
}
?>

まとめ

is_writable関数は、PHPでファイルシステムを安全に操作するために欠かせない関数です。適切に使用することで、権限エラーによるアプリケーションクラッシュを防ぎ、ユーザーに適切なエラーメッセージを提供できます。

特に重要なポイントは以下の通りです：

• ファイル操作前の事前チェックとして活用する
• セキュリティを考慮してユーザー入力の検証を行う
• 適切なエラーハンドリングと組み合わせる
• パフォーマンスを考慮してキャッシュ機能を検討する

is_writable関数を正しく理解し活用することで、より堅牢で安全なPHPアプリケーションを開発できるでしょう。