File: sh.subst

package info (click to toggle)
shtool 2.0.8-10
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 808 kB
  • sloc: perl: 399; makefile: 110; sh: 42
file content (301 lines) | stat: -rw-r--r-- 8,538 bytes parent folder | download | duplicates (3)
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
##
##  subst -- Apply sed(1) substitution operations
##  Copyright (c) 2001-2008 Ralf S. Engelschall <rse@engelschall.com>
##
##  This file is part of shtool and free software; you can redistribute
##  it and/or modify it under the terms of the GNU General Public
##  License as published by the Free Software Foundation; either version
##  2 of the License, or (at your option) any later version.
##
##  This file is distributed in the hope that it will be useful,
##  but WITHOUT ANY WARRANTY; without even the implied warranty of
##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
##  General Public License for more details.
##
##  You should have received a copy of the GNU General Public License
##  along with this program; if not, write to the Free Software
##  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
##  USA, or contact Ralf S. Engelschall <rse@engelschall.com>.
##

str_tool="subst"
str_usage="[-v|--verbose] [-t|--trace] [-n|--nop] [-w|--warning] [-q|--quiet] [-s|--stealth] [-i|--interactive] [-b|--backup <ext>] [-e|--exec <cmd>] [-f|--file <cmd-file>] [<file>] [...]"
gen_tmpfile=yes
arg_spec="0+"
opt_spec="v.t.n.w.q.s.i.b:e+f:"
opt_alias="v:verbose,t:trace,n:nop,w:warning,q:quiet,s:stealth,i:interactive,b:backup,e:exec,f:file"
opt_v=no
opt_t=no
opt_n=no
opt_w=no
opt_q=no
opt_s=no
opt_i=no
opt_b=""
opt_e=""
opt_f=""

. ./sh.common

#   remember optional list of file(s)
files="$*"
files_num="$#"

#   parameter consistency check
if [ $# -eq 0 ] && [ ".$opt_b" != . ]; then
    echo "$msgprefix:Error: option -b cannot be applied to stdin" 1>&2
    shtool_exit 1
fi
if [ $# -eq 0 ] && [ ".$opt_s" = .yes ]; then
    echo "$msgprefix:Error: option -s cannot be applied to stdin" 1>&2
    shtool_exit 1
fi

#   build underlying sed(1) command
sedcmd='sed'
if [ ".$opt_e" != . ]; then
    OIFS="$IFS"; IFS="$ASC_NL"; set -- $opt_e; IFS="$OIFS"
    for e
    do
        sedcmd="$sedcmd -e '$e'"
    done
elif [ ".$opt_f" != . ]; then
    if [ ! -f $opt_f ]; then
        echo "$msgprefix:Error: command file \`$opt_f' not found or not a regular file" 1>&2
        shtool_exit 1
    fi
    sedcmd="$sedcmd -f '$opt_f'"
else
    echo "$msgprefix:Error: either -e option(s) or -f option required" 1>&2
    shtool_exit 1
fi

#   determine extension for original file
orig=".orig"
if [ ".$opt_b" != . ]; then
    orig="$opt_b"
fi

#   apply sed(1) operation(s)
if [ ".$files" != . ]; then
    #   apply operation(s) to files
    substdone=no
    for file in $files; do
        test ".$file" = . && continue
        if [ ! -f $file ]; then
            echo "$msgprefix:Warning: file \`$file' not found or not a regular file" 1>&2
            continue
        fi

        #   handle interactive mode
        if [ ".$opt_i" = .yes ]; then
            eval "$sedcmd <$file >$file.new"
            skip=no
            if cmp $file $file.new >/dev/null 2>&1; then
                rm -f $file.new
                skip=yes
            else
                (diff -U1 $file $file.new >$tmpfile) 2>/dev/null
                if [ ".`cat $tmpfile`" = . ]; then
                    (diff -C1 $file $file.new >$tmpfile) 2>/dev/null
                    if [ ".`cat $tmpfile`" = . ]; then
                        echo "$msgprefix:Warning: unable to show difference for file \`$file'" 1>&2
                        cp /dev/null $tmpfile
                    fi
                fi
                rm -f $file.new
                cat $tmpfile
                echo dummy | awk '{ printf("%s", TEXT); }' TEXT=">>> Apply [Y/n]: "
                read input
                if [ ".$input" != .Y ] &&\
                   [ ".$input" != .y ] &&\
                   [ ".$input" != . ]; then
                   skip=yes
                fi
            fi
            if [ ".$skip" = .yes ]; then
                if [ ".$opt_v" = .yes ]; then
                    echo "file \`$file' -- skipped" 1>&2
                fi
                continue
            fi
        fi

        #   apply sed(1) operation(s)
        if [ ".$opt_v" = .yes ]; then
            echo "patching \`$file'" 1>&2
        fi
        if [ ".$opt_t" = .yes ]; then
            echo "\$ cp -p $file $file$orig"
            echo "\$ chmod u+w $file"
            echo "\$ $sedcmd <$file$orig >$file"
        fi
        if [ ".$opt_n" = .no ]; then
            cp -p $file $file$orig
            chmod u+w $file >/dev/null 2>&1 || true
            eval "$sedcmd <$file$orig >$file"
        fi

        #   optionally fix timestamp
        if [ ".$opt_s" = .yes ]; then
            if [ ".$opt_t" = .yes ]; then
                echo "\$ touch -r $file$orig $file"
            fi
            if [ ".$opt_n" = .no ]; then
                touch -r $file$orig $file
            fi
        fi

        #   optionally check whether any content change actually occurred
        if [ ".$opt_q" = .no ]; then
            if cmp $file$orig $file >/dev/null 2>&1; then
                if [ ".$opt_w" = .yes ]; then
                    echo "$msgprefix:Warning: substitution resulted in no content change on file \"$file\"" 1>&2
                fi
            else
                substdone=yes
            fi
        fi

        #   optionally remove preserved original file
        if [ ".$opt_b" = . ]; then
            if [ ".$opt_t" = .yes ]; then
                echo "\$ rm -f $file$orig"
            fi
            if [ ".$opt_n" = .no ]; then
                rm -f $file$orig
            fi
        fi
    done
    if [ ".$opt_q" = .no ] && [ ".$opt_w" = .no ]; then
        if [ ".$substdone" = .no ]; then
            if [ ".$files_num" = .1 ]; then
                echo "$msgprefix:Warning: substitution resulted in no content change on file \"$file\"" 1>&2
            else
                echo "$msgprefix:Warning: substitution resulted in no content change on any file" 1>&2
            fi
        fi
    fi
else
    #   apply operation(s) to stdin/stdout
    if [ ".$opt_v" = .yes ]; then
        echo "patching <stdin>" 1>&2
    fi
    if [ ".$opt_t" = .yes ]; then
        echo "\$ $sedcmd"
    fi
    if [ ".$opt_n" = .no ]; then
        eval "$sedcmd"
    fi
fi

shtool_exit 0

##
##  manual page
##

=pod

=head1 NAME

B<shtool-subst> - B<GNU shtool> sed(1) substitution operations

=head1 SYNOPSIS

B<shtool subst>
[B<-v>|B<--verbose>]
[B<-t>|B<--trace>]
[B<-n>|B<--nop>]
[B<-w>|B<--warning>]
[B<-q>|B<--quiet>]
[B<-s>|B<--stealth>]
[B<-i>|B<--interactive>]
[B<-b>|B<--backup> I<ext>]
[B<-e>|B<--exec> I<cmd>]
[B<-f>|B<--file> I<cmd-file>]
[I<file>] [I<file> ...]

=head1 DESCRIPTION

This command applies one or more sed(1) substitution operations to
F<stdin> or any number of files.

=head1 OPTIONS

The following command line options are available.

=over 4

=item B<-v>, B<--verbose>

Display some processing information.

=item B<-t>, B<--trace>

Enable the output of the essential shell commands which are executed.

=item B<-n>, B<--nop>

No operation mode. Actual execution of the essential shell commands
which would be executed is suppressed.

=item B<-w>, B<--warning>

Show warning on substitution operation resulting in no content change
on I<every> file. The default is to show a warning on substitution
operations resulted in no content change on I<all> files.

=item B<-q>, B<--quiet>

Suppress warning on substitution operation resulting in no content change.

=item B<-s>, B<--stealth>

Stealth operation. Preserve timestamp on I<file>.

=item B<-i>, B<--interactive>

Enter interactive mode where the user has to approve each operation.

=item B<-b>, B<--backup> I<ext>

Preserve backup of original file using file name extension I<ext>.
Default is to overwrite the original file.

=item B<-e>, B<--exec> I<cmd>

Specify sed(1) command directly.

=item B<-f>, B<--file> I<cmd-file>

Read sed(1) command from I<file>.

=back

=head1 EXAMPLE

 #   shell script
 shtool subst -i -e 's;(c) \([0-9]*\)-2000;(c) \1-2001;' *.[ch]

 #    RPM spec-file
 %install
     shtool subst -v -n \
         -e 's;^\(prefix=\).*;\1 $RPM_BUILD_ROOT%{_prefix};g' \
         -e 's;^\(sysconfdir=\).*;\1 $RPM_BUILD_ROOT%{_prefix}/etc;g' \
         `find . -name Makefile -print`
     make install

=head1 HISTORY

The B<GNU shtool> B<subst> command was originally written by Ralf S.
Engelschall E<lt>rse@engelschall.comE<gt> in 2001 for B<GNU shtool>.
It was prompted by the need to have a uniform and convenient patching
frontend to sed(1) operations in the B<OpenPKG> package specifications.

=head1 SEE ALSO

shtool(1), sed(1).

=cut