soft_delete.go 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. package gorm
  2. import (
  3. "database/sql"
  4. "database/sql/driver"
  5. "encoding/json"
  6. "reflect"
  7. "github.com/jinzhu/now"
  8. "gorm.io/gorm/clause"
  9. "gorm.io/gorm/schema"
  10. )
  11. type DeletedAt sql.NullTime
  12. // Scan implements the Scanner interface.
  13. func (n *DeletedAt) Scan(value interface{}) error {
  14. return (*sql.NullTime)(n).Scan(value)
  15. }
  16. // Value implements the driver Valuer interface.
  17. func (n DeletedAt) Value() (driver.Value, error) {
  18. if !n.Valid {
  19. return nil, nil
  20. }
  21. return n.Time, nil
  22. }
  23. func (n DeletedAt) MarshalJSON() ([]byte, error) {
  24. if n.Valid {
  25. return json.Marshal(n.Time)
  26. }
  27. return json.Marshal(nil)
  28. }
  29. func (n *DeletedAt) UnmarshalJSON(b []byte) error {
  30. if string(b) == "null" {
  31. n.Valid = false
  32. return nil
  33. }
  34. err := json.Unmarshal(b, &n.Time)
  35. if err == nil {
  36. n.Valid = true
  37. }
  38. return err
  39. }
  40. func (DeletedAt) QueryClauses(f *schema.Field) []clause.Interface {
  41. return []clause.Interface{SoftDeleteQueryClause{Field: f, ZeroValue: parseZeroValueTag(f)}}
  42. }
  43. func parseZeroValueTag(f *schema.Field) sql.NullString {
  44. if v, ok := f.TagSettings["ZEROVALUE"]; ok {
  45. if _, err := now.Parse(v); err == nil {
  46. return sql.NullString{String: v, Valid: true}
  47. }
  48. }
  49. return sql.NullString{Valid: false}
  50. }
  51. type SoftDeleteQueryClause struct {
  52. ZeroValue sql.NullString
  53. Field *schema.Field
  54. }
  55. func (sd SoftDeleteQueryClause) Name() string {
  56. return ""
  57. }
  58. func (sd SoftDeleteQueryClause) Build(clause.Builder) {
  59. }
  60. func (sd SoftDeleteQueryClause) MergeClause(*clause.Clause) {
  61. }
  62. func (sd SoftDeleteQueryClause) ModifyStatement(stmt *Statement) {
  63. if _, ok := stmt.Clauses["soft_delete_enabled"]; !ok && !stmt.Statement.Unscoped {
  64. if c, ok := stmt.Clauses["WHERE"]; ok {
  65. if where, ok := c.Expression.(clause.Where); ok && len(where.Exprs) >= 1 {
  66. for _, expr := range where.Exprs {
  67. if orCond, ok := expr.(clause.OrConditions); ok && len(orCond.Exprs) == 1 {
  68. where.Exprs = []clause.Expression{clause.And(where.Exprs...)}
  69. c.Expression = where
  70. stmt.Clauses["WHERE"] = c
  71. break
  72. }
  73. }
  74. }
  75. }
  76. stmt.AddClause(clause.Where{Exprs: []clause.Expression{
  77. clause.Eq{Column: clause.Column{Table: clause.CurrentTable, Name: sd.Field.DBName}, Value: sd.ZeroValue},
  78. }})
  79. stmt.Clauses["soft_delete_enabled"] = clause.Clause{}
  80. }
  81. }
  82. func (DeletedAt) UpdateClauses(f *schema.Field) []clause.Interface {
  83. return []clause.Interface{SoftDeleteUpdateClause{Field: f, ZeroValue: parseZeroValueTag(f)}}
  84. }
  85. type SoftDeleteUpdateClause struct {
  86. ZeroValue sql.NullString
  87. Field *schema.Field
  88. }
  89. func (sd SoftDeleteUpdateClause) Name() string {
  90. return ""
  91. }
  92. func (sd SoftDeleteUpdateClause) Build(clause.Builder) {
  93. }
  94. func (sd SoftDeleteUpdateClause) MergeClause(*clause.Clause) {
  95. }
  96. func (sd SoftDeleteUpdateClause) ModifyStatement(stmt *Statement) {
  97. if stmt.SQL.Len() == 0 && !stmt.Statement.Unscoped {
  98. SoftDeleteQueryClause(sd).ModifyStatement(stmt)
  99. }
  100. }
  101. func (DeletedAt) DeleteClauses(f *schema.Field) []clause.Interface {
  102. return []clause.Interface{SoftDeleteDeleteClause{Field: f, ZeroValue: parseZeroValueTag(f)}}
  103. }
  104. type SoftDeleteDeleteClause struct {
  105. ZeroValue sql.NullString
  106. Field *schema.Field
  107. }
  108. func (sd SoftDeleteDeleteClause) Name() string {
  109. return ""
  110. }
  111. func (sd SoftDeleteDeleteClause) Build(clause.Builder) {
  112. }
  113. func (sd SoftDeleteDeleteClause) MergeClause(*clause.Clause) {
  114. }
  115. func (sd SoftDeleteDeleteClause) ModifyStatement(stmt *Statement) {
  116. if stmt.SQL.Len() == 0 && !stmt.Statement.Unscoped {
  117. curTime := stmt.DB.NowFunc()
  118. stmt.AddClause(clause.Set{{Column: clause.Column{Name: sd.Field.DBName}, Value: curTime}})
  119. stmt.SetColumn(sd.Field.DBName, curTime, true)
  120. if stmt.Schema != nil {
  121. _, queryValues := schema.GetIdentityFieldValuesMap(stmt.Context, stmt.ReflectValue, stmt.Schema.PrimaryFields)
  122. column, values := schema.ToQueryValues(stmt.Table, stmt.Schema.PrimaryFieldDBNames, queryValues)
  123. if len(values) > 0 {
  124. stmt.AddClause(clause.Where{Exprs: []clause.Expression{clause.IN{Column: column, Values: values}}})
  125. }
  126. if stmt.ReflectValue.CanAddr() && stmt.Dest != stmt.Model && stmt.Model != nil {
  127. _, queryValues = schema.GetIdentityFieldValuesMap(stmt.Context, reflect.ValueOf(stmt.Model), stmt.Schema.PrimaryFields)
  128. column, values = schema.ToQueryValues(stmt.Table, stmt.Schema.PrimaryFieldDBNames, queryValues)
  129. if len(values) > 0 {
  130. stmt.AddClause(clause.Where{Exprs: []clause.Expression{clause.IN{Column: column, Values: values}}})
  131. }
  132. }
  133. }
  134. SoftDeleteQueryClause(sd).ModifyStatement(stmt)
  135. stmt.AddClauseIfNotExists(clause.Update{})
  136. stmt.Build(stmt.DB.Callback().Update().Clauses...)
  137. }
  138. }