File: transaction.go

package info (click to toggle)
golang-github-casbin-casbin 2.127.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,540 kB
  • sloc: makefile: 14
file content (435 lines) | stat: -rw-r--r-- 12,091 bytes parent folder | download
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
// Copyright 2025 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 casbin

import (
	"context"
	"errors"
	"sync"
	"time"

	"github.com/casbin/casbin/v2/model"
	"github.com/casbin/casbin/v2/persist"
)

const (
	// Default timeout duration for lock acquisition.
	defaultLockTimeout = 30 * time.Second
)

// Transaction represents a Casbin transaction.
// It provides methods to perform policy operations within a transaction.
// and commit or rollback all changes atomically.
type Transaction struct {
	id          string                     // Unique transaction identifier.
	enforcer    *TransactionalEnforcer     // Reference to the transactional enforcer.
	buffer      *TransactionBuffer         // Buffer for policy operations.
	txContext   persist.TransactionContext // Database transaction context.
	ctx         context.Context            // Context for the transaction.
	baseVersion int64                      // Model version at transaction start.
	committed   bool                       // Whether the transaction has been committed.
	rolledBack  bool                       // Whether the transaction has been rolled back.
	startTime   time.Time                  // Transaction start timestamp.
	mutex       sync.RWMutex               // Protects transaction state.
}

// AddPolicy adds a policy within the transaction.
// The policy is buffered and will be applied when the transaction is committed.
func (tx *Transaction) AddPolicy(params ...interface{}) (bool, error) {
	return tx.AddNamedPolicy("p", params...)
}

// buildRuleFromParams converts parameters to a rule slice.
func (tx *Transaction) buildRuleFromParams(params ...interface{}) []string {
	if len(params) == 1 {
		if strSlice, ok := params[0].([]string); ok {
			rule := make([]string, 0, len(strSlice))
			rule = append(rule, strSlice...)
			return rule
		}
	}

	rule := make([]string, 0, len(params))
	for _, param := range params {
		rule = append(rule, param.(string))
	}
	return rule
}

// checkTransactionStatus checks if the transaction is active.
func (tx *Transaction) checkTransactionStatus() error {
	if tx.committed || tx.rolledBack {
		return errors.New("transaction is not active")
	}
	return nil
}

// AddNamedPolicy adds a named policy within the transaction.
// The policy is buffered and will be applied when the transaction is committed.
func (tx *Transaction) AddNamedPolicy(ptype string, params ...interface{}) (bool, error) {
	tx.mutex.Lock()
	defer tx.mutex.Unlock()

	if err := tx.checkTransactionStatus(); err != nil {
		return false, err
	}

	rule := tx.buildRuleFromParams(params...)

	// Check if policy already exists in the buffered model.
	bufferedModel, err := tx.buffer.ApplyOperationsToModel(tx.buffer.GetModelSnapshot())
	if err != nil {
		return false, err
	}

	hasPolicy, err := bufferedModel.HasPolicy("p", ptype, rule)
	if hasPolicy || err != nil {
		return false, err
	}

	// Add operation to buffer.
	op := persist.PolicyOperation{
		Type:       persist.OperationAdd,
		Section:    "p",
		PolicyType: ptype,
		Rules:      [][]string{rule},
	}
	tx.buffer.AddOperation(op)

	return true, nil
}

// AddPolicies adds multiple policies within the transaction.
func (tx *Transaction) AddPolicies(rules [][]string) (bool, error) {
	return tx.AddNamedPolicies("p", rules)
}

// AddNamedPolicies adds multiple named policies within the transaction.
func (tx *Transaction) AddNamedPolicies(ptype string, rules [][]string) (bool, error) {
	tx.mutex.Lock()
	defer tx.mutex.Unlock()

	if err := tx.checkTransactionStatus(); err != nil {
		return false, err
	}

	if len(rules) == 0 {
		return false, nil
	}

	// Check if any policies already exist in the buffered model.
	bufferedModel, err := tx.buffer.ApplyOperationsToModel(tx.buffer.GetModelSnapshot())
	if err != nil {
		return false, err
	}

	var validRules [][]string
	for _, rule := range rules {
		hasPolicy, err := bufferedModel.HasPolicy("p", ptype, rule)
		if err != nil {
			return false, err
		}
		if !hasPolicy {
			validRules = append(validRules, rule)
		}
	}

	if len(validRules) == 0 {
		return false, nil
	}

	// Add operation to buffer.
	op := persist.PolicyOperation{
		Type:       persist.OperationAdd,
		Section:    "p",
		PolicyType: ptype,
		Rules:      validRules,
	}
	tx.buffer.AddOperation(op)

	return true, nil
}

// RemovePolicy removes a policy within the transaction.
func (tx *Transaction) RemovePolicy(params ...interface{}) (bool, error) {
	return tx.RemoveNamedPolicy("p", params...)
}

// RemoveNamedPolicy removes a named policy within the transaction.
func (tx *Transaction) RemoveNamedPolicy(ptype string, params ...interface{}) (bool, error) {
	tx.mutex.Lock()
	defer tx.mutex.Unlock()

	if err := tx.checkTransactionStatus(); err != nil {
		return false, err
	}

	rule := tx.buildRuleFromParams(params...)

	// Check if policy exists in the buffered model.
	bufferedModel, err := tx.buffer.ApplyOperationsToModel(tx.buffer.GetModelSnapshot())
	if err != nil {
		return false, err
	}

	hasPolicy, err := bufferedModel.HasPolicy("p", ptype, rule)
	if !hasPolicy || err != nil {
		return false, err
	}

	// Add operation to buffer.
	op := persist.PolicyOperation{
		Type:       persist.OperationRemove,
		Section:    "p",
		PolicyType: ptype,
		Rules:      [][]string{rule},
	}
	tx.buffer.AddOperation(op)

	return true, nil
}

// RemovePolicies removes multiple policies within the transaction.
func (tx *Transaction) RemovePolicies(rules [][]string) (bool, error) {
	return tx.RemoveNamedPolicies("p", rules)
}

// RemoveNamedPolicies removes multiple named policies within the transaction.
func (tx *Transaction) RemoveNamedPolicies(ptype string, rules [][]string) (bool, error) {
	tx.mutex.Lock()
	defer tx.mutex.Unlock()

	if err := tx.checkTransactionStatus(); err != nil {
		return false, err
	}

	if len(rules) == 0 {
		return false, nil
	}

	// Check if policies exist in the buffered model.
	bufferedModel, err := tx.buffer.ApplyOperationsToModel(tx.buffer.GetModelSnapshot())
	if err != nil {
		return false, err
	}

	var validRules [][]string
	for _, rule := range rules {
		hasPolicy, err := bufferedModel.HasPolicy("p", ptype, rule)
		if err != nil {
			return false, err
		}
		if hasPolicy {
			validRules = append(validRules, rule)
		}
	}

	if len(validRules) == 0 {
		return false, nil
	}

	// Add operation to buffer.
	op := persist.PolicyOperation{
		Type:       persist.OperationRemove,
		Section:    "p",
		PolicyType: ptype,
		Rules:      validRules,
	}
	tx.buffer.AddOperation(op)

	return true, nil
}

// UpdatePolicy updates a policy within the transaction.
func (tx *Transaction) UpdatePolicy(oldPolicy []string, newPolicy []string) (bool, error) {
	return tx.UpdateNamedPolicy("p", oldPolicy, newPolicy)
}

// UpdateNamedPolicy updates a named policy within the transaction.
func (tx *Transaction) UpdateNamedPolicy(ptype string, oldPolicy []string, newPolicy []string) (bool, error) {
	tx.mutex.Lock()
	defer tx.mutex.Unlock()

	if err := tx.checkTransactionStatus(); err != nil {
		return false, err
	}

	// Check if old policy exists and new policy doesn't exist.
	bufferedModel, err := tx.buffer.ApplyOperationsToModel(tx.buffer.GetModelSnapshot())
	if err != nil {
		return false, err
	}

	hasOldPolicy, err := bufferedModel.HasPolicy("p", ptype, oldPolicy)
	if err != nil {
		return false, err
	}
	if !hasOldPolicy {
		return false, nil
	}

	hasNewPolicy, errNew := bufferedModel.HasPolicy("p", ptype, newPolicy)
	if errNew != nil {
		return false, errNew
	}
	if hasNewPolicy {
		return false, nil
	}

	// Add operation to buffer.
	op := persist.PolicyOperation{
		Type:       persist.OperationUpdate,
		Section:    "p",
		PolicyType: ptype,
		Rules:      [][]string{newPolicy},
		OldRules:   [][]string{oldPolicy},
	}
	tx.buffer.AddOperation(op)

	return true, nil
}

// AddGroupingPolicy adds a grouping policy within the transaction.
func (tx *Transaction) AddGroupingPolicy(params ...interface{}) (bool, error) {
	return tx.AddNamedGroupingPolicy("g", params...)
}

// AddNamedGroupingPolicy adds a named grouping policy within the transaction.
func (tx *Transaction) AddNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error) {
	tx.mutex.Lock()
	defer tx.mutex.Unlock()

	if err := tx.checkTransactionStatus(); err != nil {
		return false, err
	}

	rule := tx.buildRuleFromParams(params...)

	// Check if grouping policy already exists in the buffered model.
	bufferedModel, err := tx.buffer.ApplyOperationsToModel(tx.buffer.GetModelSnapshot())
	if err != nil {
		return false, err
	}

	hasPolicy, err := bufferedModel.HasPolicy("g", ptype, rule)
	if hasPolicy || err != nil {
		return false, err
	}

	// Add operation to buffer.
	op := persist.PolicyOperation{
		Type:       persist.OperationAdd,
		Section:    "g",
		PolicyType: ptype,
		Rules:      [][]string{rule},
	}
	tx.buffer.AddOperation(op)

	return true, nil
}

// RemoveGroupingPolicy removes a grouping policy within the transaction.
func (tx *Transaction) RemoveGroupingPolicy(params ...interface{}) (bool, error) {
	return tx.RemoveNamedGroupingPolicy("g", params...)
}

// RemoveNamedGroupingPolicy removes a named grouping policy within the transaction.
func (tx *Transaction) RemoveNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error) {
	tx.mutex.Lock()
	defer tx.mutex.Unlock()

	if err := tx.checkTransactionStatus(); err != nil {
		return false, err
	}

	rule := tx.buildRuleFromParams(params...)

	// Check if grouping policy exists in the buffered model.
	bufferedModel, err := tx.buffer.ApplyOperationsToModel(tx.buffer.GetModelSnapshot())
	if err != nil {
		return false, err
	}

	hasPolicy, err := bufferedModel.HasPolicy("g", ptype, rule)
	if !hasPolicy || err != nil {
		return false, err
	}

	// Add operation to buffer.
	op := persist.PolicyOperation{
		Type:       persist.OperationRemove,
		Section:    "g",
		PolicyType: ptype,
		Rules:      [][]string{rule},
	}
	tx.buffer.AddOperation(op)

	return true, nil
}

// GetBufferedModel returns the model as it would look after applying all buffered operations.
// This is useful for preview or validation purposes within the transaction.
func (tx *Transaction) GetBufferedModel() (model.Model, error) {
	tx.mutex.RLock()
	defer tx.mutex.RUnlock()

	if err := tx.checkTransactionStatus(); err != nil {
		return nil, err
	}

	return tx.buffer.ApplyOperationsToModel(tx.buffer.GetModelSnapshot())
}

// HasOperations returns true if the transaction has any buffered operations.
func (tx *Transaction) HasOperations() bool {
	tx.mutex.RLock()
	defer tx.mutex.RUnlock()
	return tx.buffer.HasOperations()
}

// OperationCount returns the number of buffered operations in the transaction.
func (tx *Transaction) OperationCount() int {
	tx.mutex.RLock()
	defer tx.mutex.RUnlock()
	return tx.buffer.OperationCount()
}

// tryLockWithTimeout attempts to acquire the lock within the specified timeout period.
func tryLockWithTimeout(lock *sync.Mutex, startTime time.Time, maxWait time.Duration) bool {
	// Calculate remaining wait time based on transaction start time.
	remainingTime := maxWait - time.Since(startTime)
	if remainingTime <= 0 {
		return false
	}

	// Create a context with timeout for lock acquisition.
	ctx, cancel := context.WithTimeout(context.Background(), remainingTime)
	defer cancel()

	// Use channel for timeout control.
	done := make(chan bool, 1)
	go func() {
		lock.Lock()
		done <- true
	}()

	// Wait for either lock acquisition or timeout.
	select {
	case <-done:
		return true
	case <-ctx.Done():
		return false
	}
}