You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
380 lines
16 KiB
380 lines
16 KiB
<?php
|
|
|
|
// (c) Copyright by authors of the Tiki Wiki CMS Groupware Project
|
|
//
|
|
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
|
|
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
|
|
// $Id$
|
|
|
|
function wikiplugin_include_info()
|
|
{
|
|
return [
|
|
'name' => tr('Include'),
|
|
'documentation' => 'PluginInclude',
|
|
'description' => tr('Include a portion of another wiki page'),
|
|
'prefs' => ['wikiplugin_include'],
|
|
'iconname' => 'copy',
|
|
'introduced' => 1,
|
|
'tags' => [ 'basic' ],
|
|
'format' => 'wiki',
|
|
'params' => [
|
|
'page' => [
|
|
'required' => true,
|
|
'name' => tr('Page'),
|
|
'description' => tr('Name of the source wiki page (which contains the included portion)'),
|
|
'since' => '1',
|
|
'filter' => 'pagename',
|
|
'default' => '',
|
|
'profile_reference' => 'wiki_page',
|
|
],
|
|
'start' => [
|
|
'required' => false,
|
|
'name' => tr('Start'),
|
|
'description' => tr('When only a portion of the page should be included, full text of the line after which
|
|
inclusion should start'),
|
|
'since' => '1',
|
|
'default' => '',
|
|
],
|
|
'stop' => [
|
|
'required' => false,
|
|
'name' => tr('Stop'),
|
|
'description' => tr('When only a portion of the page should be included, full text of the line before which
|
|
inclusion should end'),
|
|
'since' => '1',
|
|
'default' => '',
|
|
],
|
|
'linkoriginal' => [
|
|
'required' => false,
|
|
'name' => tr('Read more button'),
|
|
'description' => tr('Add a "Read more" link at the end of included content, linking to the original page. (shows "Read More" by default)'),
|
|
'since' => '18.0',
|
|
'default' => 'n',
|
|
'options' => [
|
|
['text' => '', 'value' => ''],
|
|
['text' => tr('Yes'), 'value' => 'y'],
|
|
['text' => tr('No'), 'value' => 'n'],
|
|
],
|
|
],
|
|
'linkoriginal_text' => [
|
|
'required' => false,
|
|
'name' => tr('Read more button label'),
|
|
'description' => tr('Label of the button linking to the source page (if it is displayed)'),
|
|
'since' => '18.0',
|
|
'filter' => 'text',
|
|
'default' => '',
|
|
],
|
|
'nopage_text' => [
|
|
'required' => false,
|
|
'name' => tr('Page not found'),
|
|
'description' => tr('Text to show when the page selected to be included is not found anymore.'),
|
|
'since' => '6.0',
|
|
'filter' => 'text',
|
|
'default' => '',
|
|
],
|
|
'pagedenied_text' => [
|
|
'required' => false,
|
|
'name' => tr('Permission denied message'),
|
|
'description' => tr('Text to show when the page exists but the user has insufficient permissions to see it.'),
|
|
'since' => '6.0',
|
|
'filter' => 'text',
|
|
'default' => '',
|
|
],
|
|
'pagenotapproved_text' => [
|
|
'required' => false,
|
|
'name' => tr('No version approved error message'),
|
|
'description' => tr('Text to show when the page exists but no version is approved.'),
|
|
'since' => '18.0',
|
|
'filter' => 'text',
|
|
'default' => '',
|
|
],
|
|
'page_edit_icon' => [
|
|
'required' => false,
|
|
'name' => tr('Edit Icon'),
|
|
'description' => tr('Option to show the edit icon for the included page (shown by default). Depends on the "edit icons" settings.'),
|
|
'since' => '12.1',
|
|
'default' => '',
|
|
'filter' => 'alpha',
|
|
'options' => [
|
|
['text' => '', 'value' => ''],
|
|
['text' => tr('Yes'), 'value' => 'y'],
|
|
['text' => tr('No'), 'value' => 'n'],
|
|
],
|
|
],
|
|
'max_inclusions' => [
|
|
'required' => false,
|
|
'name' => tr('Max inclusions'),
|
|
'description' => tr('Maximum amount of times the same page can be included. Defaults to 5'),
|
|
'since' => '18.2',
|
|
'filter' => 'text',
|
|
'default' => 5,
|
|
],
|
|
'parse_included_page' => [
|
|
'required' => false,
|
|
'name' => tr('Parse Included Page'),
|
|
'description' => tr('Parse the page to be included before adding it to the parent page. This will help if html pages are included in wiki pages or vice versa, but will cause issues with the wiki table of contents.'),
|
|
'since' => '18.2',
|
|
'default' => 'n',
|
|
'filter' => 'alpha',
|
|
'options' => [
|
|
['text' => '', 'value' => ''],
|
|
['text' => tr('Yes'), 'value' => 'y'],
|
|
['text' => tr('No'), 'value' => 'n'],
|
|
],
|
|
],
|
|
'page_replace_icon' => [
|
|
'required' => false,
|
|
'name' => tr('Replace Include Icon'),
|
|
'description' => tr('Option to show the replace page icon, for the included page to be replaced by original wiki text. Depends on the "edit icons" settings.'),
|
|
'default' => '',
|
|
'filter' => 'alpha',
|
|
'options' => [
|
|
['text' => '', 'value' => ''],
|
|
['text' => tr('Yes'), 'value' => 'y'],
|
|
['text' => tr('No'), 'value' => 'n'],
|
|
],
|
|
],
|
|
'max_chars_included' => [
|
|
'required' => false,
|
|
'name' => tr('Max characters included'),
|
|
'description' => tr('Limit the length of the included text'),
|
|
'since' => '20.0',
|
|
'filter' => 'int',
|
|
'default' => '',
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
function wikiplugin_include($dataIn, $params)
|
|
{
|
|
global $killtoc, $prefs;
|
|
|
|
/** @var int[] $numberOfInclusions Associative array of the number of times each key (fragment) was included */
|
|
static $numberOfInclusions;
|
|
|
|
static $data;
|
|
$tikilib = TikiLib::lib('tiki');
|
|
|
|
$killtoc = true;
|
|
$params = array_merge([
|
|
'nopage_text' => '',
|
|
'pagedenied_text' => '',
|
|
'page_edit_icon' => $prefs['wiki_edit_plugin'],
|
|
'parse_included_page' => 'n',
|
|
'page_replace_icon' => $prefs['wiki_edit_plugin'],
|
|
'pagenotapproved_text' => tr('There are no approved versions of this page.'),
|
|
], $params);
|
|
extract($params, EXTR_SKIP);
|
|
if (! isset($page)) {
|
|
return ("<b>missing page for plugin INCLUDE</b><br />");
|
|
}
|
|
if (! isset($max_inclusions)) {
|
|
$max_inclusions = 5;
|
|
}
|
|
|
|
if (isset($replace) && (int) $replace === 1) {
|
|
$linkoriginal = 'n';
|
|
$page_edit_icon = 'n';
|
|
$page_replace_icon = 'n';
|
|
}
|
|
|
|
$returnto = ! empty($GLOBALS['page']) ? $GLOBALS['page'] : $_SERVER['REQUEST_URI'];
|
|
|
|
// This variable is for accessing included page name within plugins in that page
|
|
global $wikiplugin_included_page;
|
|
$wikiplugin_included_page = $page;
|
|
|
|
/** @var string $fragmentIdentifier Identifier of included fragment */
|
|
$fragmentIdentifier = $page;
|
|
if (isset($start)) {
|
|
$fragmentIdentifier .= "/$start";
|
|
}
|
|
if (isset($stop)) {
|
|
$fragmentIdentifier .= "/$stop";
|
|
}
|
|
|
|
if (isset($numberOfInclusions[$fragmentIdentifier])) {
|
|
if ($numberOfInclusions[$fragmentIdentifier] >= $max_inclusions) {
|
|
trigger_error('Inclusion failed', E_USER_WARNING);
|
|
return '';
|
|
}
|
|
$numberOfInclusions[$fragmentIdentifier]++;
|
|
} else {
|
|
$numberOfInclusions[$fragmentIdentifier] = 1;
|
|
// only evaluate permission the first time round
|
|
// evaluate if object or system permissions enables user to see the included page
|
|
if ($prefs['flaggedrev_approval'] != 'y') {
|
|
$data[$fragmentIdentifier] = $tikilib->get_page_info($page);
|
|
} else {
|
|
$flaggedrevisionlib = TikiLib::lib('flaggedrevision');
|
|
if ($flaggedrevisionlib->page_requires_approval($page)) {
|
|
if ($version_info = $flaggedrevisionlib->get_version_with($page, 'moderation', 'OK')) {
|
|
$data[$fragmentIdentifier] = $version_info;
|
|
} else {
|
|
$numberOfInclusions[$fragmentIdentifier] = $max_inclusions;
|
|
return($pagenotapproved_text);
|
|
}
|
|
} else {
|
|
$data[$fragmentIdentifier] = $tikilib->get_page_info($page);
|
|
}
|
|
}
|
|
if (! $data[$fragmentIdentifier]) {
|
|
$text = $nopage_text;
|
|
}
|
|
$perms = $tikilib->get_perm_object($page, 'wiki page', $data[$fragmentIdentifier], false);
|
|
if ($perms['tiki_p_view'] != 'y') {
|
|
$numberOfInclusions[$fragmentIdentifier] = $max_inclusions;
|
|
$text = $pagedenied_text;
|
|
return($text);
|
|
}
|
|
}
|
|
|
|
if (! empty($params['linkoriginal_text'])) {
|
|
$linkoriginal_text = tr($params['linkoriginal_text']);
|
|
} else {
|
|
$linkoriginal_text = tr('Read more');
|
|
}
|
|
|
|
if ($data[$fragmentIdentifier]) {
|
|
$text = $data[$fragmentIdentifier]['data'];
|
|
if (isset($start) || isset($stop)) {
|
|
$lines = explode("\n", $text);
|
|
if (isset($start) && isset($stop)) {
|
|
$state = 0;
|
|
foreach ($lines as $i => $line) {
|
|
if ($state == 0) {
|
|
// Searching for start marker, dropping lines until found
|
|
unset($lines[$i]); // Drop the line
|
|
if (0 == strcmp($start, trim($line))) {
|
|
$state = 1; // Start retaining lines and searching for stop marker
|
|
}
|
|
} else {
|
|
// Searching for stop marker, retaining lines until found
|
|
if (0 == strcmp($stop, trim($line))) {
|
|
unset($lines[$i]); // Stop marker, drop the line
|
|
$state = 0; // Go back to looking for start marker
|
|
}
|
|
}
|
|
}
|
|
} elseif (isset($start)) {
|
|
// Only start marker is set. Search for it, dropping all lines until
|
|
// it is found.
|
|
foreach ($lines as $i => $line) {
|
|
unset($lines[$i]); // Drop the line
|
|
if (0 == strcmp($start, trim($line))) {
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
// Only stop marker is set. Search for it, dropping all lines after
|
|
// it is found.
|
|
$state = 1;
|
|
foreach ($lines as $i => $line) {
|
|
if ($state == 0) {
|
|
// Dropping lines
|
|
unset($lines[$i]);
|
|
} else {
|
|
// Searching for stop marker, retaining lines until found
|
|
if (0 == strcmp($stop, trim($line))) {
|
|
unset($lines[$i]); // Stop marker, drop the line
|
|
$state = 0; // Start dropping lines
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$text = implode("\n", $lines);
|
|
}
|
|
}
|
|
|
|
if (isset($params['max_chars_included']) && mb_strlen($text) > $params['max_chars_included']) {
|
|
$text = substr($text, 0, $params['max_chars_included']) . '…';
|
|
}
|
|
|
|
$parserlib = TikiLib::lib('parser');
|
|
|
|
if ($page_replace_icon === 'y') {
|
|
$pageInfo = $tikilib->get_page_info($returnto);
|
|
$pageData = ! empty($pageInfo['data']) ? $pageInfo['data'] : '';
|
|
$permsPage = $tikilib->get_perm_object($returnto, 'wiki page', $pageData, false);
|
|
$tikiPEdit = ! empty($permsPage['tiki_p_edit']) ? $permsPage['tiki_p_edit'] : 'n';
|
|
|
|
if ($tikiPEdit === 'y') {
|
|
static $includeId = 1;
|
|
|
|
$headerlib = TikiLib::lib('header');
|
|
$headerlib->add_jsfile('lib/jquery_tiki/wikiplugin-include.js');
|
|
|
|
$smarty = TikiLib::lib('smarty');
|
|
$smarty->loadPlugin('smarty_function_ticket');
|
|
$smarty->loadPlugin('smarty_function_icon');
|
|
|
|
$tip = tr('Include Plugin') . ' | ' . tr('This section is included, click if you want to customize the content.');
|
|
|
|
$id = 'wikiplugin-include-' . $includeId;
|
|
if (
|
|
! isset($_GET['replaceby'])
|
|
|| (isset($_GET['replaceby']) && (int) $_GET['replaceby'] != $includeId)
|
|
&& (empty($_REQUEST['display']) || $_REQUEST['display'] != 'pdf')
|
|
) {
|
|
$text .= '<a id="' . $id . '" class="editplugin wikiplugin-include-replace" href="javascript:void(1)" data-index="' . $includeId . '" data-page="' . htmlentities($returnto) . '" data-ticket="' . smarty_function_ticket(['mode' => 'get'], $smarty) . '">' .
|
|
smarty_function_icon(['name' => 'exchange', 'iclass' => 'tips', 'ititle' => $tip], $smarty->getEmptyInternalTemplate()) . '</a>';
|
|
}
|
|
|
|
$includeId++;
|
|
}
|
|
}
|
|
|
|
if ($params['parse_included_page'] === 'y') {
|
|
$old_options = $parserlib->option;
|
|
$options = [
|
|
'is_html' => $data[$fragmentIdentifier]['is_html'],
|
|
'is_markdown' => TikiLib::lib('wiki')->get_page_wiki_syntax($data[$fragmentIdentifier]) === 'markdown',
|
|
'suppress_icons' => true,
|
|
];
|
|
if (! empty($_REQUEST['page'])) {
|
|
$options['page'] = $_REQUEST['page'];
|
|
}
|
|
$parserlib->setOptions($options);
|
|
$fragment = WikiParser_Parsable::instantiate($text, $options);
|
|
$text = $fragment->parse($options);
|
|
$parserlib->setOptions($old_options);
|
|
} else {
|
|
if (! empty($_REQUEST['page'])) {
|
|
$options['page'] = $_REQUEST['page'];
|
|
}
|
|
$parserlib->setOptions();
|
|
$parserlib->parse_wiki_argvariable($text);
|
|
}
|
|
|
|
global $smarty;
|
|
// append a "See full page" link at end of text if only a portion of page is being included
|
|
if (($prefs['wiki_plugin_include_link_original'] == 'y' && (isset($start) || isset($stop))) || (isset($linkoriginal) && $linkoriginal == 'y')) {
|
|
$wikilib = TikiLib::lib('wiki');
|
|
$text .= '<p><a href="' . $wikilib->sefurl($page) . '" class="btn btn-primary"';
|
|
$text .= 'title="' . sprintf(tr('The text above comes from page "%s". Click to go to that page.'), htmlspecialchars($page)) . '">';
|
|
$text .= smarty_function_icon(['name' => 'align-left'], $smarty->getEmptyInternalTemplate()) . ' ';
|
|
$text .= $linkoriginal_text;
|
|
$text .= '</a><p>';
|
|
}
|
|
|
|
// append an edit button if page_edit_icon does not equal 'n'
|
|
if ($page_edit_icon != 'n') {
|
|
if (isset($perms) && $perms['tiki_p_edit'] === 'y' && strpos($_SERVER['PHP_SELF'], 'tiki-send_newsletters.php') === false) {
|
|
$smarty = TikiLib::lib('smarty');
|
|
$smarty->loadPlugin('smarty_block_ajax_href');
|
|
$smarty->loadPlugin('smarty_function_icon');
|
|
$tip = tr('Include Plugin') . ' | ' . tr('Edit the included page:') . ' "' . $page . '"';
|
|
if (empty($_REQUEST['display']) || $_REQUEST['display'] != 'pdf') {
|
|
$text .= '<a class="editplugin" ' . // ironically smarty_block_self_link doesn't work for this! ;)
|
|
smarty_block_ajax_href(['template' => 'tiki-editpage.tpl'], 'tiki-editpage.php?page=' . urlencode($page) . '&returnto=' . urlencode($returnto), $smarty, $tmp = false) . '>' .
|
|
smarty_function_icon(['name' => 'edit', 'iclass' => 'tips', 'ititle' => $tip], $smarty->getEmptyInternalTemplate()) . '</a>';
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($params['parse_included_page'] === 'y') {
|
|
return "~np~$text~/np~";
|
|
} else {
|
|
return $text;
|
|
}
|
|
}
|