github.com/e154/smart-home@v0.17.2-0.20240311175135-e530a6e5cd45/plugins/telegram/plugin.go (about)

     1  // This file is part of the Smart Home
     2  // Program complex distribution https://github.com/e154/smart-home
     3  // Copyright (C) 2016-2023, Filippov Alex
     4  //
     5  // This library is free software: you can redistribute it and/or
     6  // modify it under the terms of the GNU Lesser General Public
     7  // License as published by the Free Software Foundation; either
     8  // version 3 of the License, or (at your option) any later version.
     9  //
    10  // This library is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13  // Library General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Lesser General Public
    16  // License along with this library.  If not, see
    17  // <https://www.gnu.org/licenses/>.
    18  
    19  package telegram
    20  
    21  import (
    22  	"context"
    23  	"embed"
    24  
    25  	"github.com/e154/smart-home/common/events"
    26  	"github.com/e154/smart-home/common/logger"
    27  	m "github.com/e154/smart-home/models"
    28  	"github.com/e154/smart-home/plugins/notify"
    29  	"github.com/e154/smart-home/system/supervisor"
    30  )
    31  
    32  var (
    33  	log = logger.MustGetLogger("plugins.telegram")
    34  )
    35  
    36  var _ supervisor.Pluggable = (*plugin)(nil)
    37  
    38  //go:embed Readme.md
    39  //go:embed Readme.ru.md
    40  var F embed.FS
    41  
    42  func init() {
    43  	supervisor.RegisterPlugin(Name, New)
    44  }
    45  
    46  type plugin struct {
    47  	*supervisor.Plugin
    48  }
    49  
    50  // New ...
    51  func New() supervisor.Pluggable {
    52  	p := &plugin{
    53  		Plugin: supervisor.NewPlugin(),
    54  	}
    55  	p.F = F
    56  	return p
    57  }
    58  
    59  // Load ...
    60  func (p *plugin) Load(ctx context.Context, service supervisor.Service) (err error) {
    61  	if err = p.Plugin.Load(ctx, service, p.ActorConstructor); err != nil {
    62  		return
    63  	}
    64  
    65  	_ = p.Service.EventBus().Subscribe("system/entities/+", p.eventHandler)
    66  
    67  	return
    68  }
    69  
    70  // Unload ...
    71  func (p *plugin) Unload(ctx context.Context) (err error) {
    72  	if err = p.Plugin.Unload(ctx); err != nil {
    73  		return
    74  	}
    75  
    76  	_ = p.Service.EventBus().Unsubscribe("system/entities/+", p.eventHandler)
    77  
    78  	return nil
    79  }
    80  
    81  // ActorConstructor ...
    82  func (p *plugin) ActorConstructor(entity *m.Entity) (actor supervisor.PluginActor, err error) {
    83  	actor, err = NewActor(entity, p.Service)
    84  	return
    85  }
    86  
    87  // Name ...
    88  func (p *plugin) Name() string {
    89  	return Name
    90  }
    91  
    92  // Type ...
    93  func (p *plugin) Type() supervisor.PluginType {
    94  	return supervisor.PluginInstallable
    95  }
    96  
    97  // Depends ...
    98  func (p *plugin) Depends() []string {
    99  	return []string{notify.Name}
   100  }
   101  
   102  // Version ...
   103  func (p *plugin) Version() string {
   104  	return Version
   105  }
   106  
   107  // Options ...
   108  func (p *plugin) Options() m.PluginOptions {
   109  	return m.PluginOptions{
   110  		Actors:             true,
   111  		ActorCustomActions: true,
   112  		ActorCustomStates:  true,
   113  		ActorCustomAttrs:   true,
   114  		ActorAttrs:         NewAttr(),
   115  		ActorSetts:         NewSettings(),
   116  		ActorStates:        supervisor.ToEntityStateShort(NewStates()),
   117  	}
   118  }
   119  
   120  func (p *plugin) eventHandler(topic string, msg interface{}) {
   121  
   122  	switch v := msg.(type) {
   123  	case events.EventStateChanged:
   124  	case events.EventCallEntityAction:
   125  		values, ok := p.Check(v)
   126  		if !ok {
   127  			return
   128  		}
   129  		for _, value := range values {
   130  			actor := value.(*Actor)
   131  			actor.addAction(v)
   132  		}
   133  	}
   134  }