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 Tarun Ramaswamy tarun.pepira@gmail.com
* @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\PartialZipArchive;
use seekquarry\yioop\library\UrlParser;
/**
* Used to create crawl summary information
* for xlsx files
*
* @author Tarun Ramaswamy
*/
class XlsxProcessor extends TextProcessor
{
/**
* 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[] = "xlsx";
self::$mime_processor["application/vnd.openxmlformats-officedocument.".
"spreadsheetml.sheet"] = "XlsxProcessor";
}
/**
* Used to extract the title, description and links from
* a xlsx file.
*
* @param string $page contents of xlsx file in zip format
* @param string $url the url where the page contents came from,
* used to canonicalize relative links
*
* @return array a summary of the contents of the page
*
*/
public function process($page, $url)
{
$summary = null;
// Open a zip archive
$zip = new PartialZipArchive($page);
//Count of the sheets in xlsx
$file_count = 0;
//Getting the title from xlsx file
$buf = $zip->getFromName("docProps/app.xml");
if ($buf) {
$dom = self::dom($buf);
if ($dom !== false) {
// Get the title
$summary[self::TITLE] = self::title($dom);
$file_count = self::sheetCount($dom);
}
}
//Getting the description from xlsx file
$buf = $zip->getFromName("xl/sharedStrings.xml");
if ($buf) {
$dom = self::dom($buf);
if ($dom !== false) {
// Get the description
$summary[self::DESCRIPTION] = self::description($dom);
}
//Getting the language from xlsx file
$summary[self::LANG] =
self::calculateLang($summary[self::DESCRIPTION], $url);
}
$summary[self::LINKS] = [];
//Getting links from each worksheet
for ($i = 1; $i<= $file_count; $i++) {
$buf = $zip->getFromName("xl/worksheets/_rels/sheet" . $i .
".xml.rels");
if ($buf) {
$dom = self::dom($buf);
if (!empty($dom)) {
// Get the links
$summary[self::LINKS] = array_merge(
$summary[self::LINKS], self::links($dom, $url));
}
}
}
return $summary;
}
/**
* Return a document object based on a string containing the contents of
* a xml file
*
* @param string $page xml document
*
* @return object document object
*/
public static function dom($page)
{
$dom = new \DOMDocument();
set_error_handler(null);
@$dom->loadXML($page);
set_error_handler(C\NS_CONFIGS . "yioop_error_handler");
return $dom;
}
/**
* Returns title of a xlsx file from each worksheet
*
* @param object $dom a document object to extract a title from.
* @return string a title of the xlsx file
*
*/
public static function title($dom)
{
$properties = $dom->getElementsByTagName("Properties");
$title = "";
foreach ($properties as $property) {
$titles = $property->getElementsByTagName("TitlesOfParts");
if (!empty($titles->item(0))) {
$title .= $titles->item(0)->nodeValue;
}
}
return $title;
}
/**
* Returns the count of worksheets in the xlsx file
*
* @param object $dom a document object to extract a title from.
* @return integer number of worksheets in the xlsx file
*
*/
public static function sheetCount($dom)
{
$count = 0;
$properties = $dom->getElementsByTagName("Properties");
foreach ($properties as $property) {
$titles = $property->getElementsByTagName("TitlesOfParts");
foreach ($titles as $vector) {
$vt_vector = $vector->getElementsByTagName("vector");
foreach ($vt_vector as $vector_attribute) {
$count = $vector_attribute->getAttribute("size");
}
}
}
return $count;
}
/**
* Returns descriptive text concerning a xlsx file based on its document
* object
*
* @param object $dom a document object to extract a description from.
* @return string a description of the slide
*/
public static function description($dom)
{
$xpath = new \DOMXPath($dom);
$sst_tag = $dom->getElementsByTagName("sst");
$descriptions = "";
foreach ($sst_tag as $sst_value) {
$t_tag = $sst_value->getElementsByTagName("si");
foreach ($t_tag as $t_value) {
$si_value = $t_value->getElementsByTagName("t");
if (!empty($si_value->item(0))) {
$descriptions .= $si_value->item(0)->nodeValue;
}
}
}
return $descriptions;
}
/**
* Returns up to MAX_LINK_PER_PAGE many links from the supplied
* dom object where links have been canonicalized according to
* the supplied $site information.
*
* @param object $dom a document object with links on it
* @param string $site a string containing a url
* @return array links from the $dom object
*/
public static function links($dom, $site)
{
$sites = [];
$hyperlink = "http://schemas.openxmlformats.org/officeDocument/2006/".
"relationships/hyperlink";
$i = 0;
$relationships = $dom->getElementsByTagName("Relationships");
foreach ($relationships as $relationship) {
$relations = $relationship->getElementsByTagName("Relationship");
foreach ($relations as $relation) {
if ( strcmp( $relation->getAttribute('Type'),
$hyperlink) == 0 ) {
if (self::$max_links_to_extract > 0 &&
$i >= self::$max_links_to_extract) {
$link = $relation->getAttribute('Target');
$url = UrlParser::canonicalLink(
$link, $site);
if (!UrlParser::checkRecursiveUrl($url) &&
strlen($url) < C\MAX_URL_LEN) {
if (isset($sites[$url])) {
$sites[$url] .=" ".$link;
} else {
$sites[$url] = $link;
}
$i++;
}
}
}
}
}
return $sites;
}
}