#!/bin/sh
#
# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
#
# Copyright (c) September 1995 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
# 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.
#
# updatedb - update locate database for local mounted filesystems
#
# $FreeBSD: head/usr.bin/locate/locate/updatedb.sh 326276 2017-11-27 15:37:16Z pfg $

if [ "$(id -u)" = "0" ]; then
	echo ">>> WARNING" 1>&2
	echo ">>> Executing updatedb as root.  This WILL reveal all filenames" 1>&2
	echo ">>> on your machine to all login users, which is a security risk." 1>&2
fi
: ${LOCATE_CONFIG="/etc/locate.rc"}
if [ -f "$LOCATE_CONFIG" -a -r "$LOCATE_CONFIG" ]; then
	. $LOCATE_CONFIG
fi

# The directory containing locate subprograms
: ${LIBEXECDIR:=/usr/libexec}; export LIBEXECDIR
: ${TMPDIR:=/tmp}; export TMPDIR
if ! TMPDIR=`mktemp -d $TMPDIR/locateXXXXXXXXXX`; then
	exit 1
fi

PATH=$LIBEXECDIR:/bin:/usr/bin:$PATH; export PATH


: ${mklocatedb:=locate.mklocatedb}	 # make locate database program
: ${FCODES:=/var/db/locate.database}	 # the database
: ${PRUNEPATHS:="/tmp /usr/tmp /var/tmp"} # unwanted directories
: ${PRUNEDIRS:=".git"}	# unwanted directories, in any parent
# allowed filesystems
: ${FILESYSTEMS:="$(lsvfs | tail -n +3 | \
	egrep -vw 'loopback|network|synthetic|read-only|0' | \
	cut -d ' ' -f1)"}
# directories to be searched to create the database
: ${SEARCHPATHS:="/"}
# the find program and its options
: ${FIND:="find"}

if [ -z "$SEARCHPATHS" ]; then
	echo "$0: empty variable SEARCHPATHS" >&2; exit 1
fi
if [ -z "$FILESYSTEMS" ]; then
	echo "$0: empty variable FILESYSTEMS" >&2; exit 1
fi
ROOTFS="$(df -T / | awk '$NF=="/" { print $2 }')"
if ! echo "$FILESYSTEMS" | grep -qw "$ROOTFS"; then
	echo "WARNING: root filesystem '$ROOTFS' was excluded" >&2
fi

# Make a list a paths to exclude in the locate run
excludes="! ("
or=""
for fstype in $FILESYSTEMS; do
	excludes="$excludes $or -fstype $fstype"
	or="-or"
done
excludes="$excludes ) -prune"

if [ -n "$PRUNEPATHS" ]; then
	for path in $PRUNEPATHS; do
		excludes="$excludes -or -path $path -prune"
	done
fi

if [ -n "$PRUNEDIRS" ]; then
	for dir in $PRUNEDIRS; do
		excludes="$excludes -or -name $dir -type d -prune"
	done
fi

tmp=$TMPDIR/_updatedb$$
trap 'rm -f $tmp; rmdir $TMPDIR' 0 1 2 3 5 10 15

# search locally
echo $FIND $SEARCHPATHS $excludes -or -print
if $FIND $SEARCHPATHS $excludes -or -print 2>/dev/null | \
	sort | uniq | $mklocatedb -presort > $tmp
then
	if [ "$(stat -f '%z' $tmp)" -lt "257" ]; then
		echo "updatedb: locate database $tmp is empty" >&2
		exit 1
	else
		# Use "cat" instead of "cp", since the permission of the
		# database is set up the by caller (i.e., peridoic task)
		# which has privilege, while this tool should be run as
		# a non-privilege user.
		cat $tmp > $FCODES
		echo "updatedb: built new locate database: $FCODES"
	fi
fi
