123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257 |
- package jsonpatch
- import (
- "bytes"
- "encoding/json"
- "fmt"
- "reflect"
- "strings"
- )
- var errBadJSONDoc = fmt.Errorf("Invalid JSON Document")
- type JsonPatchOperation struct {
- Operation string `json:"op"`
- Path string `json:"path"`
- Value interface{} `json:"value,omitempty"`
- }
- func (j *JsonPatchOperation) Json() string {
- b, _ := json.Marshal(j)
- return string(b)
- }
- func (j *JsonPatchOperation) MarshalJSON() ([]byte, error) {
- var b bytes.Buffer
- b.WriteString("{")
- b.WriteString(fmt.Sprintf(`"op":"%s"`, j.Operation))
- b.WriteString(fmt.Sprintf(`,"path":"%s"`, j.Path))
- // Consider omitting Value for non-nullable operations.
- if j.Value != nil || j.Operation == "replace" || j.Operation == "add" {
- v, err := json.Marshal(j.Value)
- if err != nil {
- return nil, err
- }
- b.WriteString(`,"value":`)
- b.Write(v)
- }
- b.WriteString("}")
- return b.Bytes(), nil
- }
- type ByPath []JsonPatchOperation
- func (a ByPath) Len() int { return len(a) }
- func (a ByPath) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
- func (a ByPath) Less(i, j int) bool { return a[i].Path < a[j].Path }
- func NewPatch(operation, path string, value interface{}) JsonPatchOperation {
- return JsonPatchOperation{Operation: operation, Path: path, Value: value}
- }
- // CreatePatch creates a patch as specified in http://jsonpatch.com/
- //
- // 'a' is original, 'b' is the modified document. Both are to be given as json encoded content.
- // The function will return an array of JsonPatchOperations
- //
- // An error will be returned if any of the two documents are invalid.
- func CreatePatch(a, b []byte) ([]JsonPatchOperation, error) {
- aI := map[string]interface{}{}
- bI := map[string]interface{}{}
- err := json.Unmarshal(a, &aI)
- if err != nil {
- return nil, errBadJSONDoc
- }
- err = json.Unmarshal(b, &bI)
- if err != nil {
- return nil, errBadJSONDoc
- }
- return diff(aI, bI, "", []JsonPatchOperation{})
- }
- // Returns true if the values matches (must be json types)
- // The types of the values must match, otherwise it will always return false
- // If two map[string]interface{} are given, all elements must match.
- func matchesValue(av, bv interface{}) bool {
- if reflect.TypeOf(av) != reflect.TypeOf(bv) {
- return false
- }
- switch at := av.(type) {
- case string:
- bt := bv.(string)
- if bt == at {
- return true
- }
- case float64:
- bt := bv.(float64)
- if bt == at {
- return true
- }
- case bool:
- bt := bv.(bool)
- if bt == at {
- return true
- }
- case map[string]interface{}:
- bt := bv.(map[string]interface{})
- for key := range at {
- if !matchesValue(at[key], bt[key]) {
- return false
- }
- }
- for key := range bt {
- if !matchesValue(at[key], bt[key]) {
- return false
- }
- }
- return true
- case []interface{}:
- bt := bv.([]interface{})
- if len(bt) != len(at) {
- return false
- }
- for key := range at {
- if !matchesValue(at[key], bt[key]) {
- return false
- }
- }
- for key := range bt {
- if !matchesValue(at[key], bt[key]) {
- return false
- }
- }
- return true
- }
- return false
- }
- // From http://tools.ietf.org/html/rfc6901#section-4 :
- //
- // Evaluation of each reference token begins by decoding any escaped
- // character sequence. This is performed by first transforming any
- // occurrence of the sequence '~1' to '/', and then transforming any
- // occurrence of the sequence '~0' to '~'.
- // TODO decode support:
- // var rfc6901Decoder = strings.NewReplacer("~1", "/", "~0", "~")
- var rfc6901Encoder = strings.NewReplacer("~", "~0", "/", "~1")
- func makePath(path string, newPart interface{}) string {
- key := rfc6901Encoder.Replace(fmt.Sprintf("%v", newPart))
- if path == "" {
- return "/" + key
- }
- if strings.HasSuffix(path, "/") {
- return path + key
- }
- return path + "/" + key
- }
- // diff returns the (recursive) difference between a and b as an array of JsonPatchOperations.
- func diff(a, b map[string]interface{}, path string, patch []JsonPatchOperation) ([]JsonPatchOperation, error) {
- for key, bv := range b {
- p := makePath(path, key)
- av, ok := a[key]
- // value was added
- if !ok {
- patch = append(patch, NewPatch("add", p, bv))
- continue
- }
- // If types have changed, replace completely
- if reflect.TypeOf(av) != reflect.TypeOf(bv) {
- patch = append(patch, NewPatch("replace", p, bv))
- continue
- }
- // Types are the same, compare values
- var err error
- patch, err = handleValues(av, bv, p, patch)
- if err != nil {
- return nil, err
- }
- }
- // Now add all deleted values as nil
- for key := range a {
- _, found := b[key]
- if !found {
- p := makePath(path, key)
- patch = append(patch, NewPatch("remove", p, nil))
- }
- }
- return patch, nil
- }
- func handleValues(av, bv interface{}, p string, patch []JsonPatchOperation) ([]JsonPatchOperation, error) {
- var err error
- switch at := av.(type) {
- case map[string]interface{}:
- bt := bv.(map[string]interface{})
- patch, err = diff(at, bt, p, patch)
- if err != nil {
- return nil, err
- }
- case string, float64, bool:
- if !matchesValue(av, bv) {
- patch = append(patch, NewPatch("replace", p, bv))
- }
- case []interface{}:
- bt, ok := bv.([]interface{})
- if !ok {
- // array replaced by non-array
- patch = append(patch, NewPatch("replace", p, bv))
- } else if len(at) != len(bt) {
- // arrays are not the same length
- patch = append(patch, compareArray(at, bt, p)...)
- } else {
- for i := range bt {
- patch, err = handleValues(at[i], bt[i], makePath(p, i), patch)
- if err != nil {
- return nil, err
- }
- }
- }
- case nil:
- switch bv.(type) {
- case nil:
- // Both nil, fine.
- default:
- patch = append(patch, NewPatch("add", p, bv))
- }
- default:
- panic(fmt.Sprintf("Unknown type:%T ", av))
- }
- return patch, nil
- }
- func compareArray(av, bv []interface{}, p string) []JsonPatchOperation {
- retval := []JsonPatchOperation{}
- // var err error
- for i, v := range av {
- found := false
- for _, v2 := range bv {
- if reflect.DeepEqual(v, v2) {
- found = true
- break
- }
- }
- if !found {
- retval = append(retval, NewPatch("remove", makePath(p, i), nil))
- }
- }
- for i, v := range bv {
- found := false
- for _, v2 := range av {
- if reflect.DeepEqual(v, v2) {
- found = true
- break
- }
- }
- if !found {
- retval = append(retval, NewPatch("add", makePath(p, i), v))
- }
- }
- return retval
- }
|