Help us understand the problem. What is going on with this article?

PHPは上書きしないrenameができない

More than 1 year has passed since last update.

PHPのrename関数はファイルが存在すると上書きする仕様になっている。上書きrenameをさせたくなくてもだ。renameの直前でfile_existsでrename先のファイルが存在しないことをチェックしたとしても、上書きrenameの仕様を完全に解消することはできない。もちろん意図しない上書きが起こる可能性を下げることはできる。

file_put_contents('a', 'a');

echo "check if file does not exist\n";
file_exists('b') && exit(1); // ファイルが存在しないことチェック

echo "other program create file b\n";
file_put_contents('b', 'b'); // 他のプログラムが同時期にbを作ってしまう

echo "before rename\n";
rename('a', 'b'); // 他のプログラムが作ったbをaで上書きしてしまう

echo 'now file b content is ' . file_get_contents('b') . "\n";

unlink('b');

renameが内部でどんなシステムコールを使っているのか?

touch('a');
echo 'before rename';
rename('a', 'b');
echo 'after rename';
unlink('b');
write(1, "before rename", 13before rename)           = 13
rename("a", "b")                        = 0
write(1, "after rename", 12after rename)            = 12

Linuxのrenameインターフェイス

int rename(const char *oldpath, const char *newpath);

newpath が既に存在する場合、それは不可分操作で (atomically) 置き換えられる (ただし、いくつかの条件がある; 以下の「エラー」のセクションを参照)。 そのため、 newpath にアクセスしようとしている他のプロセスがファイルを見失うことはない (訳註: 常にアクセス可能である)。
── Man page of RENAME

PHPのrename関数はLinuxのrenameシステムコールをそのまま使っているようで、PHPのrenameの「newname が存在する場合、上書きされます」という仕様はLinuxの仕様を踏襲していると考えられる。

PHP__rename_-_Manual.png

Linuxのシステムコールにはrenameat2があり、これは上書きしないオプションが存在する。が、PHPではこれを使っていない。

考えられる対策

  • ファイル名がかぶらないものにする(UUIDとか)
  • linkで一時ファイルのハードリンクを作ってから一時ファイルを消す

続く

suin
Qiita 4位/TypeScript入門書執筆中/TypeScripterのための座談会「YYTypeScript」主催/『実践ドメイン駆動設計』書籍邦訳レビュア/分報Slack考案/YYPHP主催/CodeIQマガジン執筆/株式会社クラフトマンソフトウェア創設/Web自動テスト「ShouldBee」の開発/TypeScript/DDD/OOP
https://yyts.connpass.com/
craftsman_software
インフラ運用を自動化し、手作業を限りなくゼロにする会社
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした