guard against Solaris preprocessor polution
[nvi.git] / common / exf.c
blobd665a45577eb219de98c79f1f44ecaf18091e902
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.62 2001/05/12 15:16:05 skimo Exp $ (Berkeley) $Date: 2001/05/12 15:16:05 $";
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 *));
47 * file_add --
48 * Insert a file name into the FREF list, if it doesn't already
49 * appear in it.
51 * !!!
52 * The "if it doesn't already appear" changes vi's semantics slightly. If
53 * you do a "vi foo bar", and then execute "next bar baz", the edit of bar
54 * will reflect the line/column of the previous edit session. Historic nvi
55 * did not do this. The change is a logical extension of the change where
56 * vi now remembers the last location in any file that it has ever edited,
57 * not just the previously edited file.
59 * PUBLIC: FREF *file_add __P((SCR *, char *));
61 FREF *
62 file_add(sp, name)
63 SCR *sp;
64 char *name;
66 GS *gp;
67 FREF *frp, *tfrp;
70 * Return it if it already exists. Note that we test against the
71 * user's name, whatever that happens to be, including if it's a
72 * temporary file.
74 * If the user added a file but was unable to initialize it, there
75 * can be file list entries where the name field is NULL. Discard
76 * them the next time we see them.
78 gp = sp->gp;
79 if (name != NULL)
80 for (frp = gp->frefq.cqh_first;
81 frp != (FREF *)&gp->frefq; frp = frp->q.cqe_next) {
82 if (frp->name == NULL) {
83 tfrp = frp->q.cqe_next;
84 CIRCLEQ_REMOVE(&gp->frefq, frp, q);
85 if (frp->name != NULL)
86 free(frp->name);
87 free(frp);
88 frp = tfrp;
89 continue;
91 if (!strcmp(frp->name, name))
92 return (frp);
95 /* Allocate and initialize the FREF structure. */
96 CALLOC(sp, frp, FREF *, 1, sizeof(FREF));
97 if (frp == NULL)
98 return (NULL);
101 * If no file name specified, or if the file name is a request
102 * for something temporary, file_init() will allocate the file
103 * name. Temporary files are always ignored.
105 if (name != NULL && strcmp(name, TEMPORARY_FILE_STRING) &&
106 (frp->name = strdup(name)) == NULL) {
107 free(frp);
108 msgq(sp, M_SYSERR, NULL);
109 return (NULL);
112 /* Append into the chain of file names. */
113 CIRCLEQ_INSERT_TAIL(&gp->frefq, frp, q);
115 return (frp);
119 * file_init --
120 * Start editing a file, based on the FREF structure. If successsful,
121 * let go of any previous file. Don't release the previous file until
122 * absolutely sure we have the new one.
124 * PUBLIC: int file_init __P((SCR *, FREF *, char *, int));
127 file_init(sp, frp, rcv_name, flags)
128 SCR *sp;
129 FREF *frp;
130 char *rcv_name;
131 int flags;
133 EXF *ep;
134 struct stat sb;
135 size_t psize;
136 int fd, exists, open_err, readonly, stolen;
137 char *oname, tname[MAXPATHLEN];
139 stolen = open_err = readonly = 0;
142 * If the file is a recovery file, let the recovery code handle it.
143 * Clear the FR_RECOVER flag first -- the recovery code does set up,
144 * and then calls us! If the recovery call fails, it's probably
145 * because the named file doesn't exist. So, move boldly forward,
146 * presuming that there's an error message the user will get to see.
148 if (F_ISSET(frp, FR_RECOVER)) {
149 F_CLR(frp, FR_RECOVER);
150 return (rcv_read(sp, frp));
154 * Required FRP initialization; the only flag we keep is the
155 * cursor information.
157 F_CLR(frp, ~FR_CURSORSET);
160 * Scan the user's path to find the file that we're going to
161 * try and open.
163 if (file_spath(sp, frp, &sb, &exists))
164 return (1);
167 * Check whether we already have this file opened in some
168 * other screen.
170 if (exists) {
171 EXF *exfp;
172 for (exfp = sp->gp->exfq.cqh_first;
173 exfp != (EXF *)&sp->gp->exfq; exfp = exfp->q.cqe_next) {
174 if (exfp->mdev == sb.st_dev &&
175 exfp->minode == sb.st_ino &&
176 (exfp != sp->ep || exfp->refcnt > 1)) {
177 ep = exfp;
178 goto postinit;
184 * Required EXF initialization:
185 * Flush the line caches.
186 * Default recover mail file fd to -1.
187 * Set initial EXF flag bits.
189 CALLOC_RET(sp, ep, EXF *, 1, sizeof(EXF));
190 ep->c_lno = ep->c_nlines = OOBLNO;
191 ep->rcv_fd = ep->fcntl_fd = -1;
192 F_SET(ep, F_FIRSTMODIFY);
195 * If no name or backing file, for whatever reason, create a backing
196 * temporary file, saving the temp file name so we can later unlink
197 * it. If the user never named this file, copy the temporary file name
198 * to the real name (we display that until the user renames it).
200 oname = frp->name;
201 if (LF_ISSET(FS_OPENERR) || oname == NULL || !exists) {
202 if (opts_empty(sp, O_DIRECTORY, 0))
203 goto err;
204 (void)snprintf(tname, sizeof(tname),
205 "%s/vi.XXXXXX", O_STR(sp, O_DIRECTORY));
206 if ((fd = mkstemp(tname)) == -1) {
207 msgq(sp, M_SYSERR,
208 "237|Unable to create temporary file");
209 goto err;
211 (void)close(fd);
213 if (frp->name == NULL)
214 F_SET(frp, FR_TMPFILE);
215 if ((frp->tname = strdup(tname)) == NULL ||
216 (frp->name == NULL &&
217 (frp->name = strdup(tname)) == NULL)) {
218 if (frp->tname != NULL) {
219 free(frp->tname);
221 msgq(sp, M_SYSERR, NULL);
222 (void)unlink(tname);
223 goto err;
225 oname = frp->tname;
226 psize = 1024;
227 if (!LF_ISSET(FS_OPENERR))
228 F_SET(frp, FR_NEWFILE);
230 time(&ep->mtime);
231 } else {
233 * XXX
234 * A seat of the pants calculation: try to keep the file in
235 * 15 pages or less. Don't use a page size larger than 10K
236 * (vi should have good locality) or smaller than 1K.
238 psize = ((sb.st_size / 15) + 1023) / 1024;
239 if (psize > 10)
240 psize = 10;
241 if (psize == 0)
242 psize = 1;
243 psize *= 1024;
245 F_SET(ep, F_DEVSET);
246 ep->mdev = sb.st_dev;
247 ep->minode = sb.st_ino;
249 ep->mtime = sb.st_mtime;
251 if (!S_ISREG(sb.st_mode))
252 msgq_str(sp, M_ERR, oname,
253 "238|Warning: %s is not a regular file");
256 /* Set up recovery. */
257 if (rcv_name == NULL) {
258 /* ep->rcv_path NULL if rcv_tmp fails */
259 rcv_tmp(sp, ep, frp->name);
260 } else {
261 if ((ep->rcv_path = strdup(rcv_name)) == NULL) {
262 msgq(sp, M_SYSERR, NULL);
263 goto err;
265 F_SET(ep, F_MODIFIED);
268 /* Open a db structure. */
269 if ((sp->db_error = db_create(&ep->db, sp->gp->env, 0)) != 0) {
270 /* XXXX */
271 fprintf(stderr, "db_create %d\n", sp->db_error);
272 goto err;
275 ep->db->set_re_delim(ep->db, '\n'); /* Always set. */
276 ep->db->set_pagesize(ep->db, psize);
277 ep->db->set_flags(ep->db, DB_RENUMBER |
278 (F_ISSET(sp->gp, G_SNAPSHOT) ? DB_SNAPSHOT : 0));
279 if (rcv_name == NULL)
280 ep->db->set_re_source(ep->db, oname);
283 * Don't let db use mmap when using fcntl for locking
285 #ifdef HAVE_LOCK_FCNTL
286 #define NOMMAPIFFCNTL DB_NOMMAP
287 #else
288 #define NOMMAPIFFCNTL 0
289 #endif
291 if ((sp->db_error = ep->db->open(ep->db, ep->rcv_path, NULL, DB_RECNO,
292 ((rcv_name == 0) ? DB_TRUNCATE : 0) | VI_DB_THREAD | NOMMAPIFFCNTL,
293 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH)) != 0) {
294 msgq_str(sp,
295 M_DBERR, rcv_name == NULL ? oname : rcv_name, "%s");
297 * !!!
298 * Historically, vi permitted users to edit files that couldn't
299 * be read. This isn't useful for single files from a command
300 * line, but it's quite useful for "vi *.c", since you can skip
301 * past files that you can't read.
303 ep->db = NULL; /* Don't close it; it wasn't opened */
305 if (LF_ISSET(FS_OPENERR))
306 goto err;
308 open_err = 1;
309 goto oerr;
313 * Do the remaining things that can cause failure of the new file,
314 * mark and logging initialization.
316 if (mark_init(sp, ep) || log_init(sp, ep))
317 goto err;
319 postinit:
321 * Set the alternate file name to be the file we're discarding.
323 * !!!
324 * Temporary files can't become alternate files, so there's no file
325 * name. This matches historical practice, although it could only
326 * happen in historical vi as the result of the initial command, i.e.
327 * if vi was executed without a file name.
329 if (LF_ISSET(FS_SETALT))
330 set_alt_name(sp, sp->frp == NULL ||
331 F_ISSET(sp->frp, FR_TMPFILE) ? NULL : sp->frp->name);
334 * Close the previous file; if that fails, close the new one and run
335 * for the border.
337 * !!!
338 * There's a nasty special case. If the user edits a temporary file,
339 * and then does an ":e! %", we need to re-initialize the backing
340 * file, but we can't change the name. (It's worse -- we're dealing
341 * with *names* here, we can't even detect that it happened.) Set a
342 * flag so that the file_end routine ignores the backing information
343 * of the old file if it happens to be the same as the new one.
345 * !!!
346 * Side-effect: after the call to file_end(), sp->frp may be NULL.
348 if (sp->ep != NULL) {
349 F_SET(frp, FR_DONTDELETE);
350 if (file_end(sp, NULL, LF_ISSET(FS_FORCE))) {
351 (void)file_end(sp, ep, 1);
352 goto err;
354 sp->ep = NULL;
355 F_CLR(frp, FR_DONTDELETE);
359 * Lock the file; if it's a recovery file, it should already be
360 * locked. Note, we acquire the lock after the previous file
361 * has been ended, so that we don't get an "already locked" error
362 * for ":edit!".
364 * XXX
365 * While the user can't interrupt us between the open and here,
366 * there's a race between the dbopen() and the lock. Not much
367 * we can do about it.
369 * XXX
370 * We don't make a big deal of not being able to lock the file. As
371 * locking rarely works over NFS, and often fails if the file was
372 * mmap(2)'d, it's far too common to do anything like print an error
373 * message, let alone make the file readonly. At some future time,
374 * when locking is a little more reliable, this should change to be
375 * an error.
377 if (rcv_name == NULL && ep->refcnt == 0) {
378 if ((ep->fd = open(oname, O_RDWR)) == -1)
379 goto no_lock;
381 switch (file_lock(sp, oname, &ep->fcntl_fd, ep->fd, 1)) {
382 case LOCK_FAILED:
383 no_lock:
384 F_SET(frp, FR_UNLOCKED);
385 break;
386 case LOCK_UNAVAIL:
387 readonly = 1;
388 msgq_str(sp, M_INFO, oname,
389 "239|%s already locked, session is read-only");
390 break;
391 case LOCK_SUCCESS:
392 break;
397 * Historically, the readonly edit option was set per edit buffer in
398 * vi, unless the -R command-line option was specified or the program
399 * was executed as "view". (Well, to be truthful, if the letter 'w'
400 * occurred anywhere in the program name, but let's not get into that.)
401 * So, the persistant readonly state has to be stored in the screen
402 * structure, and the edit option value toggles with the contents of
403 * the edit buffer. If the persistant readonly flag is set, set the
404 * readonly edit option.
406 * Otherwise, try and figure out if a file is readonly. This is a
407 * dangerous thing to do. The kernel is the only arbiter of whether
408 * or not a file is writeable, and the best that a user program can
409 * do is guess. Obvious loopholes are files that are on a file system
410 * mounted readonly (access catches this one on a few systems), or
411 * alternate protection mechanisms, ACL's for example, that we can't
412 * portably check. Lots of fun, and only here because users whined.
414 * !!!
415 * Historic vi displayed the readonly message if none of the file
416 * write bits were set, or if an an access(2) call on the path
417 * failed. This seems reasonable. If the file is mode 444, root
418 * users may want to know that the owner of the file did not expect
419 * it to be written.
421 * Historic vi set the readonly bit if no write bits were set for
422 * a file, even if the access call would have succeeded. This makes
423 * the superuser force the write even when vi expects that it will
424 * succeed. I'm less supportive of this semantic, but it's historic
425 * practice and the conservative approach to vi'ing files as root.
427 * It would be nice if there was some way to update this when the user
428 * does a "^Z; chmod ...". The problem is that we'd first have to
429 * distinguish between readonly bits set because of file permissions
430 * and those set for other reasons. That's not too hard, but deciding
431 * when to reevaluate the permissions is trickier. An alternative
432 * might be to turn off the readonly bit if the user forces a write
433 * and it succeeds.
435 * XXX
436 * Access(2) doesn't consider the effective uid/gid values. This
437 * probably isn't a problem for vi when it's running standalone.
439 if (readonly || F_ISSET(sp, SC_READONLY) ||
440 (!F_ISSET(frp, FR_NEWFILE) &&
441 (!(sb.st_mode & (S_IWUSR | S_IWGRP | S_IWOTH)) ||
442 access(frp->name, W_OK))))
443 O_SET(sp, O_READONLY);
444 else
445 O_CLR(sp, O_READONLY);
447 /* Switch... */
448 ++ep->refcnt;
449 sp->ep = ep;
450 sp->frp = frp;
452 /* Set the initial cursor position, queue initial command. */
453 file_cinit(sp);
455 /* Report conversion errors again. */
456 F_CLR(sp, SC_CONV_ERROR);
458 /* Redraw the screen from scratch, schedule a welcome message. */
459 F_SET(sp, SC_SCR_REFORMAT | SC_SCR_TOP | SC_STATUS);
461 /* Append into the chain of file structures. */
462 if (ep->refcnt == 1)
463 CIRCLEQ_INSERT_TAIL(&sp->gp->exfq, ep, q);
465 return (0);
467 err: if (frp->name != NULL) {
468 free(frp->name);
469 frp->name = NULL;
471 if (frp->tname != NULL) {
472 (void)unlink(frp->tname);
473 free(frp->tname);
474 frp->tname = NULL;
477 oerr: if (F_ISSET(ep, F_RCV_ON))
478 (void)unlink(ep->rcv_path);
479 if (ep->rcv_path != NULL) {
480 free(ep->rcv_path);
481 ep->rcv_path = NULL;
483 if (ep->db != NULL) {
484 (void)ep->db->close(ep->db, DB_NOSYNC);
485 ep->db = NULL;
487 free(ep);
489 return (open_err && !LF_ISSET(FS_OPENERR) ?
490 file_init(sp, frp, rcv_name, flags | FS_OPENERR) : 1);
494 * file_spath --
495 * Scan the user's path to find the file that we're going to
496 * try and open.
498 static int
499 file_spath(sp, frp, sbp, existsp)
500 SCR *sp;
501 FREF *frp;
502 struct stat *sbp;
503 int *existsp;
505 CHAR_T savech;
506 size_t len;
507 int found;
508 char *name, *p, *t, path[MAXPATHLEN];
511 * If the name is NULL or an explicit reference (i.e., the first
512 * component is . or ..) ignore the O_PATH option.
514 name = frp->name;
515 if (name == NULL) {
516 *existsp = 0;
517 return (0);
519 if (name[0] == '/' || (name[0] == '.' &&
520 (name[1] == '/' || (name[1] == '.' && name[2] == '/')))) {
521 *existsp = !stat(name, sbp);
522 return (0);
525 /* Try . */
526 if (!stat(name, sbp)) {
527 *existsp = 1;
528 return (0);
531 /* Try the O_PATH option values. */
532 for (found = 0, p = t = O_STR(sp, O_PATH);; ++p)
533 if (*p == ':' || *p == '\0') {
534 if (t < p - 1) {
535 savech = *p;
536 *p = '\0';
537 len = snprintf(path,
538 sizeof(path), "%s/%s", t, name);
539 *p = savech;
540 if (!stat(path, sbp)) {
541 found = 1;
542 break;
545 t = p + 1;
546 if (*p == '\0')
547 break;
550 /* If we found it, build a new pathname and discard the old one. */
551 if (found) {
552 MALLOC_RET(sp, p, char *, len + 1);
553 memcpy(p, path, len + 1);
554 free(frp->name);
555 frp->name = p;
557 *existsp = found;
558 return (0);
562 * file_cinit --
563 * Set up the initial cursor position.
565 static void
566 file_cinit(sp)
567 SCR *sp;
569 GS *gp;
570 MARK m;
571 size_t len;
572 int nb;
573 CHAR_T *wp;
574 size_t wlen;
576 /* Set some basic defaults. */
577 sp->lno = 1;
578 sp->cno = 0;
581 * Historically, initial commands (the -c option) weren't executed
582 * until a file was loaded, e.g. "vi +10 nofile", followed by an
583 * :edit or :tag command, would execute the +10 on the file loaded
584 * by the subsequent command, (assuming that it existed). This
585 * applied as well to files loaded using the tag commands, and we
586 * follow that historic practice. Also, all initial commands were
587 * ex commands and were always executed on the last line of the file.
589 * Otherwise, if no initial command for this file:
590 * If in ex mode, move to the last line, first nonblank character.
591 * If the file has previously been edited, move to the last known
592 * position, and check it for validity.
593 * Otherwise, move to the first line, first nonblank.
595 * This gets called by the file init code, because we may be in a
596 * file of ex commands and we want to execute them from the right
597 * location in the file.
599 nb = 0;
600 gp = sp->gp;
601 if (gp->c_option != NULL && !F_ISSET(sp->frp, FR_NEWFILE)) {
602 if (db_last(sp, &sp->lno))
603 return;
604 if (sp->lno == 0) {
605 sp->lno = 1;
606 sp->cno = 0;
608 CHAR2INT(sp, gp->c_option, strlen(gp->c_option) + 1,
609 wp, wlen);
610 if (ex_run_str(sp, "-c option", wp, wlen - 1, 1, 1))
611 return;
612 gp->c_option = NULL;
613 } else if (F_ISSET(sp, SC_EX)) {
614 if (db_last(sp, &sp->lno))
615 return;
616 if (sp->lno == 0) {
617 sp->lno = 1;
618 sp->cno = 0;
619 return;
621 nb = 1;
622 } else {
623 if (F_ISSET(sp->frp, FR_CURSORSET)) {
624 sp->lno = sp->frp->lno;
625 sp->cno = sp->frp->cno;
627 /* If returning to a file in vi, center the line. */
628 F_SET(sp, SC_SCR_CENTER);
629 } else {
630 if (O_ISSET(sp, O_COMMENT))
631 file_comment(sp);
632 else
633 sp->lno = 1;
634 nb = 1;
636 if (db_get(sp, sp->lno, 0, NULL, &len)) {
637 sp->lno = 1;
638 sp->cno = 0;
639 return;
641 if (!nb && sp->cno > len)
642 nb = 1;
644 if (nb) {
645 sp->cno = 0;
646 (void)nonblank(sp, sp->lno, &sp->cno);
650 * !!!
651 * The initial column is also the most attractive column.
653 sp->rcm = sp->cno;
656 * !!!
657 * Historically, vi initialized the absolute mark, but ex did not.
658 * Which meant, that if the first command in ex mode was "visual",
659 * or if an ex command was executed first (e.g. vi +10 file) vi was
660 * entered without the mark being initialized. For consistency, if
661 * the file isn't empty, we initialize it for everyone, believing
662 * that it can't hurt, and is generally useful. Not initializing it
663 * if the file is empty is historic practice, although it has always
664 * been possible to set (and use) marks in empty vi files.
666 m.lno = sp->lno;
667 m.cno = sp->cno;
668 (void)mark_set(sp, ABSMARK1, &m, 0);
672 * file_end --
673 * Stop editing a file.
675 * PUBLIC: int file_end __P((SCR *, EXF *, int));
678 file_end(sp, ep, force)
679 SCR *sp;
680 EXF *ep;
681 int force;
683 FREF *frp;
686 * !!!
687 * ep MAY NOT BE THE SAME AS sp->ep, DON'T USE THE LATTER.
688 * (If argument ep is NULL, use sp->ep.)
690 * If multiply referenced, just decrement the count and return.
692 if (ep == NULL)
693 ep = sp->ep;
694 if (--ep->refcnt != 0)
695 return (0);
699 * Clean up the FREF structure.
701 * Save the cursor location.
703 * XXX
704 * It would be cleaner to do this somewhere else, but by the time
705 * ex or vi knows that we're changing files it's already happened.
707 frp = sp->frp;
708 frp->lno = sp->lno;
709 frp->cno = sp->cno;
710 F_SET(frp, FR_CURSORSET);
713 * We may no longer need the temporary backing file, so clean it
714 * up. We don't need the FREF structure either, if the file was
715 * never named, so lose it.
717 * !!!
718 * Re: FR_DONTDELETE, see the comment above in file_init().
720 if (!F_ISSET(frp, FR_DONTDELETE) && frp->tname != NULL) {
721 if (unlink(frp->tname))
722 msgq_str(sp, M_SYSERR, frp->tname, "240|%s: remove");
723 free(frp->tname);
724 frp->tname = NULL;
725 if (F_ISSET(frp, FR_TMPFILE)) {
726 CIRCLEQ_REMOVE(&sp->gp->frefq, frp, q);
727 if (frp->name != NULL)
728 free(frp->name);
729 free(frp);
731 sp->frp = NULL;
735 * Clean up the EXF structure.
737 * Close the db structure.
739 if (ep->db->close != NULL) {
740 if ((sp->db_error = ep->db->close(ep->db, DB_NOSYNC)) != 0 &&
741 !force) {
742 msgq_str(sp, M_DBERR, frp->name, "241|%s: close");
743 ++ep->refcnt;
744 return (1);
746 ep->db = NULL;
749 /* COMMITTED TO THE CLOSE. THERE'S NO GOING BACK... */
751 /* Stop logging. */
752 (void)log_end(sp, ep);
754 /* Free up any marks. */
755 (void)mark_end(sp, ep);
758 * Delete recovery files, close the open descriptor, free recovery
759 * memory. See recover.c for a description of the protocol.
761 * XXX
762 * Unlink backup file first, we can detect that the recovery file
763 * doesn't reference anything when the user tries to recover it.
764 * There's a race, here, obviously, but it's fairly small.
766 if (!F_ISSET(ep, F_RCV_NORM)) {
767 if (ep->rcv_path != NULL && unlink(ep->rcv_path))
768 msgq_str(sp, M_SYSERR, ep->rcv_path, "242|%s: remove");
769 if (ep->rcv_mpath != NULL && unlink(ep->rcv_mpath))
770 msgq_str(sp, M_SYSERR, ep->rcv_mpath, "243|%s: remove");
772 CIRCLEQ_REMOVE(&sp->gp->exfq, ep, q);
773 if (ep->fd != -1)
774 (void)close(ep->fd);
775 if (ep->fcntl_fd != -1)
776 (void)close(ep->fcntl_fd);
777 if (ep->rcv_fd != -1)
778 (void)close(ep->rcv_fd);
779 if (ep->rcv_path != NULL)
780 free(ep->rcv_path);
781 if (ep->rcv_mpath != NULL)
782 free(ep->rcv_mpath);
784 free(ep);
785 return (0);
789 * file_write --
790 * Write the file to disk. Historic vi had fairly convoluted
791 * semantics for whether or not writes would happen. That's
792 * why all the flags.
794 * PUBLIC: int file_write __P((SCR *, MARK *, MARK *, char *, int));
797 file_write(sp, fm, tm, name, flags)
798 SCR *sp;
799 MARK *fm, *tm;
800 char *name;
801 int flags;
803 enum { NEWFILE, OLDFILE } mtype;
804 struct stat sb;
805 EXF *ep;
806 FILE *fp;
807 FREF *frp;
808 MARK from, to;
809 size_t len;
810 u_long nlno, nch;
811 int fd, nf, noname, oflags, rval;
812 char *p, *s, *t, buf[MAXPATHLEN + 64];
813 const char *msgstr;
815 ep = sp->ep;
816 frp = sp->frp;
819 * Writing '%', or naming the current file explicitly, has the
820 * same semantics as writing without a name.
822 if (name == NULL || !strcmp(name, frp->name)) {
823 noname = 1;
824 name = frp->name;
825 } else
826 noname = 0;
828 /* Can't write files marked read-only, unless forced. */
829 if (!LF_ISSET(FS_FORCE) && noname && O_ISSET(sp, O_READONLY)) {
830 msgq(sp, M_ERR, LF_ISSET(FS_POSSIBLE) ?
831 "244|Read-only file, not written; use ! to override" :
832 "245|Read-only file, not written");
833 return (1);
836 /* If not forced, not appending, and "writeany" not set ... */
837 if (!LF_ISSET(FS_FORCE | FS_APPEND) && !O_ISSET(sp, O_WRITEANY)) {
838 /* Don't overwrite anything but the original file. */
839 if ((!noname || F_ISSET(frp, FR_NAMECHANGE)) &&
840 !stat(name, &sb)) {
841 msgq_str(sp, M_ERR, name,
842 LF_ISSET(FS_POSSIBLE) ?
843 "246|%s exists, not written; use ! to override" :
844 "247|%s exists, not written");
845 return (1);
849 * Don't write part of any existing file. Only test for the
850 * original file, the previous test catches anything else.
852 if (!LF_ISSET(FS_ALL) && noname && !stat(name, &sb)) {
853 msgq(sp, M_ERR, LF_ISSET(FS_POSSIBLE) ?
854 "248|Partial file, not written; use ! to override" :
855 "249|Partial file, not written");
856 return (1);
861 * Figure out if the file already exists -- if it doesn't, we display
862 * the "new file" message. The stat might not be necessary, but we
863 * just repeat it because it's easier than hacking the previous tests.
864 * The information is only used for the user message and modification
865 * time test, so we can ignore the obvious race condition.
867 * One final test. If we're not forcing or appending the current file,
868 * and we have a saved modification time, object if the file changed
869 * since we last edited or wrote it, and make them force it.
871 if (stat(name, &sb))
872 mtype = NEWFILE;
873 else {
874 if (noname && !LF_ISSET(FS_FORCE | FS_APPEND) &&
875 ((F_ISSET(ep, F_DEVSET) &&
876 (sb.st_dev != ep->mdev || sb.st_ino != ep->minode)) ||
877 sb.st_mtime != ep->mtime)) {
878 msgq_str(sp, M_ERR, name, LF_ISSET(FS_POSSIBLE) ?
879 "250|%s: file modified more recently than this copy; use ! to override" :
880 "251|%s: file modified more recently than this copy");
881 return (1);
884 mtype = OLDFILE;
887 /* Set flags to create, write, and either append or truncate. */
888 oflags = O_CREAT | O_WRONLY |
889 (LF_ISSET(FS_APPEND) ? O_APPEND : O_TRUNC);
891 /* Backup the file if requested. */
892 if (!opts_empty(sp, O_BACKUP, 1) &&
893 file_backup(sp, name, O_STR(sp, O_BACKUP)) && !LF_ISSET(FS_FORCE))
894 return (1);
896 /* Open the file. */
897 SIGBLOCK;
898 if ((fd = open(name, oflags,
899 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH)) < 0) {
900 msgq_str(sp, M_SYSERR, name, "%s");
901 SIGUNBLOCK;
902 return (1);
904 SIGUNBLOCK;
906 /* Try and get a lock. */
907 if (!noname && file_lock(sp, NULL, NULL, fd, 0) == LOCK_UNAVAIL)
908 msgq_str(sp, M_ERR, name,
909 "252|%s: write lock was unavailable");
911 #if __linux__
913 * XXX
914 * In libc 4.5.x, fdopen(fd, "w") clears the O_APPEND flag (if set).
915 * This bug is fixed in libc 4.6.x.
917 * This code works around this problem for libc 4.5.x users.
918 * Note that this code is harmless if you're using libc 4.6.x.
920 if (LF_ISSET(FS_APPEND) && lseek(fd, (off_t)0, SEEK_END) < 0) {
921 msgq(sp, M_SYSERR, name);
922 return (1);
924 #endif
927 * Use stdio for buffering.
929 * XXX
930 * SVR4.2 requires the fdopen mode exactly match the original open
931 * mode, i.e. you have to open with "a" if appending.
933 if ((fp = fdopen(fd, LF_ISSET(FS_APPEND) ? "a" : "w")) == NULL) {
934 msgq_str(sp, M_SYSERR, name, "%s");
935 (void)close(fd);
936 return (1);
939 /* Build fake addresses, if necessary. */
940 if (fm == NULL) {
941 from.lno = 1;
942 from.cno = 0;
943 fm = &from;
944 if (db_last(sp, &to.lno))
945 return (1);
946 to.cno = 0;
947 tm = &to;
950 rval = ex_writefp(sp, name, fp, fm, tm, &nlno, &nch, 0);
953 * Save the new last modification time -- even if the write fails
954 * we re-init the time. That way the user can clean up the disk
955 * and rewrite without having to force it.
957 if (noname) {
958 if (stat(name, &sb))
959 time(&ep->mtime);
960 else {
961 F_SET(ep, F_DEVSET);
962 ep->mdev = sb.st_dev;
963 ep->minode = sb.st_ino;
965 ep->mtime = sb.st_mtime;
970 * If the write failed, complain loudly. ex_writefp() has already
971 * complained about the actual error, reinforce it if data was lost.
973 if (rval) {
974 if (!LF_ISSET(FS_APPEND))
975 msgq_str(sp, M_ERR, name,
976 "254|%s: WARNING: FILE TRUNCATED");
977 return (1);
981 * Once we've actually written the file, it doesn't matter that the
982 * file name was changed -- if it was, we've already whacked it.
984 F_CLR(frp, FR_NAMECHANGE);
987 * If wrote the entire file, and it wasn't by appending it to a file,
988 * clear the modified bit. If the file was written to the original
989 * file name and the file is a temporary, set the "no exit" bit. This
990 * permits the user to write the file and use it in the context of the
991 * filesystem, but still keeps them from discarding their changes by
992 * exiting.
994 if (LF_ISSET(FS_ALL) && !LF_ISSET(FS_APPEND)) {
995 F_CLR(ep, F_MODIFIED);
996 if (F_ISSET(frp, FR_TMPFILE)) {
997 if (noname)
998 F_SET(frp, FR_TMPEXIT);
999 else
1000 F_CLR(frp, FR_TMPEXIT);
1004 p = msg_print(sp, name, &nf);
1005 switch (mtype) {
1006 case NEWFILE:
1007 msgstr = msg_cat(sp,
1008 "256|%s: new file: %lu lines, %lu characters", NULL);
1009 len = snprintf(buf, sizeof(buf), msgstr, p, nlno, nch);
1010 break;
1011 case OLDFILE:
1012 msgstr = msg_cat(sp, LF_ISSET(FS_APPEND) ?
1013 "315|%s: appended: %lu lines, %lu characters" :
1014 "257|%s: %lu lines, %lu characters", NULL);
1015 len = snprintf(buf, sizeof(buf), msgstr, p, nlno, nch);
1016 break;
1017 default:
1018 abort();
1022 * There's a nasty problem with long path names. Cscope and tags files
1023 * can result in long paths and vi will request a continuation key from
1024 * the user. Unfortunately, the user has typed ahead, and chaos will
1025 * result. If we assume that the characters in the filenames only take
1026 * a single screen column each, we can trim the filename.
1028 s = buf;
1029 if (len >= sp->cols) {
1030 for (s = buf, t = buf + strlen(p); s < t &&
1031 (*s != '/' || len >= sp->cols - 3); ++s, --len);
1032 if (s == t)
1033 s = buf;
1034 else {
1035 *--s = '.'; /* Leading ellipses. */
1036 *--s = '.';
1037 *--s = '.';
1040 msgq(sp, M_INFO, s);
1041 if (nf)
1042 FREE_SPACE(sp, p, 0);
1043 return (0);
1047 * file_backup --
1048 * Backup the about-to-be-written file.
1050 * XXX
1051 * We do the backup by copying the entire file. It would be nice to do
1052 * a rename instead, but: (1) both files may not fit and we want to fail
1053 * before doing the rename; (2) the backup file may not be on the same
1054 * disk partition as the file being written; (3) there may be optional
1055 * file information (MACs, DACs, whatever) that we won't get right if we
1056 * recreate the file. So, let's not risk it.
1058 static int
1059 file_backup(sp, name, bname)
1060 SCR *sp;
1061 char *name, *bname;
1063 struct dirent *dp;
1064 struct stat sb;
1065 DIR *dirp;
1066 EXCMD cmd;
1067 off_t off;
1068 size_t blen;
1069 int flags, maxnum, nr, num, nw, rfd, wfd, version;
1070 char *bp, *estr, *p, *pct, *slash, *t, *wfname, buf[8192];
1071 CHAR_T *wp;
1072 size_t wlen;
1073 size_t nlen;
1074 char *d = NULL;
1076 rfd = wfd = -1;
1077 bp = estr = wfname = NULL;
1080 * Open the current file for reading. Do this first, so that
1081 * we don't exec a shell before the most likely failure point.
1082 * If it doesn't exist, it's okay, there's just nothing to back
1083 * up.
1085 errno = 0;
1086 if ((rfd = open(name, O_RDONLY, 0)) < 0) {
1087 if (errno == ENOENT)
1088 return (0);
1089 estr = name;
1090 goto err;
1094 * If the name starts with an 'N' character, add a version number
1095 * to the name. Strip the leading N from the string passed to the
1096 * expansion routines, for no particular reason. It would be nice
1097 * to permit users to put the version number anywhere in the backup
1098 * name, but there isn't a special character that we can use in the
1099 * name, and giving a new character a special meaning leads to ugly
1100 * hacks both here and in the supporting ex routines.
1102 * Shell and file name expand the option's value.
1104 ex_cinit(sp, &cmd, 0, 0, 0, 0, 0);
1105 if (bname[0] == 'N') {
1106 version = 1;
1107 ++bname;
1108 } else
1109 version = 0;
1110 CHAR2INT(sp, bname, strlen(bname) + 1, wp, wlen);
1111 if (argv_exp2(sp, &cmd, wp, wlen - 1))
1112 return (1);
1115 * 0 args: impossible.
1116 * 1 args: use it.
1117 * >1 args: object, too many args.
1119 if (cmd.argc != 1) {
1120 msgq_str(sp, M_ERR, bname,
1121 "258|%s expanded into too many file names");
1122 (void)close(rfd);
1123 return (1);
1127 * If appending a version number, read through the directory, looking
1128 * for file names that match the name followed by a number. Make all
1129 * of the other % characters in name literal, so the user doesn't get
1130 * surprised and sscanf doesn't drop core indirecting through pointers
1131 * that don't exist. If any such files are found, increment its number
1132 * by one.
1134 if (version) {
1135 GET_SPACE_GOTO(sp, bp, blen, cmd.argv[0]->len * 2 + 50);
1136 INT2CHAR(sp, cmd.argv[0]->bp, cmd.argv[0]->len + 1,
1137 p, nlen);
1138 d = strdup(p);
1139 p = d;
1140 for (t = bp, slash = NULL;
1141 p[0] != '\0'; *t++ = *p++)
1142 if (p[0] == '%') {
1143 if (p[1] != '%')
1144 *t++ = '%';
1145 } else if (p[0] == '/')
1146 slash = t;
1147 pct = t;
1148 *t++ = '%';
1149 *t++ = 'd';
1150 *t = '\0';
1152 if (slash == NULL) {
1153 dirp = opendir(".");
1154 p = bp;
1155 } else {
1156 *slash = '\0';
1157 dirp = opendir(bp);
1158 *slash = '/';
1159 p = slash + 1;
1161 if (dirp == NULL) {
1162 INT2CHAR(sp, cmd.argv[0]->bp, cmd.argv[0]->len + 1,
1163 estr, nlen);
1164 goto err;
1167 for (maxnum = 0; (dp = readdir(dirp)) != NULL;)
1168 if (sscanf(dp->d_name, p, &num) == 1 && num > maxnum)
1169 maxnum = num;
1170 (void)closedir(dirp);
1172 /* Format the backup file name. */
1173 (void)snprintf(pct, blen - (pct - bp), "%d", maxnum + 1);
1174 wfname = bp;
1175 } else {
1176 bp = NULL;
1177 INT2CHAR(sp, cmd.argv[0]->bp, cmd.argv[0]->len + 1,
1178 wfname, nlen);
1181 /* Open the backup file, avoiding lurkers. */
1182 if (stat(wfname, &sb) == 0) {
1183 if (!S_ISREG(sb.st_mode)) {
1184 msgq_str(sp, M_ERR, bname,
1185 "259|%s: not a regular file");
1186 goto err;
1188 if (sb.st_uid != getuid()) {
1189 msgq_str(sp, M_ERR, bname, "260|%s: not owned by you");
1190 goto err;
1192 if (sb.st_mode & (S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH)) {
1193 msgq_str(sp, M_ERR, bname,
1194 "261|%s: accessible by a user other than the owner");
1195 goto err;
1197 flags = O_TRUNC;
1198 } else
1199 flags = O_CREAT | O_EXCL;
1200 if ((wfd = open(wfname, flags | O_WRONLY, S_IRUSR | S_IWUSR)) < 0) {
1201 estr = bname;
1202 goto err;
1205 /* Copy the file's current contents to its backup value. */
1206 while ((nr = read(rfd, buf, sizeof(buf))) > 0)
1207 for (off = 0; nr != 0; nr -= nw, off += nw)
1208 if ((nw = write(wfd, buf + off, nr)) < 0) {
1209 estr = wfname;
1210 goto err;
1212 if (nr < 0) {
1213 estr = name;
1214 goto err;
1217 if (close(rfd)) {
1218 estr = name;
1219 goto err;
1221 if (close(wfd)) {
1222 estr = wfname;
1223 goto err;
1225 if (bp != NULL)
1226 FREE_SPACE(sp, bp, blen);
1227 return (0);
1229 alloc_err:
1230 err: if (rfd != -1)
1231 (void)close(rfd);
1232 if (wfd != -1) {
1233 (void)unlink(wfname);
1234 (void)close(wfd);
1236 if (estr)
1237 msgq_str(sp, M_SYSERR, estr, "%s");
1238 if (d != NULL)
1239 free(d);
1240 if (bp != NULL)
1241 FREE_SPACE(sp, bp, blen);
1242 return (1);
1246 * file_comment --
1247 * Skip the first comment.
1249 static void
1250 file_comment(sp)
1251 SCR *sp;
1253 db_recno_t lno;
1254 size_t len;
1255 CHAR_T *p;
1257 for (lno = 1; !db_get(sp, lno, 0, &p, &len) && len == 0; ++lno);
1258 if (p == NULL)
1259 return;
1260 if (p[0] == '#') {
1261 F_SET(sp, SC_SCR_TOP);
1262 while (!db_get(sp, ++lno, 0, &p, &len))
1263 if (len < 1 || p[0] != '#') {
1264 sp->lno = lno;
1265 return;
1267 } else if (len > 1 && p[0] == '/' && p[1] == '*') {
1268 F_SET(sp, SC_SCR_TOP);
1269 do {
1270 for (; len > 1; --len, ++p)
1271 if (p[0] == '*' && p[1] == '/') {
1272 sp->lno = lno;
1273 return;
1275 } while (!db_get(sp, ++lno, 0, &p, &len));
1276 } else if (len > 1 && p[0] == '/' && p[1] == '/') {
1277 F_SET(sp, SC_SCR_TOP);
1278 while (!db_get(sp, ++lno, 0, &p, &len))
1279 if (len < 1 || p[0] != '/' || p[1] != '/') {
1280 sp->lno = lno;
1281 return;
1287 * file_m1 --
1288 * First modification check routine. The :next, :prev, :rewind, :tag,
1289 * :tagpush, :tagpop, ^^ modifications check.
1291 * PUBLIC: int file_m1 __P((SCR *, int, int));
1294 file_m1(sp, force, flags)
1295 SCR *sp;
1296 int force, flags;
1298 EXF *ep;
1300 ep = sp->ep;
1302 /* If no file loaded, return no modifications. */
1303 if (ep == NULL)
1304 return (0);
1307 * If the file has been modified, we'll want to write it back or
1308 * fail. If autowrite is set, we'll write it back automatically,
1309 * unless force is also set. Otherwise, we fail unless forced or
1310 * there's another open screen on this file.
1312 if (F_ISSET(ep, F_MODIFIED)) {
1313 if (O_ISSET(sp, O_AUTOWRITE)) {
1314 if (!force && file_aw(sp, flags))
1315 return (1);
1316 } else if (ep->refcnt <= 1 && !force) {
1317 msgq(sp, M_ERR, LF_ISSET(FS_POSSIBLE) ?
1318 "262|File modified since last complete write; write or use ! to override" :
1319 "263|File modified since last complete write; write or use :edit! to override");
1320 return (1);
1324 return (file_m3(sp, force));
1328 * file_m2 --
1329 * Second modification check routine. The :edit, :quit, :recover
1330 * modifications check.
1332 * PUBLIC: int file_m2 __P((SCR *, int));
1335 file_m2(sp, force)
1336 SCR *sp;
1337 int force;
1339 EXF *ep;
1341 ep = sp->ep;
1343 /* If no file loaded, return no modifications. */
1344 if (ep == NULL)
1345 return (0);
1348 * If the file has been modified, we'll want to fail, unless forced
1349 * or there's another open screen on this file.
1351 if (F_ISSET(ep, F_MODIFIED) && ep->refcnt <= 1 && !force) {
1352 msgq(sp, M_ERR,
1353 "264|File modified since last complete write; write or use ! to override");
1354 return (1);
1357 return (file_m3(sp, force));
1361 * file_m3 --
1362 * Third modification check routine.
1364 * PUBLIC: int file_m3 __P((SCR *, int));
1367 file_m3(sp, force)
1368 SCR *sp;
1369 int force;
1371 EXF *ep;
1373 ep = sp->ep;
1375 /* If no file loaded, return no modifications. */
1376 if (ep == NULL)
1377 return (0);
1380 * Don't exit while in a temporary files if the file was ever modified.
1381 * The problem is that if the user does a ":wq", we write and quit,
1382 * unlinking the temporary file. Not what the user had in mind at all.
1383 * We permit writing to temporary files, so that user maps using file
1384 * system names work with temporary files.
1386 if (F_ISSET(sp->frp, FR_TMPEXIT) && ep->refcnt <= 1 && !force) {
1387 msgq(sp, M_ERR,
1388 "265|File is a temporary; exit will discard modifications");
1389 return (1);
1391 return (0);
1395 * file_aw --
1396 * Autowrite routine. If modified, autowrite is set and the readonly bit
1397 * is not set, write the file. A routine so there's a place to put the
1398 * comment.
1400 * PUBLIC: int file_aw __P((SCR *, int));
1403 file_aw(sp, flags)
1404 SCR *sp;
1405 int flags;
1407 if (!F_ISSET(sp->ep, F_MODIFIED))
1408 return (0);
1409 if (!O_ISSET(sp, O_AUTOWRITE))
1410 return (0);
1413 * !!!
1414 * Historic 4BSD vi attempted to write the file if autowrite was set,
1415 * regardless of the writeability of the file (as defined by the file
1416 * readonly flag). System V changed this as some point, not attempting
1417 * autowrite if the file was readonly. This feels like a bug fix to
1418 * me (e.g. the principle of least surprise is violated if readonly is
1419 * set and vi writes the file), so I'm compatible with System V.
1421 if (O_ISSET(sp, O_READONLY)) {
1422 msgq(sp, M_INFO,
1423 "266|File readonly, modifications not auto-written");
1424 return (1);
1426 return (file_write(sp, NULL, NULL, NULL, flags));
1430 * set_alt_name --
1431 * Set the alternate pathname.
1433 * Set the alternate pathname. It's a routine because I wanted some place
1434 * to hang this comment. The alternate pathname (normally referenced using
1435 * the special character '#' during file expansion and in the vi ^^ command)
1436 * is set by almost all ex commands that take file names as arguments. The
1437 * rules go something like this:
1439 * 1: If any ex command takes a file name as an argument (except for the
1440 * :next command), the alternate pathname is set to that file name.
1441 * This excludes the command ":e" and ":w !command" as no file name
1442 * was specified. Note, historically, the :source command did not set
1443 * the alternate pathname. It does in nvi, for consistency.
1445 * 2: However, if any ex command sets the current pathname, e.g. the
1446 * ":e file" or ":rew" commands succeed, then the alternate pathname
1447 * is set to the previous file's current pathname, if it had one.
1448 * This includes the ":file" command and excludes the ":e" command.
1449 * So, by rule #1 and rule #2, if ":edit foo" fails, the alternate
1450 * pathname will be "foo", if it succeeds, the alternate pathname will
1451 * be the previous current pathname. The ":e" command will not set
1452 * the alternate or current pathnames regardless.
1454 * 3: However, if it's a read or write command with a file argument and
1455 * the current pathname has not yet been set, the file name becomes
1456 * the current pathname, and the alternate pathname is unchanged.
1458 * If the user edits a temporary file, there may be times when there is no
1459 * alternative file name. A name argument of NULL turns it off.
1461 * PUBLIC: void set_alt_name __P((SCR *, char *));
1463 void
1464 set_alt_name(sp, name)
1465 SCR *sp;
1466 char *name;
1468 if (sp->alt_name != NULL)
1469 free(sp->alt_name);
1470 if (name == NULL)
1471 sp->alt_name = NULL;
1472 else if ((sp->alt_name = strdup(name)) == NULL)
1473 msgq(sp, M_SYSERR, NULL);
1477 * file_lock --
1478 * Get an exclusive lock on a file.
1480 * XXX
1481 * The default locking is flock(2) style, not fcntl(2). The latter is
1482 * known to fail badly on some systems, and its only advantage is that
1483 * it occasionally works over NFS.
1485 * Furthermore, the semantics of fcntl(2) are wrong. The problems are
1486 * two-fold: you can't close any file descriptor associated with the file
1487 * without losing all of the locks, and you can't get an exclusive lock
1488 * unless you have the file open for writing. Someone ought to be shot,
1489 * but it's probably too late, they may already have reproduced. To get
1490 * around these problems, nvi opens the files for writing when it can and
1491 * acquires a second file descriptor when it can't. The recovery files
1492 * are examples of the former, they're always opened for writing. The DB
1493 * files can't be opened for writing because the semantics of DB are that
1494 * files opened for writing are flushed back to disk when the DB session
1495 * is ended. So, in that case we have to acquire an extra file descriptor.
1497 * PUBLIC: lockr_t file_lock __P((SCR *, char *, int *, int, int));
1499 lockr_t
1500 file_lock(sp, name, fdp, fd, iswrite)
1501 SCR *sp;
1502 char *name;
1503 int *fdp, fd, iswrite;
1505 if (!O_ISSET(sp, O_LOCKFILES))
1506 return (LOCK_SUCCESS);
1508 #ifdef HAVE_LOCK_FLOCK /* Hurrah! We've got flock(2). */
1510 * !!!
1511 * We need to distinguish a lock not being available for the file
1512 * from the file system not supporting locking. Flock is documented
1513 * as returning EWOULDBLOCK; add EAGAIN for good measure, and assume
1514 * they are the former. There's no portable way to do this.
1516 errno = 0;
1517 return (flock(fd, LOCK_EX | LOCK_NB) ? errno == EAGAIN
1518 #ifdef EWOULDBLOCK
1519 || errno == EWOULDBLOCK
1520 #endif
1521 ? LOCK_UNAVAIL : LOCK_FAILED : LOCK_SUCCESS);
1522 #endif
1523 #ifdef HAVE_LOCK_FCNTL /* Gag me. We've got fcntl(2). */
1525 struct flock arg;
1526 int didopen, sverrno;
1528 arg.l_type = F_WRLCK;
1529 arg.l_whence = 0; /* SEEK_SET */
1530 arg.l_start = arg.l_len = 0;
1531 arg.l_pid = 0;
1534 * If the file descriptor isn't opened for writing, it must fail.
1535 * If we fail because we can't get a read/write file descriptor,
1536 * we return LOCK_SUCCESS, believing that the file is readonly
1537 * and that will be sufficient to warn the user.
1539 if (!iswrite) {
1540 if (name == NULL || fdp == NULL)
1541 return (LOCK_FAILED);
1542 if ((fd = open(name, O_RDWR, 0)) == -1)
1543 return (LOCK_SUCCESS);
1544 *fdp = fd;
1545 didopen = 1;
1548 errno = 0;
1549 if (!fcntl(fd, F_SETLK, &arg))
1550 return (LOCK_SUCCESS);
1551 if (didopen) {
1552 sverrno = errno;
1553 (void)close(fd);
1554 errno = sverrno;
1558 * !!!
1559 * We need to distinguish a lock not being available for the file
1560 * from the file system not supporting locking. Fcntl is documented
1561 * as returning EACCESS and EAGAIN; add EWOULDBLOCK for good measure,
1562 * and assume they are the former. There's no portable way to do this.
1564 return (errno == EACCES || errno == EAGAIN
1565 #ifdef EWOULDBLOCK
1566 || errno == EWOULDBLOCK
1567 #endif
1568 ? LOCK_UNAVAIL : LOCK_FAILED);
1570 #endif
1571 #if !defined(HAVE_LOCK_FLOCK) && !defined(HAVE_LOCK_FCNTL)
1572 return (LOCK_SUCCESS);
1573 #endif