Skip to content

PHPLIB-248, 249, 250, 251: GridFS stat improvements #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 12, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion src/GridFS/StreamWrapper.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

namespace MongoDB\GridFS;

use MongoDB\BSON\UTCDateTime;
use Exception;

/**
Expand Down Expand Up @@ -145,9 +146,23 @@ public function stream_stat()
{
$stat = $this->getStatTemplate();

$stat[2] = $stat['mode'] = $this->mode;
$stat[2] = $stat['mode'] = $this->stream instanceof ReadableStream
? 0100444 // S_IFREG & S_IRUSR & S_IRGRP & S_IROTH
: 0100222; // S_IFREG & S_IWUSR & S_IWGRP & S_IWOTH
$stat[7] = $stat['size'] = $this->stream->getSize();

$file = $this->stream->getFile();

if (isset($file->uploadDate) && $file->uploadDate instanceof UTCDateTime) {
$timestamp = $file->uploadDate->toDateTime()->getTimestamp();
$stat[9] = $stat['mtime'] = $timestamp;
$stat[10] = $stat['ctime'] = $timestamp;
}

if (isset($file->chunkSize) && is_integer($file->chunkSize)) {
$stat[11] = $stat['blksize'] = $file->chunkSize;
}

return $stat;
}

Expand Down
2 changes: 1 addition & 1 deletion src/GridFS/WritableStream.php
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ public function getFile()
*/
public function getSize()
{
return $this->length;
return $this->length + strlen($this->buffer);
}

/**
Expand Down
135 changes: 135 additions & 0 deletions tests/GridFS/StreamWrapperFunctionalTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
<?php

namespace MongoDB\Tests\GridFS;

use MongoDB\BSON\Binary;
use MongoDB\BSON\UTCDateTime;

/**
* Functional tests for the internal StreamWrapper class.
*/
class StreamWrapperFunctionalTest extends FunctionalTestCase
{
public function setUp()
{
parent::setUp();

$this->filesCollection->insertMany([
['_id' => 'length-10', 'length' => 10, 'chunkSize' => 4, 'uploadDate' => new UTCDateTime('1484202200000')],
]);

$this->chunksCollection->insertMany([
['_id' => 1, 'files_id' => 'length-10', 'n' => 0, 'data' => new Binary('abcd', Binary::TYPE_GENERIC)],
['_id' => 2, 'files_id' => 'length-10', 'n' => 1, 'data' => new Binary('efgh', Binary::TYPE_GENERIC)],
['_id' => 3, 'files_id' => 'length-10', 'n' => 2, 'data' => new Binary('ij', Binary::TYPE_GENERIC)],
]);
}

public function testReadableStreamClose()
{
$stream = $this->bucket->openDownloadStream('length-10');

$this->assertTrue(fclose($stream));
}

public function testReadableStreamEof()
{
$stream = $this->bucket->openDownloadStream('length-10');

$this->assertFalse(feof($stream));
$this->assertStreamContents('abcdefghij', $stream);
$this->assertTrue(feof($stream));
}

public function testReadableStreamRead()
{
$stream = $this->bucket->openDownloadStream('length-10');

$this->assertSame('abc', fread($stream, 3));
$this->assertSame('defghij', fread($stream, 10));
$this->assertSame('', fread($stream, 3));
}

public function testReadableStreamStat()
{
$stream = $this->bucket->openDownloadStream('length-10');

$stat = fstat($stream);
$this->assertSame(0100444, $stat[2]);
$this->assertSame(0100444, $stat['mode']);
$this->assertSame(10, $stat[7]);
$this->assertSame(10, $stat['size']);
$this->assertSame(1484202200, $stat[9]);
$this->assertSame(1484202200, $stat['mtime']);
$this->assertSame(1484202200, $stat[10]);
$this->assertSame(1484202200, $stat['ctime']);
$this->assertSame(4, $stat[11]);
$this->assertSame(4, $stat['blksize']);
}

public function testReadableStreamWrite()
{
$stream = $this->bucket->openDownloadStream('length-10');

$this->assertSame(0, fwrite($stream, 'foobar'));
}

public function testWritableStreamClose()
{
$stream = $this->bucket->openUploadStream('filename');

$this->assertSame(6, fwrite($stream, 'foobar'));
$this->assertTrue(fclose($stream));

$this->assertStreamContents('foobar', $this->bucket->openDownloadStreamByName('filename'));
}

public function testWritableStreamEof()
{
$stream = $this->bucket->openUploadStream('filename');

$this->assertFalse(feof($stream));
$this->assertSame(6, fwrite($stream, 'foobar'));
$this->assertFalse(feof($stream));
}

public function testWritableStreamRead()
{
$stream = $this->bucket->openUploadStream('filename');

$this->assertSame('', fread($stream, 8192));
$this->assertSame(6, fwrite($stream, 'foobar'));
$this->assertSame('', fread($stream, 8192));
}

public function testWritableStreamStat()
{
$currentTimestamp = time();
$stream = $this->bucket->openUploadStream('filename', ['chunkSizeBytes' => 1024]);

$stat = fstat($stream);
$this->assertSame(0100222, $stat[2]);
$this->assertSame(0100222, $stat['mode']);
$this->assertSame(0, $stat[7]);
$this->assertSame(0, $stat['size']);
$this->assertGreaterThanOrEqual($currentTimestamp, $stat[9]);
$this->assertGreaterThanOrEqual($currentTimestamp, $stat['mtime']);
$this->assertGreaterThanOrEqual($currentTimestamp, $stat[10]);
$this->assertGreaterThanOrEqual($currentTimestamp, $stat['ctime']);
$this->assertSame(1024, $stat[11]);
$this->assertSame(1024, $stat['blksize']);

$this->assertSame(6, fwrite($stream, 'foobar'));

$stat = fstat($stream);
$this->assertSame(6, $stat[7]);
$this->assertSame(6, $stat['size']);
}

public function testWritableStreamWrite()
{
$stream = $this->bucket->openUploadStream('filename');

$this->assertSame(6, fwrite($stream, 'foobar'));
}
}
16 changes: 16 additions & 0 deletions tests/GridFS/WritableStreamFunctionalTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,22 @@ public function testConstructorShouldRequireChunkSizeBytesOptionToBePositive()
new WritableStream($this->collectionWrapper, 'filename', ['chunkSizeBytes' => 0]);
}

public function testWriteBytesAlwaysUpdatesFileSize()
{
$stream = new WritableStream($this->collectionWrapper, 'filename', ['chunkSizeBytes' => 1024]);

$this->assertSame(0, $stream->getSize());
$this->assertSame(512, $stream->writeBytes(str_repeat('a', 512)));
$this->assertSame(512, $stream->getSize());
$this->assertSame(512, $stream->writeBytes(str_repeat('a', 512)));
$this->assertSame(1024, $stream->getSize());
$this->assertSame(512, $stream->writeBytes(str_repeat('a', 512)));
$this->assertSame(1536, $stream->getSize());

$stream->close();
$this->assertSame(1536, $stream->getSize());
}

/**
* @dataProvider provideInputDataAndExpectedMD5
*/
Expand Down