/******************************************************************************
 *
 * Project:  OpenGIS Simple Features Reference Implementation
 * Purpose:  Run SQL requests with SQLite SQL engine
 * Author:   Even Rouault, even dot rouault at spatialys.com
 *
 ******************************************************************************
 * Copyright (c) 2012-2013, Even Rouault <even dot rouault at spatialys.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/

#include "ogr_sqlite.h"
#include "ogrsqliteexecutesql.h"
#include "ogrsqlitevirtualogr.h"
#include "ogrsqliteutility.h"

#include <cctype>
#include <cstdio>
#include <cstring>

#include "cpl_conv.h"
#include "cpl_error.h"
#include "cpl_multiproc.h"
#include "cpl_port.h"
#include "cpl_string.h"
#include "cpl_vsi.h"
#include "gdal_priv.h"
#include "ogr_api.h"
#include "ogr_core.h"
#include "ogr_feature.h"
#include "ogr_geometry.h"
#include "ogr_spatialref.h"
#include "sqlite3.h"

/************************************************************************/
/*                       OGR2SQLITEExtractUnquotedString()              */
/************************************************************************/

static CPLString OGR2SQLITEExtractUnquotedString(const char **ppszSQLCommand)
{
    CPLString osRet;
    const char *pszSQLCommand = *ppszSQLCommand;
    if (*pszSQLCommand == '"' || *pszSQLCommand == '\'')
    {
        const char chQuoteChar = *pszSQLCommand;
        pszSQLCommand++;

        while (*pszSQLCommand != '\0')
        {
            if (*pszSQLCommand == chQuoteChar &&
                pszSQLCommand[1] == chQuoteChar)
            {
                pszSQLCommand++;
                osRet += chQuoteChar;
            }
            else if (*pszSQLCommand == chQuoteChar)
            {
                pszSQLCommand++;
                break;
            }
            else
                osRet += *pszSQLCommand;

            pszSQLCommand++;
        }
    }
    else
    {
        bool bNotATableName = false;
        char chQuoteChar = 0;
        int nParenthesisLevel = 0;
        while (*pszSQLCommand != '\0')
        {
            if (*pszSQLCommand == chQuoteChar &&
                pszSQLCommand[1] == chQuoteChar)
            {
                osRet += *pszSQLCommand;
                pszSQLCommand++;
            }
            else if (*pszSQLCommand == chQuoteChar)
            {
                chQuoteChar = 0;
            }
            else if (chQuoteChar == 0)
            {
                if (*pszSQLCommand == '(')
                {
                    bNotATableName = true;
                    nParenthesisLevel++;
                }
                else if (*pszSQLCommand == ')')
                {
                    nParenthesisLevel--;
                    if (nParenthesisLevel < 0)
                        break;
                }
                else if (*pszSQLCommand == '"' || *pszSQLCommand == '\'')
                {
                    chQuoteChar = *pszSQLCommand;
                }
                else if (nParenthesisLevel == 0 &&
                         (isspace((int)*pszSQLCommand) ||
                          *pszSQLCommand == '.' || *pszSQLCommand == ','))
                {
                    break;
                }
            }

            osRet += *pszSQLCommand;
            pszSQLCommand++;
        }
        if (bNotATableName)
            osRet.clear();
    }

    *ppszSQLCommand = pszSQLCommand;

    return osRet;
}

/************************************************************************/
/*                      OGR2SQLITEExtractLayerDesc()                    */
/************************************************************************/

static LayerDesc OGR2SQLITEExtractLayerDesc(const char **ppszSQLCommand)
{
    CPLString osStr;
    const char *pszSQLCommand = *ppszSQLCommand;
    LayerDesc oLayerDesc;

    while (isspace((int)*pszSQLCommand))
        pszSQLCommand++;

    const char *pszOriginalStrStart = pszSQLCommand;
    oLayerDesc.osOriginalStr = pszSQLCommand;

    osStr = OGR2SQLITEExtractUnquotedString(&pszSQLCommand);

    if (*pszSQLCommand == '.')
    {
        oLayerDesc.osDSName = osStr;
        pszSQLCommand++;
        oLayerDesc.osLayerName =
            OGR2SQLITEExtractUnquotedString(&pszSQLCommand);
    }
    else
    {
        oLayerDesc.osLayerName = osStr;
    }

    oLayerDesc.osOriginalStr.resize(pszSQLCommand - pszOriginalStrStart);

    *ppszSQLCommand = pszSQLCommand;

    return oLayerDesc;
}

/************************************************************************/
/*                           OGR2SQLITEAddLayer()                       */
/************************************************************************/

static void OGR2SQLITEAddLayer(const char *&pszStart, int &nNum,
                               const char *&pszSQLCommand,
                               std::set<LayerDesc> &oSet,
                               CPLString &osModifiedSQL)
{
    CPLString osTruncated(pszStart);
    osTruncated.resize(pszSQLCommand - pszStart);
    osModifiedSQL += osTruncated;
    pszStart = pszSQLCommand;
    LayerDesc oLayerDesc = OGR2SQLITEExtractLayerDesc(&pszSQLCommand);
    bool bInsert = true;
    if (oLayerDesc.osDSName.empty())
    {
        osTruncated = pszStart;
        osTruncated.resize(pszSQLCommand - pszStart);
        osModifiedSQL += osTruncated;
    }
    else
    {
        std::set<LayerDesc>::iterator oIter = oSet.find(oLayerDesc);
        if (oIter == oSet.end())
        {
            oLayerDesc.osSubstitutedName =
                CPLString().Printf("_OGR_%d", nNum++);
            osModifiedSQL += "\"";
            osModifiedSQL += oLayerDesc.osSubstitutedName;
            osModifiedSQL += "\"";
        }
        else
        {
            osModifiedSQL += (*oIter).osSubstitutedName;
            bInsert = false;
        }
    }
    if (bInsert)
    {
        oSet.insert(oLayerDesc);
    }
    pszStart = pszSQLCommand;
}

/************************************************************************/
/*                         StartsAsSQLITEKeyWord()                      */
/************************************************************************/

static const char *const apszKeywords[] = {
    "WHERE", "GROUP", "ORDER", "JOIN", "UNION", "INTERSECT", "EXCEPT", "LIMIT"};

static int StartsAsSQLITEKeyWord(const char *pszStr)
{
    for (int i = 0; i < (int)(sizeof(apszKeywords) / sizeof(char *)); i++)
    {
        if (EQUALN(pszStr, apszKeywords[i], strlen(apszKeywords[i])))
            return TRUE;
    }
    return FALSE;
}

/************************************************************************/
/*                     OGR2SQLITEGetPotentialLayerNames()               */
/************************************************************************/

static void OGR2SQLITEGetPotentialLayerNamesInternal(
    const char **ppszSQLCommand, std::set<LayerDesc> &oSetLayers,
    std::set<CPLString> &oSetSpatialIndex, CPLString &osModifiedSQL, int &nNum)
{
    const char *pszSQLCommand = *ppszSQLCommand;
    const char *pszStart = pszSQLCommand;
    char ch = '\0';
    int nParenthesisLevel = 0;
    bool bLookforFTableName = false;

    while ((ch = *pszSQLCommand) != '\0')
    {
        if (ch == '(')
            nParenthesisLevel++;
        else if (ch == ')')
        {
            nParenthesisLevel--;
            if (nParenthesisLevel < 0)
            {
                pszSQLCommand++;
                break;
            }
        }

        /* Skip literals and strings */
        if (ch == '\'' || ch == '"')
        {
            char chEscapeChar = ch;
            pszSQLCommand++;
            while ((ch = *pszSQLCommand) != '\0')
            {
                if (ch == chEscapeChar && pszSQLCommand[1] == chEscapeChar)
                    pszSQLCommand++;
                else if (ch == chEscapeChar)
                {
                    pszSQLCommand++;
                    break;
                }
                pszSQLCommand++;
            }
        }

        else if (STARTS_WITH_CI(pszSQLCommand, "ogr_layer_"))
        {
            while (*pszSQLCommand != '\0' && *pszSQLCommand != '(')
                pszSQLCommand++;

            if (*pszSQLCommand != '(')
                break;

            pszSQLCommand++;
            nParenthesisLevel++;

            while (isspace((int)*pszSQLCommand))
                pszSQLCommand++;

            OGR2SQLITEAddLayer(pszStart, nNum, pszSQLCommand, oSetLayers,
                               osModifiedSQL);
        }

        else if (bLookforFTableName &&
                 STARTS_WITH_CI(pszSQLCommand, "f_table_name") &&
                 (pszSQLCommand[strlen("f_table_name")] == '=' ||
                  isspace((int)pszSQLCommand[strlen("f_table_name")])))
        {
            pszSQLCommand += strlen("f_table_name");

            while (isspace((int)*pszSQLCommand))
                pszSQLCommand++;

            if (*pszSQLCommand == '=')
            {
                pszSQLCommand++;

                while (isspace((int)*pszSQLCommand))
                    pszSQLCommand++;

                oSetSpatialIndex.insert(
                    OGR2SQLITEExtractUnquotedString(&pszSQLCommand));
            }

            bLookforFTableName = false;
        }

        else if (STARTS_WITH_CI(pszSQLCommand, "FROM") &&
                 isspace(pszSQLCommand[strlen("FROM")]))
        {
            pszSQLCommand += strlen("FROM") + 1;

            while (isspace((int)*pszSQLCommand))
                pszSQLCommand++;

            if (STARTS_WITH_CI(pszSQLCommand, "SpatialIndex") &&
                isspace((int)pszSQLCommand[strlen("SpatialIndex")]))
            {
                pszSQLCommand += strlen("SpatialIndex") + 1;

                bLookforFTableName = true;

                continue;
            }

            if (*pszSQLCommand == '(')
            {
                pszSQLCommand++;

                CPLString osTruncated(pszStart);
                osTruncated.resize(pszSQLCommand - pszStart);
                osModifiedSQL += osTruncated;

                OGR2SQLITEGetPotentialLayerNamesInternal(
                    &pszSQLCommand, oSetLayers, oSetSpatialIndex, osModifiedSQL,
                    nNum);

                pszStart = pszSQLCommand;
            }
            else
                OGR2SQLITEAddLayer(pszStart, nNum, pszSQLCommand, oSetLayers,
                                   osModifiedSQL);

            while (*pszSQLCommand != '\0')
            {
                if (isspace((int)*pszSQLCommand))
                {
                    pszSQLCommand++;
                    while (isspace((int)*pszSQLCommand))
                        pszSQLCommand++;

                    if (STARTS_WITH_CI(pszSQLCommand, "AS"))
                    {
                        pszSQLCommand += 2;
                        while (isspace((int)*pszSQLCommand))
                            pszSQLCommand++;
                    }

                    /* Skip alias */
                    if (*pszSQLCommand != '\0' && *pszSQLCommand != ',')
                    {
                        if (StartsAsSQLITEKeyWord(pszSQLCommand))
                            break;
                        OGR2SQLITEExtractUnquotedString(&pszSQLCommand);
                    }
                }
                else if (*pszSQLCommand == ',')
                {
                    pszSQLCommand++;
                    while (isspace((int)*pszSQLCommand))
                        pszSQLCommand++;

                    if (*pszSQLCommand == '(')
                    {
                        pszSQLCommand++;

                        CPLString osTruncated(pszStart);
                        osTruncated.resize(pszSQLCommand - pszStart);
                        osModifiedSQL += osTruncated;

                        OGR2SQLITEGetPotentialLayerNamesInternal(
                            &pszSQLCommand, oSetLayers, oSetSpatialIndex,
                            osModifiedSQL, nNum);

                        pszStart = pszSQLCommand;
                    }
                    else
                        OGR2SQLITEAddLayer(pszStart, nNum, pszSQLCommand,
                                           oSetLayers, osModifiedSQL);
                }
                else
                    break;
            }
        }
        else if (STARTS_WITH_CI(pszSQLCommand, "JOIN") &&
                 isspace(pszSQLCommand[strlen("JOIN")]))
        {
            pszSQLCommand += strlen("JOIN") + 1;
            OGR2SQLITEAddLayer(pszStart, nNum, pszSQLCommand, oSetLayers,
                               osModifiedSQL);
        }
        else if (STARTS_WITH_CI(pszSQLCommand, "INTO") &&
                 isspace(pszSQLCommand[strlen("INTO")]))
        {
            pszSQLCommand += strlen("INTO") + 1;
            OGR2SQLITEAddLayer(pszStart, nNum, pszSQLCommand, oSetLayers,
                               osModifiedSQL);
        }
        else if (STARTS_WITH_CI(pszSQLCommand, "UPDATE") &&
                 isspace(pszSQLCommand[strlen("UPDATE")]))
        {
            pszSQLCommand += strlen("UPDATE") + 1;
            OGR2SQLITEAddLayer(pszStart, nNum, pszSQLCommand, oSetLayers,
                               osModifiedSQL);
        }
        else if (STARTS_WITH_CI(pszSQLCommand, "DROP TABLE "))
        {
            pszSQLCommand += strlen("DROP TABLE") + 1;
            OGR2SQLITEAddLayer(pszStart, nNum, pszSQLCommand, oSetLayers,
                               osModifiedSQL);
        }
        else
            pszSQLCommand++;
    }

    CPLString osTruncated(pszStart);
    osTruncated.resize(pszSQLCommand - pszStart);
    osModifiedSQL += osTruncated;

    *ppszSQLCommand = pszSQLCommand;
}

static void OGR2SQLITEGetPotentialLayerNames(
    const char *pszSQLCommand, std::set<LayerDesc> &oSetLayers,
    std::set<CPLString> &oSetSpatialIndex, CPLString &osModifiedSQL)
{
    int nNum = 1;
    OGR2SQLITEGetPotentialLayerNamesInternal(
        &pszSQLCommand, oSetLayers, oSetSpatialIndex, osModifiedSQL, nNum);
}

/************************************************************************/
/*                   OGRSQLiteGetReferencedLayers()                     */
/************************************************************************/

std::set<LayerDesc> OGRSQLiteGetReferencedLayers(const char *pszStatement)
{
    /* -------------------------------------------------------------------- */
    /*      Analyze the statement to determine which tables will be used.   */
    /* -------------------------------------------------------------------- */
    std::set<LayerDesc> oSetLayers;
    std::set<CPLString> oSetSpatialIndex;
    CPLString osModifiedSQL;
    OGR2SQLITEGetPotentialLayerNames(pszStatement, oSetLayers, oSetSpatialIndex,
                                     osModifiedSQL);

    return oSetLayers;
}

#ifndef HAVE_SQLITE3EXT_H
OGRLayer *OGRSQLiteExecuteSQL(GDALDataset *, const char *, OGRGeometry *,
                              const char *)
{
    CPLError(CE_Failure, CPLE_NotSupported,
             "SQL SQLite dialect not supported due to GDAL being built "
             "without sqlite3ext.h header");
    return nullptr;
}

#else

/************************************************************************/
/*                       OGRSQLiteExecuteSQLLayer                       */
/************************************************************************/

class OGRSQLiteExecuteSQLLayer final : public OGRSQLiteSelectLayer
{
    char *pszTmpDBName;

  public:
    OGRSQLiteExecuteSQLLayer(char *pszTmpDBName, OGRSQLiteDataSource *poDS,
                             const CPLString &osSQL, sqlite3_stmt *hStmt,
                             bool bUseStatementForGetNextFeature,
                             bool bEmptyLayer, bool bCanReopenBaseDS);
    virtual ~OGRSQLiteExecuteSQLLayer();
};

/************************************************************************/
/*                         OGRSQLiteExecuteSQLLayer()                   */
/************************************************************************/

OGRSQLiteExecuteSQLLayer::OGRSQLiteExecuteSQLLayer(
    char *pszTmpDBNameIn, OGRSQLiteDataSource *poDSIn, const CPLString &osSQL,
    sqlite3_stmt *hStmtIn, bool bUseStatementForGetNextFeature,
    bool bEmptyLayer, bool bCanReopenBaseDS)
    : OGRSQLiteSelectLayer(poDSIn, osSQL, hStmtIn,
                           bUseStatementForGetNextFeature, bEmptyLayer, true,
                           bCanReopenBaseDS),
      pszTmpDBName(pszTmpDBNameIn)
{
}

/************************************************************************/
/*                        ~OGRSQLiteExecuteSQLLayer()                   */
/************************************************************************/

OGRSQLiteExecuteSQLLayer::~OGRSQLiteExecuteSQLLayer()
{
    // This is a bit peculiar: we must "finalize" the OGRLayer, since
    // it has objects that depend on the datasource, that we are just
    // going to destroy afterwards. The issue here is that we destroy
    // our own datasource,
    Finalize();

    delete m_poDS;
    VSIUnlink(pszTmpDBName);
    CPLFree(pszTmpDBName);
}

/************************************************************************/
/*               OGR2SQLITE_IgnoreAllFieldsExceptGeometry()             */
/************************************************************************/

#ifdef HAVE_SPATIALITE
static void OGR2SQLITE_IgnoreAllFieldsExceptGeometry(OGRLayer *poLayer)
{
    char **papszIgnored = nullptr;
    papszIgnored = CSLAddString(papszIgnored, "OGR_STYLE");
    OGRFeatureDefn *poFeatureDefn = poLayer->GetLayerDefn();
    for (int i = 0; i < poFeatureDefn->GetFieldCount(); i++)
    {
        papszIgnored = CSLAddString(
            papszIgnored, poFeatureDefn->GetFieldDefn(i)->GetNameRef());
    }
    poLayer->SetIgnoredFields((const char **)papszIgnored);
    CSLDestroy(papszIgnored);
}
#endif

/************************************************************************/
/*                  OGR2SQLITEDealWithSpatialColumn()                   */
/************************************************************************/
#if HAVE_SPATIALITE
#define WHEN_SPATIALITE(arg) arg
#else
#define WHEN_SPATIALITE(arg)
#endif

static int OGR2SQLITEDealWithSpatialColumn(
    OGRLayer *poLayer, int iGeomCol, const LayerDesc &oLayerDesc,
    const CPLString &osTableName, OGRSQLiteDataSource *poSQLiteDS, sqlite3 *hDB,
    bool bSpatialiteDB, const std::set<LayerDesc> &WHEN_SPATIALITE(oSetLayers),
    const std::set<CPLString> &WHEN_SPATIALITE(oSetSpatialIndex))
{
    OGRGeomFieldDefn *poGeomField =
        poLayer->GetLayerDefn()->GetGeomFieldDefn(iGeomCol);
    CPLString osGeomColRaw;
    if (iGeomCol == 0)
        osGeomColRaw = OGR2SQLITE_GetNameForGeometryColumn(poLayer);
    else
        osGeomColRaw = poGeomField->GetNameRef();
    const char *pszGeomColRaw = osGeomColRaw.c_str();

    CPLString osGeomColEscaped(SQLEscapeLiteral(pszGeomColRaw));
    const char *pszGeomColEscaped = osGeomColEscaped.c_str();

    CPLString osLayerNameEscaped(SQLEscapeLiteral(osTableName));
    const char *pszLayerNameEscaped = osLayerNameEscaped.c_str();

    CPLString osIdxNameRaw(
        CPLSPrintf("idx_%s_%s", oLayerDesc.osLayerName.c_str(), pszGeomColRaw));
    CPLString osIdxNameEscaped(SQLEscapeName(osIdxNameRaw));

    /* Make sure that the SRS is injected in spatial_ref_sys */
    const OGRSpatialReference *poSRS = poGeomField->GetSpatialRef();
    if (iGeomCol == 0 && poSRS == nullptr)
        poSRS = poLayer->GetSpatialRef();
    int nSRSId = poSQLiteDS->GetUndefinedSRID();
    if (poSRS != nullptr)
        nSRSId = poSQLiteDS->FetchSRSId(poSRS);

    CPLString osSQL;
#ifdef HAVE_SPATIALITE
    bool bCreateSpatialIndex = false;
#endif
    if (!bSpatialiteDB)
    {
        osSQL.Printf("INSERT INTO geometry_columns (f_table_name, "
                     "f_geometry_column, geometry_format, geometry_type, "
                     "coord_dimension, srid) "
                     "VALUES ('%s','%s','SpatiaLite',%d,%d,%d)",
                     pszLayerNameEscaped, pszGeomColEscaped,
                     (int)wkbFlatten(poLayer->GetGeomType()),
                     wkbHasZ(poLayer->GetGeomType()) ? 3 : 2, nSRSId);
    }
#ifdef HAVE_SPATIALITE
    else
    {
        /* We detect the need for creating a spatial index by 2 means : */

        /* 1) if there's an explicit reference to a
         * 'idx_layername_geometrycolumn' */
        /*   table in the SQL --> old/traditional way of requesting spatial
         * indices */
        /*   with spatialite. */

        std::set<LayerDesc>::const_iterator oIter2 = oSetLayers.begin();
        for (; oIter2 != oSetLayers.end(); ++oIter2)
        {
            const LayerDesc &oLayerDescIter = *oIter2;
            if (EQUAL(oLayerDescIter.osLayerName, osIdxNameRaw))
            {
                bCreateSpatialIndex = true;
                break;
            }
        }

        /* 2) or if there's a SELECT FROM SpatialIndex WHERE f_table_name =
         * 'layername' */
        if (!bCreateSpatialIndex)
        {
            std::set<CPLString>::const_iterator oIter3 =
                oSetSpatialIndex.begin();
            for (; oIter3 != oSetSpatialIndex.end(); ++oIter3)
            {
                const CPLString &osNameIter = *oIter3;
                if (EQUAL(osNameIter, oLayerDesc.osLayerName))
                {
                    bCreateSpatialIndex = true;
                    break;
                }
            }
        }

        if (poSQLiteDS->HasSpatialite4Layout())
        {
            int nGeomType = poLayer->GetGeomType();
            int nCoordDimension = 2;
            if (wkbHasZ((OGRwkbGeometryType)nGeomType))
            {
                nGeomType += 1000;
                nCoordDimension = 3;
            }

            osSQL.Printf("INSERT INTO geometry_columns (f_table_name, "
                         "f_geometry_column, geometry_type, coord_dimension, "
                         "srid, spatial_index_enabled) "
                         "VALUES (Lower('%s'),Lower('%s'),%d ,%d ,%d, %d)",
                         pszLayerNameEscaped, pszGeomColEscaped, nGeomType,
                         nCoordDimension, nSRSId,
                         static_cast<int>(bCreateSpatialIndex));
        }
        else
        {
            const char *pszGeometryType =
                OGRToOGCGeomType(poLayer->GetGeomType());
            if (pszGeometryType[0] == '\0')
                pszGeometryType = "GEOMETRY";

            osSQL.Printf("INSERT INTO geometry_columns (f_table_name, "
                         "f_geometry_column, type, coord_dimension, "
                         "srid, spatial_index_enabled) "
                         "VALUES ('%s','%s','%s','%s',%d, %d)",
                         pszLayerNameEscaped, pszGeomColEscaped,
                         pszGeometryType,
                         wkbHasZ(poLayer->GetGeomType()) ? "XYZ" : "XY", nSRSId,
                         static_cast<int>(bCreateSpatialIndex));
        }
    }
#endif  // HAVE_SPATIALITE
    char *pszErrMsg = nullptr;
    int rc = sqlite3_exec(hDB, osSQL.c_str(), nullptr, nullptr, &pszErrMsg);
    if (pszErrMsg != nullptr)
    {
        CPLDebug("SQLITE", "%s -> %s", osSQL.c_str(), pszErrMsg);
        sqlite3_free(pszErrMsg);
    }

#ifdef HAVE_SPATIALITE
    /* -------------------------------------------------------------------- */
    /*      Should we create a spatial index ?.                             */
    /* -------------------------------------------------------------------- */
    if (!bSpatialiteDB || !bCreateSpatialIndex)
        return rc == SQLITE_OK;

    CPLDebug("SQLITE", "Create spatial index %s", osIdxNameRaw.c_str());

    /* ENABLE_VIRTUAL_OGR_SPATIAL_INDEX is not defined */
#ifdef ENABLE_VIRTUAL_OGR_SPATIAL_INDEX
    osSQL.Printf(
        "CREATE VIRTUAL TABLE \"%s\" USING "
        "VirtualOGRSpatialIndex(%d, '%s', pkid, xmin, xmax, ymin, ymax)",
        osIdxNameEscaped.c_str(), nExtraDS,
        SQLEscapeLiteral(oLayerDesc.osLayerName).c_str());

    rc = sqlite3_exec(hDB, osSQL.c_str(), NULL, NULL, NULL);
    if (rc != SQLITE_OK)
    {
        CPLDebug("SQLITE", "Error occurred during spatial index creation : %s",
                 sqlite3_errmsg(hDB));
    }
#else   //  ENABLE_VIRTUAL_OGR_SPATIAL_INDEX
    rc = sqlite3_exec(hDB, "BEGIN", nullptr, nullptr, nullptr);

    osSQL.Printf("CREATE VIRTUAL TABLE \"%s\" "
                 "USING rtree(pkid, xmin, xmax, ymin, ymax)",
                 osIdxNameEscaped.c_str());

    if (rc == SQLITE_OK)
        rc = sqlite3_exec(hDB, osSQL.c_str(), nullptr, nullptr, nullptr);

    sqlite3_stmt *hStmt = nullptr;
    if (rc == SQLITE_OK)
    {
        const char *pszInsertInto =
            CPLSPrintf("INSERT INTO \"%s\" (pkid, xmin, xmax, ymin, ymax) "
                       "VALUES (?,?,?,?,?)",
                       osIdxNameEscaped.c_str());
        rc = sqlite3_prepare_v2(hDB, pszInsertInto, -1, &hStmt, nullptr);
    }

    OGR2SQLITE_IgnoreAllFieldsExceptGeometry(poLayer);
    poLayer->ResetReading();

    OGRFeature *poFeature = nullptr;
    OGREnvelope sEnvelope;
    while (rc == SQLITE_OK &&
           (poFeature = poLayer->GetNextFeature()) != nullptr)
    {
        OGRGeometry *poGeom = poFeature->GetGeometryRef();
        if (poGeom != nullptr && !poGeom->IsEmpty())
        {
            poGeom->getEnvelope(&sEnvelope);
            sqlite3_bind_int64(hStmt, 1, (sqlite3_int64)poFeature->GetFID());
            sqlite3_bind_double(hStmt, 2, sEnvelope.MinX);
            sqlite3_bind_double(hStmt, 3, sEnvelope.MaxX);
            sqlite3_bind_double(hStmt, 4, sEnvelope.MinY);
            sqlite3_bind_double(hStmt, 5, sEnvelope.MaxY);
            rc = sqlite3_step(hStmt);
            if (rc == SQLITE_OK || rc == SQLITE_DONE)
                rc = sqlite3_reset(hStmt);
        }
        delete poFeature;
    }

    poLayer->SetIgnoredFields(nullptr);

    sqlite3_finalize(hStmt);

    if (rc == SQLITE_OK)
        rc = sqlite3_exec(hDB, "COMMIT", nullptr, nullptr, nullptr);
    else
    {
        CPLDebug("SQLITE", "Error occurred during spatial index creation : %s",
                 sqlite3_errmsg(hDB));
        rc = sqlite3_exec(hDB, "ROLLBACK", nullptr, nullptr, nullptr);
    }
#endif  //  ENABLE_VIRTUAL_OGR_SPATIAL_INDEX

#endif  // HAVE_SPATIALITE

    return rc == SQLITE_OK;
}

/************************************************************************/
/*                          OGRSQLiteExecuteSQL()                       */
/************************************************************************/

OGRLayer *OGRSQLiteExecuteSQL(GDALDataset *poDS, const char *pszStatement,
                              OGRGeometry *poSpatialFilter,
                              CPL_UNUSED const char *pszDialect)
{
    while (*pszStatement != '\0' && isspace(*pszStatement))
        pszStatement++;

    char *pszTmpDBName = (char *)CPLMalloc(256);
    char szPtr[32];
    snprintf(szPtr, sizeof(szPtr), "%p", pszTmpDBName);
    snprintf(pszTmpDBName, 256, "/vsimem/ogr2sqlite/temp_%s.db", szPtr);

    OGRSQLiteDataSource *poSQLiteDS = nullptr;
    bool bSpatialiteDB = false;

    /* -------------------------------------------------------------------- */
    /*      Create in-memory sqlite/spatialite DB                           */
    /* -------------------------------------------------------------------- */

#ifdef HAVE_SPATIALITE

/* -------------------------------------------------------------------- */
/*      Creating an empty SpatiaLite DB (with spatial_ref_sys populated */
/*      has a significant cost. So at the first attempt, let's make     */
/*      one and cache it for later use.                                 */
/* -------------------------------------------------------------------- */
#if 1
    static size_t nEmptyDBSize = 0;
    static GByte *pabyEmptyDB = nullptr;
    {
        static CPLMutex *hMutex = nullptr;
        CPLMutexHolder oMutexHolder(&hMutex);
        static bool bTried = false;
        if (!bTried && CPLTestBool(CPLGetConfigOption(
                           "OGR_SQLITE_DIALECT_USE_SPATIALITE", "YES")))
        {
            bTried = true;
            char *pszCachedFilename = (char *)CPLMalloc(256);
            snprintf(szPtr, sizeof(szPtr), "%p", pszCachedFilename);
            snprintf(pszCachedFilename, 256,
                     "/vsimem/ogr2sqlite/reference_%s.db", szPtr);
            char **papszOptions = CSLAddString(nullptr, "SPATIALITE=YES");
            OGRSQLiteDataSource *poCachedDS = new OGRSQLiteDataSource();
            const int nRet =
                poCachedDS->Create(pszCachedFilename, papszOptions);
            CSLDestroy(papszOptions);
            papszOptions = nullptr;
            delete poCachedDS;
            if (nRet)
            {
                /* Note: the reference file keeps the ownership of the data, so
                 * that */
                /* it gets released with VSICleanupFileManager() */
                vsi_l_offset nEmptyDBSizeLarge = 0;
                pabyEmptyDB = VSIGetMemFileBuffer(pszCachedFilename,
                                                  &nEmptyDBSizeLarge, FALSE);
                nEmptyDBSize = static_cast<size_t>(nEmptyDBSizeLarge);
            }
            CPLFree(pszCachedFilename);
        }
    }

    /* The following configuration option is useful mostly for debugging/testing
     */
    if (pabyEmptyDB != nullptr &&
        CPLTestBool(
            CPLGetConfigOption("OGR_SQLITE_DIALECT_USE_SPATIALITE", "YES")))
    {
        GByte *pabyEmptyDBClone = (GByte *)VSI_MALLOC_VERBOSE(nEmptyDBSize);
        if (pabyEmptyDBClone == nullptr)
        {
            CPLFree(pszTmpDBName);
            return nullptr;
        }
        memcpy(pabyEmptyDBClone, pabyEmptyDB, nEmptyDBSize);
        VSIFCloseL(VSIFileFromMemBuffer(pszTmpDBName, pabyEmptyDBClone,
                                        nEmptyDBSize, TRUE));

        poSQLiteDS = new OGRSQLiteDataSource();
        GDALOpenInfo oOpenInfo(pszTmpDBName, GDAL_OF_VECTOR | GDAL_OF_UPDATE);
        CPLConfigOptionSetter oSetter("OGR_SQLITE_STATIC_VIRTUAL_OGR", "NO",
                                      false);
        const int nRet = poSQLiteDS->Open(&oOpenInfo);
        if (!nRet)
        {
            /* should not happen really ! */
            delete poSQLiteDS;
            VSIUnlink(pszTmpDBName);
            CPLFree(pszTmpDBName);
            return nullptr;
        }
        bSpatialiteDB = true;
    }
#else
    /* No caching version */
    poSQLiteDS = new OGRSQLiteDataSource();
    char **papszOptions = CSLAddString(NULL, "SPATIALITE=YES");
    {
        CPLConfigOptionSetter oSetter("OGR_SQLITE_STATIC_VIRTUAL_OGR", "NO",
                                      false);
        const int nRet = poSQLiteDS->Create(pszTmpDBName, papszOptions);
        CSLDestroy(papszOptions);
        papszOptions = nullptr;
        if (nRet)
        {
            bSpatialiteDB = true;
        }
    }
#endif

    else
    {
        delete poSQLiteDS;
        poSQLiteDS = nullptr;
#else   // HAVE_SPATIALITE
    if (true)
    {
#endif  // HAVE_SPATIALITE

        // cppcheck-suppress redundantAssignment
        poSQLiteDS = new OGRSQLiteDataSource();
        CPLConfigOptionSetter oSetter("OGR_SQLITE_STATIC_VIRTUAL_OGR", "NO",
                                      false);
        const int nRet = poSQLiteDS->Create(pszTmpDBName, nullptr);
        if (!nRet)
        {
            delete poSQLiteDS;
            VSIUnlink(pszTmpDBName);
            CPLFree(pszTmpDBName);
            return nullptr;
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Attach the Virtual Table OGR2SQLITE module to it.               */
    /* -------------------------------------------------------------------- */
    OGR2SQLITEModule *poModule = OGR2SQLITE_Setup(poDS, poSQLiteDS);
    sqlite3 *hDB = poSQLiteDS->GetDB();

    /* -------------------------------------------------------------------- */
    /*      Analysze the statement to determine which tables will be used.  */
    /* -------------------------------------------------------------------- */
    std::set<LayerDesc> oSetLayers;
    std::set<CPLString> oSetSpatialIndex;
    CPLString osModifiedSQL;
    OGR2SQLITEGetPotentialLayerNames(pszStatement, oSetLayers, oSetSpatialIndex,
                                     osModifiedSQL);
    std::set<LayerDesc>::iterator oIter = oSetLayers.begin();

    if (strcmp(pszStatement, osModifiedSQL.c_str()) != 0)
        CPLDebug("OGR", "Modified SQL: %s", osModifiedSQL.c_str());
    pszStatement = osModifiedSQL.c_str(); /* do not use it anymore */

    const bool bFoundOGRStyle =
        (osModifiedSQL.ifind("OGR_STYLE") != std::string::npos);

    /* -------------------------------------------------------------------- */
    /*      For each of those tables, create a Virtual Table.               */
    /* -------------------------------------------------------------------- */
    OGRLayer *poSingleSrcLayer = nullptr;
    for (; oIter != oSetLayers.end(); ++oIter)
    {
        const LayerDesc &oLayerDesc = *oIter;
        /*CPLDebug("OGR", "Layer desc : %s, %s, %s, %s",
                 oLayerDesc.osOriginalStr.c_str(),
                 oLayerDesc.osSubstitutedName.c_str(),
                 oLayerDesc.osDSName.c_str(),
                 oLayerDesc.osLayerName.c_str());*/

        CPLString osSQL;
        OGRLayer *poLayer = nullptr;
        CPLString osTableName;
        int nExtraDS = -1;
        if (oLayerDesc.osDSName.empty())
        {
            poLayer = poDS->GetLayerByName(oLayerDesc.osLayerName);
            /* Might be a false positive (unlikely) */
            if (poLayer == nullptr)
                continue;

            osTableName = oLayerDesc.osLayerName;
        }
        else
        {
            OGRDataSource *poOtherDS =
                (OGRDataSource *)OGROpen(oLayerDesc.osDSName, FALSE, nullptr);
            if (poOtherDS == nullptr)
            {
                CPLError(CE_Failure, CPLE_AppDefined,
                         "Cannot open datasource '%s'",
                         oLayerDesc.osDSName.c_str());
                delete poSQLiteDS;
                VSIUnlink(pszTmpDBName);
                CPLFree(pszTmpDBName);
                return nullptr;
            }

            poLayer = poOtherDS->GetLayerByName(oLayerDesc.osLayerName);
            if (poLayer == nullptr)
            {
                CPLError(CE_Failure, CPLE_AppDefined,
                         "Cannot find layer '%s' in '%s'",
                         oLayerDesc.osLayerName.c_str(),
                         oLayerDesc.osDSName.c_str());
                delete poOtherDS;
                delete poSQLiteDS;
                VSIUnlink(pszTmpDBName);
                CPLFree(pszTmpDBName);
                return nullptr;
            }

            osTableName = oLayerDesc.osSubstitutedName;

            nExtraDS = OGR2SQLITE_AddExtraDS(poModule, poOtherDS);
        }

        if (oSetLayers.size() == 1)
            poSingleSrcLayer = poLayer;

        osSQL.Printf(
            "CREATE VIRTUAL TABLE \"%s\" USING VirtualOGR(%d,'%s',%d,%d)",
            SQLEscapeName(osTableName).c_str(), nExtraDS,
            SQLEscapeLiteral(oLayerDesc.osLayerName).c_str(),
            bFoundOGRStyle ? 1 : 0, TRUE /*bExposeOGRNativeData*/);

        char *pszErrMsg = nullptr;
        int rc = sqlite3_exec(hDB, osSQL.c_str(), nullptr, nullptr, &pszErrMsg);
        if (rc != SQLITE_OK)
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "Cannot create virtual table for layer '%s' : %s",
                     osTableName.c_str(), pszErrMsg);
            sqlite3_free(pszErrMsg);
            continue;
        }

        for (int i = 0; i < poLayer->GetLayerDefn()->GetGeomFieldCount(); i++)
        {
            OGR2SQLITEDealWithSpatialColumn(poLayer, i, oLayerDesc, osTableName,
                                            poSQLiteDS, hDB, bSpatialiteDB,
                                            oSetLayers, oSetSpatialIndex);
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Reload, so that virtual tables are recognized                   */
    /* -------------------------------------------------------------------- */
    poSQLiteDS->ReloadLayers();

    /* -------------------------------------------------------------------- */
    /*      Prepare the statement.                                          */
    /* -------------------------------------------------------------------- */
    /* This will speed-up layer creation */
    /* ORDER BY are costly to evaluate and are not necessary to establish */
    /* the layer definition. */
    bool bUseStatementForGetNextFeature = true;
    bool bEmptyLayer = false;

    sqlite3_stmt *hSQLStmt = nullptr;
    int rc = sqlite3_prepare_v2(hDB, pszStatement, -1, &hSQLStmt, nullptr);

    if (rc != SQLITE_OK)
    {
        CPLError(CE_Failure, CPLE_AppDefined,
                 "In ExecuteSQL(): sqlite3_prepare_v2(%s):\n  %s", pszStatement,
                 sqlite3_errmsg(hDB));

        if (hSQLStmt != nullptr)
        {
            sqlite3_finalize(hSQLStmt);
        }

        delete poSQLiteDS;
        VSIUnlink(pszTmpDBName);
        CPLFree(pszTmpDBName);

        return nullptr;
    }

    /* -------------------------------------------------------------------- */
    /*      Do we get a resultset?                                          */
    /* -------------------------------------------------------------------- */
    rc = sqlite3_step(hSQLStmt);
    if (rc != SQLITE_ROW)
    {
        if (rc != SQLITE_DONE)
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "In ExecuteSQL(): sqlite3_step(%s):\n  %s", pszStatement,
                     sqlite3_errmsg(hDB));

            sqlite3_finalize(hSQLStmt);

            delete poSQLiteDS;
            VSIUnlink(pszTmpDBName);
            CPLFree(pszTmpDBName);

            return nullptr;
        }

        if (!STARTS_WITH_CI(pszStatement, "SELECT "))
        {

            sqlite3_finalize(hSQLStmt);

            delete poSQLiteDS;
            VSIUnlink(pszTmpDBName);
            CPLFree(pszTmpDBName);

            return nullptr;
        }

        bUseStatementForGetNextFeature = false;
        bEmptyLayer = true;
    }

    /* -------------------------------------------------------------------- */
    /*      Create layer.                                                   */
    /* -------------------------------------------------------------------- */

    auto poDrv = poDS->GetDriver();
    const bool bCanReopenBaseDS =
        !(poDrv && EQUAL(poDrv->GetDescription(), "Memory"));
    OGRSQLiteSelectLayer *poLayer = new OGRSQLiteExecuteSQLLayer(
        pszTmpDBName, poSQLiteDS, pszStatement, hSQLStmt,
        bUseStatementForGetNextFeature, bEmptyLayer, bCanReopenBaseDS);

    if (poSpatialFilter != nullptr)
        poLayer->SetSpatialFilter(0, poSpatialFilter);

    if (poSingleSrcLayer != nullptr)
        poLayer->SetMetadata(poSingleSrcLayer->GetMetadata("NATIVE_DATA"),
                             "NATIVE_DATA");

    return poLayer;
}

#endif  // HAVE_SQLITE3EXT_H
