/**
* 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 Eswara Rajesh Pinapala epinapala@live.com
* @license https://www.gnu.org/licenses/ GPL3
* @link https://www.seekquarry.com/
* @copyright 2009 - 2023
* @filesource
*/
current_activity_closed = true;
current_activity_top = 0;
previous_help = null;
/*
* Toggles Help element from display:none and display block.
* Also changes the width of the Current activity accordingly.
* @param String help element's id to toggle.
* @param String is_mobile flag true/false.
* @param String target_controller Edit page's controller name.
*/
function toggleHelp(id, is_mobile, target_controller)
{
let activity = 'current-activity';
let images = document.querySelectorAll(".wiki-resource-image");
let all_help_elements =
document.getElementsByClassName(activity);
let help_node = all_help_elements[0];
if (current_activity_closed === true) {
current_activity_top = getCssProperty(help_node, 'top');
}
obj = elt(id);
if (is_mobile === false) {
toggleDisplay(id, "inline-block");
} else {
toggleDisplay(id, "inline-block");
let height_after_toggle = (elt("mobile-help").clientHeight);
//Calculate pixel to inch. clientWidth only returns in pixels.
if (obj.style.display === "none") {
//on closing, restore top
help_node.style.top = current_activity_top + "px";
current_activity_closed = true;
} else {
//setDisplay("help-frame",true,"inline-block");
help_node.style.top = current_activity_top +
height_after_toggle + "px";
/* The div.clientHeight doesn't include the height
of the images inside the div before the images are completely
loaded. So we iterate through the
image elements, as each image loads add the image
height to the top of the current_activity div dynamically. */
for (let i = 0; i < images.length; i++) {
let image = images[i];
image.onload = function ()
{
help_node.style.top = getCssProperty(help_node,
'top') + this.height + 'px';
};
}
current_activity_closed = false;
}
}
}
/*
* Gets the Css property given an element and property name.
* @param Object elm Element to get the Css property for.
* @param String property Css property name.
* @return String Css property value
*/
function getCssProperty(elm, property)
{
//always returns in px
return parseInt(window.getComputedStyle(elm, null)
.getPropertyValue(property));
}
/*
* This is a JS function to convert yioop wiki markup to
* html.
* @param String wiki_text to be parsed as HTML
* @return String parsed html.
*/
function parseWikiContent(wiki_text, group_id, page_id, controller_name,
csrf_token_key, csrf_token_value)
{
let html = wiki_text;
/* note that line breaks from a text area are sent
as \r\n , so make sure we clean them up to replace
all \r\n with \n */
html = html.replace(/\r\n/g, "\n");
html = parseLists(html);
//Regex replace normal links
html = html.replace(/[^\[](http[^\[\s]*)/g, function (m, l)
{
// normal link
return '<a href="' + l + '">' + l + '</a>';
});
//Regex replace for external links
html = html.replace(/\[[\[](http.*)[!\]]/g, function (m, l)
{
// external link
let p = l.replace(/[\[\]]/g, '').split(/\|/);
let link = p.shift();
return '<a href="' + link + '">' + (p.length ? p.join(' ') :
link) + '</a>';
});
//Regex replace for headings
html = html.replace(/(?:^|\n)([=]+)(.*)\1/g,
function (match, contents, t)
{
return '<h' + contents.length + '>' + t + '</h' + contents.length +
'>';
});
//Regex replace for Bold characters
html = html.replace(/'''(.*?)'''/g, function (match, contents)
{
return '<b>' + contents + '</b>';
});
//Regex replace for Italic characters
html = html.replace(/''(.*?)''/g, function (match, contents)
{
return '<i>' + contents + '</i>';
});
//Regex for yioop resource extraction.
html = html.replace(/\(\(resource:(.+?)\|(.+?)\)\)/g,
function (match, contents, desc)
{
if ((/\.(gif|jpg|jpeg|tiff|png|bmp|tif)$/i).test(contents)) {
return '<img src="' + "?c=resource&a=get&f=resources&g=" +
group_id + "&p=" + page_id + "&n=" + contents +
'" alt="' + desc + '" class="wiki-resource-image" >';
} else if ((/\.(avi|m4v|flv|wmv|mp4|webm|ogg|mov|mpg)$/i)
.test(contents)) {
return '<video style="width:100%" controls="controls">' +
'<source src="./?c=resource&a=get&f=resources&g=' +
group_id + '&p=' + page_id + '&n=' + contents +
'" type="video/mp4">' + desc + '</video>';
} else {
return '<a href="' + "?c=resource&a=get&f=resources&g=" +
group_id + "&p=" + page_id + "&n=" + contents +
'" alt="' + desc + '" >' + desc + '</a>';
}
});
//Regex replace for HR
html = html.replace(/----(.*?)/g, function (match, contents)
{
return contents + '<hr >';
});
//Regex replace for def list
html = html.replace
(/(\A|\n);([^:]+):(.+)/g,
function (match, match2, match3, match4)
{
return "<dl><dt>" + match3 + "</dt><dd>" +
match4 + "</dd></dl>";
});
//replace nowiki with pre tags
html = html.replace(/<nowiki>(.*?)<\/nowiki>/g, function (match,
contents)
{
return '<pre>' + contents + '</pre>';
});
//Regex replace for blocks
html = html.replace(/(?:^|\n+)([^# =\*<].+)(?:\n+|$)/gm,
function (match, contents)
{
if (contents.match(/^\^+$/))
return contents;
return "\n<div>" + contents + "</div>\n";
});
//Internal links to other pages.
html = html.replace(/\[\[(.*?)\]\]/g, function (matches, internal_link)
{
let internal_link_array = internal_link.split(/\|/);
let page_name = internal_link_array.shift().replace(/ /g, "_");
return '<a href="' + '?c=' + controller_name
+ '&a=wiki&arg=read&group_id=' + group_id + '&page_name=' + page_name
+ "&" + csrf_token_key + '=' + csrf_token_value + '">'
+ (internal_link_array.length ? internal_link_array.join('|')
: page_name)
+ '</a>';
});
//Parse right/left/center justified text. Does a literal word match, instead
//of (.+?).
html = html.replace(/{{(left|right|center)\|(.+?)}}/g, function (match,
contents, desc)
{
return '<div class="align-' + contents + '"><div>' + desc
+ '</div></div>';
});
return html;
}
/*
* Lists need to be recursively parsed. So the below function is used
* to recursively convert wiki markup to html.
* @param String str usually the content string in which the UL/OL lists are
* needed to be parsed to html.
* @return String parsed html.
*/
function parseLists(str)
{
return str.replace(/(?:(?:(?:^|\n)[\*#](?:.+\n)+.*))/g, function(match){
match = match.replace(/\n(?![#\*])/g," ");
let listType = match.match(/(^|\s)#/) ? 'ol' : 'ul';
match = match.replace(/(^|\s)[\*#][ ]{0,1}/g, "$1");
match = parseLists(match);
return '<'
+ listType + '><li>'
+ match.replace(/^\s/, '')
.split(/\n/).join('</li><li>')
+ '</li></' + listType
+ '>';
});
}
/*
* getPageWithCallback does a GET HTTP call on the url passed.
* Also fires the callback functions passed as
* params appropriately.
*
* @param String url the url used for making GET HTTP call.
* @param String response_type The response type expected.
* @param Function object success_call_back Callback function on success.
* @param Function object error_handler Callback function on failure.
*/
function getPageWithCallback(url, response_type, success_call_back,
error_handler)
{
let request = makeRequest();
request.open('GET', url, true);
request.onload = function ()
{
let status = request.status;
if (status == 200) {
success_call_back && success_call_back(
JSON.parse(request.responseText));
} else {
error_handler && error_handler(status,
JSON.parse(request.responseText));
}
};
request.send();
};
/*
* Takes in the help point id, uses it to fetch wiki content, then
* wiki content is being eval'd to be painted int he help pane.
* Ajax call happens only if help needs to be displayed.
* @param Object help_point element
* @param String is_mobile flag to check if the client is mobile
* or not.
* @param String target_controller Wiki page's controller name.
* @param String csrf_token_key the dynamic name used for CSRF token.
* @param String csrf_token_value The CSRF token to render edit page.
* @param String help_group_id help's group_id required to render resources.
* @param String api_controller api's controller name.
* @param String api_action api's action name.
* @param String mode r/w mode , usually read.
*/
function displayHelpForId(help_point, is_mobile, target_controller,
current_action, csrf_token_key, csrf_token_value, help_group_id,
api_controller, api_action, mode)
{
if ((elt("help-frame").style.display) === "inline-block") {
toggleHelp('help-frame', is_mobile, target_controller);
if (previous_help == help_point) {
return;
}
}
previous_help = help_point;
let tl = eval('(' + help_point.getAttribute("data-tl") + ')');
let back_params = eval('(' + help_point.getAttribute("data-back-params")
+ ')');
getPageWithCallback("?c=" + api_controller + "&group_id=" +
help_group_id + "&" +
"arg=" + mode + "&" +
"a=" + api_action + "&" +
csrf_token_key + '=' + csrf_token_value + "&" +
"page_name=" + help_point.getAttribute("data-pagename"),
'json',
function(data)
{
elt("help-frame-body").innerHTML = parseWikiContent(
data.wiki_content,
data.group_id,
data.page_id,
target_controller,
csrf_token_key,
csrf_token_value
);
console.log(data);
elt('page_name').innerHTML = data.page_view_title ||
data.page_title;
if (data.can_edit) {
elt('page_name').innerHTML +=
" <div class='position-context'>"+
"<a class='media-anchor-button white' href=\"" +
getEditLink(
target_controller,
current_action,
csrf_token_key,
csrf_token_value,
help_group_id,
data.page_title,
back_params) + '">' +
"<span role='img' aria-label='" +
tl["helpbutton_helper_edit"] +
"'>✏️</span></a>";
}
toggleHelp('help-frame', is_mobile, target_controller);
},
function(status, response)
{
if (status === 404 && response && response.can_edit) {
elt('page_name').innerHTML = help_point
.getAttribute("data-pagename");
elt('page_name').innerHTML +=
" <div class='position-context'>"+
"<a class='media-anchor-button white' href=\"" +
getEditLink(
target_controller,
current_action,
csrf_token_key,
csrf_token_value,
help_group_id,
help_point.getAttribute("data-pagename"),
back_params) + '">' +
"<span role='img' aria-label='" +
tl["helpbutton_helper_edit"] +
"'>✏️</span></a>";
elt("help-frame-body").innerHTML =
(tl["helpbutton_helper_page_no_exist"]).replace("%s", "'" +
help_point.getAttribute("data-pagename") + "'") +
tl["helpbutton_helper_create_edit"];
toggleHelp('help-frame', is_mobile, target_controller);
} else {
doMessage("<h2 class='red'>" +
tl["helpbutton_helper_not_available"] +
"</h2>");
}
});
}
/*
* Simple function to construct the Wiki Edit hyperlink with passed in params.
* @param String target_controller Edit page's controller name.
* @param String csrf_token_key the dynamic name used for CSRF token.
* @param String csrf_token_value The CSRF token to render edit page.
* @param String group_id GroupId of the group which has the wiki.
* @param String page_name Page name,unique Identifier for wiki edit page.
* @return String the edit link
*/
function getEditLink(target_controller, current_action, csrf_token_key,
csrf_token_value, group_id, page_name, back_params)
{
let edit_link = '?c=group' +
'&' + csrf_token_key + '=' + csrf_token_value +
'&group_id=' + group_id +
'&arg=edit' +
'&a=wiki' +
'&page_name=' + page_name +
'&back_params[open_help_page]=' + page_name +
'&back_params[c]=' + target_controller +
'&back_params[a]=' + current_action;
for (let key in back_params) {
let value = back_params[key];
edit_link += "&back_params[" + key + "]=" + value;
}
return edit_link;
}