mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-07-25 10:57:37 +00:00
a5a2cae7ee
**Backport:** https://codeberg.org/forgejo/forgejo/pulls/13143 The details of the refactor are in [a separate branch](https://codeberg.org/limiting-factor/forgejo/commits/branch/wip-api-context-accessors-save) which details how it was done. This pull request contains a squash of those commits rebased on top of the current Forgejo branch, which involved conflict resolution. Given the magnitude of the change, there is a high chance that a large number of future pull requests merged in Forgejo will create conflicts. They will be dealt with in the same way as chore: refactor orgAssignment to two separate middlewares (#13155). ## Review The only risk I can think of is a getter/setter implementation being incorrectly implemented. This is probably where a detailed review is most needed, in the `services/context/api.go` file. To not increase the size of the pull request, the `GetX()` accessors were preserved although they are redundant with `X()`. They will be removed in a followup pull request. ## Backporting strategy. Cherry-picking the commit to v15 has a significant amount of conflicts in 8 files out of 111. ``` unmerged routers/api/v1/activitypub/repository.go unmerged routers/api/v1/admin/user.go unmerged routers/api/v1/api.go unmerged routers/api/v1/org/team.go unmerged routers/api/v1/repo/action.go unmerged routers/api/v1/repo/pull.go unmerged routers/api/v1/user/follower.go unmerged services/context/api.go ``` Instead of resolving them, I think it is easier and safer to repeat the [refactor steps](https://codeberg.org/limiting-factor/forgejo/commits/branch/wip-api-context-accessors-save) in v15. I also think it is worth the effort since it will avoid trivial backport conflicts on over 100 files. ## Context This is a followup pull request discussed originally at https://codeberg.org/forgejo/forgejo/pulls/12512 Co-authored-by: limiting-factor <limiting-factor@posteo.com> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/13213 Reviewed-by: limiting-factor <limiting-factor@noreply.codeberg.org> Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org>
86 lines
2 KiB
Go
86 lines
2 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package admin
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"forgejo.org/modules/log"
|
|
"forgejo.org/modules/structs"
|
|
"forgejo.org/modules/util"
|
|
"forgejo.org/routers/api/v1/utils"
|
|
"forgejo.org/services/context"
|
|
"forgejo.org/services/cron"
|
|
)
|
|
|
|
// ListCronTasks api for getting cron tasks
|
|
func ListCronTasks(ctx *context.APIContext) {
|
|
// swagger:operation GET /admin/cron admin adminCronList
|
|
// ---
|
|
// summary: List cron tasks
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results to return (1-based)
|
|
// type: integer
|
|
// - name: limit
|
|
// in: query
|
|
// description: page size of results
|
|
// type: integer
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/CronList"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
tasks := cron.ListTasks()
|
|
count := len(tasks)
|
|
|
|
listOpts := utils.GetListOptions(ctx)
|
|
tasks = util.PaginateSlice(tasks, listOpts.Page, listOpts.PageSize).(cron.TaskTable)
|
|
|
|
res := make([]structs.Cron, len(tasks))
|
|
for i, task := range tasks {
|
|
res[i] = structs.Cron{
|
|
Name: task.Name,
|
|
Schedule: task.Spec,
|
|
Next: task.Next,
|
|
Prev: task.Prev,
|
|
ExecTimes: task.ExecTimes,
|
|
}
|
|
}
|
|
|
|
ctx.SetTotalCountHeader(int64(count))
|
|
ctx.JSON(http.StatusOK, res)
|
|
}
|
|
|
|
// PostCronTask api for getting cron tasks
|
|
func PostCronTask(ctx *context.APIContext) {
|
|
// swagger:operation POST /admin/cron/{task} admin adminCronRun
|
|
// ---
|
|
// summary: Run cron task
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: task
|
|
// in: path
|
|
// description: task to run
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
task := cron.GetTask(ctx.Params(":task"))
|
|
if task == nil {
|
|
ctx.NotFound()
|
|
return
|
|
}
|
|
task.Run()
|
|
log.Trace("Cron Task %s started by admin(%s)", task.Name, ctx.Doer().Name)
|
|
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|