| 1 | <?php |
| 2 | /* |
| 3 | * $Id: RawSql.php 3032 2007-10-29 19:50:16Z meus $ |
| 4 | * |
| 5 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 6 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 7 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 8 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 9 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 10 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 11 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 12 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 13 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 14 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 15 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 16 | * |
| 17 | * This software consists of voluntary contributions made by many individuals |
| 18 | * and is licensed under the LGPL. For more information, see |
| 19 | * <http://www.phpdoctrine.com>. |
| 20 | */ |
| 21 | Doctrine::autoload('Doctrine_Query_Abstract'); |
| 22 | /** |
| 23 | * Doctrine_RawSql |
| 24 | * |
| 25 | * @package Doctrine |
| 26 | * @subpackage RawSql |
| 27 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL |
| 28 | * @link www.phpdoctrine.com |
| 29 | * @since 1.0 |
| 30 | * @version $Revision: 3032 $ |
| 31 | * @author Konsta Vesterinen <kvesteri@cc.hut.fi> |
| 32 | */ |
| 33 | class Doctrine_RawSql extends Doctrine_Query_Abstract |
| 34 | { |
| 35 | /** |
| 36 | * @var array $fields |
| 37 | */ |
| 38 | private $fields = array(); |
| 39 | |
| 40 | /** |
| 41 | * parseQueryPart |
| 42 | * parses given query part |
| 43 | * |
| 44 | * @param string $queryPartName the name of the query part |
| 45 | * @param string $queryPart query part to be parsed |
| 46 | * @param boolean $append whether or not to append the query part to its stack |
| 47 | * if false is given, this method will overwrite |
| 48 | * the given query part stack with $queryPart |
| 49 | * @return Doctrine_Query this object |
| 50 | */ |
| 51 | public function parseQueryPart($queryPartName, $queryPart, $append = false) |
| 52 | { |
| 53 | if ($queryPartName == 'select') { |
| 54 | $this->parseSelectFields($queryPart); |
| 55 | return $this; |
| 56 | } |
| 57 | if( ! isset($this->parts[$queryPartName])) { |
| 58 | $this->parts[$queryPartName] = array(); |
| 59 | } |
| 60 | |
| 61 | if (! $append) { |
| 62 | $this->parts[$queryPartName] = array($queryPart); |
| 63 | }else { |
| 64 | $this->parts[$queryPartName][] = $queryPart; |
| 65 | } |
| 66 | return $this; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Add select parts to fields |
| 71 | * |
| 72 | * @param $queryPart sting The name of the querypart |
| 73 | */ |
| 74 | private function parseSelectFields($queryPart){ |
| 75 | preg_match_all('/{([^}{]*)}/U', $queryPart, $m); |
| 76 | $this->fields = $m[1]; |
| 77 | $this->parts['select'] = array(); |
| 78 | } |
| 79 | /** |
| 80 | * parseQuery |
| 81 | * parses an sql query and adds the parts to internal array |
| 82 | * |
| 83 | * @param string $query query to be parsed |
| 84 | * @return Doctrine_RawSql this object |
| 85 | */ |
| 86 | public function parseQuery($query) |
| 87 | { |
| 88 | $this->parseSelectFields($query); |
| 89 | $this->clear(); |
| 90 | |
| 91 | $tokens = Doctrine_Tokenizer::sqlExplode($query,' '); |
| 92 | |
| 93 | $parts = array(); |
| 94 | foreach ($tokens as $key => $part) { |
| 95 | $partLowerCase = strtolower($part); |
| 96 | switch ($partLowerCase) { |
| 97 | case 'select': |
| 98 | case 'from': |
| 99 | case 'where': |
| 100 | case 'limit': |
| 101 | case 'offset': |
| 102 | case 'having': |
| 103 | $type = $partLowerCase; |
| 104 | if ( ! isset($parts[$partLowerCase])) { |
| 105 | $parts[$partLowerCase] = array(); |
| 106 | } |
| 107 | break; |
| 108 | case 'order': |
| 109 | case 'group': |
| 110 | $i = $key + 1; |
| 111 | if (isset($tokens[$i]) && strtolower($tokens[$i]) === 'by') { |
| 112 | $type = $partLowerCase . 'by'; |
| 113 | $parts[$type] = array(); |
| 114 | } else { |
| 115 | //not a keyword so we add it to the previous type |
| 116 | $parts[$type][] = $part; |
| 117 | } |
| 118 | break; |
| 119 | case 'by': |
| 120 | continue; |
| 121 | default: |
| 122 | //not a keyword so we add it to the previous type. |
| 123 | if ( ! isset($parts[$type][0])) { |
| 124 | $parts[$type][0] = $part; |
| 125 | } else { |
| 126 | // why does this add to index 0 and not append to the |
| 127 | // array. If it had done that one could have used |
| 128 | // parseQueryPart. |
| 129 | $parts[$type][0] .= ' '.$part; |
| 130 | } |
| 131 | } |
| 132 | } |
| 133 | |
| 134 | $this->parts = $parts; |
| 135 | $this->parts['select'] = array(); |
| 136 | |
| 137 | return $this; |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * getQuery |
| 142 | * builds the sql query from the given query parts |
| 143 | * |
| 144 | * @return string the built sql query |
| 145 | */ |
| 146 | public function getQuery() |
| 147 | { |
| 148 | $select = array(); |
| 149 | |
| 150 | foreach ($this->fields as $field) { |
| 151 | $e = explode('.', $field); |
| 152 | if ( ! isset($e[1])) { |
| 153 | throw new Doctrine_RawSql_Exception('All selected fields in Sql query must be in format tableAlias.fieldName'); |
| 154 | } |
| 155 | // try to auto-add component |
| 156 | if ( ! $this->hasTableAlias($e[0])) { |
| 157 | try { |
| 158 | $this->addComponent($e[0], ucwords($e[0])); |
| 159 | } catch(Doctrine_Exception $exception) { |
| 160 | throw new Doctrine_RawSql_Exception('The associated component for table alias ' . $e[0] . ' couldn\'t be found.'); |
| 161 | } |
| 162 | } |
| 163 | |
| 164 | $componentAlias = $this->getComponentAlias($e[0]); |
| 165 | |
| 166 | if ($e[1] == '*') { |
| 167 | foreach ($this->_aliasMap[$componentAlias]['table']->getColumnNames() as $name) { |
| 168 | $field = $e[0] . '.' . $name; |
| 169 | |
| 170 | $select[$componentAlias][$field] = $field . ' AS ' . $e[0] . '__' . $name; |
| 171 | } |
| 172 | } else { |
| 173 | $field = $e[0] . '.' . $e[1]; |
| 174 | $select[$componentAlias][$field] = $field . ' AS ' . $e[0] . '__' . $e[1]; |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | // force-add all primary key fields |
| 179 | |
| 180 | foreach ($this->getTableAliases() as $tableAlias => $componentAlias) { |
| 181 | $map = $this->_aliasMap[$componentAlias]; |
| 182 | |
| 183 | foreach ((array) $map['table']->getIdentifier() as $key) { |
| 184 | $field = $tableAlias . '.' . $key; |
| 185 | |
| 186 | if ( ! isset($this->parts['select'][$field])) { |
| 187 | $select[$componentAlias][$field] = $field . ' AS ' . $tableAlias . '__' . $key; |
| 188 | } |
| 189 | } |
| 190 | } |
| 191 | |
| 192 | // first add the fields of the root component |
| 193 | reset($this->_aliasMap); |
| 194 | $componentAlias = key($this->_aliasMap); |
| 195 | |
| 196 | $q = 'SELECT ' . implode(', ', $select[$componentAlias]); |
| 197 | unset($select[$componentAlias]); |
| 198 | |
| 199 | foreach ($select as $component => $fields) { |
| 200 | if ( ! empty($fields)) { |
| 201 | $q .= ', ' . implode(', ', $fields); |
| 202 | } |
| 203 | } |
| 204 | |
| 205 | $string = $this->applyInheritance(); |
| 206 | if ( ! empty($string)) { |
| 207 | $this->parts['where'][] = $string; |
| 208 | } |
| 209 | $copy = $this->parts; |
| 210 | unset($copy['select']); |
| 211 | |
| 212 | $q .= ( ! empty($this->parts['from']))? ' FROM ' . implode(' ', $this->parts['from']) : ''; |
| 213 | $q .= ( ! empty($this->parts['where']))? ' WHERE ' . implode(' AND ', $this->parts['where']) : ''; |
| 214 | $q .= ( ! empty($this->parts['groupby']))? ' GROUP BY ' . implode(', ', $this->parts['groupby']) : ''; |
| 215 | $q .= ( ! empty($this->parts['having']))? ' HAVING ' . implode(' AND ', $this->parts['having']) : ''; |
| 216 | $q .= ( ! empty($this->parts['orderby']))? ' ORDER BY ' . implode(', ', $this->parts['orderby']) : ''; |
| 217 | $q .= ( ! empty($this->parts['limit']))? ' LIMIT ' . implode(' ', $this->parts['limit']) : ''; |
| 218 | $q .= ( ! empty($this->parts['offset']))? ' OFFSET ' . implode(' ', $this->parts['offset']) : ''; |
| 219 | |
| 220 | if ( ! empty($string)) { |
| 221 | array_pop($this->parts['where']); |
| 222 | } |
| 223 | return $q; |
| 224 | } |
| 225 | |
| 226 | /** |
| 227 | * getFields |
| 228 | * returns the fields associated with this parser |
| 229 | * |
| 230 | * @return array all the fields associated with this parser |
| 231 | */ |
| 232 | public function getFields() |
| 233 | { |
| 234 | return $this->fields; |
| 235 | } |
| 236 | |
| 237 | /** |
| 238 | * addComponent |
| 239 | * |
| 240 | * @param string $tableAlias |
| 241 | * @param string $componentName |
| 242 | * @return Doctrine_RawSql |
| 243 | */ |
| 244 | public function addComponent($tableAlias, $path) |
| 245 | { |
| 246 | $tmp = explode(' ', $path); |
| 247 | $originalAlias = (count($tmp) > 1) ? end($tmp) : null; |
| 248 | |
| 249 | $e = explode('.', $tmp[0]); |
| 250 | |
| 251 | $fullPath = $tmp[0]; |
| 252 | $fullLength = strlen($fullPath); |
| 253 | |
| 254 | $table = null; |
| 255 | |
| 256 | $currPath = ''; |
| 257 | |
| 258 | if (isset($this->_aliasMap[$e[0]])) { |
| 259 | $table = $this->_aliasMap[$e[0]]['table']; |
| 260 | |
| 261 | $currPath = $parent = array_shift($e); |
| 262 | } |
| 263 | |
| 264 | foreach ($e as $k => $component) { |
| 265 | // get length of the previous path |
| 266 | $length = strlen($currPath); |
| 267 | |
| 268 | // build the current component path |
| 269 | $currPath = ($currPath) ? $currPath . '.' . $component : $component; |
| 270 | |
| 271 | $delimeter = substr($fullPath, $length, 1); |
| 272 | |
| 273 | // if an alias is not given use the current path as an alias identifier |
| 274 | if (strlen($currPath) === $fullLength && isset($originalAlias)) { |
| 275 | $componentAlias = $originalAlias; |
| 276 | } else { |
| 277 | $componentAlias = $currPath; |
| 278 | } |
| 279 | if ( ! isset($table)) { |
| 280 | $conn = Doctrine_Manager::getInstance() |
| 281 | ->getConnectionForComponent($component); |
| 282 | |
| 283 | $table = $conn->getTable($component); |
| 284 | $this->_aliasMap[$componentAlias] = array('table' => $table); |
| 285 | } else { |
| 286 | $relation = $table->getRelation($component); |
| 287 | |
| 288 | $this->_aliasMap[$componentAlias] = array('table' => $relation->getTable(), |
| 289 | 'parent' => $parent, |
| 290 | 'relation' => $relation); |
| 291 | } |
| 292 | $this->addTableAlias($tableAlias, $componentAlias); |
| 293 | |
| 294 | $parent = $currPath; |
| 295 | } |
| 296 | |
| 297 | return $this; |
| 298 | } |
| 299 | } |