<?php

/*

* Textpattern Content Management System

* https://textpattern.com/

*

* Copyright (C) 2026 The Textpattern Development Team

*

* This file is part of Textpattern.

*

* Textpattern 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, version 2.

*

* Textpattern 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 Textpattern. If not, see <https://www.gnu.org/licenses/>.

*/

/**

* Tag builder.

*

* @package Admin\Tag

*/

namespace Textpattern\Tag;

if (!defined('TXPINTERFACE')) {

die('TXPINTERFACE is undefined.');

}

$tagName = gps('tag_name');

$panel = gps('panel');

if ($tagName) {

echo \Txp::get('\Textpattern\Tag\BuilderTags')->renderTagHelp($tagName, $panel);

} elseif ($panel) {

echo \Txp::get('\Textpattern\Tag\BuilderTags')->tagbuildDialog($panel);

}

/**

* Collection of tag builder functions.

*

* @package Admin\Tag

*/

class BuilderTags

{

/**

* HTML block for the header portion of the form tag.

*

* @var string

*/

private $startblock;

/**

* HTML block for the end of the form tag.

*

* Includes submit button and hidden form elements.

*

* @var string

*/

private $endform;

/**

* The name of the tagbuilder tag that is currently being displayed.

*

* @var string

*/

private $tagname;

/**

* Return a list of tag builder tags for the given event.

*

* @param $ev The event (type of dialog) to build: page, form

* @return HTML

*/

public function tagbuildDialog($ev)

{

$listActions = graf(

tag('<span class="ui-icon ui-icon-arrowthickstop-1-s"></span> ' . gTxt('expand_all'), 'button', array(

'class' => 'txp-expand-all txp-reduced-ui-button',

'aria-controls' => 'tagbuild_links',

)) .

tag('<span class="ui-icon ui-icon-arrowthickstop-1-n"></span> ' . gTxt('collapse_all'), 'button', array(

'class' => 'txp-collapse-all txp-reduced-ui-button',

'aria-controls' => 'tagbuild_links',

)), array('class' => 'txp-actions')

);

$tagbuild_items = array();

// Generate the tagbuilder links.

// Format of each entry is popTagLink -> array ( gTxt string, class/ID ).

switch ($ev) {

case "form":

$tagbuild_items = array(

'article' => array('articles', 'article-tags'),

'link' => array('links', 'link-tags'),

'comment' => array('comments', 'comment-tags'),

'comment_details' => array('comment_details', 'comment-detail-tags'),

'comment_form' => array('comment_form', 'comment-form-tags'),

'search_result' => array('search_results_form', 'search-result-tags'),

'file_download' => array('file_download_tags', 'file-tags'),

'category' => array('category_tags', 'category-tags'),

'section' => array('section_tags', 'section-tags'),

);

break;

case "page":

$tagbuild_items = array(

'page_article' => array('page_article_hed', 'article-tags'),

'page_article_nav' => array('page_article_nav_hed', 'article-nav-tags'),

'page_nav' => array('page_nav_hed', 'nav-tags'),

'page_xml' => array('page_xml_hed', 'xml-tags'),

'page_misc' => array('page_misc_hed', 'misc-tags'),

'page_file' => array('page_file_hed', 'file-tags'),

);

break;

}

$tagbuild_links = '';

foreach ($tagbuild_items as $tb => $item) {

$tagbuild_links .= wrapRegion($item[1] . '_group', $this->popTagLinks($tb, $ev), $item[1], $item[0], $item[1]);

}

// Tag builder dialog.

if ($tagbuild_links) {

return $listActions . $tagbuild_links;

}

return false;

}

/**

* List of tags in their corresponding groups.

*

* @see popTagLinks()

* @return array

*/

protected function tagbuildGroups()

{

return array(

'article_tags' => array(

'permlink',

'posted',

'title',

'body',

'excerpt',

'section',

'category1',

'category2',

'article_image',

'comments_invite',

'author',

),

'link_tags' => array(

'link',

'linkdesctitle',

'link_name',

'link_description',

'link_category',

'link_date',

),

'comment_tags' => array(

'comments',

'comments_form',

'comments_preview',

),

'comment_details_tags' => array(

'comment_permlink',

'comment_name',

'comment_email',

'comment_web',

'comment_time',

'comment_message',

),

'comment_form_tags' => array(

'comment_name_input',

'comment_email_input',

'comment_web_input',

'comment_message_input',

'comment_remember',

'comment_preview',

'comment_submit',

),

'search_result_tags' => array(

'search_result_title',

'search_result_excerpt',

'search_result_date',

'search_result_url',

),

'file_download_tags' => array(

'file_download_link',

'file_download_name',

'file_download_description',

'file_download_category',

'file_download_created',

'file_download_modified',

'file_download_size',

'file_download_downloads',

),

'category_tags' => array(

'category',

'if_category',

),

'section_tags' => array(

'section',

'if_section',

),

'page_article_tags' => array(

'article',

'article_custom',

),

'page_article_nav_tags' => array(

'prev_title',

'next_title',

'link_to_prev',

'link_to_next',

'older',

'newer',

),

'page_nav_tags' => array(

'link_to_home',

'section_list',

'category_list',

'popup',

'recent_articles',

'recent_comments',

'related_articles',

'search_input',

),

'page_xml_tags' => array(

'feed_link',

'link_feed_link',

),

'page_misc_tags' => array(

'page_title',

'css',

'site_name',

'site_slogan',

'breadcrumb',

'search_input',

'email',

'linklist',

'password_protect',

'output_form',

'lang',

),

'page_file_tags' => array(

'file_download_list',

'file_download',

'file_download_link',

),

);

}

/**

* Return a list of tag builder links.

*

* @param string $type Tag type

* @param string $panel The panel (event) on which the builder is displayed

* @return string HTML

*/

protected function popTagLinks($type, $panel)

{

$tagGroups = $this->tagbuildGroups();

$arname = $type . '_tags';

$out = array();

if (isset($tagGroups[$arname])) {

foreach ($tagGroups[$arname] as $a) {

$out[] = tag(popTag($a, gTxt('tag_' . $a), array('panel' => $panel)), 'li');

}

}

return n . tag(n . join(n, $out) . n, 'ul', array('class' => 'plain-list'));

}

/**

* Return a single tag handler instance.

*

* @param string $name The tag

* @param string $panel The panel from which the tag was invoked

* @return string|bool HTML or FALSE on error

*/

public function renderTagHelp($name, $panel)

{

$this->tagname = (string)$name;

$method = 'tag_' . $this->tagname;

if (method_exists($this, $method)) {

$backLink = '';

if ($panel) {

$backLink = graf(

href(

gTxt('go_back'),

array('event' => 'tag', 'panel' => $panel),

array('class' => 'txp-tagbuilder-link')

),

array('class' => 'txp-actions')

);

}

$this->startblock = $backLink .

hed(gTxt('tag_' . $this->tagname), 2) .

href(

gTxt('documentation') . sp . span(gTxt('opens_external_link'), array('class' => 'ui-icon ui-icon-extlink')),

'https://docs.textpattern.com/tags/' . $this->tagname,

array(

'class' => 'txp-tagbuilder-docs-link',

'rel' => 'external',

'target' => '_blank',

)

);

$this->endform = graf(

span(fInput('submit', '', gTxt('build')), array('class' => 'txp-save-button'))

) .

eInput('tag') .

sInput('build') .

hInput('tag_name', $this->tagname) .

hInput('panel', $panel);

return $this->$method($this->tagname);

}

return false;

}

/**

* Render a form tag with the given content.

*

* @param string $content The HTML form contents

* @return string HTML

*/

private function tagbuildForm($content)

{

return form($content, '', '', 'post', 'asynchtml txp-tagbuilder', 'txp-tagbuilder-output');

}

/**

* Render an input widget.

*

* @param string $label The label reference to use (will be subject to l10n)

* @param string $thing Content

* @return string HTML

*/

private function widget($label, $thing)

{

// TODO: Link to attribute help?

return inputLabel(

$label,

$thing,

$label

);

}

/**

* Render a set of input widgets.

*

* @param array $widgets List of label => content pairs

* @return string HTML

*/

private function widgets($widgets = array())

{

$out = '';

// Common global attributes

/*

$widgets += array(

'escape' => $this->tbInput('escape', gps('escape'), INPUT_REGULAR),

'wraptag' => $this->tbInput('wraptag', gps('wraptag')),

'class' => $this->tbInput('class', gps('class'), INPUT_REGULAR),

'html_id' => $this->tbInput('html_id', gps('html_id'), INPUT_REGULAR),

'label' => $this->tbInput('label', gps('label')),

'labeltag' => $this->tbInput('labeltag', gps('labeltag'))

);

*/

// TODO: Link to attribute help?

foreach ($widgets as $label => $thing) {

$out .= $this->widget($label, $thing);

}

return $out;

}

/**

* Generate a parameter-less Textpattern tag.

*

* @return string &lt;txp:tag /&gt;

*/

private function tbNoAtts()

{

return $this->tagbuildForm($this->startblock . $this->widgets() . $this->endform) . $this->tdb($this->tb($this->tagname));

}

/**

* Generate a Textpattern tag from the given attributes and content.

*

* @param string $tag Tag name

* @param string $atts_list List of attribute => value pairs

* @param string $thing Tag container content

* @return string &lt;txp:tag ...&gt;

*/

private function tb($tag, $atts_list = array(), $thing = '')

{

$atts = array();

// Common global attributes

/*

$atts_list += gpsa(array('escape', 'wraptag', 'class', 'html_id', 'label', 'labeltag'));

*/

foreach ($atts_list as $att => $val) {

if ($val or $val === '0' or $val === '{att_empty}') {

$val = str_replace('{att_empty}', '', $val);

$atts[] = ' ' . $att . '="' . $val . '"';

}

}

$atts = ($atts) ? join('', $atts) : '';

return !empty($thing) ?

'<txp:' . $tag . $atts . '>' . $thing . '</txp:' . $tag . '>' :

'<txp:' . $tag . $atts . ' />';

}

/**

* Render a textarea to hold the built content.

*

* @param string $thing Content

* @return string HTML

*/

private function tdb($thing)

{

return graf('<label for="txp-tagbuilder-output">' . gTxt('code') . '</label>' . n . text_area(

'txp-tagbuilder-output',

'',

'',

$thing,

'txp-tagbuilder-output',

TEXTAREA_HEIGHT_SMALL,

INPUT_LARGE

));

}

/**

* Assemble the tag output container.

*

* @param array $atts Attribute key => value pairs

* @param string $thing Tag container content

* @return string HTML

*/

private function build($atts, $thing = '')

{

global $step;

$out = '';

if ($step === 'build') {

$out = $this->tdb($this->tb($this->tagname, $atts, $thing));

}

return $out;

}

/**

* Render a HTML &lt;select&gt; list of time ranges.

*

* @param string $time Currently selected value

* @return string HTML

*/

private function tbTimePop($time)

{

$vals = array(

'past' => gTxt('time_past'),

'future' => gTxt('time_future'),

'any' => gTxt('any'),

);

return ' ' . selectInput('time', $vals, $time, true, '', 'time');

}

/**

* Render HTML boolean &lt;select&gt; options.

*

* @param string $name Input name/ID

* @param string $value Currently selected value

* @return string HTML

*/

private function tbYesNoPop($select_name, $value)

{

$vals = array(

1 => gTxt('yes'),

0 => gTxt('no'),

);

if (is_numeric($value)) {

$value = (int)$value;

}

return ' ' . selectInput($select_name, $vals, $value, true, '', $select_name, true);

}

/**

* Render a HTML &lt;select&gt; list of article status options.

*

* @param string $value Currently selected value

* @param string $type The flavor of status to return. article=full set, file=limited set

* @return string HTML

*/

private function tbStatusPop($value, $type = 'article')

{

$vals = array(

STATUS_LIVE => gTxt('live'),

STATUS_STICKY => gTxt('sticky'),

STATUS_PENDING => gTxt('pending'),

STATUS_DRAFT => gTxt('draft'),

STATUS_HIDDEN => gTxt('hidden'),

);

if ($type !== 'article') {

unset($vals[STATUS_DRAFT], $vals[STATUS_STICKY]);

}

return ' ' . selectInput('status', $vals, $value, true, '', 'status');

}

/**

* Render a HTML &lt;select&gt; list of sort options.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbSortPop($value)

{

$asc = ' (' . gTxt('ascending') . ')';

$desc = ' (' . gTxt('descending') . ')';

$vals = array(

'Title asc' => gTxt('title') . $asc,

'Title desc' => gTxt('title') . $desc,

'Posted asc' => gTxt('posted') . $asc,

'Posted desc' => gTxt('posted') . $desc,

'LastMod asc' => gTxt('last_modification') . $asc,

'LastMod desc' => gTxt('last_modification') . $desc,

'Section asc' => gTxt('section') . $asc,

'Section desc' => gTxt('section') . $desc,

'Category1 asc' => gTxt('category1') . $asc,

'Category1 desc' => gTxt('category1') . $desc,

'Category2 asc' => gTxt('category2') . $asc,

'Category2 desc' => gTxt('category2') . $desc,

'rand()' => gTxt('random'),

);

return ' ' . selectInput('sort', $vals, $value, true, '', 'sort');

}

/**

* Render a HTML &lt;select&gt; list of comment sort options.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbDiscussSortPop($value)

{

$asc = ' (' . gTxt('ascending') . ')';

$desc = ' (' . gTxt('descending') . ')';

$vals = array(

'posted asc' => gTxt('posted') . $asc,

'posted desc' => gTxt('posted') . $desc,

);

return ' ' . selectInput('sort', $vals, $value, true, '', 'sort');

}

/**

* Render a HTML &lt;select&gt; list of article sort options.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbListSortPop($value)

{

$asc = ' (' . gTxt('ascending') . ')';

$desc = ' (' . gTxt('descending') . ')';

$vals = array(

'title asc' => gTxt('title') . $asc,

'title desc' => gTxt('title') . $desc,

'name asc' => gTxt('name') . $asc,

'name desc' => gTxt('name') . $desc,

);

return ' ' . selectInput('sort', $vals, $value, true, '', 'sort');

}

/**

* Render a HTML &lt;select&gt; list of authors/users.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbAuthorPop($value)

{

$vals = array();

$rs = safe_rows_start("name", 'txp_users', "1 = 1 ORDER BY name");

if ($rs) {

while ($a = nextRow($rs)) {

extract($a);

$vals[$name] = $name;

}

return ' ' . selectInput('author', $vals, $value, true, '', 'author');

}

}

/**

* Render a HTML &lt;select&gt; list of Sections.

*

* @param string $select_name Input name/ID

* @param string $value Currently selected value

* @return string HTML

*/

private function tbSectionPop($select_name, $value)

{

$vals = array();

$rs = safe_rows_start("name, title", 'txp_section', "name != 'default' ORDER BY name");

if ($rs && numRows($rs) > 0) {

while ($a = nextRow($rs)) {

extract($a);

$vals[$name] = $title;

}

return ' ' . selectInput($select_name, $vals, $value, true, '', $select_name);

}

return gTxt('no_sections_available');

}

/**

* Render a HTML &lt;select&gt; list of Categories.

*

* @param string $value Currently selected value

* @param string $type Context to which the category applies

* @return string HTML

*/

private function tbCategoryPop($value, $type = 'article')

{

$vals = getTree('root', $type);

if ($vals) {

return ' ' . treeSelectInput('category', $vals, $value, 'category');

}

return gTxt('no_categories_available');

}

/**

* Render a HTML &lt;select&gt; list of category match options.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbMatchCatPop($value)

{

$vals = array(

'Category' => gTxt('category1') . ' ' . gTxt('or') . ' ' . gTxt('category2'),

'Category1,Category2' => gTxt('category1') . ' ' . gTxt('and') . ' ' . gTxt('category2'),

'Category1' => gTxt('category1'),

'Category2' => gTxt('category2'),

);

return ' ' . selectInput('match', $vals, $value, true, '', 'match');

}

/**

* Render a HTML &lt;select&gt; list of pattern match types.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbPatternPop($value)

{

$vals = array(

'exact' => gTxt('exact'),

'any' => gTxt('any'),

'all' => gTxt('all'),

);

return ' ' . selectInput('match', $vals, $value, false, '', 'match');

}

/**

* Render a HTML &lt;select&gt; list of context types.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbTypePop($value)

{

$vals = array(

'article' => gTxt('article'),

'image' => gTxt('image'),

'file' => gTxt('file'),

'link' => gTxt('link'),

);

return ' ' . selectInput('type', $vals, $value, true, '', 'type');

}

/**

* Render a HTML &lt;select&gt; list of Themes.

*

* @param string $value Currently selected value

* @return string | bool HTML | false on error

*/

private function tbThemePop($value)

{

$vals = array();

$rs = safe_rows_start("name, title", 'txp_skin', "1 = 1 ORDER BY name, title");

if ($rs) {

while ($a = nextRow($rs)) {

extract($a);

$vals[$name] = $title;

}

return ' ' . selectInput('theme', $vals, $value, true, '', 'theme');

}

return false;

}

/**

* Render a HTML &lt;select&gt; list of forms.

*

* @param string $select_name Input name/ID

* @param string $type Form type

* @param string $value Currently selected value

* @return string HTML

*/

private function tbFormPop($select_name, $type = '', $value = '')

{

$vals = array();

$type = ($type) ? "type = '" . doSlash($type) . "'" : "1 = 1";

$rs = safe_rows_start("name", 'txp_form', "$type ORDER BY name");

if ($rs and numRows($rs) > 0) {

while ($a = nextRow($rs)) {

extract($a);

$vals[$name] = $name;

}

return ' ' . selectInput($select_name, $vals, $value, true, '', $select_name);

}

return gTxt('no_forms_available');

}

/**

* Render a HTML &lt;select&gt; list of Stylesheets.

*

* @param string $value Currently selected value

* @return string | bool HTML | false on error

*/

private function tbCssPop($value)

{

$vals = array();

$rs = safe_rows_start("name", 'txp_css', "1 = 1 ORDER BY name");

if ($rs) {

while ($a = nextRow($rs)) {

extract($a);

$vals[$name] = $name;

}

return ' ' . selectInput('name', $vals, $value, true, '', 'name');

}

return false;

}

/**

* Render a HTML &lt;select&gt; list of CSS formats.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbCssFormatPop($value)

{

$vals = array(

'link' => '<link rel...',

'url' => 'css.php?...',

);

return ' ' . selectInput('format', $vals, $value, true, '', 'format');

}

/**

* Render a HTML &lt;select&gt; list of escape options.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbEscapePop($value)

{

$vals = array(

'{att_empty}' => '',

'html' => 'HTML',

);

return ' ' . selectInput('escape', $vals, $value, false, '', 'escape');

}

/**

* Render a HTML &lt;select&gt; list of feed flavours.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbFeedFlavorPop($value)

{

$vals = array(

'atom' => 'Atom 1.0',

'rss' => 'RSS 2.0',

);

return ' ' . selectInput('flavor', $vals, $value, true, '', 'flavor');

}

/**

* Render a HTML &lt;select&gt; list of feed formats.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbFeedFormatPop($value)

{

$vals = array(

'a' => '<a href...',

'link' => '<link rel...',

);

return ' ' . selectInput('format', $vals, $value, true, '', 'format');

}

/**

* Render a HTML &lt;select&gt; list of author formats.

*

* @param string $value Currently selected value

* @return string HTML

*/

private function tbAuthorFormatPop($value)

{

$vals = array(

'link' => '<a href...',

'url' => gTxt('url'),

);

return ' ' . selectInput('format', $vals, $value, true, '', 'format');

}

/**

* Render a HTML &lt;input&gt; tag.

*

* @param string $name Input name

* @param string $value Input value

* @param string $size Input size in characters

* @param string $id Input HTML ID. Uses $name if omitted

* @return string HTML

*/

private function tbInput($name, $value, $size = INPUT_SMALL, $id = null)

{

return fInput('text', $name, $value, '', '', '', $size, '', (($id === null) ? $name : $id));

}

/**

* Tag builder &lt;txp:article&gt; tag.

*/

function tag_article()

{

$atts = gpsa(array(

'allowoverride',

'break',

'class',

'form',

'frontpage',

'keywords',

'label',

'labeltag',

'limit',

'listform',

'offset',

'pageby',

'pgonly',

'searchall',

'searchform',

'searchsticky',

'sort',

'status',

'time',

'wraptag',

));

extract($atts);

$out = $this->tagbuildForm(

$this->startblock .

$this->widgets(array(

'status' => $this->tbStatusPop($status),

'time' => $this->tbTimePop($time),

'searchall' => $this->tbYesNoPop('searchall', $searchall),

'searchsticky' => $this->tbYesNoPop('searchsticky', $searchsticky),

'on_front_page' => $this->tbYesNoPop('frontpage', $frontpage),

'keywords' => '<textarea name="keywords" id="keywords">' . txpspecialchars($keywords) . '</textarea>',

'limit' => $this->tbInput('limit', $limit, INPUT_TINY),

'offset' => $this->tbInput('offset', $offset, INPUT_TINY),

'pageby' => $this->tbInput('pageby', $pageby, INPUT_TINY),

'sort' => $this->tbSortPop($sort),

'pgonly' => $this->tbYesNoPop('pgonly', $pgonly),

'allowoverride' => $this->tbYesNoPop('allowoverride', $allowoverride),

'label' => $this->tbInput('label', $label),

'labeltag' => $this->tbInput('labeltag', $labeltag),

'wraptag' => $this->tbInput('wraptag', $wraptag),

'class' => $this->tbInput('class', $class, INPUT_REGULAR),

'break' => $this->tbInput('break', $break),

'form' => $this->tbFormPop('form', 'article', $form),

'listform' => $this->tbFormPop('listform', 'article', $listform),

'searchform' => $this->tbFormPop('searchform', 'article', $searchform),

)) .

$this->endform

) .

$this->build($atts);

return $out;

}

/**

* Tag builder &lt;txp:article_custom&gt; tag.

*/