feat: add configuration options for instagram and twitter plugins

This commit is contained in:
Felipe M 2025-06-15 12:17:54 +02:00
parent 3a4ba376e7
commit fc77c97547
Signed by: fmartingr
GPG key ID: CCFBC5637D4000A8
5 changed files with 57 additions and 18 deletions

View file

@ -10,6 +10,11 @@ When creating, modifying, or removing plugins:
- Brief description of functionality - Brief description of functionality
- Usage instructions with examples - Usage instructions with examples
- Any configuration requirements - Any configuration requirements
3. **For plugins with configuration options:**
- Set `ConfigRequired: true` in the plugin's BasePlugin struct
- Add corresponding HTML form fields in `internal/admin/templates/channel_plugin_config.html`
- Use conditional template logic: `{{else if eq .ChannelPlugin.PluginID "plugin.id"}}`
- Include proper form labels, help text, and value binding
## Testing ## Testing

View file

@ -23,5 +23,5 @@
### Social Media ### Social Media
- Twitter Link Expander: Automatically converts twitter.com and x.com links to fxtwitter.com links and removes tracking parameters. This allows for better media embedding in chat platforms. - Twitter Link Expander: Automatically converts twitter.com and x.com links to alternative domain links and removes tracking parameters. This allows for better media embedding in chat platforms. Configure with `domain` option to set replacement domain (default: fxtwitter.com).
- Instagram Link Expander: Automatically converts instagram.com links to ddinstagram.com links and removes tracking parameters. This allows for better media embedding in chat platforms. - Instagram Link Expander: Automatically converts instagram.com links to alternative domain links and removes tracking parameters. This allows for better media embedding in chat platforms. Configure with `domain` option to set replacement domain (default: ddinstagram.com).

View file

@ -19,6 +19,26 @@
Messages containing links to these domains will be blocked. Messages containing links to these domains will be blocked.
</div> </div>
</div> </div>
{{else if eq .ChannelPlugin.PluginID "social.instagram"}}
<div class="mb-3">
<label class="form-label">Replacement Domain</label>
<input type="text" class="form-control" name="domain"
value="{{with .ChannelPlugin.Config}}{{index . "domain"}}{{end}}"
placeholder="ddinstagram.com">
<div class="form-text text-muted">
Enter the domain to replace instagram.com links with. Default is ddinstagram.com if left empty.
</div>
</div>
{{else if eq .ChannelPlugin.PluginID "social.twitter"}}
<div class="mb-3">
<label class="form-label">Replacement Domain</label>
<input type="text" class="form-control" name="domain"
value="{{with .ChannelPlugin.Config}}{{index . "domain"}}{{end}}"
placeholder="fxtwitter.com">
<div class="form-text text-muted">
Enter the domain to replace twitter.com and x.com links with. Default is fxtwitter.com if left empty.
</div>
</div>
{{else}} {{else}}
<div class="alert alert-warning"> <div class="alert alert-warning">
This plugin doesn't have specific configuration fields implemented yet. This plugin doesn't have specific configuration fields implemented yet.

View file

@ -20,7 +20,8 @@ func NewInstagramExpander() *InstagramExpander {
BasePlugin: plugin.BasePlugin{ BasePlugin: plugin.BasePlugin{
ID: "social.instagram", ID: "social.instagram",
Name: "Instagram Link Expander", Name: "Instagram Link Expander",
Help: "Automatically converts instagram.com links to ddinstagram.com links and removes tracking parameters", Help: "Automatically converts instagram.com links to alternative domain links and removes tracking parameters. Configure 'domain' option to set replacement domain (default: ddinstagram.com)",
ConfigRequired: true,
}, },
} }
} }
@ -32,6 +33,12 @@ func (p *InstagramExpander) OnMessage(msg *model.Message, config map[string]inte
return nil return nil
} }
// Get replacement domain from config, default to ddinstagram.com
replacementDomain := "ddinstagram.com"
if domain, ok := config["domain"].(string); ok && domain != "" {
replacementDomain = domain
}
// Regex to match instagram.com links // Regex to match instagram.com links
// Match both http://instagram.com and https://instagram.com formats // Match both http://instagram.com and https://instagram.com formats
// Also match www.instagram.com // Also match www.instagram.com
@ -42,7 +49,7 @@ func (p *InstagramExpander) OnMessage(msg *model.Message, config map[string]inte
return nil return nil
} }
// Replace instagram.com with ddinstagram.com in the message and clean query parameters // Replace instagram.com with configured domain in the message and clean query parameters
transformed := instagramRegex.ReplaceAllStringFunc(msg.Text, func(link string) string { transformed := instagramRegex.ReplaceAllStringFunc(msg.Text, func(link string) string {
// Parse the URL // Parse the URL
parsedURL, err := url.Parse(link) parsedURL, err := url.Parse(link)
@ -51,13 +58,13 @@ func (p *InstagramExpander) OnMessage(msg *model.Message, config map[string]inte
return link return link
} }
// Ensure we don't change links that already come from ddinstagram.com // Ensure we don't change links that already come from the replacement domain
if parsedURL.Host != "instagram.com" && parsedURL.Host != "www.instagram.com" { if parsedURL.Host != "instagram.com" && parsedURL.Host != "www.instagram.com" {
return link return link
} }
// Change the host // Change the host to the configured domain
parsedURL.Host = "d.ddinstagram.com" parsedURL.Host = replacementDomain
// Remove query parameters // Remove query parameters
parsedURL.RawQuery = "" parsedURL.RawQuery = ""

View file

@ -20,7 +20,8 @@ func NewTwitterExpander() *TwitterExpander {
BasePlugin: plugin.BasePlugin{ BasePlugin: plugin.BasePlugin{
ID: "social.twitter", ID: "social.twitter",
Name: "Twitter Link Expander", Name: "Twitter Link Expander",
Help: "Automatically converts twitter.com links to fxtwitter.com links and removes tracking parameters", Help: "Automatically converts twitter.com and x.com links to alternative domain links and removes tracking parameters. Configure 'domain' option to set replacement domain (default: fxtwitter.com)",
ConfigRequired: true,
}, },
} }
} }
@ -32,6 +33,12 @@ func (p *TwitterExpander) OnMessage(msg *model.Message, config map[string]interf
return nil return nil
} }
// Get replacement domain from config, default to fxtwitter.com
replacementDomain := "fxtwitter.com"
if domain, ok := config["domain"].(string); ok && domain != "" {
replacementDomain = domain
}
// Regex to match twitter.com links // Regex to match twitter.com links
// Match both http://twitter.com and https://twitter.com formats // Match both http://twitter.com and https://twitter.com formats
// Also match www.twitter.com // Also match www.twitter.com
@ -42,22 +49,22 @@ func (p *TwitterExpander) OnMessage(msg *model.Message, config map[string]interf
return nil return nil
} }
// Replace twitter.com with fxtwitter.com in the message and clean query parameters // Replace twitter.com/x.com with configured domain in the message and clean query parameters
transformed := twitterRegex.ReplaceAllStringFunc(msg.Text, func(link string) string { transformed := twitterRegex.ReplaceAllStringFunc(msg.Text, func(link string) string {
// Parse the URL // Parse the URL
parsedURL, err := url.Parse(link) parsedURL, err := url.Parse(link)
if err != nil { if err != nil {
// If parsing fails, just do the simple replacement // If parsing fails, just do the simple replacement
link = strings.Replace(link, "twitter.com", "fxtwitter.com", 1) link = strings.Replace(link, "twitter.com", replacementDomain, 1)
link = strings.Replace(link, "x.com", "fxtwitter.com", 1) link = strings.Replace(link, "x.com", replacementDomain, 1)
return link return link
} }
// Change the host // Change the host to the configured domain
if strings.Contains(parsedURL.Host, "twitter.com") { if strings.Contains(parsedURL.Host, "twitter.com") {
parsedURL.Host = strings.Replace(parsedURL.Host, "twitter.com", "fxtwitter.com", 1) parsedURL.Host = strings.Replace(parsedURL.Host, "twitter.com", replacementDomain, 1)
} else if strings.Contains(parsedURL.Host, "x.com") { } else if strings.Contains(parsedURL.Host, "x.com") {
parsedURL.Host = strings.Replace(parsedURL.Host, "x.com", "fxtwitter.com", 1) parsedURL.Host = strings.Replace(parsedURL.Host, "x.com", replacementDomain, 1)
} }
// Remove query parameters // Remove query parameters