xref: /illumos-gate/usr/src/cmd/sed/main.c (revision 49ee6bfbbe326d1f0bbc34934ab8b07a000305c4)
1 /*
2  * Copyright (c) 2013 Johann 'Myrkraverk' Oskarsson <johann@myrkraverk.com>
3  * Copyright (c) 2011 Gary Mills
4  * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
5  * Copyright (c) 1992 Diomidis Spinellis.
6  * Copyright (c) 1992, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  *
9  * This code is derived from software contributed to Berkeley by
10  * Diomidis Spinellis of Imperial College, University of London.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #include <sys/types.h>
38 #include <sys/mman.h>
39 #include <sys/param.h>
40 #include <sys/stat.h>
41 
42 #include <err.h>
43 #include <errno.h>
44 #include <fcntl.h>
45 #include <getopt.h>
46 #include <libgen.h>
47 #include <libintl.h>
48 #include <limits.h>
49 #include <locale.h>
50 #include <regex.h>
51 #include <stddef.h>
52 #include <stdio.h>
53 #include <stdlib.h>
54 #include <string.h>
55 #include <unistd.h>
56 
57 #include "defs.h"
58 #include "extern.h"
59 
60 /*
61  * Linked list of units (strings and files) to be compiled
62  */
63 struct s_compunit {
64 	struct s_compunit *next;
65 	enum e_cut {CU_FILE, CU_STRING} type;
66 	char *s;			/* Pointer to string or fname */
67 };
68 
69 /*
70  * Linked list pointer to compilation units and pointer to current
71  * next pointer.
72  */
73 static struct s_compunit *script, **cu_nextp = &script;
74 
75 /*
76  * Linked list of files to be processed
77  */
78 struct s_flist {
79 	char *fname;
80 	struct s_flist *next;
81 };
82 
83 /*
84  * Linked list pointer to files and pointer to current
85  * next pointer.
86  */
87 static struct s_flist *files, **fl_nextp = &files;
88 
89 FILE *infile;			/* Current input file */
90 FILE *outfile;			/* Current output file */
91 
92 int aflag, eflag, nflag;
93 int rflags = 0;
94 static int rval;		/* Exit status */
95 
96 static int ispan;		/* Whether inplace editing spans across files */
97 
98 /*
99  * Current file and line number; line numbers restart across compilation
100  * units, but span across input files.  The latter is optional if editing
101  * in place.
102  */
103 const char *fname;		/* File name. */
104 const char *outfname;		/* Output file name */
105 static char oldfname[PATH_MAX];	/* Old file name (for in-place editing) */
106 static char tmpfname[PATH_MAX];	/* Temporary file name (for in-place editing) */
107 static const char *inplace;	/* Inplace edit file extension. */
108 ulong_t linenum;
109 
110 static const struct option lopts[] = {
111 	{"in-place",	optional_argument,	NULL,	'i'},
112 	{NULL,		0,			NULL,	0}
113 };
114 
115 static void add_compunit(enum e_cut, char *);
116 static void add_file(char *);
117 static void usage(void);
118 
119 
120 int
121 main(int argc, char *argv[])
122 {
123 	int c, fflag;
124 	char *temp_arg;
125 
126 	(void) setlocale(LC_ALL, "");
127 
128 #ifndef TEXT_DOMAIN
129 #define	TEXT_DOMAIN	"SYS_TEST"
130 #endif
131 	(void) textdomain(TEXT_DOMAIN);
132 
133 	fflag = 0;
134 	inplace = NULL;
135 
136 	while ((c = getopt_long(argc, argv, "EI::ae:f:i::lnr", lopts, NULL)) !=
137 	    -1)
138 		switch (c) {
139 		case 'r':		/* Gnu sed compat */
140 		case 'E':
141 			rflags = REG_EXTENDED;
142 			break;
143 		case 'I':
144 			if (optarg != NULL)
145 				inplace = optarg;
146 			else
147 				inplace = "";
148 			ispan = 1;	/* span across input files */
149 			break;
150 		case 'a':
151 			aflag = 1;
152 			break;
153 		case 'e':
154 			eflag = 1;
155 			if (asprintf(&temp_arg, "%s\n", optarg) < 1)
156 				err(1, "asprintf");
157 			add_compunit(CU_STRING, temp_arg);
158 			break;
159 		case 'f':
160 			fflag = 1;
161 			add_compunit(CU_FILE, optarg);
162 			break;
163 		case 'i':
164 			if (optarg != NULL)
165 				inplace = optarg;
166 			else
167 				inplace = "";
168 			ispan = 0;	/* don't span across input files */
169 			break;
170 		case 'l':
171 			/* On SunOS, setlinebuf "returns no useful value */
172 			(void) setlinebuf(stdout);
173 			break;
174 		case 'n':
175 			nflag = 1;
176 			break;
177 		default:
178 		case '?':
179 			usage();
180 		}
181 	argc -= optind;
182 	argv += optind;
183 
184 	/* First usage case; script is the first arg */
185 	if (!eflag && !fflag && *argv) {
186 		add_compunit(CU_STRING, *argv);
187 		argv++;
188 	}
189 
190 	compile();
191 
192 	/* Continue with first and start second usage */
193 	if (*argv)
194 		for (; *argv; argv++)
195 			add_file(*argv);
196 	else
197 		add_file(NULL);
198 	process();
199 	cfclose(prog, NULL);
200 	if (fclose(stdout))
201 		err(1, "stdout");
202 	return (rval);
203 }
204 
205 static void
206 usage(void)
207 {
208 	(void) fputs(_("usage: sed script [-Ealn] [-i[extension]] [file...]\n"
209 	    "       sed [-Ealn] [-i[extension]] [-e script]... "
210 	    "[-f script_file]... [file...]\n"),
211 	    stderr);
212 	exit(1);
213 }
214 
215 /*
216  * Like fgets, but go through the chain of compilation units chaining them
217  * together.  Empty strings and files are ignored.
218  */
219 char *
220 cu_fgets(char *buf, int n, int *more)
221 {
222 	static enum {ST_EOF, ST_FILE, ST_STRING} state = ST_EOF;
223 	static FILE *f;		/* Current open file */
224 	static char *s;		/* Current pointer inside string */
225 	static char string_ident[30];
226 	char *p;
227 
228 again:
229 	switch (state) {
230 	case ST_EOF:
231 		if (script == NULL) {
232 			if (more != NULL)
233 				*more = 0;
234 			return (NULL);
235 		}
236 		linenum = 0;
237 		switch (script->type) {
238 		case CU_FILE:
239 			if ((f = fopen(script->s, "r")) == NULL)
240 				err(1, "%s", script->s);
241 			fname = script->s;
242 			state = ST_FILE;
243 			goto again;
244 		case CU_STRING:
245 			if (((size_t)snprintf(string_ident,
246 			    sizeof (string_ident), "\"%s\"", script->s)) >=
247 			    sizeof (string_ident) - 1)
248 				(void) strcpy(string_ident +
249 				    sizeof (string_ident) - 6, " ...\"");
250 			fname = string_ident;
251 			s = script->s;
252 			state = ST_STRING;
253 			goto again;
254 		default:
255 			errx(1, "BUG: Unknown script type: %d\n", script->type);
256 		}
257 		/*NOTREACHED*/
258 
259 	case ST_FILE:
260 		if ((p = fgets(buf, n, f)) != NULL) {
261 			linenum++;
262 			if (linenum == 1 && buf[0] == '#' && buf[1] == 'n')
263 				nflag = 1;
264 			if (more != NULL)
265 				*more = !feof(f);
266 			return (p);
267 		}
268 		script = script->next;
269 		(void) fclose(f);
270 		state = ST_EOF;
271 		goto again;
272 	case ST_STRING:
273 		if (linenum == 0 && s[0] == '#' && s[1] == 'n')
274 			nflag = 1;
275 		p = buf;
276 		for (;;) {
277 			if (n-- <= 1) {
278 				*p = '\0';
279 				linenum++;
280 				if (more != NULL)
281 					*more = 1;
282 				return (buf);
283 			}
284 			switch (*s) {
285 			case '\0':
286 				state = ST_EOF;
287 				if (s == script->s) {
288 					script = script->next;
289 					goto again;
290 				} else {
291 					script = script->next;
292 					*p = '\0';
293 					linenum++;
294 					if (more != NULL)
295 						*more = 0;
296 					return (buf);
297 				}
298 			case '\n':
299 				*p++ = '\n';
300 				*p = '\0';
301 				s++;
302 				linenum++;
303 				if (more != NULL)
304 					*more = 0;
305 				return (buf);
306 			default:
307 				*p++ = *s++;
308 			}
309 		}
310 	}
311 	/* NOTREACHED */
312 	return (NULL);
313 }
314 
315 /*
316  * Like fgets, but go through the list of files chaining them together.
317  * Set len to the length of the line.
318  */
319 int
320 mf_fgets(SPACE *sp, enum e_spflag spflag)
321 {
322 	struct stat sb, nsb;
323 	ssize_t len;
324 	static char *p = NULL;
325 	static size_t plen = 0;
326 	int c;
327 	static int firstfile;
328 
329 	if (infile == NULL) {
330 		/* stdin? */
331 		if (files->fname == NULL) {
332 			if (inplace != NULL)
333 				errx(1,
334 				    _("-I or -i may not be used with stdin"));
335 			infile = stdin;
336 			fname = "stdin";
337 			outfile = stdout;
338 			outfname = "stdout";
339 		}
340 		firstfile = 1;
341 	}
342 
343 	for (;;) {
344 		if (infile != NULL && (c = getc(infile)) != EOF) {
345 			(void) ungetc(c, infile);
346 			break;
347 		}
348 		/* If we are here then either eof or no files are open yet */
349 		if (infile == stdin) {
350 			sp->len = 0;
351 			return (0);
352 		}
353 		if (infile != NULL) {
354 			(void) fclose(infile);
355 			if (*oldfname != '\0') {
356 				/* if there was a backup file, remove it */
357 				(void) unlink(oldfname);
358 				/*
359 				 * Backup the original.  Note that hard links
360 				 * are not supported on all filesystems.
361 				 */
362 				if ((link(fname, oldfname) != 0) &&
363 				    (rename(fname, oldfname) != 0)) {
364 					warn("rename()");
365 					if (*tmpfname)
366 						(void) unlink(tmpfname);
367 					exit(1);
368 				}
369 				*oldfname = '\0';
370 			}
371 			if (*tmpfname != '\0') {
372 				if (outfile != NULL && outfile != stdout)
373 					if (fclose(outfile) != 0) {
374 						warn("fclose()");
375 						(void) unlink(tmpfname);
376 						exit(1);
377 					}
378 				outfile = NULL;
379 				if (rename(tmpfname, fname) != 0) {
380 					/* this should not happen really! */
381 					warn("rename()");
382 					(void) unlink(tmpfname);
383 					exit(1);
384 				}
385 				*tmpfname = '\0';
386 			}
387 			outfname = NULL;
388 		}
389 		if (firstfile == 0)
390 			files = files->next;
391 		else
392 			firstfile = 0;
393 		if (files == NULL) {
394 			sp->len = 0;
395 			return (0);
396 		}
397 		fname = files->fname;
398 		if (inplace != NULL) {
399 			char bn[PATH_MAX];
400 			char dn[PATH_MAX];
401 			(void) strlcpy(bn, fname, sizeof (bn));
402 			(void) strlcpy(dn, fname, sizeof (dn));
403 			if (lstat(fname, &sb) != 0)
404 				err(1, "%s", fname);
405 			if (!(sb.st_mode & S_IFREG))
406 				fatal(_("in-place editing only "
407 				    "works for regular files"));
408 			if (*inplace != '\0') {
409 				(void) strlcpy(oldfname, fname,
410 				    sizeof (oldfname));
411 				len = strlcat(oldfname, inplace,
412 				    sizeof (oldfname));
413 				if (len > sizeof (oldfname))
414 					fatal(_("name too long"));
415 			}
416 			len = snprintf(tmpfname, sizeof (tmpfname),
417 			    "%s/.!%ld!%s", dirname(dn), (long)getpid(),
418 			    basename(bn));
419 			if (len >= sizeof (tmpfname))
420 				fatal(_("name too long"));
421 			(void) unlink(tmpfname);
422 			if ((outfile = fopen(tmpfname, "w")) == NULL)
423 				err(1, "%s", fname);
424 			/*
425 			 * Some file systems don't support chown or
426 			 * chmod fully.  On those, the owner/group and
427 			 * permissions will already be set to what
428 			 * they need to be.
429 			 */
430 			if (fstat(fileno(outfile), &nsb) != 0) {
431 				warn("fstat()");
432 			}
433 			if (((sb.st_uid != nsb.st_uid) ||
434 			    (sb.st_gid != nsb.st_gid)) &&
435 			    (fchown(fileno(outfile), sb.st_uid, sb.st_gid)
436 			    != 0))
437 				warn("fchown()");
438 			if ((sb.st_mode != nsb.st_mode) &&
439 			    (fchmod(fileno(outfile), sb.st_mode & 07777) != 0))
440 				warn("fchmod()");
441 			outfname = tmpfname;
442 			if (!ispan) {
443 				linenum = 0;
444 				resetstate();
445 			}
446 		} else {
447 			outfile = stdout;
448 			outfname = "stdout";
449 		}
450 		if ((infile = fopen(fname, "r")) == NULL) {
451 			warn("%s", fname);
452 			rval = 1;
453 			continue;
454 		}
455 	}
456 	/*
457 	 * We are here only when infile is open and we still have something
458 	 * to read from it.
459 	 *
460 	 * Use getline() so that we can handle essentially infinite
461 	 * input data.  The p and plen are static so each invocation gives
462 	 * getline() the same buffer which is expanded as needed.
463 	 */
464 	len = getline(&p, &plen, infile);
465 	if (len == -1)
466 		err(1, "%s", fname);
467 	if (len != 0 && p[len - 1] == '\n')
468 		len--;
469 	cspace(sp, p, len, spflag);
470 
471 	linenum++;
472 
473 	return (1);
474 }
475 
476 /*
477  * Add a compilation unit to the linked list
478  */
479 static void
480 add_compunit(enum e_cut type, char *s)
481 {
482 	struct s_compunit *cu;
483 
484 	if ((cu = malloc(sizeof (struct s_compunit))) == NULL)
485 		err(1, "malloc");
486 	cu->type = type;
487 	cu->s = s;
488 	cu->next = NULL;
489 	*cu_nextp = cu;
490 	cu_nextp = &cu->next;
491 }
492 
493 /*
494  * Add a file to the linked list
495  */
496 static void
497 add_file(char *s)
498 {
499 	struct s_flist *fp;
500 
501 	if ((fp = malloc(sizeof (struct s_flist))) == NULL)
502 		err(1, "malloc");
503 	fp->next = NULL;
504 	*fl_nextp = fp;
505 	fp->fname = s;
506 	fl_nextp = &fp->next;
507 }
508 
509 int
510 lastline(void)
511 {
512 	int ch;
513 
514 	if (files->next != NULL && (inplace == NULL || ispan))
515 		return (0);
516 	if ((ch = getc(infile)) == EOF)
517 		return (1);
518 	(void) ungetc(ch, infile);
519 	return (0);
520 }
521