<?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\library\index_bundle_iterators;
use seekquarry\yioop\configs as C;
use seekquarry\yioop\library as L;
use seekquarry\yioop\library\FetchUrl;
use seekquarry\yioop\library\AnalyticsManager;
/**
* This iterator is used to handle querying a network of queue_servers
* with regard to a query
*
* @author Chris Pollett
*/
class NetworkIterator extends IndexBundleIterator
{
/**
* Part of query without limit and num to be processed by all queue_server
* machines
*
* @var string
*/
public $base_query;
/**
* Current limit number to be added to base query
*
* @var string
*/
public $limit;
/**
* Flags for each server saying if there are more results for that server
* or not
*
* @var array
*/
public $more_results;
/**
* used to adaptively change the number of pages requested from each
* machine based on the number of machines that still have results
* @var int
*/
public $next_results_per_server;
/**
* Number of query results downloaded from machines involved in network
* query
* @var int
*/
public $num_downloaded;
/**
* Flags used to keep track of whether a given machine has more search
* result data. Array of booleans
* @var array
*/
public $more_flags;
/**
* How url, keywords, and title words should influence relevance
* and doc rank calculations
* @var array
*/
public $ranking_factors;
/**
* last value for results_per_block
* @var int
*/
public $last_results_per_block;
/** Host Key position + 1 (first char says doc, inlink or eternal link)*/
const HOST_KEY_POS = 17;
/** Length of a doc key*/
const KEY_LEN = 8;
/**
* Creates a network iterator with the given parameters.
*
* @param string $query the query that was supplied by the end user
* that we are trying to get search results for
* @param array $queue_servers urls of yioop instances on which documents
* indexes live
* @param string $timestamp the timestamp of the particular current index
* archive bundles that we look in for results
* @param SearchfiltersModel $filter Model responsible for keeping
* track of edited and deleted search results
* @param string $save_timestamp_name if this timestamp is nonzero, then
* when making queries to separate machines the save_timestamp is sent
* so the queries on those machine can make savepoints. Note the
* format of save_timestamp is timestamp-query_part where query_part
* is the number of the item in a query presentation (usually 0).
* @param array $ranking_factors field say how url, keywords, and
* title words should influence relevance and doc rank calculations
*/
public function __construct($query, public $queue_servers, $timestamp,
public $filter = null, $save_timestamp_name = "",
$ranking_factors = [])
{
$this->results_per_block = ceil(C\p('MIN_RESULTS_TO_GROUP'));
$num_servers = max(1, count($queue_servers));
$this->next_results_per_server =
self::serverAdjustedResultsPerBlock($num_servers,
$this->results_per_block);
$this->base_query = "q=" . urlencode($query).
"&f=serial&network=false&raw=1&its=$timestamp&guess=false";
foreach (["cld_url_bonus" => C\p('CLD_URL_BONUS'),
"host_url_bonus" => C\p('HOST_URL_BONUS'),
"host_keyword_bonus" => C\p('HOST_KEYWORD_BONUS'),
"path_keyword_bonus" => C\p('PATH_KEYWORD_BONUS'),
"title_bonus" => C\p('TITLE_BONUS'),
"user_rank_bonus" => C\p('USER_RANK_BONUS'),
"wiki_bonus" => C\p('WIKI_BONUS'),
"num_slashes_bonus" => C\p('NUM_SLASHES_BONUS'),
] as $factor => $default) {
$this->base_query .= "&$factor=" . ($ranking_factors[$factor] ??
$default);
}
if ($save_timestamp_name != "") {
// used for archive crawls of crawl mixes
$this->base_query .= "&save_timestamp=$save_timestamp_name";
}
$this->limit = 0;
$count = count($this->queue_servers);
for ($i = 0; $i < $count; $i++) {
$this->more_flags[$i] = true;
}
$this->last_results_per_block = $this->results_per_block;
}
/**
* Returns the iterators to the first document block that it could iterate
* over
*/
public function reset()
{
$this->limit = 0;
$this->last_results_per_block = $this->results_per_block;
$num_servers = max(1, count($this->queue_servers));
$this->next_results_per_server =
self::serverAdjustedResultsPerBlock($num_servers,
$this->results_per_block);
$count = count($this->queue_servers);
for ($i = 0; $i < $count; $i++) {
$this->more_flags[$i] = true;
}
}
/**
* Forwards the iterator one group of docs
* @param array $gen_doc_offset a generation, doc_offset pair. If set,
* the must be of greater than or equal generation, and if equal the
* next block must all have $doc_offsets larger than or equal to
* this value
*/
public function advance($gen_doc_offset = null)
{
$this->current_block_fresh = false;
$num_added = $this->num_downloaded ?? 0;
$this->limit += $num_added;
}
/**
* Gets the doc_offset and generation for the next document that
* would be return by this iterator. As this is not easily determined
* for a network iterator, this method always returns -1 for this
* iterator
*
* @return mixed an array with the desired document offset
* and generation; -1 on fail
*/
public function currentGenDocOffsetWithWord()
{
return -1;
}
/**
* Hook function used by currentDocsWithWord to return the current block
* of docs if it is not cached
*
* @return mixed doc ids and score if there are docs left, -1 otherwise
*/
public function findDocsWithWord()
{
if ($this->last_results_per_block != $this->results_per_block) {
$this->last_results_per_block = $this->results_per_block;
$num_servers = max(1, count($this->queue_servers));
$this->next_results_per_server =
self::serverAdjustedResultsPerBlock($num_servers,
$this->results_per_block);
}
$query = $this->base_query .
"&num={$this->next_results_per_server}&limit={$this->limit}";
$sites = [];
$lookup = [];
$i = 0;
$j = 0;
foreach ($this->queue_servers as $server) {
if ($this->more_flags[$i]) {
// ###@ tells FetchUrl to use dns cache if possible.
$sites[$j][self::URL] = $server . "?". $query.
"&machine=$i###@";
$lookup[$j] = $i;
$j++;
}
$i++;
}
$net_times = AnalyticsManager::get("NET_TIMES") ?? 0;
$download_time = microtime(true);
$downloads = [];
if (count($sites) > 0) {
$downloads = FetchUrl::getPages($sites, false, 0, null, self::URL,
self::PAGE, true);
}
$net_times += L\changeInMicrotime($download_time);
AnalyticsManager::set("NET_TIMES", $net_times);
$results = [];
$count = count($downloads);
$this->num_docs = 0;
$this->num_downloaded = 0;
$in4 = " ";
$machine_times = AnalyticsManager::get("MACHINE_TIMES");
$indent = ($machine_times) ? "<br>$in4" : $in4;
$machine_times = ($machine_times) ? $machine_times: "";
$max_machine_times = AnalyticsManager::get("MAX_MACHINE_TIMES");
$max_machine_times = ($max_machine_times) ? $max_machine_times : 0;
$max_time = 0;
$num_with_results = $count;
for ($j = 0; $j < $count; $j++) {
$download = $downloads[$j];
$lookup_link = $this->makeLookupLink($sites, $lookup[$j]);
if (!empty($download[self::PAGE])) {
if (preg_match("/PHP[\s\w]+(NOTICE|ERROR|WARNING)(.+){0,250}/i",
$download[self::PAGE], $errors)) {
L\crawlLog("NetworkIterator reports an error response from".
" the request" . $download[self::URL]);
L\crawlLog($errors[0]);
$download[self::PAGE] = "";
}
set_error_handler(null);
$pre_result = @unserialize($download[self::PAGE]);
restore_error_handler();
if (!isset($pre_result["TOTAL_ROWS"]) ||
$pre_result["TOTAL_ROWS"] < $this->results_per_block) {
$this->more_flags[$lookup[$j]] = false;
$num_with_results--;
}
if (isset($pre_result["TOTAL_ROWS"])) {
$this->num_docs += $pre_result["TOTAL_ROWS"];
}
if (isset($pre_result["PAGES"])) {
$this->num_downloaded += count($pre_result["PAGES"]);
foreach ($pre_result["PAGES"] as $page_data) {
if (isset($page_data[self::KEY])) {
$results[$page_data[self::KEY]] =
$page_data;
$results[$page_data[self::KEY]][self::MACHINE_ID] =
$lookup[$j];
}
}
}
$elapsed_time = (float)($pre_result['ELAPSED_TIME'] ?? 0);
$total_time = (float)($pre_result['TOTAL_TIME'] ?? 0);
$max_time = max($max_time, $total_time);
$machine_times .= $in4 . $lookup_link . " ".
number_format($elapsed_time, 6) . "/" .
number_format($total_time, 6) . "<br>";
} else {
$machine_times .= $in4 . $lookup_link . " No Results<br>";
}
}
$machine_times = substr( $machine_times, 0, -strlen("<br>"));
if ($num_with_results > 0) {
$this->next_results_per_server =
self::serverAdjustedResultsPerBlock($num_with_results,
$this->results_per_block);
}
$max_machine_times += $max_time;
AnalyticsManager::set("MACHINE_TIMES", $machine_times);
AnalyticsManager::set("MAX_MACHINE_TIMES", $max_machine_times);
if ($results == []) {
$results = -1;
}
if ($results != -1) {
if ($this->filter != null) {
foreach ($results as $keys => $data) {
$host_key =
substr($keys, self::HOST_KEY_POS, self::KEY_LEN);
if (!empty($this->filter) && $this->filter->isFiltered(
$host_key)) {
unset($results[$keys]);
}
}
}
$this->count_block = count($results);
$this->pages = $results;
} else {
$this->count_block = 0;
$this->pages = [];
}
return $results;
}
/**
* Called to make a link for AnalyticsManager about a network query
* performed by this iterator.
*
* @param array $sites used by this network iterator
* @param int $index which site in array to make link for
* @return string html of link
*/
public function makeLookupLink($sites, $index)
{
if (isset($sites[$index][self::URL])) {
$url = $sites[$index][self::URL];
$title = $url;
} else {
if (!isset($sites[$index])) {
$sites[$index] = [];
}
$tmp = urlencode(print_r($sites[$index],
true));
$title = 'URL not set';
if (trim($tmp) == "") {
$tmp = 'Site null';
}
$url = 'javascript:alert("'.$tmp.'")';
}
$link = "<a target='_blank' rel='noopener' class='gray-link'".
" href='$url' title='$title' >ID_$index</a>:";
return $link;
}
/**
* Gets the summaries associated with the keys provided the keys
* can be found in the current block of docs returned by this iterator
* @param array $keys keys to try to find in the current block of returned
* results
* @return array doc summaries that match provided keys
*/
public function getCurrentDocsForKeys($keys = null)
{
if ($this->current_block_fresh == false) {
$pages = $this->currentDocsWithWord();
if (!is_array($pages)) {
return $pages;
}
} else {
$pages = & $this->pages;
}
return $pages;
}
/**
* If we want the top $num_results results (a block) and we have
* $num_machines, this computes how many results we shhould request
* of each machine.
* Buttcher, Clark, Cormack give an exact formula to compute this,
* but it is slow to compute
* We instead compute a (1/$num_machines^{3/4})* $num_results + 5;
* @param int $num_machines number of machines each having a portion
* of the results
* @param int $num_results, the k value that we want the top k best
* overall results.
* @return int number of best results we should ask from each machine
* to ensure get top k best results overall
*/
public static function serverAdjustedResultsPerBlock($num_machines,
$num_results)
{
if ($num_machines <= 1) {
return $num_results;
}
$slope = 1/pow($num_machines, 0.75);
return min($num_results, intval($slope * $num_results + 5));
}
}
(c) 2026 Seekquarry - Open Source Search Engine Software