feat: implement a convenient IsEnabled method to figure out if a plugin must be enabled or not

Author: mirkobrombin

internal/plugin/plugin_base.go

@@ -29,3 +29,18 @@ func (bp *BasePlugin) SetupLoggers(conf config.SiteConfig, pluginName string, do
 
 	return nil
 }
+
+// IsEnabled returns true if the plugin is enabled for the given site.
+func (bp *BasePlugin) IsEnabled(conf interface{}) bool {
+	if conf == nil {
+		return false
+	}
+
+	// We assume that the plugin config has an "Enable" field.
+	enabled, ok := conf.(map[string]interface{})["enable"].(bool)
+	if !ok {
+		return false
+	}
+
+	return enabled
+}

plugins/auth.go

@@ -80,11 +80,9 @@ func (p *AuthPlugin) OnInitForSite(conf config.SiteConfig, domainLogger *logger.
 	}
 
 	if rawMap, ok := pluginConfigRaw.(map[string]interface{}); ok {
-		// ProtectedPaths
-		if en, ok := rawMap["enable"].(bool); ok {
-			authConfig.Enable = en
-		}
+		authConfig.Enable = p.IsEnabled(rawMap)
 
+		// ProtectedPaths
 		if paths, ok := rawMap["protected_paths"].([]interface{}); ok {
 			for _, path := range paths {
 				if pStr, ok := path.(string); ok {

plugins/custom_header.go

@@ -29,6 +29,12 @@ func (p *CustomHeaderPlugin) OnInitForSite(conf config.SiteConfig, domainLogger
 	if err := p.SetupLoggers(conf, p.Name(), domainLogger); err != nil {
 		return err
 	}
+
+	pluginConfigRaw, ok := conf.PluginConfigs[p.Name()]
+	if !ok || !p.IsEnabled(pluginConfigRaw) {
+		return nil
+	}
+
 	p.siteConfigs[conf.Domain] = conf
 	return nil
 }

plugins/docker_base.go

@@ -53,9 +53,7 @@ func (d *DockerBasePlugin) OnInitForSite(conf config.SiteConfig, domainLogger *l
 	raw, ok := conf.PluginConfigs[d.Name()]
 	if ok {
 		if rawMap, ok := raw.(map[string]interface{}); ok {
-			if v, ok := rawMap["enable"].(bool); ok {
-				cfg.Enable = v
-			}
+			cfg.Enable = d.IsEnabled(rawMap)
 			if v, ok := rawMap["mode"].(string); ok {
 				cfg.Mode = v
 			}

plugins/docker_standard.go

@@ -59,9 +59,7 @@ func (d *DockerStandardPlugin) OnInitForSite(conf config.SiteConfig, domainLogge
 	raw, ok := conf.PluginConfigs[d.Name()]
 	if ok {
 		if rawMap, ok := raw.(map[string]interface{}); ok {
-			if v, ok := rawMap["enable"].(bool); ok {
-				cfg.Enable = v
-			}
+			cfg.Enable = d.IsEnabled(rawMap)
 			if v, ok := rawMap["dockerfile_path"].(string); ok {
 				cfg.DockerfilePath = v
 			}

plugins/nodejs.go

@@ -31,9 +31,8 @@ type NodeJSPluginConfig struct {
 type NodeJSPlugin struct {
 	plugin.BasePlugin
 
-	mu      sync.Mutex
-	process *os.Process
-
+	mu          sync.Mutex
+	process     *os.Process
 	siteConfigs map[string]NodeJSPluginConfig
 }
 
@@ -58,9 +57,8 @@ func (p *NodeJSPlugin) OnInitForSite(conf config.SiteConfig, domainLogger *logge
 	}
 	cfg := NodeJSPluginConfig{}
 	if rawMap, ok := pluginConfigRaw.(map[string]interface{}); ok {
-		if enable, ok := rawMap["enable"].(bool); ok {
-			cfg.Enable = enable
-		}
+		// Use BasePlugin's IsEnabled method to determine if the plugin is enabled.
+		cfg.Enable = p.IsEnabled(rawMap)
 		if port, ok := rawMap["port"].(string); ok {
 			cfg.Port = port
 		}

plugins/php.go

@@ -47,9 +47,8 @@ func (p *PHPPlugin) OnInitForSite(conf config.SiteConfig, domainLogger *logger.L
 
 	cfg := PHPPluginConfig{}
 	if rawMap, ok := pluginConfigRaw.(map[string]interface{}); ok {
-		if enable, ok := rawMap["enable"].(bool); ok {
-			cfg.Enable = enable
-		}
+		// Use BasePlugin's IsEnabled method to determine if the plugin is enabled.
+		cfg.Enable = p.IsEnabled(rawMap)
 		if fpmAddr, ok := rawMap["fpm_addr"].(string); ok {
 			cfg.FPMAddr = fpmAddr
 		}

plugins/python.go

@@ -63,9 +63,8 @@ func (p *PythonPlugin) OnInitForSite(conf config.SiteConfig, baseLogger *logger.
 
 	cfg := PythonPluginConfig{}
 	if rawMap, ok := raw.(map[string]interface{}); ok {
-		if v, ok := rawMap["enable"].(bool); ok {
-			cfg.Enable = v
-		}
+		// Use BasePlugin's IsEnabled method to determine if the plugin is enabled.
+		cfg.Enable = p.IsEnabled(rawMap)
 		if v, ok := rawMap["port"].(string); ok {
 			cfg.Port = v
 		}