08c0b7a2fd
* Refactor error usage from the store level up and add API helpers * Complete API tests * Fix merge errorResponse calls * Remove ensure helpers to allow for custom messages on permission errors * Fix bad import and call * Remove bad user check on auth that was added as part of the main merge * Fix empty list test * Replace deprecated proxy calls to ioutil.ReadAll with io.ReadAll * Add information to the NotFound errors * Add context to all remaining errors and address review comments * Fix linter * Adapt the new card API endpoints to the error refactor * Remove almost all customErrorResponse calls * Add request entity too large to errorResponse and remove customErrorResponse * Fix linter
389 lines
9.2 KiB
Go
389 lines
9.2 KiB
Go
package api
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"strconv"
|
|
|
|
"github.com/gorilla/mux"
|
|
"github.com/mattermost/focalboard/server/model"
|
|
"github.com/mattermost/focalboard/server/services/audit"
|
|
|
|
"github.com/mattermost/mattermost-server/v6/shared/mlog"
|
|
)
|
|
|
|
const (
|
|
defaultPage = "0"
|
|
defaultPerPage = "100"
|
|
)
|
|
|
|
func (a *API) registerCardsRoutes(r *mux.Router) {
|
|
// Cards APIs
|
|
r.HandleFunc("/boards/{boardID}/cards", a.sessionRequired(a.handleCreateCard)).Methods("POST")
|
|
r.HandleFunc("/boards/{boardID}/cards", a.sessionRequired(a.handleGetCards)).Methods("GET")
|
|
r.HandleFunc("/cards/{cardID}", a.sessionRequired(a.handlePatchCard)).Methods("PATCH")
|
|
r.HandleFunc("/cards/{cardID}", a.sessionRequired(a.handleGetCard)).Methods("GET")
|
|
}
|
|
|
|
func (a *API) handleCreateCard(w http.ResponseWriter, r *http.Request) {
|
|
// swagger:operation POST /boards/{boardID}/cards createCard
|
|
//
|
|
// Creates a new card for the specified board.
|
|
//
|
|
// ---
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: boardID
|
|
// in: path
|
|
// description: Board ID
|
|
// required: true
|
|
// type: string
|
|
// - name: Body
|
|
// in: body
|
|
// description: the card to create
|
|
// required: true
|
|
// schema:
|
|
// "$ref": "#/definitions/Card"
|
|
// - name: disable_notify
|
|
// in: query
|
|
// description: Disables notifications (for bulk data inserting)
|
|
// required: false
|
|
// type: bool
|
|
// security:
|
|
// - BearerAuth: []
|
|
// responses:
|
|
// '200':
|
|
// description: success
|
|
// schema:
|
|
// $ref: '#/definitions/Card'
|
|
// default:
|
|
// description: internal error
|
|
// schema:
|
|
// "$ref": "#/definitions/ErrorResponse"
|
|
|
|
userID := getUserID(r)
|
|
boardID := mux.Vars(r)["boardID"]
|
|
|
|
val := r.URL.Query().Get("disable_notify")
|
|
disableNotify := val == True
|
|
|
|
requestBody, err := io.ReadAll(r.Body)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
var newCard *model.Card
|
|
if err = json.Unmarshal(requestBody, &newCard); err != nil {
|
|
a.errorResponse(w, r, model.NewErrBadRequest(err.Error()))
|
|
return
|
|
}
|
|
|
|
if !a.permissions.HasPermissionToBoard(userID, boardID, model.PermissionManageBoardCards) {
|
|
a.errorResponse(w, r, model.NewErrPermission("access denied to create card"))
|
|
return
|
|
}
|
|
|
|
if newCard.BoardID != "" && newCard.BoardID != boardID {
|
|
a.errorResponse(w, r, model.ErrBoardIDMismatch)
|
|
return
|
|
}
|
|
|
|
newCard.PopulateWithBoardID(boardID)
|
|
if err = newCard.CheckValid(); err != nil {
|
|
a.errorResponse(w, r, model.NewErrBadRequest(err.Error()))
|
|
return
|
|
}
|
|
|
|
auditRec := a.makeAuditRecord(r, "createCard", audit.Fail)
|
|
defer a.audit.LogRecord(audit.LevelModify, auditRec)
|
|
auditRec.AddMeta("boardID", boardID)
|
|
|
|
// create card
|
|
card, err := a.app.CreateCard(newCard, boardID, userID, disableNotify)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
a.logger.Debug("CreateCard",
|
|
mlog.String("boardID", boardID),
|
|
mlog.String("cardID", card.ID),
|
|
mlog.String("userID", userID),
|
|
)
|
|
|
|
data, err := json.Marshal(card)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
// response
|
|
jsonBytesResponse(w, http.StatusOK, data)
|
|
|
|
auditRec.Success()
|
|
}
|
|
|
|
func (a *API) handleGetCards(w http.ResponseWriter, r *http.Request) {
|
|
// swagger:operation GET /boards/{boardID}/cards
|
|
//
|
|
// Fetches cards for the specified board.
|
|
//
|
|
// ---
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: boardID
|
|
// in: path
|
|
// description: Board ID
|
|
// required: true
|
|
// type: string
|
|
// - name: page
|
|
// in: query
|
|
// description: The page to select (default=0)
|
|
// required: false
|
|
// type: integer
|
|
// - name: per_page
|
|
// in: query
|
|
// description: Number of cards to return per page(default=100)
|
|
// required: false
|
|
// type: integer
|
|
// security:
|
|
// - BearerAuth: []
|
|
// responses:
|
|
// '200':
|
|
// description: success
|
|
// schema:
|
|
// type: array
|
|
// items:
|
|
// "$ref": "#/definitions/Card"
|
|
// default:
|
|
// description: internal error
|
|
// schema:
|
|
// "$ref": "#/definitions/ErrorResponse"
|
|
userID := getUserID(r)
|
|
boardID := mux.Vars(r)["boardID"]
|
|
|
|
query := r.URL.Query()
|
|
strPage := query.Get("page")
|
|
strPerPage := query.Get("per_page")
|
|
|
|
if !a.permissions.HasPermissionToBoard(userID, boardID, model.PermissionViewBoard) {
|
|
a.errorResponse(w, r, model.NewErrPermission("access denied to fetch cards"))
|
|
return
|
|
}
|
|
|
|
if strPage == "" {
|
|
strPage = defaultPage
|
|
}
|
|
if strPerPage == "" {
|
|
strPerPage = defaultPerPage
|
|
}
|
|
|
|
page, err := strconv.Atoi(strPage)
|
|
if err != nil {
|
|
message := fmt.Sprintf("invalid `page` parameter: %s", err)
|
|
a.errorResponse(w, r, model.NewErrBadRequest(message))
|
|
}
|
|
|
|
perPage, err := strconv.Atoi(strPerPage)
|
|
if err != nil {
|
|
message := fmt.Sprintf("invalid `per_page` parameter: %s", err)
|
|
a.errorResponse(w, r, model.NewErrBadRequest(message))
|
|
}
|
|
|
|
auditRec := a.makeAuditRecord(r, "getCards", audit.Fail)
|
|
defer a.audit.LogRecord(audit.LevelRead, auditRec)
|
|
auditRec.AddMeta("boardID", boardID)
|
|
auditRec.AddMeta("page", page)
|
|
auditRec.AddMeta("per_page", perPage)
|
|
|
|
cards, err := a.app.GetCardsForBoard(boardID, page, perPage)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
a.logger.Debug("GetCards",
|
|
mlog.String("boardID", boardID),
|
|
mlog.String("userID", userID),
|
|
mlog.Int("page", page),
|
|
mlog.Int("per_page", perPage),
|
|
mlog.Int("count", len(cards)),
|
|
)
|
|
|
|
data, err := json.Marshal(cards)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
// response
|
|
jsonBytesResponse(w, http.StatusOK, data)
|
|
|
|
auditRec.Success()
|
|
}
|
|
|
|
func (a *API) handlePatchCard(w http.ResponseWriter, r *http.Request) {
|
|
// swagger:operation PATCH /cards/{cardID}/cards patchCard
|
|
//
|
|
// Patches the specified card.
|
|
//
|
|
// ---
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: cardID
|
|
// in: path
|
|
// description: Card ID
|
|
// required: true
|
|
// type: string
|
|
// - name: Body
|
|
// in: body
|
|
// description: the card patch
|
|
// required: true
|
|
// schema:
|
|
// "$ref": "#/definitions/CardPatch"
|
|
// - name: disable_notify
|
|
// in: query
|
|
// description: Disables notifications (for bulk data patching)
|
|
// required: false
|
|
// type: bool
|
|
// security:
|
|
// - BearerAuth: []
|
|
// responses:
|
|
// '200':
|
|
// description: success
|
|
// schema:
|
|
// $ref: '#/definitions/Card'
|
|
// default:
|
|
// description: internal error
|
|
// schema:
|
|
// "$ref": "#/definitions/ErrorResponse"
|
|
|
|
userID := getUserID(r)
|
|
cardID := mux.Vars(r)["cardID"]
|
|
|
|
val := r.URL.Query().Get("disable_notify")
|
|
disableNotify := val == True
|
|
|
|
requestBody, err := io.ReadAll(r.Body)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
card, err := a.app.GetCardByID(cardID)
|
|
if err != nil {
|
|
message := fmt.Sprintf("could not fetch card %s: %s", cardID, err)
|
|
a.errorResponse(w, r, model.NewErrBadRequest(message))
|
|
return
|
|
}
|
|
|
|
if !a.permissions.HasPermissionToBoard(userID, card.BoardID, model.PermissionManageBoardCards) {
|
|
a.errorResponse(w, r, model.NewErrPermission("access denied to patch card"))
|
|
return
|
|
}
|
|
|
|
var patch *model.CardPatch
|
|
if err = json.Unmarshal(requestBody, &patch); err != nil {
|
|
a.errorResponse(w, r, model.NewErrBadRequest(err.Error()))
|
|
return
|
|
}
|
|
|
|
auditRec := a.makeAuditRecord(r, "patchCard", audit.Fail)
|
|
defer a.audit.LogRecord(audit.LevelModify, auditRec)
|
|
auditRec.AddMeta("boardID", card.BoardID)
|
|
auditRec.AddMeta("cardID", card.ID)
|
|
|
|
// patch card
|
|
cardPatched, err := a.app.PatchCard(patch, card.ID, userID, disableNotify)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
a.logger.Debug("PatchCard",
|
|
mlog.String("boardID", cardPatched.BoardID),
|
|
mlog.String("cardID", cardPatched.ID),
|
|
mlog.String("userID", userID),
|
|
)
|
|
|
|
data, err := json.Marshal(cardPatched)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
// response
|
|
jsonBytesResponse(w, http.StatusOK, data)
|
|
|
|
auditRec.Success()
|
|
}
|
|
|
|
func (a *API) handleGetCard(w http.ResponseWriter, r *http.Request) {
|
|
// swagger:operation GET /cards/{cardID}
|
|
//
|
|
// Fetches the specified card.
|
|
//
|
|
// ---
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: cardID
|
|
// in: path
|
|
// description: Card ID
|
|
// required: true
|
|
// type: string
|
|
// security:
|
|
// - BearerAuth: []
|
|
// responses:
|
|
// '200':
|
|
// description: success
|
|
// schema:
|
|
// $ref: '#/definitions/Card'
|
|
// default:
|
|
// description: internal error
|
|
// schema:
|
|
// "$ref": "#/definitions/ErrorResponse"
|
|
|
|
userID := getUserID(r)
|
|
cardID := mux.Vars(r)["cardID"]
|
|
|
|
card, err := a.app.GetCardByID(cardID)
|
|
if err != nil {
|
|
message := fmt.Sprintf("could not fetch card %s: %s", cardID, err)
|
|
a.errorResponse(w, r, model.NewErrBadRequest(message))
|
|
return
|
|
}
|
|
|
|
if !a.permissions.HasPermissionToBoard(userID, card.BoardID, model.PermissionManageBoardCards) {
|
|
a.errorResponse(w, r, model.NewErrPermission("access denied to fetch card"))
|
|
return
|
|
}
|
|
|
|
auditRec := a.makeAuditRecord(r, "getCard", audit.Fail)
|
|
defer a.audit.LogRecord(audit.LevelRead, auditRec)
|
|
auditRec.AddMeta("boardID", card.BoardID)
|
|
auditRec.AddMeta("cardID", card.ID)
|
|
|
|
a.logger.Debug("GetCard",
|
|
mlog.String("boardID", card.BoardID),
|
|
mlog.String("cardID", card.ID),
|
|
mlog.String("userID", userID),
|
|
)
|
|
|
|
data, err := json.Marshal(card)
|
|
if err != nil {
|
|
a.errorResponse(w, r, err)
|
|
return
|
|
}
|
|
|
|
// response
|
|
jsonBytesResponse(w, http.StatusOK, data)
|
|
|
|
auditRec.Success()
|
|
}
|