Adjust copyrights years
<?php
/**
* SeekQuarry/Yioop --
* Open Source Pure PHP Search Engine, Crawler, and Indexer
*
* Copyright (C) 2009 - 2023 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 - 2023
* @filesource
*/
namespace seekquarry\yioop\library\processors;
use seekquarry\yioop\configs as C;
use seekquarry\yioop\library\ComputerVision;
use seekquarry\yioop\library\UrlParser;
/**
* Used to create crawl summary information
* for BMP and ICO files
*
* @author Chris Pollett
*/
class IconProcessor extends ImageProcessor
{
/**
* Set-ups the any indexing plugins associated with this page
* processor
*
* @param array $plugins an array of indexing plugins which might
* do further processing on the data handles by this page
* processor
* @param int $max_description_len maximal length of a page summary
* @param int $max_links_to_extract maximum number of links to extract
* from a single document
* @param string $summarizer_option CRAWL_CONSTANT specifying what kind
* of summarizer to use self::BASIC_SUMMARIZER,
* self::GRAPH_BASED_SUMMARIZER and self::CENTROID_SUMMARIZER
* self::CENTROID_SUMMARIZER
*/
public function __construct($plugins = [], $max_description_len = null,
$max_links_to_extract = null,
$summarizer_option = self::BASIC_SUMMARIZER)
{
parent::__construct($plugins, $max_description_len,
$max_links_to_extract, $summarizer_option);
/** Register File Types We Handle*/
self::$indexed_file_types[] = "ico";
self::$image_types[] = "ico";
self::$mime_processor["image/x-icon"] = "IconProcessor";
}
/**
* {@inheritDoc}
*
* @param string $page the image represented as a character string
* @param string $url the url where the image was downloaded from
* @return array summary information including a thumbnail and a
* description (where the description is just the url)
*/
public function process($page, $url)
{
if (is_string($page)) {
$summary = [];
$this->addWidthHeightNumImagesSummary($summary, $page);
$host = UrlParser::getHost($url);
$summary[self::LANG] = "mul";
$summary[self::TITLE] = "$host Icon";
$summary[self::DESCRIPTION] =
UrlParser::getWordsLastPathPartUrl($url) . "\n";
if (ComputerVision::ocrEnabled()) {
set_error_handler(null);
$temp_file = $this->saveTempFile($page, $url, "ico");
$lang = UrlParser::getLang($url);
$ocr_data = ComputerVision::recognizeText($temp_file, [$lang]);
if (!empty($ocr_data)) {
$summary[self::DESCRIPTION] .= $ocr_data;
}
@unlink($temp_file);
set_error_handler(C\NS_CONFIGS . "yioop_error_handler");
}
$summary[self::LINKS] = [];
$summary["raw-image"] = $page;
$summary[self::THUMB] = 'data:image/x-icon;base64,' .
base64_encode($page);
$summary[self::PAGE] =
"<html><body><div><img src='" . $summary[self::THUMB] .
"' alt='" . $summary[self::DESCRIPTION] .
"' ></div></body></html>";
}
return $summary;
}
/**
* Determines width and height info of first image in icon file
*
* @param string $bmp_string string with the contents of a bmp file
*/
public function addWidthHeightNumImagesSummary(&$summary, $page)
{
if (strlen($page) < 8) {
return;
}
$summary[self::NUM_ICON_IMAGES] = unpack("S", $page, 4)[1];
$summary[self::WIDTH] = ord($page[6]); // smallest image in ico
$summary[self::HEIGHT] = ord($page[7]);
}
}