Piwik\ProxyHttp::serverStaticFile PHP Method

serverStaticFile() public static method

It performs the following actions: - Checks the file is readable or returns "HTTP/1.0 404 Not Found" - Returns "HTTP/1.1 304 Not Modified" after comparing the HTTP_IF_MODIFIED_SINCE with the modification date of the static file - Will try to compress the static file according to HTTP_ACCEPT_ENCODING. Compressed files are store in the /tmp directory. If compressing extensions are not available, a manually gzip compressed file can be provided in the /tmp directory. It has to bear the same name with an added .gz extension. Using manually compressed static files requires you to manually update the compressed file when the static file is updated. - Overrides server cache control config to allow caching - Sends Very Accept-Encoding to tell proxies to store different version of the static file according to users encoding capacities. Warning: Compressed filed are stored in the /tmp directory. If this method is used with two files bearing the same name but located in different locations, there is a risk of conflict. One file could be served with the content of the other. A future upgrade of this method would be to recreate the directory structure of the static file within a /tmp/compressed-static-files directory.
public static serverStaticFile ( string $file, string $contentType, $expireFarFutureDays = 100, integer | false $byteStart = false, integer | false $byteEnd = false, string | false $filename = false )
$file string The location of the static file to serve
$contentType string The content type of the static file.
$byteStart integer | false The starting byte in the file to serve. If false, the data from the beginning of the file will be served.
$byteEnd integer | false The ending byte in the file to serve. If false, the data from $byteStart to the end of the file will be served.
$filename string | false By default the filename of $file is reused as Content-Disposition. If the file should be sent as a different filename to the client you can specify a custom filename here.
    public static function serverStaticFile($file, $contentType, $expireFarFutureDays = 100, $byteStart = false, $byteEnd = false, $filename = false)
    {
        // if the file cannot be found return HTTP status code '404'
        if (!file_exists($file)) {
            Common::sendResponseCode(404);
            return;
        }
        $modifiedSince = Http::getModifiedSinceHeader();
        $fileModifiedTime = @filemtime($file);
        $lastModified = gmdate('D, d M Y H:i:s', $fileModifiedTime) . ' GMT';
        // set some HTTP response headers
        self::overrideCacheControlHeaders('public');
        Common::sendHeader('Vary: Accept-Encoding');
        if (false === $filename) {
            $filename = basename($file);
        }
        Common::sendHeader('Content-Disposition: inline; filename=' . $filename);
        if ($expireFarFutureDays) {
            // Required by proxy caches potentially in between the browser and server to cache the request indeed
            Common::sendHeader(self::getExpiresHeaderForFutureDay($expireFarFutureDays));
        }
        // Return 304 if the file has not modified since
        if ($modifiedSince === $lastModified) {
            Common::sendResponseCode(304);
            return;
        }
        // if we have to serve the file, serve it now, either in the clear or compressed
        if ($byteStart === false) {
            $byteStart = 0;
        }
        if ($byteEnd === false) {
            $byteEnd = filesize($file);
        }
        $compressed = false;
        $encoding = '';
        $compressedFileLocation = AssetManager::getInstance()->getAssetDirectory() . '/' . basename($file);
        if (!($byteStart == 0 && $byteEnd == filesize($file))) {
            $compressedFileLocation .= ".{$byteStart}.{$byteEnd}";
        }
        $phpOutputCompressionEnabled = self::isPhpOutputCompressed();
        if (isset($_SERVER['HTTP_ACCEPT_ENCODING']) && !$phpOutputCompressionEnabled) {
            list($encoding, $extension) = self::getCompressionEncodingAcceptedByClient();
            $filegz = $compressedFileLocation . $extension;
            if (self::canCompressInPhp()) {
                if (!empty($encoding)) {
                    // compress the file if it doesn't exist or is newer than the existing cached file, and cache
                    // the compressed result
                    if (self::shouldCompressFile($file, $filegz)) {
                        self::compressFile($file, $filegz, $encoding, $byteStart, $byteEnd);
                    }
                    $compressed = true;
                    $file = $filegz;
                    $byteStart = 0;
                    $byteEnd = filesize($file);
                }
            } else {
                // if a compressed file exists, the file was manually compressed so we just serve that
                if ($extension == '.gz' && !self::shouldCompressFile($file, $filegz)) {
                    $compressed = true;
                    $file = $filegz;
                    $byteStart = 0;
                    $byteEnd = filesize($file);
                }
            }
        }
        Common::sendHeader('Last-Modified: ' . $lastModified);
        if (!$phpOutputCompressionEnabled) {
            Common::sendHeader('Content-Length: ' . ($byteEnd - $byteStart));
        }
        if (!empty($contentType)) {
            Common::sendHeader('Content-Type: ' . $contentType);
        }
        if ($compressed) {
            Common::sendHeader('Content-Encoding: ' . $encoding);
        }
        if (!_readfile($file, $byteStart, $byteEnd)) {
            Common::sendResponseCode(500);
        }
    }

Usage Example

Example #1
0
    exit;
}
/**
 * piwik.js proxy
 *
 * @see core/Piwik.php
 */
define('PIWIK_INCLUDE_PATH', '..');
define('PIWIK_DOCUMENT_ROOT', '..');
define('PIWIK_USER_PATH', '..');
require_once PIWIK_INCLUDE_PATH . '/libs/upgradephp/upgrade.php';
// Composer autoloader
if (file_exists(PIWIK_INCLUDE_PATH . '/vendor/autoload.php')) {
    $path = PIWIK_INCLUDE_PATH . '/vendor/autoload.php';
    // Piwik is the main project
} else {
    $path = PIWIK_INCLUDE_PATH . '/../../autoload.php';
    // Piwik is installed as a dependency
}
require $path;
$file = '../piwik.js';
$daysExpireFarFuture = 10;
$byteStart = $byteEnd = false;
if (!defined("PIWIK_KEEP_JS_TRACKER_COMMENT") || !PIWIK_KEEP_JS_TRACKER_COMMENT) {
    $byteStart = 369;
    // length of comment header in bytes
}
$environment = new \Piwik\Application\Environment(null);
$environment->init();
ProxyHttp::serverStaticFile($file, "application/javascript; charset=UTF-8", $daysExpireFarFuture, $byteStart, $byteEnd);
exit;
All Usage Examples Of Piwik\ProxyHttp::serverStaticFile