dao

package

v0.0.0-...-e33f0fe Latest Latest Go to latest Published: Aug 2, 2018 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hegrankyr/harbor

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AddAccessLog(accessLog models.AccessLog) error
func AddAdminJob(job *models.AdminJob) (int64, error)
func AddLabel(label *models.Label) (int64, error)
func AddProject(project models.Project) (int64, error)
func AddProjectMetadata(meta *models.ProjectMetadata) error
func AddRepJob(job models.RepJob) (int64, error)
func AddRepPolicy(policy models.RepPolicy) (int64, error)
func AddRepTarget(target models.RepTarget) (int64, error)
func AddRepository(repo models.RepoRecord) error
func AddResourceLabel(rl *models.ResourceLabel) (int64, error)
func AddScanJob(job models.ScanJob) (int64, error)
func ArrayEqual(arrayA, arrayB []int) bool
func AuthModeCanBeModified() (bool, error)
func ChangeUserPassword(u models.User) error
func ChangeUserProfile(user models.User, cols ...string) error
func CleanUser(id int64) error
func ClearTable(table string) error
func CountPull(repoName string) (int64, error)
func CreatePagination(query *models.ProjectQueryParam, sql string, params []interface{}) (string, []interface{})
func DeleteAdminJob(id int64) error
func DeleteLabel(id int64) error
func DeleteLabelsOfResource(rType string, rIDOrName interface{}) error
func DeleteProject(id int64) error
func DeleteProjectMetadata(projectID int64, name ...string) error
func DeleteRepJob(id int64) error
func DeleteRepPolicy(id int64) error
func DeleteRepTarget(id int64) error
func DeleteRepository(name string) error
func DeleteResourceLabel(id int64) error
func DeleteResourceLabelByLabel(id int64) error
func DeleteUser(userID int) error
func Escape(str string) string
func FilterRepPolicies(name string, projectID, page, pageSize int64) ([]*models.RepPolicy, error)
func FilterRepTargets(name string) ([]*models.RepTarget, error)
func GetAccessLogs(query *models.LogQueryParam) ([]models.AccessLog, error)
func GetAdminJob(id int64) (*models.AdminJob, error)
func GetAdminJobs(query *models.AdminJobQuery) ([]*models.AdminJob, error)
func GetConfigEntries() ([]*models.ConfigEntry, error)
func GetGroupProjects(groupDNCondition string, query *models.ProjectQueryParam) ([]*models.Project, error)
func GetImgScanOverview(digest string) (*models.ImgScanOverview, error)
func GetLabel(id int64) (*models.Label, error)
func GetLabelsOfResource(rType string, rIDOrName interface{}) ([]*models.Label, error)
func GetOrmer() orm.Ormer
func GetProjectByID(id int64) (*models.Project, error)
func GetProjectByName(name string) (*models.Project, error)
func GetProjectMetadata(projectID int64, name ...string) ([]*models.ProjectMetadata, error)
func GetProjects(query *models.ProjectQueryParam) ([]*models.Project, error)
func GetRepJob(id int64) (*models.RepJob, error)
func GetRepJobs(query ...*models.RepJobQuery) ([]*models.RepJob, error)
func GetRepPolicy(id int64) (*models.RepPolicy, error)
func GetRepPolicyByName(name string) (*models.RepPolicy, error)
func GetRepPolicyByProject(projectID int64) ([]*models.RepPolicy, error)
func GetRepPolicyByProjectAndTarget(projectID, targetID int64) ([]*models.RepPolicy, error)
func GetRepPolicyByTarget(targetID int64) ([]*models.RepPolicy, error)
func GetRepTarget(id int64) (*models.RepTarget, error)
func GetRepTargetByEndpoint(endpoint string) (*models.RepTarget, error)
func GetRepTargetByName(name string) (*models.RepTarget, error)
func GetRepositories(query ...*models.RepositoryQuery) ([]*models.RepoRecord, error)
func GetRepositoryByName(name string) (*models.RepoRecord, error)
func GetResourceLabel(rType string, rIDOrName interface{}, labelID int64) (*models.ResourceLabel, error)
func GetRoleByID(id int) (*models.Role, error)
func GetRolesByLDAPGroup(projectID int64, groupDNCondition string) ([]int, error)
func GetScanJob(id int64) (*models.ScanJob, error)
func GetScanJobsByDigest(digest string, limit ...int) ([]*models.ScanJob, error)
func GetScanJobsByImage(repository, tag string, limit ...int) ([]*models.ScanJob, error)
func GetScanJobsByStatus(status ...string) ([]*models.ScanJob, error)
func GetSchemaVersion() (*models.SchemaVersion, error)
func GetTop10AdminJobs() ([]*models.AdminJob, error)
func GetTopRepos(projectIDs []int64, n int) ([]*models.RepoRecord, error)
func GetTotalCountOfRepJobs(query ...*models.RepJobQuery) (int64, error)
func GetTotalGroupProjects(groupDNCondition string, query *models.ProjectQueryParam) (int, error)
func GetTotalOfAccessLogs(query *models.LogQueryParam) (int64, error)
func GetTotalOfLabels(query *models.LabelQuery) (int64, error)
func GetTotalOfProjects(query *models.ProjectQueryParam) (int64, error)
func GetTotalOfRepPolicies(name string, projectID int64) (int64, error)
func GetTotalOfRepositories(query ...*models.RepositoryQuery) (int64, error)
func GetTotalOfUsers(query *models.UserQuery) (int64, error)
func GetUser(query models.User) (*models.User, error)
func GetUserProjectRoles(userID int, projectID int64, entityType string) ([]models.Role, error)
func IncreasePullCount(name string) (err error)
func InitClairDB(clairDB *models.PostGreSQL) error
func InitDatabase(database *models.Database) error
func IsAdminRole(userIDOrUsername interface{}) (bool, error)
func IsSuperUser(username string) bool
func ListClairVulnTimestamps() ([]*models.ClairVulnTimestamp, error)
func ListImgScanOverviews() ([]*models.ImgScanOverview, error)
func ListLabels(query *models.LabelQuery) ([]*models.Label, error)
func ListProjectMetadata(name, value string) ([]*models.ProjectMetadata, error)
func ListResourceLabels(query ...*models.ResourceLabelQuery) ([]*models.ResourceLabel, error)
func ListUsers(query *models.UserQuery) ([]models.User, error)
func LoginByDb(auth models.AuthModel) (*models.User, error)
func OnBoardUser(u *models.User) error
func PrepareTestData(clearSqls []string, initSqls []string)
func PrepareTestForMySQL()
func PrepareTestForPostgresSQL()
func PrepareTestForSQLite()
func Register(user models.User) (int64, error)
func RepositoryExists(name string) bool
func ResetUserPassword(u models.User) error
func SaveConfigEntries(entries []models.ConfigEntry) error
func SetAdminJobUUID(id int64, uuid string) error
func SetClairVulnTimestamp(namespace string, timestamp time.Time) error
func SetRepJobUUID(id int64, uuid string) error
func SetScanJobForImg(digest string, jobID int64) error
func SetScanJobUUID(id int64, uuid string) error
func ToggleUserAdminRole(userID int, hasAdmin bool) error
func UpdateAdminJobStatus(id int64, status string) error
func UpdateImgScanOverview(digest, detailsKey string, sev models.Severity, ...) error
func UpdateLabel(label *models.Label) error
func UpdateProjectMetadata(meta *models.ProjectMetadata) error
func UpdateRepJobStatus(id int64, status string) error
func UpdateRepPolicy(policy *models.RepPolicy) error
func UpdateRepTarget(target models.RepTarget) error
func UpdateRepository(repo models.RepoRecord) error
func UpdateScanJobStatus(id int64, status string) error
func UpdateUserResetUUID(u models.User) error
func UpgradeSchema(database *models.Database) error
func UserExists(user models.User, target string) (bool, error)
type Database
- func NewMySQL(host, port, usr, pwd, database string) Database
- func NewPGSQL(host string, port string, usr string, pwd string, database string, ...) Database
- func NewSQLite(file string) Database
type DatabaseWatchItemDAO
- func (d *DatabaseWatchItemDAO) Add(item *models.WatchItem) (int64, error)
- func (d *DatabaseWatchItemDAO) DeleteByPolicyID(policyID int64) error
- func (d *DatabaseWatchItemDAO) Get(namespace, operation string) ([]models.WatchItem, error)
type WatchItemDAO

Constants ¶

View Source

const (
	// NonExistUserID : if a user does not exist, the ID of the user will be 0.
	NonExistUserID = 0
	// ClairDBAlias ...
	ClairDBAlias = "clair-db"
)

View Source

const (
	// SchemaVersion is the version of database schema
	SchemaVersion = "1.6.0"
)

Variables ¶

This section is empty.

Functions ¶

func AddProject ¶

func AddProject(project models.Project) (int64, error)

AddProject adds a project to the database along with project roles information and access log records.

func AddProjectMetadata ¶

func AddProjectMetadata(meta *models.ProjectMetadata) error

AddProjectMetadata adds metadata for a project

func AddRepository ¶

func AddRepository(repo models.RepoRecord) error

AddRepository adds a repo to the database.

func AddResourceLabel ¶

func AddResourceLabel(rl *models.ResourceLabel) (int64, error)

AddResourceLabel add a label to a resource

func AuthModeCanBeModified ¶

func AuthModeCanBeModified() (bool, error)

AuthModeCanBeModified determines whether auth mode can be modified or not. Auth mode can modified when there is only admin user in database.

func ChangeUserProfile ¶

func ChangeUserProfile(user models.User, cols ...string) error

ChangeUserProfile - Update user in local db, cols to specify the columns need to update, Email, and RealName, Comment are updated by default.

func CleanUser ¶

func CleanUser(id int64) error

CleanUser - Clean this user information from DB

func ClearTable ¶

func ClearTable(table string) error

ClearTable is the shortcut for test cases, it should be called only in test cases.

func DeleteLabelsOfResource ¶

func DeleteLabelsOfResource(rType string, rIDOrName interface{}) error

DeleteLabelsOfResource removes all labels of the resource

func DeleteProjectMetadata ¶

func DeleteProjectMetadata(projectID int64, name ...string) error

DeleteProjectMetadata deleted metadata of a project. If name is absent all metadatas will be deleted, otherwise only the metadatas specified by name will be deleted

func DeleteResourceLabelByLabel ¶

func DeleteResourceLabelByLabel(id int64) error

DeleteResourceLabelByLabel delete the mapping relationship by label ID

func FilterRepPolicies ¶

func FilterRepPolicies(name string, projectID, page, pageSize int64) ([]*models.RepPolicy, error)

FilterRepPolicies filters policies by name and project ID

func GetAccessLogs ¶

func GetAccessLogs(query *models.LogQueryParam) ([]models.AccessLog, error)

GetAccessLogs gets access logs according to different conditions

func GetAdminJobs ¶

func GetAdminJobs(query *models.AdminJobQuery) ([]*models.AdminJob, error)

GetAdminJobs get admin jobs bases on query conditions

func GetConfigEntries ¶

func GetConfigEntries() ([]*models.ConfigEntry, error)

GetConfigEntries Get configuration from database

func GetGroupProjects ¶

func GetGroupProjects(groupDNCondition string, query *models.ProjectQueryParam) ([]*models.Project, error)

GetGroupProjects - Get user's all projects, including user is the user member of this project and the user is in the group which is a group member of this project.

func GetImgScanOverview ¶

func GetImgScanOverview(digest string) (*models.ImgScanOverview, error)

GetImgScanOverview returns the ImgScanOverview based on the digest.

func GetLabelsOfResource ¶

func GetLabelsOfResource(rType string, rIDOrName interface{}) ([]*models.Label, error)

GetLabelsOfResource returns the label list of the resource Get the labels by ResourceID if rIDOrName is int, or get the labels by ResourceName

func GetProjectMetadata ¶

func GetProjectMetadata(projectID int64, name ...string) ([]*models.ProjectMetadata, error)

GetProjectMetadata returns the metadata of a project. If name is absent all metadatas will be returned, otherwise only the metadatas specified by name will be returned

func GetProjects ¶

func GetProjects(query *models.ProjectQueryParam) ([]*models.Project, error)

GetProjects returns a project list according to the query conditions

func GetRepPolicyByProjectAndTarget ¶

func GetRepPolicyByProjectAndTarget(projectID, targetID int64) ([]*models.RepPolicy, error)

GetRepPolicyByProjectAndTarget ...

func GetResourceLabel ¶

func GetResourceLabel(rType string, rIDOrName interface{}, labelID int64) (*models.ResourceLabel, error)

GetResourceLabel specified by resource ID or name Get the ResourceLabel by ResourceID if rIDOrName is int Get the ResourceLabel by ResourceName if rIDOrName is string

func GetRolesByLDAPGroup ¶

func GetRolesByLDAPGroup(projectID int64, groupDNCondition string) ([]int, error)

GetRolesByLDAPGroup - Get Project roles of the specified group DN is a member of current project

func GetScanJobsByDigest ¶

func GetScanJobsByDigest(digest string, limit ...int) ([]*models.ScanJob, error)

GetScanJobsByDigest returns a list of scan jobs with given digest

func GetScanJobsByImage ¶

func GetScanJobsByImage(repository, tag string, limit ...int) ([]*models.ScanJob, error)

GetScanJobsByImage returns a list of scan jobs with given repository and tag

func GetScanJobsByStatus ¶

func GetScanJobsByStatus(status ...string) ([]*models.ScanJob, error)

GetScanJobsByStatus return a list of scan jobs with any of the given statuses in param

func GetSchemaVersion ¶

func GetSchemaVersion() (*models.SchemaVersion, error)

GetSchemaVersion return the version of database schema

func GetTopRepos ¶

func GetTopRepos(projectIDs []int64, n int) ([]*models.RepoRecord, error)

GetTopRepos returns the most popular repositories whose project ID is in projectIDs

func GetTotalGroupProjects ¶

func GetTotalGroupProjects(groupDNCondition string, query *models.ProjectQueryParam) (int, error)

GetTotalGroupProjects - Get the total count of projects, including user is the member of this project and the user is in the group, which is the group member of this project.

func GetTotalOfLabels ¶

func GetTotalOfLabels(query *models.LabelQuery) (int64, error)

GetTotalOfLabels returns the total count of labels

func GetTotalOfProjects ¶

func GetTotalOfProjects(query *models.ProjectQueryParam) (int64, error)

GetTotalOfProjects returns the total count of projects according to the query conditions

func GetTotalOfRepPolicies ¶

func GetTotalOfRepPolicies(name string, projectID int64) (int64, error)

GetTotalOfRepPolicies returns the total count of replication policies

func GetUserProjectRoles ¶

func GetUserProjectRoles(userID int, projectID int64, entityType string) ([]models.Role, error)

GetUserProjectRoles returns roles that the user has according to the project.

func IsAdminRole ¶

func IsAdminRole(userIDOrUsername interface{}) (bool, error)

IsAdminRole returns whether the user is admin.

func IsSuperUser ¶

func IsSuperUser(username string) bool

IsSuperUser checks if the user is super user(conventionally id == 1) of Harbor

func ListClairVulnTimestamps ¶

func ListClairVulnTimestamps() ([]*models.ClairVulnTimestamp, error)

ListClairVulnTimestamps return a list of all records in vuln timestamp table.

func ListImgScanOverviews ¶

func ListImgScanOverviews() ([]*models.ImgScanOverview, error)

ListImgScanOverviews list all records in table img_scan_overview, it is called in notification handler when it needs to refresh the severity of all images.

func ListLabels ¶

func ListLabels(query *models.LabelQuery) ([]*models.Label, error)

ListLabels list labels according to the query conditions

func ListResourceLabels ¶

func ListResourceLabels(query ...*models.ResourceLabelQuery) ([]*models.ResourceLabel, error)

ListResourceLabels lists ResourceLabel according to the query conditions

func ListUsers ¶

func ListUsers(query *models.UserQuery) ([]models.User, error)

ListUsers lists all users according to different conditions.

func LoginByDb ¶

func LoginByDb(auth models.AuthModel) (*models.User, error)

LoginByDb is used for user to login with database auth mode.

func OnBoardUser ¶

func OnBoardUser(u *models.User) error

OnBoardUser will check if a user exists in user table, if not insert the user and put the id in the pointer of user model, if it does exist, return the user's profile. This is used for ldap and uaa authentication, such the user can have an ID in Harbor.

func PrepareTestData ¶

func PrepareTestData(clearSqls []string, initSqls []string)

PrepareTestData -- Clean and Create data

func PrepareTestForMySQL ¶

func PrepareTestForMySQL()

PrepareTestForMySQL is for test only.

func PrepareTestForPostgresSQL ¶

func PrepareTestForPostgresSQL()

PrepareTestForPostgresSQL is for test only.

func PrepareTestForSQLite ¶

func PrepareTestForSQLite()

PrepareTestForSQLite is for test only.

func Register ¶

func Register(user models.User) (int64, error)

Register is used for user to register, the password is encrypted before the record is inserted into database.

func RepositoryExists ¶

func RepositoryExists(name string) bool

RepositoryExists returns whether the repository exists according to its name.

func ResetUserPassword ¶

func ResetUserPassword(u models.User) error

ResetUserPassword ...

func SaveConfigEntries ¶

func SaveConfigEntries(entries []models.ConfigEntry) error

SaveConfigEntries Save configuration to database.

func SetAdminJobUUID ¶

func SetAdminJobUUID(id int64, uuid string) error

SetAdminJobUUID ...

func SetClairVulnTimestamp ¶

func SetClairVulnTimestamp(namespace string, timestamp time.Time) error

SetClairVulnTimestamp update the last_update of a namespace. If there's no record for this namespace, one will be created.

func SetRepJobUUID ¶

func SetRepJobUUID(id int64, uuid string) error

SetRepJobUUID ...

func SetScanJobForImg ¶

func SetScanJobForImg(digest string, jobID int64) error

SetScanJobForImg updates the scan_job_id based on the digest of image, if there's no data, it created one record.

func SetScanJobUUID ¶

func SetScanJobUUID(id int64, uuid string) error

SetScanJobUUID set UUID to the record so it associates with the job in job service.

func ToggleUserAdminRole ¶

func ToggleUserAdminRole(userID int, hasAdmin bool) error

ToggleUserAdminRole gives a user admin role.

func UpdateAdminJobStatus ¶

func UpdateAdminJobStatus(id int64, status string) error

UpdateAdminJobStatus ...

func UpdateImgScanOverview ¶

func UpdateImgScanOverview(digest, detailsKey string, sev models.Severity, compOverview *models.ComponentsOverview) error

UpdateImgScanOverview updates the serverity and components status of a record in img_scan_overview

func UpdateLabel ¶

func UpdateLabel(label *models.Label) error

UpdateLabel ...

func UpdateProjectMetadata ¶

func UpdateProjectMetadata(meta *models.ProjectMetadata) error

UpdateProjectMetadata updates metadata of a project

func UpdateRepJobStatus ¶

func UpdateRepJobStatus(id int64, status string) error

UpdateRepJobStatus ...

func UpdateRepPolicy ¶

func UpdateRepPolicy(policy *models.RepPolicy) error

UpdateRepPolicy ...

func UpdateRepTarget ¶

func UpdateRepTarget(target models.RepTarget) error

UpdateRepTarget ...

func UpdateRepository ¶

func UpdateRepository(repo models.RepoRecord) error

UpdateRepository ...

func UpdateScanJobStatus ¶

func UpdateScanJobStatus(id int64, status string) error

UpdateScanJobStatus updates the status of a scan job.

func UpdateUserResetUUID ¶

func UpdateUserResetUUID(u models.User) error

UpdateUserResetUUID ...

func UpgradeSchema ¶

func UpgradeSchema(database *models.Database) error

UpgradeSchema will call the internal migrator to upgrade schema based on the setting of database.

func UserExists ¶

func UserExists(user models.User, target string) (bool, error)

UserExists returns whether a user exists according username or Email.

Types ¶

type Database ¶

type Database interface {
	// Name returns the name of database
	Name() string
	// String returns the details of database
	String() string
	// Register registers the database which will be used
	Register(alias ...string) error
	// UpgradeSchema upgrades the DB schema to the latest version
	UpgradeSchema() error
}

Database is an interface of different databases

func NewMySQL ¶

func NewMySQL(host, port, usr, pwd, database string) Database

NewMySQL returns an instance of mysql

func NewPGSQL ¶

func NewPGSQL(host string, port string, usr string, pwd string, database string, sslmode bool) Database

NewPGSQL returns an instance of postgres

func NewSQLite ¶

func NewSQLite(file string) Database

NewSQLite returns an instance of sqlite

type DatabaseWatchItemDAO ¶

type DatabaseWatchItemDAO struct{}

DatabaseWatchItemDAO implements interface WatchItemDAO for database

func (*DatabaseWatchItemDAO) Add ¶

func (d *DatabaseWatchItemDAO) Add(item *models.WatchItem) (int64, error)

Add a WatchItem

func (*DatabaseWatchItemDAO) DeleteByPolicyID ¶

func (d *DatabaseWatchItemDAO) DeleteByPolicyID(policyID int64) error

DeleteByPolicyID deletes the WatchItem specified by policy ID

func (*DatabaseWatchItemDAO) Get ¶

func (d *DatabaseWatchItemDAO) Get(namespace, operation string) ([]models.WatchItem, error)

Get returns WatchItem list according to the namespace and operation

type WatchItemDAO ¶

type WatchItemDAO interface {
	Add(*models.WatchItem) (int64, error)
	DeleteByPolicyID(int64) error
	Get(namespace, operation string) ([]models.WatchItem, error)
}

WatchItemDAO defines operations about WatchItem

var DefaultDatabaseWatchItemDAO WatchItemDAO = &DatabaseWatchItemDAO{}

DefaultDatabaseWatchItemDAO is an instance of DatabaseWatchItemDAO

Directories ¶

Path	Synopsis
clair
group
project

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func AddAccessLog ¶

func AddAdminJob ¶

func AddLabel ¶

func AddProject ¶

func AddProjectMetadata ¶

func AddRepJob ¶

func AddRepPolicy ¶

func AddRepTarget ¶

func AddRepository ¶

func AddResourceLabel ¶

func AddScanJob ¶

func ArrayEqual ¶

func AuthModeCanBeModified ¶

func ChangeUserPassword ¶

func ChangeUserProfile ¶

func CleanUser ¶

func ClearTable ¶

func CountPull ¶

func CreatePagination ¶

func DeleteAdminJob ¶

func DeleteLabel ¶

func DeleteLabelsOfResource ¶

func DeleteProject ¶

func DeleteProjectMetadata ¶

func DeleteRepJob ¶

func DeleteRepPolicy ¶

func DeleteRepTarget ¶

func DeleteRepository ¶

func DeleteResourceLabel ¶

func DeleteResourceLabelByLabel ¶

func DeleteUser ¶

func Escape ¶

func FilterRepPolicies ¶

func FilterRepTargets ¶

func GetAccessLogs ¶

func GetAdminJob ¶

func GetAdminJobs ¶

func GetConfigEntries ¶

func GetGroupProjects ¶

func GetImgScanOverview ¶

func GetLabel ¶

func GetLabelsOfResource ¶

func GetOrmer ¶

func GetProjectByID ¶

func GetProjectByName ¶

func GetProjectMetadata ¶

func GetProjects ¶

func GetRepJob ¶

func GetRepJobs ¶

func GetRepPolicy ¶

func GetRepPolicyByName ¶

func GetRepPolicyByProject ¶

func GetRepPolicyByProjectAndTarget ¶

func GetRepPolicyByTarget ¶

func GetRepTarget ¶

func GetRepTargetByEndpoint ¶

func GetRepTargetByName ¶

func GetRepositories ¶

func GetRepositoryByName ¶

func GetResourceLabel ¶

func GetRoleByID ¶