gosora/query_gen/querygen.go

252 lines
6.4 KiB
Go
Raw Normal View History

/* WIP Under Construction */
2022-02-21 03:53:13 +00:00
package qgen // import "git.tuxpa.in/a/gosora/query_gen"
import (
2022-02-21 03:53:13 +00:00
"database/sql"
"errors"
"strconv"
"strings"
"sync"
)
var Registry []Adapter
var ErrNoAdapter = errors.New("This adapter doesn't exist")
var queryStrPool = sync.Pool{}
type DBTableColumn struct {
2022-02-21 03:32:53 +00:00
Name string
Type string
Size int
Null bool
AutoIncrement bool
Default string
Added the Social Groups plugin. This is still under construction. Made a few improvements to the ForumStore, including bringing it's API closer in line with the other datastores, adding stubs for future subforum functionality, and improving efficiency in a few places. The auth interface now handles all the authentication stuff. Renamed the debug config variable to debug_mode. Added the PluginPerms API. Internal Errors will now dump the stack trace in the console. Added support for installable plugins. Refactored the routing logic so that the router now handles the common PreRoute logic(exc. /static/) Added the CreateTable method to the query generator. It might need some tweaking to better support other database systems. Added the same CreateTable method to the query builder. Began work on PostgreSQL support. Added the string-string hook type Added the pre_render hook type. Added the ParentID and ParentType fields to forums. Added the get_forum_url_prefix function. Added a more generic build_slug function. Added the get_topic_url_prefix function. Added the override_perms and override_forum_perms functions for bulk setting and unsetting permissions. Added more ExtData fields in a few structs and removed them on the Perms struct as the PluginPerms API supersedes them there. Plugins can now see the router instance. The plugin initialisation handlers can now throw errors. Plugins are now initialised after all the forum's subsystems are. Refactored the unit test logic. For instance, we now use the proper .Log method rather than fmt.Println in many cases. Sorry, we'll have to break Github's generated file detection, as the build instructions aren't working, unless I put them at the top, and they're far, far more important than getting Github to recognise the generated code as generated code. Fixed an issue with mysql.go's _init_database() overwriting the dbpassword variable. Not a huge issue, but it is a "gotcha" for those not expecting a ':' at the start. Fixed an issue with forum creation where the forum permissions didn't get cached. Fixed a bug in plugin_bbcode where negative numbers in rand would crash Gosora. Made the outputs of plugin_markdown and plugin_bbcode more compliant with the tests. Revamped the phrase system to make it easier for us to add language pack related features in the future. Added the WidgetMenu widget type. Revamped the theme again. I'm experimenting to see which approach I like most. - Excuse the little W3C rage. Some things about CSS drive me crazy :p Tests: Added 22 bbcode_full_parse tests. Added 19 bbcode_regex_parse tests. Added 27 markdown_parse tests. Added four UserStore tests. More to come when the test database functionality is added. Added 18 name_to_slug tests. Hooks: Added the pre_render hook. Added the pre_render_forum_list hook. Added the pre_render_view_forum hook. Added the pre_render_topic_list hook. Added the pre_render_view_topic hook. Added the pre_render_profile hook. Added the pre_render_custom_page hook. Added the pre_render_overview hook. Added the pre_render_create_topic hook. Added the pre_render_account_own_edit_critical hook. Added the pre_render_account_own_edit_avatar hook. Added the pre_render_account_own_edit_username hook. Added the pre_render_account_own_edit_email hook. Added the pre_render_login hook. Added the pre_render_register hook. Added the pre_render_ban hook. Added the pre_render_panel_dashboard hook. Added the pre_render_panel_forums hook. Added the pre_render_panel_delete_forum hook. Added the pre_render_panel_edit_forum hook. Added the pre_render_panel_settings hook. Added the pre_render_panel_setting hook. Added the pre_render_panel_plugins hook. Added the pre_render_panel_users hook. Added the pre_render_panel_edit_user hook. Added the pre_render_panel_groups hook. Added the pre_render_panel_edit_group hook. Added the pre_render_panel_edit_group_perms hook. Added the pre_render_panel_themes hook. Added the pre_render_panel_mod_log hook. Added the pre_render_error hook. Added the pre_render_security_error hook. Added the create_group_preappend hook. Added the intercept_build_widgets hook. Added the simple_forum_check_pre_perms hook. Added the forum_check_pre_perms hook.
2017-07-09 12:06:04 +00:00
}
type DBTableKey struct {
2022-02-21 03:32:53 +00:00
Columns string
Type string
2022-02-21 03:32:53 +00:00
// Foreign keys only
FTable string
Cascade bool
Added the Social Groups plugin. This is still under construction. Made a few improvements to the ForumStore, including bringing it's API closer in line with the other datastores, adding stubs for future subforum functionality, and improving efficiency in a few places. The auth interface now handles all the authentication stuff. Renamed the debug config variable to debug_mode. Added the PluginPerms API. Internal Errors will now dump the stack trace in the console. Added support for installable plugins. Refactored the routing logic so that the router now handles the common PreRoute logic(exc. /static/) Added the CreateTable method to the query generator. It might need some tweaking to better support other database systems. Added the same CreateTable method to the query builder. Began work on PostgreSQL support. Added the string-string hook type Added the pre_render hook type. Added the ParentID and ParentType fields to forums. Added the get_forum_url_prefix function. Added a more generic build_slug function. Added the get_topic_url_prefix function. Added the override_perms and override_forum_perms functions for bulk setting and unsetting permissions. Added more ExtData fields in a few structs and removed them on the Perms struct as the PluginPerms API supersedes them there. Plugins can now see the router instance. The plugin initialisation handlers can now throw errors. Plugins are now initialised after all the forum's subsystems are. Refactored the unit test logic. For instance, we now use the proper .Log method rather than fmt.Println in many cases. Sorry, we'll have to break Github's generated file detection, as the build instructions aren't working, unless I put them at the top, and they're far, far more important than getting Github to recognise the generated code as generated code. Fixed an issue with mysql.go's _init_database() overwriting the dbpassword variable. Not a huge issue, but it is a "gotcha" for those not expecting a ':' at the start. Fixed an issue with forum creation where the forum permissions didn't get cached. Fixed a bug in plugin_bbcode where negative numbers in rand would crash Gosora. Made the outputs of plugin_markdown and plugin_bbcode more compliant with the tests. Revamped the phrase system to make it easier for us to add language pack related features in the future. Added the WidgetMenu widget type. Revamped the theme again. I'm experimenting to see which approach I like most. - Excuse the little W3C rage. Some things about CSS drive me crazy :p Tests: Added 22 bbcode_full_parse tests. Added 19 bbcode_regex_parse tests. Added 27 markdown_parse tests. Added four UserStore tests. More to come when the test database functionality is added. Added 18 name_to_slug tests. Hooks: Added the pre_render hook. Added the pre_render_forum_list hook. Added the pre_render_view_forum hook. Added the pre_render_topic_list hook. Added the pre_render_view_topic hook. Added the pre_render_profile hook. Added the pre_render_custom_page hook. Added the pre_render_overview hook. Added the pre_render_create_topic hook. Added the pre_render_account_own_edit_critical hook. Added the pre_render_account_own_edit_avatar hook. Added the pre_render_account_own_edit_username hook. Added the pre_render_account_own_edit_email hook. Added the pre_render_login hook. Added the pre_render_register hook. Added the pre_render_ban hook. Added the pre_render_panel_dashboard hook. Added the pre_render_panel_forums hook. Added the pre_render_panel_delete_forum hook. Added the pre_render_panel_edit_forum hook. Added the pre_render_panel_settings hook. Added the pre_render_panel_setting hook. Added the pre_render_panel_plugins hook. Added the pre_render_panel_users hook. Added the pre_render_panel_edit_user hook. Added the pre_render_panel_groups hook. Added the pre_render_panel_edit_group hook. Added the pre_render_panel_edit_group_perms hook. Added the pre_render_panel_themes hook. Added the pre_render_panel_mod_log hook. Added the pre_render_error hook. Added the pre_render_security_error hook. Added the create_group_preappend hook. Added the intercept_build_widgets hook. Added the simple_forum_check_pre_perms hook. Added the forum_check_pre_perms hook.
2017-07-09 12:06:04 +00:00
}
type DBSelect struct {
2022-02-21 03:32:53 +00:00
Table string
Columns string
Where string
Orderby string
Limit string
}
type DBJoin struct {
2022-02-21 03:32:53 +00:00
Table1 string
Table2 string
Columns string
Joiners string
Where string
Orderby string
Limit string
}
type DBInsert struct {
2022-02-21 03:32:53 +00:00
Table string
Columns string
Fields string
}
type DBColumn struct {
2022-02-21 03:32:53 +00:00
Table string
Left string // Could be a function or a column, so I'm naming this Left
Alias string // aka AS Blah, if it's present
//Type string // function or column
Type int
}
const (
2022-02-21 03:32:53 +00:00
IdenFunc = iota
IdenColumn
IdenString
IdenLiteral
)
type DBField struct {
2022-02-21 03:32:53 +00:00
Name string
//Type string
Type int
}
type DBWhere struct {
2022-02-21 03:32:53 +00:00
Expr []DBToken // Simple expressions, the innards of functions are opaque for now.
}
type DBJoiner struct {
2022-02-21 03:32:53 +00:00
LeftTable string
LeftColumn string
RightTable string
RightColumn string
Operator string
}
type DBOrder struct {
2022-02-21 03:32:53 +00:00
Column string
Order string
}
const (
2022-02-21 03:32:53 +00:00
TokenFunc = iota
TokenOp
TokenColumn
TokenNumber
TokenString
TokenSub
TokenOr
TokenNot
TokenLike
TokenScope
)
type DBToken struct {
2022-02-21 03:32:53 +00:00
Contents string
//Type string // function, op, column, number, string, sub, not, like
Type int
}
type DBSetter struct {
2022-02-21 03:32:53 +00:00
Column string
Expr []DBToken // Simple expressions, the innards of functions are opaque for now.
}
type DBLimit struct {
2022-02-21 03:32:53 +00:00
Offset string // ? or int
MaxCount string // ? or int
}
type DBStmt struct {
2022-02-21 03:32:53 +00:00
Contents string
Type string // create-table, insert, update, delete
2017-07-12 11:05:18 +00:00
}
// TODO: Add the TableExists and ColumnExists methods
type Adapter interface {
2022-02-21 03:32:53 +00:00
GetName() string
BuildConn(config map[string]string) (*sql.DB, error)
DbVersion() string
DropTable(name, table string) (string, error)
CreateTable(name, table, charset, collation string, cols []DBTableColumn, keys []DBTableKey) (string, error)
// TODO: Some way to add indices and keys
// TODO: Test this
AddColumn(name, table string, col DBTableColumn, key *DBTableKey) (string, error)
DropColumn(name, table, colName string) (string, error)
RenameColumn(name, table, oldName, newName string) (string, error)
ChangeColumn(name, table, colName string, col DBTableColumn) (string, error)
SetDefaultColumn(name, table, colName, colType, defaultStr string) (string, error)
AddIndex(name, table, iname, colname string) (string, error)
AddKey(name, table, col string, key DBTableKey) (string, error)
RemoveIndex(name, table, col string) (string, error)
AddForeignKey(name, table, col, ftable, fcol string, cascade bool) (out string, e error)
SimpleInsert(name, table, cols, fields string) (string, error)
SimpleBulkInsert(name, table, cols string, fieldSet []string) (string, error)
SimpleUpdate(b *updatePrebuilder) (string, error)
SimpleUpdateSelect(b *updatePrebuilder) (string, error) // ! Experimental
SimpleDelete(name, table, where string) (string, error)
Purge(name, table string) (string, error)
SimpleSelect(name, table, cols, where, orderby, limit string) (string, error)
ComplexDelete(b *deletePrebuilder) (string, error)
SimpleLeftJoin(name, table1, table2, cols, joiners, where, orderby, limit string) (string, error)
SimpleInnerJoin(string, string, string, string, string, string, string, string) (string, error)
SimpleInsertSelect(string, DBInsert, DBSelect) (string, error)
SimpleInsertLeftJoin(string, DBInsert, DBJoin) (string, error)
SimpleInsertInnerJoin(string, DBInsert, DBJoin) (string, error)
SimpleCount(string, string, string, string) (string, error)
ComplexSelect(*selectPrebuilder) (string, error)
Builder() *prebuilder
Write() error
}
func GetAdapter(name string) (adap Adapter, err error) {
2022-02-21 03:32:53 +00:00
for _, adapter := range Registry {
if adapter.GetName() == name {
return adapter, nil
}
}
return adap, ErrNoAdapter
}
type QueryPlugin interface {
2022-02-21 03:32:53 +00:00
Hook(name string, args ...interface{}) error
Write() error
}
type MySQLUpsertCallback struct {
2022-02-21 03:32:53 +00:00
stmt *sql.Stmt
}
func (double *MySQLUpsertCallback) Exec(args ...interface{}) (res sql.Result, err error) {
2022-02-21 03:32:53 +00:00
if len(args) < 2 {
return res, errors.New("Need two or more arguments")
}
args = args[:len(args)-1]
return double.stmt.Exec(append(args, args...)...)
}
func PrepareMySQLUpsertCallback(db *sql.DB, query string) (*MySQLUpsertCallback, error) {
2022-02-21 03:32:53 +00:00
stmt, err := db.Prepare(query)
return &MySQLUpsertCallback{stmt}, err
}
type LitStr string
// TODO: Test this
func InterfaceMapToInsertStrings(data map[string]interface{}, order string) (cols, values string) {
2022-02-21 03:32:53 +00:00
done := make(map[string]bool)
addValue := func(value interface{}) {
switch value := value.(type) {
case string:
values += "'" + strings.Replace(value, "'", "\\'", -1) + "',"
case int:
values += strconv.Itoa(value) + ","
case LitStr:
values += string(value) + ","
case bool:
if value {
values += "1,"
} else {
values += "0,"
}
}
}
// Add the ordered items
for _, col := range strings.Split(order, ",") {
col = strings.TrimSpace(col)
value, ok := data[col]
if ok {
cols += col + ","
addValue(value)
done[col] = true
}
}
// Go over any unordered items and add them at the end
if len(data) > len(done) {
for col, value := range data {
_, ok := done[col]
if ok {
continue
}
cols += col + ","
addValue(value)
}
}
if cols != "" {
cols = cols[:len(cols)-1]
values = values[:len(values)-1]
}
return cols, values
}