1 Commits

Author SHA1 Message Date
195c4ab3ad Add insane ramblings 2024-07-01 20:08:23 +02:00
14 changed files with 514 additions and 1110 deletions

6
.gitignore vendored
View File

@@ -1,4 +1,2 @@
*.exe
*.exe main.exe
cln
cln.log

View File

@@ -1,89 +0,0 @@
# synclib
A small Go tool for creating symbolic links
Created out of infuriating difficulty of creating symbolic links on windows
## Instruction Formats
The tool supports two formats for defining symbolic links:
### 1. CSV Format (Legacy)
Simple comma-separated values with the format: `<source>,<destination>[,force][,hard][,delete]`
For example:
```
source_path,target_path
source_path,target_path,true
source_path,target_path,true,true
source_path,target_path,true,true,true
```
Or with named flags:
```
source_path,target_path,force=true,hard=true,delete=true
source_path,target_path,f=true,h=true,d=true
```
### 2. YAML Format (Recommended)
A more readable format using YAML:
```yaml
links:
- source: ~/Documents/config.ini
target: ~/.config/app/config.ini
force: true
- source: ~/Pictures
target: ~/Documents/Pictures
hard: true
force: true
- source: ~/Scripts/script.sh
target: ~/bin/script.sh
delete: true
```
Alternatively, you can use an array directly:
```yaml
- source: ~/Documents/config.ini
target: ~/.config/app/config.ini
force: true
- source: ~/Pictures
target: ~/Documents/Pictures
hard: true
```
## Input Methods
The tool supports input of these instructions through:
- Stdin
- `echo "this,that" | sync`
- Run arguments
- `sync this,that foo,bar "foo 2","C:/bar"`
- Files
- `sync -f <file>` (CSV format)
- `sync -f <file.yaml>` or `sync -f <file.yml>` (YAML format)
- Where the file contains instructions, one per line for CSV or structured YAML
- Directories
- `sync -r <directory>`
- This mode will look for "sync", "sync.yaml", or "sync.yml" files recursively in directories and run their instructions
## Options
- `force: true` - Overwrite an existing symbolic link at the target location
- `hard: true` - Create a hard link instead of a symbolic link
- `delete: true` - Delete a non-symlink file at the target location (implies `force: true`)
## Use case
I have a lot of folders (documents, projects, configurations) backed up via Seafile and to have the software using those folders find them at their usual location I'm creating soft symbolic links from the seafile drive to their original location
It would be problematic to have to redo all (or some part) of these symlinks when reinstalling the OS or having something somewhere explode (say software uninstalled) so I have all the instructions in sync files in individual folders in the seafile drive
Which means I can easily back up my configuration and `sync -r ~/Seafile` to symlink it where it belongs

View File

@@ -1,99 +0,0 @@
package main
import (
"fmt"
"math/rand/v2"
)
const (
// Reset
Reset = "\033[0m" // Text Reset
// Regular Colors
Black = "\033[0;30m" // Black
Red = "\033[0;31m" // Red
Green = "\033[0;32m" // Green
Yellow = "\033[0;33m" // Yellow
Blue = "\033[0;34m" // Blue
Purple = "\033[0;35m" // Purple
Cyan = "\033[0;36m" // Cyan
White = "\033[0;37m" // White
// Bold
BBlack = "\033[1;30m" // Black
BRed = "\033[1;31m" // Red
BGreen = "\033[1;32m" // Green
BYellow = "\033[1;33m" // Yellow
BBlue = "\033[1;34m" // Blue
BPurple = "\033[1;35m" // Purple
BCyan = "\033[1;36m" // Cyan
BWhite = "\033[1;37m" // White
// Underline
UBlack = "\033[4;30m" // Black
URed = "\033[4;31m" // Red
UGreen = "\033[4;32m" // Green
UYellow = "\033[4;33m" // Yellow
UBlue = "\033[4;34m" // Blue
UPurple = "\033[4;35m" // Purple
UCyan = "\033[4;36m" // Cyan
UWhite = "\033[4;37m" // White
// Background
On_Black = "\033[40m" // Black
On_Red = "\033[41m" // Red
On_Green = "\033[42m" // Green
On_Yellow = "\033[43m" // Yellow
On_Blue = "\033[44m" // Blue
On_Purple = "\033[45m" // Purple
On_Cyan = "\033[46m" // Cyan
On_White = "\033[47m" // White
// High Intensty
IBlack = "\033[0;90m" // Black
IRed = "\033[0;91m" // Red
IGreen = "\033[0;92m" // Green
IYellow = "\033[0;93m" // Yellow
IBlue = "\033[0;94m" // Blue
IPurple = "\033[0;95m" // Purple
ICyan = "\033[0;96m" // Cyan
IWhite = "\033[0;97m" // White
// Bold High Intensty
BIBlack = "\033[1;90m" // Black
BIRed = "\033[1;91m" // Red
BIGreen = "\033[1;92m" // Green
BIYellow = "\033[1;93m" // Yellow
BIBlue = "\033[1;94m" // Blue
BIPurple = "\033[1;95m" // Purple
BICyan = "\033[1;96m" // Cyan
BIWhite = "\033[1;97m" // White
// High Intensty backgrounds
On_IBlack = "\033[0;100m" // Black
On_IRed = "\033[0;101m" // Red
On_IGreen = "\033[0;102m" // Green
On_IYellow = "\033[0;103m" // Yellow
On_IBlue = "\033[0;104m" // Blue
On_IPurple = "\033[10;95m" // Purple
On_ICyan = "\033[0;106m" // Cyan
On_IWhite = "\033[0;107m" // White
)
// The acceptable range is [16, 231] but here we remove some very dark colors
// That make text unreadable on a dark terminal
// See https://www.hackitu.de/termcolor256/
var colors = []int{22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 57, 62, 63, 64, 65, 67, 68, 69, 70, 71, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 148, 149, 150, 151, 152, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 184, 185, 186, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 226, 227, 228, 229, 230}
var colorsIndex int = -1
var shuffled bool
func GenerateRandomAnsiColor() string {
if !shuffled {
rand.Shuffle(len(colors), func(i int, j int) {
colors[i], colors[j] = colors[j], colors[i]
})
shuffled = true
}
colorsIndex++
return fmt.Sprintf("\033[1;4;38;5;%dm", colors[colorsIndex%len(colors)])
}

View File

@@ -1,2 +1 @@
GOOS=windows GOARCH=amd64 go build -o main.exe main && cp main.exe "/c/Program Files/Git/usr/bin/cln.exe" go build main && cp main.exe "/c/Program Files/Git/usr/bin/cln.exe"
GOOS=linux GOARCH=amd64 go build -o main_linux main

4
go.mod
View File

@@ -1,5 +1,3 @@
module cln module main
go 1.21.7 go 1.21.7
require gopkg.in/yaml.v3 v3.0.1

4
go.sum
View File

@@ -1,4 +0,0 @@
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

View File

@@ -1,312 +1,132 @@
package main package main
import ( import (
"fmt" "fmt"
"os" "log"
"path/filepath" "os"
"slices" "regexp"
"strings" "strconv"
"strings"
"gopkg.in/yaml.v3" )
)
type LinkInstruction struct {
type LinkInstruction struct { Source string
Source string `yaml:"source"` Target string
Target string `yaml:"target"` Force bool
Force bool `yaml:"force,omitempty"` }
Hard bool `yaml:"hard,omitempty"`
Delete bool `yaml:"delete,omitempty"` func (instruction *LinkInstruction) String() string {
} return fmt.Sprintf("%s%s%s%s%s%s%s%s%s", SourceColor, instruction.Source, DefaultColor, deliminer, TargetColor, instruction.Target, DefaultColor, deliminer, strconv.FormatBool(instruction.Force))
}
type YAMLConfig struct {
Links []LinkInstruction `yaml:"links"` func ParseInstruction(line string) (LinkInstruction, error) {
} parts := strings.Split(line, deliminer)
instruction := LinkInstruction{}
func (instruction *LinkInstruction) Tidy() {
instruction.Source = strings.ReplaceAll(instruction.Source, "\"", "") if len(parts) < 2 {
instruction.Source = strings.ReplaceAll(instruction.Source, "\\", "/") return instruction, fmt.Errorf("invalid format - not enough parameters (must have at least source and target)")
instruction.Source = strings.TrimSpace(instruction.Source) }
instruction.Target = strings.ReplaceAll(instruction.Target, "\"", "") instruction.Source = parts[0]
instruction.Target = strings.ReplaceAll(instruction.Target, "\\", "/") instruction.Target = parts[1]
instruction.Target = strings.TrimSpace(instruction.Target) instruction.Force = false
} if len(parts) > 2 {
res, _ := regexp.MatchString("^(?i)T|TRUE$", parts[2])
func (instruction *LinkInstruction) String() string { instruction.Force = res
var flags []string }
if instruction.Force {
flags = append(flags, "force=true") instruction.Source, _ = ConvertHome(instruction.Source)
} instruction.Target, _ = ConvertHome(instruction.Target)
if instruction.Hard {
flags = append(flags, "hard=true") instruction.Source = NormalizePath(instruction.Source)
} instruction.Target = NormalizePath(instruction.Target)
if instruction.Delete {
flags = append(flags, "delete=true") return instruction, nil
} }
flagsStr := "" func (instruction *LinkInstruction) RunSync() error {
if len(flags) > 0 { if !FileExists(instruction.Source) {
flagsStr = " [" + strings.Join(flags, ", ") + "]" return fmt.Errorf("instruction source %s%s%s does not exist", SourceColor, instruction.Source, DefaultColor)
} }
return fmt.Sprintf("%s%s%s → %s%s%s%s", if AreSame(instruction.Source, instruction.Target) {
SourceColor, instruction.Source, DefaultColor, log.Printf("Source %s%s%s and target %s%s%s are the same, %snothing to do...%s", SourceColor, instruction.Source, DefaultColor, TargetColor, instruction.Target, DefaultColor, PathColor, DefaultColor)
TargetColor, instruction.Target, DefaultColor, return nil
flagsStr) }
}
if FileExists(instruction.Target) {
func ParseInstruction(line, workdir string) (LinkInstruction, error) { if instruction.Force {
line = strings.TrimSpace(line) isSymlink, err := IsSymlink(instruction.Target)
if strings.HasPrefix(line, "#") { if err != nil {
return LinkInstruction{}, fmt.Errorf("comment line") return fmt.Errorf("could not determine whether %s%s%s is a sym link or not, stopping; err: %s%+v%s", TargetColor, instruction.Target, DefaultColor, ErrorColor, err, DefaultColor)
} }
parts := strings.Split(line, deliminer) if isSymlink {
instruction := LinkInstruction{} log.Printf("Removing symlink at %s%s%s", TargetColor, instruction.Target, DefaultColor)
err = os.Remove(instruction.Target)
if len(parts) < 2 { if err != nil {
return instruction, fmt.Errorf("invalid format - not enough parameters (must have at least source and target)") return fmt.Errorf("failed deleting %s%s%s due to %s%+v%s", TargetColor, instruction.Target, DefaultColor, ErrorColor, err, DefaultColor)
} }
} else {
instruction.Source = strings.TrimSpace(parts[0]) return fmt.Errorf("refusing to delte actual (non symlink) file %s%s%s", TargetColor, instruction.Target, DefaultColor)
instruction.Target = strings.TrimSpace(parts[1]) }
} else {
for i := 2; i < len(parts); i++ { return fmt.Errorf("target %s%s%s exists - handle manually or set the 'forced' flag (3rd field)", TargetColor, instruction.Target, DefaultColor)
flagPart := strings.TrimSpace(parts[i]) }
}
// Support for legacy format (backward compatibility)
if !strings.Contains(flagPart, "=") { err := os.Symlink(instruction.Source, instruction.Target)
// Legacy format: positional boolean flags if err != nil {
switch i { return fmt.Errorf("failed creating symlink between %s%s%s and %s%s%s with error %s%+v%s", SourceColor, instruction.Source, DefaultColor, TargetColor, instruction.Target, DefaultColor, ErrorColor, err, DefaultColor)
case 2: // Force flag (3rd position) }
instruction.Force = isTrue(flagPart) log.Printf("Created symlink between %s%s%s and %s%s%s", SourceColor, instruction.Source, DefaultColor, TargetColor, instruction.Target, DefaultColor)
case 3: // Hard flag (4th position)
instruction.Hard = isTrue(flagPart) return nil
case 4: // Delete flag (5th position) }
instruction.Delete = isTrue(flagPart)
if instruction.Delete { func (instruction *LinkInstruction) RunAsync(status chan (error)) {
instruction.Force = true // Delete implies Force defer close(status)
} if !FileExists(instruction.Source) {
} status <- fmt.Errorf("instruction source %s%s%s does not exist", SourceColor, instruction.Source, DefaultColor)
continue return
} }
// New format: named flags (name=value) if AreSame(instruction.Source, instruction.Target) {
nameValue := strings.SplitN(flagPart, "=", 2) status <- fmt.Errorf("source %s%s%s and target %s%s%s are the same, %snothing to do...%s", SourceColor, instruction.Source, DefaultColor, TargetColor, instruction.Target, DefaultColor, PathColor, DefaultColor)
if len(nameValue) != 2 { return
// Skip malformed flags }
continue
} if FileExists(instruction.Target) {
if instruction.Force {
flagName := strings.ToLower(strings.TrimSpace(nameValue[0])) isSymlink, err := IsSymlink(instruction.Target)
flagValue := strings.TrimSpace(nameValue[1]) if err != nil {
status <- fmt.Errorf("could not determine whether %s%s%s is a sym link or not, stopping; err: %s%+v%s", TargetColor, instruction.Target, DefaultColor, ErrorColor, err, DefaultColor)
switch flagName { return
case "force", "f": }
instruction.Force = isTrue(flagValue)
case "hard", "h": if isSymlink {
instruction.Hard = isTrue(flagValue) log.Printf("Removing symlink at %s%s%s", TargetColor, instruction.Target, DefaultColor)
case "delete", "d": err = os.Remove(instruction.Target)
instruction.Delete = isTrue(flagValue) if err != nil {
if instruction.Delete { status <- fmt.Errorf("failed deleting %s%s%s due to %s%+v%s", TargetColor, instruction.Target, DefaultColor, ErrorColor, err, DefaultColor)
instruction.Force = true // Delete implies Force return
} }
} } else {
} status <- fmt.Errorf("refusing to delte actual (non symlink) file %s%s%s", TargetColor, instruction.Target, DefaultColor)
return
instruction.Tidy() }
instruction.Source, _ = ConvertHome(instruction.Source) } else {
instruction.Target, _ = ConvertHome(instruction.Target) status <- fmt.Errorf("target %s%s%s exists - handle manually or set the 'forced' flag (3rd field)", TargetColor, instruction.Target, DefaultColor)
return
instruction.Source = NormalizePath(instruction.Source, workdir) }
instruction.Target = NormalizePath(instruction.Target, workdir) }
return instruction, nil err := os.Symlink(instruction.Source, instruction.Target)
} if err != nil {
status <- fmt.Errorf("failed creating symlink between %s%s%s and %s%s%s with error %s%+v%s", SourceColor, instruction.Source, DefaultColor, TargetColor, instruction.Target, DefaultColor, ErrorColor, err, DefaultColor)
func isTrue(value string) bool { return
value = strings.ToLower(strings.TrimSpace(value)) }
return value == "true" || value == "t" || value == "yes" || value == "y" || value == "1" log.Printf("Created symlink between %s%s%s and %s%s%s", SourceColor, instruction.Source, DefaultColor, TargetColor, instruction.Target, DefaultColor)
}
status <- nil
func (instruction *LinkInstruction) RunAsync(status chan (error)) { }
defer close(status)
if !FileExists(instruction.Source) {
status <- fmt.Errorf("instruction source %s does not exist", FormatSourcePath(instruction.Source))
return
}
if !instruction.Force && AreSame(instruction.Source, instruction.Target) {
status <- fmt.Errorf("source %s and target %s are the same, nothing to do...",
FormatSourcePath(instruction.Source),
FormatTargetPath(instruction.Target))
return
}
if FileExists(instruction.Target) {
if instruction.Force {
isSymlink, err := IsSymlink(instruction.Target)
if err != nil {
status <- fmt.Errorf("could not determine whether %s is a sym link or not, stopping; err: %v",
FormatTargetPath(instruction.Target), err)
return
}
if instruction.Hard {
info, err := os.Stat(instruction.Target)
if err != nil {
status <- fmt.Errorf("could not stat %s, stopping; err: %v",
FormatTargetPath(instruction.Target), err)
return
}
if info.Mode().IsRegular() && info.Name() == filepath.Base(instruction.Source) {
LogTarget("Overwriting existing file %s", instruction.Target)
err := os.Remove(instruction.Target)
if err != nil {
status <- fmt.Errorf("could not remove existing file %s; err: %v",
FormatTargetPath(instruction.Target), err)
return
}
}
}
if isSymlink {
LogTarget("Removing symlink at %s", instruction.Target)
err = os.Remove(instruction.Target)
if err != nil {
status <- fmt.Errorf("failed deleting %s due to %v",
FormatTargetPath(instruction.Target), err)
return
}
} else {
if !instruction.Delete {
status <- fmt.Errorf("refusing to delte actual (non symlink) file %s",
FormatTargetPath(instruction.Target))
return
}
LogImportant("Deleting (!!!) %s", instruction.Target)
err = os.RemoveAll(instruction.Target)
if err != nil {
status <- fmt.Errorf("failed deleting %s due to %v",
FormatTargetPath(instruction.Target), err)
return
}
}
} else {
status <- fmt.Errorf("target %s exists - handle manually or set the 'forced' flag (3rd field)",
FormatTargetPath(instruction.Target))
return
}
}
targetDir := filepath.Dir(instruction.Target)
if _, err := os.Stat(targetDir); os.IsNotExist(err) {
err = os.MkdirAll(targetDir, 0755)
if err != nil {
status <- fmt.Errorf("failed creating directory %s due to %v",
FormatTargetPath(targetDir), err)
return
}
}
var err error
if instruction.Hard {
err = os.Link(instruction.Source, instruction.Target)
} else {
err = os.Symlink(instruction.Source, instruction.Target)
}
if err != nil {
status <- fmt.Errorf("failed creating symlink between %s and %s with error %v",
FormatSourcePath(instruction.Source),
FormatTargetPath(instruction.Target),
err)
return
}
LogInfo("Created symlink between %s and %s",
FormatSourcePath(instruction.Source),
FormatTargetPath(instruction.Target))
status <- nil
}
func ParseYAMLFile(filename, workdir string) ([]LinkInstruction, error) {
data, err := os.ReadFile(filename)
if err != nil {
return nil, fmt.Errorf("error reading YAML file: %w", err)
}
// First try to parse as a list of link instructions
var config YAMLConfig
err = yaml.Unmarshal(data, &config)
if err != nil || len(config.Links) == 0 {
// If that fails, try parsing as a direct list of instructions
var instructions []LinkInstruction
err = yaml.Unmarshal(data, &instructions)
if err != nil {
return nil, fmt.Errorf("error parsing YAML: %w", err)
}
config.Links = instructions
}
toRemove := []int{}
for i, link := range config.Links {
if strings.Contains(link.Source, "*") {
LogSource("Expanding wildcard source %s in YAML file %s", link.Source, filename)
newlinks, err := ExpandWildcard(link.Source, workdir, link.Target)
if err != nil {
return nil, fmt.Errorf("error expanding wildcard: %w", err)
}
LogInfo("Expanded wildcard source %s in YAML file %s to %d links",
FormatSourcePath(link.Source), FormatSourcePath(filename), len(newlinks))
config.Links = append(config.Links, newlinks...)
toRemove = append(toRemove, i)
}
}
for i := len(toRemove) - 1; i >= 0; i-- {
config.Links = slices.Delete(config.Links, toRemove[i], 1)
}
for i := range config.Links {
link := &config.Links[i]
link.Tidy()
link.Source, _ = ConvertHome(link.Source)
link.Target, _ = ConvertHome(link.Target)
link.Source = NormalizePath(link.Source, workdir)
link.Target = NormalizePath(link.Target, workdir)
// If Delete is true, Force must also be true
if config.Links[i].Delete {
config.Links[i].Force = true
}
}
return config.Links, nil
}
func ExpandWildcard(source, workdir, target string) (links []LinkInstruction, err error) {
dir := filepath.Dir(source)
pattern := filepath.Base(source)
files, err := filepath.Glob(filepath.Join(workdir, dir, pattern))
if err != nil {
return nil, fmt.Errorf("error expanding wildcard: %w", err)
}
for _, file := range files {
link := LinkInstruction{
Source: file,
Target: filepath.Join(target, filepath.Base(file)),
}
links = append(links, link)
}
LogInfo("Expanded wildcard source %s to %d links", FormatSourcePath(source), len(links))
return
}
func IsYAMLFile(filename string) bool {
ext := strings.ToLower(filepath.Ext(filename))
return ext == ".yaml" || ext == ".yml"
}

View File

@@ -1,92 +0,0 @@
package main
import (
"fmt"
"log"
)
// Message type prefixes
const (
InfoPrefix = "INFO"
ErrorPrefix = "ERROR"
WarningPrefix = "WARN"
SourcePrefix = "SOURCE"
TargetPrefix = "TARGET"
PathPrefix = "PATH"
ImportantPrefix = "IMPORTANT"
)
// LogInfo logs an informational message
func LogInfo(format string, args ...interface{}) {
message := fmt.Sprintf(format, args...)
log.Printf("%s[%s]%s %s", BGreen, InfoPrefix, Reset, message)
}
// LogSource logs a message about a source file/path with proper coloring
func LogSource(format string, args ...interface{}) {
message := fmt.Sprintf(format, args...)
log.Printf("%s[%s]%s %s%s%s", BPurple, SourcePrefix, Reset, SourceColor, message, Reset)
}
// LogTarget logs a message about a target file/path with proper coloring
func LogTarget(format string, args ...interface{}) {
message := fmt.Sprintf(format, args...)
log.Printf("%s[%s]%s %s%s%s", BYellow, TargetPrefix, Reset, TargetColor, message, Reset)
}
// LogPath logs a message about a path with proper coloring
func LogPath(format string, args ...interface{}) {
message := fmt.Sprintf(format, args...)
log.Printf("%s[%s]%s %s%s%s", BGreen, PathPrefix, Reset, PathColor, message, Reset)
}
// LogImportant logs a message that needs attention with proper coloring
func LogImportant(format string, args ...interface{}) {
message := fmt.Sprintf(format, args...)
log.Printf("%s[%s]%s %s%s%s", BRed, ImportantPrefix, Reset, ImportantColor, message, Reset)
}
// LogError logs an error message with proper coloring that won't be cut off
func LogError(format string, args ...interface{}) {
// Format the message first with normal text (no red coloring)
message := fmt.Sprintf(format, args...)
// The Error prefix itself is bold red on a light background for maximum visibility
prefix := fmt.Sprintf("%s%s[%s]%s ", BRed, On_White, ErrorPrefix, Reset)
// The message is in default color (no red), only the [ERROR] prefix is colored
log.Printf("%s%s", prefix, message)
}
// FormatSourcePath returns a source path with proper coloring
func FormatSourcePath(path string) string {
return fmt.Sprintf("%s%s%s", SourceColor, path, Reset)
}
// FormatTargetPath returns a target path with proper coloring
func FormatTargetPath(path string) string {
return fmt.Sprintf("%s%s%s", TargetColor, path, Reset)
}
// FormatPathValue returns a path with proper coloring
func FormatPathValue(path string) string {
return fmt.Sprintf("%s%s%s", PathColor, path, Reset)
}
// FormatErrorValue returns an error value without any additional formatting
// Since error messages are no longer red, we don't need special formatting
func FormatErrorValue(err error) string {
if err == nil {
return ""
}
// Just return the error string with no color formatting
return fmt.Sprintf("%v", err)
}
// FormatErrorMessage formats an error message with no additional color formatting,
// while preserving the special formatting of embedded source/target/path elements.
func FormatErrorMessage(format string, args ...interface{}) string {
// This just formats the message with no additional color formatting
// The path formatting will still be preserved
return fmt.Sprintf(format, args...)
}

502
main.go
View File

@@ -1,264 +1,238 @@
package main package main
import ( import (
"bufio" "bufio"
"flag" "flag"
"io" "io"
"log" "log"
"os" "os"
"path/filepath" "regexp"
"regexp" "sync"
"sync" "sync/atomic"
"sync/atomic" )
)
const deliminer = ","
const deliminer = "," const (
const SourceColor = Purple Black = "\033[30m"
const TargetColor = Yellow Red = "\033[31m"
const ErrorColor = Red Green = "\033[32m"
const ImportantColor = BRed Yellow = "\033[33m"
const DefaultColor = Reset Blue = "\033[34m"
const PathColor = Green Magenta = "\033[35m"
Cyan = "\033[36m"
var FileRegex, _ = regexp.Compile(`sync\.ya?ml$`) White = "\033[37m"
var programName = os.Args[0] )
const SourceColor = Magenta
func main() { const TargetColor = Yellow
recurse := flag.String("r", "", "recurse into directories") const ErrorColor = Red
file := flag.String("f", "", "file to read instructions from") const DefaultColor = White
debug := flag.Bool("d", false, "debug") const PathColor = Green
flag.Parse()
var DirRegex, _ = regexp.Compile(`^(.+?)[/\\]sync$`)
if *debug { var FileRegex, _ = regexp.Compile(`^sync$`)
log.SetFlags(log.Lmicroseconds | log.Lshortfile) var programName = os.Args[0]
logFile, err := os.Create("cln.log")
if err != nil { func main() {
LogError("Error creating log file: %v", err) recurse := flag.String("r", "", "recurse into directories")
os.Exit(1) file := flag.String("f", "", "file to read instructions from")
} debug := flag.Bool("d", false, "debug")
logger := io.MultiWriter(os.Stdout, logFile) flag.Parse()
log.SetOutput(logger)
} else { if *debug {
log.SetFlags(log.Lmicroseconds) log.SetFlags(log.Lmicroseconds | log.Lshortfile)
} logFile, err := os.Create("main.log")
if err != nil {
instructions := make(chan *LinkInstruction, 1000) log.Printf("Error creating log file: %v", err)
status := make(chan error) os.Exit(1)
}
// Check input sources in priority order logger := io.MultiWriter(os.Stdout, logFile)
switch { log.SetOutput(logger)
case *recurse != "": } else {
LogInfo("Recurse: %s", *recurse) log.SetFlags(log.Lmicroseconds)
go ReadFromFilesRecursively(*recurse, instructions, status) }
case *file != "": log.Printf("Recurse: %s", *recurse)
LogInfo("File: %s", *file) log.Printf("File: %s", *file)
go ReadFromFile(*file, instructions, status, true)
instructions := make(chan LinkInstruction, 1000)
case len(flag.Args()) > 0: status := make(chan error)
LogInfo("Reading from command line arguments") if *recurse != "" {
go ReadFromArgs(instructions, status) go ReadFromFilesRecursively(*recurse, instructions, status)
} else if *file != "" {
case IsPipeInput(): go ReadFromFile(*file, instructions, status, true)
LogInfo("Reading from stdin pipe") } else if len(os.Args) > 1 {
go ReadFromStdin(instructions, status) go ReadFromArgs(instructions, status)
} else {
default: go ReadFromStdin(instructions, status)
if _, err := os.Stat("sync.yaml"); err == nil { }
LogInfo("Using default sync.yaml file")
go ReadFromFile("sync.yaml", instructions, status, true) go func() {
} else if _, err := os.Stat("sync.yml"); err == nil { for {
LogInfo("Using default sync.yml file") err, ok := <-status
go ReadFromFile("sync.yml", instructions, status, true) if !ok {
} else { break
LogInfo("No input provided") }
LogInfo("Provide input as: ") if err != nil {
LogInfo("Arguments - %s <source>,<target>,<force?>", programName) log.Println(err)
LogInfo("File - %s -f <file>", programName) }
LogInfo("YAML File - %s -f <file.yaml>", programName) }
LogInfo("Folder (finding sync files in folder recursively) - %s -r <folder>", programName) }()
LogInfo("stdin - (cat <file> | %s)", programName)
os.Exit(1) var instructionsDone int32
} var wg sync.WaitGroup
} for {
instruction, ok := <-instructions
go func() { if !ok {
for { log.Printf("No more instructions to process")
err, ok := <-status break
if !ok { }
break log.Printf("Processing: %s", instruction.String())
} status := make(chan error)
if err != nil { go instruction.RunAsync(status)
LogError("%v", err) wg.Add(1)
} err := <-status
} if err != nil {
}() log.Printf("Failed parsing instruction %s%s%s due to %s%+v%s", SourceColor, instruction.String(), DefaultColor, ErrorColor, err, DefaultColor)
}
var instructionsDone int32 = 0 atomic.AddInt32(&instructionsDone, 1)
var wg sync.WaitGroup wg.Done()
for { }
instruction, ok := <-instructions wg.Wait()
if !ok { log.Println("All done")
LogInfo("No more instructions to process") if instructionsDone == 0 {
break log.Printf("No input provided")
} log.Printf("Provide input as: ")
LogInfo("Processing: %s", instruction.String()) log.Printf("Arguments - %s <source>,<target>,<force?>", programName)
status := make(chan error) log.Printf("File - %s -f <file>", programName)
go instruction.RunAsync(status) log.Printf("Folder (finding sync files in folder recursively) - %s -r <folder>", programName)
wg.Add(1) log.Printf("stdin - (cat <file> | %s)", programName)
err := <-status os.Exit(1)
if err != nil { }
LogError("Failed processing instruction: %v", err) }
}
atomic.AddInt32(&instructionsDone, 1) func ReadFromFilesRecursively(input string, output chan LinkInstruction, status chan error) {
wg.Done() defer close(output)
} defer close(status)
wg.Wait()
if instructionsDone == 0 { input = NormalizePath(input)
LogInfo("No instructions were processed") log.Printf("Reading input from files recursively starting in %s%s%s", PathColor, input, DefaultColor)
os.Exit(1)
} files := make(chan string, 128)
LogInfo("All done") recurseStatus := make(chan error)
} go GetSyncFilesRecursively(input, files, recurseStatus)
go func() {
func IsPipeInput() bool { for {
info, err := os.Stdin.Stat() err, ok := <-recurseStatus
if err != nil { if !ok {
return false break
} }
return info.Mode()&os.ModeNamedPipe != 0 if err != nil {
} log.Printf("Failed to get sync files recursively: %s%+v%s", ErrorColor, err, DefaultColor)
status <- err
func ReadFromFilesRecursively(input string, output chan *LinkInstruction, status chan error) { }
defer close(output) }
defer close(status) }()
workdir, _ := os.Getwd() var wg sync.WaitGroup
input = NormalizePath(input, workdir) for {
LogInfo("Reading input from files recursively starting in %s", FormatPathValue(input)) file, ok := <-files
if !ok {
files := make(chan string, 128) log.Printf("No more files to process")
fileStatus := make(chan error) break
var wg sync.WaitGroup }
go GetSyncFilesRecursively(input, files, fileStatus) wg.Add(1)
go func() { go func() {
wg.Wait() defer wg.Done()
close(files) log.Println(file)
}() file = NormalizePath(file)
log.Printf("Processing file: %s%s%s", PathColor, file, DefaultColor)
go func() {
for { // This "has" to be done because instructions are resolved in relation to cwd
err, ok := <-fileStatus fileDir := DirRegex.FindStringSubmatch(file)
if !ok { if fileDir == nil {
break log.Printf("Failed to extract directory from %s%s%s", SourceColor, file, DefaultColor)
} return
if err != nil { }
LogError("Failed to get sync files recursively: %v", err) log.Printf("Changing directory to %s%s%s (for %s%s%s)", PathColor, fileDir[1], DefaultColor, PathColor, file, DefaultColor)
status <- err err := os.Chdir(fileDir[1])
} if err != nil {
} log.Printf("Failed to change directory to %s%s%s: %s%+v%s", SourceColor, fileDir[1], DefaultColor, ErrorColor, err, DefaultColor)
}() return
}
for {
file, ok := <-files ReadFromFile(file, output, status, false)
if !ok { }()
LogInfo("No more files to process") }
break wg.Wait()
} }
wg.Add(1) func ReadFromFile(input string, output chan LinkInstruction, status chan error, doclose bool) {
go func() { if doclose {
defer wg.Done() defer close(output)
LogInfo(file) defer close(status)
file = NormalizePath(file, workdir) }
LogInfo("Processing file: %s", FormatPathValue(file))
input = NormalizePath(input)
// This "has" to be done because instructions are resolved in relation to cwd log.Printf("Reading input from file: %s%s%s", PathColor, input, DefaultColor)
fileDir := FileRegex.FindStringSubmatch(file) file, err := os.Open(input)
if fileDir == nil { if err != nil {
LogError("Failed to extract directory from %s", FormatSourcePath(file)) log.Fatalf("Failed to open file %s%s%s: %s%+v%s", SourceColor, input, DefaultColor, ErrorColor, err, DefaultColor)
return return
} }
LogInfo("Changing directory to %s (for %s)", defer file.Close()
FormatPathValue(fileDir[1]),
FormatPathValue(file)) scanner := bufio.NewScanner(file)
err := os.Chdir(fileDir[1]) for scanner.Scan() {
if err != nil { line := scanner.Text()
LogError("Failed to change directory to %s: %v", instruction, err := ParseInstruction(line)
FormatSourcePath(fileDir[1]), err) if err != nil {
return log.Printf("Error parsing line: %s'%s'%s, error: %s%+v%s", SourceColor, line, DefaultColor, ErrorColor, err, DefaultColor)
} continue
ReadFromFile(file, output, status, false) }
// Don't return directory, stay where we are log.Printf("Read instruction: %s", instruction.String())
os.Chdir(workdir) output <- instruction
}() }
} }
} func ReadFromArgs(output chan LinkInstruction, status chan error) {
defer close(output)
func ReadFromFile(input string, output chan *LinkInstruction, status chan error, doclose bool) { defer close(status)
if doclose {
defer close(output) log.Printf("Reading input from args")
defer close(status) for _, arg := range os.Args[1:] {
} instruction, err := ParseInstruction(arg)
if err != nil {
input = NormalizePath(input, filepath.Dir(input)) log.Printf("Error parsing arg: %s'%s'%s, error: %s%+v%s", SourceColor, arg, DefaultColor, ErrorColor, err, DefaultColor)
LogInfo("Reading input from file: %s", FormatPathValue(input)) continue
}
// Check if this is a YAML file output <- instruction
if IsYAMLFile(input) { }
LogInfo("Parsing as YAML file") }
instructions, err := ParseYAMLFile(input, filepath.Dir(input)) func ReadFromStdin(output chan LinkInstruction, status chan error) {
if err != nil { defer close(output)
LogError("Failed to parse YAML file %s: %v", defer close(status)
FormatSourcePath(input), err)
status <- err log.Printf("Reading input from stdin")
return
} info, err := os.Stdin.Stat()
if err != nil {
for _, instruction := range instructions { log.Fatalf("Failed to stat stdin: %s%+v%s", ErrorColor, err, DefaultColor)
instr := instruction // Create a copy to avoid reference issues status <- err
LogInfo("Read YAML instruction: %s", instr.String()) return
output <- &instr }
} if info.Mode()&os.ModeNamedPipe != 0 {
return scanner := bufio.NewScanner(os.Stdin)
} for scanner.Scan() {
} line := scanner.Text()
instruction, err := ParseInstruction(line)
func ReadFromArgs(output chan *LinkInstruction, status chan error) { if err != nil {
defer close(output) log.Printf("Error parsing line: %s'%s'%s, error: %s%+v%s", SourceColor, line, DefaultColor, ErrorColor, err, DefaultColor)
defer close(status) continue
}
workdir, _ := os.Getwd() output <- instruction
LogInfo("Reading input from args") }
for _, arg := range flag.Args() { if err := scanner.Err(); err != nil {
instruction, err := ParseInstruction(arg, workdir) log.Fatalf("Error reading from stdin: %s%+v%s", ErrorColor, err, DefaultColor)
if err != nil { status <- err
LogError("Error parsing arg '%s': %v", arg, err) return
continue }
} }
output <- &instruction }
}
}
func ReadFromStdin(output chan *LinkInstruction, status chan error) {
defer close(output)
defer close(status)
workdir, _ := os.Getwd()
LogInfo("Reading input from stdin")
scanner := bufio.NewScanner(os.Stdin)
for scanner.Scan() {
line := scanner.Text()
instruction, err := ParseInstruction(line, workdir)
if err != nil {
LogError("Error parsing line '%s': %v", line, err)
continue
}
output <- &instruction
}
if err := scanner.Err(); err != nil {
LogError("Error reading from stdin: %v", err)
status <- err
return
}
}

1
sync Normal file
View File

@@ -0,0 +1 @@
test,testdir/test3

View File

@@ -1,2 +0,0 @@
- source: \*
target: test/

View File

@@ -1,26 +0,0 @@
# Example sync.yaml file
# You can use this format to define symbolic links
# Each link specifies source, target, and optional flags
links:
- source: ~/Documents/config.ini
target: ~/.config/app/config.ini
# This will create a symbolic link, overwriting any existing symlink
force: true
- source: ~/Pictures
target: ~/Documents/Pictures
# This will create a hard link instead of a symbolic link
hard: true
force: true
- source: ~/Scripts/script.sh
target: ~/bin/script.sh
# This will delete a non-symlink file at the target location
# 'delete: true' implies 'force: true'
delete: true
# Alternative format:
# Instead of using the 'links' property, you can define an array directly:
# - source: ~/Documents/config.ini
# target: ~/.config/app/config.ini
# force: true

View File

@@ -1,26 +0,0 @@
18:24:37.967093 Using default sync.yaml file
18:24:37.967093 Input 'sync.yaml' is not absolute, prepending work dir '.'
18:24:37.967593 Reading input from file: C:/Users/Administrator/Seafile/Projects-Go/GoProjects/synclib/sync.yaml
18:24:37.967593 Parsing as YAML file
18:24:37.967593 Failed to parse YAML file C:/Users/Administrator/Seafile/Projects-Go/GoProjects/synclib/sync.yaml: error unmarshaling YAML: yaml: unmarshal errors:
line 1: cannot unmarshal !!seq into main.YAMLConfig
18:24:37.967593 No more instructions to process
18:24:37.968092 No instructions were processed
18:27:59.691333 Using default sync.yaml file
18:27:59.691333 Input 'sync.yaml' is not absolute, prepending work dir '.'
18:27:59.691834 Reading input from file: C:/Users/Administrator/Seafile/Projects-Go/GoProjects/synclib/sync.yaml
18:27:59.691834 Parsing as YAML file
18:27:59.692335 Expanding wildcard source \* in YAML file C:/Users/Administrator/Seafile/Projects-Go/GoProjects/synclib/sync.yaml
18:27:59.692335 Expanded wildcard source \* to 0 links
18:27:59.692836 Expanded wildcard source \* in YAML file C:/Users/Administrator/Seafile/Projects-Go/GoProjects/synclib/sync.yaml to 0 links
18:27:59.692836 No more instructions to process
18:27:59.692836 No instructions were processed
18:28:04.075821 Using default sync.yaml file
18:28:04.076320 Input 'sync.yaml' is not absolute, prepending work dir '.'
18:28:04.076320 Reading input from file: C:/Users/Administrator/Seafile/Projects-Go/GoProjects/synclib/sync.yaml
18:28:04.076320 Parsing as YAML file
18:28:04.076320 Expanding wildcard source \* in YAML file C:/Users/Administrator/Seafile/Projects-Go/GoProjects/synclib/sync.yaml
18:28:04.076821 Expanded wildcard source \* to 0 links
18:28:04.076821 Expanded wildcard source \* in YAML file C:/Users/Administrator/Seafile/Projects-Go/GoProjects/synclib/sync.yaml to 0 links
18:28:04.076821 No more instructions to process
18:28:04.076821 No instructions were processed

326
util.go
View File

@@ -1,187 +1,139 @@
package main package main
import ( import (
"fmt" "fmt"
"os" "log"
"path/filepath" "os"
"strings" "path/filepath"
"sync" "strings"
"sync/atomic" "sync"
"time" "sync/atomic"
) "time"
)
func IsSymlink(path string) (bool, error) {
fileInfo, err := os.Lstat(path) func IsSymlink(path string) (bool, error) {
if err != nil { fileInfo, err := os.Lstat(path)
return false, err if err != nil {
} return false, err
}
// os.ModeSymlink is a bitmask that identifies the symlink mode.
// If the file mode & os.ModeSymlink is non-zero, the file is a symlink. // os.ModeSymlink is a bitmask that identifies the symlink mode.
return fileInfo.Mode()&os.ModeSymlink != 0, nil // If the file mode & os.ModeSymlink is non-zero, the file is a symlink.
} return fileInfo.Mode()&os.ModeSymlink != 0, nil
}
func FileExists(path string) bool {
_, err := os.Lstat(path) func FileExists(path string) bool {
return err == nil _, err := os.Lstat(path)
} return err == nil
}
func NormalizePath(input, workdir string) string {
input = filepath.Clean(input) func NormalizePath(input string) string {
input = filepath.ToSlash(input) workingdirectory, _ := os.Getwd()
input = strings.ReplaceAll(input, "\"", "") input = strings.ReplaceAll(input, "\\", "/")
input = strings.ReplaceAll(input, "\"", "")
if !filepath.IsAbs(input) {
LogInfo("Input '%s' is not absolute, prepending work dir '%s'", input, workdir) if !filepath.IsAbs(input) {
var err error input = workingdirectory + "/" + input
input = filepath.Join(workdir, input) }
input, err = filepath.Abs(input)
if err != nil { return filepath.Clean(input)
LogError("Failed to get absolute path for %s: %v", FormatSourcePath(input), err) }
return input
} func AreSame(lhs string, rhs string) bool {
} lhsinfo, err := os.Stat(lhs)
if err != nil {
input = filepath.Clean(input) return false
input = filepath.ToSlash(input) }
return input rhsinfo, err := os.Stat(rhs)
} if err != nil {
return false
func AreSame(lhs string, rhs string) bool { }
lhsinfo, err := os.Stat(lhs)
if err != nil { return os.SameFile(lhsinfo, rhsinfo)
return false }
}
rhsinfo, err := os.Stat(rhs) func ConvertHome(input string) (string, error) {
if err != nil { if strings.Contains(input, "~") {
return false homedir, err := os.UserHomeDir()
} if err != nil {
return input, fmt.Errorf("unable to convert ~ to user directory with error %+v", err)
return os.SameFile(lhsinfo, rhsinfo) }
}
return strings.Replace(input, "~", homedir, 1), nil
func ConvertHome(input string) (string, error) { }
if strings.HasPrefix(input, "~/") { return input, nil
homedir, err := os.UserHomeDir() }
if err != nil {
return input, fmt.Errorf("unable to convert ~ to user directory with error %+v", err) func GetSyncFilesRecursively(input string, output chan string, status chan error) {
} defer close(output)
defer close(status)
return strings.Replace(input, "~", homedir, 1), nil
} var filesProcessed int32
return input, nil var foldersProcessed int32
} progressTicker := time.NewTicker(200 * time.Millisecond)
defer progressTicker.Stop()
func GetSyncFilesRecursively(input string, output chan string, status chan error) {
defer close(output) var wg sync.WaitGroup
defer close(status) var initial sync.Once
wg.Add(1)
var filesProcessed int32 directories := make(chan string, 100000)
var foldersProcessed int32 workerPool := make(chan struct{}, 4000)
var activeWorkers int32 directories <- input
progressTicker := time.NewTicker(200 * time.Millisecond) go func() {
defer progressTicker.Stop() for {
fmt.Printf("\rFiles processed: %d; Folders processed: %d; Workers: %d; Directory Stack Size: %d;", filesProcessed, foldersProcessed, len(workerPool), len(directories))
done := make(chan struct{}) <-progressTicker.C
defer close(done) }
}()
directories := make(chan string, 100000)
workerPool := make(chan struct{}, 4000) log.Printf("%+v", len(workerPool))
directories <- input go func() {
for directory := range directories {
go func() { workerPool <- struct{}{}
for { wg.Add(1)
select { go func(directory string) {
case <-progressTicker.C: atomic.AddInt32(&foldersProcessed, 1)
dirCount := len(directories) defer wg.Done()
workers := atomic.LoadInt32(&activeWorkers) defer func() { <-workerPool }()
fmt.Printf("\rFiles processed: %d; Folders processed: %d; Active workers: %d; Directory queue: %d",
atomic.LoadInt32(&filesProcessed), files, err := os.ReadDir(directory)
atomic.LoadInt32(&foldersProcessed), if err != nil {
workers, log.Printf("Error reading directory %s: %+v", directory, err)
dirCount) return
case <-done: }
// Final progress update
fmt.Printf("\nFiles processed: %d; Folders processed: %d; Completed successfully\n", for _, file := range files {
atomic.LoadInt32(&filesProcessed), // log.Printf("Processing file %s", file.Name())
atomic.LoadInt32(&foldersProcessed)) if file.IsDir() {
return directories <- filepath.Join(directory, file.Name())
} } else {
} // log.Println(file.Name(), DirRegex.MatchString(file.Name()))
}() if FileRegex.MatchString(file.Name()) {
// log.Printf("Writing")
allDone := make(chan struct{}) output <- filepath.Join(directory, file.Name())
}
go func() { atomic.AddInt32(&filesProcessed, 1)
// WTF is this waitgroup? }
// Nowhere is it added... }
var wg sync.WaitGroup // log.Printf("Done reading directory %s", directory)
go func() { initial.Do(func() {
for { // Parallelism is very difficult...
if atomic.LoadInt32(&activeWorkers) == 0 && len(directories) == 0 { time.Sleep(250 * time.Millisecond)
time.Sleep(10 * time.Millisecond) wg.Done()
if atomic.LoadInt32(&activeWorkers) == 0 && len(directories) == 0 { })
close(allDone) }(directory)
return }
} }()
}
time.Sleep(50 * time.Millisecond) // This actually does not go through ALL files sadly...
} // It so happens (very often) that we manage to quit between one iteration ending
}() // And another beginning
// In such a state workgroup is decreased and, before it has a chance to increase, we are done
for { // What I should do here is only terminate if directories is empty
select { // ...but how do I do that?
case directory, ok := <-directories: // I might be wrong... Fuck knows...
if !ok { wg.Wait()
wg.Wait() log.Printf("Files processed: %d; Folders processed: %d", filesProcessed, foldersProcessed)
return }
}
atomic.AddInt32(&activeWorkers, 1)
go func(dir string) {
workerPool <- struct{}{}
atomic.AddInt32(&foldersProcessed, 1)
processDirectory(dir, directories, output, &filesProcessed)
<-workerPool
atomic.AddInt32(&activeWorkers, -1)
}(directory)
}
}
}()
<-allDone
if atomic.LoadInt32(&filesProcessed) > 0 {
LogInfo("Files processed: %d; Folders processed: %d",
atomic.LoadInt32(&filesProcessed),
atomic.LoadInt32(&foldersProcessed))
}
}
func processDirectory(directory string, directories chan<- string, output chan<- string, filesProcessed *int32) {
files, err := os.ReadDir(directory)
if err != nil {
LogError("Error reading directory %s: %v", directory, err)
return
}
for _, file := range files {
if file.IsDir() {
directories <- filepath.Join(directory, file.Name())
} else {
if IsYAMLSyncFile(file.Name()) {
output <- filepath.Join(directory, file.Name())
}
atomic.AddInt32(filesProcessed, 1)
}
}
}
func IsYAMLSyncFile(filename string) bool {
return filename == "sync.yaml" || filename == "sync.yml"
}