summaryrefslogtreecommitdiff
path: root/connectivity/inc/connectivity/sqliterator.hxx
blob: 46a1cc9d84726940ca4f8467031fc4d0a492e6ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
/*************************************************************************
 *
 *  $RCSfile: sqliterator.hxx,v $
 *
 *  $Revision: 1.15 $
 *
 *  last change: $Author: rt $ $Date: 2004-09-09 09:03:13 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef _CONNECTIVITY_PARSE_SQLITERATOR_HXX_
#define _CONNECTIVITY_PARSE_SQLITERATOR_HXX_

#ifndef _CONNECTIVITY_SQLNODE_HXX
#include "connectivity/sqlnode.hxx"
#endif
#ifndef _COM_SUN_STAR_SDBCX_XTABLESSUPPLIER_HPP_
#include <com/sun/star/sdbcx/XTablesSupplier.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBCX_XCOLUMNSSUPPLIER_HPP_
#include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XDATABASEMETADATA_HPP_
#include <com/sun/star/sdbc/XDatabaseMetaData.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_DATATYPE_HPP_
#include <com/sun/star/sdbc/DataType.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_SQLWARNING_HPP_
#include <com/sun/star/sdbc/SQLWarning.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
#include <com/sun/star/beans/XPropertySet.hpp>
#endif
#ifndef _MAP_
#include <map>
#endif
#ifndef _CONNECTIVITY_COMMONTOOLS_HXX_
#include "connectivity/CommonTools.hxx"
#endif
#ifndef _VOS_REF_HXX_
#include <vos/ref.hxx>
#endif
#ifndef _CPPUHELPER_WEAK_HXX_
#include <cppuhelper/weak.hxx>
#endif

namespace connectivity
{

    class OSQLParseNode;


    enum OSQLStatementType {
        SQL_STATEMENT_UNKNOWN,
        SQL_STATEMENT_SELECT,
        SQL_STATEMENT_INSERT,
        SQL_STATEMENT_UPDATE,
        SQL_STATEMENT_DELETE,
        SQL_STATEMENT_ODBC_CALL,
        SQL_STATEMENT_SELECT_COUNT,
        SQL_STATEMENT_CREATE_TABLE
    };

    //==================================================================
    // SbaParseIteratorErrorInfo wird dem Call von aErrorHdl aus SbaParseIterator "ubergeben
    // nErrorCode enth"alt eine Zusatzinformation "uber den Fehler
    // 1    ->      Tabelle nicht gefunden
    // 2    ->      Spalte nicht gefunden
    //==================================================================
    struct OSQLParseIteratorErrorInfo
    {
        sal_uInt16      nErrorCode;     // 1 == Tabelle nicht gefunden, 2 == Spalte nicht gefunden
        ::rtl::OUString     aExpression;    // der Teil-Ausdruck, der das Problem verursacht hat (kann leer sein)
    };

    #define RET_CONTINUE    1   // Parsevorgang fortsetzen
    #define RET_HANDLED     2   // der Fehler wurde schon behandelt, das Parsen soll (mit Status auf Success) abgebrochen werden
    #define RET_BREAK       3   // Abbrechen, Status-Fehlercode setzen
    struct OSQLParseTreeIteratorImpl;

    class OSQLParseTreeIterator
    {
    public:

    private:
        ::com::sun::star::sdbc::SQLWarning  m_aWarning;         // conatins the error while iterating through the statement
        const OSQLParseNode*                m_pParseTree;       // aktueller ParseTree
        const OSQLParser*                   m_pParser;          // if set used for general error messages from the context
        OSQLStatementType                   m_eStatementType;   // Art des Statements
        OSQLTables                          m_aTables;          // Alle Tabellen die im ParseTree und bei der Connection gefunden wurden
        ::vos::ORef<OSQLColumns>            m_aSelectColumns;   // alle Spalten aus dem Select-Clause
        ::vos::ORef<OSQLColumns>            m_aParameters;      // all parameters
        ::vos::ORef<OSQLColumns>            m_aGroupColumns;    // the group by columns
        ::vos::ORef<OSQLColumns>            m_aOrderColumns;    // the order by columns
        ::vos::ORef<OSQLColumns>            m_aCreateColumns;   // the columns for Create table clause
        ::comphelper::UStringMixEqual       m_aCaseEqual;

        OSQLParseTreeIteratorImpl*          m_pImpl;
        ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData>    m_xDatabaseMetaData;

        void appendWarning(const ::rtl::OUString& _sErrMsg); // append warnings if m_pParser is set
        // F"ugt eine Tabelle in die Map ein
        void                traverseOneTableName(OSQLTables& _rTables,const OSQLParseNode * pTableName, const ::rtl::OUString & rTableRange, const sal_Bool bIsCreateTable);
        void                traverseORCriteria(OSQLParseNode * pSearchCondition);
        void                traverseANDCriteria(OSQLParseNode * pSearchCondition);
        void                traverseOnePredicate(
                                                OSQLParseNode * pColumnRef,
                                                sal_Int32 ePredicateType,
                                                ::rtl::OUString& aValue,
                                                sal_Bool bCompareNull,
                                                OSQLParseNode * pParameter);
        void traverseByColumnNames(const OSQLParseNode* pSelectNode,sal_Bool _bOrder);

        OSQLParseNode *     getTableRef(OSQLTables& _rTables,OSQLParseNode *pTableRef,::rtl::OUString& aTableRange);
        OSQLParseNode *     getQualified_join(OSQLTables& _rTables,OSQLParseNode *pTableRef,::rtl::OUString& aTableRange);
        void                getSelect_statement(OSQLTables& _rTables,OSQLParseNode *pSelect);
        ::rtl::OUString     getUniqueColumnName(const ::rtl::OUString & rColumnName)    const;

        ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > findColumn(const OSQLTables& _rTables,const ::rtl::OUString & rColumnName, const ::rtl::OUString & rTableRange);

      protected:
        void setSelectColumnName(::vos::ORef<OSQLColumns>& _rColumns,const ::rtl::OUString & rColumnName,const ::rtl::OUString & rColumnAlias, const ::rtl::OUString & rTableRange,sal_Bool bFkt=sal_False,sal_Int32 _nType = com::sun::star::sdbc::DataType::VARCHAR);
        void appendColumns(::vos::ORef<OSQLColumns>& _rColumns,const ::rtl::OUString& _rTableAlias,const OSQLTable& _rTable);
        // Weitere Member-Variable, die in den "set"-Funktionen zur
        // Verfuegung stehen sollen, koennen in der abgeleiteten Klasse
        // definiert werden und z. B. in deren Konstruktor initialisiert
        // bzw. nach Benutzung der "traverse"-Routinen mit Hilfe weiterer
        // Funktionen abgefragt werden.


      public:
        OSQLParseTreeIterator();
        OSQLParseTreeIterator(const OSQLParseTreeIterator & rIter);
        OSQLParseTreeIterator(  const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess>& _xTableSupplier ,
                                const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData>& _xDatabaseMetaData,
                                const OSQLParseNode* pRoot,
                                const OSQLParser* _pParser = NULL);
        ~OSQLParseTreeIterator();

        inline static void * SAL_CALL operator new( size_t nSize ) SAL_THROW( () )
            { return ::rtl_allocateMemory( nSize ); }
        inline static void * SAL_CALL operator new( size_t nSize,void* _pHint ) SAL_THROW( () )
            { return _pHint; }
        inline static void SAL_CALL operator delete( void * pMem ) SAL_THROW( () )
            { ::rtl_freeMemory( pMem ); }
        inline static void SAL_CALL operator delete( void * pMem,void* _pHint ) SAL_THROW( () )
            {  }

        void dispose();
        sal_Bool isCaseSensitive() const { return m_aCaseEqual.isCaseSensitive(); }
        // Der zu analysierende/zu traversierende Parse Tree:
        // bei "Ubergabe von NULL wird der aktuelle Parsetree gel"oscht und der Fehlerstatus gecleared
        void setParseTree(const OSQLParseNode * pNewParseTree);
        void setParser(const OSQLParser* _pParser) { m_pParser = _pParser; }
        const OSQLParseNode * getParseTree() const { return m_pParseTree; };

        // Teilbaueme bei einem select statement
        const OSQLParseNode* getWhereTree() const;
        const OSQLParseNode* getOrderTree() const;
        const OSQLParseNode* getGroupByTree() const;
        const OSQLParseNode* getHavingTree() const;

        const OSQLParseNode* getSimpleWhereTree() const;
        const OSQLParseNode* getSimpleOrderTree() const;
        const OSQLParseNode* getSimpleGroupByTree() const;
        const OSQLParseNode* getSimpleHavingTree() const;

        ::com::sun::star::sdbc::SQLWarning  getWarning() const { return m_aWarning; }
        // Statement-Typ (wird bereits in setParseTree gesetzt):
        OSQLStatementType getStatementType() const { return m_eStatementType; }

        // Die "traverse"-Routinen durchlaufen bestimmte Teile des Parse Tree
        // und rufen fuer die erkannten Konstrukte die virtuellen "set"-Routinen
        // auf und uebergeben diesen die erkannten Informationen als Parameter.
        //
        // Der Parse Tree muss in einer bestimmten Form vorliegen:
        //      SELECT [<tablerange>.]<columnname>, [<tablerange>.]<columnname>, ...
        //        FROM <tablename> [<tablerange>], <tablename> [<tablerange>], ...
        //       WHERE (
        //                  <predicate>
        //              AND <predicate>
        //              ...
        //             )
        //          OR (
        //              ...
        //             )
        //          ...
        //       ORDER BY <columname>, <columnname>, ...
        //
        // (die Klammern sind optional bzw. zusaetzliche Klammern stoeren nicht, aber
        // es duerfen nur mehrere AND-Bedingungen, die ihrerseits mit OR verknuepft sind,
        // auftreten).
        //
        //
        // <predicate> kann sein:
        //          [<tablerange>.]<columnname> <operator> <value>
        //          [<tablerange>.]<columnname> LIKE <value>
        //          [<tablerange>.]<columnname> NOT LIKE <value>
        //          [<tablerange>.]<columnname> IS NULL
        //          [<tablerange>.]<columnname> IS NOT NULL
        //
        // <operator> kann sein:
        //          "="
        //          "<>"
        //          "<"
        //          "<="
        //          ">"
        //          ">="
        //
        // <value> kann auch ein Parameter sein, in diesem Fall enthaelt
        // das Argument "ParameterName" der "set"-Funktionen den Namen des Parameters
        // (ohne fuehrenden Doppelpunkt) bzw. "?" bei unbenannten Parametern.
        //
        // <columnname> in der Select-Klausel kann auch "*" oder "COUNT(*)" sein.
        //
        //
        // Wenn das Statement NICHT diese Form hat, oder wenn eine der "set"-Routinen
        // den IteratorStatus != IsSuccessful() hinterlaesst, wird die weitere Analyse
        // des Parse Tree abgebrochen. Ansonsten liefert "Status().IsSuccessful() == TRUE".

        void traverseTableNames(OSQLTables& _rTables);
        virtual void setTableName(const ::rtl::OUString & rTableName, const ::rtl::OUString & rCatalogName, const ::rtl::OUString& rSchemaName,
                              const ::rtl::OUString & rTableRange);
        // [TableName enthaelt immer einen Namen, TableRange ist, falls angegeben, die "Range"-
        // Variable (eine Art Alias-Name fuer den TableName), falls nicht angegeben, identisch
        // zum TableName. SchemaName ist leer, wenn nicht angegeben.]

        void traverseSelectColumnNames(const OSQLParseNode* pSelectNode);
        // [TableRange kann leer sein, wenn nicht angegeben]

        void traverseCreateColumns(const OSQLParseNode* pSelectNode); //traverse columns for "create table" statement

        void traverseOrderByColumnNames(const OSQLParseNode* pSelectNode);
        virtual void setOrderByColumnName(const ::rtl::OUString & rColumnName, const ::rtl::OUString & rTableRange, sal_Bool bAscending);

        void traverseGroupByColumnNames(const OSQLParseNode* pSelectNode);
        virtual void setGroupByColumnName(const ::rtl::OUString & rColumnName, const ::rtl::OUString & rTableRange);
        // [TableRange kann leer sein, wenn nicht angegeben]

        // Bei Selektionskriterien werden (selbst bei einem einfachen Praedikat)
        // folgende "set"-Funktionen in der angegebenen Reihenfolge aufgerufen:
        //
        //          setORCriteriaPre
        //          |
        //          |   setANDCriteriaPre
        //          |   |   setPredicate
        //          |   |   [weitere setPredicate-Aufrufe] ...
        //          |   setANDCriteriaPost
        //          |
        //          |   ... [weitere setANDCriteriaPre/Post-Paare und darin setPredicate-Aufrufe]
        //          |
        //          setORCriteriaPost
        //
        // Die AND-Verknuepfungen sind also implizit ODER-Verknuepft. setORCriteriaPre und
        // setORCriteriaPost werden jeweils nur ein einziges Mal aufgerufen (sind also
        // eigentlich ziemlich ueberfluessig, da man diese Aktionen auch vor bzw. nach dem
        // traverse-Aufruf erledigen kann)!
        //
        void traverseSelectionCriteria(const OSQLParseNode* pSelectNode);
        virtual void setORCriteriaPre();
        virtual void setORCriteriaPost();
        virtual void setANDCriteriaPre();
        virtual void setANDCriteriaPost();
        virtual void setPredicate(const ::rtl::OUString & rColumnName,
                                  const ::rtl::OUString & rTableRange,
                                  sal_Int32 ePredicateType,
                                  const ::rtl::OUString & rValue,
                                  const ::rtl::OUString & rParameterName);


        // Erweiterung auf UPDATE- und INSERT-Statement ... (nyi):
        void traverseAssignments();
        virtual void setAssign(const ::rtl::OUString & rColumnName,
                               const ::rtl::OUString & rValue, sal_Bool bsetNull,
                               const ::rtl::OUString & rParameterName);

        // Alle "traverse"-Routinen hintereinander aufrufen. Je nach Statement-Typ:
        // Bei UPDATE und INSERT-Statement nur traverseTableNames und traverseAssignments,
        // bei DELETE nur traverseTableNames und bei SELECT-Statement
        // in der Reihenfolge: traverseTableNames, traverseSelectColumnNames,
        // traverseOrderByColumnNames, traverseSelectionCriteria.
        // Bricht bei irgendwelchen Fehlern sofort ab und liefert entsprechenden
        // Status.
        void traverseAll();

        // Die TableRangeMap enth"alt alle Tabellen unter dem zugeh"origen Rangenamen der zuerst gefunden wird
        const OSQLTables& getTables() const { return m_aTables;}

        ::vos::ORef<OSQLColumns> getSelectColumns() const { return m_aSelectColumns;}
        ::vos::ORef<OSQLColumns> getGroupColumns() const { return m_aGroupColumns;}
        ::vos::ORef<OSQLColumns> getOrderColumns() const { return m_aOrderColumns;}
        ::vos::ORef<OSQLColumns> getParameters()    const { return m_aParameters; }
        ::vos::ORef<OSQLColumns> getCreateColumns() const { return m_aCreateColumns;}

        /** return the columname and the table range
            @param  _pColumnRef
                The column ref parse node.
            @param  _rColumnName
                The column name to be set.
            @param  _rTableRange
                The table range to be set.
        */
        void getColumnRange(    const OSQLParseNode* _pColumnRef,
                                ::rtl::OUString &_rColumnName,
                                ::rtl::OUString& _rTableRange) const;

        /** return the alias name of a column
            @param  _pDerivedColumn
                The parse node where SQL_ISRULE(_pDerivedColumn,derived_column) must be true
            @return
                The alias name of the column or an empty string.
        */
        static ::rtl::OUString getColumnAlias(const OSQLParseNode* _pDerivedColumn);
        // gibt den Columnnamen und die Tablerange (falls vorhanden) zur"uck

        /** return the columname and the table range
            @param  _pColumnRef
                The column ref parse node.
            @param  _xMetaData
                The database meta data.
            @param  _rColumnName
                The column name to be set.
            @param  _rTableRange
                The table range to be set.
        */
        static void getColumnRange( const OSQLParseNode* _pColumnRef,
                                    const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData>& _xMetaData,
                                    ::rtl::OUString &_rColumnName,
                                    ::rtl::OUString& _rTableRange);

        // Ermittelt fuer eine Funktion, Spalten den zugehoeren TableRange,
        // wenn nicht eindeutig, dann leer
        sal_Bool getColumnTableRange(const OSQLParseNode* pNode, ::rtl::OUString &rTableRange) const;

        // return true when the tableNode is a rule like catalog_name, schema_name or table_name
        sal_Bool isTableNode(const OSQLParseNode* _pTableNode) const;
    };
}

#endif // _CONNECTIVITY_PARSE_SQLITERATOR_HXX_