spout/tests/Spout/Reader/ODS/ReaderTest.php

<?php

namespace Box\Spout\Reader\ODS;

use Box\Spout\Common\Exception\IOException;
use Box\Spout\Common\Type;
use Box\Spout\Reader\ReaderFactory;
use Box\Spout\TestUsingResource;

/**
 * Class ReaderTest
 *
 * @package Box\Spout\Reader\ODS
 */
class ReaderTest extends \PHPUnit_Framework_TestCase
{
    use TestUsingResource;

    /**
     * @return array
     */
    public function dataProviderForTestReadShouldThrowException()
    {
        return [
            ['/path/to/fake/file.ods'],
            ['file_corrupted.ods'],
        ];
    }

    /**
     * @dataProvider dataProviderForTestReadShouldThrowException
     * @expectedException \Box\Spout\Common\Exception\IOException
     *
     * @param string $filePath
     * @return void
     */
    public function testReadShouldThrowException($filePath)
    {
        // using @ to prevent warnings/errors from being displayed
        @$this->getAllRowsForFile($filePath);
    }

    /**
     * @return array
     */
    public function dataProviderForTestReadForAllWorksheets()
    {
        return [
            ['one_sheet_with_strings.ods', 2, 3],
            ['two_sheets_with_strings.ods', 4, 3],
        ];
    }

    /**
     * @dataProvider dataProviderForTestReadForAllWorksheets
     *
     * @param string $resourceName
     * @param int $expectedNumOfRows
     * @param int $expectedNumOfCellsPerRow
     * @return void
     */
    public function testReadForAllWorksheets($resourceName, $expectedNumOfRows, $expectedNumOfCellsPerRow)
    {
        $allRows = $this->getAllRowsForFile($resourceName);

        $this->assertEquals($expectedNumOfRows, count($allRows), "There should be $expectedNumOfRows rows");
        foreach ($allRows as $row) {
            $this->assertEquals($expectedNumOfCellsPerRow, count($row), "There should be $expectedNumOfCellsPerRow cells for every row");
        }
    }

    /**
     * @return void
     */
    public function testReadShouldSupportRowWithOnlyOneCell()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_only_one_cell.ods');
        $this->assertEquals([['foo']], $allRows);
    }

    /**
     * @return void
     */
    public function testReadShouldSupportNumberColumnsRepeated()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_number_columns_repeated.ods');
        $expectedRows = [
            [
                'foo', 'foo', 'foo',
                '', '',
                true, true,
                10.43, 10.43, 10.43, 10.43,
            ],
        ];
        $this->assertEquals($expectedRows, $allRows);
    }

    /**
     * @return array
     */
    public function dataProviderForTestReadWithFilesGeneratedByExternalSoftwares()
    {
        return [
            ['file_generated_by_libre_office.ods', true],
            ['file_generated_by_excel_2010_windows.ods', false],
            ['file_generated_by_excel_office_online.ods', false],
        ];
    }

    /**
     * @dataProvider dataProviderForTestReadWithFilesGeneratedByExternalSoftwares
     * The files contain styles, different value types, gaps between cells,
     * repeated values, empty row, different number of cells per row.
     *
     * @param bool $skipLastEmptyValues
     * @param string $fileName
     * @return void
     */
    public function testReadWithFilesGeneratedByExternalSoftwares($fileName, $skipLastEmptyValues)
    {
        $allRows = $this->getAllRowsForFile($fileName);

        $expectedRows = [
            ['header1','header2','header3','header4'],
            ['val11','val12','val13','val14'],
            ['val21','','val23','val23'],
            ['', 10.43, 29.11],
        ];

        // In the description of the last cell, Excel specifies that the empty value needs to be repeated
        // a lot of times (16384 - number of cells used in the row). To avoid creating 16384 cells all the time,
        // this cell is skipped alltogether.
        if ($skipLastEmptyValues) {
            $expectedRows[3][] = '';
        }

        $this->assertEquals($expectedRows, $allRows);
    }


    /**
     * @return void
     */
    public function testReadShouldSupportAllCellTypes()
    {
        $utcTz = new \DateTimeZone('UTC');
        $honoluluTz = new \DateTimeZone('Pacific/Honolulu'); // UTC-10

        $allRows = $this->getAllRowsForFile('sheet_with_all_cell_types.ods');

        $expectedRows = [
            [
                'ods--11', 'ods--12',
                true, false,
                0, 10.43,
                new \DateTime('1987-11-29T00:00:00', $utcTz), new \DateTime('1987-11-29T13:37:00', $utcTz),
                new \DateTime('1987-11-29T13:37:00', $utcTz), new \DateTime('1987-11-29T13:37:00', $honoluluTz),
                new \DateInterval('PT13H37M00S'),
                0, 0.42,
                '42 USD', '9.99 EUR',
                '',
            ],
        ];
        $this->assertEquals($expectedRows, $allRows);
    }

    /**
     * @return void
     */
    public function testReadShouldSupportFormatDatesAndTimesIfSpecified()
    {
        $shouldFormatDates = true;
        $allRows = $this->getAllRowsForFile('sheet_with_dates_and_times.ods', $shouldFormatDates);

        $expectedRows = [
            ['05/19/2016', '5/19/16', '05/19/2016 16:39:00', '05/19/16 04:39 PM', '5/19/2016'],
            ['11:29', '13:23:45', '01:23:45', '01:23:45 AM', '01:23:45 PM'],
        ];
        $this->assertEquals($expectedRows, $allRows);
    }

    /**
     * @return void
     */
    public function testReadShouldReturnEmptyStringOnUndefinedCellType()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_undefined_value_type.ods');
        $this->assertEquals([['ods--11', '', 'ods--13']], $allRows);
    }

    /**
     * @return void
     */
    public function testReadShouldReturnNullOnInvalidDateOrTime()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_invalid_date_time.ods');
        $this->assertEquals([[null, null]], $allRows);
    }

    /**
     * @return void
     */
    public function testReadShouldSupportMultilineStrings()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_multiline_string.ods');

        $expectedRows = [["string\non multiple\nlines!"]];
        $this->assertEquals($expectedRows, $allRows);
    }

    /**
     * @return void
     */
    public function testReadShouldSkipEmptyRowsIfShouldPreserveEmptyRowsNotSet()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_empty_rows.ods');

        $this->assertEquals(3, count($allRows), 'There should be only 3 rows, because the empty rows are skipped');

        $expectedRows = [
            // skipped row here
            ['ods--21', 'ods--22', 'ods--23'],
            // skipped row here
            // skipped row here
            ['ods--51', 'ods--52', 'ods--53'],
            ['ods--61', 'ods--62', 'ods--63'],
        ];
        $this->assertEquals($expectedRows, $allRows);
    }

    /**
     * @return void
     */
    public function testReadShouldReturnEmptyLinesIfShouldPreserveEmptyRowsSet()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_empty_rows.ods', false, true);

        $this->assertEquals(6, count($allRows), 'There should be 6 rows');

        $expectedRows = [
            [''],
            ['ods--21', 'ods--22', 'ods--23'],
            [''],
            [''],
            ['ods--51', 'ods--52', 'ods--53'],
            ['ods--61', 'ods--62', 'ods--63'],
        ];
        $this->assertEquals($expectedRows, $allRows);
    }

    /**
     * @return void
     */
    public function testReadShouldPreserveSpacing()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_various_spaces.ods');

        $expectedRow = [
            '    4 spaces before and after    ',
            ' 1 space before and after ',
            '2 spaces after  ',
            '  2 spaces before',
            "3 spaces   in the middle\nand 2 spaces  in the middle",
        ];
        $this->assertEquals([$expectedRow], $allRows);
    }


    /**
     * @NOTE: The LIBXML_NOENT is used to ACTUALLY substitute entities (and should therefore not be used)
     *
     * @return void
     */
    public function testReadShouldBeProtectedAgainstBillionLaughAttack()
    {
        $startTime = microtime(true);
        $fileName = 'attack_billion_laughs.ods';

        try {
            // using @ to prevent warnings/errors from being displayed
            @$this->getAllRowsForFile($fileName);
            $this->fail('An exception should have been thrown');
        } catch (IOException $exception) {
            $duration = microtime(true) - $startTime;
            $this->assertLessThan(10, $duration, 'Entities should not be expanded and therefore take more than 10 seconds to be parsed.');

            $expectedMaxMemoryUsage = 30 * 1024 * 1024; // 30MB
            $this->assertLessThan($expectedMaxMemoryUsage, memory_get_peak_usage(true), 'Entities should not be expanded and therefore consume all the memory.');
        }
    }

    /**
     * @NOTE: The LIBXML_NOENT is used to ACTUALLY substitute entities (and should therefore not be used)
     *
     * @return void
     */
    public function testReadShouldBeProtectedAgainstQuadraticBlowupAttack()
    {
        $startTime = microtime(true);

        $fileName = 'attack_quadratic_blowup.ods';
        $allRows = $this->getAllRowsForFile($fileName);

        $this->assertEquals('', $allRows[0][0], 'Entities should not have been expanded');

        $duration = microtime(true) - $startTime;
        $this->assertLessThan(10, $duration, 'Entities should not be expanded and therefore take more than 10 seconds to be parsed.');

        $expectedMaxMemoryUsage = 30 * 1024 * 1024; // 30MB
        $this->assertLessThan($expectedMaxMemoryUsage, memory_get_peak_usage(true), 'Entities should not be expanded and therefore consume all the memory.');
    }

    /**
     * @return void
     */
    public function testReadShouldBeAbleToProcessEmptySheets()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_no_cells.ods');
        $this->assertEquals([], $allRows, 'Sheet with no cells should be correctly processed.');
    }

    /**
     * @return void
     */
    public function testReadShouldSkipFormulas()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_formulas.ods');

        $expectedRows = [
            ['val1', 'val2', 'total1', 'total2'],
            [10, 20, 30, 21],
            [11, 21, 32, 41],
        ];
        $this->assertEquals($expectedRows, $allRows);
    }

    /**
     * @expectedException \Box\Spout\Reader\Exception\IteratorNotRewindableException
     *
     * @return void
     */
    public function testReadShouldThrowIfTryingToRewindRowIterator()
    {
        $resourcePath = $this->getResourcePath('one_sheet_with_strings.ods');
        $reader = ReaderFactory::create(Type::ODS);
        $reader->open($resourcePath);

        foreach ($reader->getSheetIterator() as $sheet) {
            // start looping throw the rows
            foreach ($sheet->getRowIterator() as $row) {
                break;
            }

            // this will rewind the row iterator
            foreach ($sheet->getRowIterator() as $row) {
                break;
            }
        }
    }

    /**
     * @return void
     */
    public function testReadMultipleTimesShouldRewindReader()
    {
        $allRows = [];
        $resourcePath = $this->getResourcePath('two_sheets_with_strings.ods');

        $reader = ReaderFactory::create(Type::ODS);
        $reader->open($resourcePath);

        foreach ($reader->getSheetIterator() as $sheet) {
            // do nothing
        }

        // this loop should only add the first row of each sheet
        foreach ($reader->getSheetIterator() as $sheet) {
            foreach ($sheet->getRowIterator() as $row) {
                $allRows[] = $row;
                break;
            }
        }

        // this loop should only add the first row of the first sheet
        foreach ($reader->getSheetIterator() as $sheet) {
            foreach ($sheet->getRowIterator() as $row) {
                $allRows[] = $row;
                break;
            }

            // stop reading more sheets
            break;
        }

        $reader->close();

        $expectedRows = [
            ['ods--sheet1--11', 'ods--sheet1--12', 'ods--sheet1--13'], // 1st row, 1st sheet
            ['ods--sheet2--11', 'ods--sheet2--12', 'ods--sheet2--13'], // 1st row, 2nd sheet
            ['ods--sheet1--11', 'ods--sheet1--12', 'ods--sheet1--13'], // 1st row, 1st sheet
        ];
        $this->assertEquals($expectedRows, $allRows);
    }

    /**
     * @expectedException \Box\Spout\Common\Exception\IOException
     *
     * @return void
     */
    public function testReadWithUnsupportedCustomStreamWrapper()
    {
        /** @var \Box\Spout\Reader\ODS\Reader $reader */
        $reader = ReaderFactory::create(Type::ODS);
        $reader->open('unsupported://foobar');
    }

    /**
     * @expectedException \Box\Spout\Common\Exception\IOException
     *
     * @return void
     */
    public function testReadWithSupportedCustomStreamWrapper()
    {
        /** @var \Box\Spout\Reader\ODS\Reader $reader */
        $reader = ReaderFactory::create(Type::ODS);
        $reader->open('php://memory');
    }

    /**
     * https://github.com/box/spout/issues/184
     * @return void
     */
    public function testReadShouldInludeRowsWithZerosOnly()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_zeros_in_row.ods');

        $expectedRows = [
            ['A', 'B', 'C'],
            ['1', '2', '3'],
            ['0', '0', '0']
        ];
        $this->assertEquals($expectedRows, $allRows, 'There should be only 3 rows, because zeros (0) are valid values');
    }

    /**
     * https://github.com/box/spout/issues/184
     * @return void
     */
    public function testReadShouldCreateOutputEmptyCellPreserved()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_empty_cells.ods');

        $expectedRows = [
            ['A', 'B', 'C'],
            ['0', '', ''],
            ['1', '1', '']
        ];
        $this->assertEquals($expectedRows, $allRows, 'There should be 3 rows, with equal length');
    }

    /**
     * https://github.com/box/spout/issues/195
     * @return void
     */
    public function testReaderShouldNotTrimCellValues()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_untrimmed_strings.ods');

        $expectedRows = [
            ['A'],
            [' A '],
            ["\n\tA\n\t"],
        ];

        $this->assertEquals($expectedRows, $allRows, 'Cell values should not be trimmed');
    }

    /**
     * https://github.com/box/spout/issues/218
     * @return void
     */
    public function testReaderShouldReadTextInHyperlinks()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_hyperlinks.ods');

        $expectedRows = [
            ['email', 'text'],
            ['1@example.com', 'text'],
            ['2@example.com', 'text and https://github.com/box/spout/issues/218 and text'],
        ];

        $this->assertEquals($expectedRows, $allRows, 'Text in hyperlinks should be read');
    }

    /**
     * @return void
     */
    public function testReaderShouldReadInlineFontFormattingAsText()
    {
        $allRows = $this->getAllRowsForFile('sheet_with_inline_font_formatting.ods');

        $expectedRows = [
            ['I am a yellow bird']
        ];

        $this->assertEquals($expectedRows, $allRows, 'Text formatted inline should be read');
    }

    /**
     * @param string $fileName
     * @param bool|void $shouldFormatDates
     * @param bool|void $shouldPreserveEmptyRows
     * @return array All the read rows the given file
     */
    private function getAllRowsForFile($fileName, $shouldFormatDates = false, $shouldPreserveEmptyRows = false)
    {
        $allRows = [];
        $resourcePath = $this->getResourcePath($fileName);

        /** @var \Box\Spout\Reader\ODS\Reader $reader */
        $reader = ReaderFactory::create(Type::ODS);
        $reader->setShouldFormatDates($shouldFormatDates);
        $reader->setShouldPreserveEmptyRows($shouldPreserveEmptyRows);
        $reader->open($resourcePath);

        foreach ($reader->getSheetIterator() as $sheetIndex => $sheet) {
            foreach ($sheet->getRowIterator() as $rowIndex => $row) {
                $allRows[] = $row;
            }
        }

        $reader->close();

        return $allRows;
    }
}