Merge pull request #282 from itsneufox/save-roles

Track roles (re-adds them if user rejoins) and /wiki improvements

Author: NotUnlikeTheWaves

bot/commands/cmd_wiki.go

@@ -27,10 +27,20 @@ const (
 )
 
 func truncateText(s string, max int) string {
+	if s == "" {
+		return "Documentation available - click to view"
+	}
 	if max > len(s) {
 		return s
 	}
-	return s[:strings.LastIndex(s[:max], " ")] + " ..."
+	
+	// Find last space before max length
+	truncated := s[:max]
+	if lastSpace := strings.LastIndex(truncated, " "); lastSpace > max/2 {
+		return truncated[:lastSpace] + "..."
+	}
+	
+	return truncated + "..."
 }
 
 func (cm *CommandManager) commandWiki(
@@ -61,7 +71,7 @@ func (cm *CommandManager) commandWiki(
 				search.NewEmptySearchForHits().
 					SetIndexName(algoliaIndexName).
 					SetQuery(searchTerm).
-					SetHitsPerPage(3).
+					SetHitsPerPage(5).
 					SetFilters("language:en"),
 			)},
 		),
@@ -78,6 +88,7 @@ func (cm *CommandManager) commandWiki(
 			Type:        discordgo.EmbedTypeRich,
 			Title:       fmt.Sprintf("No results: %s", searchTerm),
 			Description: "There were no results for that query.",
+			Color:       0xED4245, // Red color for no results
 		})
 		return
 	}
@@ -102,61 +113,194 @@ func (cm *CommandManager) commandWiki(
 			continue
 		}
 
-		if seenUrls[hitData["url_without_anchor"].(string)] { //Already presented to user - Algolia does this thing of sending twice the same thing
+		// Get URL
+		urlWithoutAnchor, ok := hitData["url_without_anchor"].(string)
+		if !ok {
 			continue
 		}
 
-		seenUrls[hitData["url_without_anchor"].(string)] = true
+		// Skip if already processed this URL - Algolia does this thing of sending twice the same thing
+		if seenUrls[urlWithoutAnchor] {
+			continue
+		}
+		seenUrls[urlWithoutAnchor] = true
 
-		stringParts := strings.Split(strings.TrimSuffix(hitData["url_without_anchor"].(string), "/"), "/") //Algolia doesnt give the Function/Callback name - so I steal it from the URL
+		// Parse URL to get page info - Algolia doesn't give the Function/Callback name - so I steal it from the URL
+		stringParts := strings.Split(strings.TrimSuffix(urlWithoutAnchor, "/"), "/")
+		if len(stringParts) < 3 {
+			continue
+		}
 
-		if stringParts[len(stringParts)-2] == "blog" { //Remove blog posts from results
+		// Skip blog posts and other non-documentation pages - Remove blog posts from results
+		if len(stringParts) >= 4 && (stringParts[len(stringParts)-2] == "blog" || 
+			stringParts[len(stringParts)-3] == "blog") {
 			continue
 		}
 
 		actuallyFoundResults++
 
-		content, ok := hitData["content"].(string)
-		description := ""
-		if !ok {
-			description = "(No description found)"
-		} else {
-			description = formatDescription(&content)
-		}
+		// Get page/function name
+		pageName := stringParts[len(stringParts)-1]
+		
+		// Get description from multiple possible sources
+		description := extractDescription(hitData)
+		
+		// Build category path
+		category := buildCategory(stringParts)
 
+		// Format the result
 		desc.WriteString(fmt.Sprintf(
-			"[%s](%s) [%s/%s]: %s\n",
-			stringParts[len(stringParts)-1],
-			hitData["url_without_anchor"].(string),
-			stringParts[len(stringParts)-3],
-			stringParts[len(stringParts)-2],
-			truncateText(description, 200),
+			"[**%s**](%s)\n%s: %s\n\n",
+			pageName,
+			urlWithoutAnchor,
+			category,
+			truncateText(description, 120),
 		))
+
+		// Limit to 3 results for readability
+		if actuallyFoundResults >= 3 {
+			break
+		}
 	}
 
-	if actuallyFoundResults == 0 { //Hitting this means all results were filtered out
+	// Hitting this means all results were filtered out
+	if actuallyFoundResults == 0 {
 		cm.replyDirectlyEmbed(interaction, "", &discordgo.MessageEmbed{
 			Type:        discordgo.EmbedTypeRich,
 			Title:       fmt.Sprintf("No results: %s", searchTerm),
-			Description: "There were no results for that query.",
+			Description: "No documentation found for that query. Try a different search term.",
+			Color:       0xED4245,
 		})
 		return
 	}
 
 	embed := &discordgo.MessageEmbed{
 		Type:        discordgo.EmbedTypeRich,
-		Title:       fmt.Sprintf("Documentation Search Results: %s", searchTerm),
+		Title:       fmt.Sprintf("Documentation Search Results for %s", searchTerm),
 		Description: desc.String(),
+		Color:       0x5865F2, // Discord blurple
+		Footer: &discordgo.MessageEmbedFooter{
+			Text: "Click the links to view full documentation",
+		},
 	}
 	cm.replyDirectlyEmbed(interaction, "", embed)
 
-	return false, err // Todo: remove this
+	return false, err
+}
+
+func extractDescription(hitData map[string]interface{}) string {
+	// Try to get description from various fields in order of preference
+	descriptionSources := []string{
+		"description",  // Most likely to have the frontmatter description
+		"content",      // Page content
+		"excerpt",      // Page excerpt
+		"text",         // Text content
+		"summary",      // Summary
+	}
+	
+	for _, field := range descriptionSources {
+		if value, exists := hitData[field]; exists {
+			if strValue, ok := value.(string); ok && strings.TrimSpace(strValue) != "" {
+				cleaned := cleanDescription(strValue)
+				if cleaned != "" {
+					return cleaned
+				}
+			}
+		}
+	}
+	
+	// Try hierarchy for context
+	if hierarchy, exists := hitData["hierarchy"]; exists {
+		if hierarchyMap, ok := hierarchy.(map[string]interface{}); ok {
+			// Try different hierarchy levels
+			for _, level := range []string{"lvl0", "lvl1", "lvl2", "lvl3"} {
+				if lvlValue, exists := hierarchyMap[level]; exists {
+					if strValue, ok := lvlValue.(string); ok && strings.TrimSpace(strValue) != "" {
+						return cleanDescription(strValue)
+					}
+				}
+			}
+		}
+	}
+	
+	// Try anchor text
+	if anchor, exists := hitData["anchor"]; exists {
+		if strValue, ok := anchor.(string); ok && strings.TrimSpace(strValue) != "" {
+			return cleanDescription(strValue)
+		}
+	}
+	
+	return "Documentation available"
 }
 
-func formatDescription(hit *string) string {
-	return html.UnescapeString(strings.ReplaceAll(
-		strings.ReplaceAll(
-			*hit,
-			"<mark>", "**"),
-		"</mark>", "**"))
+func cleanDescription(text string) string {
+	if text == "" {
+		return ""
+	}
+	
+	// Remove HTML tags and decode entities
+	cleaned := html.UnescapeString(text)
+	
+	// Remove markdown-style highlighting
+	cleaned = strings.ReplaceAll(cleaned, "<mark>", "**")
+	cleaned = strings.ReplaceAll(cleaned, "</mark>", "**")
+	
+	// Clean up whitespace and newlines
+	cleaned = strings.ReplaceAll(cleaned, "\n", " ")
+	cleaned = strings.ReplaceAll(cleaned, "\r", " ")
+	
+	// Remove multiple spaces
+	for strings.Contains(cleaned, "  ") {
+		cleaned = strings.ReplaceAll(cleaned, "  ", " ")
+	}
+	
+	cleaned = strings.TrimSpace(cleaned)
+	
+	// Remove common prefixes that aren't useful
+	prefixesToRemove := []string{
+		"Description:",
+		"Description",
+		"## Description",
+		"###",
+		"##",
+		"#",
+	}
+	
+	for _, prefix := range prefixesToRemove {
+		if strings.HasPrefix(cleaned, prefix) {
+			cleaned = strings.TrimSpace(strings.TrimPrefix(cleaned, prefix))
+		}
+	}
+	
+	return cleaned
 }
+
+func buildCategory(urlParts []string) string {
+	if len(urlParts) < 4 {
+		return "Documentation"
+	}
+	
+	// Extract meaningful category parts
+	var categoryParts []string
+	
+	// Skip the domain parts and get the meaningful path
+	for i := 3; i < len(urlParts)-1; i++ {
+		part := urlParts[i]
+		
+		// Skip common path parts that aren't useful
+		if part == "docs" || part == "en" || part == "" {
+			continue
+		}
+		
+		// Capitalize and clean up the part
+		part = strings.ReplaceAll(part, "-", " ")
+		part = strings.Title(part)
+		categoryParts = append(categoryParts, part)
+	}
+	
+	if len(categoryParts) == 0 {
+		return "Documentation"
+	}
+	
+	return strings.Join(categoryParts, " › ")
+}

bot/discord.go

@@ -18,6 +18,22 @@ type ChannelDM struct {
 	LastMessageID string         `json:"last_message_id"`
 }
 
+// Define the roles that we want to track
+var trackedRoleIDs = map[string]string{
+	"1002922725553217648": 	"Clown",
+	"400250542628274177":  	"Caged",
+	"995816487610753094":  	"annoyed me",
+	"1016047260364198008": 	"Not Cool",
+	"833325019252785173":  	"Doesnt deserve to embed",
+	"818457955690872832":  	"Doesnt deserve to react",
+	"996883259252297758": 	"No open.mp support",
+	"910950457680212088": 	"No Server Adverts",
+	"841368374356738078": 	"Suffers from dunning-kruger",
+	"987825514511220867": 	"Muted",
+	"1204891485867352144": 	"Can't @everyone",
+	
+}
+
 const greeting = `Hi! Welcome to the San Andreas Multiplayer unofficial Discord server!
 
 Please read the rules and be respectful.`
@@ -35,6 +51,7 @@ func (app *App) ConnectDiscord() (err error) {
 	app.discordClient.S.AddHandler(app.onJoin)
 	app.discordClient.S.AddHandler(app.onReactionAdd)
 	app.discordClient.S.AddHandler(app.onReactionRemove)
+	app.discordClient.S.AddHandler(app.onGuildMemberUpdate)
 
 	intent := discordgo.MakeIntent(discordgo.IntentsAllWithoutPrivileged | discordgo.IntentsGuildMembers)
 
@@ -56,6 +73,58 @@ func (app *App) ConnectDiscord() (err error) {
 	return
 }
 
+// nolint:gocyclo
+func (app *App) onGuildMemberUpdate(s *discordgo.Session, event *discordgo.GuildMemberUpdate) {
+	member := event.Member
+	
+	// Get user's current tracked roles
+	user, err := app.storage.GetUserOrCreate(member.User.ID)
+	if err != nil {
+		zap.L().Error("failed to get user for role tracking", zap.Error(err))
+		return
+	}
+
+	// Check current Discord roles aginst our tracked role list
+	currentTrackedRoles := make(map[string]bool)
+	for _, roleID := range member.Roles {
+		if roleName, isTracked := trackedRoleIDs[roleID]; isTracked {
+			currentTrackedRoles[roleID] = true
+			
+			hasRole := false
+			for _, trackedRole := range user.TrackedRoles {
+				if trackedRole.RoleID == roleID {
+					hasRole = true
+					break
+				}
+			}
+			if !hasRole {
+				err := app.storage.AddTrackedRole(member.User.ID, roleID, roleName)
+				if err != nil {
+					zap.L().Error("failed to add tracked role", zap.Error(err))
+				} else {
+					zap.L().Info("started tracking role", 
+						zap.String("user", member.User.Username),
+						zap.String("role", roleName))
+				}
+			}
+		}
+	}
+
+	// Remove from database if no longer has the role
+	for _, trackedRole := range user.TrackedRoles {
+		if !currentTrackedRoles[trackedRole.RoleID] {
+			err := app.storage.RemoveTrackedRole(member.User.ID, trackedRole.RoleID)
+			if err != nil {
+				zap.L().Error("failed to remove tracked role", zap.Error(err))
+			} else {
+				zap.L().Info("stopped tracking role", 
+					zap.String("user", member.User.Username),
+					zap.String("role", trackedRole.RoleName))
+			}
+		}
+	}
+}
+
 // nolint:gocyclo
 func (app *App) onReady(s *discordgo.Session, event *discordgo.Ready) {
 	zap.L().Debug("connected to Discord gateway")
@@ -160,10 +229,42 @@ func (app *App) onJoin(s *discordgo.Session, event *discordgo.GuildMemberAdd) {
 	ch, err := s.UserChannelCreate(event.Member.User.ID)
 	if err != nil {
 		zap.L().Error("failed to create user channel", zap.Error(err))
-		return
+	} else {
+		_, err = app.discordClient.S.ChannelMessageSend(ch.ID, greeting)
+		if err != nil {
+			zap.L().Error("failed to send message", zap.Error(err))
+		}
 	}
-	_, err = app.discordClient.S.ChannelMessageSend(ch.ID, greeting)
+
+	err = app.reapplyTrackedRoles(event.Member.User.ID, event.GuildID)
 	if err != nil {
-		zap.L().Error("failed to send message", zap.Error(err))
+		zap.L().Error("failed to reapply tracked roles", zap.Error(err))
 	}
 }
+
+func (app *App) reapplyTrackedRoles(userID, guildID string) error {
+	trackedRoles, err := app.storage.GetTrackedRoles(userID)
+	if err != nil {
+		return err
+	}
+
+	if len(trackedRoles) == 0 {
+		return nil
+	}
+
+	for _, role := range trackedRoles {
+		err = app.discordClient.S.GuildMemberRoleAdd(guildID, userID, role.RoleID)
+		if err != nil {
+			zap.L().Error("failed to re-add tracked role", 
+				zap.Error(err),
+				zap.String("user", userID),
+				zap.String("role", role.RoleName))
+		} else {
+			zap.L().Info("reapplied tracked role", 
+				zap.String("user", userID),
+				zap.String("role", role.RoleName))
+		}
+	}
+
+	return nil
+}