1
0
mirror of https://github.com/goharbor/harbor.git synced 2024-12-27 11:07:46 +01:00
harbor/api/project.go

304 lines
8.6 KiB
Go
Raw Normal View History

2016-02-01 12:59:10 +01:00
/*
Copyright (c) 2016 VMware, Inc. All Rights Reserved.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
*/
2016-02-26 11:54:14 +01:00
2016-02-01 12:59:10 +01:00
package api
import (
"fmt"
"net/http"
2016-05-31 11:38:51 +02:00
"unicode"
2016-02-01 12:59:10 +01:00
"github.com/vmware/harbor/dao"
"github.com/vmware/harbor/models"
2016-03-28 02:50:09 +02:00
"github.com/vmware/harbor/utils/log"
2016-02-01 12:59:10 +01:00
"strconv"
"time"
)
2016-02-26 11:35:55 +01:00
// ProjectAPI handles request to /api/projects/{} /api/projects/{}/logs
2016-02-01 12:59:10 +01:00
type ProjectAPI struct {
BaseAPI
userID int
projectID int64
2016-02-01 12:59:10 +01:00
}
type projectReq struct {
ProjectName string `json:"project_name"`
Public bool `json:"public"`
}
const projectNameMaxLen int = 30
const projectNameMinLen int = 4
2016-02-17 07:29:05 +01:00
2016-02-26 11:35:55 +01:00
// Prepare validates the URL and the user
2016-02-01 12:59:10 +01:00
func (p *ProjectAPI) Prepare() {
idStr := p.Ctx.Input.Param(":id")
if len(idStr) > 0 {
2016-02-01 12:59:10 +01:00
var err error
p.projectID, err = strconv.ParseInt(idStr, 10, 64)
2016-02-01 12:59:10 +01:00
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Error parsing project id: %s, error: %v", idStr, err)
p.CustomAbort(http.StatusBadRequest, "invalid project id")
2016-02-01 12:59:10 +01:00
}
exist, err := dao.ProjectExists(p.projectID)
2016-02-01 12:59:10 +01:00
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Error occurred in ProjectExists, error: %v", err)
p.CustomAbort(http.StatusInternalServerError, "Internal error.")
2016-02-01 12:59:10 +01:00
}
2016-02-17 07:29:05 +01:00
if !exist {
p.CustomAbort(http.StatusNotFound, fmt.Sprintf("project does not exist, id: %v", p.projectID))
2016-02-01 12:59:10 +01:00
}
}
}
2016-02-26 11:35:55 +01:00
// Post ...
2016-02-01 12:59:10 +01:00
func (p *ProjectAPI) Post() {
p.userID = p.ValidateUser()
2016-02-01 12:59:10 +01:00
var req projectReq
var public int
p.DecodeJSONReq(&req)
2016-02-01 12:59:10 +01:00
if req.Public {
public = 1
}
2016-02-17 07:29:05 +01:00
err := validateProjectReq(req)
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Invalid project request, error: %v", err)
p.RenderError(http.StatusBadRequest, "Invalid request for creating project")
2016-02-17 07:29:05 +01:00
return
}
2016-02-01 12:59:10 +01:00
projectName := req.ProjectName
exist, err := dao.ProjectExists(projectName)
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Error happened checking project existence in db, error: %v, project name: %s", err, projectName)
2016-02-01 12:59:10 +01:00
}
if exist {
p.RenderError(http.StatusConflict, "")
2016-02-01 12:59:10 +01:00
return
}
2016-02-26 03:15:01 +01:00
project := models.Project{OwnerID: p.userID, Name: projectName, CreationTime: time.Now(), Public: public}
projectID, err := dao.AddProject(project)
2016-02-17 07:29:05 +01:00
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Failed to add project, error: %v", err)
p.RenderError(http.StatusInternalServerError, "Failed to add project")
2016-02-17 07:29:05 +01:00
}
p.Redirect(http.StatusCreated, strconv.FormatInt(projectID, 10))
2016-02-01 12:59:10 +01:00
}
2016-02-26 11:35:55 +01:00
// Head ...
2016-02-01 12:59:10 +01:00
func (p *ProjectAPI) Head() {
projectName := p.GetString("project_name")
2016-05-20 05:32:12 +02:00
if len(projectName) == 0 {
p.CustomAbort(http.StatusBadRequest, "project_name is needed")
}
project, err := dao.GetProjectByName(projectName)
2016-02-01 12:59:10 +01:00
if err != nil {
log.Errorf("error occurred in GetProjectByName: %v", err)
p.CustomAbort(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
2016-02-01 12:59:10 +01:00
}
// only public project can be Headed by user without login
if project != nil && project.Public == 1 {
2016-02-01 12:59:10 +01:00
return
}
userID := p.ValidateUser()
if project == nil {
p.CustomAbort(http.StatusNotFound, http.StatusText(http.StatusNotFound))
}
if !checkProjectPermission(userID, project.ProjectID) {
p.CustomAbort(http.StatusForbidden, http.StatusText(http.StatusForbidden))
}
2016-02-01 12:59:10 +01:00
}
2016-02-26 11:35:55 +01:00
// Get ...
2016-02-01 12:59:10 +01:00
func (p *ProjectAPI) Get() {
2016-05-26 07:59:03 +02:00
project, err := dao.GetProjectByID(p.projectID)
if err != nil {
log.Errorf("failed to get project %d: %v", p.projectID, err)
p.CustomAbort(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
}
if project.Public == 0 {
userID := p.ValidateUser()
if !checkProjectPermission(userID, p.projectID) {
p.CustomAbort(http.StatusUnauthorized, http.StatusText(http.StatusUnauthorized))
}
}
p.Data["json"] = project
p.ServeJSON()
}
// List ...
func (p *ProjectAPI) List() {
2016-05-17 11:03:40 +02:00
var projectList []models.Project
2016-02-01 12:59:10 +01:00
projectName := p.GetString("project_name")
if len(projectName) > 0 {
2016-05-17 11:03:40 +02:00
projectName = "%" + projectName + "%"
2016-02-01 12:59:10 +01:00
}
2016-05-17 11:03:40 +02:00
var public int
var err error
isPublic := p.GetString("is_public")
if len(isPublic) > 0 {
2016-05-17 11:03:40 +02:00
public, err = strconv.Atoi(isPublic)
if err != nil {
log.Errorf("Error parsing public property: %d, error: %v", isPublic, err)
p.CustomAbort(http.StatusBadRequest, "invalid project Id")
}
}
isAdmin := false
2016-05-17 11:03:40 +02:00
if public == 1 {
projectList, err = dao.GetPublicProjects(projectName)
} else {
//if the request is not for public projects, user must login or provide credential
p.userID = p.ValidateUser()
isAdmin, err = dao.IsAdminRole(p.userID)
2016-05-17 11:03:40 +02:00
if err != nil {
log.Errorf("Error occured in check admin, error: %v", err)
2016-05-17 11:03:40 +02:00
p.CustomAbort(http.StatusInternalServerError, "Internal error.")
}
if isAdmin {
projectList, err = dao.GetAllProjects(projectName)
} else {
projectList, err = dao.GetUserRelevantProjects(p.userID, projectName)
}
}
if err != nil {
2016-05-18 09:07:54 +02:00
log.Errorf("Error occured in get projects info, error: %v", err)
p.CustomAbort(http.StatusInternalServerError, "Internal error.")
2016-02-01 12:59:10 +01:00
}
for i := 0; i < len(projectList); i++ {
if public != 1 {
if isAdmin {
projectList[i].Role = models.PROJECTADMIN
}
if projectList[i].Role == models.PROJECTADMIN {
projectList[i].Togglable = true
}
2016-02-01 12:59:10 +01:00
}
projectList[i].RepoCount = getRepoCountByProject(projectList[i].Name)
2016-02-01 12:59:10 +01:00
}
p.Data["json"] = projectList
p.ServeJSON()
}
2016-06-02 11:33:10 +02:00
// ToggleProjectPulic handles request PUT /api/projects/:id/publicity
2016-05-25 08:21:01 +02:00
func (p *ProjectAPI) ToggleProjectPublic() {
p.userID = p.ValidateUser()
2016-02-01 12:59:10 +01:00
var req projectReq
var public int
projectID, err := strconv.ParseInt(p.Ctx.Input.Param(":id"), 10, 64)
2016-02-01 12:59:10 +01:00
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Error parsing project id: %d, error: %v", projectID, err)
p.RenderError(http.StatusBadRequest, "invalid project id")
2016-02-01 12:59:10 +01:00
return
}
p.DecodeJSONReq(&req)
2016-02-01 12:59:10 +01:00
if req.Public {
public = 1
}
if !isProjectAdmin(p.userID, projectID) {
2016-03-28 02:50:09 +02:00
log.Warningf("Current user, id: %d does not have project admin role for project, id: %d", p.userID, projectID)
p.RenderError(http.StatusForbidden, "")
2016-02-01 12:59:10 +01:00
return
}
err = dao.ToggleProjectPublicity(p.projectID, public)
2016-02-01 12:59:10 +01:00
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Error while updating project, project id: %d, error: %v", projectID, err)
p.RenderError(http.StatusInternalServerError, "Failed to update project")
2016-02-01 12:59:10 +01:00
}
}
2016-02-26 11:35:55 +01:00
// FilterAccessLog handles GET to /api/projects/{}/logs
2016-02-01 12:59:10 +01:00
func (p *ProjectAPI) FilterAccessLog() {
p.userID = p.ValidateUser()
2016-02-01 12:59:10 +01:00
var filter models.AccessLog
p.DecodeJSONReq(&filter)
2016-02-01 12:59:10 +01:00
username := filter.Username
keywords := filter.Keywords
beginTime := time.Unix(filter.BeginTimestamp, 0)
endTime := time.Unix(filter.EndTimestamp, 0)
2016-02-26 03:15:01 +01:00
query := models.AccessLog{ProjectID: p.projectID, Username: "%" + username + "%", Keywords: keywords, BeginTime: beginTime, BeginTimestamp: filter.BeginTimestamp, EndTime: endTime, EndTimestamp: filter.EndTimestamp}
2016-03-28 02:50:09 +02:00
log.Infof("Query AccessLog: begin: %v, end: %v, keywords: %s", query.BeginTime, query.EndTime, query.Keywords)
2016-02-01 12:59:10 +01:00
accessLogList, err := dao.GetAccessLogs(query)
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Error occurred in GetAccessLogs, error: %v", err)
p.CustomAbort(http.StatusInternalServerError, "Internal error.")
2016-02-01 12:59:10 +01:00
}
p.Data["json"] = accessLogList
2016-04-21 18:28:59 +02:00
2016-02-01 12:59:10 +01:00
p.ServeJSON()
}
func isProjectAdmin(userID int, pid int64) bool {
isSysAdmin, err := dao.IsAdminRole(userID)
if err != nil {
log.Errorf("Error occurred in IsAdminRole, returning false, error: %v", err)
return false
}
if isSysAdmin {
return true
}
2016-03-29 06:09:27 +02:00
rolelist, err := dao.GetUserProjectRoles(userID, pid)
2016-02-01 12:59:10 +01:00
if err != nil {
2016-03-28 02:50:09 +02:00
log.Errorf("Error occurred in GetUserProjectRoles, returning false, error: %v", err)
2016-02-01 12:59:10 +01:00
return false
}
2016-03-29 06:09:27 +02:00
hasProjectAdminRole := false
for _, role := range rolelist {
if role.RoleID == models.PROJECTADMIN {
hasProjectAdminRole = true
break
}
}
return hasProjectAdminRole
2016-02-01 12:59:10 +01:00
}
2016-02-17 07:29:05 +01:00
func validateProjectReq(req projectReq) error {
pn := req.ProjectName
if len(pn) == 0 {
return fmt.Errorf("Project name can not be empty")
}
if isIllegalLength(req.ProjectName, projectNameMinLen, projectNameMaxLen) {
2016-05-25 08:21:01 +02:00
return fmt.Errorf("project name is illegal in length. (greater than 4 or less than 30)")
}
if isContainIllegalChar(req.ProjectName, []string{"~", "-", "$", "\\", "[", "]", "{", "}", "(", ")", "&", "^", "%", "*", "<", ">", "\"", "'", "/", "?", "@"}) {
return fmt.Errorf("project name contains illegal characters")
}
2016-05-31 11:38:51 +02:00
for _, v := range pn {
if !unicode.IsLower(v) {
return fmt.Errorf("project name must be in lower case")
}
}
2016-02-17 07:29:05 +01:00
return nil
}