| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409 |
- package tools
- import (
- "context"
- _ "embed"
- "fmt"
- "log/slog"
- "os"
- "path/filepath"
- "strings"
- "time"
- "charm.land/fantasy"
- "github.com/charmbracelet/crush/internal/csync"
- "github.com/charmbracelet/crush/internal/diff"
- "github.com/charmbracelet/crush/internal/filepathext"
- "github.com/charmbracelet/crush/internal/fsext"
- "github.com/charmbracelet/crush/internal/history"
- "github.com/charmbracelet/crush/internal/lsp"
- "github.com/charmbracelet/crush/internal/permission"
- )
- type MultiEditOperation struct {
- OldString string `json:"old_string" description:"The text to replace"`
- NewString string `json:"new_string" description:"The text to replace it with"`
- ReplaceAll bool `json:"replace_all,omitempty" description:"Replace all occurrences of old_string (default false)."`
- }
- type MultiEditParams struct {
- FilePath string `json:"file_path" description:"The absolute path to the file to modify"`
- Edits []MultiEditOperation `json:"edits" description:"Array of edit operations to perform sequentially on the file"`
- }
- type MultiEditPermissionsParams struct {
- FilePath string `json:"file_path"`
- OldContent string `json:"old_content,omitempty"`
- NewContent string `json:"new_content,omitempty"`
- }
- type FailedEdit struct {
- Index int `json:"index"`
- Error string `json:"error"`
- Edit MultiEditOperation `json:"edit"`
- }
- type MultiEditResponseMetadata struct {
- Additions int `json:"additions"`
- Removals int `json:"removals"`
- OldContent string `json:"old_content,omitempty"`
- NewContent string `json:"new_content,omitempty"`
- EditsApplied int `json:"edits_applied"`
- EditsFailed []FailedEdit `json:"edits_failed,omitempty"`
- }
- const MultiEditToolName = "multiedit"
- //go:embed multiedit.md
- var multieditDescription []byte
- func NewMultiEditTool(lspClients *csync.Map[string, *lsp.Client], permissions permission.Service, files history.Service, workingDir string) fantasy.AgentTool {
- return fantasy.NewAgentTool(
- MultiEditToolName,
- string(multieditDescription),
- func(ctx context.Context, params MultiEditParams, call fantasy.ToolCall) (fantasy.ToolResponse, error) {
- if params.FilePath == "" {
- return fantasy.NewTextErrorResponse("file_path is required"), nil
- }
- if len(params.Edits) == 0 {
- return fantasy.NewTextErrorResponse("at least one edit operation is required"), nil
- }
- params.FilePath = filepathext.SmartJoin(workingDir, params.FilePath)
- // Validate all edits before applying any
- if err := validateEdits(params.Edits); err != nil {
- return fantasy.NewTextErrorResponse(err.Error()), nil
- }
- var response fantasy.ToolResponse
- var err error
- editCtx := editContext{ctx, permissions, files, workingDir}
- // Handle file creation case (first edit has empty old_string)
- if len(params.Edits) > 0 && params.Edits[0].OldString == "" {
- response, err = processMultiEditWithCreation(editCtx, params, call)
- } else {
- response, err = processMultiEditExistingFile(editCtx, params, call)
- }
- if err != nil {
- return response, err
- }
- if response.IsError {
- return response, nil
- }
- // Notify LSP clients about the change
- notifyLSPs(ctx, lspClients, params.FilePath)
- // Wait for LSP diagnostics and add them to the response
- text := fmt.Sprintf("<result>\n%s\n</result>\n", response.Content)
- text += getDiagnostics(params.FilePath, lspClients)
- response.Content = text
- return response, nil
- })
- }
- func validateEdits(edits []MultiEditOperation) error {
- for i, edit := range edits {
- // Only the first edit can have empty old_string (for file creation)
- if i > 0 && edit.OldString == "" {
- return fmt.Errorf("edit %d: only the first edit can have empty old_string (for file creation)", i+1)
- }
- }
- return nil
- }
- func processMultiEditWithCreation(edit editContext, params MultiEditParams, call fantasy.ToolCall) (fantasy.ToolResponse, error) {
- // First edit creates the file
- firstEdit := params.Edits[0]
- if firstEdit.OldString != "" {
- return fantasy.NewTextErrorResponse("first edit must have empty old_string for file creation"), nil
- }
- // Check if file already exists
- if _, err := os.Stat(params.FilePath); err == nil {
- return fantasy.NewTextErrorResponse(fmt.Sprintf("file already exists: %s", params.FilePath)), nil
- } else if !os.IsNotExist(err) {
- return fantasy.ToolResponse{}, fmt.Errorf("failed to access file: %w", err)
- }
- // Create parent directories
- dir := filepath.Dir(params.FilePath)
- if err := os.MkdirAll(dir, 0o755); err != nil {
- return fantasy.ToolResponse{}, fmt.Errorf("failed to create parent directories: %w", err)
- }
- // Start with the content from the first edit
- currentContent := firstEdit.NewString
- // Apply remaining edits to the content, tracking failures
- var failedEdits []FailedEdit
- for i := 1; i < len(params.Edits); i++ {
- edit := params.Edits[i]
- newContent, err := applyEditToContent(currentContent, edit)
- if err != nil {
- failedEdits = append(failedEdits, FailedEdit{
- Index: i + 1,
- Error: err.Error(),
- Edit: edit,
- })
- continue
- }
- currentContent = newContent
- }
- // Get session and message IDs
- sessionID := GetSessionFromContext(edit.ctx)
- if sessionID == "" {
- return fantasy.ToolResponse{}, fmt.Errorf("session ID is required for creating a new file")
- }
- // Check permissions
- _, additions, removals := diff.GenerateDiff("", currentContent, strings.TrimPrefix(params.FilePath, edit.workingDir))
- p := edit.permissions.Request(permission.CreatePermissionRequest{
- SessionID: sessionID,
- Path: fsext.PathOrPrefix(params.FilePath, edit.workingDir),
- ToolCallID: call.ID,
- ToolName: MultiEditToolName,
- Action: "write",
- Description: fmt.Sprintf("Create file %s with %d edits", params.FilePath, len(params.Edits)),
- Params: MultiEditPermissionsParams{
- FilePath: params.FilePath,
- OldContent: "",
- NewContent: currentContent,
- },
- })
- if !p {
- return fantasy.ToolResponse{}, permission.ErrorPermissionDenied
- }
- // Write the file
- err := os.WriteFile(params.FilePath, []byte(currentContent), 0o644)
- if err != nil {
- return fantasy.ToolResponse{}, fmt.Errorf("failed to write file: %w", err)
- }
- // Update file history
- _, err = edit.files.Create(edit.ctx, sessionID, params.FilePath, "")
- if err != nil {
- return fantasy.ToolResponse{}, fmt.Errorf("error creating file history: %w", err)
- }
- _, err = edit.files.CreateVersion(edit.ctx, sessionID, params.FilePath, currentContent)
- if err != nil {
- slog.Debug("Error creating file history version", "error", err)
- }
- recordFileWrite(params.FilePath)
- recordFileRead(params.FilePath)
- editsApplied := len(params.Edits) - len(failedEdits)
- var message string
- if len(failedEdits) > 0 {
- message = fmt.Sprintf("File created with %d of %d edits: %s (%d edit(s) failed)", editsApplied, len(params.Edits), params.FilePath, len(failedEdits))
- } else {
- message = fmt.Sprintf("File created with %d edits: %s", len(params.Edits), params.FilePath)
- }
- return fantasy.WithResponseMetadata(
- fantasy.NewTextResponse(message),
- MultiEditResponseMetadata{
- OldContent: "",
- NewContent: currentContent,
- Additions: additions,
- Removals: removals,
- EditsApplied: editsApplied,
- EditsFailed: failedEdits,
- },
- ), nil
- }
- func processMultiEditExistingFile(edit editContext, params MultiEditParams, call fantasy.ToolCall) (fantasy.ToolResponse, error) {
- // Validate file exists and is readable
- fileInfo, err := os.Stat(params.FilePath)
- if err != nil {
- if os.IsNotExist(err) {
- return fantasy.NewTextErrorResponse(fmt.Sprintf("file not found: %s", params.FilePath)), nil
- }
- return fantasy.ToolResponse{}, fmt.Errorf("failed to access file: %w", err)
- }
- if fileInfo.IsDir() {
- return fantasy.NewTextErrorResponse(fmt.Sprintf("path is a directory, not a file: %s", params.FilePath)), nil
- }
- // Check if file was read before editing
- if getLastReadTime(params.FilePath).IsZero() {
- return fantasy.NewTextErrorResponse("you must read the file before editing it. Use the View tool first"), nil
- }
- // Check if file was modified since last read
- modTime := fileInfo.ModTime()
- lastRead := getLastReadTime(params.FilePath)
- if modTime.After(lastRead) {
- return fantasy.NewTextErrorResponse(
- fmt.Sprintf("file %s has been modified since it was last read (mod time: %s, last read: %s)",
- params.FilePath, modTime.Format(time.RFC3339), lastRead.Format(time.RFC3339),
- )), nil
- }
- // Read current file content
- content, err := os.ReadFile(params.FilePath)
- if err != nil {
- return fantasy.ToolResponse{}, fmt.Errorf("failed to read file: %w", err)
- }
- oldContent, isCrlf := fsext.ToUnixLineEndings(string(content))
- currentContent := oldContent
- // Apply all edits sequentially, tracking failures
- var failedEdits []FailedEdit
- for i, edit := range params.Edits {
- newContent, err := applyEditToContent(currentContent, edit)
- if err != nil {
- failedEdits = append(failedEdits, FailedEdit{
- Index: i + 1,
- Error: err.Error(),
- Edit: edit,
- })
- continue
- }
- currentContent = newContent
- }
- // Check if content actually changed
- if oldContent == currentContent {
- // If we have failed edits, report them
- if len(failedEdits) > 0 {
- return fantasy.WithResponseMetadata(
- fantasy.NewTextErrorResponse(fmt.Sprintf("no changes made - all %d edit(s) failed", len(failedEdits))),
- MultiEditResponseMetadata{
- EditsApplied: 0,
- EditsFailed: failedEdits,
- },
- ), nil
- }
- return fantasy.NewTextErrorResponse("no changes made - all edits resulted in identical content"), nil
- }
- // Get session and message IDs
- sessionID := GetSessionFromContext(edit.ctx)
- if sessionID == "" {
- return fantasy.ToolResponse{}, fmt.Errorf("session ID is required for editing file")
- }
- // Generate diff and check permissions
- _, additions, removals := diff.GenerateDiff(oldContent, currentContent, strings.TrimPrefix(params.FilePath, edit.workingDir))
- p := edit.permissions.Request(permission.CreatePermissionRequest{
- SessionID: sessionID,
- Path: fsext.PathOrPrefix(params.FilePath, edit.workingDir),
- ToolCallID: call.ID,
- ToolName: MultiEditToolName,
- Action: "write",
- Description: fmt.Sprintf("Apply %d edits to file %s", len(params.Edits), params.FilePath),
- Params: MultiEditPermissionsParams{
- FilePath: params.FilePath,
- OldContent: oldContent,
- NewContent: currentContent,
- },
- })
- if !p {
- return fantasy.ToolResponse{}, permission.ErrorPermissionDenied
- }
- if isCrlf {
- currentContent, _ = fsext.ToWindowsLineEndings(currentContent)
- }
- // Write the updated content
- err = os.WriteFile(params.FilePath, []byte(currentContent), 0o644)
- if err != nil {
- return fantasy.ToolResponse{}, fmt.Errorf("failed to write file: %w", err)
- }
- // Update file history
- file, err := edit.files.GetByPathAndSession(edit.ctx, params.FilePath, sessionID)
- if err != nil {
- _, err = edit.files.Create(edit.ctx, sessionID, params.FilePath, oldContent)
- if err != nil {
- return fantasy.ToolResponse{}, fmt.Errorf("error creating file history: %w", err)
- }
- }
- if file.Content != oldContent {
- // User manually changed the content, store an intermediate version
- _, err = edit.files.CreateVersion(edit.ctx, sessionID, params.FilePath, oldContent)
- if err != nil {
- slog.Debug("Error creating file history version", "error", err)
- }
- }
- // Store the new version
- _, err = edit.files.CreateVersion(edit.ctx, sessionID, params.FilePath, currentContent)
- if err != nil {
- slog.Debug("Error creating file history version", "error", err)
- }
- recordFileWrite(params.FilePath)
- recordFileRead(params.FilePath)
- editsApplied := len(params.Edits) - len(failedEdits)
- var message string
- if len(failedEdits) > 0 {
- message = fmt.Sprintf("Applied %d of %d edits to file: %s (%d edit(s) failed)", editsApplied, len(params.Edits), params.FilePath, len(failedEdits))
- } else {
- message = fmt.Sprintf("Applied %d edits to file: %s", len(params.Edits), params.FilePath)
- }
- return fantasy.WithResponseMetadata(
- fantasy.NewTextResponse(message),
- MultiEditResponseMetadata{
- OldContent: oldContent,
- NewContent: currentContent,
- Additions: additions,
- Removals: removals,
- EditsApplied: editsApplied,
- EditsFailed: failedEdits,
- },
- ), nil
- }
- func applyEditToContent(content string, edit MultiEditOperation) (string, error) {
- if edit.OldString == "" && edit.NewString == "" {
- return content, nil
- }
- if edit.OldString == "" {
- return "", fmt.Errorf("old_string cannot be empty for content replacement")
- }
- var newContent string
- var replacementCount int
- if edit.ReplaceAll {
- newContent = strings.ReplaceAll(content, edit.OldString, edit.NewString)
- replacementCount = strings.Count(content, edit.OldString)
- if replacementCount == 0 {
- return "", fmt.Errorf("old_string not found in content. Make sure it matches exactly, including whitespace and line breaks")
- }
- } else {
- index := strings.Index(content, edit.OldString)
- if index == -1 {
- return "", fmt.Errorf("old_string not found in content. Make sure it matches exactly, including whitespace and line breaks")
- }
- lastIndex := strings.LastIndex(content, edit.OldString)
- if index != lastIndex {
- return "", fmt.Errorf("old_string appears multiple times in the content. Please provide more context to ensure a unique match, or set replace_all to true")
- }
- newContent = content[:index] + edit.NewString + content[index+len(edit.OldString):]
- replacementCount = 1
- }
- return newContent, nil
- }
|