sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-12-22 13:45:02 +00:00
Code Activity

Add search index rebuilding action to master settings screen

Browse source
This commit is contained in:
Starbeamrainbowlabs 2017-07-11 20:21:20 +01:00
parent 576b293c4e
commit 1236ce8e4d
4 changed files with 105 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
build/index.php
View file

@ -2554,6 +2554,39 @@ register_module([
$content = "<h1>Master Control Panel</h1>\n";
$content .= "<p>This page lets you configure $settings->sitename's master settings. Please be careful - you can break things easily on this page if you're not careful!</p>\n";
$content .= "<h2>Actions</h2>";
$content .= "<button class='action-invindex-rebuild'>Rebuild Search Index</button><br />\n";
$content .= "<output class='action-invindex-rebuild-latestmessage'></output><br />\n";
$content .= "<progress class='action-invindex-rebuild-progress' min='0' max='100' value='0' style='display: none;'></progress><br />\n";
$invindex_rebuild_script = <<<SCRIPT
window.addEventListener("load", function(event) {
document.querySelector(".action-invindex-rebuild").addEventListener("click", function(event) {
var rebuildActionEvents = new EventSource("?action=invindex-rebuild");
var latestMessageElement = document.querySelector(".action-invindex-rebuild-latestmessage");
var progressElement = document.querySelector(".action-invindex-rebuild-progress");
rebuildActionEvents.addEventListener("message", function(event) {
console.log(event);
let message = event.data;
latestMessageElement.value = event.data;
let parts = message.match(/^\[\s*(\d+)\s+\/\s+(\d+)\s*\]/);
if(parts != null) {
progressElement.style.display = "";
progressElement.min = 0;
progressElement.max = parseInt(parts[2]);
progressElement.value = parseInt(parts[1]);
}
if(message.startsWith("Done! Saving new search index to"))
rebuildActionEvents.close();
});
});
});
SCRIPT;
page_renderer::AddJSSnippet($invindex_rebuild_script);
$content .= "<h2>Settings</h2>";
$content .= "<p>Mouse over the name of each setting to see a description of what it does.</p>\n";
$content .= "<form action='?action=configure-save' method='post'>\n";
@ -3122,7 +3155,9 @@ register_module([
* @apiDescription Causes the inverted search index to be completely rebuilt from scratch. Can take a while for large wikis!
* @apiName SearchInvindexRebuild
* @apiGroup Search
* @apiPermission Anonymous
* @apiPermission Admin
*
* @apiParam {string} secret Optional. Specify the secret from peppermint.json here in order to rebuild the search index without logging in.
*/
/*
@ -3572,10 +3607,12 @@ class search
public static function rebuild_invindex($output = true)
{
global $pageindex, $env, $paths;
global $pageindex, $env, $paths, $settings;
if($output)
if($output) {
header("content-type: text/event-stream");
ob_end_flush();
}
// Clear the id index out
ids::clear();
@ -3583,16 +3620,24 @@ class search
// Reindex each page in turn
$invindex = [];
$i = 0; $max = count(get_object_vars($pageindex));
$missing_files = 0;
foreach($pageindex as $pagename => $pagedetails)
{
$pagesource = utf8_encode(file_get_contents("$env->storage_prefix$pagename.md"));
$page_filename = $env->storage_prefix . $pagedetails->filename;
if(!file_exists($page_filename)) {
echo("data: [" . ($i + 1) . " / $max] Error: Can't find $page_filename");
flush();
$missing_files++;
continue;
}
$pagesource = utf8_encode(file_get_contents($page_filename));
$index = self::index($pagesource);
$pageid = ids::getid($pagename);
self::merge_into_invindex($invindex, $pageid, $index);
if($output) {
echo("[" . ($i + 1) . " / $max] Added $pagename (id #$pageid) to the new search index.\n\n");
echo("data: [" . ($i + 1) . " / $max] Added $pagename (id #$pageid) to the new search index.\n\n");
flush();
}
@ -3600,8 +3645,9 @@ class search
}
if($output) {
echo("Search index rebuilding complete.\n\n");
echo("Saving new search index to '$paths->searchindex'.\n\n");
echo("data: Search index rebuilding complete.\n\n");
echo("data: Couldn't find $missing_files pages on disk. If $settings->sitename couldn't find some pages on disk, then you might need to manually correct $settings->sitename's page index (stored in pageindex.json).\n\n");
echo("data: Done! Saving new search index to '$paths->searchindex'.\n\n");
}
self::save_invindex($paths->searchindex, $invindex);

4
module_index.json
View file

@ -68,7 +68,7 @@
"author": "Starbeamrainbowlabs",
"description": "The module everyone has been waiting for! Adds a web based gui that lets mods change the wiki settings.",
"id": "feature-guiconfig",
"lastupdate": 1490040335,
"lastupdate": 1499800769,
"optional": false
},
{
@ -104,7 +104,7 @@
"author": "Starbeamrainbowlabs",
"description": "Adds proper search functionality to Pepperminty Wiki using an inverted index to provide a full text search engine. If pages don't show up, then you might have hit a stop word. If not, try requesting the `invindex-rebuild` action to rebuild the inverted index from scratch.",
"id": "feature-search",
"lastupdate": 1499720597,
"lastupdate": 1499800831,
"optional": false
},
{

33
modules/feature-guiconfig.php
View file

@ -36,6 +36,39 @@ register_module([
$content = "<h1>Master Control Panel</h1>\n";
$content .= "<p>This page lets you configure $settings->sitename's master settings. Please be careful - you can break things easily on this page if you're not careful!</p>\n";
$content .= "<h2>Actions</h2>";
$content .= "<button class='action-invindex-rebuild'>Rebuild Search Index</button><br />\n";
$content .= "<output class='action-invindex-rebuild-latestmessage'></output><br />\n";
$content .= "<progress class='action-invindex-rebuild-progress' min='0' max='100' value='0' style='display: none;'></progress><br />\n";
$invindex_rebuild_script = <<<SCRIPT
window.addEventListener("load", function(event) {
document.querySelector(".action-invindex-rebuild").addEventListener("click", function(event) {
var rebuildActionEvents = new EventSource("?action=invindex-rebuild");
var latestMessageElement = document.querySelector(".action-invindex-rebuild-latestmessage");
var progressElement = document.querySelector(".action-invindex-rebuild-progress");
rebuildActionEvents.addEventListener("message", function(event) {
console.log(event);
let message = event.data;
latestMessageElement.value = event.data;
let parts = message.match(/^\[\s*(\d+)\s+\/\s+(\d+)\s*\]/);
if(parts != null) {
progressElement.style.display = "";
progressElement.min = 0;
progressElement.max = parseInt(parts[2]);
progressElement.value = parseInt(parts[1]);
}
if(message.startsWith("Done! Saving new search index to"))
rebuildActionEvents.close();
});
});
});
SCRIPT;
page_renderer::AddJSSnippet($invindex_rebuild_script);
$content .= "<h2>Settings</h2>";
$content .= "<p>Mouse over the name of each setting to see a description of what it does.</p>\n";
$content .= "<form action='?action=configure-save' method='post'>\n";

23
modules/feature-search.php
View file

@ -498,10 +498,12 @@ class search
public static function rebuild_invindex($output = true)
{
global $pageindex, $env, $paths;
global $pageindex, $env, $paths, $settings;
if($output)
if($output) {
header("content-type: text/event-stream");
ob_end_flush();
}
// Clear the id index out
ids::clear();
@ -509,16 +511,24 @@ class search
// Reindex each page in turn
$invindex = [];
$i = 0; $max = count(get_object_vars($pageindex));
$missing_files = 0;
foreach($pageindex as $pagename => $pagedetails)
{
$pagesource = utf8_encode(file_get_contents("$env->storage_prefix$pagename.md"));
$page_filename = $env->storage_prefix . $pagedetails->filename;
if(!file_exists($page_filename)) {
echo("data: [" . ($i + 1) . " / $max] Error: Can't find $page_filename");
flush();
$missing_files++;
continue;
}
$pagesource = utf8_encode(file_get_contents($page_filename));
$index = self::index($pagesource);
$pageid = ids::getid($pagename);
self::merge_into_invindex($invindex, $pageid, $index);
if($output) {
echo("[" . ($i + 1) . " / $max] Added $pagename (id #$pageid) to the new search index.\n\n");
echo("data: [" . ($i + 1) . " / $max] Added $pagename (id #$pageid) to the new search index.\n\n");
flush();
}
@ -526,8 +536,9 @@ class search
}
if($output) {
echo("Search index rebuilding complete.\n\n");
echo("Saving new search index to '$paths->searchindex'.\n\n");
echo("data: Search index rebuilding complete.\n\n");
echo("data: Couldn't find $missing_files pages on disk. If $settings->sitename couldn't find some pages on disk, then you might need to manually correct $settings->sitename's page index (stored in pageindex.json).\n\n");
echo("data: Done! Saving new search index to '$paths->searchindex'.\n\n");
}
self::save_invindex($paths->searchindex, $invindex);