Show/Hide some shortcodes contextually

classes/controllers/FrmFormsController.php

@@ -1654,19 +1654,14 @@ private static function get_shortcode_helpers( $settings_tab ) {
 			''           => '',
 			'siteurl'    => __( 'Site URL', 'formidable' ),
 			'sitename'   => __( 'Site Name', 'formidable' ),
+			'form_name'  => __( 'Form Name', 'formidable' ),
 		);
 
+		$entry_shortcodes = array_merge( FrmShortcodeHelper::get_contextual_shortcode_values(), $entry_shortcodes );
 		if ( ! FrmAppHelper::pro_is_installed() ) {
 			unset( $entry_shortcodes['post_id'] );
 		}
 
-		if ( $settings_tab ) {
-			$entry_shortcodes['default-message'] = __( 'Default Msg', 'formidable' );
-			$entry_shortcodes['default-html']    = __( 'Default HTML', 'formidable' );
-			$entry_shortcodes['default-plain']   = __( 'Default Plain', 'formidable' );
-			$entry_shortcodes['form_name']       = __( 'Form Name', 'formidable' );
-		}
-
 		/**
 		 * Use this hook to add or remove buttons in the helpers section
 		 * in the customization panel

classes/helpers/FrmFieldsHelper.php

@@ -913,6 +913,7 @@ public static function allowed_shortcodes( $fields = array() ) {
 			'updated[-|_]at',
 			'updated[-|_]by',
 			'parent[-|_]id',
+			'form_name',
 		);
 
 		foreach ( $fields as $field ) {

classes/helpers/FrmShortcodeHelper.php

@@ -30,6 +30,55 @@ public static function get_shortcode_attribute_array( $text ) {
 		return $atts;
 	}
 
+	/**
+	 * Returns shortcodes that are shown/hidden based on the context.
+	 *
+	 * @since x.x
+	 * @return array
+	 */
+	public static function get_contextual_shortcodes() {
+		return array(
+			'address' => array(
+				'admin_email'        => __( 'Admin email', 'formidable' ),
+				'default-from-email' => __( 'Default from email', 'formidable' ),
+				'default-email'      => __( 'Default email', 'formidable' ),
+			),
+			'body'    => array(
+				'default-message' => __( 'Default Msg', 'formidable' ),
+				'default-html'    => __( 'Default HTML', 'formidable' ),
+				'default-plain'   => __( 'Default Plain', 'formidable' ),
+			),
+		);
+	}
+
+	/**
+	 * Get contextual shortcodes.
+	 *
+	 * @since x.x
+	 *
+	 * @return array
+	 */
+	public static function get_contextual_shortcode_values() {
+		$contextual_shortcodes = self::get_contextual_shortcodes();
+		return array_merge( $contextual_shortcodes['address'], $contextual_shortcodes['body'] );
+	}
+
+	/**
+	 * Get flattened format of contextual shortcodes.
+	 *
+	 * @since x.x
+	 *
+	 * @return array
+	 */
+	public static function get_contextual_codes() {
+		$contextual_shortcodes = self::get_contextual_shortcodes();
+		$result                = array();
+		foreach ( $contextual_shortcodes as $type => $shortcodes ) {
+			$result[ $type ] = array_keys( $shortcodes );
+		}
+		return $result;
+	}
+
 	/**
 	 * Get the name of the shortcode from the regEx
 	 *

classes/views/frm-forms/mb_insert_fields.php

@@ -2,8 +2,9 @@
 if ( ! defined( 'ABSPATH' ) ) {
 	die( 'You are not allowed to call this page directly.' );
 }
+$data_attrs = array( 'data-contextual-shortcodes' => FrmAppHelper::maybe_json_encode( FrmShortcodeHelper::get_contextual_codes() ) );
 ?>
-<div id="frm_adv_info" class="postbox frm-dropdown-menu">
+<div id="frm_adv_info" class="postbox frm-dropdown-menu" <?php FrmAppHelper::array_to_html_params( $data_attrs, true ); ?>>
 	<div class="inside">
 		<?php FrmFormsController::mb_tags_box( $id ); ?>
 	</div>

classes/views/shared/mb_adv_info.php

@@ -200,6 +200,7 @@
 		</div>
 		<ul class="frm_code_list frm-full-hover">
 		<?php
+		$contextual_codes = FrmShortcodeHelper::get_contextual_codes();
 		foreach ( $entry_shortcodes as $skey => $sname ) {
 			if ( ! $skey ) {
 				echo '<li class="clear frm_block"></li>';
@@ -210,6 +211,10 @@
 			$classes .= in_array( $skey, array( 'siteurl', 'sitename', 'entry_count' ), true ) ? ' show_before_content show_after_content' : '';
 			$classes .= strpos( $skey, 'default-' ) === 0 ? ' hide_frm_not_email_subject' : '';
 
+			if ( in_array( $skey, array_keys( $contextual_codes ), true ) ) {
+				$classes .= ' frm_hidden';
+			}
+
 			FrmFormsHelper::insert_code_html(
 				array(
 					'code'  => $skey,
@@ -219,7 +224,7 @@
 			);
 
 			unset( $skey, $sname, $classes );
-		}
+		}//end foreach
 
 		foreach ( $advanced_helpers as $helper_type => $helper ) {
 			if ( 'user_id' === $helper_type && ! isset( $uid ) ) {

js/formidable_admin.js

@@ -241,6 +241,7 @@ function frmAdminBuildJS() {
 	const { tag, div, span, a, svg, img } = frmDom;
 	const { onClickPreventDefault } = frmDom.util;
 	const { doJsonFetch, doJsonPost } = frmDom.ajax;
+	frmAdminJs.contextualShortcodes = getContextualShortcodes();
 	const icons = {
 		save: svg({ href: '#frm_save_icon' }),
 		drag: svg({ href: '#frm_drag_icon', classList: [ 'frm_drag_icon', 'frm-drag' ] })
@@ -8446,9 +8447,104 @@ function frmAdminBuildJS() {
 					jQuery( tinymce.get( input.id ) ).trigger( 'focus' );
 				}
 			}
+			showOrHideContextualShortcodes( input );
 		}
 	}
 
+	/**
+	 * Returns true if a shortcode could be shown in the search result.
+	 *
+	 * @since x.x
+	 *
+	 * @param {HTMLElement} item
+	 * @returns {Boolean}
+	 */
+	function checkContextualShortcode( item ) {
+		if ( frmAdminJs.contextualShortcodes.length === 0 ) {
+			return true;
+		}
+		return ! isContextualShortcode( item ) || canShowContextualShortcode( item );
+	}
+
+	/**
+	 * Returns true if a shortcode is contextual to fields.
+	 *
+	 * @since x.x
+	 *
+	 * @param {HTMLElement} item
+	 * @returns {Boolean}
+	 */
+	function isContextualShortcode( item ) {
+		const shortcode = item.querySelector( 'a' ).dataset.code;
+		return frmAdminJs.contextualShortcodes.address.includes( shortcode ) || frmAdminJs.contextualShortcodes.body.includes( shortcode );
+	}
+
+	/**
+	 * @since x.x
+	 *
+	 * @param {HTMLElement} item
+	 * @returns {Boolean}
+	 */
+	function canShowContextualShortcode( item ) {
+		const shortcode = item.querySelector( 'a' ).dataset.code;
+		const inputId = document.getElementById( 'frm_adv_info' ).dataset.fills;
+		const input   = document.getElementById( inputId );
+		const contextualShortcodes = frmAdminJs.contextualShortcodes;
+		if ( contextualShortcodes.address.includes( shortcode ) ) {
+			return input.matches( contextualShortcodes.addressSelector );
+		}
+		return input.matches( contextualShortcodes.bodySelector );
+	}
+
+	/**
+	 * @since x.x
+	 *
+	 * @param {HTMLElement} input
+	 * @returns {Void}
+	 */
+	function showOrHideContextualShortcodes( input ) {
+		[ 'address', 'body' ].forEach( type => {
+			toggleContextualShortcodes( input, type );
+		});
+	}
+
+	/**
+	 * @since x.x
+	 *
+	 * @param {HTMLElement} input
+	 * @param {string}      type
+	 *
+	 * @returns {Void}
+	 */
+	function toggleContextualShortcodes( input, type ) {
+		let selector, contextualShortcodes;
+		selector             = frmAdminJs.contextualShortcodes[ type + 'Selector' ];
+		contextualShortcodes = frmAdminJs.contextualShortcodes[ type ];
+		let shouldShowShortcodes = input.matches( selector );
+		for ( let shortcode of contextualShortcodes ) {
+			const shortcodeLi = document.querySelector( '#frm-adv-info-tab .frm_code_list [data-code="' + shortcode + '"]' )?.closest( 'li');
+			shortcodeLi?.classList.toggle( 'frm_hidden', ! shouldShowShortcodes );
+		}
+	}
+
+	/**
+	 * Returns shortcodes that are contextual to the current input field.
+	 *
+	 * @since x.x
+	 *
+	 * @returns {Array}
+	 */
+	function getContextualShortcodes() {
+		let contextualShortcodes = document.getElementById( 'frm_adv_info' )?.dataset.contextualShortcodes;
+		if ( ! contextualShortcodes) {
+			return [];
+		}
+		contextualShortcodes = JSON.parse( contextualShortcodes );
+		contextualShortcodes.addressSelector = '[id^=email_to], [id^=from_], [id^=cc], [id^=bcc]';
+		contextualShortcodes.bodySelector    = '[id^=email_message_]';
+		return contextualShortcodes;
+	}
+
 	function fieldUpdated() {
 		if ( ! fieldsUpdated ) {
 			fieldsUpdated = 1;
@@ -9454,12 +9550,12 @@ function frmAdminBuildJS() {
 
 			const itemCanBeShown = ! ( getExportOption() === 'xml' && items[i].classList.contains( 'frm-is-repeater' ) );
 			if ( searchText === '' ) {
-				if ( itemCanBeShown ) {
+				if ( itemCanBeShown && checkContextualShortcode( items[i] ) ) {
 					items[i].classList.remove( 'frm_hidden' );
 				}
 				items[i].classList.remove( 'frm-search-result' );
 			} else if ( ( regEx && new RegExp( searchText ).test( innerText ) ) || innerText.indexOf( searchText ) >= 0 || textMatchesPlural( innerText, searchText ) ) {
-				if ( itemCanBeShown ) {
+				if ( itemCanBeShown && checkContextualShortcode( items[i] ) ) {
 					items[i].classList.remove( 'frm_hidden' );
 				}
 				items[i].classList.add( 'frm-search-result' );