// // Copyright (c) 2018 // Mainflux // // SPDX-License-Identifier: Apache-2.0 // package things import ( "context" "errors" "time" "github.com/mainflux/mainflux" ) var ( // ErrMalformedEntity indicates malformed entity specification (e.g. // invalid username or password). ErrMalformedEntity = errors.New("malformed entity specification") // ErrUnauthorizedAccess indicates missing or invalid credentials provided // when accessing a protected resource. ErrUnauthorizedAccess = errors.New("missing or invalid credentials provided") // ErrNotFound indicates a non-existent entity request. ErrNotFound = errors.New("non-existent entity") // ErrConflict indicates that entity already exists. ErrConflict = errors.New("entity already exists") ) // Service specifies an API that must be fullfiled by the domain service // implementation, and all of its decorators (e.g. logging & metrics). type Service interface { // AddThing adds new thing to the user identified by the provided key. AddThing(string, Thing) (Thing, error) // UpdateThing updates the thing identified by the provided ID, that // belongs to the user identified by the provided key. UpdateThing(string, Thing) error // UpdateKey updates key value of the existing thing. A non-nil error is // returned to indicate operation failure. UpdateKey(string, string, string) error // ViewThing retrieves data about the thing identified with the provided // ID, that belongs to the user identified by the provided key. ViewThing(string, string) (Thing, error) // ListThings retrieves data about subset of things that belongs to the // user identified by the provided key. ListThings(string, uint64, uint64, string) (ThingsPage, error) // ListThingsByChannel retrieves data about subset of things that are // connected to specified channel and belong to the user identified by // the provided key. ListThingsByChannel(string, string, uint64, uint64) (ThingsPage, error) // RemoveThing removes the thing identified with the provided ID, that // belongs to the user identified by the provided key. RemoveThing(string, string) error // CreateChannel adds new channel to the user identified by the provided key. CreateChannel(string, Channel) (Channel, error) // UpdateChannel updates the channel identified by the provided ID, that // belongs to the user identified by the provided key. UpdateChannel(string, Channel) error // ViewChannel retrieves data about the channel identified by the provided // ID, that belongs to the user identified by the provided key. ViewChannel(string, string) (Channel, error) // ListChannels retrieves data about subset of channels that belongs to the // user identified by the provided key. ListChannels(string, uint64, uint64) (ChannelsPage, error) // ListChannelsByThing retrieves data about subset of channels that have // specified thing connected to them and belong to the user identified by // the provided key. ListChannelsByThing(string, string, uint64, uint64) (ChannelsPage, error) // RemoveChannel removes the thing identified by the provided ID, that // belongs to the user identified by the provided key. RemoveChannel(string, string) error // Connect adds thing to the channel's list of connected things. Connect(string, string, string) error // Disconnect removes thing from the channel's list of connected // things. Disconnect(string, string, string) error // CanAccess determines whether the channel can be accessed using the // provided key and returns thing's id if access is allowed. CanAccess(string, string) (string, error) // Identify returns thing ID for given thing key. Identify(string) (string, error) } // PageMetadata contains page metadata that helps navigation. type PageMetadata struct { Total uint64 Offset uint64 Limit uint64 } var _ Service = (*thingsService)(nil) type thingsService struct { users mainflux.UsersServiceClient things ThingRepository channels ChannelRepository channelCache ChannelCache thingCache ThingCache idp IdentityProvider } // New instantiates the things service implementation. func New(users mainflux.UsersServiceClient, things ThingRepository, channels ChannelRepository, ccache ChannelCache, tcache ThingCache, idp IdentityProvider) Service { return &thingsService{ users: users, things: things, channels: channels, channelCache: ccache, thingCache: tcache, idp: idp, } } func (ts *thingsService) AddThing(token string, thing Thing) (Thing, error) { if err := thing.Validate(); err != nil { return Thing{}, ErrMalformedEntity } ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return Thing{}, ErrUnauthorizedAccess } thing.ID, err = ts.idp.ID() if err != nil { return Thing{}, err } thing.Owner = res.GetValue() if thing.Key == "" { thing.Key, err = ts.idp.ID() if err != nil { return Thing{}, err } } id, err := ts.things.Save(thing) if err != nil { return Thing{}, err } thing.ID = id return thing, nil } func (ts *thingsService) UpdateThing(token string, thing Thing) error { if err := thing.Validate(); err != nil { return ErrMalformedEntity } ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ErrUnauthorizedAccess } thing.Owner = res.GetValue() return ts.things.Update(thing) } func (ts *thingsService) UpdateKey(token, id, key string) error { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ErrUnauthorizedAccess } owner := res.GetValue() return ts.things.UpdateKey(owner, id, key) } func (ts *thingsService) ViewThing(token, id string) (Thing, error) { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return Thing{}, ErrUnauthorizedAccess } return ts.things.RetrieveByID(res.GetValue(), id) } func (ts *thingsService) ListThings(token string, offset, limit uint64, name string) (ThingsPage, error) { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ThingsPage{}, ErrUnauthorizedAccess } return ts.things.RetrieveAll(res.GetValue(), offset, limit, name) } func (ts *thingsService) ListThingsByChannel(token, channel string, offset, limit uint64) (ThingsPage, error) { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ThingsPage{}, ErrUnauthorizedAccess } return ts.things.RetrieveByChannel(res.GetValue(), channel, offset, limit) } func (ts *thingsService) RemoveThing(token, id string) error { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ErrUnauthorizedAccess } ts.thingCache.Remove(id) return ts.things.Remove(res.GetValue(), id) } func (ts *thingsService) CreateChannel(token string, channel Channel) (Channel, error) { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return Channel{}, ErrUnauthorizedAccess } channel.ID, err = ts.idp.ID() if err != nil { return Channel{}, err } channel.Owner = res.GetValue() id, err := ts.channels.Save(channel) if err != nil { return Channel{}, err } channel.ID = id return channel, nil } func (ts *thingsService) UpdateChannel(token string, channel Channel) error { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ErrUnauthorizedAccess } channel.Owner = res.GetValue() return ts.channels.Update(channel) } func (ts *thingsService) ViewChannel(token, id string) (Channel, error) { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return Channel{}, ErrUnauthorizedAccess } return ts.channels.RetrieveByID(res.GetValue(), id) } func (ts *thingsService) ListChannels(token string, offset, limit uint64) (ChannelsPage, error) { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ChannelsPage{}, ErrUnauthorizedAccess } return ts.channels.RetrieveAll(res.GetValue(), offset, limit) } func (ts *thingsService) ListChannelsByThing(token, thing string, offset, limit uint64) (ChannelsPage, error) { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ChannelsPage{}, ErrUnauthorizedAccess } return ts.channels.RetrieveByThing(res.GetValue(), thing, offset, limit) } func (ts *thingsService) RemoveChannel(token, id string) error { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ErrUnauthorizedAccess } ts.channelCache.Remove(id) return ts.channels.Remove(res.GetValue(), id) } func (ts *thingsService) Connect(token, chanID, thingID string) error { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ErrUnauthorizedAccess } return ts.channels.Connect(res.GetValue(), chanID, thingID) } func (ts *thingsService) Disconnect(token, chanID, thingID string) error { ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() res, err := ts.users.Identify(ctx, &mainflux.Token{Value: token}) if err != nil { return ErrUnauthorizedAccess } ts.channelCache.Disconnect(chanID, thingID) return ts.channels.Disconnect(res.GetValue(), chanID, thingID) } func (ts *thingsService) CanAccess(chanID, key string) (string, error) { thingID, err := ts.hasThing(chanID, key) if err == nil { return thingID, nil } thingID, err = ts.channels.HasThing(chanID, key) if err != nil { return "", ErrUnauthorizedAccess } ts.thingCache.Save(key, thingID) ts.channelCache.Connect(chanID, thingID) return thingID, nil } func (ts *thingsService) Identify(key string) (string, error) { id, err := ts.thingCache.ID(key) if err == nil { return id, nil } id, err = ts.things.RetrieveByKey(key) if err != nil { return "", ErrUnauthorizedAccess } ts.thingCache.Save(key, id) return id, nil } func (ts *thingsService) hasThing(chanID, key string) (string, error) { thingID, err := ts.thingCache.ID(key) if err != nil { return "", err } if connected := ts.channelCache.HasThing(chanID, thingID); !connected { return "", ErrUnauthorizedAccess } return thingID, nil }