woodpecker/server/api/badge.go

136 lines
3.9 KiB
Go
Raw Normal View History

// Copyright 2022 Woodpecker Authors
// Copyright 2021 Informatyka Boguslawski sp. z o.o. sp.k., http://www.ib.pl/
// Copyright 2018 Drone.IO Inc.
2018-03-21 13:02:17 +00:00
//
2018-02-19 22:24:10 +00: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
2018-03-21 13:02:17 +00:00
//
2018-02-19 22:24:10 +00:00
// http://www.apache.org/licenses/LICENSE-2.0
2018-03-21 13:02:17 +00:00
//
2018-02-19 22:24:10 +00: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.
package api
2015-04-08 22:43:59 +00:00
import (
"errors"
"fmt"
"net/http"
"strconv"
2015-09-30 01:21:17 +00:00
"github.com/gin-gonic/gin"
"github.com/rs/zerolog/log"
2015-04-08 22:43:59 +00:00
"go.woodpecker-ci.org/woodpecker/v2/server"
"go.woodpecker-ci.org/woodpecker/v2/server/badges"
"go.woodpecker-ci.org/woodpecker/v2/server/ccmenu"
"go.woodpecker-ci.org/woodpecker/v2/server/model"
"go.woodpecker-ci.org/woodpecker/v2/server/store"
"go.woodpecker-ci.org/woodpecker/v2/server/store/types"
2015-04-08 22:43:59 +00:00
)
// GetBadge
//
// @Summary Get status of pipeline as SVG badge
// @Router /badges/{repo_id}/status.svg [get]
// @Produce image/svg+xml
// @Success 200
// @Tags Badges
// @Param repo_id path int true "the repository id"
2015-04-08 22:43:59 +00:00
func GetBadge(c *gin.Context) {
_store := store.FromContext(c)
var repo *model.Repo
var err error
if c.Param("repo_name") != "" {
repo, err = _store.GetRepoName(c.Param("repo_id_or_owner") + "/" + c.Param("repo_name"))
} else {
var repoID int64
repoID, err = strconv.ParseInt(c.Param("repo_id_or_owner"), 10, 64)
if err != nil {
c.AbortWithStatus(http.StatusBadRequest)
return
}
repo, err = _store.GetRepo(repoID)
}
if err != nil {
handleDBError(c, err)
2015-09-30 01:21:17 +00:00
return
}
2015-04-08 22:43:59 +00:00
// if no commit was found then display
// the 'none' badge, instead of throwing
// an error response
2015-09-30 01:21:17 +00:00
branch := c.Query("branch")
if len(branch) == 0 {
branch = repo.Branch
}
pipeline, err := _store.GetPipelineLast(repo, branch)
if err != nil {
if !errors.Is(err, types.RecordNotExist) {
log.Warn().Err(err).Msg("could not get last pipeline for badge")
}
pipeline = nil
2015-04-08 22:43:59 +00:00
}
// we serve an SVG, so set content type appropriately.
c.Writer.Header().Set("Content-Type", "image/svg+xml")
c.String(http.StatusOK, badges.Generate(pipeline))
2015-04-08 22:43:59 +00:00
}
// GetCC
//
// @Summary Provide pipeline status information to the CCMenu tool
// @Description CCMenu displays the pipeline status of projects on a CI server as an item in the Mac's menu bar.
// @Description More details on how to install, you can find at http://ccmenu.org/
// @Description The response format adheres to CCTray v1 Specification, https://cctray.org/v1/
// @Router /badges/{repo_id}/cc.xml [get]
// @Produce xml
// @Success 200
// @Tags Badges
// @Param repo_id path int true "the repository id"
2015-04-08 22:43:59 +00:00
func GetCC(c *gin.Context) {
_store := store.FromContext(c)
2023-10-07 16:59:59 +00:00
var repo *model.Repo
var err error
if c.Param("repo_name") != "" {
repo, err = _store.GetRepoName(c.Param("repo_id_or_owner") + "/" + c.Param("repo_name"))
} else {
var repoID int64
repoID, err = strconv.ParseInt(c.Param("repo_id_or_owner"), 10, 64)
if err != nil {
c.AbortWithStatus(http.StatusBadRequest)
return
}
repo, err = _store.GetRepo(repoID)
}
2015-09-30 01:21:17 +00:00
if err != nil {
handleDBError(c, err)
2015-04-08 22:43:59 +00:00
return
}
pipelines, err := _store.GetPipelineList(repo, &model.ListOptions{Page: 1, PerPage: 1}, nil)
if err != nil && !errors.Is(err, types.RecordNotExist) {
log.Warn().Err(err).Msg("could not get pipeline list")
c.AbortWithStatus(http.StatusInternalServerError)
return
}
if len(pipelines) == 0 {
c.AbortWithStatus(http.StatusNotFound)
2015-09-30 01:21:17 +00:00
return
}
2015-04-08 22:43:59 +00:00
2023-10-07 16:59:59 +00:00
url := fmt.Sprintf("%s/repos/%d/pipeline/%d", server.Config.Server.Host, repo.ID, pipelines[0].Number)
cc := ccmenu.New(repo, pipelines[0], url)
c.XML(http.StatusOK, cc)
2015-04-08 22:43:59 +00:00
}