← All changes | includes/Frontend/Form/FrontendFormHandler.php +186 -22 3.2.1 → 3.3.1 View file →

		@@ -15,8 +15,9 @@
15	15	use BitCode\BitForm\Core\Integration\IntegrationHandler;
16	16	use BitCode\BitForm\Core\Util\EscapingHelper;
17	17	use BitCode\BitForm\Core\Util\FieldValueHandler;
18	18	use BitCode\BitForm\Core\Util\FileDownloadProvider;
	19	+use BitCode\BitForm\Core\Util\FileHandler;
19	20	use BitCode\BitForm\Core\Util\FrontendHelpers;
20	21	use BitCode\BitForm\Core\Util\Log;
21	22	use BitCode\BitForm\Core\Util\SmartTagRegistry;
22	23	use BitCode\BitForm\Core\Util\SmartTags;
		@@ -24,8 +25,11 @@
24	25	use BitCode\BitForm\Core\WorkFlow\WorkFlow;
25	26
26	27	final class FrontendFormHandler
27	28	{
	29	+ /** Largest stored signature inlined into the page as a data URI. */
	30	+ private const MAX_INLINE_SIGNATURE_BYTES = 2097152;
	31	+
28	32	public function __construct()
29	33	{
30	34	// before markup load - formids [], posts [1,2]
31	35	add_action('wp_enqueue_scripts', [$this, 'loadAssets']);
		@@ -31,9 +35,11 @@
31	35	add_action('wp_enqueue_scripts', [$this, 'loadAssets']);
32	36	// markup loads - formids []
33	37	add_shortcode('bitform', [$this, 'handleFrontendRenderRequest']);
34	38	// after markup load - formids [1,35,3]
35		- add_action('wp_footer', [$this, 'generateJS']);
	39	+ // After popup plugins render at 10 (that is when popup-only forms register
	40	+ // their formID), before wp_print_footer_scripts at 20.
	41	+ add_action('wp_footer', [$this, 'generateJS'], 15);
36	42	}
37	43
38	44	private function validPassowordResetToken($token, $userID, $formId)
39	45	{
		@@ -62,10 +68,43 @@
62	68
63	69	return $formScriptSrc;
64	70	}
65	71
	72	+ private function getJSFilePath($postId)
	73	+ {
	74	+ return BITFORMS_CONTENT_DIR . "/form-scripts/$postId/bitform-js-$postId.js";
	75	+ }
	76	+
	77	+ /**
	78	+ * Does this page's bundle need (re)generating?
	79	+ *
	80	+ * The DB flag alone is not enough: a page marked generated whose file was never written
	81	+ * (crashed generation, unwritable uploads dir) would enqueue a 404 forever. Conversely a
	82	+ * file that cannot be written must not make every request rebuild it, so a missing file
	83	+ * is retried on a backoff window rather than on every hit.
	84	+ *
	85	+ * @param int $postId
	86	+ * @param bool $regenerateScriptFlag DB-side verdict from regenerateScriptChecker()
	87	+ *
	88	+ * @return bool
	89	+ */
	90	+ private function needsScriptGeneration($postId, $regenerateScriptFlag)
	91	+ {
	92	+ if (file_exists($this->getJSFilePath($postId))) {
	93	+ return (bool) $regenerateScriptFlag;
	94	+ }
	95	+ $retryKey = 'bitforms_js_regen_' . $postId;
	96	+ if (get_transient($retryKey)) {
	97	+ return false;
	98	+ }
	99	+ set_transient($retryKey, 1, 5 * MINUTE_IN_SECONDS);
	100	+ return true;
	101	+ }
	102	+
66	103	public function generateJs($formID = null, $entryID = null, $formType = null)
67	104	{
	105	+ // bitform-js-{postId}.js is disk-cached per post ID with no language key.
	106	+ // Display strings must stay out of it and travel in bf_globals per request.
68	107	// return true;
69	108	$isFormPreview = get_transient('bitform_form_preview');
70	109	if ($isFormPreview && !$formID) {
71	110	delete_transient('bitform_form_preview');
		@@ -125,8 +164,10 @@
125	164	if (!$regenerateScriptFlag) {
126	165	$regenerateScriptFlag = $this->deleteUnusedFormPageIds($postId, $bfUniqFormIds);
127	166	}
128	167	$isJsGenerating = get_option('bitforms_frontend_js_generating');
	168	+ // The fast path also requires the cached bundle to exist on disk, not just be flagged in the DB.
	169	+ $regenerateScriptFlag = $this->needsScriptGeneration($postId, $regenerateScriptFlag);
129	170	if (!$regenerateScriptFlag && !$isJsGenerating && !empty($formIDs)) {
130	171	wp_enqueue_script('bit-form-all-script-test', $this->getJSFileSrc($postId), [], $formUpdateVersion, true);
131	172	return;
132	173	}
		@@ -159,8 +200,13 @@
159	200	$frontendScriptGenObj->generateJsFile($formContents, $allFields, $contentIds, $postId, $formIDs, $previewMode);
160	201	if ('preview' === $previewMode) {
161	202	return;
162	203	}
	204	+ // Only mark the page as generated once the bundle is verifiably on disk; otherwise the
	205	+ // next request must retry generation instead of fast-pathing to a stale/missing file.
	206	+ if (!empty($bfUniqFormIds) && file_exists($this->getJSFilePath($postId))) {
	207	+ $this->markScriptGenerated($bfUniqFormIds, $postId);
	208	+ }
163	209	wp_enqueue_script('bit-form-all-script-test', $this->getJSFileSrc($postId), [], $formUpdateVersion, true);
164	210	}
165	211
166	212	private function deleteUnusedFormPageIds($postId, $formIDs)
		@@ -176,9 +222,9 @@
176	222	);
177	223	$regenerateScriptFlag = false;
178	224	foreach ($forms as $form) {
179	225	$formId = $form->id;
180		- $generatedScriptPageIdsDecoded = json_decode($form->generated_script_page_ids, true);
	226	+ $generatedScriptPageIdsDecoded = json_decode((string) $form->generated_script_page_ids, true);
181	227	$generatedScriptPageIds = is_array($generatedScriptPageIdsDecoded) ? array_keys($generatedScriptPageIdsDecoded) : [];
182	228	if (!empty($generatedScriptPageIds) && !in_array($formId, $formIDs) && in_array($postId, $generatedScriptPageIds)) {
183	229	unset($generatedScriptPageIdsDecoded[$postId]);
184	230	if (empty($generatedScriptPageIdsDecoded)) {
		@@ -206,10 +252,11 @@
206	252	if (!is_a($post, 'WP_Post') && !isset($post->ID)) {
207	253	return;
208	254	}
209	255	$postId = $post->ID;
210		- $regenerateScriptFlag = false;
211		- $formModel = new FormModel();
	256	+ // Read-only check. Marking the page as generated is deferred to markScriptGenerated(),
	257	+ // called only after the bundle file is actually written — marking here left the DB
	258	+ // saying "generated" while the file stayed stale whenever generation failed mid-way.
212	259	foreach ($formsIds as $formId) {
213	260	$formInstance = FormManager::getInstance($formId);
214	261	if (!$formInstance->isExist()) {
215	262	continue;
		@@ -215,18 +262,35 @@
215	262	continue;
216	263	}
217	264	$generatedPages = $formInstance->getFormData('generated_script_page_ids');
218	265	if (empty($generatedPages)) {
219		- $regenerateScriptFlag = true;
220		- } elseif (is_object($generatedPages) && (!isset($generatedPages->{$postId}) || (isset($generatedPages->{$postId}) && false === $generatedPages->{$postId}))) {
221		- $regenerateScriptFlag = true;
	266	+ return true;
222	267	}
223		- if (!$regenerateScriptFlag) {
	268	+ if (is_object($generatedPages) && (!isset($generatedPages->{$postId}) || false === $generatedPages->{$postId})) {
	269	+ return true;
	270	+ }
	271	+ }
	272	+ return false;
	273	+ }
	274	+
	275	+ private function markScriptGenerated($formsIds, $postId)
	276	+ {
	277	+ // Fetched via FormModel rather than FormManager: FormManager keeps its row in a static
	278	+ // property shared across instances, so after the render loop it holds the last form's
	279	+ // data regardless of which instance is asked.
	280	+ $formModel = new FormModel();
	281	+ foreach ($formsIds as $formId) {
	282	+ $form = $formModel->get(['generated_script_page_ids'], ['id' => $formId]);
	283	+ if (is_wp_error($form) || empty($form)) {
224	284	continue;
225	285	}
	286	+ $generatedPages = Utilities::jsonObj($form[0]->generated_script_page_ids ?? '');
226	287	if (!is_object($generatedPages)) {
227	288	$generatedPages = (object) [];
228	289	}
	290	+ if (!empty($generatedPages->{$postId})) {
	291	+ continue;
	292	+ }
229	293	$generatedPages->{$postId} = true;
230	294	$formModel->update(
231	295	[
232	296	'generated_script_page_ids' => \wp_json_encode($generatedPages)
		@@ -235,9 +299,8 @@
235	299	'id' => $formId,
236	300	]
237	301	);
238	302	}
239		- return $regenerateScriptFlag;
240	303	}
241	304
242	305	private function addInlineScript($code, $handle = '', $position = 'after')
243	306	{
		@@ -546,8 +609,9 @@
546	609	];
547	610
548	611	if ($entryId) {
549	612	$bitFormFrontArr['entryId'] = $entryId;
	613	+ self::markResponseUncacheable();
550	614	}
551	615
552	616	if (isset($additional->enabled->validateFocusLost)) {
553	617	$bitFormFrontArr['validateFocusLost'] = true;
		@@ -553,9 +617,11 @@
553	617	$bitFormFrontArr['validateFocusLost'] = true;
554	618	}
555	619
556	620	if (!empty($isAbandoned)) {
	621	+ // One visitor's typed values, so this response must not be page-cached.
557	622	$bitFormFrontArr['oldValues'] = $this->getFieldsValue($formID, $isAbandoned);
	623	+ self::markResponseUncacheable();
558	624	if (empty($entryId)) {
559	625	$bitFormFrontArr['entryId'] = $entryId;
560	626	}
561	627	}
		@@ -592,27 +658,31 @@
592	658	$layout = wp_json_encode($layout);
593	659	$buttons = wp_json_encode($buttons);
594	660	$frontArr = wp_json_encode($bitFormFrontArr);
595	661
596		- $bfGlobals = sprintf('
597		- if(!window.bf_globals) {
598		- window.bf_globals = {}
599		- } if(!window.bf_globals.%1$s) {
600		- window.bf_globals.%1$s = {}
	662	+ $bfGlobals = sprintf('
	663	+ if(!window.bf_globals) {
	664	+ window.bf_globals = {}
	665	+ } if(!window.bf_globals.%1$s) {
	666	+ window.bf_globals.%1$s = {}
601	667	}
602		- if(document.getElementById("%1$s")) {
603		- window.bf_globals.%1$s = {
604		- ...window.bf_globals.%1$s,
605		- ...%2$s
606		- };
607		- }', $FormIdentifier, $frontArr);
	668	+ window.bf_globals.%1$s = {
	669	+ ...window.bf_globals.%1$s,
	670	+ ...%2$s
	671	+ };
	672	+ if (typeof window.bitformInit === "function") { window.bitformInit("%1$s"); }', $FormIdentifier, $frontArr);
608	673
	674	+ // Inert copy of the config. Optimizers only rewrite executable scripts, so
	675	+ // this survives and travels with the markup; the runtime hydrates from it
	676	+ // whenever bf_globals is missing.
	677	+ $configTag = self::buildFormConfigTag($FormIdentifier, $bitFormFrontArr);
	678	+
609	679	if ('conversational' === $formType
610	680	&& isset($formContent->formInfo->conversationalSettings->enable)
611	681	&& $formContent->formInfo->conversationalSettings->enable) {
612		- $html = $FrontendFormManager->conversationalFormView($fields, $file, $errorMessages);
	682	+ $html = $FrontendFormManager->conversationalFormView($fields, $file, $errorMessages, null, !empty($entryId));
613	683	} else {
614		- $html = $FrontendFormManager->formView($fields, $file, $errorMessages);
	684	+ $html = $FrontendFormManager->formView($fields, $file, $errorMessages, null, !empty($entryId));
615	685	}
616	686
617	687	// if form preview then return html otherwise echo with output buffer
618	688	if ($formPreview) {
		@@ -620,8 +690,9 @@
620	690	$formViewObject = new \stdClass();
621	691	$formViewObject->html = $html;
622	692	$formViewObject->font = $font;
623	693	$formViewObject->bfGlobals = $bfGlobals;
	694	+ $formViewObject->configTag = $configTag;
624	695	$formViewObject->formContent = $formContent;
625	696	return $formViewObject;
626	697	}
627	698
		@@ -628,13 +699,60 @@
628	699	$bfGlobalsHandle = 'bitform-bf-globals-' . sanitize_key($FormIdentifier);
629	700	$this->addInlineScript($bfGlobals, $bfGlobalsHandle, 'after');
630	701	$this->emitShowPickerBridge();
631	702
	703	+ // Printed outside wp_kses rather than allowing <script> in form markup.
	704	+ // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- built by buildFormConfigTag(), JSON_HEX_* escaped.
	705	+ echo $configTag;
632	706	echo wp_kses(trim($html), EscapingHelper::getFormAllowedHtml($formContent));
633	707	return ob_get_clean();
634	708	}
635	709
636	710	/**
	711	+ * Keep per-visitor config (oldValues, entryId) out of full-page caches.
	712	+ *
	713	+ * @return void
	714	+ */
	715	+ public static function markResponseUncacheable()
	716	+ {
	717	+ // DONOTCACHEPAGE does the work; caches read it at shutdown. Rendering
	718	+ // usually runs after headers are sent, so nocache_headers() is a bonus.
	719	+ if (!defined('DONOTCACHEPAGE')) {
	720	+ define('DONOTCACHEPAGE', true);
	721	+ }
	722	+ if (!headers_sent() && function_exists('nocache_headers')) {
	723	+ nocache_headers();
	724	+ }
	725	+ }
	726	+
	727	+ /**
	728	+ * Build the inert JSON config block for a rendered form.
	729	+ *
	730	+ * JSON_HEX_* escapes < > & as \u00XX so no field value can close the script
	731	+ * element or inject markup.
	732	+ *
	733	+ * @param string $formIdentifier
	734	+ * @param array $config
	735	+ *
	736	+ * @return string
	737	+ */
	738	+ public static function buildFormConfigTag($formIdentifier, $config)
	739	+ {
	740	+ $json = wp_json_encode($config, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT);
	741	+ if (false === $json) {
	742	+ return '';
	743	+ }
	744	+ // Some optimizers wrap any inline <script>, including application/json,
	745	+ // in DOMContentLoaded boilerplate that corrupts the JSON. These attributes
	746	+ // make the common ones skip it; the JS side also salvage-parses.
	747	+ return sprintf(
	748	+ '<script type="application/json" class="bf-form-config" id="bf-config-%1$s" data-bf-form="%1$s" data-no-optimize="1" data-no-defer="1" data-no-minify="1" data-cfasync="false" nowprocket>%2$s</script>',
	749	+ esc_attr($formIdentifier),
	750	+ $json
	751	+ );
	752	+ }
	753	+
	754	+ /**
637	755	* Build the smart-tag map exposed to the browser in window.bf_globals[formId].smartTags.
638	756	*
639	757	* Security: the legacy code shipped the ENTIRE ~43-tag map to every visitor, leaking
640	758	* PII (admin/user/author email) and freezing per-visitor request data (IP, time,
		@@ -832,12 +950,58 @@
832	950	if ('file-up' === $fields->{$metaKey}->typ || 'advanced-file-up' === $fields->{$metaKey}->typ) {
833	951	$fields->{$metaKey}->val = $metaValue->meta_value;
834	952	$fields->{$metaKey}->config->oldFiles = $metaValue->meta_value;
835	953	}
	954	+ if ('signature' === $fields->{$metaKey}->typ) {
	955	+ $this->setOldSignature($fields->{$metaKey}, $formID, $entryID, $metaValue->meta_value);
	956	+ }
836	957	}
837	958	}
838	959	}
839	960	return $fields;
	961	+ }
	962	+
	963	+ /** Give the signature field its stored signature: a data URI to redraw, and the name it posts back as `_old`. */
	964	+ private function setOldSignature($field, $formID, $entryID, $storedValue)
	965	+ {
	966	+ $fileName = is_string($storedValue) ? trim($storedValue) : '';
	967	+ $decoded = json_decode($fileName, true);
	968	+ if (is_array($decoded)) {
	969	+ $fileName = empty($decoded) ? '' : trim((string) reset($decoded));
	970	+ }
	971	+ // signature-failed.png means the stored signature was never usable.
	972	+ if ('' === $fileName || 'signature-failed.png' === $fileName) {
	973	+ return;
	974	+ }
	975	+ $fileName = sanitize_file_name($fileName);
	976	+ if (!isset($field->config)) {
	977	+ $field->config = (object) [];
	978	+ } elseif (is_array($field->config)) {
	979	+ $field->config = (object) $field->config;
	980	+ }
	981	+ $field->config->oldSignatureFile = $fileName;
	982	+
	983	+ $filePath = FileHandler::getEntriesFileUploadDir($formID, $entryID) . DIRECTORY_SEPARATOR . $fileName;
	984	+ if (!is_file($filePath) || !is_readable($filePath)) {
	985	+ return;
	986	+ }
	987	+ // The types getSignatureFilePath() writes; wp_check_filetype() reports none for SVG.
	988	+ $signatureMimeTypes = ['png' => 'image/png', 'jpg' => 'image/jpeg', 'svg' => 'image/svg+xml'];
	989	+ $extension = strtolower((string) pathinfo($fileName, PATHINFO_EXTENSION));
	990	+ if (!isset($signatureMimeTypes[$extension])) {
	991	+ return;
	992	+ }
	993	+ $mimeType = $signatureMimeTypes[$extension];
	994	+ // A hand-drawn signature is a few KB; a larger file is not worth inlining.
	995	+ if (filesize($filePath) > self::MAX_INLINE_SIGNATURE_BYTES) {
	996	+ return;
	997	+ }
	998	+ // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_get_contents -- local upload dir read, inlined as a data URI for the signature pad.
	999	+ $contents = file_get_contents($filePath);
	1000	+ if (false === $contents || '' === $contents) {
	1001	+ return;
	1002	+ }
	1003	+ $field->config->oldSignature = 'data:' . $mimeType . ';base64,' . base64_encode($contents);
840	1004	}
841	1005
842	1006	public function loadAssets($formID = 0, $fromType = 'classic')
843	1007	{