From 2826da432cfda62b5512dfa72641c77fc10373d0 Mon Sep 17 00:00:00 2001
From: Conrad Meyer <cem@FreeBSD.org>
Date: Sat, 20 Jul 2019 20:56:31 +0000
Subject: [PATCH] motd: Generate from template to /var/run

Update login(1), its manual pages, similar utilities, and motd.5 to refer to
the new location.

Suggested by:	delphij@ (re: r349256)
Reviewed by:	bcr (manpages), delphij
Differential Revision:	https://reviews.freebsd.org/D20721
---
 libexec/rc/rc.d/motd                       | 44 ++++++++++++----------
 release/picobsd/tinyware/login/pathnames.h |  2 +-
 share/man/man5/motd.5                      | 21 ++++++++---
 usr.bin/login/Makefile                     |  2 +-
 usr.bin/login/login.1                      |  4 +-
 usr.bin/login/login.conf                   |  4 +-
 usr.bin/login/{motd => motd.template}      |  3 +-
 usr.bin/login/pathnames.h                  |  2 +-
 8 files changed, 48 insertions(+), 34 deletions(-)
 rename usr.bin/login/{motd => motd.template} (91%)

diff --git a/libexec/rc/rc.d/motd b/libexec/rc/rc.d/motd
index 2c06187c1d2a..e63973945f9d 100755
--- a/libexec/rc/rc.d/motd
+++ b/libexec/rc/rc.d/motd
@@ -4,48 +4,52 @@
 #
 
 # PROVIDE: motd
-# REQUIRE: mountcritremote
+# REQUIRE: mountcritremote FILESYSTEMS
 # BEFORE:  LOGIN
 
 . /etc/rc.subr
 
 name="motd"
-desc="Update /etc/motd"
+desc="Update /var/run/motd"
 rcvar="update_motd"
 start_cmd="motd_start"
 stop_cmd=":"
 
+COMPAT_MOTD="/etc/motd"
+TARGET="/var/run/motd"
+TEMPLATE="/etc/motd.template"
 PERMS="644"
 
 motd_start()
 {
-	#	Update kernel info in /etc/motd
+	#	Update kernel info in /var/run/motd
 	#	Must be done *before* interactive logins are possible
 	#	to prevent possible race conditions.
 	#
 	check_startmsgs && echo -n 'Updating motd:'
-	if [ ! -f /etc/motd ]; then
-		install -c -o root -g wheel -m ${PERMS} /dev/null /etc/motd
-	fi
-
-	if [ ! -w /etc/motd ]; then
-		echo ' /etc/motd is not writable, update failed.'
-		return
+	if [ ! -f "${TEMPLATE}" ]; then
+		# Create missing template from existing regular motd file, if
+		# one exists.
+		if [ -f "${COMPAT_MOTD}" ]; then
+			sed '1{/^FreeBSD.*/{d;};};' "${COMPAT_MOTD}" > "${TEMPLATE}"
+			chmod $PERMS "${TEMPLATE}"
+			rm -f "${COMPAT_MOTD}"
+		else
+			# Otherwise, create an empty template file.
+			install -c -o root -g wheel -m ${PERMS} /dev/null "${TEMPLATE}"
+		fi
+		# Provide compatibility symlink:
+		if [ ! -h "${COMPAT_MOTD}" ]; then
+			ln -sF "${TARGET}" "${COMPAT_MOTD}"
+		fi
 	fi
 
 	T=`mktemp -t motd`
 	uname -v | sed -e 's,^\([^#]*\) #\(.* [1-2][0-9][0-9][0-9]\).*/\([^\]*\) $,\1 (\3) #\2,' > ${T}
-	awk '{if (NR == 1) {if ($1 == "FreeBSD") {next} else {print "\n"$0}} else {print}}' < /etc/motd >> ${T}
+	cat "${TEMPLATE}" >> ${T}
 
-	if ! cmp -s $T /etc/motd; then
-		mv -f $T /etc/.motd.tmp
-		fsync /etc/.motd.tmp
-		mv -f /etc/.motd.tmp /etc/motd
-		chmod ${PERMS} /etc/motd
-		fsync /etc
-	else
-		rm -f $T
-	fi
+	install -C -o root -g wheel -m "${PERMS}" "$T" "${TARGET}"
+	rm -f "$T"
 
 	check_startmsgs && echo '.'
 }
diff --git a/release/picobsd/tinyware/login/pathnames.h b/release/picobsd/tinyware/login/pathnames.h
index 1984631aa944..23780fc227e6 100644
--- a/release/picobsd/tinyware/login/pathnames.h
+++ b/release/picobsd/tinyware/login/pathnames.h
@@ -39,7 +39,7 @@
 #include <paths.h>
 
 #define	_PATH_HUSHLOGIN		".hushlogin"
-#define	_PATH_MOTDFILE		"/etc/motd"
+#define	_PATH_MOTDFILE		"/var/run/motd"
 #define _PATH_LOGACCESS		"/etc/login.access"
 #define _PATH_FBTAB		"/etc/fbtab"
 #define _PATH_LOGINDEVPERM	"/etc/logindevperm"
diff --git a/share/man/man5/motd.5 b/share/man/man5/motd.5
index 2ffbc9e419bf..9feb0479b926 100644
--- a/share/man/man5/motd.5
+++ b/share/man/man5/motd.5
@@ -3,7 +3,7 @@
 .\" This file is in the public domain.
 .\" $FreeBSD$
 .\"
-.Dd February 13, 1997
+.Dd July 20, 2019
 .Dt MOTD 5
 .Os
 .Sh NAME
@@ -11,13 +11,16 @@
 .Nd file containing message(s) of the day
 .Sh DESCRIPTION
 The file
-.Pa /etc/motd
+.Pa /var/run/motd
 is normally displayed by
 .Xr login 1
 after a user has logged in but before the shell is run.
 It is generally used for important system-wide announcements.
 During system startup, a line containing the kernel version string is
-prepended to this file.
+prepended to
+.Pa /etc/motd.template
+and the contents are written to
+.Pa /var/run/motd .
 .Pp
 Individual users may suppress the display of this file by
 creating a file named
@@ -26,11 +29,13 @@ in their home directories or through
 .Xr login.conf 5 .
 .Sh FILES
 .Bl -tag -width $HOME/.hushlogin -compact
-.It Pa /etc/motd
+.It Pa /etc/motd.template
+The template file that system administrators can edit.
+.It Pa /var/run/motd
 The message of the day.
 .It Pa $HOME/.hushlogin
 Suppresses output of
-.Pa /etc/motd .
+.Pa /var/run/motd .
 .El
 .Sh EXAMPLES
 .Bd -literal
@@ -41,3 +46,9 @@ FreeBSD 2.1.6.1-RELEASE (GENERIC) #0: Sun Dec 29 03:08:31 PST 1996
 .Sh SEE ALSO
 .Xr login 1 ,
 .Xr login.conf 5
+.Sh HISTORY
+Prior to
+.Fx 13.0 ,
+.Nm
+lived in
+.Pa /etc .
diff --git a/usr.bin/login/Makefile b/usr.bin/login/Makefile
index be29e8c05857..cb1e7e38e160 100644
--- a/usr.bin/login/Makefile
+++ b/usr.bin/login/Makefile
@@ -3,7 +3,7 @@
 
 .include <src.opts.mk>
 
-CONFS=	fbtab login.conf motd login.access
+CONFS=	fbtab login.conf motd.template login.access
 PROG=	login
 SRCS=	login.c login_fbtab.c
 CFLAGS+=-DLOGALL
diff --git a/usr.bin/login/login.1 b/usr.bin/login/login.1
index 2bfa4cda48db..bd92837b8b87 100644
--- a/usr.bin/login/login.1
+++ b/usr.bin/login/login.1
@@ -28,7 +28,7 @@
 .\"	@(#)login.1	8.2 (Berkeley) 5/5/94
 .\" $FreeBSD$
 .\"
-.Dd September 13, 2006
+.Dd July 20, 2019
 .Dt LOGIN 1
 .Os
 .Sh NAME
@@ -131,7 +131,7 @@ result in an error exit from
 changes device protections
 .It Pa /etc/login.conf
 login class capabilities database
-.It Pa /etc/motd
+.It Pa /var/run/motd
 message-of-the-day
 .It Pa /var/mail/user
 system mailboxes
diff --git a/usr.bin/login/login.conf b/usr.bin/login/login.conf
index e352f7f7aaf5..157305821b2c 100644
--- a/usr.bin/login/login.conf
+++ b/usr.bin/login/login.conf
@@ -25,7 +25,7 @@
 default:\
 	:passwd_format=sha512:\
 	:copyright=/etc/COPYRIGHT:\
-	:welcome=/etc/motd:\
+	:welcome=/var/run/motd:\
 	:setenv=MAIL=/var/mail/$,BLOCKSIZE=K:\
 	:path=/sbin /bin /usr/sbin /usr/bin /usr/local/sbin /usr/local/bin ~/bin:\
 	:nologin=/var/run/nologin:\
@@ -120,7 +120,7 @@ russian|Russian Users Accounts:\
 ##
 #standard:\
 #	:copyright=/etc/COPYRIGHT:\
-#	:welcome=/etc/motd:\
+#	:welcome=/var/run/motd:\
 #	:setenv=MAIL=/var/mail/$,BLOCKSIZE=K:\
 #	:path=~/bin /bin /usr/bin /usr/local/bin:\
 #	:manpath=/usr/share/man /usr/local/man:\
diff --git a/usr.bin/login/motd b/usr.bin/login/motd.template
similarity index 91%
rename from usr.bin/login/motd
rename to usr.bin/login/motd.template
index 4dc41a744c31..80d790959802 100644
--- a/usr.bin/login/motd
+++ b/usr.bin/login/motd.template
@@ -1,4 +1,3 @@
-FreeBSD ?.?.?  (UNKNOWN)
 
 Welcome to FreeBSD!
 
@@ -18,4 +17,4 @@ Please include that output and any error messages when posting questions.
 Introduction to manual pages:  man man
 FreeBSD directory layout:      man hier
 
-Edit /etc/motd to change this login announcement.
+Edit /etc/motd.template to change this login announcement.
diff --git a/usr.bin/login/pathnames.h b/usr.bin/login/pathnames.h
index e501d7b8772d..5dca6f2cbb4e 100644
--- a/usr.bin/login/pathnames.h
+++ b/usr.bin/login/pathnames.h
@@ -35,6 +35,6 @@
 #include <paths.h>
 
 #define	_PATH_HUSHLOGIN		".hushlogin"
-#define	_PATH_MOTDFILE		"/etc/motd"
+#define	_PATH_MOTDFILE		"/var/run/motd"
 #define _PATH_FBTAB		"/etc/fbtab"
 #define _PATH_LOGINDEVPERM	"/etc/logindevperm"