Debian Codegraph @

ogr/ogrsf_frmts/oci/ogr_oci.h

raw
1 /******************************************************************************
2 *
3 * Project: Oracle Spatial Driver
4 * Purpose: Oracle Spatial OGR Driver Declarations.
5 * Author: Frank Warmerdam <[email protected]>
6 *
7 ******************************************************************************
8 * Copyright (c) 2002, Frank Warmerdam <[email protected]>
9 *
10 * SPDX-License-Identifier: MIT
11 ****************************************************************************/
12
13 #ifndef OGR_OCI_H_INCLUDED
14 #define OGR_OCI_H_INCLUDED
15
16 #include "ogrsf_frmts.h"
17 #include "oci.h"
18 #include "cpl_error.h"
19
20 #include <map>
21 #include <set>
22
23 /* -------------------------------------------------------------------- */
24 /* Low level Oracle spatial declarations. */
25 /* -------------------------------------------------------------------- */
26 #define TYPE_OWNER "MDSYS"
27 #define SDO_GEOMETRY "MDSYS.SDO_GEOMETRY"
28
29 typedef struct
30 {
31 OCINumber x;
32 OCINumber y;
33 OCINumber z;
34 } sdo_point_type;
35
36 typedef OCIArray sdo_elem_info_array;
37 typedef OCIArray sdo_ordinate_array;
38
39 typedef struct
40 {
41 OCINumber sdo_gtype;
42 OCINumber sdo_srid;
43 sdo_point_type sdo_point;
44 OCIArray *sdo_elem_info;
45 OCIArray *sdo_ordinates;
46 } SDO_GEOMETRY_TYPE;
47
48 typedef struct
49 {
50 OCIInd _atomic;
51 OCIInd x;
52 OCIInd y;
53 OCIInd z;
54 } sdo_point_type_ind;
55
56 typedef struct
57 {
58 OCIInd _atomic;
59 OCIInd sdo_gtype;
60 OCIInd sdo_srid;
61 sdo_point_type_ind sdo_point;
62 OCIInd sdo_elem_info;
63 OCIInd sdo_ordinates;
64 } SDO_GEOMETRY_ind;
65
66 #define ORA_GTYPE_MATCH(a, b) (((a) % 100) == ((b) % 100))
67 #define ORA_GTYPE_UNKNOWN 0
68 #define ORA_GTYPE_POINT 1
69 #define ORA_GTYPE_LINESTRING 2 // or curve
70 #define ORA_GTYPE_POLYGON 3 // or surface
71 #define ORA_GTYPE_COLLECTION 4
72 #define ORA_GTYPE_MULTIPOINT 5
73 #define ORA_GTYPE_MULTILINESTRING 6 // or multicurve
74 #define ORA_GTYPE_MULTIPOLYGON 7 // or multisurface
75 #define ORA_GTYPE_SOLID 8
76 #define ORA_GTYPE_MULTISOLID 9
77
78 #define DEFAULT_STRING_SIZE 4000
79
80 /************************************************************************/
81 /* OGROCISession */
82 /************************************************************************/
83 class CPL_DLL OGROCISession final
84 {
85 public:
86 OCIEnv *hEnv;
87 OCIError *hError;
88 OCISvcCtx *hSvcCtx;
89 OCIServer *hServer;
90 OCISession *hSession;
91 OCIDescribe *hDescribe;
92 OCIType *hGeometryTDO;
93 OCIType *hOrdinatesTDO;
94 OCIType *hElemInfoTDO;
95
96 char *pszUserid;
97 char *pszPassword;
98 char *pszDatabase;
99
100 public:
101 OGROCISession();
102 ~OGROCISession();
103
104 int EstablishSession(const char *pszUserid, const char *pszPassword,
105 const char *pszDatabase);
106
107 int Failed(sword nStatus, const char *pszFunction = nullptr);
108
109 CPLErr GetParamInfo(OCIParam *hParamDesc, OGRFieldDefn *poOGRDefn,
110 ub2 *pnOCIType, ub4 *pnOCILen);
111
112 void CleanName(char *);
113
114 OCIType *PinTDO(const char *);
115
116 private:
117 int nServerVersion;
118 int nServerRelease;
119 size_t nMaxNameLength;
120 };
121
122 OGROCISession CPL_DLL *OGRGetOCISession(const char *pszUserid,
123 const char *pszPassword,
124 const char *pszDatabase);
125
126 /************************************************************************/
127 /* OGROCIStatement */
128 /************************************************************************/
129 class CPL_DLL OGROCIStatement final
130 {
131 public:
132 explicit OGROCIStatement(OGROCISession *);
133 ~OGROCIStatement();
134
135 OCIStmt *GetStatement()
136 {
137 return hStatement;
138 }
139
140 CPLErr BindScalar(const char *pszPlaceName, void *pData, int nDataLen,
141 int nSQLType, sb2 *paeInd = nullptr);
142 CPLErr BindString(const char *pszPlaceName, const char *pszData,
143 sb2 *paeInd = nullptr);
144 CPLErr BindObject(const char *pszPlaceName, void *pahObject, OCIType *hTDO,
145 void **papIndicators);
146
147 char *pszCommandText;
148
149 CPLErr Prepare(const char *pszStatement);
150 CPLErr Execute(const char *pszStatement, int nMode = -1);
151 void Clean();
152
153 OGRFeatureDefn *GetResultDefn()
154 {
155 return poDefn;
156 }
157
158 char **SimpleFetchRow();
159
160 int GetAffectedRows() const
161 {
162 return nAffectedRows;
163 }
164
165 private:
166 OGROCISession *poSession;
167 OCIStmt *hStatement;
168
169 OGRFeatureDefn *poDefn;
170
171 char **papszCurColumn;
172 char **papszCurImage;
173 sb2 *panCurColumnInd;
174
175 int nRawColumnCount;
176 int *panFieldMap;
177 int nAffectedRows;
178 };
179
180 /************************************************************************/
181 /* OGROCIStringBuf */
182 /************************************************************************/
183 class OGROCIStringBuf final
184 {
185 char *pszString;
186 int nLen;
187 int nBufSize;
188
189 void UpdateEnd();
190
191 public:
192 OGROCIStringBuf();
193 ~OGROCIStringBuf();
194
195 void MakeRoomFor(int);
196 void Append(const char *);
197 void Appendf(int nMax, const char *pszFormat, ...)
198 CPL_PRINT_FUNC_FORMAT(3, 4);
199 char *StealString();
200
201 char GetLast();
202
203 char *GetEnd()
204 {
205 UpdateEnd();
206 return pszString + nLen;
207 }
208
209 char *GetString()
210 {
211 return pszString;
212 }
213
214 void Clear();
215 };
216
217 /************************************************************************/
218 /* OGROCILayer */
219 /************************************************************************/
220
221 class OGROCIDataSource;
222
223 class OGROCILayer CPL_NON_FINAL : public OGRLayer
224 {
225 protected:
226 OGROCIDataSource *poDS;
227
228 OGRFeatureDefn *poFeatureDefn;
229
230 int iNextShapeId;
231
232 char *pszQueryStatement;
233
234 int nResultOffset;
235
236 OGROCIStatement *poStatement;
237
238 int ExecuteQuery(const char *);
239
240 SDO_GEOMETRY_TYPE *hLastGeom;
241 SDO_GEOMETRY_ind *hLastGeomInd;
242
243 char *pszGeomName;
244 int iGeomColumn;
245
246 char *pszFIDName;
247 int iFIDColumn;
248
249 std::set<int> setFieldIndexWithTimeStampWithTZ{};
250
251 OGRGeometry *TranslateGeometry();
252 OGRGeometry *TranslateGeometryElement(int *piElement, int nGType,
253 int nDimension, int nEType,
254 int nInterpretation,
255 int nStartOrdinal, int nOrdCount);
256 int LoadElementInfo(int iElement, int nElemCount, int nTotalOrdCount,
257 int *pnEType, int *pnInterpretation,
258 int *pnStartOrdinal, int *pnElemOrdCount);
259 int GetOrdinalPoint(int iOrdinal, int nDimension, double *pdfX,
260 double *pdfY, double *pdfZ);
261
262 public:
263 explicit OGROCILayer(OGROCIDataSource *poDSIn);
264 ~OGROCILayer() override;
265
266 virtual int FindFieldIndex(const char *pszFieldName,
267 int bExactMatch) override
268 {
269 return OGRLayer::FindFieldIndex(pszFieldName, bExactMatch);
270 }
271
272 void ResetReading() override;
273 virtual OGRFeature *GetNextRawFeature();
274 OGRFeature *GetNextFeature() override;
275
276 using OGRLayer::GetLayerDefn;
277
278 const OGRFeatureDefn *GetLayerDefn() const override
279 {
280 return poFeatureDefn;
281 }
282
283 int TestCapability(const char *) const override;
284
285 const char *GetFIDColumn() const override;
286 const char *GetGeometryColumn() const override;
287
288 GDALDataset *GetDataset() override;
289
290 int LookupTableSRID();
291 };
292
293 /************************************************************************/
294 /* OGROCIWritableLayer */
295 /************************************************************************/
296
297 class OGROCIWritableLayer CPL_NON_FINAL : public OGROCILayer
298 {
299 protected:
300 int nDimension;
301 int nSRID;
302
303 int nOrdinalCount;
304 int nOrdinalMax;
305 double *padfOrdinals;
306
307 int nElemInfoCount;
308 int nElemInfoMax;
309 int *panElemInfo;
310
311 void PushOrdinal(double);
312 void PushElemInfo(int, int, int);
313
314 OGRErr TranslateToSDOGeometry(OGRGeometry *, int *pnGType);
315 OGRErr TranslateElementGroup(OGRGeometry *poGeometry);
316
317 int bLaunderColumnNames;
318 int bPreservePrecision;
319 int nDefaultStringSize;
320
321 OGRSpatialReferenceRefCountedPtr poSRS{};
322
323 char **papszOptions;
324
325 int bTruncationReported;
326 void ReportTruncation(OGRFieldDefn *);
327
328 void ParseDIMINFO(const char *, double *, double *, double *);
329
330 explicit OGROCIWritableLayer(OGROCIDataSource *poDSIn);
331 ~OGROCIWritableLayer() override;
332
333 public:
334 const OGRSpatialReference *GetSpatialRef() const override
335 {
336 return poSRS.get();
337 }
338
339 virtual OGRErr CreateField(const OGRFieldDefn *poField,
340 int bApproxOK = TRUE) override;
341 virtual int FindFieldIndex(const char *pszFieldName,
342 int bExactMatch) override;
343
344 // following methods are not base class overrides
345 void SetOptions(CSLConstList);
346
347 void SetDimension(int);
348
349 void SetLaunderFlag(int bFlag)
350 {
351 bLaunderColumnNames = bFlag;
352 }
353
354 void SetPrecisionFlag(int bFlag)
355 {
356 bPreservePrecision = bFlag;
357 }
358
359 void SetDefaultStringSize(int nSize)
360 {
361 nDefaultStringSize = nSize;
362 }
363 };
364
365 /************************************************************************/
366 /* OGROCILoaderLayer */
367 /************************************************************************/
368
369 #define LDRM_UNKNOWN 0
370 #define LDRM_STREAM 1
371 #define LDRM_VARIABLE 2
372 #define LDRM_BINARY 3
373
374 class OGROCILoaderLayer final : public OGROCIWritableLayer
375 {
376 OGREnvelope sExtent;
377 int iNextFIDToWrite;
378
379 char *pszLoaderFilename;
380
381 FILE *fpLoader;
382 int bHeaderWritten;
383
384 FILE *fpData;
385
386 int nLDRMode;
387
388 void WriteLoaderHeader();
389 void FinalizeNewLayer();
390
391 OGRErr WriteFeatureStreamMode(OGRFeature *);
392 OGRErr WriteFeatureVariableMode(OGRFeature *);
393
394 static OGRErr WriteFeatureBinaryMode(OGRFeature *);
395
396 public:
397 OGROCILoaderLayer(OGROCIDataSource *, const char *pszName,
398 const char *pszGeomCol, int nSRID,
399 const char *pszLoaderFile);
400 ~OGROCILoaderLayer() override;
401
402 void ResetReading() override;
403 GIntBig GetFeatureCount(int) override;
404
405 OGRErr SetAttributeFilter(const char *) override
406 {
407 return OGRERR_UNSUPPORTED_OPERATION;
408 }
409
410 OGRFeature *GetNextFeature() override;
411
412 OGRErr ICreateFeature(OGRFeature *poFeature) override;
413
414 int TestCapability(const char *) const override;
415 };
416
417 /************************************************************************/
418 /* OGROCITableLayer */
419 /************************************************************************/
420
421 class OGROCITableLayer final : public OGROCIWritableLayer
422 {
423 int bUpdateAccess;
424 int bNewLayer;
425 OGREnvelope sExtent;
426 bool bExtentUpdated;
427
428 int iNextFIDToWrite;
429 int bHaveSpatialIndex;
430
431 OGRFeatureDefn *ReadTableDefinition(const char *);
432
433 void BuildWhere();
434 char *BuildFields();
435 void BuildFullQueryStatement();
436
437 char *pszQuery;
438 char *pszWHERE;
439
440 int bValidTable;
441
442 CPLString osTableName;
443 CPLString osOwner;
444
445 int nFirstId;
446 int nMultiLoadCount;
447 int bMultiLoad;
448
449 OCIArray *hOrdVARRAY;
450 OCIArray *hElemInfoVARRAY;
451
452 void UpdateLayerExtents();
453 void CreateSpatialIndex();
454
455 void TestForSpatialIndex(const char *);
456
457 OGROCIStatement *poBoundStatement;
458
459 int nWriteCacheMax;
460 int nWriteCacheUsed;
461
462 SDO_GEOMETRY_TYPE *pasWriteGeoms;
463 SDO_GEOMETRY_TYPE **papsWriteGeomMap;
464 SDO_GEOMETRY_ind *pasWriteGeomInd;
465 SDO_GEOMETRY_ind **papsWriteGeomIndMap;
466
467 void **papWriteFields;
468 OCIInd **papaeWriteFieldInd;
469 int *panWriteFIDs;
470
471 int AllocAndBindForWrite();
472 OGRErr FlushPendingFeatures();
473
474 OGRErr UnboundCreateFeature(OGRFeature *poFeature);
475 OGRErr BoundCreateFeature(OGRFeature *poFeature);
476
477 public:
478 OGROCITableLayer(OGROCIDataSource *, const char *pszName,
479 OGRwkbGeometryType eGType, int nSRID, int bUpdate,
480 int bNew);
481 ~OGROCITableLayer() override;
482
483 void ResetReading() override;
484 GIntBig GetFeatureCount(int) override;
485
486 OGRErr ISetSpatialFilter(int iGeomField,
487 const OGRGeometry *poGeom) override;
488
489 OGRErr SetAttributeFilter(const char *) override;
490
491 OGRFeature *GetNextFeature() override;
492 OGRFeature *GetFeature(GIntBig nFeatureId) override;
493
494 OGRErr ISetFeature(OGRFeature *poFeature) override;
495 OGRErr ICreateFeature(OGRFeature *poFeature) override;
496 OGRErr DeleteFeature(GIntBig nFID) override;
497
498 OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,
499 bool bForce) override;
500
501 int TestCapability(const char *) const override;
502
503 OGRErr SyncToDisk() override;
504
505 // following methods are not base class overrides
506 int IsValid()
507 {
508 return bValidTable;
509 }
510
511 int GetMaxFID();
512 };
513
514 /************************************************************************/
515 /* OGROCISelectLayer */
516 /************************************************************************/
517
518 class OGROCISelectLayer final : public OGROCILayer
519 {
520 OGRFeatureDefn *ReadTableDefinition(OGROCIStatement *poStatement);
521
522 public:
523 OGROCISelectLayer(OGROCIDataSource *, const char *pszName,
524 OGROCIStatement *poStatement);
525 ~OGROCISelectLayer() override;
526 };
527
528 /************************************************************************/
529 /* OGROCIDataSource */
530 /************************************************************************/
531
532 class OGROCIDataSource final : public GDALDataset
533 {
534 OGROCILayer **papoLayers;
535 int nLayers;
536
537 char *pszDBName;
538
539 int bDSUpdate;
540 int bNoLogging;
541
542 OGROCISession *poSession;
543
544 // We maintain a list of known SRID to reduce the number of trips to
545 // the database to get SRSes.
546 std::map<int, OGRSpatialReferenceRefCountedPtr> m_oSRSCache{};
547
548 public:
549 OGROCIDataSource();
550 ~OGROCIDataSource() override;
551
552 OGROCISession *GetSession()
553 {
554 return poSession;
555 }
556
557 int Open(const char *, char **papszOpenOptionsIn, int bUpdate,
558 int bTestOpen);
559 int OpenTable(const char *pszTableName, int nSRID, int bUpdate,
560 int bTestOpen, char **papszOpenOptionsIn);
561
562 int GetLayerCount() const override
563 {
564 return nLayers;
565 }
566
567 const OGRLayer *GetLayer(int) const override;
568 OGRLayer *GetLayerByName(const char *pszName) override;
569
570 OGRErr DeleteLayer(int) override;
571
572 OGRLayer *ICreateLayer(const char *pszName,
573 const OGRGeomFieldDefn *poGeomFieldDefn,
574 CSLConstList papszOptions) override;
575
576 int TestCapability(const char *) const override;
577
578 void DeleteLayer(const char *);
579
580 void TruncateLayer(const char *);
581 void ValidateLayer(const char *);
582
583 OGRLayer *ExecuteSQL(const char *pszSQLCommand,
584 OGRGeometry *poSpatialFilter,
585 const char *pszDialect) override;
586 void ReleaseResultSet(OGRLayer *poLayer) override;
587
588 int FetchSRSId(const OGRSpatialReference *poSRS);
589 OGRSpatialReferenceRefCountedPtr FetchSRS(int nSRID);
590 };
591
592 /* -------------------------------------------------------------------- */
593 /* Helper functions. */
594 /* -------------------------------------------------------------------- */
595 int OGROCIStrokeArcToOGRGeometry_Points(double dfStartX, double dfStartY,
596 double dfAlongX, double dfAlongY,
597 double dfEndX, double dfEndY,
598 double dfMaxAngleStepSizeDegrees,
599 int bForceWholeCircle,
600 OGRLineString *poLine);
601
602 #endif /* ndef OGR_OCI_H_INCLUDED */