Doc #81345 [Com]: ftell() after writing to compress://zlib stream wrong

From: Date: Thu, 18 Apr 2024 08:56:42 +0000
Subject: Doc #81345 [Com]: ftell() after writing to compress://zlib stream wrong
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-19702@lists.php.net to get a copy of this message 
Edit report at https://bugs.php.net/bug.php?id=81345&edit=1

 ID:                 81345
 Comment by:         Anthony101990Jones at outlook dot com
 Reported by:        cmb@php.net
 Summary:            ftell() after writing to compress://zlib stream
                     wrong
 Status:             Open
 Type:               Documentation Problem
 Package:            Streams related
 Operating System:   *
 PHP Version:        7.4Git-2021-08-10 (Git)
 Block user comment: N
 Private report:     N

 New Comment:

It seems you’re encountering an issue where ftell() is reporting the number of uncompressed
bytes written to a compress://zlib stream, rather than the actual stream position. This is a known
behavior tied to the streams layer of PHP, where the stream’s write method is supposed to
return the number of input bytes processed. This can be confusing because for streams where the
number of input bytes is not the same as the number of output bytes, the position reported by
ftell() will not match the actual stream position1.

As of the information available, this issue was documented as a bug and was open as of the last
update. It’s recommended to check the PHP bug tracking system for the most recent updates on
this issue1. In the meantime, if you need to know the actual position in the stream, you might have
to use a different approach, such as manually tracking the bytes written or using a different
compression stream wrapper that behaves as expected.

Here’s a brief example of the issue:
<?php
$s = fopen("compress.zlib://file.gz", "w");
var_dump(fwrite($s, str_repeat("hello world", 100)));
fflush($s); // this doesn't make a difference
var_dump(ftell($s)); // reports the number of uncompressed bytes
fclose($s);
var_dump(filesize("file.gz")); // actual compressed file size
?>
(https://github.com)(https://www.dognearme.co.uk/)


Previous Comments:
------------------------------------------------------------------------
[2021-08-10 13:11:03] cmb@php.net

Description:
------------
After writing to a compress://zlib stream, ftell() reports the
number of uncompressed bytes which have been written, not the
actual stream position.  This is inherently tied to the way the
streams layer works: the stream's write method is supposed to
return the number of input bytes processed, so the same confusing
behavior happens for all streams for which the number of input
bytes is not the same as the number of output bytes.

Since this cannot easily be fixed, it should at least be
documented.


Test script:
---------------
<?php
$s = fopen("compress.zlib://file.gz", "w");
var_dump(fwrite($s, str_repeat("hello world", 100)));
fflush($s); // this doesn't make a difference
var_dump(ftell($s));
fclose($s);
var_dump(filesize("file.gz"));
?>


Expected result:
----------------
int(1100)
int(38)
int(48)


Actual result:
--------------
int(1100)
int(1100)
int(48)



------------------------------------------------------------------------



--
Edit this bug report at https://bugs.php.net/bug.php?id=81345&edit=1

Thread (4 messages)

« previous php.doc.bugs (#19702) next »