wide/util/ret.go

116 lines
2.6 KiB
Go
Raw Normal View History

2019-05-17 06:28:50 +03:00
// Copyright (c) 2014-present, b3log.org
2014-12-09 05:36:33 +03:00
//
2014-11-12 18:13:14 +03:00
// 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
2014-12-09 05:36:33 +03:00
//
2018-03-12 07:28:33 +03:00
// https://www.apache.org/licenses/LICENSE-2.0
2014-12-09 05:36:33 +03:00
//
2014-11-12 18:13:14 +03:00
// 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.
2014-09-01 16:50:51 +04:00
package util
import (
2014-12-09 05:36:33 +03:00
"compress/gzip"
2014-09-01 16:50:51 +04:00
"encoding/json"
"net/http"
2014-12-13 13:47:41 +03:00
"os"
2014-09-12 13:10:58 +04:00
2014-12-13 13:47:41 +03:00
"github.com/b3log/wide/log"
2014-09-01 16:50:51 +04:00
)
2014-12-13 13:47:41 +03:00
// Logger.
var retLogger = log.NewLogger(os.Stdout)
2015-10-20 13:08:48 +03:00
// Result.
type Result struct {
Succ bool `json:"succ"` // successful or not
2019-05-16 18:17:25 +03:00
Code int `json:"code"` // return code
2015-10-20 13:08:48 +03:00
Msg string `json:"msg"` // message
Data interface{} `json:"data"` // data object
}
2019-05-16 18:17:25 +03:00
// NewResult creates a result with Succ=true, Code=0, Msg="", Data=nil.
2015-10-20 13:08:48 +03:00
func NewResult() *Result {
return &Result{
Succ: true,
2019-05-16 18:17:25 +03:00
Code: 0,
2015-10-20 13:08:48 +03:00
Msg: "",
Data: nil,
}
}
// RetResult writes HTTP response with "Content-Type, application/json".
func RetResult(w http.ResponseWriter, r *http.Request, res *Result) {
w.Header().Set("Content-Type", "application/json")
data, err := json.Marshal(res)
if err != nil {
retLogger.Error(err)
2015-10-20 13:31:20 +03:00
2015-10-20 13:08:48 +03:00
return
}
w.Write(data)
}
2015-10-20 13:31:20 +03:00
// RetGzResult writes HTTP response with "Content-Type, application/json" and "Content-Encoding, gzip".
func RetGzResult(w http.ResponseWriter, r *http.Request, res *Result) {
w.Header().Set("Content-Type", "application/json")
w.Header().Set("Content-Encoding", "gzip")
gz := gzip.NewWriter(w)
err := json.NewEncoder(gz).Encode(res)
if nil != err {
retLogger.Error(err)
return
}
err = gz.Close()
if nil != err {
retLogger.Error(err)
return
}
}
2014-10-29 13:15:18 +03:00
// RetJSON writes HTTP response with "Content-Type, application/json".
2014-09-01 16:50:51 +04:00
func RetJSON(w http.ResponseWriter, r *http.Request, res map[string]interface{}) {
w.Header().Set("Content-Type", "application/json")
data, err := json.Marshal(res)
if err != nil {
2014-12-13 13:47:41 +03:00
retLogger.Error(err)
2015-10-20 13:31:20 +03:00
2014-09-01 16:50:51 +04:00
return
}
w.Write(data)
}
2014-12-09 05:36:33 +03:00
2015-10-20 13:31:20 +03:00
// RetGzJSON writes HTTP response with "Content-Type, application/json" and "Content-Encoding, gzip".
2014-12-09 05:36:33 +03:00
func RetGzJSON(w http.ResponseWriter, r *http.Request, res map[string]interface{}) {
w.Header().Set("Content-Type", "application/json")
w.Header().Set("Content-Encoding", "gzip")
gz := gzip.NewWriter(w)
err := json.NewEncoder(gz).Encode(res)
if nil != err {
2014-12-13 13:47:41 +03:00
retLogger.Error(err)
2015-10-20 13:31:20 +03:00
2014-12-09 05:36:33 +03:00
return
}
err = gz.Close()
if nil != err {
2014-12-13 13:47:41 +03:00
retLogger.Error(err)
2014-12-09 05:36:33 +03:00
return
}
}