// Copyright Project Harbor Authors // // 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. package models import ( "strings" "time" ) // ProjectTable is the table name for project const ProjectTable = "project" // Project holds the details of a project. type Project struct { ProjectID int64 `orm:"pk;auto;column(project_id)" json:"project_id"` OwnerID int `orm:"column(owner_id)" json:"owner_id"` Name string `orm:"column(name)" json:"name"` CreationTime time.Time `orm:"column(creation_time);auto_now_add" json:"creation_time"` UpdateTime time.Time `orm:"column(update_time);auto_now" json:"update_time"` Deleted bool `orm:"column(deleted)" json:"deleted"` OwnerName string `orm:"-" json:"owner_name"` Togglable bool `orm:"-" json:"togglable"` Role int `orm:"-" json:"current_user_role_id"` RepoCount int64 `orm:"-" json:"repo_count"` Metadata map[string]string `orm:"-" json:"metadata"` } // GetMetadata ... func (p *Project) GetMetadata(key string) (string, bool) { if len(p.Metadata) == 0 { return "", false } value, exist := p.Metadata[key] return value, exist } // SetMetadata ... func (p *Project) SetMetadata(key, value string) { if p.Metadata == nil { p.Metadata = map[string]string{} } p.Metadata[key] = value } // IsPublic ... func (p *Project) IsPublic() bool { public, exist := p.GetMetadata(ProMetaPublic) if !exist { return false } return isTrue(public) } // ContentTrustEnabled ... func (p *Project) ContentTrustEnabled() bool { enabled, exist := p.GetMetadata(ProMetaEnableContentTrust) if !exist { return false } return isTrue(enabled) } // VulPrevented ... func (p *Project) VulPrevented() bool { prevent, exist := p.GetMetadata(ProMetaPreventVul) if !exist { return false } return isTrue(prevent) } // Severity ... func (p *Project) Severity() string { severity, exist := p.GetMetadata(ProMetaSeverity) if !exist { return "" } return severity } // AutoScan ... func (p *Project) AutoScan() bool { auto, exist := p.GetMetadata(ProMetaAutoScan) if !exist { return false } return isTrue(auto) } func isTrue(value string) bool { return strings.ToLower(value) == "true" || strings.ToLower(value) == "1" } // ProjectQueryParam can be used to set query parameters when listing projects. // The query condition will be set in the query if its corresponding field // is not nil. Leave it empty if you don't want to apply this condition. // // e.g. // List all projects: query := nil // List all public projects: query := &QueryParam{Public: true} // List projects the owner of which is user1: query := &QueryParam{Owner:"user1"} // List all public projects the owner of which is user1: query := &QueryParam{Owner:"user1",Public:true} // List projects which user1 is member of: query := &QueryParam{Member:&Member{Name:"user1"}} // List projects which user1 is the project admin : query := &QueryParam{Member:&Member{Name:"user1",Role:1}} type ProjectQueryParam struct { Name string // the name of project Owner string // the username of project owner Public *bool // the project is public or not, can be ture, false and nil Member *MemberQuery // the member of project Pagination *Pagination // pagination information ProjectIDs []int64 // project ID list } // MemberQuery filter by member's username and role type MemberQuery struct { Name string // the username of member Role int // the role of the member has to the project GroupList []*UserGroup // the group list of current user } // Pagination ... type Pagination struct { Page int64 Size int64 } // Sorting sort by given field, ascending or descending type Sorting struct { Sort string // in format [+-]?, e.g. '+creation_time', '-creation_time' } // BaseProjectCollection contains the query conditions which can be used // to get a project collection. The collection can be used as the base to // do other filter type BaseProjectCollection struct { Public bool Member string } // ProjectRequest holds informations that need for creating project API type ProjectRequest struct { Name string `json:"project_name"` Public *int `json:"public"` // deprecated, reserved for project creation in replication Metadata map[string]string `json:"metadata"` } // ProjectQueryResult ... type ProjectQueryResult struct { Total int64 Projects []*Project } // TableName is required by beego orm to map Project to table project func (p *Project) TableName() string { return ProjectTable }