Recipe 23.5. Reading a File into a String


23.5.1. Problem

You want to load the entire contents of a file into a variable. For example, you want to determine if the text in a file matches a regular expression.

23.5.2. Solution

Use file_get_contents( ), as shown in Example 23-16.

Reading a file into a string

<?php $people = file_get_contents('people.txt'); if (preg_match('/Names:.*(David|Susannah)/i',$people)) {     print "people.txt matches."; } ?> 

23.5.3. Discussion

If you want the contents of a file in a string to manipulate, file_get_contents( ) is great, but if you just want to print the entire contents of a file, there are easier (and more efficient) ways than reading it into a string and then printing the string. PHP provides two functions for this. The first is fpassthru($fh), which prints everything left on the file handle $fh and then closes it. The second, readfile($filename), prints the entire contents of $filename.

You can use readfile( ) to implement a wrapper around images that shouldn't always be displayed. The program in Example 23-17 makes sure a requested image is less than a week old.

Displaying recent images

<?php $image_directory = '/usr/local/images'; if (preg_match('/^[a-zA-Z0-9]+\.(gif|jpe?g)$/',$image,$matches) &&     is_readable($image_directory."/$image") &&     (filemtime($image_directory."/$image") >= (time() - 86400 * 7))) {   header('Content-Type: image/'.$matches[1]);   header('Content-Length: '.filesize($image_directory."/$image"));   readfile($image_directory."/$image"); } else {   error_log("Can't serve image: $image"); } ?>

The directory in which the images are stored, $image_directory, needs to be outside the web server's document root for the wrapper to be effective. Otherwise, users can just access the image files directly. The code tests the image file for three things. First, that the filename passed in $image is just alphanumeric with an ending of either .gif, .jpg, or .jpeg. We need to ensure that characters such as .. or / are not in the filename; this prevents malicious users from retrieving files outside the specified directory. Second, we use is_readable( ) to make sure the program can read the file. Finally, we get the file's modification time with filemtime( ) and make sure that time is after 86,400 x 7 seconds ago. There are 86,400 seconds in a day, so 86,400 x 7 is a week.[] If all of these conditions are met, we're ready to send the image. First, we send two headers to tell the browser the image's MIME type and file size. Then we use readfile( ) to send the entire contents of the file to the user.

[] When switching between standard time and daylight saving time, there are not 86,400 seconds in a day. See Recipe 3.12 for details.

23.5.4. See Also

Documentation on filesize( ) at http://www.php.net/filesize, fread( ) at http://www.php.net/fread, fpassthru( ) at http://www.php.net/fpassthru, and readfile( ) at http://www.php.net/readfile .




PHP Cookbook, 2nd Edition
PHP Cookbook: Solutions and Examples for PHP Programmers
ISBN: 0596101015
EAN: 2147483647
Year: 2006
Pages: 445

Similar book on Amazon

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net