/
git.vi
executable file
·541 lines (478 loc) · 21.7 KB
/
git.vi
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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
#!/bin/bash
#------------------------------------------------------------------------------#
# vi: set sw=4 ts=4 ai: ("set modeline" in ~/.exrc) #
#------------------------------------------------------------------------------#
# Program : git.vi #
# #
# Author : Ton Kersten Groesbeek, The Netherlands #
# #
# Date : 23-01-2009 Time : 12:18 #
# #
# Description : Program to edit files and commit them to git #
# #
# Parameters : The files #
# -m <The commit message> #
# -e -> Do not start the Editor #
# #
# Pre reqs : Git should be installed, working and in your path #
# #
# Exit codes : 0 -> OK #
# <> 0 -> !OK #
#------------------------------------------------------------------------------#
#------------------------------------------------------------------------------#
# V e r s i o n i n f o r m a t i o n #
#------------------------------------------------------------------------------#
# $Id:: git.vi 56 2011-09-21 14:58:02 tonk $: #
# $Revision:: 56 $: #
# $Author:: Ton Kersten <github@tonkersten.com> $: #
# $Date:: 2011-09-21 14:59:20 +0200 (Wed, 21 Sep 2011) $: #
# $Hash:: $: #
#------------------------------------------------------------------------------#
# E n d o f v e r s i o n i n f o r m a t i o n #
#------------------------------------------------------------------------------#
#------------------------------------------------------------------------------#
# Configuration #
#------------------------------------------------------------------------------#
# use this maildomain if no info could be found
maildomain=example.com
#------------------------------------------------------------------------------#
# Determine the program name and the 'running directory' #
#------------------------------------------------------------------------------#
IAM="${0##*/}"
CRD="$( [[ "${0:0:2}" = "./" ]] &&
{ printf "${PWD}/${0#./}"
} || {
printf "${0}"
})"
CRD="${CRD%/*}"
CUR="${PWD}"
#------------------------------------------------------------------------------#
# Save the shell settings #
#------------------------------------------------------------------------------#
SETA=0; [[ ${-} = *a* ]] && SETA=1
SETE=0; [[ ${-} = *e* ]] && SETE=1
SETU=0; [[ ${-} = *u* ]] && SETU=1
SETX=0; [[ ${-} = *x* ]] && SETX=1
#------------------------------------------------------------------------------#
# Set and unset the needed shell settings #
#------------------------------------------------------------------------------#
set +o noclobber # Overwrite existing files, if needed #
set -o nounset # Dont allow uninitialized variables #
set +o errexit # No returncode checking #
#============================== Function "Usage" ==============================#
Usage()
{
#+-------------------------------------------------------------------------#
# Function : Usage #
# #
# Description : Display the syntax of this program #
# #
# Parameters : None #
# #
# Returns : Exits with RC = 1 #
#-------------------------------------------------------------------------+#
T=" "
cat <<- @EOF
vi and git combiner editor
Usage: ${IAM} [-h] [-a] [-m "message"] [-e] file <file> ...
Options:
${T}-h Display this message
${T}-a All files will be committed with the same commit message.
${T} This message is the first file to be edited.
${T}-m All files will be committed with the same commit message.
${T} This message should be supplied on the command line.
${T}-e Do not edit the file(s).
${T} This is very usefull for automatic checkins
This program works best when used with git filters, such as the
'git-edit' filter.
See my blog on how to use this (http://tonkersten.com)
${T}Examples:
${T}${T}${IAM} -m "Changed the version number" *.cfg
${T}or
${T}${T}${IAM} -a *.cfg
If both the '-m' and '-a' option are given, the '-m' has precedence.
@EOF
exit 1
}
#========================== End of function "Usage" ===========================#
#============================== Function "IsNum" ==============================#
IsNum()
{
#+-------------------------------------------------------------------------#
# Function : IsNum #
# #
# Description : Check if a supplied parameters is numeric #
# #
# Parameters : $1 -> Parameter to check #
# #
# Returns : RC=0: Numeric. Otherwise not numeric #
#-------------------------------------------------------------------------+#
case $1 in
"") return 1 ;;
*[!0-9]*) return 1 ;;
*) return 0 ;;
esac
}
#========================== End of function "IsNum" ===========================#
#------------------------------------------------------------------------------#
# No git, no glory #
#------------------------------------------------------------------------------#
[[ x"$(which git 2>/dev/null)" = x"" ]] &&
{ echo "No 'git' found. Please use plain vi(m)"
exit 1
}
spc="$(printf "%80s" "")"
#------------------------------------------------------------------------------#
# Who are we #
#------------------------------------------------------------------------------#
who=${SUDO_USER:-${LOGNAME}}
#------------------------------------------------------------------------------#
# Set the TEMP dir #
#------------------------------------------------------------------------------#
export TMP=${TMPDIR:-/tmp}
#------------------------------------------------------------------------------#
# Try to get the user info from git #
#------------------------------------------------------------------------------#
host=$(hostname -s)
if [[ -f ${HOME}/.gitconfig ]]
then
full=$( git config --get user.name)
email=$(git config --get user.email)
host=$(git config --get user.hostname)
[[ x"${host}" = x"" ]] && host=$(hostname -s)
fi
#------------------------------------------------------------------------------#
# Try to get the user info from environment variables #
#------------------------------------------------------------------------------#
if [[ "${GIT_AUTHOR_NAME:?}" ]] && [[ "${GIT_AUTHOR_EMAIL:?}" ]]
then
full="$GIT_AUTHOR_NAME"
email="$GIT_AUTHOR_EMAIL"
fi
#------------------------------------------------------------------------------#
# If no info was found, make up your own #
#------------------------------------------------------------------------------#
if [[ x"${full:-}" = x"" ]]
then
full=$(getent passwd ${who} | awk -F: '{ gsub(/,*/, ""); print $5 }')
email="${who}@${maildomain}"
fi
author="${full} <${email}>"
#------------------------------------------------------------------------------#
# Get the commandline options #
#------------------------------------------------------------------------------#
options=":haem:"
commitall=0
cmtmsg=""
editit=1
while getopts ${options} opts
do
case "${opts}"
in
a)
#------------------------------------------------------------------#
# Commit all files with the same commit message (With editor) #
#------------------------------------------------------------------#
commitall=1
;;
m)
#------------------------------------------------------------------#
# Commit all files with the same commit message (Without editor) #
#------------------------------------------------------------------#
cmtmsg="${OPTARG}"
;;
e)
#------------------------------------------------------------------#
# Edit it, or just continue #
#------------------------------------------------------------------#
editit=0
;;
h)
#------------------------------------------------------------------#
# Display help #
#------------------------------------------------------------------#
Usage
exit ${OK}
;;
*)
#------------------------------------------------------------------#
# Display the usage #
#------------------------------------------------------------------#
Usage
exit 1
esac
done
[[ x"${cmtmsg}" != x"" ]] && commitall=0
#------------------------------------------------------------------------------#
# Shift away processed options #
#------------------------------------------------------------------------------#
shift $(( ${OPTIND} - 1 ))
#------------------------------------------------------------------------------#
# Do we have files on the command line? If not, it's no use #
#------------------------------------------------------------------------------#
[[ x"${@:-}" = x"" ]] && Usage
#------------------------------------------------------------------------------#
# Set the editor #
#------------------------------------------------------------------------------#
if [[ x"${EDITOR:-}" = x"" ]]
then
EDIT="$(type -p vi 2>/dev/null)"
if [[ ${?} = 0 ]]
then
EDITOR="${EDIT//* }"
elif [[ -x /bin/vi ]]
then
EDITOR="/bin/vi"
elif [[ -x /usr/bin/vi ]]
then
EDITOR="/usr/bin/vi"
elif [[ -x /usr/bin/vi ]]
then
EDITOR="/usr/local/bin/vi"
fi
fi
#------------------------------------------------------------------------------#
# If all files should have the same commitmessage, create it now #
#------------------------------------------------------------------------------#
commitfile="${TMP}/${IAM}_commit.${$}"
if [[ ${commitall} = 1 ]]
then
cat <<- @EOF > ${commitfile}
# This file is the general commit file for ${IAM}
# Please type the general commit text for all files.
#
# Comment lines starting with '#' will not be included.
#
# Affected files: ${@}
@EOF
${EDITOR} ${commitfile}
fi
#------------------------------------------------------------------------------#
# Do we have a umask configured. If so, set it #
#------------------------------------------------------------------------------#
gitowner=$(git config gitvi.owner)
gitgroup=$(git config gitvi.group)
gitumask=$(git config gitvi.umask)
gitlang=$( git config gitvi.lang)
[[ x"${gitowner}" = x"" ]] && gitowner="${USER}"
[[ x"${gitgroup}" = x"" ]] && gitgroup="$(id -g)"
[[ x"${gitumask}" = x"" ]] && gitumask="$(umask)"
[[ x"${gitlang}" = x"" ]] && gitlang="en"
umask ${gitumask}
#------------------------------------------------------------------------------#
# Proces all files #
#------------------------------------------------------------------------------#
case "${gitlang}"
in
en) automsg="Automatic checkin by '${IAM}'"
;;
nl) automsg="Automatische checkin door '${IAM}'"
;;
*) automsg="Automatic checkin by '${IAM}'"
;;
esac
for file in "${@}"
do
dir="$(dirname "${file}")"
base="$(basename "${file}")"
[[ ! -d "${dir}" ]] &&
{ echo "Cannot change to a non existing directory" >&2
cd - >/dev/null 2>&1
continue
}
[[ -d "${file}" ]] &&
{ echo "Cannot edit a directory" >&2
cd - >/dev/null 2>&1
continue
}
cd "${dir}"
#--------------------------------------------------------------------------#
# Find the top of the git tree #
#--------------------------------------------------------------------------#
GIT_TOP="$(git rev-parse --git-dir 2>/dev/null | sed 's/\.git$//')"
#--------------------------------------------------------------------------#
# Check if this directory is part of a git tree. If not, create one #
#--------------------------------------------------------------------------#
if [[ x"${GIT_TOP}" = x"" ]]
then
#----------------------------------------------------------------------#
# Make a new one in ${PWD} #
#----------------------------------------------------------------------#
git init || exit 1
GIT_TOP="$(pwd)"
fi
#--------------------------------------------------------------------------#
# Get the rights (if possible) #
#--------------------------------------------------------------------------#
if [[ -f "${base}" ]]
then
rights=$(stat -c "%a" "${base}")
chmod +w "${base}" 2>/dev/null
else
rights=$(( 666 - ${gitumask} ))
fi
#--------------------------------------------------------------------------#
# Create a nice filename #
#--------------------------------------------------------------------------#
GIT_FNAME="$(echo "$(pwd)/${base}" | sed -e "s!^${GIT_TOP}!.../!" -e "s!//!/!g")"
GIT_FNAME="${host}:${GIT_FNAME}"
#--------------------------------------------------------------------------#
# Determine the filetype and comment length #
#--------------------------------------------------------------------------#
GIT_LEN=66
case ${base}
in
*.c) GIT_LEN=64 ;;
*.h) GIT_LEN=64 ;;
*.go) GIT_LEN=64 ;;
*.js) GIT_LEN=64 ;;
*.pas) GIT_LEN=64 ;;
*.php) GIT_LEN=64 ;;
*.css) GIT_LEN=64 ;;
*.html) GIT_LEN=60 ;;
esac
export GIT_TOP GIT_LEN GIT_FNAME
#--------------------------------------------------------------------------#
# Edit the file #
#--------------------------------------------------------------------------#
if [[ ${editit} = 1 ]]
then
${EDITOR} "${base}"
fi
#----------------------------------------------------------------------#
# Did we put something usefull in it #
#----------------------------------------------------------------------#
[[ ! -s "${base}" ]] && exit 0
#----------------------------------------------------------------------#
# Check if the file is already in git #
#----------------------------------------------------------------------#
initial=0
ingit=$(git ls-files ${base} | wc -l)
[[ ${ingit} = 0 ]] &&
{ git add "${base}"
git commit --author "${author}" -m "${automsg}" "${base}"
initial=1
}
#----------------------------------------------------------------------#
# If we didn't make any changes, the repo and this one are the same #
#----------------------------------------------------------------------#
diff=$(git diff "${base}" 2>&1)
[[ x"${diff}" = x"" ]] &&
{ if [[ ${initial} = 0 ]]
then
cd - >/dev/null 2>&1
continue
fi
}
rm -f "${TMP}/${base}.bck"
#----------------------------------------------------------------------#
# Give the file a new version number (while we are at it) #
#----------------------------------------------------------------------#
if [[ ( $(grep -c "[[:space:]]*\$[I]d::.*\$:" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[R]evision::.*\$:" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[A]uthor::.*\$:" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[D]ate::.*\$:" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[F]name::.*\$:" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[U]RL::.*\$:" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[I]d:[^:].*\$" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[R]evision:[^:].*\$" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[A]uthor:[^:].*\$" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[D]ate:[^:].*\$" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[F]name:[^:].*\$" "${base}") != 0 ) ||
( $(grep -c "[[:space:]]*\$[U]RL:[^:].*\$" "${base}") != 0 ) ]]
then
datim=$(stat -c"%y" "${base}" | cut -d '.' -f1)
newrev="$(awk '/[[:space:]]*\$[R]evision::/ { print $3; exit }' "${base}")"
if [[ ( x"${newrev}" = x"" ) || ( x"${newrev}" = x"\$:" ) ]]
then
# Revision tag not found. Maybe Id will help
newrev="$(awk '/[[:space:]]*\$[I]d:.*\$/ { print $4; exit }' "${base}")"
fi
[[ x"${newrev}" = x"\$:" || x"${newrev}" = x"#" || x"${newrev}" = x"" ]] && newrev=0
IsNum "${newrev}" || newrev=0
newrev="$(( ${newrev} + 1 ))"
id="${base##*/} ${newrev} ${datim} ${who}"
f="${base##*/} ${newrev} ${datim} ${who} ${spc}"
newrevns="${newrev}"
newrev="${newrev}${spc}"
nam="${author}${spc}"
namns="${author}"
GIT_SHORT="${GIT_FNAME}"
GIT_FNAME="${GIT_FNAME}${spc}"
now="$(date '+%F %T %z (%a, %d %b %Y)') ${spc}"
nowns="$(date '+%F %T %z (%a, %d %b %Y)')"
#------------------------------------------------------------------#
# Prepare the header strings #
#------------------------------------------------------------------#
L0=$(( ${GIT_LEN} + 0 ))
L1=$(( ${GIT_LEN} + 2 ))
L2=$(( ${GIT_LEN} - 2 ))
L3=$(( ${GIT_LEN} - 4 ))
L4=$(( ${GIT_LEN} - 1 ))
cp "${base}" "${TMP}/${base}.bck"
sed -e 's!\([[:space:]]*\$[I]d::\).*\$:!\1 '"${f:0:${L1}}"'\$:!' \
-e 's!\([[:space:]]*\$[R]evision::\).*\$:!\1 '"${newrev:0:${L3}}"'\$:!' \
-e 's!\([[:space:]]*\$[A]uthor::\).*\$:!\1 '"${nam:0:${L2}}"'\$:!' \
-e 's!\([[:space:]]*\$[D]ate::\).*\$:!\1 '"${now:0:${L0}}"'\$:!' \
-e 's!\([[:space:]]*\$[F]name::\).*\$:!\1 '"${GIT_FNAME:0:${L4}}"'\$:!' \
-e 's!\([[:space:]]*\$[U]RL::\).*\$:!\1 '"${GIT_FNAME:0:${L4}}"'\$:!' \
-e 's!\([[:space:]]*\$[I]d:[^:]\).*\$!\1'"${id}"' \$!' \
-e 's!\([[:space:]]*\$[R]evision:[^:]\).*\$!\1'"${newrevns}"' \$!' \
-e 's!\([[:space:]]*\$[A]uthor:[^:]\).*\$!\1'"${namns}"' \$!' \
-e 's!\([[:space:]]*\$[D]ate:[^:]\).*\$!\1'"${nowns}"' \$!' \
-e 's!\([[:space:]]*\$[F]name:[^:]\).*\$!\1'"${GIT_SHORT//* }"' \$!' \
-e 's!\([[:space:]]*\$[U]RL:[^:]\).*\$!\1'"${GIT_SHORT//* }"' \$!' \
"${TMP}/${base}.bck" > "${base}"
rm -f "${TMP}/${base}.bck"
fi
#----------------------------------------------------------------------#
# Commit the file to git #
#----------------------------------------------------------------------#
if [[ ${commitall} = 1 ]]
then
cl=$(grep -v '^[[:space:]]*#' ${commitfile} | grep -v '^[[:space:]]*$' | wc -l)
[[ ${cl} = 0 ]] &&
{ echo "Cannot continue with an empty commit message!" >&2
cd - >/dev/null 2>&1
continue
}
grep -v '^[[:space:]]*#' ${commitfile} | \
git commit -F - --author "${author}" "${base}"
else
if [[ x"${cmtmsg}" = x"" ]]
then
cat <<- @EOF > ${commitfile}
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# Changes to be committed:
# (use "git rm --cached <file>..." to unstage)
#
# Affected files: ${@}
#
@EOF
${EDITOR} ${commitfile}
cl=$(grep -v '^[[:space:]]*#' ${commitfile} | grep -v '^[[:space:]]*$' | wc -l)
[[ ${cl} = 0 ]] &&
{ echo "Cannot continue with an empty commit message!" >&2
cd - >/dev/null 2>&1
continue
}
grep -v '^[[:space:]]*#' ${commitfile} | \
git commit -F - --author "${author}" "${base}"
else
git commit --author "${author}" -m "${cmtmsg}" "${base}"
fi
fi
#----------------------------------------------------------------------#
# And check it out again to apply the smudge filters #
#----------------------------------------------------------------------#
mv "${base}" "${TMP}/${base}.bck"
git checkout "${base}"
[[ -f "${base}" ]] && rm -f "${TMP}/${base}.bck" || mv "${TMP}/${base}.bck" "${base}"
chown ${gitowner} "${base}" > /dev/null 2>&1
chgrp ${gitgroup} "${base}" > /dev/null 2>&1
chmod ${rights} "${base}" > /dev/null 2>&1
cd - >/dev/null 2>&1
done
[[ -f ${commitfile} ]] && rm -f ${commitfile}