├── horm使用步骤.png ├── horm ├── table.go ├── const.go ├── init.go ├── result.go ├── config.go ├── result_map.go ├── utils.go ├── struct_generator.go ├── hrom_manager.go ├── horm_test.go ├── sql_generator.go ├── reflect.go └── horm.go ├── README.md └── LICENSE /horm使用步骤.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tian-gua/go-horm/HEAD/horm使用步骤.png -------------------------------------------------------------------------------- /horm/table.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | type Table interface { 4 | GetTableName() string 5 | } 6 | -------------------------------------------------------------------------------- /horm/const.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | const ( 4 | MYSQL string = "mysql" 5 | COLUMN_TAG string = "field" 6 | ) 7 | -------------------------------------------------------------------------------- /horm/init.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | func init() { 4 | SetSqlGenerator(&defaultSqlGenerator{}) 5 | structInfoMap = make(map[string]*StructInfo) 6 | } 7 | -------------------------------------------------------------------------------- /horm/result.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | type Result struct { 4 | LastInsertId int 5 | LastInsertId64 int64 6 | RowsAffected int 7 | RowsAffected64 int64 8 | } 9 | -------------------------------------------------------------------------------- /horm/config.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | var isPrintLog bool = true 4 | 5 | func DisableLog() { 6 | isPrintLog = false 7 | } 8 | 9 | func EnableLog() { 10 | isPrintLog = true 11 | } 12 | -------------------------------------------------------------------------------- /horm/result_map.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | //用于存放所有的结构体和表的映射 4 | type resultMap struct { 5 | tableMap map[string]string //结构体名->表名 6 | fieldMap map[string](map[string]string) //结构体名->(结构体字段->表字段) 7 | } 8 | 9 | func newResultMap() *resultMap { 10 | tableMap := make(map[string]string) 11 | fieldMap := make(map[string](map[string]string)) 12 | return &resultMap{tableMap: tableMap, fieldMap: fieldMap} 13 | } 14 | -------------------------------------------------------------------------------- /horm/utils.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | import ( 4 | "bytes" 5 | "github.com/fatih/color" 6 | "log" 7 | "runtime" 8 | "strconv" 9 | ) 10 | 11 | //获取goroutine id 12 | func getGID() uint64 { 13 | b := make([]byte, 64) 14 | b = b[:runtime.Stack(b, false)] 15 | b = bytes.TrimPrefix(b, []byte("goroutine ")) 16 | b = b[:bytes.IndexByte(b, ' ')] 17 | n, _ := strconv.ParseUint(string(b), 10, 64) 18 | return n 19 | } 20 | 21 | func printLog(s string) { 22 | if isPrintLog { 23 | formatS := color.GreenString("%s", s) 24 | log.Printf("[horm]:%s", formatS) 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /horm/struct_generator.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | import ( 4 | "fmt" 5 | "strings" 6 | ) 7 | 8 | type tableStruct struct { 9 | Field string `field:"Field"` 10 | Type string `field:"Type"` 11 | } 12 | 13 | func GenerateStruct(h IHorm, tableName string, structName string) (string, error) { 14 | ts := new([]tableStruct) 15 | err := h.Query("DESC "+tableName, ts) 16 | if err != nil { 17 | return "", fmt.Errorf("Generate table struct failed:%s", err.Error()) 18 | } 19 | structStr := fmt.Sprintf("\ntype %s struct {\n", structName) 20 | for _, v := range *ts { 21 | structStr += fmt.Sprintf("\t%-20s %-20s `field:\"%s\"`\n", getCamelString(v.Field), getStructType(v.Type), v.Field) 22 | } 23 | structStr += "}\n" 24 | structStr += fmt.Sprintf("func (%s *%s)GetTableName() string {\n\treturn \"%s\"\n}", ([]byte(structName))[0:1], structName, tableName) 25 | return structStr, nil 26 | } 27 | 28 | func getStructType(dbType string) string { 29 | if strings.Contains(dbType, "int") { 30 | return "int" 31 | } else if strings.Contains(dbType, "varchar") { 32 | return "string" 33 | } else if strings.Contains(dbType, "timestamp") || strings.Contains(dbType, "datetime") { 34 | return "time.Time" 35 | } else if strings.Contains(dbType, "decimal") || strings.Contains(dbType, "datetime") { 36 | return "float64" 37 | } 38 | return "unknown" 39 | } 40 | 41 | func getCamelString(unCamelString string) string { 42 | s := strings.Split(unCamelString, "_") 43 | camelString := "" 44 | for _, v := range s { 45 | camelString += strings.Title(v) 46 | } 47 | return camelString 48 | } 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # go-horm 2 | 轻量级的自动注册、多连接orm框架,操作方便 3 | 4 | ## 为什么写horm 5 | 因为工作的原因,会经常操作数据库,包括批量插入数据,表之间迁移,多表合并等操作,工作是用java,所以尝试过用java写,但是一些小操作用java写太浪费时间. 6 | 7 | 加上当时已经研究go一段时间了.所以尝试用go来写一个工具.然后就写了一个gorm(和jinzhu大大的gorm名字雷同..) 8 | 9 | 后来发现要做的事情越来越复杂,之前的orm写的很单纯,拓展性不好,所以这次写了一个接口化的orm框架 10 | 11 | 和其他orm框架一样,horm主要功能就是把struct和table关联起来.让用户对struct的操作映射到table上. 12 | 13 | # 功能 14 | + 多连接(每一个goroutine可以拥有一个连接) 15 | + 自动注册 16 | + 包装常用操作(简单CRUD),自动生成sql语句 17 | + 支持事务(事务提交,事务回滚) 18 | + 接口化(包括horm管理器,horm对象,sql生成器都做了抽象),提供默认实现 19 | + 辅助功能(根据table生成struct) 20 | 21 | ### 支持的数据库 22 | > 目前仅在mysql中测试过 23 | 24 | # 用法 25 | 26 | ### 测试用的struct 27 | ``` 28 | type testHorm struct { 29 | Id int `field:"id" default:"auto"` 30 | CreateTime time.Time `field:"create_time"` 31 | ModifyTime time.Time `field:"modify_time"` 32 | State int `field:"state"` 33 | Type int `field:"type"` 34 | Description string `field:"description"` 35 | } 36 | 37 | //实现Table接口,用户自己指定表名 38 | func (t *testHorm) GetTableName() string { 39 | return "tb_test" 40 | } 41 | 42 | func newTestHorm() *testHorm { 43 | return &testHorm{CreateTime:time.Now(), ModifyTime:time.Now(), State:0, Type:0, Description:"测试horm"} 44 | } 45 | ``` 46 | 47 | ### horm操作 48 | 49 | ``` 50 | //创建一个HormManager 51 | hormManager := New() 52 | 53 | //连接数据库 54 | //did为这一次连接的标识符,生成规则会当前时间戳(纳秒单位) 55 | did, err := hormManager.Connect("127.0.0.1", 3306, "root", "root", "horm") 56 | 57 | //在当前did对应的连接中创建一个horm操作对象 58 | horm := hormManager.Create(did) 59 | 60 | //开启一个事务 61 | err = horm.Begin() 62 | 63 | //保存新建的struct到数据库 64 | //res为操作的结果,可以获取最新添加的id和操作的记录的条数 65 | res, err := horm.Save(newTestHorm()) 66 | //提交事务 67 | err = horm.Commit() 68 | 69 | //关闭所有goroutine的连接 70 | err = hormManager.CloseAll() 71 | ``` 72 | 73 | ### 控制台 74 | ``` 75 | [horm]εε[2017-03-13 11:31:15]: INSERT INTO tb_test(id,description,create_time,modify_time,state,type) VALUES(DEFAULT,'测试horm','2017-03-13 11:31:15','2017-03-13 11:31:15',0,0) 76 | [horm]εε[2017-03-13 11:31:15]: Horm-Connection[1489375875531622312] is closed. 77 | ``` 78 | 79 | ![horm使用步骤.png](https://github.com/aidonggua/go-horm/blob/master/horm%E4%BD%BF%E7%94%A8%E6%AD%A5%E9%AA%A4.png) -------------------------------------------------------------------------------- /horm/hrom_manager.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | import ( 4 | "database/sql" 5 | "errors" 6 | "fmt" 7 | "log" 8 | "strconv" 9 | "sync" 10 | "time" 11 | ) 12 | 13 | type IHormManager interface { 14 | Connect(url string, port int, userName string, passWord string, dbName string) (int64, error) //连接数据库 15 | Create(int64) IHorm //创建horm 16 | CloseAll() error //关闭数据库连接 17 | } 18 | 19 | type HormManager struct { 20 | dbMap map[int64]*sql.DB 21 | hormList []IHorm 22 | } 23 | 24 | func (m *HormManager) Connect(url string, port int, userName string, passWord string, dbName string) (int64, error) { 25 | db, err := sql.Open(MYSQL, userName+":"+passWord+"@tcp("+url+":"+strconv.Itoa(port)+")/"+dbName) 26 | if err != nil { 27 | panic(errors.New("Not connected to the database:" + err.Error())) 28 | } 29 | did := time.Now().UnixNano() 30 | m.dbMap[did] = db 31 | return did, nil 32 | } 33 | 34 | func (m *HormManager) Create(did int64) IHorm { 35 | return newDefaultHorm(m.dbMap[did]) 36 | } 37 | 38 | func (m *HormManager) CloseAll() error { 39 | for k, v := range m.dbMap { 40 | err := v.Close() 41 | if err != nil { 42 | return errors.New("Connection closed failed:" + err.Error()) 43 | } 44 | log.Printf("[horm]:Horm-Connection[%d] is closed.\n", k) 45 | } 46 | return nil 47 | } 48 | 49 | var hormManager IHormManager = nil 50 | var lock sync.Mutex 51 | 52 | //创建一个新的horm管理器 53 | func New() IHormManager { 54 | lock.Lock() 55 | if hormManager == nil { 56 | hormManager = &HormManager{dbMap: make(map[int64]*sql.DB)} 57 | } 58 | lock.Unlock() 59 | return hormManager 60 | } 61 | 62 | //创建默认的Horm 63 | func newDefaultHorm(db *sql.DB) IHorm { 64 | return &defaultHorm{db: db, mappings: newResultMap(), txMap: make(map[uint64]*sql.Tx)} 65 | } 66 | 67 | func FastCreate(url string, port int, userName string, passWord string, dbName string) (IHorm, error) { 68 | hormManager := New() 69 | did, err := hormManager.Connect(url, port, userName, passWord, dbName) 70 | if err != nil { 71 | return nil, fmt.Errorf("Fast create horm failed:%s", err) 72 | } 73 | return hormManager.Create(did), nil 74 | } 75 | -------------------------------------------------------------------------------- /horm/horm_test.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | import ( 4 | "testing" 5 | "time" 6 | ) 7 | 8 | func TestHorm(t *testing.T) { 9 | //创建一个HormManager 10 | hormManager := New() 11 | did, err := hormManager.Connect("127.0.0.1", 3306, "root", "root", "horm") 12 | dealError(err) 13 | t.Logf("did=%d", did) 14 | 15 | //创建一个horm 16 | horm := hormManager.Create(did) 17 | 18 | //开始一个事务 19 | err = horm.Begin() 20 | dealError(err) 21 | 22 | //创建一个测试struct 23 | th := newTestHorm() 24 | 25 | //保存新建的struct 26 | res, err := horm.Save(th) 27 | dealError(err) 28 | 29 | //删除新建的struct 30 | th.Id = res.LastInsertId 31 | rows, err := horm.DelById(th) 32 | dealError(err) 33 | t.Logf("rows=%d", rows) 34 | 35 | //查询id = 9的struct 36 | th2 := &testHorm{Id: 9} 37 | err = horm.FindById(th2) 38 | dealError(err) 39 | t.Logf("%+v", th2) 40 | 41 | //更新struct 42 | th2.Description = "更新 horm" 43 | rows, err = horm.UpdateById(th2) 44 | dealError(err) 45 | t.Logf("更新了[%d]条记录", rows) 46 | 47 | //自定义更新操作 48 | result, err := horm.Exec("update tb_test set state = 1 where state = 9") 49 | dealError(err) 50 | t.Logf("更新了[%d]条记录", result.RowsAffected) 51 | 52 | //自定义查询单条记录操作 53 | single := &testHorm{} 54 | err = horm.Query("select * from tb_test where id = 9", single) 55 | dealError(err) 56 | t.Logf("%+v", single) 57 | 58 | //自定义查询单条记录操作 59 | list := new([]testHorm) 60 | err = horm.Query("select * from tb_test", list) 61 | dealError(err) 62 | for _, v := range *list { 63 | t.Logf("---%+v", v) 64 | } 65 | 66 | //自定义查询单个字段操作 67 | tp := 0 68 | err = horm.Query("select type from tb_test where id = 9", &tp) 69 | dealError(err) 70 | t.Logf("type=%d", tp) 71 | des := "" 72 | err = horm.Query("select description from tb_test where id = 9", &des) 73 | dealError(err) 74 | t.Logf("description=%s", des) 75 | 76 | //自定义查询单个列表操作 77 | ids := new([]*int) 78 | err = horm.Query("select id from tb_test", ids) 79 | dealError(err) 80 | for _, v := range *ids { 81 | t.Logf("id=%d", *v) 82 | } 83 | 84 | //查询id = 9的struct 85 | th2 = &testHorm{Id: 9} 86 | err = horm.FindById(th2) 87 | dealError(err) 88 | t.Logf("%+v", th2) 89 | 90 | ths := new([]testHorm) 91 | err = horm.List(ths) 92 | dealError(err) 93 | for _, v := range *ths { 94 | t.Logf("%+v", v) 95 | } 96 | 97 | //提交事务 98 | err = horm.Commit() 99 | dealError(err) 100 | 101 | //关闭所有连接 102 | err = hormManager.CloseAll() 103 | dealError(err) 104 | } 105 | 106 | func dealError(err error) { 107 | if err != nil { 108 | panic(err) 109 | } 110 | } 111 | 112 | type testHorm struct { 113 | Id int `field:"id,pk,auto"` 114 | CreateTime time.Time `field:"create_time"` 115 | ModifyTime time.Time `field:"modify_time"` 116 | State int64 `field:"state"` 117 | Type int `field:"type"` 118 | Description string `field:"description"` 119 | } 120 | 121 | func (t *testHorm) GetTableName() string { 122 | return "tb_test" 123 | } 124 | 125 | func newTestHorm() *testHorm { 126 | return &testHorm{CreateTime: time.Now(), ModifyTime: time.Now(), State: 0, Type: 0, Description: "测试horm"} 127 | } 128 | -------------------------------------------------------------------------------- /horm/sql_generator.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | import ( 4 | "fmt" 5 | "strings" 6 | "errors" 7 | ) 8 | 9 | type ISqlGenerator interface { 10 | GenerateListSql(i interface{}, conditions ...string) (string, error) //生成查询多条记录sql 11 | GenerateFindByIdSql(i interface{}) (string, error) //生成根据id查询sql 12 | GenerateSaveSql(i interface{}) (string, error) //生成保存记录sql 13 | GenerateUpdateByIdSql(i interface{}) (string, error) //生成根据id更新记录sql 14 | GenerateDelByIdSql(i interface{}) (string, error) //生成根据Id删除sql 15 | } 16 | 17 | var sqlGenerator ISqlGenerator = nil 18 | 19 | //设置sql生成器 20 | func SetSqlGenerator(sg ISqlGenerator) { 21 | sqlGenerator = sg 22 | } 23 | 24 | type defaultSqlGenerator struct { 25 | } 26 | 27 | func (d *defaultSqlGenerator) GenerateListSql(i interface{}, conditions ...string) (string, error) { 28 | structInfo, err := getStuctInfo(i) 29 | if err != nil { 30 | return "", fmt.Errorf("get struct reflect type failed -> %s", err.Error()) 31 | } 32 | fields := structInfo.pkColumnName + "," 33 | for _, v := range structInfo.structFieldMap { 34 | fields += v.Tag.Get(COLUMN_TAG) + "," 35 | } 36 | fields = strings.TrimSuffix(fields, ",") 37 | where := "" 38 | sort := "" 39 | for _, condition := range conditions { 40 | if strings.Contains(condition, "=") { 41 | where += " " + condition 42 | } else if strings.Contains(condition, "desc") || strings.Contains(condition, "DESC") || strings.Contains(condition, "asc") || strings.Contains(condition, "ASC") { 43 | sort += condition + "," 44 | } 45 | } 46 | sort = strings.TrimSuffix(sort, ",") 47 | if where != "" { 48 | where = "WHERE" + where 49 | } 50 | if sort != "" { 51 | sort = "ORDER BY " + sort 52 | } 53 | s := fmt.Sprintf("SELECT %s FROM %s %s %s", fields, structInfo.tableName, where, sort) 54 | printLog(s) 55 | return s, nil 56 | } 57 | 58 | func (d *defaultSqlGenerator) GenerateFindByIdSql(i interface{}) (string, error) { 59 | structValue, err := getStructValue(i) 60 | if err != nil { 61 | return "", fmt.Errorf("get struct reflect value failed -> %s", err.Error()) 62 | } 63 | if structValue.pkColumnName == "" || structValue.pkStringValue == "" { 64 | return "", fmt.Errorf("[%s] primary key [id] can not be empty", structValue.value.Type().Name()) 65 | } 66 | 67 | fields := "" 68 | for k, _ := range structValue.fieldStringMap { 69 | fields += k + "," 70 | } 71 | fields = strings.TrimSuffix(fields, ",") 72 | s := fmt.Sprintf("SELECT %s FROM %s WHERE %s = %s", fields, structValue.tableName, structValue.pkColumnName, structValue.pkStringValue) 73 | printLog(s) 74 | return s, nil 75 | } 76 | 77 | func (d *defaultSqlGenerator) GenerateSaveSql(i interface{}) (string, error) { 78 | structValue, err := getStructValue(i) 79 | if err != nil { 80 | return "", fmt.Errorf("get struct reflect value error -> %s", err.Error()) 81 | } 82 | if structValue.pkColumnName == "" || structValue.pkStringValue == "" { 83 | //color.Red("there is no primary key") 84 | } 85 | if len(structValue.fieldStringMap) == 0 { 86 | return "", errors.New("there is no field") 87 | } 88 | fileds := structValue.pkColumnName 89 | values := "" 90 | if structValue.autoIncrease { 91 | values += "DEFAULT" 92 | } else { 93 | if structValue.pkStringValue != "" { 94 | values += structValue.pkStringValue 95 | } 96 | } 97 | for k, v := range structValue.fieldStringMap { 98 | fileds += "," + k 99 | values += "," + v 100 | } 101 | fileds = strings.TrimPrefix(fileds, ",") 102 | values = strings.TrimPrefix(values, ",") 103 | s := fmt.Sprintf("INSERT INTO %s(%s) VALUES(%s)", structValue.tableName, fileds, values) 104 | printLog(s) 105 | return s, nil 106 | } 107 | 108 | func (d *defaultSqlGenerator) GenerateUpdateByIdSql(i interface{}) (string, error) { 109 | structValue, err := getStructValue(i) 110 | if err != nil { 111 | return "", fmt.Errorf("get struct value error:%s", err.Error()) 112 | } 113 | if structValue.pkColumnName == "" || structValue.pkStringValue == "" { 114 | return "", errors.New("primary key can not be empty") 115 | } 116 | if len(structValue.fieldStringMap) == 0 { 117 | return "", errors.New("there is no field") 118 | } 119 | set := "" 120 | for k, v := range structValue.fieldStringMap { 121 | set += k + " = " + v + ", " 122 | } 123 | set = strings.TrimSuffix(set, ", ") 124 | s := "UPDATE " + structValue.tableName + " SET " + set + " WHERE " + structValue.pkColumnName + " = " + structValue.pkStringValue 125 | printLog(s) 126 | return s, nil 127 | } 128 | 129 | func (d *defaultSqlGenerator) GenerateDelByIdSql(i interface{}) (string, error) { 130 | structValue, err := getStructValue(i) 131 | if err != nil { 132 | return "", fmt.Errorf("get struct value error -> %s", err.Error()) 133 | } 134 | if structValue.pkColumnName == "" || structValue.pkStringValue == "" { 135 | return "", errors.New("primary key can not be empty") 136 | } 137 | s := fmt.Sprintf("DELETE FROM %s WHERE %s = %s", structValue.tableName, structValue.pkColumnName, structValue.pkStringValue) 138 | printLog(s) 139 | return s, nil 140 | } 141 | -------------------------------------------------------------------------------- /horm/reflect.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | import ( 4 | "database/sql" 5 | "fmt" 6 | "reflect" 7 | "strconv" 8 | "strings" 9 | "time" 10 | ) 11 | 12 | //结构体信息 13 | type StructInfo struct { 14 | tableName string //表名 15 | structFieldMap map[string]*reflect.StructField //字段名->字段反射信息 16 | columnFieldMap map[string]string //列名->字段名 17 | pkField *reflect.StructField //主键 18 | pkColumnName string //主键字段名 19 | pkAutoIncrease bool //主键是否自增长 20 | } 21 | 22 | //结构体字段值 23 | type structValue struct { 24 | value *reflect.Value //结构体的值 25 | tableName string //表名 26 | fieldStringMap map[string]string //列名->字符串值 27 | fieldValueMap map[string]*reflect.Value //列名->反射值 28 | pkStringValue string //主键字符串值 29 | pkColumnName string //主键的列名 30 | autoIncrease bool //是否自增长 31 | } 32 | 33 | var structInfoMap map[string]*StructInfo 34 | 35 | //获取结构体字段类型信息 36 | func getStuctInfo(i interface{}) (*StructInfo, error) { 37 | t := reflect.TypeOf(i) 38 | 39 | /*校验参数是否是指针或者切片,如果是,则获取指向的元素的反射类型信息,如果参数不是结构体指针或者切片,返回错误*/ 40 | kind := t.Kind() 41 | if kind == reflect.Ptr || kind == reflect.Slice { 42 | t = t.Elem() 43 | kind = t.Kind() 44 | } 45 | if kind != reflect.Struct { 46 | return nil, fmt.Errorf("[%s] is not struct", kind) 47 | } 48 | 49 | /*从缓存中获反射信息*/ 50 | if v, ok := structInfoMap[t.Name()]; ok { 51 | return v, nil 52 | } 53 | 54 | var primarayKeyField *reflect.StructField = nil 55 | pkColumnName := "" 56 | auto := false 57 | sfMap := make(map[string]*reflect.StructField) 58 | 59 | /*遍历结构体字段,保存带有field标签的字段类型信息*/ 60 | for j := 0; j < t.NumField(); j++ { 61 | sf := t.Field(j) 62 | tags := strings.Split(strings.TrimSpace(sf.Tag.Get(COLUMN_TAG)), ",") 63 | if tags[0] != "" { 64 | if len(tags) >= 2 && tags[1] == "pk" { 65 | primarayKeyField = &sf 66 | pkColumnName = tags[0] 67 | if len(tags) >= 3 && tags[2] == "auto" { 68 | auto = true 69 | } 70 | } else { 71 | sfMap[sf.Name] = &sf 72 | } 73 | } 74 | } 75 | 76 | si := &StructInfo{structFieldMap: sfMap, pkField: primarayKeyField, pkColumnName: pkColumnName, pkAutoIncrease: auto} 77 | 78 | /*通过table接口调用GetTableName方法获取表名*/ 79 | if table, ok := i.(Table); ok { 80 | si.tableName = table.GetTableName() 81 | } else { 82 | return nil, fmt.Errorf("[%s] did not implement the [Table] interface", t.Name()) 83 | } 84 | 85 | structInfoMap[kind.String()] = si //存放结构体类型信息到缓存里 86 | return si, nil 87 | } 88 | 89 | //获取结构体字段值 90 | func getStructValue(i interface{}) (*structValue, error) { 91 | v := reflect.Indirect(reflect.ValueOf(i)) 92 | sf, err := getStuctInfo(i) //获取参数类型反射信息 93 | if err != nil { 94 | return nil, fmt.Errorf("get [%s] struct info failed -> %s", v.Type().Name(), err.Error()) 95 | } 96 | stringMap := make(map[string]string) 97 | valueMap := make(map[string]*reflect.Value) 98 | 99 | /*遍历结构体类型信息中保存的字段(过滤非field标签字段),并过滤非可导出的字段,获取字段的值*/ 100 | for fieldName, structField := range sf.structFieldMap { 101 | value := v.FieldByName(fieldName) 102 | if !value.CanSet() { 103 | return nil, fmt.Errorf("field [%s] is unexported", fieldName) 104 | } 105 | convertedValue, err := convertString(value, value.Kind()) 106 | if err != nil { 107 | return nil, fmt.Errorf("convert [value=%s type=%s] error", value.Type(), value.Kind().String()) 108 | } 109 | tags := strings.Split(strings.TrimSpace(structField.Tag.Get(COLUMN_TAG)), ",") 110 | stringMap[tags[0]] = convertedValue 111 | valueMap[tags[0]] = &value 112 | } 113 | 114 | sv := &structValue{ 115 | value: &v, 116 | fieldValueMap: valueMap, 117 | fieldStringMap: stringMap, 118 | tableName: sf.tableName, 119 | autoIncrease: sf.pkAutoIncrease, 120 | pkColumnName: sf.pkColumnName, 121 | } 122 | 123 | /*获取主键字段的值,校验主键字段是否可导出和是否是自增*/ 124 | if sf.pkField != nil { 125 | pkValue := v.FieldByName(sf.pkField.Name) //获取主键的反射值 126 | valueMap[sv.pkColumnName] = &pkValue 127 | if !v.FieldByName(sf.pkField.Name).CanSet() { 128 | return nil, fmt.Errorf("primary key [%s] is unexported", sf.pkField.Name) 129 | } 130 | pkStringValue, err := convertString(v.FieldByName(sf.pkField.Name), sf.pkField.Type.Kind()) 131 | if err != nil { 132 | return nil, fmt.Errorf("convert id error:%s", err.Error()) 133 | } 134 | sv.pkStringValue = pkStringValue 135 | } 136 | 137 | return sv, nil 138 | } 139 | 140 | //获取切片的元素 141 | func getSliceElem(list interface{}) (interface{}, error) { 142 | v := reflect.Indirect(reflect.ValueOf(list)) 143 | if v.Kind() != reflect.Slice { 144 | return nil, fmt.Errorf("[%s] not a slice", v.Kind()) 145 | } 146 | elementType := v.Type().Elem() 147 | return reflect.New(elementType).Interface(), nil 148 | } 149 | 150 | //转换反射值为字符串值 151 | func convertString(v reflect.Value, k reflect.Kind) (string, error) { 152 | switch k { 153 | case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: 154 | return strconv.Itoa(int(v.Int())), nil 155 | case reflect.Float64: 156 | return floatToString(v.Float()), nil 157 | case reflect.String: 158 | return "'" + v.String() + "'", nil 159 | case reflect.Struct: 160 | if t, ok := v.Interface().(time.Time); ok { 161 | return t.Format("'2006-01-02 15:04:05'"), nil 162 | } 163 | } 164 | return "", fmt.Errorf("convert value to string error:not support type[%s]", v.Type().Name()) 165 | } 166 | 167 | //通过反射设置一个字段的值 168 | func setValue(v *reflect.Value, rb sql.RawBytes) error { 169 | k := v.Kind() 170 | switch k { 171 | case reflect.Int: 172 | intValue, err := strconv.Atoi(string(rb)) 173 | if err != nil { 174 | return fmt.Errorf("Set [%s] value failed:%s", k.String(), err) 175 | } 176 | v.Set(reflect.ValueOf(intValue)) 177 | case reflect.Int8: 178 | intValue, err := strconv.Atoi(string(rb)) 179 | if err != nil { 180 | return err 181 | } 182 | v.Set(reflect.ValueOf(int8(intValue))) 183 | case reflect.Int16: 184 | intValue, err := strconv.Atoi(string(rb)) 185 | if err != nil { 186 | return err 187 | } 188 | v.Set(reflect.ValueOf(int16(intValue))) 189 | case reflect.Int32: 190 | intValue, err := strconv.Atoi(string(rb)) 191 | if err != nil { 192 | return err 193 | } 194 | v.Set(reflect.ValueOf(int32(intValue))) 195 | case reflect.Int64: 196 | intValue, err := strconv.Atoi(string(rb)) 197 | if err != nil { 198 | return err 199 | } 200 | v.Set(reflect.ValueOf(int64(intValue))) 201 | case reflect.Float64: 202 | floatValue, err := strconv.ParseFloat(string(rb), 64) 203 | if err != nil { 204 | return err 205 | } 206 | v.Set(reflect.ValueOf(floatValue)) 207 | case reflect.String: 208 | v.Set(reflect.ValueOf(string(rb))) 209 | case reflect.Struct: 210 | t, err := time.Parse("2006-01-02 15:04:05", string(rb)) 211 | if err != nil { 212 | return err 213 | } 214 | v.Set(reflect.ValueOf(t)) 215 | } 216 | return nil 217 | } 218 | 219 | func floatToString(f float64) string { 220 | return strconv.FormatFloat(f, 'f', 2, 64) 221 | } 222 | -------------------------------------------------------------------------------- /horm/horm.go: -------------------------------------------------------------------------------- 1 | package horm 2 | 3 | import ( 4 | "database/sql" 5 | "errors" 6 | "fmt" 7 | _ "github.com/go-sql-driver/mysql" 8 | "reflect" 9 | "strings" 10 | "sync" 11 | ) 12 | 13 | type IHorm interface { 14 | List(list interface{}, conditions ...string) error //查询列表 15 | FindById(i interface{}) error //根据id查找 16 | Save(i interface{}) (*Result, error) //插入单个记录 17 | UpdateById(i interface{}) (*Result, error) //根据id更新 18 | DelById(i interface{}) (*Result, error) //根据id删除 19 | Query(string, interface{}) error //自定义sql 20 | Exec(string) (*Result, error) //自定义sql 21 | Begin() error //开始事务 22 | Commit() error //提交事务 23 | RollBack() error //回滚 24 | RegistMapping(i interface{}) error //注册映射(目前为自动注册) 25 | } 26 | 27 | type defaultHorm struct { 28 | db *sql.DB 29 | mappings *resultMap 30 | txMap map[uint64]*sql.Tx 31 | mutex sync.Mutex 32 | } 33 | 34 | func (d *defaultHorm) List(list interface{}, conditions ...string) error { 35 | ele, err := getSliceElem(list) 36 | if err != nil { 37 | return fmt.Errorf("get slice element failed -> %s", err.Error()) 38 | } 39 | sqlStr, err := sqlGenerator.GenerateListSql(ele, conditions...) 40 | if err != nil { 41 | return fmt.Errorf("Generate sql error:%s", err.Error()) 42 | } 43 | rows, stmt, err := d.query(sqlStr) 44 | if err != nil { 45 | return fmt.Errorf("Query select sql error:%s", err) 46 | } 47 | err = injectStructList(list, ele, rows) 48 | if err != nil { 49 | return fmt.Errorf("Data inject error:%s", err) 50 | } 51 | err = rows.Close() 52 | if err != nil { 53 | return fmt.Errorf("close rows failed -> %s", err.Error()) 54 | } 55 | err = stmt.Close() 56 | if err != nil { 57 | return fmt.Errorf("Close statement error:%s", err.Error()) 58 | } 59 | return nil 60 | } 61 | 62 | func (d *defaultHorm) FindById(i interface{}) error { 63 | sqlStr, err := sqlGenerator.GenerateFindByIdSql(i) 64 | if err != nil { 65 | return fmt.Errorf("generate sql error:%s", err.Error()) 66 | } 67 | rows, stmt, err := d.query(sqlStr) 68 | if err != nil { 69 | return fmt.Errorf("Query select sql error:%s", err) 70 | } 71 | err = injectOneStruct(i, rows) 72 | if err != nil { 73 | return fmt.Errorf("Data inject error:%s", err) 74 | } 75 | err = rows.Close() 76 | if err != nil { 77 | return fmt.Errorf("close rows failed -> %s", err.Error()) 78 | } 79 | err = stmt.Close() 80 | if err != nil { 81 | return fmt.Errorf("Close statement error:%s", err.Error()) 82 | } 83 | return nil 84 | } 85 | 86 | func (d *defaultHorm) Save(i interface{}) (*Result, error) { 87 | sqlStr, err := sqlGenerator.GenerateSaveSql(i) 88 | if err != nil { 89 | return nil, fmt.Errorf("generate sql failed:%s", err.Error()) 90 | } 91 | return d.exec(sqlStr) 92 | } 93 | 94 | func (d *defaultHorm) UpdateById(i interface{}) (*Result, error) { 95 | sqlStr, err := sqlGenerator.GenerateUpdateByIdSql(i) 96 | if err != nil { 97 | return nil, errors.New("Generate sql failed:" + err.Error()) 98 | } 99 | return d.exec(sqlStr) 100 | } 101 | 102 | func (d *defaultHorm) DelById(i interface{}) (*Result, error) { 103 | sqlStr, err := sqlGenerator.GenerateDelByIdSql(i) 104 | if err != nil { 105 | return nil, errors.New("Generate sql failed:" + err.Error()) 106 | } 107 | return d.exec(sqlStr) 108 | } 109 | 110 | func (d *defaultHorm) Query(s string, i interface{}) error { 111 | t := reflect.TypeOf(i) 112 | if t.Kind() == reflect.Ptr { 113 | t = t.Elem() 114 | } 115 | printLog(s) 116 | rows, stmt, err := d.query(s) 117 | if err != nil { 118 | return fmt.Errorf("Query select sql error:%s", err) 119 | } 120 | switch t.Kind() { 121 | case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.String: 122 | err = injectOneField(i, rows) 123 | case reflect.Struct: 124 | err = injectOneStruct(i, rows) 125 | case reflect.Slice: 126 | ele, err := getSliceElem(i) 127 | if err != nil { 128 | return fmt.Errorf("get slice element failed -> %s", err.Error()) 129 | } 130 | if reflect.TypeOf(ele).Elem().Kind() == reflect.Struct { 131 | err = injectStructList(i, ele, rows) 132 | } else { 133 | err = injectOneFieldList(i, ele, rows) 134 | } 135 | if err != nil { 136 | return fmt.Errorf("Inject one field failed:%s", err.Error()) 137 | } 138 | } 139 | err = rows.Close() 140 | if err != nil { 141 | return fmt.Errorf("Close rows failed:%s", err.Error()) 142 | } 143 | err = stmt.Close() 144 | if err != nil { 145 | return fmt.Errorf("Close statement error:%s", err.Error()) 146 | } 147 | return nil 148 | } 149 | 150 | func (d *defaultHorm) Exec(s string) (*Result, error) { 151 | return d.exec(s) 152 | } 153 | 154 | func (d *defaultHorm) exec(sqlStr string) (*Result, error) { 155 | stmt, err := d.getStatement(sqlStr) 156 | if err != nil { 157 | return nil, fmt.Errorf("Get statement error:%s", err.Error()) 158 | } 159 | result, err := stmt.Exec() 160 | if err != nil { 161 | return nil, fmt.Errorf("Execute sql error:%s", err.Error()) 162 | } 163 | err = stmt.Close() 164 | if err != nil { 165 | return nil, fmt.Errorf("Close statement error:%s", err.Error()) 166 | } 167 | lastInsertId64, err := result.LastInsertId() 168 | if err != nil { 169 | return nil, err 170 | } 171 | rowsAffected64, err := result.RowsAffected() 172 | if err != nil { 173 | return nil, err 174 | } 175 | r := &Result{ 176 | LastInsertId: int(lastInsertId64), 177 | LastInsertId64: lastInsertId64, 178 | RowsAffected: int(rowsAffected64), 179 | RowsAffected64: rowsAffected64, 180 | } 181 | return r, nil 182 | } 183 | 184 | func (d *defaultHorm) query(sqlStr string) (*sql.Rows, *sql.Stmt, error) { 185 | stmt, err := d.getStatement(sqlStr) 186 | if err != nil { 187 | return nil, nil, fmt.Errorf("get statement error:%s", err.Error()) 188 | } 189 | rows, err := stmt.Query() 190 | if err != nil { 191 | return nil, nil, fmt.Errorf("execute sql error:%s", err.Error()) 192 | } 193 | return rows, stmt, nil 194 | } 195 | 196 | //向单个字段注入数据 197 | func injectOneField(i interface{}, rows *sql.Rows) error { 198 | columns, err := rows.Columns() 199 | if err != nil { 200 | fmt.Errorf("get columns error:%s", err.Error()) 201 | } 202 | if len(columns) != 1 { 203 | fmt.Errorf("found [%d] column but 1", len(columns)) 204 | } 205 | rowNum := 0 206 | for rows.Next() { 207 | rowNum++ 208 | if rowNum > 1 { 209 | return errors.New("select one but found more") 210 | } 211 | err = rows.Scan(i) 212 | if err != nil { 213 | return err 214 | } 215 | } 216 | return nil 217 | } 218 | 219 | //向单个结构体注入数据 220 | func injectOneStruct(i interface{}, rows *sql.Rows) error { 221 | columns, err := rows.Columns() 222 | if err != nil { 223 | fmt.Errorf("get columns error:%s", err.Error()) 224 | } 225 | values := make([]sql.RawBytes, len(columns)) 226 | scans := make([]interface{}, len(columns)) 227 | for index, _ := range values { 228 | scans[index] = &values[index] 229 | } 230 | sv, err := getStructValue(i) 231 | if err != nil { 232 | return fmt.Errorf("get struct value failed:%s", err.Error()) 233 | } 234 | rowNum := 0 235 | for rows.Next() { 236 | rowNum++ 237 | if rowNum > 1 { 238 | return errors.New("select one but found more") 239 | } 240 | err = rows.Scan(scans...) 241 | if err != nil { 242 | return err 243 | } 244 | for k, v := range values { 245 | f := sv.fieldValueMap[columns[k]] 246 | if f != nil { 247 | err = setValue(f, v) 248 | if err != nil { 249 | return fmt.Errorf("set value failed -> %s", err) 250 | } 251 | } 252 | } 253 | } 254 | return nil 255 | } 256 | 257 | //向单个字段切片注入数据 258 | func injectOneFieldList(list interface{}, ele interface{}, rows *sql.Rows) error { 259 | columns, err := rows.Columns() 260 | if err != nil { 261 | return fmt.Errorf("get columns error:%s", err.Error()) 262 | } 263 | if len(columns) != 1 { 264 | return fmt.Errorf("found [%d] columns but one", len(columns)) 265 | } 266 | listValue := reflect.ValueOf(list).Elem() 267 | for rows.Next() { 268 | err = rows.Scan(ele) 269 | if err != nil { 270 | return err 271 | } 272 | listValue.Set(reflect.Append(listValue, reflect.ValueOf(ele).Elem())) 273 | } 274 | return nil 275 | } 276 | 277 | //向结构体切片注入数据 278 | func injectStructList(list interface{}, ele interface{}, rows *sql.Rows) error { 279 | columns, err := rows.Columns() 280 | if err != nil { 281 | fmt.Errorf("get columns error:%s", err.Error()) 282 | } 283 | values := make([]sql.RawBytes, len(columns)) 284 | scans := make([]interface{}, len(columns)) 285 | for index, _ := range values { 286 | scans[index] = &values[index] 287 | } 288 | listValue := reflect.ValueOf(list).Elem() 289 | sv, err := getStructValue(ele) 290 | if err != nil { 291 | return fmt.Errorf("get slice [%s] element struct reflect type failed -> %s", listValue.Type().Name(), err.Error()) 292 | } 293 | for rows.Next() { 294 | err = rows.Scan(scans...) 295 | if err != nil { 296 | return err 297 | } 298 | for k, v := range values { 299 | f := sv.fieldValueMap[columns[k]] 300 | if f != nil { 301 | err = setValue(f, v) 302 | if err != nil { 303 | return fmt.Errorf("set value failed -> %s", err) 304 | } 305 | } 306 | } 307 | listValue.Set(reflect.Append(listValue, *sv.value)) 308 | } 309 | return nil 310 | } 311 | 312 | func (d *defaultHorm) Begin() error { 313 | printLog("transaction begin↓↓") 314 | d.mutex.Lock() 315 | var err error 316 | tx, err := d.db.Begin() 317 | if err != nil { 318 | return errors.New("transaction error -> " + err.Error()) 319 | } 320 | d.txMap[getGID()] = tx 321 | return nil 322 | } 323 | 324 | func (d *defaultHorm) Commit() error { 325 | printLog("transaction commit↑↑") 326 | defer d.mutex.Unlock() 327 | return d.txMap[getGID()].Commit() 328 | } 329 | 330 | func (d *defaultHorm) RollBack() error { 331 | printLog("transaction rollback↑↑") 332 | defer d.mutex.Unlock() 333 | return d.txMap[getGID()].Rollback() 334 | } 335 | 336 | func (d *defaultHorm) RegistMapping(i interface{}) error { 337 | return errors.New("Not yet supported") 338 | } 339 | 340 | func (d *defaultHorm) getStatement(s string) (*sql.Stmt, error) { 341 | s = strings.TrimSpace(s) 342 | if d.txMap[getGID()] == nil { 343 | stmt, err := d.db.Prepare(s) 344 | return stmt, err 345 | } 346 | return d.txMap[getGID()].Prepare(s) 347 | } 348 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------