1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
|
# $NetBSD: check-files.mk,v 1.16 2007/03/16 10:29:22 rillig Exp $
#
# This file checks that the list of installed files matches the PLIST.
# For that purpose it records the file list of LOCALBASE before and
# after the installation of the package and compares these lists with
# the PLIST.
#
# User-settable variables:
#
# CHECK_FILES
# "yes" to enable the check, "no" to disable it.
#
# Default value: "yes" for PKG_DEVELOPERs, "no" otherwise.
#
# CHECK_FILES_STRICT
# When set to "yes", VARBASE and PKG_SYSCONFDIR are checked in
# addition to LOCALBASE.
#
# Package-settable variables:
#
# CHECK_FILES_SKIP
# A list of regular expressions (FIXME: all other checks use shell
# patterns) that names files to be skipped. This is useful to
# avoid getting errors triggered by changes in directories not
# really handled by pkgsrc.
#
_VARGROUPS+= check-files
_USER_VARS.check-files= CHECK_FILES CHECK_FILES_STRICT
_PKG_VARS.check-files= CHECK_FILES_SKIP
.if defined(PKG_DEVELOPER)
CHECK_FILES?= yes
.endif
CHECK_FILES?= no
CHECK_FILES_STRICT?= no
# Info index files updated when a new info file is added.
.if defined(INFO_FILES)
CHECK_FILES_SKIP+= ${PREFIX}/.*/dir$$$$
.endif
# Perl's perllocal.pod index that is regenerated when a local module
# is added.
#
CHECK_FILES_SKIP+= ${PERL5_INSTALLARCHLIB}/perllocal.pod
# R's index files that are regenerated when a local module
# is added.
#
CHECK_FILES_SKIP+= ${PREFIX}/lib/R/doc/html/packages.html
CHECK_FILES_SKIP+= ${PREFIX}/lib/R/doc/html/search/index.txt
# We don't care about what's under /proc in Linux emulation, which is
# just holds run-time generated data.
#
CHECK_FILES_SKIP+= ${PREFIX}/emul/linux/proc.*
# The reference-count meta-data directory used by the pkginstall framework.
CHECK_FILES_SKIP+= ${PKG_DBDIR}.refcount.*
# Some people have their distfiles and binary packages below ${LOCALBASE}.
CHECK_FILES_SKIP+= ${PACKAGES}/.*
CHECK_FILES_SKIP+= ${DISTDIR}/.*
# File that are outside of ${PREFIX} in directories we already know we'll
# be using for mutable data.
#
.for d in ${MAKE_DIRS} ${OWN_DIRS}
CHECK_FILES_SKIP+= ${d:C/^([^\/])/${PREFIX}\/\1/}.*
.endfor
.for d o g m in ${MAKE_DIRS_PERMS} ${OWN_DIRS_PERMS}
CHECK_FILES_SKIP+= ${d:C/^([^\/])/${PREFIX}\/\1/}.*
.endfor
# Mutable X11 font database files
.if (defined(FONTS_DIRS.x11) && !empty(FONTS_DIRS.x11:M*))
CHECK_FILES_SKIP+= ${PREFIX}/.*/encodings.dir
CHECK_FILES_SKIP+= ${PREFIX}/.*/fonts.dir
.endif
.if (defined(FONTS_DIRS.ttf) && !empty(FONTS_DIRS.ttf:M*)) || \
(defined(FONTS_DIRS.type1) && !empty(FONTS_DIRS.type1:M*))
CHECK_FILES_SKIP+= ${PREFIX}/.*/fonts.scale
.endif
.if (defined(FONTS_DIRS.ttf) && !empty(FONTS_DIRS.ttf:M*)) || \
(defined(FONTS_DIRS.type1) && !empty(FONTS_DIRS.type1:M*)) || \
(defined(FONTS_DIRS.x11) && !empty(FONTS_DIRS.x11:M*))
CHECK_FILES_SKIP+= ${PREFIX}/.*/fonts.cache-1
.endif
# Mutable charset.alias file
CHECK_FILES_SKIP+= ${PREFIX}/lib/charset.alias
_CHECK_FILES_SKIP_FILTER= ${GREP} -vx ${CHECK_FILES_SKIP:@f@-e ${DESTDIR:Q}${f:Q}@}
###########################################################################
# These are the files generated and used by the check-files implementation
# used across several check-files targets.
#
# _CHECK_FILES_ERRMSG.* are the files that contain the error
# messages discovered during each stage of file-checking.
#
# _CHECK_FILES_PRE.* are the file lists generated before any files
# from the package are installed.
#
# _CHECK_FILES_POST.* are the file lists generated after all files
# from the package are installed.
#
# The "pre" and "post" file lists are compared against each other to
# determine if the package is installing files where it shouldn't be.
#
_CHECK_FILES_ERRMSG.prefix= ${ERROR_DIR}/check-files-prefix
_CHECK_FILES_PRE.prefix= ${WRKDIR}/.prefix.pre
_CHECK_FILES_POST.prefix= ${WRKDIR}/.prefix.post
_CHECK_FILES_ERRMSG.sysconfdir= ${ERROR_DIR}/.check-files-sysconfdir
_CHECK_FILES_PRE.sysconfdir= ${WRKDIR}/.sysconfdir.pre
_CHECK_FILES_POST.sysconfdir= ${WRKDIR}/.sysconfdir.post
_CHECK_FILES_ERRMSG.varbase= ${ERROR_DIR}/.check-files-varbase
_CHECK_FILES_PRE.varbase= ${WRKDIR}/.varbase.pre
_CHECK_FILES_POST.varbase= ${WRKDIR}/.varbase.post
_CHECK_FILES_ERRMSGS= # empty
_CHECK_FILES_ERRMSGS+= ${_CHECK_FILES_ERRMSG.prefix}
.if empty(CHECK_FILES_STRICT:M[nN][oO])
_CHECK_FILES_ERRMSGS+= ${_CHECK_FILES_ERRMSG.sysconfdir}
_CHECK_FILES_ERRMSGS+= ${_CHECK_FILES_ERRMSG.varbase}
.endif
###########################################################################
# _CHECK_FILES_PRE holds the list of targets that are built as part of
# building the check-files-pre target. These targets should cause the
# "pre" file lists to be generated.
#
_CHECK_FILES_PRE= check-files-pre-message
_CHECK_FILES_PRE+= ${_CHECK_FILES_PRE.prefix}
.if empty(CHECK_FILES_STRICT:M[nN][oO])
_CHECK_FILES_PRE+= ${_CHECK_FILES_PRE.sysconfdir}
_CHECK_FILES_PRE+= ${_CHECK_FILES_PRE.varbase}
.endif
###########################################################################
# _CHECK_FILES_POST holds the list of targets that are built as part of
# building the check-files-post target. These targets should cause the
# "post" file lists to be generated.
#
_CHECK_FILES_POST= check-files-post-message
_CHECK_FILES_POST+= ${_CHECK_FILES_POST.prefix}
.if empty(CHECK_FILES_STRICT:M[nN][oO])
_CHECK_FILES_POST+= ${_CHECK_FILES_POST.sysconfdir}
_CHECK_FILES_POST+= ${_CHECK_FILES_POST.varbase}
.endif
.if empty(CHECK_FILES:M[nN][oO])
privileged-install-hook: check-files
.endif
###########################################################################
# check-files-pre and check-files-post targets and subtargets
#
.PHONY: check-files-pre check-files-post
check-files-pre: ${_CHECK_FILES_PRE}
check-files-post: ${_CHECK_FILES_POST}
.PHONY: check-files-pre-message check-files-post-message
check-files-pre-message:
${_PKG_SILENT}${_PKG_DEBUG}${STEP_MSG} \
"Generating pre-install file lists"
check-files-post-message:
${_PKG_SILENT}${_PKG_DEBUG}${STEP_MSG} \
"Generating post-install file lists"
${_CHECK_FILES_PRE.prefix} ${_CHECK_FILES_POST.prefix}:
${_PKG_SILENT}${_PKG_DEBUG} \
${FIND} ${DESTDIR}${PREFIX}/. \( -type f -o -type l \) -print 2>/dev/null \
| ${SED} -e 's,/\./,/,' \
| ${_CHECK_FILES_SKIP_FILTER} \
| ${SORT} > ${.TARGET} \
|| ${TRUE}
${_CHECK_FILES_PRE.sysconfdir} ${_CHECK_FILES_POST.sysconfdir}:
${_PKG_SILENT}${_PKG_DEBUG} \
${FIND} ${DESTDIR}${PKG_SYSCONFDIR}/. -print 2>/dev/null \
| ${SED} -e 's,/\./,/,' \
| ${_CHECK_FILES_SKIP_FILTER} \
| ${SORT} > ${.TARGET} \
|| ${TRUE}
${_CHECK_FILES_PRE.varbase} ${_CHECK_FILES_POST.varbase}:
${_PKG_SILENT}${_PKG_DEBUG} \
${FIND} ${DESTDIR}${VARBASE}/. -print 2>/dev/null \
| ${SED} -e 's,/\./,/,' \
| ${_CHECK_FILES_SKIP_FILTER} \
| ${SORT} > ${.TARGET} \
|| ${TRUE}
###########################################################################
# check-files targets and subtargets
#
.PHONY: check-files-prefix check-files-sysconfdir check-files-varbase
check-files-prefix: ${_CHECK_FILES_ERRMSG.prefix}
check-files-sysconfdir: ${_CHECK_FILES_ERRMSG.sysconfdir}
check-files-varbase: ${_CHECK_FILES_ERRMSG.varbase}
# The check-files target looks at the cookie files generated by the
# check-files-* subtargets, and if they are non-empty, then they
# contain the error messages collected during the build of each
# subtarget.
#
.PHONY: check-files
.if !empty(CHECK_FILES_SUPPORTED:M[nN][oO])
check-files:
@${DO_NADA}
.else
check-files: check-files-message ${_CHECK_FILES_ERRMSGS} error-check
.endif
.PHONY: check-files-message
check-files-message:
@${STEP_MSG} "Checking file-check results for ${PKGNAME}"
# Check ${PREFIX} for files which are not listed in the generated ${PLIST}
# and vice-versa.
#
_CHECK_FILES_DIFF= ${WRKDIR}/.check_files_diff
_CHECK_FILES_ADDED= ${WRKDIR}/.check_files_added
_CHECK_FILES_DELETED= ${WRKDIR}/.check_files_deleted
_CHECK_FILES_EXPECTED= ${WRKDIR}/.check_files_expected
_CHECK_FILES_MISSING= ${WRKDIR}/.check_files_missing
_CHECK_FILES_MISSING_SKIP= ${WRKDIR}/.check_files_missing_skip
_CHECK_FILES_MISSING_REAL= ${WRKDIR}/.check_files_missing_real
_CHECK_FILES_EXTRA= ${WRKDIR}/.check_files_extra
${_CHECK_FILES_DIFF}: ${_CHECK_FILES_PRE.prefix} ${_CHECK_FILES_POST.prefix}
${_PKG_SILENT}${_PKG_DEBUG} \
${DIFF} -u ${_CHECK_FILES_PRE.prefix} \
${_CHECK_FILES_POST.prefix} \
> ${.TARGET} || ${TRUE}
${_CHECK_FILES_ADDED}: ${_CHECK_FILES_DIFF}
${_PKG_SILENT}${_PKG_DEBUG} \
${GREP} '^+/' ${_CHECK_FILES_DIFF} | ${SED} "s|^+||" | ${SORT} \
> ${.TARGET}
${_CHECK_FILES_DELETED}: ${_CHECK_FILES_DIFF}
${_PKG_SILENT}${_PKG_DEBUG} \
${GREP} '^-/' ${_CHECK_FILES_DIFF} | ${SED} "s|^-||" | ${SORT} \
> ${.TARGET}
${_CHECK_FILES_EXPECTED}: plist
${_PKG_SILENT}${_PKG_DEBUG} \
${GREP} '^[^@]' ${PLIST} | ${SED} "s|^|${DESTDIR}${PREFIX}/|" | ${SORT} \
> ${.TARGET}
${_CHECK_FILES_MISSING}: ${_CHECK_FILES_EXPECTED} ${_CHECK_FILES_ADDED}
${_PKG_SILENT}${_PKG_DEBUG} \
${DIFF} -u ${_CHECK_FILES_EXPECTED} ${_CHECK_FILES_ADDED} | \
${GREP} '^-[^-]' | ${SED} "s|^-||" | \
while read file; do \
${TEST} -f "$$file" || ${ECHO} "$$file"; \
done > ${.TARGET}
${_CHECK_FILES_MISSING_REAL}: ${_CHECK_FILES_MISSING}
${_PKG_SILENT}${_PKG_DEBUG} \
${CAT} ${_CHECK_FILES_MISSING} | ${_CHECK_FILES_SKIP_FILTER} \
> ${.TARGET} || ${TRUE}
${_CHECK_FILES_MISSING_SKIP}: \
${_CHECK_FILES_MISSING} \
${_CHECK_FILES_MISSING_REAL}
${_PKG_SILENT}${_PKG_DEBUG} \
${DIFF} -u ${_CHECK_FILES_MISSING} \
${_CHECK_FILES_MISSING_REAL} | \
${GREP} '^-[^-]' | ${SED} "s|^-||" \
> ${.TARGET}
${_CHECK_FILES_EXTRA}: ${_CHECK_FILES_EXPECTED} ${_CHECK_FILES_ADDED}
${_PKG_SILENT}${_PKG_DEBUG} \
${DIFF} -u ${_CHECK_FILES_EXPECTED} ${_CHECK_FILES_ADDED} | \
${GREP} '^+[^+]' | ${SED} "s|^+||" | \
while read file; do \
${TEST} ! -f "$$file" || ${ECHO} "$$file"; \
done > ${.TARGET}
${_CHECK_FILES_ERRMSG.prefix}: \
${_CHECK_FILES_DELETED} \
${_CHECK_FILES_MISSING} \
${_CHECK_FILES_MISSING_REAL} \
${_CHECK_FILES_MISSING_SKIP} \
${_CHECK_FILES_EXTRA}
${_PKG_SILENT}${_PKG_DEBUG}${RM} -f ${.TARGET}
${_PKG_SILENT}${_PKG_DEBUG} \
if ${_NONZERO_FILESIZE_P} ${_CHECK_FILES_DELETED}; then \
${ECHO} "The following files have been deleted" \
"from ${PREFIX}!"; \
${SED} "s|^| |" ${_CHECK_FILES_DELETED}; \
fi >> ${.TARGET}
${_PKG_SILENT}${_PKG_DEBUG} \
if ${_NONZERO_FILESIZE_P} ${_CHECK_FILES_MISSING_REAL}; then \
${ECHO} "************************************************************"; \
${ECHO} "The following files are in the" \
"PLIST but not in ${PREFIX}:"; \
${SED} "s|^| |" ${_CHECK_FILES_MISSING_REAL}; \
fi >> ${.TARGET}
${_PKG_SILENT}${_PKG_DEBUG} \
if ${_NONZERO_FILESIZE_P} ${_CHECK_FILES_EXTRA}; then \
${ECHO} "************************************************************"; \
${ECHO} "The following files are in" \
"${PREFIX} but not in the PLIST:"; \
${SED} "s|^| |" ${_CHECK_FILES_EXTRA}; \
fi >> ${.TARGET}
${_PKG_SILENT}${_PKG_DEBUG} \
if ${_NONZERO_FILESIZE_P} ${_CHECK_FILES_MISSING_SKIP}; then \
${ECHO} "************************************************************"; \
${ECHO} "The following files are in both the" \
"PLIST and CHECK_FILES_SKIP:"; \
${SED} "s|^| |" ${_CHECK_FILES_MISSING_SKIP}; \
fi >> ${.TARGET}
# Check ${SYSCONFDIR} for files which are not in the PLIST and are also
# not copied into place by the INSTALL scripts.
#
${_CHECK_FILES_ERRMSG.sysconfdir}: \
${_CHECK_FILES_PRE.sysconfdir} \
${_CHECK_FILES_POST.sysconfdir}
${_PKG_SILENT}${_PKG_DEBUG} \
if ${CMP} -s ${_CHECK_FILES_PRE.sysconfdir} \
${_CHECK_FILES_POST.sysconfdir}; then \
${DO_NADA}; \
else \
${ECHO} "************************************************************"; \
${ECHO} "The package has modified ${PKG_SYSCONFDIR}" \
"contents directly!"; \
${ECHO} " The offending files/directories are:"; \
${DIFF} -u ${_CHECK_FILES_PRE.sysconfdir} \
${_CHECK_FILES_POST.sysconfdir} | \
${GREP} '^+[^+]' | ${SED} "s|^+| |"; \
fi > ${.TARGET}
# Check ${VARBASE} for files which are not in the PLIST and are also
# not created by the INSTALL scripts.
#
${_CHECK_FILES_ERRMSG.varbase}: \
${_CHECK_FILES_PRE.varbase} \
${_CHECK_FILES_POST.varbase}
${_PKG_SILENT}${_PKG_DEBUG} \
if ${CMP} -s ${_CHECK_FILES_PRE.varbase} \
${_CHECK_FILES_POST.varbase}; then \
${DO_NADA}; \
else \
${ECHO} "************************************************************"; \
${ECHO} "The package has modified ${VARBASE}" \
"contents directly!"; \
${ECHO} " The offending files/directories are:"; \
${DIFF} -u ${_CHECK_FILES_PRE.varbase} \
${_CHECK_FILES_POST.varbase} | \
${GREP} '^+[^+]' | ${SED} "s|^+| |"; \
fi > ${.TARGET}
###########################################################################
# check-files-clean removes the state files related to the "check-files"
# target so that the check-files-{pre,post} targets may be re-run.
#
.PHONY: check-files-clean
check-clean: check-files-clean
check-files-clean:
${_PKG_SILENT}${_PKG_DEBUG} \
${RM} -f ${_CHECK_FILES_ERRMSGS} \
${_CHECK_FILES_PRE} ${_CHECK_FILES_POST} \
${_CHECK_FILES_DIFF} ${_CHECK_FILES_ADDED} \
${_CHECK_FILES_DELETED} ${_CHECK_FILES_EXPECTED} \
${_CHECK_FILES_MISSING} ${_CHECK_FILES_MISSING_SKIP} \
${_CHECK_FILES_MISSING_REAL} ${_CHECK_FILES_EXTRA}
|