controller.go

// 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 controller

import (
	"fmt"

	"github.com/goharbor/harbor/src/common/job"
	"github.com/goharbor/harbor/src/common/utils/log"
	"github.com/goharbor/harbor/src/replication/model"
	"github.com/goharbor/harbor/src/replication/policy"
	"github.com/goharbor/harbor/src/replication/policy/manager"
	"github.com/goharbor/harbor/src/replication/policy/scheduler"
)

// NewController returns a policy controller which can CURD and schedule policies
func NewController(js job.Client) policy.Controller {
	mgr := manager.NewDefaultManager()
	scheduler := scheduler.NewScheduler(js)
	ctl := &controller{
		scheduler: scheduler,
	}
	ctl.Controller = mgr
	return ctl
}

type controller struct {
	policy.Controller
	scheduler scheduler.Scheduler
}

func (c *controller) Create(policy *model.Policy) (int64, error) {
	id, err := c.Controller.Create(policy)
	if err != nil {
		return 0, err
	}
	if isScheduledTrigger(policy) {
		// TODO: need a way to show the schedule status to users
		// maybe we can add a property "schedule status" for
		// listing policy API
		if err = c.scheduler.Schedule(id, policy.Trigger.Settings.Cron); err != nil {
			log.Errorf("failed to schedule the policy %d: %v", id, err)
		}
	}
	return id, nil
}

func (c *controller) Update(policy *model.Policy) error {
	origin, err := c.Controller.Get(policy.ID)
	if err != nil {
		return err
	}
	if origin == nil {
		return fmt.Errorf("policy %d not found", policy.ID)
	}
	// if no need to reschedule the policy, just update it
	if !isScheduleTriggerChanged(origin, policy) {
		return c.Controller.Update(policy)
	}
	// need to reschedule the policy
	// unschedule first if needed
	if isScheduledTrigger(origin) {
		if err = c.scheduler.Unschedule(origin.ID); err != nil {
			return fmt.Errorf("failed to unschedule the policy %d: %v", origin.ID, err)
		}
	}
	// update the policy
	if err = c.Controller.Update(policy); err != nil {
		return err
	}
	// schedule again if needed
	if isScheduledTrigger(policy) {
		if err = c.scheduler.Schedule(policy.ID, policy.Trigger.Settings.Cron); err != nil {
			return fmt.Errorf("failed to schedule the policy %d: %v", policy.ID, err)
		}
	}
	return nil
}

func (c *controller) Remove(policyID int64) error {
	policy, err := c.Controller.Get(policyID)
	if err != nil {
		return err
	}
	if policy == nil {
		return fmt.Errorf("policy %d not found", policyID)
	}
	if isScheduledTrigger(policy) {
		if err = c.scheduler.Unschedule(policyID); err != nil {
			return err
		}
	}
	return c.Controller.Remove(policyID)
}

func isScheduledTrigger(policy *model.Policy) bool {
	if policy == nil {
		return false
	}
	if !policy.Enabled {
		return false
	}
	if policy.Trigger == nil {
		return false
	}
	return policy.Trigger.Type == model.TriggerTypeScheduled
}

func isScheduleTriggerChanged(origin, current *model.Policy) bool {
	o := isScheduledTrigger(origin)
	c := isScheduledTrigger(current)
	// both triggers are not scheduled
	if !o && !c {
		return false
	}
	// both triggers are scheduled
	if o && c {
		return origin.Trigger.Settings.Cron != current.Trigger.Settings.Cron
	}
	// one is scheduled but the other one isn't
	return true
}