CODEWITHSUNDEEP
phpfile-io
kritya
kritya

Reputation: 3362

Reading large files from end

Can I read a file in PHP from my end, for example if I want to read last 10-20 lines?

And, as I read, if the size of the file is more than 10mbs I start getting errors.

How can I prevent this error?

For reading a normal file, we use the code :

if ($handle) {
    while (($buffer = fgets($handle, 4096)) !== false) {
    $i1++;
    $content[$i1]=$buffer;
    }
    if (!feof($handle)) {
        echo "Error: unexpected fgets() fail\n";
    }
    fclose($handle);
}

My file might go over 10mbs, but I just need to read the last few lines. How do I do it?

Thanks

Upvotes: 14

Views: 20499

Answers (12)

Skeets
Skeets

Reputation: 4828

Here's a more complete solution:

function readFileFromEnd($filePathOrHandle, $callback, $maxLines = 0, $pos = null)
{
    if ($pos === null) {
        $pos = -2;
    }
    if (is_string($filePathOrHandle)) {
        $handle = fopen($filePathOrHandle, "r");
    } else {
        $handle = $filePathOrHandle;
    }
    while (true) {
        fseek($handle, $pos, SEEK_END);
        $pos--;
        $char = fgetc($handle);
        if ($char === "\n") {
            break;
        }
        if ($char === false) {
            fseek($handle, 0);
            break;
        }
    }
    $line   = fgets($handle);
    $result = $callback($line);

     if ($result === false) {
        fclose($handle);

        return;
    }
    if ($char === false) {
        return;
    }
    if ($maxLines > 0) {
        $maxLines--;
        if ($maxLines === 0) {
            fclose($handle);

            return;
        }
    }

    readFileFromEnd($handle, $callback, $maxLines, $pos);
}

Here is a usage example:

readFileFromEnd("/file/path",function($line){
  echo $line;

  if ( ! str_contains($address, "stop_word")) {
    echo "\nFound 'stop_word'!";

    return false; // returning false here "breaks" the loop
  }
}, 30);

This would print the last 30 lines of the file, in reverse order, unless one of those 30 lines had "stop_word" on it, in which case it will stop after processing the line containing "stop_word".

Upvotes: 0

Sukhjinder Singh
Sukhjinder Singh

Reputation: 1825

Following snippet worked for me.

$file = popen("tac $filename",'r');

while ($line = fgets($file)) {

    echo $line;

}

Reference: http://laughingmeme.org/2008/02/28/reading-a-file-backwards-in-php/

Upvotes: 6

madnordski
madnordski

Reputation: 1

A more complete example of the "tail" suggestion above is provided here. This seems to be a simple and efficient method -- thank-you. Very large files should not be an issue and a temporary file is not required.

$out = array();
$ret = null;

// capture the last 30 files of the log file into a buffer
exec('tail -30 ' . $weatherLog, $buf, $ret);

if ( $ret == 0 ) {

  // process the captured lines one at a time
  foreach ($buf as $line) {
    $n = sscanf($line, "%s temperature %f", $dt, $t);
    if ( $n > 0 ) $temperature = $t;
    $n = sscanf($line, "%s humidity %f", $dt, $h);
    if ( $n > 0 ) $humidity = $h;
  }
  printf("<tr><th>Temperature</th><td>%0.1f</td></tr>\n", 
          $temperature);
  printf("<tr><th>Humidity</th><td>%0.1f</td></tr>\n", $humidity);
}
else { # something bad happened }

In the above example, the code reads 30 lines of text output and displays the last temperature and humidity readings in the file (that's why the printf's are outside of the loop, in case you were wondering). The file is filled by an ESP32 which adds to the file every few minutes even when the sensor reports only nan. So thirty lines gets plenty of readings so it should never fail. Each reading includes the date and time so in the final version the output will include the time the reading was taken.

Upvotes: 0

felwithe
felwithe

Reputation: 2744

If you know about how long the lines are, you can avoid a lot of the black magic and just grab a chunk of the end of the file.

I needed the last 15 lines from a very large log file, and altogether they were about 3000 characters. So I just grab the last 8000 bytes to be safe, then read the file as normal and take what I need from the end.

    $fh = fopen($file, "r");
    fseek($fh, -8192, SEEK_END);
    $lines = array();
    while($lines[] = fgets($fh)) {}

This is possibly even more efficient than the highest rated answer, which reads the file character by character, compares each character, and splits based on newline characters.

Upvotes: 3

Greenisha
Greenisha

Reputation: 1437

You can use fopen and fseek to navigate in file backwards from end. For example

$fp = @fopen($file, "r");
$pos = -2;
while (fgetc($fp) != "\n") {
    fseek($fp, $pos, SEEK_END);
    $pos = $pos - 1;
}
$lastline = fgets($fp);

Upvotes: 19

Just_Do_It
Just_Do_It

Reputation: 821

Well while searching for the same thing, I can across the following and thought it might be useful to others as well so sharing it here:

/* Read file from end line by line */

function tail_custom($filepath, $lines = 1, $adaptive = true) {
        // Open file
        $f = @fopen($filepath, "rb");
        if ($f === false) return false;

        // Sets buffer size, according to the number of lines to retrieve.
        // This gives a performance boost when reading a few lines from the file.
        if (!$adaptive) $buffer = 4096;
        else $buffer = ($lines < 2 ? 64 : ($lines < 10 ? 512 : 4096));

        // Jump to last character
        fseek($f, -1, SEEK_END);

        // Read it and adjust line number if necessary
        // (Otherwise the result would be wrong if file doesn't end with a blank line)
        if (fread($f, 1) != "\n") $lines -= 1;

        // Start reading
        $output = '';
        $chunk = '';

        // While we would like more
        while (ftell($f) > 0 && $lines >= 0) {

            // Figure out how far back we should jump
            $seek = min(ftell($f), $buffer);

            // Do the jump (backwards, relative to where we are)
            fseek($f, -$seek, SEEK_CUR);

            // Read a chunk and prepend it to our output
            $output = ($chunk = fread($f, $seek)) . $output;

            // Jump back to where we started reading
            fseek($f, -mb_strlen($chunk, '8bit'), SEEK_CUR);

            // Decrease our line counter
            $lines -= substr_count($chunk, "\n");

        }

        // While we have too many lines
        // (Because of buffer size we might have read too many)
        while ($lines++ < 0) {
            // Find first newline and remove all text before that
            $output = substr($output, strpos($output, "\n") + 1);
        }

        // Close file and return
        fclose($f);     
        return trim($output);

    }

Upvotes: 1

Victor
Victor

Reputation: 815

For Linux you can do 

$linesToRead = 10;
exec("tail -n{$linesToRead} {$myFileName}" , $content);

You will get an array of lines in $content variable

Pure PHP solution

$f = fopen($myFileName, 'r');

    $maxLineLength = 1000;  // Real maximum length of your records
    $linesToRead = 10;
    fseek($f, -$maxLineLength*$linesToRead, SEEK_END);  // Moves cursor back from the end of file
    $res = array();
    while (($buffer = fgets($f, $maxLineLength)) !== false) {
        $res[] = $buffer;
    }

    $content = array_slice($res, -$linesToRead);

Upvotes: 3

Shim Kporku
Shim Kporku

Reputation: 51

As Einstein said every thing should be made as simple as possible but no simpler. At this point you are in need of a data structure, a LIFO data structure or simply put a stack.

Upvotes: 0

Stritof
Stritof

Reputation: 850

Here is another solution. It doesn't have line length control in fgets(), you can add it.

/* Read file from end line by line */
$fp = fopen( dirname(__FILE__) . '\\some_file.txt', 'r');
$lines_read = 0;
$lines_to_read = 1000;
fseek($fp, 0, SEEK_END); //goto EOF
$eol_size = 2; // for windows is 2, rest is 1
$eol_char = "\r\n"; // mac=\r, unix=\n
while ($lines_read < $lines_to_read) {
    if (ftell($fp)==0) break; //break on BOF (beginning...)
    do {
            fseek($fp, -1, SEEK_CUR); //seek 1 by 1 char from EOF
        $eol = fgetc($fp) . fgetc($fp); //search for EOL (remove 1 fgetc if needed)
        fseek($fp, -$eol_size, SEEK_CUR); //go back for EOL
    } while ($eol != $eol_char && ftell($fp)>0 ); //check EOL and BOF

    $position = ftell($fp); //save current position
    if ($position != 0) fseek($fp, $eol_size, SEEK_CUR); //move for EOL
    echo fgets($fp); //read LINE or do whatever is needed
    fseek($fp, $position, SEEK_SET); //set current position
    $lines_read++;
}
fclose($fp);

Upvotes: 2

phant0m
phant0m

Reputation: 16905

It depends how you interpret "can".

If you wonder whether you can do this directly (with PHP function) without reading the all the preceding lines, then the answer is: No, you cannot.

A line ending is an interpretation of the data and you can only know where they are, if you actually read the data.

If it is a really big file, I'd not do that though. It would be better if you were to scan the file starting from the end, and gradually read blocks from the end to the file.

Update

Here's a PHP-only way to read the last n lines of a file without reading through all of it:

function last_lines($path, $line_count, $block_size = 512){
    $lines = array();

    // we will always have a fragment of a non-complete line
    // keep this in here till we have our next entire line.
    $leftover = "";

    $fh = fopen($path, 'r');
    // go to the end of the file
    fseek($fh, 0, SEEK_END);
    do{
        // need to know whether we can actually go back
        // $block_size bytes
        $can_read = $block_size;
        if(ftell($fh) < $block_size){
            $can_read = ftell($fh);
        }

        // go back as many bytes as we can
        // read them to $data and then move the file pointer
        // back to where we were.
        fseek($fh, -$can_read, SEEK_CUR);
        $data = fread($fh, $can_read);
        $data .= $leftover;
        fseek($fh, -$can_read, SEEK_CUR);

        // split lines by \n. Then reverse them,
        // now the last line is most likely not a complete
        // line which is why we do not directly add it, but
        // append it to the data read the next time.
        $split_data = array_reverse(explode("\n", $data));
        $new_lines = array_slice($split_data, 0, -1);
        $lines = array_merge($lines, $new_lines);
        $leftover = $split_data[count($split_data) - 1];
    }
    while(count($lines) < $line_count && ftell($fh) != 0);
    if(ftell($fh) == 0){
        $lines[] = $leftover;
    }
    fclose($fh);
    // Usually, we will read too many lines, correct that here.
    return array_slice($lines, 0, $line_count);
}

Upvotes: 7

symcbean
symcbean

Reputation: 48357

If your code is not working and reporting an error you should include the error in your posts!

The reason you are getting an error is because you are trying to store the entire contents of the file in PHP's memory space.

The most effiicent way to solve the problem would be as Greenisha suggests and seek to the end of the file then go back a bit. But Greenisha's mecanism for going back a bit is not very efficient.

Consider instead the method for getting the last few lines from a stream (i.e. where you can't seek):

while (($buffer = fgets($handle, 4096)) !== false) {
    $i1++;
    $content[$i1]=$buffer;
    unset($content[$i1-$lines_to_keep]);
}

So if you know that your max line length is 4096, then you would:

if (4096*lines_to_keep<filesize($input_file)) {
   fseek($fp, -4096*$lines_to_keep, SEEK_END);
}

Then apply the loop I described previously.

Since C has some more efficient methods for dealing with byte streams, the fastest solution (on a POSIX/Unix/Linux/BSD) system would be simply:

$last_lines=system("last -" . $lines_to_keep . " filename");

Upvotes: 3

Eran Galperin
Eran Galperin

Reputation: 86805

It's not pure PHP, but the common solution is to use the tac command which is the revert of cat and loads the file in reverse. Use exec() or passthru() to run it on the server and then read the results. Example usage:

<?php
$myfile = 'myfile.txt';
$command = "tac $myfile > /tmp/myfilereversed.txt";
exec($command);
$currentRow = 0;
$numRows = 20;  // stops after this number of rows
$handle = fopen("/tmp/myfilereversed.txt", "r");
while (!feof($handle) && $currentRow <= $numRows) {
   $currentRow++;
   $buffer = fgets($handle, 4096);
   echo $buffer."<br>";
}
fclose($handle);
?>

Upvotes: 7

Related Questions