Add a libutempter compatibility interface to libulog.

The ulog_login_pseudo(3) and ulog_logout_pseudo(3) interfaces provide a
functionality identical to what libutempter has to offer. Just transform
libutempter's calls into the before mentioned functions.

libutempter doesn't work with utmpx, so instead of fixing I thought the
easiest way would be to integrate this functionality. libutempter is
used by applications like xterm and the KDE libraries, so if I ever
change the underlying file format, these applications will keep working
automatically.

Also increase __FreeBSD_version to indicate the addition (as well as the
import of libulog).

5 files changed, 263 insertions, 4 deletions

diff --git a/lib/libulog/Makefile b/lib/libulog/Makefile
index 4c3ac93..c6cb510 100644
--- a/lib/libulog/Makefile
+++ b/lib/libulog/Makefile
@@ -1,12 +1,15 @@
 # $FreeBSD$
 
+.include <bsd.own.mk>
+
 LIB=	ulog
 SHLIB_MAJOR= 0
-INCS=	ulog.h
+INCS=	ulog.h utempter.h
 SRCS=	ulog.h ulog_getutxent.c ulog_internal.h ulog_login.c \
-	ulog_login_pseudo.c ulog_pututxline.c ulog_util.c
+	ulog_login_pseudo.c ulog_pututxline.c ulog_util.c utempter.c
 
-MAN=	ulog_getutxent.3 ulog_login.3 ulog_setutxfile.3
+MAN=	ulog_getutxent.3 ulog_login.3 ulog_setutxfile.3 \
+	utempter_add_record.3
 MLINKS+=ulog_getutxent.3 ulog_endutxent.3 \
 	ulog_getutxent.3 ulog_getutxline.3 \
 	ulog_getutxent.3 ulog_pututxline.3 \
@@ -14,7 +17,12 @@ MLINKS+=ulog_getutxent.3 ulog_endutxent.3 \
 	ulog_login.3 ulog_login_pseudo.3 \
 	ulog_login.3 ulog_logout.3 \
 	ulog_login.3 ulog_logout_pseudo.3 \
-	ulog_setutxfile.3 ulog_getutxuser.3
+	ulog_setutxfile.3 ulog_getutxuser.3 \
+	utempter_add_record.3 utempter_remove_added_record.3 \
+	utempter_add_record.3 utempter_remove_record.3 \
+	utempter_add_record.3 addToUtmp.3 \
+	utempter_remove_added_record.3 removeFromUtmp.3 \
+	utempter_remove_record.3 removeLineFromUtmp.3
 
 # Add links to <utmpx.h>-style functions.
 MLINKS+=ulog_endutxent.3 endutxent.3 \
@@ -28,4 +36,14 @@ WARNS?=	6
 VERSION_DEF= ${.CURDIR}/../libc/Versions.def
 SYMBOL_MAPS= ${.CURDIR}/Symbol.map
 
+.if ${MK_INSTALLLIB} != "no"
+SYMLINKS+=libulog.a ${LIBDIR}/libutempter.a
+.endif
+.if !defined(NO_PIC)
+SYMLINKS+=libulog.so ${LIBDIR}/libutempter.so
+.endif
+.if ${MK_PROFILE} != "no"
+SYMLINKS+=libulog_p.a ${LIBDIR}/libutempter_p.a
+.endif
+
 .include <bsd.lib.mk>
diff --git a/lib/libulog/Symbol.map b/lib/libulog/Symbol.map
index f435c9c..38f2df8 100644
--- a/lib/libulog/Symbol.map
+++ b/lib/libulog/Symbol.map
@@ -14,4 +14,11 @@ FBSD_1.2 {
 	ulog_pututxline;
 	ulog_setutxent;
 	ulog_setutxfile;
+
+	addToUtmp;
+	removeFromUtmp;
+	removeLineFromUtmp;
+	utempter_add_record;
+	utempter_remove_added_record;
+	utempter_remove_record;
 };
diff --git a/lib/libulog/utempter.c b/lib/libulog/utempter.c
new file mode 100644
index 0000000..bb0eb2b
--- /dev/null
+++ b/lib/libulog/utempter.c
@@ -0,0 +1,84 @@
+/*-
+ * Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include "ulog_internal.h"
+#include "utempter.h"
+
+static int last_fd = -1;
+
+int
+utempter_add_record(int fd, const char *host)
+{
+
+	ulog_login_pseudo(fd, host);
+	last_fd = fd;
+	return (0);
+}
+
+int
+utempter_remove_added_record(void)
+{
+
+	if (last_fd < 0)
+		return (0);
+	ulog_logout_pseudo(last_fd);
+	last_fd = -1;
+	return (0);
+}
+
+int
+utempter_remove_record(int fd)
+{
+
+	ulog_logout_pseudo(fd);
+	if (last_fd == fd)
+		last_fd = -1;
+	return (0);
+}
+
+void
+addToUtmp(const char *pty __unused, const char *host, int fd)
+{
+
+	utempter_add_record(fd, host);
+}
+
+void
+removeFromUtmp(void)
+{
+
+	utempter_remove_added_record();
+}
+
+void
+removeLineFromUtmp(const char *pty __unused, int fd)
+{
+
+	utempter_remove_record(fd);
+}
diff --git a/lib/libulog/utempter.h b/lib/libulog/utempter.h
new file mode 100644
index 0000000..0e0274c
--- /dev/null
+++ b/lib/libulog/utempter.h
@@ -0,0 +1,44 @@
+/*-
+ * Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * $FreeBSD$
+ */
+
+#ifndef _UTEMPTER_H_
+#define	_UTEMPTER_H_
+
+#include <sys/cdefs.h>
+
+__BEGIN_DECLS
+int	utempter_add_record(int, const char *);
+int	utempter_remove_added_record(void);
+int	utempter_remove_record(int);
+
+void	addToUtmp(const char *, const char *, int);
+void	removeFromUtmp(void);
+void	removeLineFromUtmp(const char *, int);
+__END_DECLS
+
+#endif /* !_UTEMPTER_H_ */
diff --git a/lib/libulog/utempter_add_record.3 b/lib/libulog/utempter_add_record.3
new file mode 100644
index 0000000..fdaa00e
--- /dev/null
+++ b/lib/libulog/utempter_add_record.3
@@ -0,0 +1,106 @@
+.\" Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd December 6, 2009
+.Os
+.Dt UTEMPTER_ADD_RECORD 3
+.Sh NAME
+.Nm utempter_add_record ,
+.Nm utempter_remove_added_record ,
+.Nm utempter_remove_record ,
+.Nm addToUtmp ,
+.Nm removeFromUtmp ,
+.Nm removeLineFromUtmp
+.Nd utempter compatibility interface
+.Sh LIBRARY
+.Lb libulog
+.Sh SYNOPSIS
+.In utempter.h
+.Ft int
+.Fn utempter_add_record "int fd" "const char *host"
+.Ft int
+.Fn utempter_remove_added_record "void"
+.Ft int
+.Fn utempter_remove_record "int fd"
+.Ft void
+.Fn addToUtmp "const char *pty" "const char *host" "int fd"
+.Ft void
+.Fn removeFromUtmp "void"
+.Ft void
+.Fn removeLineFromUtmp "const char *pty" "int fd"
+.Sh DESCRIPTION
+The
+.Fn utempter_add_record
+and
+.Fn addToUtmp
+functions add a login record to the database for the TTY belonging to
+the pseudo-terminal master file descriptor
+.Fa fd ,
+using the username corresponding with the real user ID of the calling
+process and the optional hostname
+.Fa host .
+These functions are equivalent to
+.Xr ulog_login_pseudo 3 .
+.Pp
+The
+.Fn utempter_remove_record
+and
+.Fn removeLineFromUtmp
+functions mark the login session as being closed for the TTY belonging
+to the pseudo-terminal master file descriptor
+.Fa fd .
+These functions are equivalent to
+.Xr ulog_logout_pseudo 3 .
+.Pp
+The
+.Fn utempter_remove_added_record
+and
+.Fn removeFromUtmp
+functions have the same properties as the previously mentioned
+functions, except that they use an internally cached value of the file
+descriptor passed to the login functions.
+.Pp
+The
+.Fa pty
+arguments of 
+.Fn addToUtmp
+and
+.Fn removeLineFromUtmp
+are unused.
+.Sh RETURN VALUES
+In this implementation, the
+.Fn utempter_add_record ,
+.Fn utempter_remove_added_record
+and
+.Fn utempter_remove_record
+always return a value of 0.
+.Sh SEE ALSO
+.Xr ulog_login_pseudo 3 ,
+.Xr ulog_setutxfile 3 ,
+.Xr utmp 5
+.Sh HISTORY
+These functions appeared in
+.Fx 9.0 .