<?php
/**
 * SeekQuarry/Yioop --
 * Open Source Pure PHP Search Engine, Crawler, and Indexer
 *
 * Copyright (C) 2009 - 2026  Chris Pollett chris@pollett.org
 *
 * LICENSE:
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * END LICENSE
 *
 * @author Chris Pollett chris@pollett.org
 * @license https://www.gnu.org/licenses/ GPL3
 * @link https://www.seekquarry.com/
 * @copyright 2009 - 2026
 * @filesource
 */
namespace seekquarry\yioop\tests;

use seekquarry\yioop\configs as C;
use seekquarry\yioop\library as L;
use seekquarry\yioop\library\CrawlConstants;
use seekquarry\yioop\library\processors\IconProcessor;
use seekquarry\yioop\library\UnitTest;

/**
 * UnitTest for the IconProcessor class. A IconProcessor is used to process
 * a .ico file and extract summary from it. This
 * class tests the processing of an .ico file.
 *
 * @author Chris Pollett
 */
class IconProcessorTest extends UnitTest implements CrawlConstants
{
    /**
     * Not used
     */
    public function setUp()
    {
    }
    /**
     * Delete any files associated with our test on BmpProcessor (in this case
     * none)
     */
    public function tearDown()
    {
    }
    /**
     * Tests the generation of a summary from the included bmp image of my
     * photo
     */
    public function summaryTestCase()
    {
        $icon_object = new IconProcessor();
        $url = "http://www.yioop.com/favion.ico";
        $filename = C\BASE_DIR . "/favicon.ico";
        $page = file_get_contents($filename);
        $summary = $icon_object->process($page, $url);
        $this->assertTrue(!empty($summary[self::THUMB]), "Thumb Generated");
        $description_terms = explode(" ", $summary[self::DESCRIPTION]);
        $this->assertEqual($summary[self::NUM_ICON_IMAGES], 1,
            "Correct Number of Contained Images Determined");
        $this->assertEqual($summary[self::WIDTH], 14,
            "Correct Width Extracted");
        $this->assertEqual($summary[self::HEIGHT], 16,
            "Correct Height Extracted");
    }
    /**
     * Checks that the temporary file name an image processor writes before
     * handing it to an external tool is well formed: it must carry the
     * given extension and contain no spaces. A malformed name with spaces
     * once leaked stray files into the working folder when passed to an
     * unquoted shell command.
     */
    public function tempFileNameTestCase()
    {
        $icon_object = new IconProcessor();
        $temp_file = $icon_object->saveTempFile("not a real image",
            "http://www.yioop.com/favion.ico", "ico");
        $this->assertTrue($temp_file !== null,
            "Temp file path was returned");
        $base_name = basename($temp_file);
        $this->assertTrue(strpos($base_name, " ") === false,
            "Temp file name contains no spaces");
        $this->assertEqual(substr($base_name, -4), ".ico",
            "Temp file name ends with the given extension");
        if ($temp_file !== null && file_exists($temp_file)) {
            unlink($temp_file);
        }
    }
}
