|
| 1 | +package apiform |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "io" |
| 6 | + "mime/multipart" |
| 7 | + "net/textproto" |
| 8 | + "path" |
| 9 | + "reflect" |
| 10 | + "sort" |
| 11 | + "strconv" |
| 12 | + "strings" |
| 13 | +) |
| 14 | + |
| 15 | +// Marshal encodes a value as multipart form data using default settings |
| 16 | +func Marshal(value any, writer *multipart.Writer) error { |
| 17 | + e := &encoder{ |
| 18 | + format: FormatRepeat, |
| 19 | + } |
| 20 | + return e.marshal(value, writer) |
| 21 | +} |
| 22 | + |
| 23 | +// MarshalWithSettings encodes a value with custom array format |
| 24 | +func MarshalWithSettings(value any, writer *multipart.Writer, arrayFormat FormFormat) error { |
| 25 | + e := &encoder{ |
| 26 | + format: arrayFormat, |
| 27 | + } |
| 28 | + return e.marshal(value, writer) |
| 29 | +} |
| 30 | + |
| 31 | +type encoder struct { |
| 32 | + format FormFormat |
| 33 | +} |
| 34 | + |
| 35 | +func (e *encoder) marshal(value any, writer *multipart.Writer) error { |
| 36 | + val := reflect.ValueOf(value) |
| 37 | + if !val.IsValid() { |
| 38 | + return nil |
| 39 | + } |
| 40 | + return e.encodeValue("", val, writer) |
| 41 | +} |
| 42 | + |
| 43 | +func (e *encoder) encodeValue(key string, val reflect.Value, writer *multipart.Writer) error { |
| 44 | + if !val.IsValid() { |
| 45 | + return writer.WriteField(key, "") |
| 46 | + } |
| 47 | + |
| 48 | + t := val.Type() |
| 49 | + |
| 50 | + if t.Implements(reflect.TypeOf((*io.Reader)(nil)).Elem()) { |
| 51 | + return e.encodeReader(key, val, writer) |
| 52 | + } |
| 53 | + |
| 54 | + switch t.Kind() { |
| 55 | + case reflect.Pointer: |
| 56 | + if val.IsNil() || !val.IsValid() { |
| 57 | + return writer.WriteField(key, "") |
| 58 | + } |
| 59 | + return e.encodeValue(key, val.Elem(), writer) |
| 60 | + |
| 61 | + case reflect.Slice, reflect.Array: |
| 62 | + return e.encodeArray(key, val, writer) |
| 63 | + |
| 64 | + case reflect.Map: |
| 65 | + return e.encodeMap(key, val, writer) |
| 66 | + |
| 67 | + case reflect.Interface: |
| 68 | + if val.IsNil() { |
| 69 | + return writer.WriteField(key, "") |
| 70 | + } |
| 71 | + return e.encodeValue(key, val.Elem(), writer) |
| 72 | + |
| 73 | + case reflect.String: |
| 74 | + return writer.WriteField(key, val.String()) |
| 75 | + |
| 76 | + case reflect.Bool: |
| 77 | + if val.Bool() { |
| 78 | + return writer.WriteField(key, "true") |
| 79 | + } |
| 80 | + return writer.WriteField(key, "false") |
| 81 | + |
| 82 | + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: |
| 83 | + return writer.WriteField(key, strconv.FormatInt(val.Int(), 10)) |
| 84 | + |
| 85 | + case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: |
| 86 | + return writer.WriteField(key, strconv.FormatUint(val.Uint(), 10)) |
| 87 | + |
| 88 | + case reflect.Float32: |
| 89 | + return writer.WriteField(key, strconv.FormatFloat(val.Float(), 'f', -1, 32)) |
| 90 | + |
| 91 | + case reflect.Float64: |
| 92 | + return writer.WriteField(key, strconv.FormatFloat(val.Float(), 'f', -1, 64)) |
| 93 | + |
| 94 | + default: |
| 95 | + return fmt.Errorf("unknown type: %s", t.String()) |
| 96 | + } |
| 97 | +} |
| 98 | + |
| 99 | +func (e *encoder) encodeArray(key string, val reflect.Value, writer *multipart.Writer) error { |
| 100 | + if e.format == FormatComma { |
| 101 | + var values []string |
| 102 | + for i := 0; i < val.Len(); i++ { |
| 103 | + item := val.Index(i) |
| 104 | + var strValue string |
| 105 | + switch item.Kind() { |
| 106 | + case reflect.String: |
| 107 | + strValue = item.String() |
| 108 | + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: |
| 109 | + strValue = strconv.FormatInt(item.Int(), 10) |
| 110 | + case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: |
| 111 | + strValue = strconv.FormatUint(item.Uint(), 10) |
| 112 | + case reflect.Float32, reflect.Float64: |
| 113 | + strValue = strconv.FormatFloat(item.Float(), 'f', -1, 64) |
| 114 | + case reflect.Bool: |
| 115 | + strValue = strconv.FormatBool(item.Bool()) |
| 116 | + default: |
| 117 | + return fmt.Errorf("comma format not supported for complex array elements") |
| 118 | + } |
| 119 | + values = append(values, strValue) |
| 120 | + } |
| 121 | + return writer.WriteField(key, strings.Join(values, ",")) |
| 122 | + } |
| 123 | + |
| 124 | + for i := 0; i < val.Len(); i++ { |
| 125 | + var formattedKey string |
| 126 | + switch e.format { |
| 127 | + case FormatRepeat: |
| 128 | + formattedKey = key |
| 129 | + case FormatBrackets: |
| 130 | + formattedKey = key + "[]" |
| 131 | + case FormatIndicesDots: |
| 132 | + if key == "" { |
| 133 | + formattedKey = strconv.Itoa(i) |
| 134 | + } else { |
| 135 | + formattedKey = key + "." + strconv.Itoa(i) |
| 136 | + } |
| 137 | + case FormatIndicesBrackets: |
| 138 | + if key == "" { |
| 139 | + formattedKey = strconv.Itoa(i) |
| 140 | + } else { |
| 141 | + formattedKey = key + "[" + strconv.Itoa(i) + "]" |
| 142 | + } |
| 143 | + default: |
| 144 | + return fmt.Errorf("apiform: unsupported array format") |
| 145 | + } |
| 146 | + |
| 147 | + if err := e.encodeValue(formattedKey, val.Index(i), writer); err != nil { |
| 148 | + return err |
| 149 | + } |
| 150 | + } |
| 151 | + return nil |
| 152 | +} |
| 153 | + |
| 154 | +var quoteEscaper = strings.NewReplacer("\\", "\\\\", `"`, "\\\"") |
| 155 | + |
| 156 | +func escapeQuotes(s string) string { |
| 157 | + return quoteEscaper.Replace(s) |
| 158 | +} |
| 159 | + |
| 160 | +func (e *encoder) encodeReader(key string, val reflect.Value, writer *multipart.Writer) error { |
| 161 | + reader, ok := val.Convert(reflect.TypeOf((*io.Reader)(nil)).Elem()).Interface().(io.Reader) |
| 162 | + if !ok { |
| 163 | + return nil |
| 164 | + } |
| 165 | + |
| 166 | + // Set defaults |
| 167 | + filename := "anonymous_file" |
| 168 | + contentType := "application/octet-stream" |
| 169 | + |
| 170 | + // Get filename if available |
| 171 | + if named, ok := reader.(interface{ Filename() string }); ok { |
| 172 | + filename = named.Filename() |
| 173 | + } else if named, ok := reader.(interface{ Name() string }); ok { |
| 174 | + filename = path.Base(named.Name()) |
| 175 | + } |
| 176 | + |
| 177 | + // Get content type if available |
| 178 | + if typed, ok := reader.(interface{ ContentType() string }); ok { |
| 179 | + contentType = typed.ContentType() |
| 180 | + } |
| 181 | + |
| 182 | + h := make(textproto.MIMEHeader) |
| 183 | + h.Set("Content-Disposition", fmt.Sprintf(`form-data; name="%s"; filename="%s"`, |
| 184 | + escapeQuotes(key), escapeQuotes(filename))) |
| 185 | + h.Set("Content-Type", contentType) |
| 186 | + |
| 187 | + filewriter, err := writer.CreatePart(h) |
| 188 | + if err != nil { |
| 189 | + return err |
| 190 | + } |
| 191 | + _, err = io.Copy(filewriter, reader) |
| 192 | + return err |
| 193 | +} |
| 194 | + |
| 195 | +func (e *encoder) encodeMap(key string, val reflect.Value, writer *multipart.Writer) error { |
| 196 | + type mapPair struct { |
| 197 | + key string |
| 198 | + value reflect.Value |
| 199 | + } |
| 200 | + |
| 201 | + if key != "" { |
| 202 | + key = key + "." |
| 203 | + } |
| 204 | + |
| 205 | + // Collect and sort map entries for deterministic output |
| 206 | + pairs := []mapPair{} |
| 207 | + iter := val.MapRange() |
| 208 | + for iter.Next() { |
| 209 | + if iter.Key().Type().Kind() != reflect.String { |
| 210 | + return fmt.Errorf("cannot encode a map with a non string key") |
| 211 | + } |
| 212 | + pairs = append(pairs, mapPair{key: iter.Key().String(), value: iter.Value()}) |
| 213 | + } |
| 214 | + |
| 215 | + sort.Slice(pairs, func(i, j int) bool { |
| 216 | + return pairs[i].key < pairs[j].key |
| 217 | + }) |
| 218 | + |
| 219 | + // Process sorted pairs |
| 220 | + for _, p := range pairs { |
| 221 | + if err := e.encodeValue(key+p.key, p.value, writer); err != nil { |
| 222 | + return err |
| 223 | + } |
| 224 | + } |
| 225 | + |
| 226 | + return nil |
| 227 | +} |
![stainless-app[bot]](https://avatars.githubusercontent.com/in/378072?v=4&size=40){kind=avatar}
0 commit comments