<?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\views\elements;
use seekquarry\yioop as B;
use seekquarry\yioop\configs as C;
use seekquarry\yioop\library\CrawlConstants;
/**
* Element responsible for displaying options about how a crawl will be
* performed. For instance, what are the seed sites for the crawl, what
* sites are allowed to be crawl what sites must not be crawled, etc.
*
* @author Chris Pollett
*/
class CrawloptionsElement extends Element
{
/**
* Draws configurable options about how a web crawl should be conducted
*
* @param array $data keys are generally the different setting that can
* be set in the crawl.ini file
*/
public function render($data)
{
$admin_url = htmlentities(B\controllerUrl('admin', true));
$crawlform = (empty($_REQUEST['ts'])) ? "&crawlform=true" :
""; ?>
<div class="current-activity"><?php
$this->view->helper("close")->render($admin_url .
"a=manageCrawls&" . C\p('CSRF_TOKEN') . "=" .
$data[C\p('CSRF_TOKEN')] .
$crawlform);
if (isset($data['ts'])) {
?><h2><?= tl('crawloptions_element_modify_active_crawl')
?></h2><?php
} else {
?><h2><?= tl('crawloptions_element_edit_crawl_options')
?></h2><?php
} ?>
<form id="crawloptionsForm" method="post">
<input type="hidden" name="c" value="admin" >
<input type="hidden" name="<?= C\p('CSRF_TOKEN') ?>" value="<?=
$data[C\p('CSRF_TOKEN')] ?>" >
<input type="hidden" name="a" value="manageCrawls" >
<input type="hidden" name="arg" value="options" >
<input type="hidden" name="posted" value="posted" >
<input type="hidden" id='crawl-type' name="crawl_type" value="<?=
$data['crawl_type'] ?>" >
<?php if (isset($data['ts'])) { ?>
<input type="hidden" name="ts" value="<?=
$data['ts'] ?>" >
<?php } ?>
<ul class='tab-menu-list'>
<?php if (!isset($data['ts']) ||
$data['crawl_type'] == CrawlConstants::WEB_CRAWL) { ?>
<li><a <?php if (!isset($data['ts'])) { ?>
href="javascript:switchTab('webcrawltab', 'archivetab');"
<?php } ?>
id='webcrawltabitem'
class="<?= $data['web_crawl_active'] ?>"><?=
tl('crawloptions_element_web_crawl')?></a></li>
<?php
}
if (!isset($data['ts']) ||
$data['crawl_type'] == CrawlConstants::ARCHIVE_CRAWL) { ?>
<li><a <?php if (!isset($data['ts'])) { ?>
href="javascript:switchTab('archivetab', 'webcrawltab');"
<?php } ?>
id='archivetabitem'
class="<?= $data['archive_crawl_active'] ?>"><?=
tl('crawloptions_element_archive_crawl') ?></a></li>
<?php } ?>
</ul>
<div class='tab-menu-content'>
<div id='webcrawltab'>
<?php if (!isset($data['ts'])) { ?>
<div class="top-margin"><label for="load-options"><b><?=
tl('crawloptions_element_load_options') ?></b></label><?php
$this->view->helper("options")->render("load-options","load_option",
$data['available_options'], $data['options_default']);
?></div>
<div class="top-margin">[<a href="<?= $admin_url .
C\p('CSRF_TOKEN') . "=" .
$data[C\p('CSRF_TOKEN')] . "&a=pageOptions" ?>"><?=
tl('crawloptions_element_page_options')
?></a>]</div>
<div class="top-margin"><label for="server-channel"><b><?=
tl('crawloptions_element_server_channel') ?></b></label><?php
if (empty($data['available_server_channels'])) {
e(" <span class='red' >" .
tl('crawloptions_element_no_machines') . "</span>");
} else {
$this->view->helper("options")->render("server-channel",
"server_channel", $data['available_server_channels'],
$data['server_channel']);
}
e(" ".$this->view->helper("helpbutton")->render(
"Server Channel", $data[C\p('CSRF_TOKEN')]));
?></div>
<div class="top-margin"><label for="crawl-order"><b><?=
tl('crawloptions_element_crawl_order') ?></b></label><?php
$this->view->helper("options")->render("crawl-order", "crawl_order",
$data['available_crawl_orders'], $data['crawl_order']);
e(" ".$this->view->helper("helpbutton")->render(
"Crawl Order", $data[C\p('CSRF_TOKEN')]));
?></div>
<div class="top-margin"><label for="max-depth"><b><?=
tl('crawloptions_element_max_depth') ?></b></label><?php
$this->view->helper("options")->render("max-depth", "max_depth",
$data['available_max_depths'], $data['max_depth']);
e(" ".$this->view->helper("helpbutton")->render(
"Max Depth", $data[C\p('CSRF_TOKEN')]));
?>
</div>
<?php } ?>
<div class="top-margin"><label for="repeat-type"><b><?=
tl('crawloptions_element_repeat_type') ?></b></label><?php
$this->view->helper("options")->render("repeat-type", "repeat_type",
$data['available_repeat_types'], $data['repeat_type']);
e(" ".$this->view->helper("helpbutton")->render(
"Repeat Type", $data[C\p('CSRF_TOKEN')]));
?>
</div>
<div class="top-margin"><b><?=tl('crawloptions_element_crawl_sleep')
?></b>
<label for="sleep_start"><?=tl('crawloptions_element_sleep_start')
?></label><input type="time" name="sleep_start" id="sleep-start"
placeholder="HH:MM" value="<?=$data['sleep_start']?>"
style="width:140px;" >
<label for="sleep_start"><?=tl('crawloptions_element_sleep_duration')
?></label><?php
$this->view->helper("options")->render("sleep-duration",
"sleep_duration", $data['available_sleep_durations'],
$data['sleep_duration']);
e(" ".$this->view->helper("helpbutton")->render(
"Crawl Sleep", $data[C\p('CSRF_TOKEN')]));
?>
</div>
<div class="top-margin"><label for="robots-txt"><b><?=
tl('crawloptions_element_robots_txt') ?></b></label><?php
$this->view->helper("options")->render("robots-txt", "robots_txt",
$data['robots_txt_behaviors'], $data['robots_txt']);
e(" ".$this->view->helper("helpbutton")->render(
"Robots Behaviors", $data[C\p('CSRF_TOKEN')]));
?>
</div>
<div class="top-margin"><label for="restrict-sites-by-url"><b><?=
tl('crawloptions_element_restrict_by_url')?></b></label>
<input type="checkbox" id="restrict-sites-by-url"
class="restrict-sites-by-url"
name="restrict_sites_by_url" value="true"
onclick="setDisplay('toggle', this.checked)" <?=
$data['TOGGLE_STATE'] ?> ></div>
<div id="toggle">
<div class="top-margin"><label for="allowed-sites"><b><?=
tl('crawloptions_element_allowed_to_crawl') ?></b></label> <?=
$this->view->helper("helpbutton")->render(
"Allowed to Crawl Sites", $data[C\p('CSRF_TOKEN')]) ?></div>
<textarea class="short-text-area" id="allowed-sites"
name="allowed_sites"><?=$data['allowed_sites']?></textarea></div>
<div class="top-margin"><label for="disallowed-sites"><b><?=
tl('crawloptions_element_disallowed_and_quota_sites')?></b></label>
<?=$this->view->helper("helpbutton")->render(
"Disallowed and Sites With Quotas",
$data[C\p('CSRF_TOKEN')])?></div>
<textarea class="short-text-area" id="disallowed-sites"
name="disallowed_sites" ><?=$data['disallowed_sites'] ?></textarea>
<?php
if (!isset($data['ts'])) { ?>
<div class="top-margin"><label for="seed-sites"><b><?=
tl('crawloptions_element_seed_sites')?></b></label><?php
if (!C\DIRECT_ADD_SUGGEST) {
?>[<a href="<?=$admin_url
?>&a=manageCrawls&arg=options<?=
'&' . C\p('CSRF_TOKEN') . '=' . $data[C\p('CSRF_TOKEN')]
?>&suggest=add"><?=
tl('crawloptions_element_add_suggest_urls') ?></a>] <?=
$this->view->helper("helpbutton")->render(
"Seed Sites and URL Suggestions", $data[C\p('CSRF_TOKEN')])
?><?php
}
?>
</div>
<textarea class="tall-text-area" id="seed-sites"
name="seed_sites" ><?= $data['seed_sites']
?></textarea><?php
} else { ?>
<div class="top-margin"><label for="inject-sites"><b><?=
tl('crawloptions_element_inject_sites')?></b></label><?php
if (!C\DIRECT_ADD_SUGGEST) {
?>[<a href="?c=admin&a=manageCrawls&arg=options<?=
'&'.C\p('CSRF_TOKEN').'='.$data[C\p('CSRF_TOKEN')].
'&ts='.
$data['ts'] ?>&suggest=add"><?=
tl('crawloptions_element_add_suggest_urls') ?></a>]
</div>
<?php
if ($data['INJECT_SITES'] != "") {
?>
<input type="hidden" name="use_suggest" value="true" >
<?php
}
}
?>
<textarea class="short-text-area" id="inject-sites"
name="inject_sites"><?= $data['INJECT_SITES']?></textarea>
<?php
} ?>
</div>
<div id='archivetab'>
<?php if (!isset($data['ts'])) { ?>
<div>[<a href="<?= $admin_url . C\p('CSRF_TOKEN') . "=" .
$data[C\p('CSRF_TOKEN')] . "&a=pageOptions" ?>"><?=
tl('crawloptions_element_page_options')
?></a>]</div>
<div class="top-margin"><label for="aserver-channel"><b><?=
tl('crawloptions_element_server_channel') ?></b></label><?php
$this->view->helper("options")->render("aserver-channel",
"aserver_channel", $data['available_server_channels'],
$data['server_channel']);
e(" ".$this->view->helper("helpbutton")->render(
"Server Label", $data[C\p('CSRF_TOKEN')]));
?></div>
<div class="top-margin"><b><?=tl('crawloptions_element_crawl_sleep')
?></b>
<label for="asleep_start"><?=tl('crawloptions_element_sleep_start')
?></label><input type="time" name="asleep_start" id="asleep-start"
placeholder="HH:MM" value="<?=$data['sleep_start']?>"
style="width:140px;" >
<label for="sleep_start"><?=tl('crawloptions_element_sleep_duration')
?></label><?php
$this->view->helper("options")->render("asleep-duration",
"asleep_duration", $data['available_sleep_durations'],
$data['sleep_duration']);
e(" ".$this->view->helper("helpbutton")->render(
"Crawl Sleep", $data[C\p('CSRF_TOKEN')]));
?>
</div>
<div class="top-margin"><label for="load-options"><b><?=
tl('crawloptions_element_reindex_crawl') ?></b></label><?php
$this->view->helper("options")->render("crawl-indexes",
"crawl_indexes",
$data['available_crawl_indexes'], $data['crawl_index']);
?> <?=$this->view->helper("helpbutton")->render(
"Arc and Re-crawls", $data[C\p('CSRF_TOKEN')]) ?></div>
<?php if (!C\p('API_ACCESS')) { ?>
<div class="center red"><?=
tl('crawloptions_element_need_api_for_mix') ?></div>
<?php } ?>
</div>
<?php } ?>
</div>
<div class="center slight-pad"><button class="button-box"
type="submit" name="save_options">
<?= tl('crawloptions_element_save')
?></button></div>
</form>
</div>
<script>
function switchTab(newtab, oldtab)
{
setDisplay(newtab, true);
setDisplay(oldtab, false);
ntab = elt(newtab+"item");
if (ntab) {
ntab.className = 'active';
}
otab = elt(oldtab+"item");
if (otab) {
otab.className = '';
}
ctype = elt('crawl-type');
if (ctype) {
ctype.value = (newtab == 'webcrawltab')
? '<?= CrawlConstants::WEB_CRAWL ?>' :
'<?= CrawlConstants::ARCHIVE_CRAWL ?>';
}
}
</script>
<?php
}
}
(c) 2026 Seekquarry - Open Source Search Engine Software