LocalAI/core/services/studio/toolsadmin.go

package studio

import (
	"context"
	"github.com/mudler/LocalAI/core/services/studio/session"
	"slices"
	"time"

	"github.com/mudler/LocalAI/core/services/studio/hostexec"
	"github.com/mudler/LocalAI/pkg/addons/contract"
)

// BuiltinToolInfo is one built-in chat tool as Settings > Tools shows it.
type BuiltinToolInfo struct {
	ID, Label, Description string
	// Group is the per-chat switch group, or "".
	Group string
	// Setting is the runtime setting that switches it off; Options are the
	// other runtime settings that configure it.
	Setting string
	Options []string
	Enabled bool
	// ReadOnly says the tool only reads; Replaceable that an add-on tool may
	// shadow it.
	ReadOnly, Replaceable bool
	// Provider serves the tool now: an add-on's ID, BuiltinProvider, or ""
	// when nothing does (it is off and no add-on replaces it).
	Provider string
	// Candidates are the add-ons that replace the tool, oldest install first
	// (ties and add-ons with no time by ID); Default is the first, the one
	// that serves with no pin; Pinned is the one an administrator chose, if
	// any. InstalledAt maps a candidate to its install time (RFC 3339), when
	// known.
	Candidates  []string
	Default     string
	Pinned      string
	InstalledAt map[string]string
	// Titles maps a candidate to its title. Stopped lists the candidates
	// that are installed but cannot serve now (stopped or disabled).
	Titles  map[string]string
	Stopped []string
	// Note is "not running" when an installed add-on replaces the tool but
	// none serves, so the built-in serves (or nothing, when it is off).
	Note string
	// Mode is chats_host_exec as it applies now, for bash only.
	Mode string
	// Unavailable says why this server cannot run the built-in, or "".
	Unavailable string
}

// AdminBuiltinTools lists the built-in chat tools for the administrator user:
// whether each is on, who serves it, and the add-ons that replace it.
func (s *Service) AdminBuiltinTools(ctx context.Context, user string) ([]BuiltinToolInfo, error) {
	candidates := map[string][]string{}
	installed := map[string]string{}
	if s.d.AddonTools != nil {
		defs, err := s.d.AddonTools.Tools(ctx, principal(user))
		if err != nil {
			return nil, err
		}
		seen := map[string]bool{}
		for _, d := range defs {
			if d.Shadows == "" || seen[d.Shadows+"\x00"+d.AddonID] {
				continue
			}
			seen[d.Shadows+"\x00"+d.AddonID] = true
			candidates[d.Shadows] = append(candidates[d.Shadows], d.AddonID)
			if d.InstalledAt != "" {
				installed[d.AddonID] = d.InstalledAt
			}
		}
	}
	pins, err := s.toolPins(ctx)
	if err != nil {
		return nil, err
	}
	// The running candidates come from the tools; the lister adds the
	// installed add-ons that are stopped, so an administrator can choose one
	// before it runs and sees why the built-in serves.
	sh := shadowers{}
	if s.d.AddonTools != nil {
		sh = s.shadowersFor(ctx, principal(user))
	}
	for id, when := range sh.when {
		if installed[id] == "" {
			installed[id] = when
		}
	}
	var out []BuiltinToolInfo
	for _, t := range s.builtins.Tools() {
		if t.Unlisted {
			continue
		}
		running := candidates[t.ID]
		all := slices.Clone(running)
		for _, id := range sh.byName[t.ID] {
			if !slices.Contains(all, id) {
				all = append(all, id)
			}
		}
		c := OrderProviders(all, installed)
		info := BuiltinToolInfo{ID: t.ID, Label: t.Label, Description: t.Description, Group: t.Group, Setting: t.Setting,
			Options: t.Options, Enabled: t.On(), ReadOnly: t.ReadOnly, Replaceable: t.Replaceable, Candidates: c, Pinned: pins[t.ID], InstalledAt: installTimesOf(c, installed)}
		for _, id := range c {
			if !slices.Contains(running, id) {
				info.Stopped = append(info.Stopped, id)
			}
			if title := sh.title[id]; title != "" {
				if info.Titles == nil {
					info.Titles = map[string]string{}
				}
				info.Titles[id] = title
			}
		}
		// Default is the one that serves with no pin: the oldest running
		// install, or the oldest install when none runs.
		if r := OrderProviders(running, installed); len(r) > 0 && t.Replaceable {
			info.Default = r[0]
		} else if len(c) > 0 && t.Replaceable {
			info.Default = c[0]
		}
		switch {
		case len(running) > 0 && t.Replaceable && !sh.pinnedButIdle(t.ID, info.Pinned, running):
			info.Provider = ChooseProvider(running, installed, info.Pinned)
		case info.Enabled:
			info.Provider = BuiltinProvider
		}
		if len(c) > 0 && t.Replaceable && (info.Provider == BuiltinProvider || info.Provider == "") {
			info.Note = "not running"
		}
		if t.ID == "bash" && s.d.HostExec != nil {
			info.Mode = s.hostExecMode()
			info.Unavailable = s.d.HostExec.Unavailable()
		}
		out = append(out, info)
	}
	return out, nil
}

// HostExecAudit reads the audit of the commands run on this machine.
// *hostexec.Runner implements it.
type HostExecAudit interface {
	Events(ctx context.Context, limit int) ([]hostexec.Event, error)
}

// hostExecPruner removes old lines of the audit of the commands.
// *hostexec.Runner implements it.
type hostExecPruner interface {
	Prune(ctx context.Context, before time.Time) (int64, error)
}

// PruneHostExecAudit removes the lines of the audit of the commands run on
// this machine older than the retention of the network audit
// (chats_egress_audit_days): both record what the commands of the chats did.
// It runs with PruneEgressAudit, on one frontend of a cluster.
func (s *Service) PruneHostExecAudit(ctx context.Context) (int64, error) {
	a, ok := s.d.HostExec.(hostExecPruner)
	if !ok {
		return 0, nil
	}
	return a.Prune(ctx, s.now().Add(-s.auditRetention()))
}

// HostExecEvents returns the newest lines of the audit of the commands, newest
// first.
func (s *Service) HostExecEvents(ctx context.Context, limit int) ([]hostexec.Event, error) {
	a, ok := s.d.HostExec.(HostExecAudit)
	if !ok {
		return []hostexec.Event{}, nil
	}
	return a.Events(ctx, limit)
}

// BuiltinSkillInfo is one built-in skill that installed add-ons replace, as
// Settings > Tools shows it next to the tools.
type BuiltinSkillInfo struct {
	ID string
	// Provider serves the skill now: an add-on's ID or BuiltinProvider.
	Provider string
	// Candidates are the add-ons that replace it, by ID, with their Titles;
	// Pinned is the one an administrator chose, if any.
	Candidates []string
	// Default is the candidate that serves with no pin: the oldest install.
	Default     string
	Titles      map[string]string
	Pinned      string
	InstalledAt map[string]string
	// Note says why the built-in serves although an add-on replaces it.
	Note string
}

// AdminBuiltinSkills lists, for the administrator user, the replaceable
// built-in skills that at least one installed add-on replaces: who serves each
// one now and the add-ons to choose from. The choice is the same pin map as
// for the tools (chats_tool_providers).
func (s *Service) AdminBuiltinSkills(ctx context.Context, user string) ([]BuiltinSkillInfo, error) {
	command, err := s.addonCommandDescriptor(ctx, principal(user), session.ChatRecord{}, nil)
	if err != nil {
		return nil, err
	}
	ad, err := s.addonSkillsFor(ctx, principal(user), nil, nil, command)
	if err != nil {
		return nil, err
	}
	var out []BuiltinSkillInfo
	for _, name := range contract.ReplaceableSkills {
		info := BuiltinSkillInfo{ID: name, Pinned: ad.pins[name], Titles: map[string]string{}}
		installed := ad.installTimes()
		info.Candidates = OrderProviders(ad.shippers(ad.known, name), installed)
		if len(info.Candidates) == 0 {
			continue
		}
		info.Default = info.Candidates[0]
		info.InstalledAt = installTimesOf(info.Candidates, installed)
		for _, id := range info.Candidates {
			info.Titles[id] = ad.title(id)
		}
		info.Provider = BuiltinProvider
		if p, _ := ad.provider(name); p != "" {
			info.Provider = p
		} else {
			info.Note = "not running"
		}
		out = append(out, info)
	}
	return out, nil
}

// installTimesOf keeps the known install times of ids.
func installTimesOf(ids []string, installed map[string]string) map[string]string {
	var out map[string]string
	for _, id := range ids {
		if t := installed[id]; t != "" {
			if out == nil {
				out = map[string]string{}
			}
			out[id] = t
		}
	}
	return out
}