support dco

controllers/dco.go

@@ -0,0 +1,127 @@
+package controllers
+
+import (
+	"strings"
+
+	"github.com/opensourceways/app-cla-server/models"
+)
+
+type DCOController struct {
+	baseController
+}
+
+func (ctl *DCOController) Prepare() {
+	if ctl.isGetRequest() && strings.HasSuffix(ctl.routerPattern(), "/:link_id/:id") {
+		ctl.apiPrepare("")
+	} else {
+		ctl.apiPrepare(PermissionOwnerOfOrg)
+	}
+}
+
+// @Title Add
+// @Description add dco
+// @Tags DCO
+// @Accept json
+// @Param  body  body  models.DCOCreateOpt  true  "body for adding dco"
+// @Success 201 {object} controllers.respData
+// @router /:link_id [post]
+func (ctl *DCOController) Add() {
+	action := "add dco"
+	linkID := ctl.GetString(":link_id")
+
+	pl, fr := ctl.tokenPayloadBasedOnCodePlatform()
+	if fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+	if fr := pl.isOwnerOfLink(linkID); fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+
+	input := &models.DCOCreateOpt{}
+	if fr := ctl.fetchInputPayloadFromFormData(input); fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+
+	if err := models.AddDCOInstance(linkID, input); err != nil {
+		ctl.sendModelErrorAsResp(err, action)
+	} else {
+		ctl.sendSuccessResp(action, "successfully")
+	}
+}
+
+// @Title Delete
+// @Description delete dco
+// @Tags DCO
+// @Accept json
+// @Param  link_id  path  string  true  "link id"
+// @Param  id       path  string  true  "dco id"
+// @Success 204 {object} controllers.respData
+// @router /:link_id/:id [delete]
+func (ctl *DCOController) Delete() {
+	action := "delete dco"
+	linkID := ctl.GetString(":link_id")
+	dcoId := ctl.GetString(":id")
+
+	pl, fr := ctl.tokenPayloadBasedOnCodePlatform()
+	if fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+	if fr := pl.isOwnerOfLink(linkID); fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+
+	if err := models.RemoveDCOInstance(linkID, dcoId); err != nil {
+		ctl.sendModelErrorAsResp(err, action)
+
+		return
+	}
+
+	ctl.sendSuccessResp(action, "successfully")
+}
+
+// @Title DownloadPDF
+// @Description get dco pdf
+// @Tags DCO
+// @Accept json
+// @Param  link_id  path  string  true  "link id"
+// @Param  id       path  string  true  "dco id"
+// @Success 200
+// @router /:link_id/:id [get]
+func (ctl *DCOController) DownloadPDF() {
+	ctl.downloadFile(models.DCOFile(
+		ctl.GetString(":link_id"), ctl.GetString(":id"),
+	))
+}
+
+// @Title List
+// @Description list dcos of link
+// @Tags DCO
+// @Accept json
+// @Param  link_id  path  string  true  "link id"
+// @Success 200 {object} models.CLADetail
+// @router /:link_id [get]
+func (ctl *DCOController) List() {
+	action := "list dco"
+	linkID := ctl.GetString(":link_id")
+
+	pl, fr := ctl.tokenPayloadBasedOnCodePlatform()
+	if fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+	if fr := pl.isOwnerOfLink(linkID); fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+
+	if dcos, merr := models.ListDCOInstances(linkID); merr != nil {
+		ctl.sendModelErrorAsResp(merr, action)
+	} else {
+		ctl.sendSuccessResp(action, dcos)
+	}
+}

controllers/dco_link.go

@@ -0,0 +1,134 @@
+package controllers
+
+import (
+	"strings"
+
+	"github.com/opensourceways/app-cla-server/models"
+)
+
+type DCOLinkController struct {
+	baseController
+}
+
+func (ctl *DCOLinkController) Prepare() {
+	if strings.HasSuffix(ctl.routerPattern(), "dcos") {
+		ctl.apiPrepare("")
+	} else {
+		ctl.apiPrepare(PermissionOwnerOfOrg)
+	}
+}
+
+// @Title Create
+// @Description create a link(dco application)
+// @Tags DCOLink
+// @Accept json
+// @Param  body  body  models.DCOLinkCreateOption  true  "body for creating link"
+// @Success 201 {object} controllers.respData
+// @router / [post]
+func (ctl *DCOLinkController) Create() {
+	action := "community manager creates link(dco application)"
+	sendResp := ctl.newFuncForSendingFailedResp(action)
+
+	pl, fr := ctl.tokenPayloadBasedOnCodePlatform()
+	if fr != nil {
+		sendResp(fr)
+		return
+	}
+
+	input := &models.DCOLinkCreateOption{}
+	if fr := ctl.fetchInputPayloadFromFormData(input); fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+
+	if fr := pl.isOwnerOfOrg(input.Platform, input.OrgID); fr != nil {
+		sendResp(fr)
+		return
+	}
+
+	if merr := models.AddDCOLink(pl.User, input); merr != nil {
+		ctl.sendModelErrorAsResp(merr, action)
+		return
+	}
+
+	ctl.sendSuccessResp(action, "successfully")
+}
+
+// @Title Delete
+// @Description delete link
+// @Tags DCOLink
+// @Accept json
+// @Param  link_id  path  string  true  "link id"
+// @Success 204 {object} controllers.respData
+// @router /:link_id [delete]
+func (ctl *DCOLinkController) Delete() {
+	linkId := ctl.GetString(":link_id")
+	action := "community manager delete dco link: " + linkId
+	sendResp := ctl.newFuncForSendingFailedResp(action)
+
+	pl, fr := ctl.tokenPayloadBasedOnCodePlatform()
+	if fr != nil {
+		sendResp(fr)
+		return
+	}
+
+	if fr := pl.isOwnerOfLink(linkId); fr != nil {
+		sendResp(fr)
+		return
+	}
+
+	if err := models.RemoveDCOLink(linkId); err != nil {
+		ctl.sendModelErrorAsResp(err, action)
+		return
+	}
+
+	ctl.sendSuccessResp(action, "successfully")
+}
+
+// @Title List
+// @Description list all links
+// @Tags DCOLink
+// @Accept json
+// @Success 200 {object} models.LinkInfo
+// @Failure 401 missing_token:              token is missing
+// @Failure 402 unknown_token:              token is unknown
+// @Failure 403 expired_token:              token is expired
+// @Failure 404 unauthorized_token:         the permission of token is unmatched
+// @Failure 500 system_error:               system error
+// @router / [get]
+func (ctl *DCOLinkController) List() {
+	action := "community manager list dco links"
+
+	pl, fr := ctl.tokenPayloadBasedOnCodePlatform()
+	if fr != nil {
+		ctl.sendFailedResultAsResp(fr, action)
+		return
+	}
+
+	if r, merr := models.ListDCOLink(pl.Platform, pl.Orgs); merr != nil {
+		ctl.sendModelErrorAsResp(merr, action)
+	} else {
+		ctl.sendSuccessResp(action, r)
+	}
+}
+
+// @Title GetDCOForSigning
+// @Description get signing page info
+// @Tags DCOLink
+// @Accept json
+// @Param  link_id   path  string  true  "link id"
+// @Param  apply_to  path  string  true  "apply to"
+// @Success 200 {object} models.CLADetail
+// @Failure util.ErrNoCLABindingDoc	"org has not been bound any clas"
+// @Failure util.ErrNotReadyToSign	"the corp signing is not ready"
+// @router /:link_id/dcos [get]
+func (ctl *DCOLinkController) GetDCOForSigning() {
+	action := "fetch dco signing page info"
+
+	result, err := models.ListDCOs(ctl.GetString(":link_id"))
+	if err != nil {
+		ctl.sendModelErrorAsResp(err, action)
+	} else {
+		ctl.sendSuccessResp(action, result)
+	}
+}

controllers/link.go

@@ -18,14 +18,14 @@ func (ctl *LinkController) Prepare() {
 	}
 }
 
-// @Title Link
+// @Title Create
 // @Description create a link(cla application)
 // @Tags Link
 // @Accept json
 // @Param  body  body  models.LinkCreateOption  true  "body for creating link"
 // @Success 201 {object} controllers.respData
 // @router / [post]
-func (ctl *LinkController) Link() {
+func (ctl *LinkController) Create() {
 	action := "community manager creates link(cla application)"
 	sendResp := ctl.newFuncForSendingFailedResp(action)
 

controllers/token.go

@@ -6,7 +6,6 @@ import (
 	"net"
 	"strings"
 
-	"github.com/beego/beego/v2/core/logs"
 	"github.com/opensourceways/app-cla-server/models"
 )
 
@@ -92,17 +91,12 @@ func (ctl *baseController) setToken(t models.AccessToken) {
 
 func (ctl *baseController) getRemoteAddr() (string, *failedApiResult) {
 	ips := ctl.Ctx.Request.Header.Get("x-forwarded-for")
-	logs.Info("x-forwarded-for value is: %s", ips)
 
 	for _, item := range strings.Split(ips, ", ") {
 		if net.ParseIP(item) != nil {
-			logs.Info("x-forwarded-for value is: %s, remote addr: %s", ips, item)
-
 			return item, nil
 		}
 	}
 
-	logs.Info("x-forwarded-for value is: %s, no remote addr", ips)
-
 	return "", newFailedApiResult(400, errCanNotFetchClientIP, fmt.Errorf("can not fetch client ip"))
 }

models/adapter.go

@@ -48,6 +48,8 @@ func ListLink(platform string, orgs []string) ([]LinkInfo, IModelError) {
 	return linkAdapterInstance.List(platform, orgs)
 }
 
+// function of signing
+
 func GetLinkCLA(linkId, claId string) (OrgInfo, CLAInfo, IModelError) {
 	return linkAdapterInstance.GetLinkCLA(linkId, claId)
 }
@@ -60,6 +62,42 @@ func GetLink(linkId string) (OrgInfo, IModelError) {
 	return linkAdapterInstance.GetLink(linkId)
 }
 
+// dco
+
+func AddDCOInstance(linkId string, opt *DCOCreateOpt) IModelError {
+	return dcoAdapterInstance.Add(linkId, opt)
+}
+
+func DCOFile(linkId, dcoId string) string {
+	return dcoAdapterInstance.DCOLocalFilePath(linkId, dcoId)
+}
+
+func ListDCOInstances(linkId string) ([]CLADetail, IModelError) {
+	return dcoAdapterInstance.List(linkId)
+}
+
+func RemoveDCOInstance(linkId, dcoId string) IModelError {
+	return dcoAdapterInstance.Remove(linkId, dcoId)
+}
+
+// dco link
+
+func AddDCOLink(submitter string, opt *DCOLinkCreateOption) IModelError {
+	return dcoLinkAdapterInstance.Add(submitter, opt)
+}
+
+func RemoveDCOLink(linkId string) IModelError {
+	return dcoLinkAdapterInstance.Remove(linkId)
+}
+
+func ListDCOLink(platform string, orgs []string) ([]LinkInfo, IModelError) {
+	return dcoLinkAdapterInstance.List(platform, orgs)
+}
+
+func ListDCOs(linkId string) ([]CLADetail, IModelError) {
+	return dcoLinkAdapterInstance.ListDCOs(linkId)
+}
+
 // corp signing
 
 func VCOfCorpSigning(linkId, email string) (string, IModelError) {

models/dco.go

@@ -0,0 +1,16 @@
+package models
+
+type DCOLinkCreateOption struct {
+	Platform string        `json:"platform"`
+	OrgID    string        `json:"org_id"`
+	RepoID   string        `json:"repo_id"`
+	OrgAlias string        `json:"org_alias"`
+	OrgEmail string        `json:"org_email"`
+	DCO      *DCOCreateOpt `json:"dco"`
+}
+
+type DCOCreateOpt = struct {
+	URL      string     `json:"url"`
+	Fields   []CLAField `json:"fields"`
+	Language string     `json:"language"`
+}

models/error.go

@@ -49,10 +49,15 @@ const (
 	ErrNoRefreshToken          ModelErrCode = "no_refresh_token"
 	ErrInvalidToken            ModelErrCode = "invalid_token"
 	ErrCLAExists               ModelErrCode = "cla_exists"
+	ErrCLAIsUsed               ModelErrCode = "cla_is_used"
+	ErrDCOExists               ModelErrCode = "dco_exists"
+	ErrDCOIsUsed               ModelErrCode = "dco_is_used"
 	ErrTooManyRequest          ModelErrCode = "too_many_request"
 	ErrUserLoginFrozen         ModelErrCode = "user_login_frozen"
-	ErrCLAIsUsed               ModelErrCode = "cla_is_used"
 	ErrLinkIsUsed              ModelErrCode = "link_is_used"
+	ErrNoDCOLink               ModelErrCode = "no_dco_link"
+	ErrDCOLinkExists           ModelErrCode = "dco_link_exists"
+	ErrDCOLinkIsUsed           ModelErrCode = "dco_link_is_used"
 )
 
 type IModelError interface {