From 72f87757e2570c9880ce967709195e65055ca0ae Mon Sep 17 00:00:00 2001
From: srcspider <source.spider@gmail.com>
Date: Thu, 29 Aug 2013 15:19:57 +0300
Subject: [PATCH] hotfix - replaced getElementById with XPath equivalent to
 ensure a form tag with an id is reliably retrieved

The following,

$form = $node->ownerDocument->getElementById($formId);

...is an unreliable way to retrieve the ID.

Even if there is an element with an id attribute the id won't be recognized unless the document was validated at the point it was read which in the case of setNode (for whatever reason) does not happen under some circumstances.

To give an example, given the following xml file

	<?xml version="1.0" encoding="UTF-8"?>
	<root>
		<form id="testform1"></form>
	</root>

And the following code,

	<?php

	ini_set('display_errors',1);
	ini_set('display_startup_errors',1);
	ini_set('html_errors', 1);
	error_reporting(-1);

	$doc = new DomDocument;
	$doc->validateOnParse = true;
	$doc->Load('test.xml');

	echo 'Form Tag Exists? '.($doc->getElementById('testform1') === null ? 'Nope' : 'Yup');

The code will still output "Form Tag Exists? Nope" because of how picky the getElementById method is.

For more on the phenomenon see this stackoverflow answer: http://stackoverflow.com/questions/3391942/php-html-domdocument-getelementbyid-problems

I haven't been able to track down why the document in question doesn't work with getElementById, but somehow I'm assuming it has something to do with html5 not having a DTD (though for what it's worth ownerDocument in that particular case somehow gets reduced to just the form and the fields; which is weird in of itself). For reference the real world circumstances where this borks miserably is when using behat with goutte.

The following XPath version appears to reliably work,

	$xp = new \DOMXPath($node->ownerDocument);
	$form = $xp->query("//*[@id='{$formId}']")->item(0);
---
 src/Symfony/Component/DomCrawler/Form.php | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/Symfony/Component/DomCrawler/Form.php b/src/Symfony/Component/DomCrawler/Form.php
index 7f44a5be5e253..762c824108f75 100644
--- a/src/Symfony/Component/DomCrawler/Form.php
+++ b/src/Symfony/Component/DomCrawler/Form.php
@@ -346,7 +346,8 @@ protected function setNode(\DOMNode $node)
             if ($node->hasAttribute('form')) {
                 // if the node has the HTML5-compliant 'form' attribute, use it
                 $formId = $node->getAttribute('form');
-                $form = $node->ownerDocument->getElementById($formId);
+                $xp = new \DOMXPath($node->ownerDocument);
+                $form = $xp->query("//*[@id='{$formId}']")->item(0);
                 if (null === $form) {
                     throw new \LogicException(sprintf('The selected node has an invalid form attribute (%s).', $formId));
                 }