xref: /freebsd/usr.bin/locate/locate/updatedb.sh (revision c697fb7f)
1#!/bin/sh
2#
3# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4#
5# Copyright (c) September 1995 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
6# All rights reserved.
7#
8# Redistribution and use in source and binary forms, with or without
9# modification, are permitted provided that the following conditions
10# are met:
11# 1. Redistributions of source code must retain the above copyright
12#    notice, this list of conditions and the following disclaimer.
13# 2. Redistributions in binary form must reproduce the above copyright
14#    notice, this list of conditions and the following disclaimer in the
15#    documentation and/or other materials provided with the distribution.
16#
17# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27# SUCH DAMAGE.
28#
29# updatedb - update locate database for local mounted filesystems
30#
31# $FreeBSD$
32
33if [ "$(id -u)" = "0" ]; then
34	echo ">>> WARNING" 1>&2
35	echo ">>> Executing updatedb as root.  This WILL reveal all filenames" 1>&2
36	echo ">>> on your machine to all login users, which is a security risk." 1>&2
37fi
38: ${LOCATE_CONFIG="/etc/locate.rc"}
39if [ -f "$LOCATE_CONFIG" -a -r "$LOCATE_CONFIG" ]; then
40       . $LOCATE_CONFIG
41fi
42
43# The directory containing locate subprograms
44: ${LIBEXECDIR:=/usr/libexec}; export LIBEXECDIR
45: ${TMPDIR:=/tmp}; export TMPDIR
46if ! TMPDIR=`mktemp -d $TMPDIR/locateXXXXXXXXXX`; then
47	exit 1
48fi
49
50PATH=$LIBEXECDIR:/bin:/usr/bin:$PATH; export PATH
51
52
53: ${mklocatedb:=locate.mklocatedb}	 # make locate database program
54: ${FCODES:=/var/db/locate.database}	 # the database
55: ${SEARCHPATHS="/"}		# directories to be put in the database
56: ${PRUNEPATHS="/tmp /usr/tmp /var/tmp /var/db/portsnap /var/db/freebsd-update"} # unwanted directories
57: ${PRUNEDIRS=".zfs"}	# unwanted directories, in any parent
58: ${FILESYSTEMS="$(lsvfs | tail -n +3 | \
59	egrep -vw "loopback|network|synthetic|read-only|0" | \
60	cut -d " " -f1)"}		# allowed filesystems
61: ${find:=find}
62
63if [ -z "$SEARCHPATHS" ]; then
64	echo "$0: empty variable SEARCHPATHS" >&2; exit 1
65fi
66if [ -z "$FILESYSTEMS" ]; then
67	echo "$0: empty variable FILESYSTEMS" >&2; exit 1
68fi
69
70# Make a list a paths to exclude in the locate run
71excludes="! (" or=""
72for fstype in $FILESYSTEMS
73do
74       excludes="$excludes $or -fstype $fstype"
75       or="-or"
76done
77excludes="$excludes ) -prune"
78
79if [ -n "$PRUNEPATHS" ]; then
80	for path in $PRUNEPATHS; do
81		excludes="$excludes -or -path $path -prune"
82	done
83fi
84
85if [ -n "$PRUNEDIRS" ]; then
86	for dir in $PRUNEDIRS; do
87		excludes="$excludes -or -name $dir -type d -prune"
88	done
89fi
90
91tmp=$TMPDIR/_updatedb$$
92trap 'rm -f $tmp; rmdir $TMPDIR' 0 1 2 3 5 10 15
93
94# search locally
95if $find -s $SEARCHPATHS $excludes -or -print 2>/dev/null |
96        $mklocatedb -presort > $tmp
97then
98	if [ -n "$($find $tmp -size -257c -print)" ]; then
99		echo "updatedb: locate database $tmp is empty" >&2
100		exit 1
101	else
102		cat $tmp > $FCODES		# should be cp?
103	fi
104fi
105