forked from casbin/gorm-adapter
/
adapter.go
executable file
·398 lines (348 loc) · 9.05 KB
/
adapter.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
// Copyright 2017 The casbin Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package gormadapter
import (
"errors"
"runtime"
"github.com/casbin/casbin/model"
"github.com/casbin/casbin/persist"
"github.com/jinzhu/gorm"
"github.com/lib/pq"
)
type CasbinRule struct {
PType string `gorm:"size:100"`
V0 string `gorm:"size:100"`
V1 string `gorm:"size:100"`
V2 string `gorm:"size:100"`
V3 string `gorm:"size:100"`
V4 string `gorm:"size:100"`
V5 string `gorm:"size:100"`
}
type Filter struct {
PType []string
V0 []string
V1 []string
V2 []string
V3 []string
V4 []string
V5 []string
}
func (c *CasbinRule) TableName() string {
return "casbin_rule" //as Gorm keeps table names are plural, and we love consistency
}
// Adapter represents the Gorm adapter for policy storage.
type Adapter struct {
driverName string
dataSourceName string
dbSpecified bool
db *gorm.DB
isFiltered bool
}
// finalizer is the destructor for Adapter.
func finalizer(a *Adapter) {
a.db.Close()
}
// NewAdapter is the constructor for Adapter.
// dbSpecified is an optional bool parameter. The default value is false.
// It's up to whether you have specified an existing DB in dataSourceName.
// If dbSpecified == true, you need to make sure the DB in dataSourceName exists.
// If dbSpecified == false, the adapter will automatically create a DB named "casbin".
func NewAdapter(driverName string, dataSourceName string, dbSpecified ...bool) *Adapter {
a := &Adapter{}
a.driverName = driverName
a.dataSourceName = dataSourceName
if len(dbSpecified) == 0 {
a.dbSpecified = false
} else if len(dbSpecified) == 1 {
a.dbSpecified = dbSpecified[0]
} else {
panic(errors.New("invalid parameter: dbSpecified"))
}
// Open the DB, create it if not existed.
a.open()
// Call the destructor when the object is released.
runtime.SetFinalizer(a, finalizer)
return a
}
func NewAdapterByDB(db *gorm.DB) *Adapter {
a := &Adapter{
db: db,
}
a.createTable()
return a
}
func (a *Adapter) createDatabase() error {
var err error
var db *gorm.DB
if a.driverName == "postgres" {
db, err = gorm.Open(a.driverName, a.dataSourceName+" dbname=postgres")
} else {
db, err = gorm.Open(a.driverName, a.dataSourceName)
}
if err != nil {
return err
}
defer db.Close()
if a.driverName == "postgres" {
if err = db.Exec("CREATE DATABASE casbin").Error; err != nil {
// 42P04 is duplicate_database
if err.(*pq.Error).Code == "42P04" {
return nil
}
}
} else if a.driverName != "sqlite3" {
err = db.Exec("CREATE DATABASE IF NOT EXISTS casbin").Error
}
return err
}
func (a *Adapter) open() {
var err error
var db *gorm.DB
if a.dbSpecified {
db, err = gorm.Open(a.driverName, a.dataSourceName)
if err != nil {
panic(err)
}
} else {
if err = a.createDatabase(); err != nil {
panic(err)
}
if a.driverName == "postgres" {
db, err = gorm.Open(a.driverName, a.dataSourceName+" dbname=casbin")
} else if a.driverName == "sqlite3" {
db, err = gorm.Open(a.driverName, a.dataSourceName)
} else {
db, err = gorm.Open(a.driverName, a.dataSourceName+"casbin")
}
if err != nil {
panic(err)
}
}
a.db = db
a.createTable()
}
func (a *Adapter) close() {
a.db.Close()
a.db = nil
}
func (a *Adapter) createTable() {
if a.db.HasTable(&CasbinRule{}) {
return
}
err := a.db.CreateTable(&CasbinRule{}).Error
if err != nil {
panic(err)
}
}
func (a *Adapter) dropTable() {
err := a.db.DropTable(&CasbinRule{}).Error
if err != nil {
panic(err)
}
}
func loadPolicyLine(line CasbinRule, model model.Model) {
lineText := line.PType
if line.V0 != "" {
lineText += ", " + line.V0
}
if line.V1 != "" {
lineText += ", " + line.V1
}
if line.V2 != "" {
lineText += ", " + line.V2
}
if line.V3 != "" {
lineText += ", " + line.V3
}
if line.V4 != "" {
lineText += ", " + line.V4
}
if line.V5 != "" {
lineText += ", " + line.V5
}
persist.LoadPolicyLine(lineText, model)
}
// LoadPolicy loads policy from database.
func (a *Adapter) LoadPolicy(model model.Model) error {
var lines []CasbinRule
if err := a.db.Find(&lines).Error; err != nil {
return err
}
for _, line := range lines {
loadPolicyLine(line, model)
}
return nil
}
// LoadFilteredPolicy loads only policy rules that match the filter.
func (a *Adapter) LoadFilteredPolicy(model model.Model, filter interface{}) error {
var lines []CasbinRule
filterValue, ok := filter.(Filter)
if !ok {
return errors.New("invalid filter type")
}
if err := a.db.Scopes(a.filterQuery(a.db, filterValue)).Find(&lines).Error; err != nil {
return err
}
for _, line := range lines {
loadPolicyLine(line, model)
}
a.isFiltered = true
return nil
}
// IsFiltered returns true if the loaded policy has been filtered.
func (a *Adapter) IsFiltered() bool {
return a.isFiltered
}
// filterQuery builds the gorm query to match the rule filter to use within a scope.
func (a *Adapter) filterQuery(db *gorm.DB, filter Filter) func(db *gorm.DB) *gorm.DB {
return func(db *gorm.DB) *gorm.DB {
if len(filter.PType) > 0 {
db = db.Where("p_type in (?)", filter.PType)
}
if len(filter.V0) > 0 {
db = db.Where("v0 in (?)", filter.V0)
}
if len(filter.V1) > 0 {
db = db.Where("v1 in (?)", filter.V1)
}
if len(filter.V2) > 0 {
db = db.Where("v2 in (?)", filter.V2)
}
if len(filter.V3) > 0 {
db = db.Where("v3 in (?)", filter.V3)
}
if len(filter.V4) > 0 {
db = db.Where("v4 in (?)", filter.V4)
}
if len(filter.V5) > 0 {
db = db.Where("v5 in (?)", filter.V5)
}
return db
}
}
func savePolicyLine(ptype string, rule []string) CasbinRule {
line := CasbinRule{}
line.PType = ptype
if len(rule) > 0 {
line.V0 = rule[0]
}
if len(rule) > 1 {
line.V1 = rule[1]
}
if len(rule) > 2 {
line.V2 = rule[2]
}
if len(rule) > 3 {
line.V3 = rule[3]
}
if len(rule) > 4 {
line.V4 = rule[4]
}
if len(rule) > 5 {
line.V5 = rule[5]
}
return line
}
// SavePolicy saves policy to database.
func (a *Adapter) SavePolicy(model model.Model) error {
a.dropTable()
a.createTable()
for ptype, ast := range model["p"] {
for _, rule := range ast.Policy {
line := savePolicyLine(ptype, rule)
err := a.db.Create(&line).Error
if err != nil {
return err
}
}
}
for ptype, ast := range model["g"] {
for _, rule := range ast.Policy {
line := savePolicyLine(ptype, rule)
err := a.db.Create(&line).Error
if err != nil {
return err
}
}
}
return nil
}
// AddPolicy adds a policy rule to the storage.
func (a *Adapter) AddPolicy(sec string, ptype string, rule []string) error {
line := savePolicyLine(ptype, rule)
err := a.db.Create(&line).Error
return err
}
// RemovePolicy removes a policy rule from the storage.
func (a *Adapter) RemovePolicy(sec string, ptype string, rule []string) error {
line := savePolicyLine(ptype, rule)
err := rawDelete(a.db, line) //can't use db.Delete as we're not using primary key http://jinzhu.me/gorm/crud.html#delete
return err
}
// RemoveFilteredPolicy removes policy rules that match the filter from the storage.
func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error {
line := CasbinRule{}
line.PType = ptype
if fieldIndex <= 0 && 0 < fieldIndex+len(fieldValues) {
line.V0 = fieldValues[0-fieldIndex]
}
if fieldIndex <= 1 && 1 < fieldIndex+len(fieldValues) {
line.V1 = fieldValues[1-fieldIndex]
}
if fieldIndex <= 2 && 2 < fieldIndex+len(fieldValues) {
line.V2 = fieldValues[2-fieldIndex]
}
if fieldIndex <= 3 && 3 < fieldIndex+len(fieldValues) {
line.V3 = fieldValues[3-fieldIndex]
}
if fieldIndex <= 4 && 4 < fieldIndex+len(fieldValues) {
line.V4 = fieldValues[4-fieldIndex]
}
if fieldIndex <= 5 && 5 < fieldIndex+len(fieldValues) {
line.V5 = fieldValues[5-fieldIndex]
}
err := rawDelete(a.db, line)
return err
}
func rawDelete(db *gorm.DB, line CasbinRule) error {
queryArgs := []interface{}{line.PType}
queryStr := "p_type = ?"
if line.V0 != "" {
queryStr += " and v0 = ?"
queryArgs = append(queryArgs, line.V0)
}
if line.V1 != "" {
queryStr += " and v1 = ?"
queryArgs = append(queryArgs, line.V1)
}
if line.V2 != "" {
queryStr += " and v2 = ?"
queryArgs = append(queryArgs, line.V2)
}
if line.V3 != "" {
queryStr += " and v3 = ?"
queryArgs = append(queryArgs, line.V3)
}
if line.V4 != "" {
queryStr += " and v4 = ?"
queryArgs = append(queryArgs, line.V4)
}
if line.V5 != "" {
queryStr += " and v5 = ?"
queryArgs = append(queryArgs, line.V5)
}
args := append([]interface{}{queryStr}, queryArgs...)
err := db.Delete(CasbinRule{}, args...).Error
return err
}