contact_info_store.go

// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// 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 store

import (
	"context"
	"runtime/trace"
	"time"

	"github.com/jinzhu/gorm"
	"go.thethings.network/lorawan-stack/v3/pkg/errors"
	"go.thethings.network/lorawan-stack/v3/pkg/ttnpb"
)

// GetContactInfoStore returns an ContactInfoStore on the given db (or transaction).
func GetContactInfoStore(db *gorm.DB) ContactInfoStore {
	return &contactInfoStore{store: newStore(db)}
}

type contactInfoStore struct {
	*store
}

func (s *contactInfoStore) GetContactInfo(ctx context.Context, entityID ttnpb.IDStringer) ([]*ttnpb.ContactInfo, error) {
	defer trace.StartRegion(ctx, "get contact info").End()
	entity, err := s.findEntity(ctx, entityID, "id")
	if err != nil {
		return nil, err
	}
	var models []ContactInfo
	err = s.query(ctx, ContactInfo{}).Where(ContactInfo{
		EntityType: entityTypeForID(entityID),
		EntityID:   entity.PrimaryKey(),
	}).Find(&models).Error
	if err != nil {
		return nil, err
	}
	pb := make([]*ttnpb.ContactInfo, len(models))
	for i, model := range models {
		pb[i] = model.toPB()
	}
	return pb, nil
}

func (s *contactInfoStore) SetContactInfo(ctx context.Context, entityID ttnpb.IDStringer, pb []*ttnpb.ContactInfo) ([]*ttnpb.ContactInfo, error) {
	defer trace.StartRegion(ctx, "update contact info").End()
	entity, err := s.findEntity(ctx, entityID, "id")
	if err != nil {
		return nil, err
	}
	entityType, entityUUID := entityTypeForID(entityID), entity.PrimaryKey()

	var existing []ContactInfo
	err = s.query(ctx, ContactInfo{}).Where(ContactInfo{
		EntityType: entityType,
		EntityID:   entityUUID,
	}).Find(&existing).Error
	if err != nil {
		return nil, err
	}

	type contactInfoID struct {
		contactType   int
		contactMethod int
		value         string
	}
	type contactInfo struct {
		ContactInfo
		deleted bool
	}

	existingByUUID := make(map[string]ContactInfo, len(existing))
	existingByInfo := make(map[contactInfoID]*contactInfo, len(existing))

	for _, existing := range existing {
		existingByUUID[existing.ID] = existing
		existingByInfo[contactInfoID{existing.ContactType, existing.ContactMethod, existing.Value}] = &contactInfo{
			ContactInfo: existing,
			deleted:     true,
		}
	}

	var toCreate []*ContactInfo
	for _, pb := range pb {
		if existing, ok := existingByInfo[contactInfoID{int(pb.ContactType), int(pb.ContactMethod), pb.Value}]; ok {
			existing.deleted = false
			existing.fromPB(pb)
		} else {
			model := ContactInfo{}
			model.fromPB(pb)
			toCreate = append(toCreate, &model)
		}
	}

	var toUpdate []*ContactInfo
	var toDelete []string
	for _, existing := range existingByInfo {
		if existing.deleted {
			toDelete = append(toDelete, existing.ContactInfo.ID)
		} else {
			toUpdate = append(toUpdate, &existing.ContactInfo)
		}
	}

	for _, info := range toCreate {
		info.EntityType, info.EntityID = entityType, entityUUID
		if err = s.createEntity(ctx, info); err != nil {
			return nil, err
		}
	}

	for _, info := range toUpdate {
		if err = s.query(ctx, ContactInfo{}).Save(&info).Error; err != nil {
			return nil, err
		}
	}

	if len(toDelete) > 0 {
		if err = s.query(ctx, ContactInfo{}).Where("id in (?)", toDelete).Delete(&ContactInfo{}).Error; err != nil {
			return nil, err
		}
	}

	pb = make([]*ttnpb.ContactInfo, 0, len(toUpdate)+len(toCreate))
	for _, model := range toUpdate {
		pb = append(pb, model.toPB())
	}
	for _, model := range toCreate {
		pb = append(pb, model.toPB())
	}

	return pb, nil
}

var errValidationAlreadyExists = errors.DefineAlreadyExists("validation_already_exists", "contact info validation already exists")

func (s *contactInfoStore) CreateValidation(ctx context.Context, validation *ttnpb.ContactInfoValidation) (*ttnpb.ContactInfoValidation, error) {
	defer trace.StartRegion(ctx, "create contact info validation").End()
	var (
		contactMethod ttnpb.ContactMethod
		value         string
	)
	for i, info := range validation.ContactInfo {
		if i == 0 {
			contactMethod = info.ContactMethod
			value = info.Value
			continue
		}
		if info.ContactMethod != contactMethod || info.Value != value {
			panic("inconsistent contact info in validation")
		}
	}
	entity, err := s.findEntity(ctx, validation.Entity, "id")
	if err != nil {
		return nil, err
	}

	var model ContactInfoValidation
	model.fromPB(validation)
	model.EntityType, model.EntityID = entityTypeForID(validation.Entity), entity.PrimaryKey()
	model.ContactMethod = int(contactMethod)
	model.Value = value

	var existing ContactInfoValidation
	err = s.query(ctx, ContactInfoValidation{}).Where(ContactInfoValidation{
		EntityID:      model.EntityID,
		EntityType:    model.EntityType,
		ContactMethod: model.ContactMethod,
		Value:         model.Value,
	}).Where("expires_at > ?", cleanTime(time.Now())).First(&existing).Error
	switch {
	case err == nil:
		return nil, errValidationAlreadyExists.New()
	case gorm.IsRecordNotFoundError(err):
	default:
		return nil, err
	}

	if err = s.createEntity(ctx, &model); err != nil {
		return nil, err
	}

	pb := model.toPB()
	pb.Entity, pb.ContactInfo = validation.Entity, validation.ContactInfo

	return pb, nil
}

var (
	errValidationTokenNotFound = errors.DefineNotFound("validation_token", "validation token not found")
	errValidationTokenUsed     = errors.DefineAlreadyExists("validation_token_used", "validation token already used")
	errValidationTokenExpired  = errors.DefineNotFound("validation_token_expired", "validation token expired")
)

func (s *contactInfoStore) Validate(ctx context.Context, validation *ttnpb.ContactInfoValidation) error {
	defer trace.StartRegion(ctx, "validate contact info").End()
	now := cleanTime(time.Now())

	var model ContactInfoValidation
	err := s.query(ctx, ContactInfoValidation{}).Where(ContactInfoValidation{
		Reference: validation.Id,
		Token:     validation.Token,
	}).Find(&model).Error
	if err != nil {
		if gorm.IsRecordNotFoundError(err) {
			return errValidationTokenNotFound.New()
		}
		return err
	}

	if model.Used {
		return errValidationTokenUsed.New()
	}

	if model.ExpiresAt != nil && model.ExpiresAt.Before(time.Now()) {
		return errValidationTokenExpired.New()
	}

	err = s.query(ctx, ContactInfo{}).Where(ContactInfo{
		EntityID:      model.EntityID,
		EntityType:    model.EntityType,
		ContactMethod: model.ContactMethod,
		Value:         model.Value,
	}).Update(ContactInfo{
		ValidatedAt: &now,
	}).Error
	if err != nil {
		return err
	}

	if model.EntityType == "user" && model.ContactMethod == int(ttnpb.CONTACT_METHOD_EMAIL) {
		err = s.query(ctx, User{
			Model: Model{ID: model.EntityID},
		}).Where(User{
			PrimaryEmailAddress: model.Value,
		}).Update(User{
			PrimaryEmailAddressValidatedAt: &now,
		}).Error
		if err != nil {
			return err
		}
	}

	err = s.query(ctx, ContactInfoValidation{}).Where(ContactInfoValidation{
		Reference: validation.Id,
		Token:     validation.Token,
	}).Update(ContactInfoValidation{
		ExpiresAt: &now,
		Used:      true,
	}).Error
	if err != nil {
		return err
	}

	return nil
}

func (s *contactInfoStore) DeleteEntityContactInfo(ctx context.Context, entityID ttnpb.IDStringer) error {
	defer trace.StartRegion(ctx, "delete entity contact info").End()
	entity, err := s.findDeletedEntity(ctx, entityID, "id")
	if err != nil {
		return err
	}
	err = s.query(ctx, ContactInfoValidation{}).Where(ContactInfoValidation{
		EntityID:   entity.PrimaryKey(),
		EntityType: entityTypeForID(entityID),
	}).Delete(&ContactInfoValidation{}).Error
	if err != nil {
		return err
	}
	return s.query(ctx, ContactInfo{}).Where(&ContactInfo{
		EntityID:   entity.PrimaryKey(),
		EntityType: entityTypeForID(entityID),
	}).Delete(&ContactInfo{}).Error
}