From dc3e02fbfdc6c477e74e7b62b74df46fad3853e8 Mon Sep 17 00:00:00 2001
From: Angie Byron <webchick@24967.no-reply.drupal.org>
Date: Wed, 1 Sep 2010 01:35:19 +0000
Subject: [PATCH] #890994 by Berdir, Crell, Josh Waihi: Fixed Entity query
tests fail on PostgreSQL.
---
includes/database/database.inc | 28 +++++++++
includes/database/pgsql/query.inc | 67 ++++++++++++++++++++++
includes/database/select.inc | 9 ++-
modules/search/search.extender.inc | 9 +--
modules/simpletest/tests/entity_query.test | 12 ++--
5 files changed, 115 insertions(+), 10 deletions(-)
diff --git a/includes/database/database.inc b/includes/database/database.inc
index 73cb243e5448..ca6023f2dfea 100644
--- a/includes/database/database.inc
+++ b/includes/database/database.inc
@@ -809,6 +809,34 @@ public function escapeField($field) {
return preg_replace('/[^A-Za-z0-9_.]+/', '', $field);
}
+ /**
+ * Escapes an alias name string.
+ *
+ * Force all alias names to be strictly alphanumeric-plus-underscore. In
+ * contrast to DatabaseConnection::escapeField() /
+ * DatabaseConnection::escapeTable(), this doesn't allow the period (".")
+ *
+ * @return
+ * The sanitized field name string.
+ */
+ public function escapeAlias($field) {
+ return preg_replace('/[^A-Za-z0-9_]+/', '', $field);
+ }
+
+ /**
+ * Escapes a alias name string.
+ *
+ * Force all alias names to be strictly alphanumeric-plus-underscore. In
+ * contrast to DatabaseConnection::escapeField() /
+ * DatabaseConnection::escapeTable(), this doesn't allow the point.
+ *
+ * @return
+ * The sanitized field name string.
+ */
+ public function escapeAlias($field) {
+ return preg_replace('/[^A-Za-z0-9_]+/', '', $field);
+ }
+
/**
* Escapes characters that work as wildcard characters in a LIKE pattern.
*
diff --git a/includes/database/pgsql/query.inc b/includes/database/pgsql/query.inc
index 61c82180173b..7642f53f70ba 100644
--- a/includes/database/pgsql/query.inc
+++ b/includes/database/pgsql/query.inc
@@ -217,4 +217,71 @@ public function orderRandom() {
return $this;
}
+ /**
+ * Overrides SelectQuery::orderBy().
+ *
+ * Automatically adds columns that are ordered on as fields.
+ */
+ public function orderBy($field, $direction = 'ASC') {
+ // Call parent function to order on this.
+ $return = parent::orderBy($field, $direction);
+
+ // PostgreSQL requires that when using DISTINCT or GROUP BY conditions,
+ // fields/expressions that are ordered on also need to be selected.
+ // This function tries to automatically add a field if it is not already
+ // added or a condition applies that makes it impossible to handle that
+ // automatically. In such cases, the query might fail on PostgreSQL if the
+ // field or expression is not added manually.
+
+ // If there is a table alias specified, split it up.
+ if (strpos($field, '.') !== FALSE) {
+ list($table, $table_field) = explode('.', $field);
+ }
+ // Figure out if the field has already been added.
+ foreach ($this->fields as $existing_field) {
+ if (!empty($table)) {
+ // If table alias is given, check if field and table exists.
+ if ($existing_field['table'] == $table && $existing_field['field'] == $table_field) {
+ return $return;
+ }
+ }
+ else {
+ // If there is no table, simply check if the field exists as a field or
+ // an aliased field.
+ if ($existing_field['alias'] == $field) {
+ return $return;
+ }
+ }
+ }
+
+ // Also check expression aliases.
+ foreach ($this->expressions as $expression) {
+ if ($expression['alias'] == $field) {
+ return $return;
+ }
+ }
+
+ // If a table loads all fields, it can not be added again. It would
+ // result in an ambigious alias error because that field would be loaded
+ // twice: Once through table_alias.* and once directly. If the field
+ // actually belongs to a different table, it must be added manually.
+ foreach ($this->tables as $table) {
+ if (!empty($table['all_fields'])) {
+ return $return;
+ }
+ }
+
+ // If $field contains an characters which are not allowed in a field name
+ // it is considered an expression, these can't be handeld automatically
+ // either.
+ if ($this->connection->escapeField($field) != $field) {
+ return $return;
+ }
+
+ // This is a case that can be handled automatically, add the field.
+ $this->addField(NULL, $field);
+ return $return;
+ }
+
+
}
diff --git a/includes/database/select.inc b/includes/database/select.inc
index d46abefdf2ca..0fc17f586389 100644
--- a/includes/database/select.inc
+++ b/includes/database/select.inc
@@ -366,6 +366,11 @@ public function addJoin($type, $table, $alias = NULL, $condition = NULL, $argume
* If called multiple times, the query will order by each specified field in the
* order this method is called.
*
+ * If the query uses DISTINCT or GROUP BY conditions, fields or expressions
+ * that are used for the order must be selected to be compatible with some
+ * databases like PostgreSQL. The PostgreSQL driver can handle simple cases
+ * automatically but it is suggested to explicitly specify them.
+ *
* @param $field
* The field on which to order.
* @param $direction
@@ -1373,10 +1378,10 @@ public function __toString() {
foreach ($this->fields as $alias => $field) {
// Always use the AS keyword for field aliases, as some
// databases require it (e.g., PostgreSQL).
- $fields[] = (isset($field['table']) ? $this->connection->escapeTable($field['table']) . '.' : '') . $this->connection->escapeField($field['field']) . ' AS ' . $this->connection->escapeField($field['alias']);
+ $fields[] = (isset($field['table']) ? $this->connection->escapeTable($field['table']) . '.' : '') . $this->connection->escapeField($field['field']) . ' AS ' . $this->connection->escapeAlias($field['alias']);
}
foreach ($this->expressions as $alias => $expression) {
- $fields[] = $expression['expression'] . ' AS ' . $expression['alias'];
+ $fields[] = $expression['expression'] . ' AS ' . $this->connection->escapeAlias($expression['alias']);
}
$query .= implode(', ', $fields);
diff --git a/modules/search/search.extender.inc b/modules/search/search.extender.inc
index 1eae2caa6c62..6c0c7600ba4d 100644
--- a/modules/search/search.extender.inc
+++ b/modules/search/search.extender.inc
@@ -415,10 +415,6 @@ public function execute()
// Add default score.
$this->addScore('i.relevance');
}
- if (count($this->getOrderBy()) == 0) {
- // Add default order.
- $this->orderBy('calculated_score', 'DESC');
- }
if (count($this->multiply)) {
// Add the total multiplicator as many times as requested to maintain
@@ -436,6 +432,11 @@ public function execute()
// Convert scores to an expression.
$this->addExpression('SUM(' . implode(' + ', $this->scores) . ')', 'calculated_score', $this->scoresArguments);
+ if (count($this->getOrderBy()) == 0) {
+ // Add default order after adding the expression.
+ $this->orderBy('calculated_score', 'DESC');
+ }
+
// Add tag and useful metadata.
$this
->addTag('search_' . $this->type)
diff --git a/modules/simpletest/tests/entity_query.test b/modules/simpletest/tests/entity_query.test
index 0b3db8b59e96..e120c53b2311 100644
--- a/modules/simpletest/tests/entity_query.test
+++ b/modules/simpletest/tests/entity_query.test
@@ -501,16 +501,20 @@ class EntityFieldQueryTestCase extends DrupalWebTestCase {
$query = new EntityFieldQuery();
$query
->entityCondition('entity_type', 'test_entity_bundle_key')
- ->propertyCondition('ftid', 1, 'CONTAINS');
+ ->propertyCondition('fttype', 'und', 'CONTAINS');
$this->assertEntityFieldQuery($query, array(
array('test_entity_bundle_key', 1),
+ array('test_entity_bundle_key', 2),
+ array('test_entity_bundle_key', 3),
+ array('test_entity_bundle_key', 4),
+ array('test_entity_bundle_key', 5),
+ array('test_entity_bundle_key', 6),
), t('Test the "contains" operation on a property.'));
$query = new EntityFieldQuery();
- $query->fieldCondition($this->fields[0], 'value', 3, 'CONTAINS');
+ $query->fieldCondition($this->fields[1], 'shape', 'uar', 'CONTAINS');
$this->assertEntityFieldQuery($query, array(
- array('test_entity_bundle_key', 3),
- array('test_entity', 3),
+ array('test_entity_bundle', 5),
), t('Test the "contains" operation on a field.'));
$query = new EntityFieldQuery();
--
GitLab