xorm/engine.go

package xorm

import (
	"database/sql"
	"fmt"
	"reflect"
	"strconv"
	"strings"
)

const (
	PQSQL   = "pqsql"
	MSSQL   = "mssql"
	SQLITE  = "sqlite"
	MYSQL   = "mysql"
	MYMYSQL = "mymysql"
)

type Engine struct {
	Mapper          IMapper
	Protocol        string
	UserName        string
	Password        string
	Host            string
	Port            int
	DBName          string
	Charset         string
	Others          string
	Tables          map[string]Table
	AutoIncrement   string
	ShowSQL         bool
	QuoteIdentifier string
	Statement       Statement
}

func Type(bean interface{}) reflect.Type {
	sliceValue := reflect.Indirect(reflect.ValueOf(bean))
	return reflect.TypeOf(sliceValue.Interface())
}

func (e *Engine) OpenDB() (db *sql.DB, err error) {
	db = nil
	err = nil
	if e.Protocol == SQLITE {
		// 'sqlite:///foo.db'
		db, err = sql.Open("sqlite3", e.Others)
		// 'sqlite:///:memory:'
	} else if e.Protocol == MYSQL {
		// 'mysql://<username>:<passwd>@<host>/<dbname>?charset=<encoding>'
		connstr := strings.Join([]string{e.UserName, ":",
			e.Password, "@tcp(", e.Host, ":3306)/", e.DBName, "?charset=", e.Charset}, "")
		db, err = sql.Open(e.Protocol, connstr)
	} else if e.Protocol == MYMYSQL {
		//   DBNAME/USER/PASSWD
		connstr := strings.Join([]string{e.DBName, e.UserName, e.Password}, "/")
		db, err = sql.Open(e.Protocol, connstr)
		//   unix:SOCKPATH*DBNAME/USER/PASSWD
		//   unix:SOCKPATH,OPTIONS*DBNAME/USER/PASSWD
		//   tcp:ADDR*DBNAME/USER/PASSWD
		//   tcp:ADDR,OPTIONS*DBNAME/USER/PASSWD
	}

	return
}

func (engine *Engine) MakeSession() (session Session, err error) {
	db, err := engine.OpenDB()
	if err != nil {
		return Session{}, err
	}
	if engine.Protocol == PQSQL {
		engine.QuoteIdentifier = "\""
		session = Session{Engine: engine, Db: db}
	} else if engine.Protocol == MSSQL {
		engine.QuoteIdentifier = ""
		session = Session{Engine: engine, Db: db}
	} else {
		engine.QuoteIdentifier = "`"
		session = Session{Engine: engine, Db: db}
	}
	session.Mapper = engine.Mapper
	session.Init()
	return
}

func (engine *Engine) Where(querystring string, args ...interface{}) *Engine {
	engine.Statement.Where(querystring, args...)
	return engine
}

func (engine *Engine) Limit(limit int, start ...int) *Engine {
	engine.Statement.Limit(limit, start...)
	return engine
}

func (engine *Engine) OrderBy(order string) *Engine {
	engine.Statement.OrderBy(order)
	return engine
}

//The join_operator should be one of INNER, LEFT OUTER, CROSS etc - this will be prepended to JOIN
func (engine *Engine) Join(join_operator, tablename, condition string) *Engine {
	engine.Statement.Join(join_operator, tablename, condition)
	return engine
}

func (engine *Engine) GroupBy(keys string) *Engine {
	engine.Statement.GroupBy(keys)
	return engine
}

func (engine *Engine) Having(conditions string) *Engine {
	engine.Statement.Having(conditions)
	return engine
}

func (e *Engine) genColumnStr(col *Column) string {
	sql := "`" + col.Name + "` "
	if col.SQLType == Date {
		sql += " datetime "
	} else {
		if e.Protocol == SQLITE && col.IsPrimaryKey {
			sql += "integer"
		} else {
			sql += col.SQLType.Name
		}
		if e.Protocol != SQLITE {
			if col.SQLType != Decimal {
				sql += "(" + strconv.Itoa(col.Length) + ")"
			} else {
				sql += "(" + strconv.Itoa(col.Length) + "," + strconv.Itoa(col.Length2) + ")"
			}
		}
	}

	if col.Nullable {
		sql += " NULL "
	} else {
		sql += " NOT NULL "
	}
	//fmt.Println(key)
	if col.IsPrimaryKey {
		sql += "PRIMARY KEY "
	}
	if col.IsAutoIncrement {
		sql += e.AutoIncrement + " "
	}
	if col.IsUnique {
		sql += "Unique "
	}
	return sql
}

func (e *Engine) genCreateSQL(table *Table) string {
	sql := "CREATE TABLE IF NOT EXISTS `" + table.Name + "` ("
	//fmt.Println(session.Mapper.Obj2Table(session.PrimaryKey))
	for _, col := range table.Columns {
		sql += e.genColumnStr(&col)
		sql += ","
	}
	sql = sql[:len(sql)-2] + ");"
	if e.ShowSQL {
		fmt.Println(sql)
	}
	return sql
}

func (e *Engine) genDropSQL(table *Table) string {
	sql := "DROP TABLE IF EXISTS `" + table.Name + "`;"
	if e.ShowSQL {
		fmt.Println(sql)
	}
	return sql
}

/*
map an object into a table object
*/
func (engine *Engine) MapOne(bean interface{}) Table {
	t := Type(bean)
	return engine.MapType(t)
}

func (engine *Engine) MapType(t reflect.Type) Table {
	table := Table{Name: engine.Mapper.Obj2Table(t.Name()), Type: t}
	table.Columns = make(map[string]Column)
	var pkCol *Column = nil
	var pkstr = ""

	for i := 0; i < t.NumField(); i++ {
		tag := t.Field(i).Tag
		ormTagStr := tag.Get("xorm")
		var col Column
		fieldType := t.Field(i).Type

		if ormTagStr != "" {
			col = Column{FieldName: t.Field(i).Name}
			ormTagStr = strings.ToLower(ormTagStr)
			tags := strings.Split(ormTagStr, " ")
			// TODO: 
			if len(tags) > 0 {
				if tags[0] == "-" {
					continue
				}
				for j, key := range tags {
					switch k := strings.ToLower(key); k {
					case "pk":
						col.IsPrimaryKey = true
						pkCol = &col
					case "null":
						col.Nullable = (tags[j-1] != "not")
					case "autoincr":
						col.IsAutoIncrement = true
					case "default":
						col.Default = tags[j+1]
					case "int":
						col.SQLType = Int
					case "not":
					default:
						col.Name = k
					}
				}
				if col.SQLType.Name == "" {
					col.SQLType = Type2SQLType(fieldType)
					col.Length = col.SQLType.DefaultLength
					col.Length2 = col.SQLType.DefaultLength2
				}

				if col.Name == "" {
					col.Name = engine.Mapper.Obj2Table(t.Field(i).Name)
				}
			}
		}

		if col.Name == "" {
			sqlType := Type2SQLType(fieldType)
			col = Column{engine.Mapper.Obj2Table(t.Field(i).Name), t.Field(i).Name, sqlType,
				sqlType.DefaultLength, sqlType.DefaultLength2, true, "", false, false, false}
		}
		table.Columns[col.Name] = col
		if strings.ToLower(t.Field(i).Name) == "id" {
			pkstr = col.Name
		}
	}

	if pkCol == nil {
		if pkstr != "" {
			col := table.Columns[pkstr]
			col.IsPrimaryKey = true
			col.IsAutoIncrement = true
			col.Nullable = false
			col.Length = Int.DefaultLength
			table.PrimaryKey = col.Name
		}
	} else {
		table.PrimaryKey = pkCol.Name
	}

	return table
}

func (engine *Engine) Map(beans ...interface{}) (e error) {
	for _, bean := range beans {
		tableName := engine.Mapper.Obj2Table(StructName(bean))
		if _, ok := engine.Tables[tableName]; !ok {
			table := engine.MapOne(bean)
			engine.Tables[table.Name] = table
		}
	}
	return
}

func (engine *Engine) UnMap(beans ...interface{}) (e error) {
	for _, bean := range beans {
		tableName := engine.Mapper.Obj2Table(StructName(bean))
		if _, ok := engine.Tables[tableName]; ok {
			delete(engine.Tables, tableName)
		}
	}
	return
}

func (e *Engine) DropAll() error {
	session, err := e.MakeSession()
	session.Begin()
	defer session.Close()
	if err != nil {
		return err
	}

	for _, table := range e.Tables {
		sql := e.genDropSQL(&table)
		_, err = session.Exec(sql)
		if err != nil {
			session.Rollback()
			break
		}
	}
	session.Commit()
	return err
}

func (e *Engine) CreateTables(beans ...interface{}) error {
	session, err := e.MakeSession()
	session.Begin()
	defer session.Close()
	if err != nil {
		return err
	}
	for _, bean := range beans {
		table := e.MapOne(bean)
		e.Tables[table.Name] = table
		sql := e.genCreateSQL(&table)
		_, err = session.Exec(sql)
		if err != nil {
			session.Rollback()
			break
		}
	}
	session.Commit()
	return err
}

func (e *Engine) CreateAll() error {
	session, err := e.MakeSession()
	session.Begin()
	defer session.Close()
	if err != nil {
		return err
	}

	for _, table := range e.Tables {
		sql := e.genCreateSQL(&table)
		_, err = session.Exec(sql)
		if err != nil {
			session.Rollback()
			break
		}
	}
	session.Commit()
	return err
}

func (engine *Engine) Insert(beans ...interface{}) (int64, error) {
	session, err := engine.MakeSession()
	defer session.Close()
	if err != nil {
		return -1, err
	}
	defer engine.Statement.Init()
	engine.Statement.Session = &session
	session.SetStatement(&engine.Statement)
	return session.Insert(beans...)
}

func (engine *Engine) Update(bean interface{}) (int64, error) {
	session, err := engine.MakeSession()
	defer session.Close()
	if err != nil {
		return -1, err
	}
	defer engine.Statement.Init()
	engine.Statement.Session = &session
	session.SetStatement(&engine.Statement)
	return session.Update(bean)
}

func (engine *Engine) Delete(bean interface{}) (int64, error) {
	session, err := engine.MakeSession()
	defer session.Close()
	if err != nil {
		return -1, err
	}
	defer engine.Statement.Init()
	engine.Statement.Session = &session
	session.SetStatement(&engine.Statement)
	return session.Delete(bean)
}

func (engine *Engine) Get(bean interface{}) error {
	session, err := engine.MakeSession()
	defer session.Close()
	if err != nil {
		return err
	}
	defer engine.Statement.Init()
	engine.Statement.Session = &session
	session.SetStatement(&engine.Statement)
	return session.Get(bean)
}

func (engine *Engine) Find(beans interface{}) error {
	session, err := engine.MakeSession()
	defer session.Close()
	if err != nil {
		return err
	}
	defer engine.Statement.Init()
	engine.Statement.Session = &session
	session.SetStatement(&engine.Statement)
	return session.Find(beans)
}

func (engine *Engine) Count(bean interface{}) (int64, error) {
	session, err := engine.MakeSession()
	defer session.Close()
	if err != nil {
		return 0, err
	}
	defer engine.Statement.Init()
	engine.Statement.Session = &session
	session.SetStatement(&engine.Statement)
	return session.Count(bean)
}