【PHP】リモートファイル（SSHなど）をfreadする時は注意！正しい実装方法

投稿日：2018年11月15日更新日：2019年3月24日

PHPでリモートファイルをfreadする時は注意が必要です。

はい、お察しの通り僕はこれで不具合出しちゃいました。笑

同じように不幸なプログラマーが増えないように、
また既に同じ不具合を出してしまったプログラマーの為に実装の注意点と正しい実装方法を解説します。

リモートファイルをfreadすると途中でファイル読み込みが切れる
freadではなくstream_get_contentsを使おう
まとめ

リモートファイルをfreadすると途中でファイル読み込みが切れる

リモートファイルをfreadすると、途中でファイル読み込みが切れちゃうんです。

恐ろしいのは、そこそこのファイルサイズじゃないと切れないので大きいサイズのファイルでテストしていないと気づかないんですよね。
僕は、うっかりしてまして本番で不具合が発覚しちゃいました。笑

なぜファイルの読み込みが途中で切れちゃうかというと…

警告
通常のローカルファイル以外のもの、例えばリモートファイルや popen()、fsockopen() が返すストリームを読み込んでいる場合には、パケットが有効になった後に読み込みはストップします。つまり以下の例のように分割されたデータを結合すべきであるということです。

参考：PHPリファレンス

PHPリファレンスにちゃんと書いてありました。

これは言い訳できませんね。今回の不具合は僕が悪いです。
でもみなさん毎回リファレンスなんて読んでますか？
僕は読んでません！
これからも読みたくありません！
これがプログラミングの難しいところですね。

ちなみに、リファレンスではhttpでファイルを開いたケースが紹介されいますが、
僕はssh2で読み込んだファイルで発生しました。
リファレンスで言われている通り、リモートファイルの読み込み全般で発生すると思われます。

freadではなくstream_get_contentsを使おう

正しい実装方法もリファレンスに書いてあります。

一応引用しておきますね。

PHP５以降

<?php
// PHP 5 以降での例
$handle = fopen("http://www.example.com/", "rb");
$contents = stream_get_contents($handle);
fclose($handle);
?>

<?php

// PHP 5 以降での例

$handle = fopen("http://www.example.com/", "rb");

$contents = stream_get_contents($handle);

fclose($handle);

PHP５未満

<?php
$handle = fopen("http://www.example.com/", "rb");
if (FALSE === $handle) {
    exit("Failed to open stream to URL");
}

$contents = '';

while (!feof($handle)) {
    $contents .= fread($handle, 8192);
}
fclose($handle);
?>

<?php

$handle = fopen("http://www.example.com/", "rb");

if (FALSE === $handle) {

exit("Failed to open stream to URL");

}

$contents = '';

while (!feof($handle)) {

$contents .= fread($handle, 8192);

}

fclose($handle);

参考：PHPリファレンス

PHP５以降であれば、freadをstream_get_contentsに変えればOKです。

修正は至って簡単ですね！

まとめ

僕が出してしまった不具合を記事にしてみました。

不具合出しちゃうと凹みますよね。

今回もやっちゃったな〜と思って、どうしたら防げたかなと考えるとやっぱりテストなんですよね。

でもテストにかける時間は限られている場合がほとんどで、どこまでテストしてどこで妥協するかは難しいところですよね。

今回の教訓は、大容量のテストはやるべし！でした。