Initial db4 logging.
[nvi.git] / common / exf.c
bloba30501cce4fc1419a8a5333f1693fa6f1814d6fd
1 /*-
2 * Copyright (c) 1992, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1992, 1993, 1994, 1995, 1996
5 * Keith Bostic. All rights reserved.
7 * See the LICENSE file for redistribution information.
8 */
10 #include "config.h"
12 #ifndef lint
13 static const char sccsid[] = "$Id: exf.c,v 10.70 2002/03/02 23:36:22 skimo Exp $ (Berkeley) $Date: 2002/03/02 23:36:22 $";
14 #endif /* not lint */
16 #include <sys/param.h>
17 #include <sys/types.h> /* XXX: param.h may not have included types.h */
18 #include <sys/queue.h>
19 #include <sys/stat.h>
22 * We include <sys/file.h>, because the flock(2) and open(2) #defines
23 * were found there on historical systems. We also include <fcntl.h>
24 * because the open(2) #defines are found there on newer systems.
26 #include <sys/file.h>
28 #include <bitstring.h>
29 #include <dirent.h>
30 #include <errno.h>
31 #include <fcntl.h>
32 #include <limits.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <string.h>
36 #include <unistd.h>
37 #include <time.h>
39 #include "common.h"
41 static int file_backup __P((SCR *, char *, char *));
42 static void file_cinit __P((SCR *));
43 static void file_comment __P((SCR *));
44 static int file_spath __P((SCR *, FREF *, struct stat *, int *));
45 static int db_setup __P((SCR *sp, EXF *ep));
48 * file_add --
49 * Insert a file name into the FREF list, if it doesn't already
50 * appear in it.
52 * !!!
53 * The "if it doesn't already appear" changes vi's semantics slightly. If
54 * you do a "vi foo bar", and then execute "next bar baz", the edit of bar
55 * will reflect the line/column of the previous edit session. Historic nvi
56 * did not do this. The change is a logical extension of the change where
57 * vi now remembers the last location in any file that it has ever edited,
58 * not just the previously edited file.
60 * PUBLIC: FREF *file_add __P((SCR *, char *));
62 FREF *
63 file_add(SCR *sp, char *name)
65 GS *gp;
66 FREF *frp, *tfrp;
69 * Return it if it already exists. Note that we test against the
70 * user's name, whatever that happens to be, including if it's a
71 * temporary file.
73 * If the user added a file but was unable to initialize it, there
74 * can be file list entries where the name field is NULL. Discard
75 * them the next time we see them.
77 gp = sp->gp;
78 if (name != NULL)
79 for (frp = gp->frefq.cqh_first;
80 frp != (FREF *)&gp->frefq; frp = frp->q.cqe_next) {
81 if (frp->name == NULL) {
82 tfrp = frp->q.cqe_next;
83 CIRCLEQ_REMOVE(&gp->frefq, frp, q);
84 if (frp->name != NULL)
85 free(frp->name);
86 free(frp);
87 frp = tfrp;
88 continue;
90 if (!strcmp(frp->name, name))
91 return (frp);
94 /* Allocate and initialize the FREF structure. */
95 CALLOC(sp, frp, FREF *, 1, sizeof(FREF));
96 if (frp == NULL)
97 return (NULL);
100 * If no file name specified, or if the file name is a request
101 * for something temporary, file_init() will allocate the file
102 * name. Temporary files are always ignored.
104 if (name != NULL && strcmp(name, TEMPORARY_FILE_STRING) &&
105 (frp->name = strdup(name)) == NULL) {
106 free(frp);
107 msgq(sp, M_SYSERR, NULL);
108 return (NULL);
111 /* Append into the chain of file names. */
112 CIRCLEQ_INSERT_TAIL(&gp->frefq, frp, q);
114 return (frp);
118 * file_init --
119 * Start editing a file, based on the FREF structure. If successsful,
120 * let go of any previous file. Don't release the previous file until
121 * absolutely sure we have the new one.
123 * PUBLIC: int file_init __P((SCR *, FREF *, char *, int));
126 file_init(SCR *sp, FREF *frp, char *rcv_name, int flags)
128 EXF *ep;
129 struct stat sb;
130 size_t psize;
131 int fd, exists, open_err, readonly, stolen;
132 char *oname, tname[MAXPATHLEN];
134 stolen = open_err = readonly = 0;
137 * If the file is a recovery file, let the recovery code handle it.
138 * Clear the FR_RECOVER flag first -- the recovery code does set up,
139 * and then calls us! If the recovery call fails, it's probably
140 * because the named file doesn't exist. So, move boldly forward,
141 * presuming that there's an error message the user will get to see.
143 if (F_ISSET(frp, FR_RECOVER)) {
144 F_CLR(frp, FR_RECOVER);
145 return (rcv_read(sp, frp));
149 * Required FRP initialization; the only flag we keep is the
150 * cursor information.
152 F_CLR(frp, ~FR_CURSORSET);
155 * Scan the user's path to find the file that we're going to
156 * try and open.
158 if (file_spath(sp, frp, &sb, &exists))
159 return (1);
162 * Check whether we already have this file opened in some
163 * other screen.
165 if (exists) {
166 EXF *exfp;
167 for (exfp = sp->gp->exfq.cqh_first;
168 exfp != (EXF *)&sp->gp->exfq; exfp = exfp->q.cqe_next) {
169 if (exfp->mdev == sb.st_dev &&
170 exfp->minode == sb.st_ino &&
171 (exfp != sp->ep || exfp->refcnt > 1)) {
172 ep = exfp;
173 goto postinit;
179 * Required EXF initialization:
180 * Flush the line caches.
181 * Default recover mail file fd to -1.
182 * Set initial EXF flag bits.
184 CALLOC_RET(sp, ep, EXF *, 1, sizeof(EXF));
185 CIRCLEQ_INIT(&ep->scrq);
186 sp->c_lno = ep->c_nlines = OOBLNO;
187 ep->rcv_fd = ep->fcntl_fd = -1;
188 F_SET(ep, F_FIRSTMODIFY);
191 * If no name or backing file, for whatever reason, create a backing
192 * temporary file, saving the temp file name so we can later unlink
193 * it. If the user never named this file, copy the temporary file name
194 * to the real name (we display that until the user renames it).
196 oname = frp->name;
197 if (LF_ISSET(FS_OPENERR) || oname == NULL || !exists) {
198 if (opts_empty(sp, O_DIRECTORY, 0))
199 goto err;
200 (void)snprintf(tname, sizeof(tname),
201 "%s/vi.XXXXXX", O_STR(sp, O_DIRECTORY));
202 if ((fd = mkstemp(tname)) == -1) {
203 msgq(sp, M_SYSERR,
204 "237|Unable to create temporary file");
205 goto err;
207 (void)close(fd);
209 if (frp->name == NULL)
210 F_SET(frp, FR_TMPFILE);
211 if ((frp->tname = strdup(tname)) == NULL ||
212 (frp->name == NULL &&
213 (frp->name = strdup(tname)) == NULL)) {
214 if (frp->tname != NULL) {
215 free(frp->tname);
217 msgq(sp, M_SYSERR, NULL);
218 (void)unlink(tname);
219 goto err;
221 oname = frp->tname;
222 psize = 1024;
223 if (!LF_ISSET(FS_OPENERR))
224 F_SET(frp, FR_NEWFILE);
226 time(&ep->mtime);
227 } else {
229 * XXX
230 * A seat of the pants calculation: try to keep the file in
231 * 15 pages or less. Don't use a page size larger than 10K
232 * (vi should have good locality) or smaller than 1K.
234 psize = ((sb.st_size / 15) + 1023) / 1024;
235 if (psize > 10)
236 psize = 10;
237 if (psize == 0)
238 psize = 1;
239 psize *= 1024;
241 F_SET(ep, F_DEVSET);
242 ep->mdev = sb.st_dev;
243 ep->minode = sb.st_ino;
245 ep->mtime = sb.st_mtime;
247 if (!S_ISREG(sb.st_mode))
248 msgq_str(sp, M_ERR, oname,
249 "238|Warning: %s is not a regular file");
252 /* Set up recovery. */
253 if (rcv_name == NULL) {
254 /* ep->rcv_path NULL if rcv_tmp fails */
255 rcv_tmp(sp, ep, frp->name);
256 } else {
257 if ((ep->rcv_path = strdup(rcv_name)) == NULL) {
258 msgq(sp, M_SYSERR, NULL);
259 goto err;
261 F_SET(ep, F_MODIFIED);
264 if (db_setup(sp, ep))
265 goto err;
267 /* Open a db structure. */
268 if ((sp->db_error = db_create(&ep->db, 0, 0)) != 0) {
269 msgq(sp, M_DBERR, "db_create");
270 goto err;
273 ep->db->set_re_delim(ep->db, '\n'); /* Always set. */
274 ep->db->set_pagesize(ep->db, psize);
275 ep->db->set_flags(ep->db, DB_RENUMBER | DB_SNAPSHOT);
276 if (rcv_name == NULL)
277 ep->db->set_re_source(ep->db, oname);
280 * Don't let db use mmap when using fcntl for locking
282 #ifdef HAVE_LOCK_FCNTL
283 #define NOMMAPIFFCNTL DB_NOMMAP
284 #else
285 #define NOMMAPIFFCNTL 0
286 #endif
288 #define _DB_OPEN_MODE S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH
290 if ((sp->db_error = ep->db->open(ep->db, ep->rcv_path, NULL, DB_RECNO,
291 ((rcv_name == 0) ? DB_TRUNCATE : 0) | VI_DB_THREAD | NOMMAPIFFCNTL,
292 _DB_OPEN_MODE)) != 0) {
293 msgq_str(sp,
294 M_DBERR, rcv_name == NULL ? oname : rcv_name, "%s");
296 * !!!
297 * Historically, vi permitted users to edit files that couldn't
298 * be read. This isn't useful for single files from a command
299 * line, but it's quite useful for "vi *.c", since you can skip
300 * past files that you can't read.
302 ep->db = NULL; /* Don't close it; it wasn't opened */
304 if (LF_ISSET(FS_OPENERR))
305 goto err;
307 open_err = 1;
308 goto oerr;
311 /* re_source is loaded into the database.
312 * Close it and reopen it in the environment.
314 if ((sp->db_error = ep->db->close(ep->db, 0))) {
315 msgq(sp, M_DBERR, "close");
316 goto err;
318 if ((sp->db_error = db_create(&ep->db, ep->env, 0)) != 0) {
319 msgq(sp, M_DBERR, "db_create 2");
320 goto err;
322 if ((sp->db_error = ep->db->open(ep->db, ep->rcv_path, NULL, DB_RECNO,
323 VI_DB_THREAD | NOMMAPIFFCNTL, _DB_OPEN_MODE)) != 0) {
324 msgq_str(sp,
325 M_DBERR, ep->rcv_path, "%s");
326 goto err;
330 * Do the remaining things that can cause failure of the new file,
331 * mark and logging initialization.
333 if (mark_init(sp, ep) || log_init(sp, ep))
334 goto err;
336 postinit:
338 * Set the alternate file name to be the file we're discarding.
340 * !!!
341 * Temporary files can't become alternate files, so there's no file
342 * name. This matches historical practice, although it could only
343 * happen in historical vi as the result of the initial command, i.e.
344 * if vi was executed without a file name.
346 if (LF_ISSET(FS_SETALT))
347 set_alt_name(sp, sp->frp == NULL ||
348 F_ISSET(sp->frp, FR_TMPFILE) ? NULL : sp->frp->name);
351 * Close the previous file; if that fails, close the new one and run
352 * for the border.
354 * !!!
355 * There's a nasty special case. If the user edits a temporary file,
356 * and then does an ":e! %", we need to re-initialize the backing
357 * file, but we can't change the name. (It's worse -- we're dealing
358 * with *names* here, we can't even detect that it happened.) Set a
359 * flag so that the file_end routine ignores the backing information
360 * of the old file if it happens to be the same as the new one.
362 * !!!
363 * Side-effect: after the call to file_end(), sp->frp may be NULL.
365 if (sp->ep != NULL) {
366 F_SET(frp, FR_DONTDELETE);
367 if (file_end(sp, NULL, LF_ISSET(FS_FORCE))) {
368 (void)file_end(sp, ep, 1);
369 goto err;
371 sp->ep = NULL;
372 F_CLR(frp, FR_DONTDELETE);
376 * Lock the file; if it's a recovery file, it should already be
377 * locked. Note, we acquire the lock after the previous file
378 * has been ended, so that we don't get an "already locked" error
379 * for ":edit!".
381 * XXX
382 * While the user can't interrupt us between the open and here,
383 * there's a race between the dbopen() and the lock. Not much
384 * we can do about it.
386 * XXX
387 * We don't make a big deal of not being able to lock the file. As
388 * locking rarely works over NFS, and often fails if the file was
389 * mmap(2)'d, it's far too common to do anything like print an error
390 * message, let alone make the file readonly. At some future time,
391 * when locking is a little more reliable, this should change to be
392 * an error.
394 if (rcv_name == NULL && ep->refcnt == 0) {
395 if ((ep->fd = open(oname, O_RDWR)) == -1)
396 goto no_lock;
398 switch (file_lock(sp, oname, &ep->fcntl_fd, ep->fd, 1)) {
399 case LOCK_FAILED:
400 no_lock:
401 F_SET(frp, FR_UNLOCKED);
402 break;
403 case LOCK_UNAVAIL:
404 readonly = 1;
405 msgq_str(sp, M_INFO, oname,
406 "239|%s already locked, session is read-only");
407 break;
408 case LOCK_SUCCESS:
409 break;
414 * Historically, the readonly edit option was set per edit buffer in
415 * vi, unless the -R command-line option was specified or the program
416 * was executed as "view". (Well, to be truthful, if the letter 'w'
417 * occurred anywhere in the program name, but let's not get into that.)
418 * So, the persistant readonly state has to be stored in the screen
419 * structure, and the edit option value toggles with the contents of
420 * the edit buffer. If the persistant readonly flag is set, set the
421 * readonly edit option.
423 * Otherwise, try and figure out if a file is readonly. This is a
424 * dangerous thing to do. The kernel is the only arbiter of whether
425 * or not a file is writeable, and the best that a user program can
426 * do is guess. Obvious loopholes are files that are on a file system
427 * mounted readonly (access catches this one on a few systems), or
428 * alternate protection mechanisms, ACL's for example, that we can't
429 * portably check. Lots of fun, and only here because users whined.
431 * !!!
432 * Historic vi displayed the readonly message if none of the file
433 * write bits were set, or if an an access(2) call on the path
434 * failed. This seems reasonable. If the file is mode 444, root
435 * users may want to know that the owner of the file did not expect
436 * it to be written.
438 * Historic vi set the readonly bit if no write bits were set for
439 * a file, even if the access call would have succeeded. This makes
440 * the superuser force the write even when vi expects that it will
441 * succeed. I'm less supportive of this semantic, but it's historic
442 * practice and the conservative approach to vi'ing files as root.
444 * It would be nice if there was some way to update this when the user
445 * does a "^Z; chmod ...". The problem is that we'd first have to
446 * distinguish between readonly bits set because of file permissions
447 * and those set for other reasons. That's not too hard, but deciding
448 * when to reevaluate the permissions is trickier. An alternative
449 * might be to turn off the readonly bit if the user forces a write
450 * and it succeeds.
452 * XXX
453 * Access(2) doesn't consider the effective uid/gid values. This
454 * probably isn't a problem for vi when it's running standalone.
456 if (readonly || F_ISSET(sp, SC_READONLY) ||
457 (!F_ISSET(frp, FR_NEWFILE) &&
458 (!(sb.st_mode & (S_IWUSR | S_IWGRP | S_IWOTH)) ||
459 access(frp->name, W_OK))))
460 O_SET(sp, O_READONLY);
461 else
462 O_CLR(sp, O_READONLY);
464 /* Switch... */
465 ++ep->refcnt;
466 CIRCLEQ_INSERT_HEAD(&ep->scrq, sp, eq);
467 sp->ep = ep;
468 sp->frp = frp;
470 /* Set the initial cursor position, queue initial command. */
471 file_cinit(sp);
473 /* Report conversion errors again. */
474 F_CLR(sp, SC_CONV_ERROR);
476 /* Redraw the screen from scratch, schedule a welcome message. */
477 F_SET(sp, SC_SCR_REFORMAT | SC_SCR_TOP | SC_STATUS);
479 /* Append into the chain of file structures. */
480 if (ep->refcnt == 1)
481 CIRCLEQ_INSERT_TAIL(&sp->gp->exfq, ep, q);
483 return (0);
485 err: if (frp->name != NULL) {
486 free(frp->name);
487 frp->name = NULL;
489 if (frp->tname != NULL) {
490 (void)unlink(frp->tname);
491 free(frp->tname);
492 frp->tname = NULL;
495 oerr: if (F_ISSET(ep, F_RCV_ON))
496 (void)unlink(ep->rcv_path);
497 if (ep->rcv_path != NULL) {
498 free(ep->rcv_path);
499 ep->rcv_path = NULL;
501 if (ep->db != NULL) {
502 (void)ep->db->close(ep->db, DB_NOSYNC);
503 ep->db = NULL;
505 free(ep);
507 return (open_err && !LF_ISSET(FS_OPENERR) ?
508 file_init(sp, frp, rcv_name, flags | FS_OPENERR) : 1);
512 * file_spath --
513 * Scan the user's path to find the file that we're going to
514 * try and open.
516 static int
517 file_spath(SCR *sp, FREF *frp, struct stat *sbp, int *existsp)
519 CHAR_T savech;
520 size_t len;
521 int found;
522 char *name, *p, *t, path[MAXPATHLEN];
525 * If the name is NULL or an explicit reference (i.e., the first
526 * component is . or ..) ignore the O_PATH option.
528 name = frp->name;
529 if (name == NULL) {
530 *existsp = 0;
531 return (0);
533 if (name[0] == '/' || (name[0] == '.' &&
534 (name[1] == '/' || (name[1] == '.' && name[2] == '/')))) {
535 *existsp = !stat(name, sbp);
536 return (0);
539 /* Try . */
540 if (!stat(name, sbp)) {
541 *existsp = 1;
542 return (0);
545 /* Try the O_PATH option values. */
546 for (found = 0, p = t = O_STR(sp, O_PATH);; ++p)
547 if (*p == ':' || *p == '\0') {
548 if (t < p - 1) {
549 savech = *p;
550 *p = '\0';
551 len = snprintf(path,
552 sizeof(path), "%s/%s", t, name);
553 *p = savech;
554 if (!stat(path, sbp)) {
555 found = 1;
556 break;
559 t = p + 1;
560 if (*p == '\0')
561 break;
564 /* If we found it, build a new pathname and discard the old one. */
565 if (found) {
566 MALLOC_RET(sp, p, char *, len + 1);
567 memcpy(p, path, len + 1);
568 free(frp->name);
569 frp->name = p;
571 *existsp = found;
572 return (0);
576 * file_cinit --
577 * Set up the initial cursor position.
579 static void
580 file_cinit(SCR *sp)
582 GS *gp;
583 MARK m;
584 size_t len;
585 int nb;
586 CHAR_T *wp;
587 size_t wlen;
589 /* Set some basic defaults. */
590 sp->lno = 1;
591 sp->cno = 0;
594 * Historically, initial commands (the -c option) weren't executed
595 * until a file was loaded, e.g. "vi +10 nofile", followed by an
596 * :edit or :tag command, would execute the +10 on the file loaded
597 * by the subsequent command, (assuming that it existed). This
598 * applied as well to files loaded using the tag commands, and we
599 * follow that historic practice. Also, all initial commands were
600 * ex commands and were always executed on the last line of the file.
602 * Otherwise, if no initial command for this file:
603 * If in ex mode, move to the last line, first nonblank character.
604 * If the file has previously been edited, move to the last known
605 * position, and check it for validity.
606 * Otherwise, move to the first line, first nonblank.
608 * This gets called by the file init code, because we may be in a
609 * file of ex commands and we want to execute them from the right
610 * location in the file.
612 nb = 0;
613 gp = sp->gp;
614 if (gp->c_option != NULL && !F_ISSET(sp->frp, FR_NEWFILE)) {
615 if (db_last(sp, &sp->lno))
616 return;
617 if (sp->lno == 0) {
618 sp->lno = 1;
619 sp->cno = 0;
621 CHAR2INT(sp, gp->c_option, strlen(gp->c_option) + 1,
622 wp, wlen);
623 if (ex_run_str(sp, "-c option", wp, wlen - 1, 1, 1))
624 return;
625 gp->c_option = NULL;
626 } else if (F_ISSET(sp, SC_EX)) {
627 if (db_last(sp, &sp->lno))
628 return;
629 if (sp->lno == 0) {
630 sp->lno = 1;
631 sp->cno = 0;
632 return;
634 nb = 1;
635 } else {
636 if (F_ISSET(sp->frp, FR_CURSORSET)) {
637 sp->lno = sp->frp->lno;
638 sp->cno = sp->frp->cno;
640 /* If returning to a file in vi, center the line. */
641 F_SET(sp, SC_SCR_CENTER);
642 } else {
643 if (O_ISSET(sp, O_COMMENT))
644 file_comment(sp);
645 else
646 sp->lno = 1;
647 nb = 1;
649 if (db_get(sp, sp->lno, 0, NULL, &len)) {
650 sp->lno = 1;
651 sp->cno = 0;
652 return;
654 if (!nb && sp->cno > len)
655 nb = 1;
657 if (nb) {
658 sp->cno = 0;
659 (void)nonblank(sp, sp->lno, &sp->cno);
663 * !!!
664 * The initial column is also the most attractive column.
666 sp->rcm = sp->cno;
669 * !!!
670 * Historically, vi initialized the absolute mark, but ex did not.
671 * Which meant, that if the first command in ex mode was "visual",
672 * or if an ex command was executed first (e.g. vi +10 file) vi was
673 * entered without the mark being initialized. For consistency, if
674 * the file isn't empty, we initialize it for everyone, believing
675 * that it can't hurt, and is generally useful. Not initializing it
676 * if the file is empty is historic practice, although it has always
677 * been possible to set (and use) marks in empty vi files.
679 m.lno = sp->lno;
680 m.cno = sp->cno;
681 (void)mark_set(sp, ABSMARK1, &m, 0);
685 * file_end --
686 * Stop editing a file.
688 * PUBLIC: int file_end __P((SCR *, EXF *, int));
691 file_end(SCR *sp, EXF *ep, int force)
693 FREF *frp;
696 * !!!
697 * ep MAY NOT BE THE SAME AS sp->ep, DON'T USE THE LATTER.
698 * (If argument ep is NULL, use sp->ep.)
700 * If multiply referenced, just decrement the count and return.
702 if (ep == NULL)
703 ep = sp->ep;
704 CIRCLEQ_REMOVE(&ep->scrq, sp, eq);
705 if (--ep->refcnt != 0)
706 return (0);
710 * Clean up the FREF structure.
712 * Save the cursor location.
714 * XXX
715 * It would be cleaner to do this somewhere else, but by the time
716 * ex or vi knows that we're changing files it's already happened.
718 frp = sp->frp;
719 frp->lno = sp->lno;
720 frp->cno = sp->cno;
721 F_SET(frp, FR_CURSORSET);
724 * We may no longer need the temporary backing file, so clean it
725 * up. We don't need the FREF structure either, if the file was
726 * never named, so lose it.
728 * !!!
729 * Re: FR_DONTDELETE, see the comment above in file_init().
731 if (!F_ISSET(frp, FR_DONTDELETE) && frp->tname != NULL) {
732 if (unlink(frp->tname))
733 msgq_str(sp, M_SYSERR, frp->tname, "240|%s: remove");
734 free(frp->tname);
735 frp->tname = NULL;
736 if (F_ISSET(frp, FR_TMPFILE)) {
737 CIRCLEQ_REMOVE(&sp->gp->frefq, frp, q);
738 if (frp->name != NULL)
739 free(frp->name);
740 free(frp);
742 sp->frp = NULL;
746 * Clean up the EXF structure.
748 * Close the db structure.
750 if (ep->db->close != NULL) {
751 if ((sp->db_error = ep->db->close(ep->db, DB_NOSYNC)) != 0 &&
752 !force) {
753 msgq_str(sp, M_DBERR, frp->name, "241|%s: close");
754 CIRCLEQ_INSERT_HEAD(&ep->scrq, sp, eq);
755 ++ep->refcnt;
756 return (1);
758 ep->db = NULL;
761 /* COMMITTED TO THE CLOSE. THERE'S NO GOING BACK... */
763 /* Stop logging. */
764 (void)log_end(sp, ep);
766 /* Free up any marks. */
767 (void)mark_end(sp, ep);
769 if (ep->env) {
770 DB_ENV *env;
772 ep->env->close(ep->env, 0);
773 ep->env = 0;
774 if ((sp->db_error = db_env_create(&env, 0)))
775 msgq(sp, M_DBERR, "env_create");
776 if ((sp->db_error = env->remove(env, ep->env_path, 0)))
777 msgq(sp, M_DBERR, "env->remove");
778 if (ep->env_path != NULL && rmdir(ep->env_path))
779 msgq_str(sp, M_SYSERR, ep->env_path, "242|%s: remove");
783 * Delete recovery files, close the open descriptor, free recovery
784 * memory. See recover.c for a description of the protocol.
786 * XXX
787 * Unlink backup file first, we can detect that the recovery file
788 * doesn't reference anything when the user tries to recover it.
789 * There's a race, here, obviously, but it's fairly small.
791 if (!F_ISSET(ep, F_RCV_NORM)) {
792 if (ep->rcv_path != NULL && unlink(ep->rcv_path))
793 msgq_str(sp, M_SYSERR, ep->rcv_path, "242|%s: remove");
794 if (ep->rcv_mpath != NULL && unlink(ep->rcv_mpath))
795 msgq_str(sp, M_SYSERR, ep->rcv_mpath, "243|%s: remove");
797 CIRCLEQ_REMOVE(&sp->gp->exfq, ep, q);
798 if (ep->fd != -1)
799 (void)close(ep->fd);
800 if (ep->fcntl_fd != -1)
801 (void)close(ep->fcntl_fd);
802 if (ep->rcv_fd != -1)
803 (void)close(ep->rcv_fd);
804 if (ep->env_path != NULL)
805 free(ep->env_path);
806 if (ep->rcv_path != NULL)
807 free(ep->rcv_path);
808 if (ep->rcv_mpath != NULL)
809 free(ep->rcv_mpath);
811 free(ep);
812 return (0);
816 * file_write --
817 * Write the file to disk. Historic vi had fairly convoluted
818 * semantics for whether or not writes would happen. That's
819 * why all the flags.
821 * PUBLIC: int file_write __P((SCR *, MARK *, MARK *, char *, int));
824 file_write(SCR *sp, MARK *fm, MARK *tm, char *name, int flags)
826 enum { NEWFILE, OLDFILE } mtype;
827 struct stat sb;
828 EXF *ep;
829 FILE *fp;
830 FREF *frp;
831 MARK from, to;
832 size_t len;
833 u_long nlno, nch;
834 int fd, nf, noname, oflags, rval;
835 char *p, *s, *t, buf[MAXPATHLEN + 64];
836 const char *msgstr;
838 ep = sp->ep;
839 frp = sp->frp;
842 * Writing '%', or naming the current file explicitly, has the
843 * same semantics as writing without a name.
845 if (name == NULL || !strcmp(name, frp->name)) {
846 noname = 1;
847 name = frp->name;
848 } else
849 noname = 0;
851 /* Can't write files marked read-only, unless forced. */
852 if (!LF_ISSET(FS_FORCE) && noname && O_ISSET(sp, O_READONLY)) {
853 msgq(sp, M_ERR, LF_ISSET(FS_POSSIBLE) ?
854 "244|Read-only file, not written; use ! to override" :
855 "245|Read-only file, not written");
856 return (1);
859 /* If not forced, not appending, and "writeany" not set ... */
860 if (!LF_ISSET(FS_FORCE | FS_APPEND) && !O_ISSET(sp, O_WRITEANY)) {
861 /* Don't overwrite anything but the original file. */
862 if ((!noname || F_ISSET(frp, FR_NAMECHANGE)) &&
863 !stat(name, &sb)) {
864 msgq_str(sp, M_ERR, name,
865 LF_ISSET(FS_POSSIBLE) ?
866 "246|%s exists, not written; use ! to override" :
867 "247|%s exists, not written");
868 return (1);
872 * Don't write part of any existing file. Only test for the
873 * original file, the previous test catches anything else.
875 if (!LF_ISSET(FS_ALL) && noname && !stat(name, &sb)) {
876 msgq(sp, M_ERR, LF_ISSET(FS_POSSIBLE) ?
877 "248|Partial file, not written; use ! to override" :
878 "249|Partial file, not written");
879 return (1);
884 * Figure out if the file already exists -- if it doesn't, we display
885 * the "new file" message. The stat might not be necessary, but we
886 * just repeat it because it's easier than hacking the previous tests.
887 * The information is only used for the user message and modification
888 * time test, so we can ignore the obvious race condition.
890 * One final test. If we're not forcing or appending the current file,
891 * and we have a saved modification time, object if the file changed
892 * since we last edited or wrote it, and make them force it.
894 if (stat(name, &sb))
895 mtype = NEWFILE;
896 else {
897 if (noname && !LF_ISSET(FS_FORCE | FS_APPEND) &&
898 ((F_ISSET(ep, F_DEVSET) &&
899 (sb.st_dev != ep->mdev || sb.st_ino != ep->minode)) ||
900 sb.st_mtime != ep->mtime)) {
901 msgq_str(sp, M_ERR, name, LF_ISSET(FS_POSSIBLE) ?
902 "250|%s: file modified more recently than this copy; use ! to override" :
903 "251|%s: file modified more recently than this copy");
904 return (1);
907 mtype = OLDFILE;
910 /* Set flags to create, write, and either append or truncate. */
911 oflags = O_CREAT | O_WRONLY |
912 (LF_ISSET(FS_APPEND) ? O_APPEND : O_TRUNC);
914 /* Backup the file if requested. */
915 if (!opts_empty(sp, O_BACKUP, 1) &&
916 file_backup(sp, name, O_STR(sp, O_BACKUP)) && !LF_ISSET(FS_FORCE))
917 return (1);
919 /* Open the file. */
920 SIGBLOCK;
921 if ((fd = open(name, oflags,
922 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH)) < 0) {
923 msgq_str(sp, M_SYSERR, name, "%s");
924 SIGUNBLOCK;
925 return (1);
927 SIGUNBLOCK;
929 /* Try and get a lock. */
930 if (!noname && file_lock(sp, NULL, NULL, fd, 0) == LOCK_UNAVAIL)
931 msgq_str(sp, M_ERR, name,
932 "252|%s: write lock was unavailable");
934 #if __linux__
936 * XXX
937 * In libc 4.5.x, fdopen(fd, "w") clears the O_APPEND flag (if set).
938 * This bug is fixed in libc 4.6.x.
940 * This code works around this problem for libc 4.5.x users.
941 * Note that this code is harmless if you're using libc 4.6.x.
943 if (LF_ISSET(FS_APPEND) && lseek(fd, (off_t)0, SEEK_END) < 0) {
944 msgq(sp, M_SYSERR, name);
945 return (1);
947 #endif
950 * Use stdio for buffering.
952 * XXX
953 * SVR4.2 requires the fdopen mode exactly match the original open
954 * mode, i.e. you have to open with "a" if appending.
956 if ((fp = fdopen(fd, LF_ISSET(FS_APPEND) ? "a" : "w")) == NULL) {
957 msgq_str(sp, M_SYSERR, name, "%s");
958 (void)close(fd);
959 return (1);
962 /* Build fake addresses, if necessary. */
963 if (fm == NULL) {
964 from.lno = 1;
965 from.cno = 0;
966 fm = &from;
967 if (db_last(sp, &to.lno))
968 return (1);
969 to.cno = 0;
970 tm = &to;
973 rval = ex_writefp(sp, name, fp, fm, tm, &nlno, &nch, 0);
976 * Save the new last modification time -- even if the write fails
977 * we re-init the time. That way the user can clean up the disk
978 * and rewrite without having to force it.
980 if (noname) {
981 if (stat(name, &sb))
982 time(&ep->mtime);
983 else {
984 F_SET(ep, F_DEVSET);
985 ep->mdev = sb.st_dev;
986 ep->minode = sb.st_ino;
988 ep->mtime = sb.st_mtime;
993 * If the write failed, complain loudly. ex_writefp() has already
994 * complained about the actual error, reinforce it if data was lost.
996 if (rval) {
997 if (!LF_ISSET(FS_APPEND))
998 msgq_str(sp, M_ERR, name,
999 "254|%s: WARNING: FILE TRUNCATED");
1000 return (1);
1004 * Once we've actually written the file, it doesn't matter that the
1005 * file name was changed -- if it was, we've already whacked it.
1007 F_CLR(frp, FR_NAMECHANGE);
1010 * If wrote the entire file, and it wasn't by appending it to a file,
1011 * clear the modified bit. If the file was written to the original
1012 * file name and the file is a temporary, set the "no exit" bit. This
1013 * permits the user to write the file and use it in the context of the
1014 * filesystem, but still keeps them from discarding their changes by
1015 * exiting.
1017 if (LF_ISSET(FS_ALL) && !LF_ISSET(FS_APPEND)) {
1018 F_CLR(ep, F_MODIFIED);
1019 if (F_ISSET(frp, FR_TMPFILE)) {
1020 if (noname)
1021 F_SET(frp, FR_TMPEXIT);
1022 else
1023 F_CLR(frp, FR_TMPEXIT);
1027 p = msg_print(sp, name, &nf);
1028 switch (mtype) {
1029 case NEWFILE:
1030 msgstr = msg_cat(sp,
1031 "256|%s: new file: %lu lines, %lu characters", NULL);
1032 len = snprintf(buf, sizeof(buf), msgstr, p, nlno, nch);
1033 break;
1034 case OLDFILE:
1035 msgstr = msg_cat(sp, LF_ISSET(FS_APPEND) ?
1036 "315|%s: appended: %lu lines, %lu characters" :
1037 "257|%s: %lu lines, %lu characters", NULL);
1038 len = snprintf(buf, sizeof(buf), msgstr, p, nlno, nch);
1039 break;
1040 default:
1041 abort();
1045 * There's a nasty problem with long path names. Cscope and tags files
1046 * can result in long paths and vi will request a continuation key from
1047 * the user. Unfortunately, the user has typed ahead, and chaos will
1048 * result. If we assume that the characters in the filenames only take
1049 * a single screen column each, we can trim the filename.
1051 s = buf;
1052 if (len >= sp->cols) {
1053 for (s = buf, t = buf + strlen(p); s < t &&
1054 (*s != '/' || len >= sp->cols - 3); ++s, --len);
1055 if (s == t)
1056 s = buf;
1057 else {
1058 *--s = '.'; /* Leading ellipses. */
1059 *--s = '.';
1060 *--s = '.';
1063 msgq(sp, M_INFO, s);
1064 if (nf)
1065 FREE_SPACE(sp, p, 0);
1066 return (0);
1070 * file_backup --
1071 * Backup the about-to-be-written file.
1073 * XXX
1074 * We do the backup by copying the entire file. It would be nice to do
1075 * a rename instead, but: (1) both files may not fit and we want to fail
1076 * before doing the rename; (2) the backup file may not be on the same
1077 * disk partition as the file being written; (3) there may be optional
1078 * file information (MACs, DACs, whatever) that we won't get right if we
1079 * recreate the file. So, let's not risk it.
1081 static int
1082 file_backup(SCR *sp, char *name, char *bname)
1084 struct dirent *dp;
1085 struct stat sb;
1086 DIR *dirp;
1087 EXCMD cmd;
1088 off_t off;
1089 size_t blen;
1090 int flags, maxnum, nr, num, nw, rfd, wfd, version;
1091 char *bp, *estr, *p, *pct, *slash, *t, *wfname, buf[8192];
1092 CHAR_T *wp;
1093 size_t wlen;
1094 size_t nlen;
1095 char *d = NULL;
1097 rfd = wfd = -1;
1098 bp = estr = wfname = NULL;
1101 * Open the current file for reading. Do this first, so that
1102 * we don't exec a shell before the most likely failure point.
1103 * If it doesn't exist, it's okay, there's just nothing to back
1104 * up.
1106 errno = 0;
1107 if ((rfd = open(name, O_RDONLY, 0)) < 0) {
1108 if (errno == ENOENT)
1109 return (0);
1110 estr = name;
1111 goto err;
1115 * If the name starts with an 'N' character, add a version number
1116 * to the name. Strip the leading N from the string passed to the
1117 * expansion routines, for no particular reason. It would be nice
1118 * to permit users to put the version number anywhere in the backup
1119 * name, but there isn't a special character that we can use in the
1120 * name, and giving a new character a special meaning leads to ugly
1121 * hacks both here and in the supporting ex routines.
1123 * Shell and file name expand the option's value.
1125 ex_cinit(sp, &cmd, 0, 0, 0, 0, 0);
1126 if (bname[0] == 'N') {
1127 version = 1;
1128 ++bname;
1129 } else
1130 version = 0;
1131 CHAR2INT(sp, bname, strlen(bname) + 1, wp, wlen);
1132 if (argv_exp2(sp, &cmd, wp, wlen - 1))
1133 return (1);
1136 * 0 args: impossible.
1137 * 1 args: use it.
1138 * >1 args: object, too many args.
1140 if (cmd.argc != 1) {
1141 msgq_str(sp, M_ERR, bname,
1142 "258|%s expanded into too many file names");
1143 (void)close(rfd);
1144 return (1);
1148 * If appending a version number, read through the directory, looking
1149 * for file names that match the name followed by a number. Make all
1150 * of the other % characters in name literal, so the user doesn't get
1151 * surprised and sscanf doesn't drop core indirecting through pointers
1152 * that don't exist. If any such files are found, increment its number
1153 * by one.
1155 if (version) {
1156 GET_SPACE_GOTO(sp, bp, blen, cmd.argv[0]->len * 2 + 50);
1157 INT2SYS(sp, cmd.argv[0]->bp, cmd.argv[0]->len + 1,
1158 p, nlen);
1159 d = strdup(p);
1160 p = d;
1161 for (t = bp, slash = NULL;
1162 p[0] != '\0'; *t++ = *p++)
1163 if (p[0] == '%') {
1164 if (p[1] != '%')
1165 *t++ = '%';
1166 } else if (p[0] == '/')
1167 slash = t;
1168 pct = t;
1169 *t++ = '%';
1170 *t++ = 'd';
1171 *t = '\0';
1173 if (slash == NULL) {
1174 dirp = opendir(".");
1175 p = bp;
1176 } else {
1177 *slash = '\0';
1178 dirp = opendir(bp);
1179 *slash = '/';
1180 p = slash + 1;
1182 if (dirp == NULL) {
1183 INT2SYS(sp, cmd.argv[0]->bp, cmd.argv[0]->len + 1,
1184 estr, nlen);
1185 goto err;
1188 for (maxnum = 0; (dp = readdir(dirp)) != NULL;)
1189 if (sscanf(dp->d_name, p, &num) == 1 && num > maxnum)
1190 maxnum = num;
1191 (void)closedir(dirp);
1193 /* Format the backup file name. */
1194 (void)snprintf(pct, blen - (pct - bp), "%d", maxnum + 1);
1195 wfname = bp;
1196 } else {
1197 bp = NULL;
1198 INT2SYS(sp, cmd.argv[0]->bp, cmd.argv[0]->len + 1,
1199 wfname, nlen);
1202 /* Open the backup file, avoiding lurkers. */
1203 if (stat(wfname, &sb) == 0) {
1204 if (!S_ISREG(sb.st_mode)) {
1205 msgq_str(sp, M_ERR, bname,
1206 "259|%s: not a regular file");
1207 goto err;
1209 if (sb.st_uid != getuid()) {
1210 msgq_str(sp, M_ERR, bname, "260|%s: not owned by you");
1211 goto err;
1213 if (sb.st_mode & (S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH)) {
1214 msgq_str(sp, M_ERR, bname,
1215 "261|%s: accessible by a user other than the owner");
1216 goto err;
1218 flags = O_TRUNC;
1219 } else
1220 flags = O_CREAT | O_EXCL;
1221 if ((wfd = open(wfname, flags | O_WRONLY, S_IRUSR | S_IWUSR)) < 0) {
1222 estr = bname;
1223 goto err;
1226 /* Copy the file's current contents to its backup value. */
1227 while ((nr = read(rfd, buf, sizeof(buf))) > 0)
1228 for (off = 0; nr != 0; nr -= nw, off += nw)
1229 if ((nw = write(wfd, buf + off, nr)) < 0) {
1230 estr = wfname;
1231 goto err;
1233 if (nr < 0) {
1234 estr = name;
1235 goto err;
1238 if (close(rfd)) {
1239 estr = name;
1240 goto err;
1242 if (close(wfd)) {
1243 estr = wfname;
1244 goto err;
1246 if (bp != NULL)
1247 FREE_SPACE(sp, bp, blen);
1248 return (0);
1250 alloc_err:
1251 err: if (rfd != -1)
1252 (void)close(rfd);
1253 if (wfd != -1) {
1254 (void)unlink(wfname);
1255 (void)close(wfd);
1257 if (estr)
1258 msgq_str(sp, M_SYSERR, estr, "%s");
1259 if (d != NULL)
1260 free(d);
1261 if (bp != NULL)
1262 FREE_SPACE(sp, bp, blen);
1263 return (1);
1267 * file_comment --
1268 * Skip the first comment.
1270 static void
1271 file_comment(SCR *sp)
1273 db_recno_t lno;
1274 size_t len;
1275 CHAR_T *p;
1277 for (lno = 1; !db_get(sp, lno, 0, &p, &len) && len == 0; ++lno);
1278 if (p == NULL)
1279 return;
1280 if (p[0] == '#') {
1281 F_SET(sp, SC_SCR_TOP);
1282 while (!db_get(sp, ++lno, 0, &p, &len))
1283 if (len < 1 || p[0] != '#') {
1284 sp->lno = lno;
1285 return;
1287 } else if (len > 1 && p[0] == '/' && p[1] == '*') {
1288 F_SET(sp, SC_SCR_TOP);
1289 do {
1290 for (; len > 1; --len, ++p)
1291 if (p[0] == '*' && p[1] == '/') {
1292 sp->lno = lno;
1293 return;
1295 } while (!db_get(sp, ++lno, 0, &p, &len));
1296 } else if (len > 1 && p[0] == '/' && p[1] == '/') {
1297 F_SET(sp, SC_SCR_TOP);
1298 while (!db_get(sp, ++lno, 0, &p, &len))
1299 if (len < 1 || p[0] != '/' || p[1] != '/') {
1300 sp->lno = lno;
1301 return;
1307 * file_m1 --
1308 * First modification check routine. The :next, :prev, :rewind, :tag,
1309 * :tagpush, :tagpop, ^^ modifications check.
1311 * PUBLIC: int file_m1 __P((SCR *, int, int));
1314 file_m1(SCR *sp, int force, int flags)
1316 EXF *ep;
1318 ep = sp->ep;
1320 /* If no file loaded, return no modifications. */
1321 if (ep == NULL)
1322 return (0);
1325 * If the file has been modified, we'll want to write it back or
1326 * fail. If autowrite is set, we'll write it back automatically,
1327 * unless force is also set. Otherwise, we fail unless forced or
1328 * there's another open screen on this file.
1330 if (F_ISSET(ep, F_MODIFIED)) {
1331 if (O_ISSET(sp, O_AUTOWRITE)) {
1332 if (!force && file_aw(sp, flags))
1333 return (1);
1334 } else if (ep->refcnt <= 1 && !force) {
1335 msgq(sp, M_ERR, LF_ISSET(FS_POSSIBLE) ?
1336 "262|File modified since last complete write; write or use ! to override" :
1337 "263|File modified since last complete write; write or use :edit! to override");
1338 return (1);
1342 return (file_m3(sp, force));
1346 * file_m2 --
1347 * Second modification check routine. The :edit, :quit, :recover
1348 * modifications check.
1350 * PUBLIC: int file_m2 __P((SCR *, int));
1353 file_m2(SCR *sp, int force)
1355 EXF *ep;
1357 ep = sp->ep;
1359 /* If no file loaded, return no modifications. */
1360 if (ep == NULL)
1361 return (0);
1364 * If the file has been modified, we'll want to fail, unless forced
1365 * or there's another open screen on this file.
1367 if (F_ISSET(ep, F_MODIFIED) && ep->refcnt <= 1 && !force) {
1368 msgq(sp, M_ERR,
1369 "264|File modified since last complete write; write or use ! to override");
1370 return (1);
1373 return (file_m3(sp, force));
1377 * file_m3 --
1378 * Third modification check routine.
1380 * PUBLIC: int file_m3 __P((SCR *, int));
1383 file_m3(SCR *sp, int force)
1385 EXF *ep;
1387 ep = sp->ep;
1389 /* If no file loaded, return no modifications. */
1390 if (ep == NULL)
1391 return (0);
1394 * Don't exit while in a temporary files if the file was ever modified.
1395 * The problem is that if the user does a ":wq", we write and quit,
1396 * unlinking the temporary file. Not what the user had in mind at all.
1397 * We permit writing to temporary files, so that user maps using file
1398 * system names work with temporary files.
1400 if (F_ISSET(sp->frp, FR_TMPEXIT) && ep->refcnt <= 1 && !force) {
1401 msgq(sp, M_ERR,
1402 "265|File is a temporary; exit will discard modifications");
1403 return (1);
1405 return (0);
1409 * file_aw --
1410 * Autowrite routine. If modified, autowrite is set and the readonly bit
1411 * is not set, write the file. A routine so there's a place to put the
1412 * comment.
1414 * PUBLIC: int file_aw __P((SCR *, int));
1417 file_aw(SCR *sp, int flags)
1419 if (!F_ISSET(sp->ep, F_MODIFIED))
1420 return (0);
1421 if (!O_ISSET(sp, O_AUTOWRITE))
1422 return (0);
1425 * !!!
1426 * Historic 4BSD vi attempted to write the file if autowrite was set,
1427 * regardless of the writeability of the file (as defined by the file
1428 * readonly flag). System V changed this as some point, not attempting
1429 * autowrite if the file was readonly. This feels like a bug fix to
1430 * me (e.g. the principle of least surprise is violated if readonly is
1431 * set and vi writes the file), so I'm compatible with System V.
1433 if (O_ISSET(sp, O_READONLY)) {
1434 msgq(sp, M_INFO,
1435 "266|File readonly, modifications not auto-written");
1436 return (1);
1438 return (file_write(sp, NULL, NULL, NULL, flags));
1442 * set_alt_name --
1443 * Set the alternate pathname.
1445 * Set the alternate pathname. It's a routine because I wanted some place
1446 * to hang this comment. The alternate pathname (normally referenced using
1447 * the special character '#' during file expansion and in the vi ^^ command)
1448 * is set by almost all ex commands that take file names as arguments. The
1449 * rules go something like this:
1451 * 1: If any ex command takes a file name as an argument (except for the
1452 * :next command), the alternate pathname is set to that file name.
1453 * This excludes the command ":e" and ":w !command" as no file name
1454 * was specified. Note, historically, the :source command did not set
1455 * the alternate pathname. It does in nvi, for consistency.
1457 * 2: However, if any ex command sets the current pathname, e.g. the
1458 * ":e file" or ":rew" commands succeed, then the alternate pathname
1459 * is set to the previous file's current pathname, if it had one.
1460 * This includes the ":file" command and excludes the ":e" command.
1461 * So, by rule #1 and rule #2, if ":edit foo" fails, the alternate
1462 * pathname will be "foo", if it succeeds, the alternate pathname will
1463 * be the previous current pathname. The ":e" command will not set
1464 * the alternate or current pathnames regardless.
1466 * 3: However, if it's a read or write command with a file argument and
1467 * the current pathname has not yet been set, the file name becomes
1468 * the current pathname, and the alternate pathname is unchanged.
1470 * If the user edits a temporary file, there may be times when there is no
1471 * alternative file name. A name argument of NULL turns it off.
1473 * PUBLIC: void set_alt_name __P((SCR *, char *));
1475 void
1476 set_alt_name(SCR *sp, char *name)
1478 if (sp->alt_name != NULL)
1479 free(sp->alt_name);
1480 if (name == NULL)
1481 sp->alt_name = NULL;
1482 else if ((sp->alt_name = strdup(name)) == NULL)
1483 msgq(sp, M_SYSERR, NULL);
1487 * file_lock --
1488 * Get an exclusive lock on a file.
1490 * XXX
1491 * The default locking is flock(2) style, not fcntl(2). The latter is
1492 * known to fail badly on some systems, and its only advantage is that
1493 * it occasionally works over NFS.
1495 * Furthermore, the semantics of fcntl(2) are wrong. The problems are
1496 * two-fold: you can't close any file descriptor associated with the file
1497 * without losing all of the locks, and you can't get an exclusive lock
1498 * unless you have the file open for writing. Someone ought to be shot,
1499 * but it's probably too late, they may already have reproduced. To get
1500 * around these problems, nvi opens the files for writing when it can and
1501 * acquires a second file descriptor when it can't. The recovery files
1502 * are examples of the former, they're always opened for writing. The DB
1503 * files can't be opened for writing because the semantics of DB are that
1504 * files opened for writing are flushed back to disk when the DB session
1505 * is ended. So, in that case we have to acquire an extra file descriptor.
1507 * PUBLIC: lockr_t file_lock __P((SCR *, char *, int *, int, int));
1509 lockr_t
1510 file_lock(SCR *sp, char *name, int *fdp, int fd, int iswrite)
1512 if (!O_ISSET(sp, O_LOCKFILES))
1513 return (LOCK_SUCCESS);
1515 #ifdef HAVE_LOCK_FLOCK /* Hurrah! We've got flock(2). */
1517 * !!!
1518 * We need to distinguish a lock not being available for the file
1519 * from the file system not supporting locking. Flock is documented
1520 * as returning EWOULDBLOCK; add EAGAIN for good measure, and assume
1521 * they are the former. There's no portable way to do this.
1523 errno = 0;
1524 return (flock(fd, LOCK_EX | LOCK_NB) ? errno == EAGAIN
1525 #ifdef EWOULDBLOCK
1526 || errno == EWOULDBLOCK
1527 #endif
1528 ? LOCK_UNAVAIL : LOCK_FAILED : LOCK_SUCCESS);
1529 #endif
1530 #ifdef HAVE_LOCK_FCNTL /* Gag me. We've got fcntl(2). */
1532 struct flock arg;
1533 int didopen, sverrno;
1535 arg.l_type = F_WRLCK;
1536 arg.l_whence = 0; /* SEEK_SET */
1537 arg.l_start = arg.l_len = 0;
1538 arg.l_pid = 0;
1541 * If the file descriptor isn't opened for writing, it must fail.
1542 * If we fail because we can't get a read/write file descriptor,
1543 * we return LOCK_SUCCESS, believing that the file is readonly
1544 * and that will be sufficient to warn the user.
1546 if (!iswrite) {
1547 if (name == NULL || fdp == NULL)
1548 return (LOCK_FAILED);
1549 if ((fd = open(name, O_RDWR, 0)) == -1)
1550 return (LOCK_SUCCESS);
1551 *fdp = fd;
1552 didopen = 1;
1555 errno = 0;
1556 if (!fcntl(fd, F_SETLK, &arg))
1557 return (LOCK_SUCCESS);
1558 if (didopen) {
1559 sverrno = errno;
1560 (void)close(fd);
1561 errno = sverrno;
1565 * !!!
1566 * We need to distinguish a lock not being available for the file
1567 * from the file system not supporting locking. Fcntl is documented
1568 * as returning EACCESS and EAGAIN; add EWOULDBLOCK for good measure,
1569 * and assume they are the former. There's no portable way to do this.
1571 return (errno == EACCES || errno == EAGAIN
1572 #ifdef EWOULDBLOCK
1573 || errno == EWOULDBLOCK
1574 #endif
1575 ? LOCK_UNAVAIL : LOCK_FAILED);
1577 #endif
1578 #if !defined(HAVE_LOCK_FLOCK) && !defined(HAVE_LOCK_FCNTL)
1579 return (LOCK_SUCCESS);
1580 #endif
1583 #ifdef USE_DB4_LOGGING
1584 #define VI_DB_INIT_LOG DB_INIT_LOG
1585 #else
1586 #define VI_DB_INIT_LOG 0
1587 #endif
1589 static int
1590 db_setup(SCR *sp, EXF *ep)
1592 char path[MAXPATHLEN];
1593 int fd;
1594 DB_ENV *env;
1596 (void)snprintf(path, sizeof(path), "%s/vi.XXXXXX", O_STR(sp, O_RECDIR));
1597 if ((fd = mkstemp(path)) == -1) {
1598 msgq(sp, M_SYSERR, "%s", path);
1599 goto err;
1601 (void)close(fd);
1602 (void)unlink(path);
1603 if (mkdir(path, S_IRWXU)) {
1604 msgq(sp, M_SYSERR, "%s", path);
1605 goto err;
1607 if (db_env_create(&env, 0)) {
1608 msgq(sp, M_ERR, "env_create");
1609 goto err;
1611 #ifdef USE_DB4_LOGGING
1612 if ((sp->db_error = vi_db_init_recover(env))) {
1613 msgq(sp, M_DBERR, "init_recover");
1614 goto err;
1616 if ((sp->db_error = __vi_init_recover(env))) {
1617 msgq(sp, M_DBERR, "init_recover");
1618 goto err;
1620 #endif
1621 if ((sp->db_error = env->open(env, path,
1622 DB_PRIVATE | DB_CREATE | DB_INIT_MPOOL | VI_DB_THREAD
1623 | VI_DB_INIT_LOG, 0)) != 0) {
1624 msgq(sp, M_DBERR, "env->open");
1625 goto err;
1628 if ((ep->env_path = strdup(path)) == NULL) {
1629 msgq(sp, M_SYSERR, NULL);
1630 (void)rmdir(path);
1631 goto err;
1633 ep->env = env;
1634 return 0;
1635 err:
1636 return 1;