github.com/e154/smart-home@v0.17.2-0.20240311175135-e530a6e5cd45/plugins/slack/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 slack
    20  
    21  import (
    22  	"context"
    23  	"embed"
    24  
    25  	"github.com/e154/smart-home/common/logger"
    26  	m "github.com/e154/smart-home/models"
    27  	"github.com/e154/smart-home/plugins/notify"
    28  	"github.com/e154/smart-home/system/supervisor"
    29  )
    30  
    31  var (
    32  	log = logger.MustGetLogger("plugins.slack")
    33  )
    34  
    35  var _ supervisor.Pluggable = (*plugin)(nil)
    36  
    37  //go:embed Readme.md
    38  //go:embed Readme.ru.md
    39  var F embed.FS
    40  
    41  func init() {
    42  	supervisor.RegisterPlugin(Name, New)
    43  }
    44  
    45  type plugin struct {
    46  	*supervisor.Plugin
    47  }
    48  
    49  // New ...
    50  func New() supervisor.Pluggable {
    51  	p := &plugin{
    52  		Plugin: supervisor.NewPlugin(),
    53  	}
    54  	p.F = F
    55  	return p
    56  }
    57  
    58  // Load ...
    59  func (p *plugin) Load(ctx context.Context, service supervisor.Service) (err error) {
    60  	if err = p.Plugin.Load(ctx, service, p.ActorConstructor); err != nil {
    61  		return
    62  	}
    63  	return
    64  }
    65  
    66  // Unload ...
    67  func (p *plugin) Unload(ctx context.Context) (err error) {
    68  	if err = p.Plugin.Unload(ctx); err != nil {
    69  		return
    70  	}
    71  	return nil
    72  }
    73  
    74  // ActorConstructor ...
    75  func (p *plugin) ActorConstructor(entity *m.Entity) (actor supervisor.PluginActor, err error) {
    76  	actor = NewActor(entity, p.Service)
    77  	return
    78  }
    79  
    80  // Name ...
    81  func (p *plugin) Name() string {
    82  	return Name
    83  }
    84  
    85  // Type ...
    86  func (p *plugin) Type() supervisor.PluginType {
    87  	return supervisor.PluginInstallable
    88  }
    89  
    90  // Depends ...
    91  func (p *plugin) Depends() []string {
    92  	return []string{notify.Name}
    93  }
    94  
    95  // Version ...
    96  func (p *plugin) Version() string {
    97  	return Version
    98  }
    99  
   100  // Options ...
   101  func (p *plugin) Options() m.PluginOptions {
   102  	return m.PluginOptions{
   103  		ActorSetts: NewSettings(),
   104  	}
   105  }