-
Notifications
You must be signed in to change notification settings - Fork 0
/
batch-rename.go
369 lines (306 loc) · 10.2 KB
/
batch-rename.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
102
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
145
146
147
148
149
150
151
152
153
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
183
184
185
186
187
188
189
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
/*
batch-rename.go
A small program to handle batch renames and copies.
Author: Ysgard (Jan Van Uytven) 2013
*/
package main
import (
"flag"
"fmt"
"os"
//"ioutil" // For ReadDir
"path/filepath"
"regexp"
//"github.com/jteeuwen/go-pkg-optarg" optarg
"errors"
"io" // Needed for file copy
"strings"
)
// Why do I have to use "MustCompile"? Why does a simple Compile raise an error?
var defaultFileMatch = regexp.MustCompile(`^([a-zA-Z0-9\s\._-]+)$`)
var usageString = `
batch-rename (-p <prefix>|-s <suffix>|-e <name>) [-x <regex>] [-t <target_dir>] -[crn] -[l|u]
batch-rename will construct a list of all files that match a given regex,
or all files in the directory, and rename/copy them to a matching file
that is modified according to the specified prefix or suffix.
For example, 'batch-rename' -prefix to_sort_ -regex "/.png$/"' will
rename all files matching .png in the current directory to
'to_sort_<oldname>.png'.
Arguments:
-regex|-x <regex>
A regular expression for matching files. You can use "/<regex>/" or
"<regex>", but the double-quotes are necessary.
-prefix|-p <prefix>
Renames matching files to have the specified prefix.
-suffix|-s <suffix>
Renames matching files to have the specified suffix.
-enumerate|-e <name>
Rename matching files to <name>_<num>, where <num> is
incremented from 000.
-target-dir|-t <path>
The directory within which we rename/copy. Default is the current
working directory.
-copy|-c
Copy instead of rename.
-recurse|-r
Search for matching files in subdirectories.
-lowercase|-l
Lowercase the final rename. (Can't be used with '-u')
-uppercase|-u
Uppercase the final rename. (Can't be used with '-l')
-dry-run|-n
List files, but don't copy/rename
-force|-for
If the file exists, overwrite. Default is to not copy/rename
if the target file already exists.
}
`
var regexArg string
var fileRegex *regexp.Regexp
var prefixArg string
var suffixArg string
var enumerateArg string
var targetArg string
var copyArg bool
var recurseArg bool
var lowerArg bool
var upperArg bool
var dryrunArg bool
var forceArg bool
// Just return the concatenation of the prefix and the filename.
func prefixName(name, prefix string) string {
return prefix + name
}
// Add a suffix to a filename, being careful to remove and re-add the extension
// on it (if it exists).
func suffixName(name, suffix string) string {
ext := filepath.Ext(name)
raw_base := strings.TrimSuffix(filepath.Base(name), ext)
return raw_base + suffix + ext
}
// enumerated files take the form <name>_<dddd>.<ext>
func enumerateName(name, newname string, count int) string {
ext := filepath.Ext(name)
return fmt.Sprintf("%s_%04d.%s", newname, count, ext)
}
// Call before parsing flags
func flagInit() {
// redefine flag's Usage function
flag.Usage = func() {
fmt.Fprintf(os.Stderr, usageString)
}
const (
regex_default = ""
prefix_default = ""
suffix_default = ""
enumerate_default = ""
target_default = ""
copy_default = false
recurse_default = false
lowercase_default = false
uppercase_default = false
dryrun_default = false
force_default = false
)
flag.StringVar(®exArg, "regex", regex_default, "")
flag.StringVar(®exArg, "x", regex_default, "")
flag.StringVar(&prefixArg, "prefix", prefix_default, "")
flag.StringVar(&prefixArg, "p", prefix_default, "")
flag.StringVar(&suffixArg, "suffix", suffix_default, "")
flag.StringVar(&suffixArg, "s", suffix_default, "")
flag.StringVar(&enumerateArg, "enumerate", enumerate_default, "")
flag.StringVar(&enumerateArg, "e", enumerate_default, "")
flag.StringVar(&targetArg, "target-dir", target_default, "")
flag.StringVar(&targetArg, "t", target_default, "")
flag.BoolVar(©Arg, "copy", copy_default, "")
flag.BoolVar(©Arg, "c", copy_default, "")
flag.BoolVar(&recurseArg, "recurse", recurse_default, "")
flag.BoolVar(&recurseArg, "r", recurse_default, "")
flag.BoolVar(&lowerArg, "lowercase", lowercase_default, "")
flag.BoolVar(&lowerArg, "l", lowercase_default, "")
flag.BoolVar(&upperArg, "uppercase", uppercase_default, "")
flag.BoolVar(&upperArg, "u", uppercase_default, "")
flag.BoolVar(&dryrunArg, "dry-run", dryrun_default, "")
flag.BoolVar(&dryrunArg, "n", dryrun_default, "")
flag.BoolVar(&forceArg, "f", force_default, "")
flag.BoolVar(&forceArg, "force", force_default, "")
flag.Parse()
}
func usage(msg string) {
fmt.Fprintf(os.Stderr, msg+"\n")
fmt.Fprintf(os.Stderr, usageString)
os.Exit(0)
}
// Build a list of all files that match the regex, and then walk
// them and rename them as we go.
func processFiles() (int, error) {
var targetDir string
if targetArg != "" {
targetDir = targetArg // If target specified, use it
} else {
var err error
targetDir, err = os.Getwd()
if err != nil {
fmt.Fprintf(os.Stderr, "Could not determine current directory! Please specify target directory with -t.")
return 0, err
}
}
// Make sure the target directory is a valid one
if dinfo, err := os.Lstat(targetDir); err != nil || dinfo.IsDir() == false {
err = errors.New(fmt.Sprintf("Target directory %s is not a directory?\n", targetDir))
fmt.Fprintf(os.Stderr, err.Error())
return 0, err
}
fmt.Fprintf(os.Stderr, "Target directory is : %s\n", targetDir)
// Process each file & return the results
fCount, err := processDir(targetDir)
return fCount, err
}
func processDir(dirname string) (int, error) {
var count, counter int // count is how many files were successfully counted, counter is for enum
var return_msg string
var return_err error
dp, open_err := os.Open(dirname)
if open_err != nil {
fmt.Fprintf(os.Stderr, open_err.Error())
return 0, open_err
}
defer dp.Close()
files, read_err := dp.Readdir(0)
if read_err != nil {
return_msg += read_err.Error() + "\n"
}
for _, f := range files {
if f.IsDir() == true && recurseArg == true {
dir_count, dir_err := processDir(filepath.Join(dirname, f.Name()))
if dir_err != nil {
return_msg += dir_err.Error() + "\n"
}
count += dir_count
} else if f.IsDir() == true && recurseArg == false {
continue
} else {
file_count, file_err := processFile(filepath.Join(dirname, f.Name()), counter)
if file_err != nil {
return_msg += file_err.Error() + "\n"
}
count += file_count
counter++
}
}
if return_msg == "" {
return_err = nil
} else {
return_err = errors.New(return_msg)
}
return count, return_err
}
// Rename/Copy a file based on global arguments.
func processFile(name string, currentCount int) (int, error) {
base := filepath.Base(name)
path := filepath.Dir(name)
if fileRegex != nil {
// Check to see whether file matches, exit if it doesn't
if fileRegex.MatchString(base) == false {
return 0, nil
}
}
// Order is - enumerate, suffix, prefix.
var newName, outputMsg string
ext := filepath.Ext(name)
newName = strings.TrimSuffix(filepath.Base(name), ext)
if enumerateArg != "" {
newName = fmt.Sprintf("%s_%04d", enumerateArg, currentCount)
}
if suffixArg != "" {
newName = newName + suffixArg
}
if prefixArg != "" {
newName = prefixArg + newName
}
// Uppercase/lowercase if the user requested it
if upperArg == true {
newName = strings.ToUpper(newName)
}
if lowerArg == true {
newName = strings.ToLower(newName)
}
newName = filepath.Join(path, newName+ext)
// Check to see if the renamed file exists. If it does, what
// we do next depends on whether or not the force flag is applied
_, fileInfoErr := os.Lstat(newName)
if fileInfoErr == nil && forceArg == false { // file does exist & force is not set
fmt.Fprintf(os.Stderr, "File %s already exists, not copying/renaming. Use --force to override\n", newName)
return 0, nil
}
// Copy/Rename the file
if copyArg == true {
outputMsg = fmt.Sprintf("Copying %s to %s...\n", name, newName)
} else {
outputMsg = fmt.Sprintf("Renaming %s to %s...\n", name, newName)
}
fmt.Fprintf(os.Stdout, outputMsg)
if dryrunArg == true {
return 0, nil
} else {
if copyArg == true {
copyFile, openFileErr := os.Create(newName)
if openFileErr != nil {
return 0, openFileErr
}
srcFile, openFileErr := os.Open(name)
if openFileErr != nil {
return 0, openFileErr
}
io.Copy(copyFile, srcFile)
return 1, nil
} else {
if rename_err := os.Rename(name, newName); rename_err != nil {
return 0, rename_err
}
return 1, nil
}
}
}
func main() {
// Get the command-line arguments
flagInit()
// Sanity check - no upper with lower
if lowerArg == true && upperArg == true {
usage("Cannot combine -u (uppercase) and -l (lowercase) flags")
}
// We require at least one of 'prefix', 'suffix' or 'enumerate', otherwise
// we don't know how to rename.
if prefixArg == "" && suffixArg == "" && enumerateArg == "" {
usage("Specify one of -p <prefix>, -s <suffix> or -e <enumerate>")
}
// Some people like to bracket a regex with '/'. Strip these out, if found
regexArg = strings.TrimLeft(strings.TrimRight(regexArg, "/"), "/")
// Print out the values of each argument
fmt.Fprintf(os.Stdout, "regexArg: "+regexArg+"\n")
fmt.Fprintf(os.Stdout, "prefixArg: "+prefixArg+"\n")
fmt.Fprintf(os.Stdout, "suffixArg: "+suffixArg+"\n")
fmt.Fprintf(os.Stdout, "enumerateArg: "+enumerateArg+"\n")
fmt.Fprintf(os.Stdout, "targetArg: "+targetArg+"\n")
fmt.Fprintf(os.Stdout, "copyArg: %b\n", copyArg)
fmt.Fprintf(os.Stdout, "recurseArg: %b\n", recurseArg)
fmt.Fprintf(os.Stdout, "lowerArg: %b\n", lowerArg)
fmt.Fprintf(os.Stdout, "upperArg: %b\n", upperArg)
fmt.Fprintf(os.Stdout, "dryrunArg: %b\n", dryrunArg)
// Compile the passed regex, if any
if regexArg != "" {
var err error
fileRegex, err = regexp.Compile(regexArg)
if err != nil {
fmt.Fprintf(os.Stderr, "Invalid regex: %s\n", regexArg)
fmt.Fprintf(os.Stderr, "Cannot continue, quitting...")
os.Exit(1)
}
}
fCount, err := processFiles()
if err == nil {
fmt.Fprintf(os.Stdout, "\nOperation complete: %d files renamed/copied\n", fCount)
} else {
fmt.Fprintf(os.Stdout, "\nOperation could not be completed: %s\n", err.Error())
}
}