conn.go

// Copyright 2012 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package odbc

import (
	"context"
	"database/sql/driver"
	"errors"
	"strings"
	"unsafe"

	"github.com/duneanalytics/odbc/api"
)

type Conn struct {
	h                api.SQLHDBC
	tx               *Tx
	bad              bool
	isMSAccessDriver bool
}

var accessDriverSubstr = strings.ToUpper(strings.Replace("DRIVER={Microsoft Access Driver", " ", "", -1))

func (d *Driver) Open(dsn string) (driver.Conn, error) {
	if d.initErr != nil {
		return nil, d.initErr
	}

	var out api.SQLHANDLE
	ret := api.SQLAllocHandle(api.SQL_HANDLE_DBC, api.SQLHANDLE(d.h), &out)
	if IsError(ret) {
		return nil, NewError("SQLAllocHandle", d.h)
	}
	h := api.SQLHDBC(out)
	drv.Stats.updateHandleCount(api.SQL_HANDLE_DBC, 1)

	b := api.StringToUTF16(dsn)
	ret = api.SQLDriverConnect(h, 0,
		(*api.SQLWCHAR)(unsafe.Pointer(&b[0])), api.SQL_NTS,
		nil, 0, nil, api.SQL_DRIVER_NOPROMPT)
	if IsError(ret) {
		defer releaseHandle(h)
		return nil, NewError("SQLDriverConnect", h)
	}
	isAccess := strings.Contains(strings.ToUpper(strings.Replace(dsn, " ", "", -1)), accessDriverSubstr)
	return &Conn{h: h, isMSAccessDriver: isAccess}, nil
}

func (c *Conn) Close() (err error) {
	if c.tx != nil {
		c.tx.Rollback()
	}
	h := c.h
	defer func() {
		c.h = api.SQLHDBC(api.SQL_NULL_HDBC)
		e := releaseHandle(h)
		if err == nil {
			err = e
		}
	}()
	ret := api.SQLDisconnect(c.h)
	if IsError(ret) {
		return c.newError("SQLDisconnect", h)
	}
	return err
}

func (c *Conn) newError(apiName string, handle interface{}) error {
	err := NewError(apiName, handle)
	if err == driver.ErrBadConn {
		c.bad = true
	}
	return err
}

// QueryContext implements the driver.QueryerContext interface.
// As per the specifications, it honours the context timeout and returns when the context is cancelled.
// When the context is cancelled, it first cancels the statement, closes it, and then returns an error.
func (c *Conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) {
	// Prepare a query
	os, err := c.PrepareODBCStmt(query)
	if err != nil {
		return nil, err
	}

	dargs, err := namedValueToValue(args)
	if err != nil {
		return nil, err
	}

	// Execute the statement
	rowsChan := make(chan driver.Rows)
	defer close(rowsChan)
	errorChan := make(chan error)
	defer close(errorChan)

	if ctx.Err() != nil {
		os.closeByStmt()
		return nil, ctx.Err()
	}

	go c.wrapQuery(ctx, os, dargs, rowsChan, errorChan)

	var finalErr error
	var finalRes driver.Rows

	select {
	case <-ctx.Done():
		// Context has been cancelled or has expired, cancel the statement
		if err := os.Cancel(); err != nil {
			finalErr = err
			break
		}

		// The statement has been cancelled, the query execution should eventually fail now.
		// We wait for it in order to avoid having a dangling goroutine running in the background
		<-errorChan
		finalErr = ctx.Err()
	case err := <-errorChan:
		finalErr = err
	case rows := <-rowsChan:
		finalRes = rows
	}

	// Close the statement
	os.closeByStmt()
	os = nil

	return finalRes, finalErr
}

// wrapQuery is following the same logic as `stmt.Query()` except that we don't use a lock
// because the ODBC statement doesn't get exposed externally.
func (c *Conn) wrapQuery(ctx context.Context, os *ODBCStmt, dargs []driver.Value, rowsChan chan<- driver.Rows, errorChan chan<- error) {
	if err := os.Exec(dargs, c); err != nil {
		errorChan <- err
		return
	}

	if err := os.BindColumns(); err != nil {
		errorChan <- err
		return
	}

	os.usedByRows = true
	rowsChan <- &Rows{os: os}

	// At the end of the execution, we check if the context has been cancelled
	// to ensure the caller doesn't end up waiting for a message indefinitely (L119)
	if ctx.Err() != nil {
		errorChan <- ctx.Err()
	}
}

// namedValueToValue is a utility function that converts a driver.NamedValue into a driver.Value.
// Source:
// https://github.com/golang/go/blob/03ac39ce5e6af4c4bca58b54d5b160a154b7aa0e/src/database/sql/ctxutil.go#L137-L146
func namedValueToValue(named []driver.NamedValue) ([]driver.Value, error) {
	dargs := make([]driver.Value, len(named))
	for n, param := range named {
		if len(param.Name) > 0 {
			return nil, errors.New("sql: driver does not support the use of Named Parameters")
		}
		dargs[n] = param.Value
	}
	return dargs, nil
}