Files
portainer/api/http/handler/useractivity/authlogs_csv.go
T
2021-04-07 16:54:07 +12:00

85 lines
2.7 KiB
Go

package useractivity
import (
"net/http"
httperror "github.com/portainer/libhttp/error"
"github.com/portainer/libhttp/request"
portainer "github.com/portainer/portainer/api"
"github.com/portainer/portainer/api/useractivity"
)
// @id AuthLogsCSV
// @summary Download auth logs as CSV
// @description Download auth logs as CSV by provided query
// @description **Access policy**: admin
// @tags useractivity
// @security jwt
// @produce text/csv
// @param before query int false "Results before timestamp (unix)"
// @param after query int false "Results after timestamp (unix)"
// @param sortBy query string false "Sort by this column" Enum("Type", "Timestamp", "Origin", "Context", "Username", "Result")
// @param sortDesc query bool false "Sort order, if true will return results by descending order"
// @param keyword query string false "Query logs by this keyword"
// @success 200 string "Success"
// @failure 500 "Server error"
// @router /useractivity/authlogs.csv [get]
func (handler *Handler) authLogsCSV(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
before, _ := request.RetrieveNumericQueryParameter(r, "before", true)
after, _ := request.RetrieveNumericQueryParameter(r, "after", true)
sortBy, _ := request.RetrieveQueryParameter(r, "sortBy", true)
sortDesc, _ := request.RetrieveBooleanQueryParameter(r, "sortDesc", true)
keyword, _ := request.RetrieveQueryParameter(r, "keyword", true)
contextTypes, err := parseContextTypes(r.URL.RawQuery)
if err != nil {
return &httperror.HandlerError{
StatusCode: http.StatusInternalServerError,
Message: "Unable to parse query string",
Err: err,
}
}
activityTypes, err := parseActivityTypes(r.URL.RawQuery)
if err != nil {
return &httperror.HandlerError{
StatusCode: http.StatusInternalServerError,
Message: "Unable to parse query string",
Err: err,
}
}
opts := portainer.AuthLogsQuery{
BeforeTimestamp: int64(before),
AfterTimestamp: int64(after),
SortBy: sortBy,
SortDesc: sortDesc,
Keyword: keyword,
ContextTypes: contextTypes,
ActivityTypes: activityTypes,
}
logs, _, err := handler.UserActivityStore.GetAuthLogs(opts)
if err != nil {
return &httperror.HandlerError{
StatusCode: http.StatusInternalServerError,
Message: "Unable to retrieve authentication logs",
Err: err,
}
}
err = useractivity.MarshalAuthLogsToCSV(w, logs)
if err != nil {
return &httperror.HandlerError{
StatusCode: http.StatusInternalServerError,
Message: "Unable to marshal logs to csv",
Err: err,
}
}
w.Header().Set("Content-Disposition", "attachment; filename=\"logs.csv\"")
w.Header().Set("Content-Type", "text/csv")
return nil
}