]> git.saurik.com Git - apt.git/blame - debian/apt.systemd.daily
Switch documentation from httpredir.d.o to deb.d.o
[apt.git] / debian / apt.systemd.daily
CommitLineData
0c132682 1#!/bin/sh
0c132682 2#set -e
8a139d4d
MV
3#
4# This file understands the following apt configuration variables:
ff7c76f8 5# Values here are the default.
f9be02d7 6# Create /etc/apt/apt.conf.d/10periodic file to set your preference.
8a139d4d 7#
ff7c76f8
OA
8# Dir "/";
9# - RootDir for all configuration files
8a139d4d 10#
0d0bdb60 11# Dir::Cache "var/cache/apt/";
ff7c76f8
OA
12# - Set apt package cache directory
13#
c1cde32e 14# Dir::Cache::Archives "archives/";
ff7c76f8
OA
15# - Set package archive directory
16#
17443d48
JAK
17# APT::Periodic::Enable "1";
18# - Enable the update/upgrade script (0=disable)
19#
ff7c76f8
OA
20# APT::Periodic::BackupArchiveInterval "0";
21# - Backup after n-days if archive contents changed.(0=disable)
22#
23# APT::Periodic::BackupLevel "3";
24# - Backup level.(0=disable), 1 is invalid.
25#
26# Dir::Cache::Backup "backup/";
27# - Set periodic package backup directory
28#
29# APT::Archives::MaxAge "0"; (old, deprecated)
30# APT::Periodic::MaxAge "0"; (new)
8a139d4d
MV
31# - Set maximum allowed age of a cache package file. If a cache
32# package file is older it is deleted (0=disable)
33#
ff7c76f8
OA
34# APT::Archives::MinAge "2"; (old, deprecated)
35# APT::Periodic::MinAge "2"; (new)
36# - Set minimum age of a package file. If a file is younger it
1e3f4083 37# will not be deleted (0=disable). Useful to prevent races
ff7c76f8
OA
38# and to keep backups of the packages for emergency.
39#
40# APT::Archives::MaxSize "0"; (old, deprecated)
41# APT::Periodic::MaxSize "0"; (new)
8a139d4d
MV
42# - Set maximum size of the cache in MB (0=disable). If the cache
43# is bigger, cached package files are deleted until the size
12c4e7c9 44# requirement is met (the oldest packages will be deleted
8a139d4d
MV
45# first).
46#
ff7c76f8
OA
47# APT::Periodic::Update-Package-Lists "0";
48# - Do "apt-get update" automatically every n-days (0=disable)
49#
50# APT::Periodic::Download-Upgradeable-Packages "0";
51# - Do "apt-get upgrade --download-only" every n-days (0=disable)
6b519e42
JAK
52#
53# APT::Periodic::Download-Upgradeable-Packages-Debdelta "1";
54# - Use debdelta-upgrade to download updates if available (0=disable)
55#
ff7c76f8
OA
56# APT::Periodic::Unattended-Upgrade "0";
57# - Run the "unattended-upgrade" security upgrade script
58# every n-days (0=disabled)
59# Requires the package "unattended-upgrades" and will write
60# a log in /var/log/unattended-upgrades
8a139d4d 61#
ff7c76f8
OA
62# APT::Periodic::AutocleanInterval "0";
63# - Do "apt-get autoclean" every n-days (0=disable)
64#
73d52d65
MV
65# APT::Periodic::CleanInterval "0";
66# - Do "apt-get clean" every n-days (0=disable)
67#
ff7c76f8
OA
68# APT::Periodic::Verbose "0";
69# - Send report mail to root
70# 0: no report (or null string)
71# 1: progress report (actually any string)
72# 2: + command outputs (remove -qq, remove 2>/dev/null, add -d)
73# 3: + trace on
1d6afdd9 74#
0c132682 75
05f6a46a 76check_stamp()
0c132682 77{
05f6a46a
MZ
78 stamp="$1"
79 interval="$2"
80
10946ddc 81 if [ $interval -eq 0 ]; then
53391d0f 82 debug_echo "check_stamp: interval=0"
ff7c76f8 83 # treat as no time has passed
10946ddc
MZ
84 return 1
85 fi
86
05f6a46a 87 if [ ! -f $stamp ]; then
ff7c76f8
OA
88 debug_echo "check_stamp: missing time stamp file: $stamp."
89 # treat as enough time has passed
05f6a46a 90 return 0
0c132682 91 fi
05f6a46a
MZ
92
93 # compare midnight today to midnight the day the stamp was updated
a7c526b6
MV
94 stamp_file="$stamp"
95 stamp=$(date --date=$(date -r $stamp_file --iso-8601) +%s 2>/dev/null)
96 if [ "$?" != "0" ]; then
97 # Due to some timezones returning 'invalid date' for midnight on
e9db7e74 98 # certain dates (e.g. America/Sao_Paulo), if date returns with error
a7c526b6
MV
99 # remove the stamp file and return 0. See coreutils bug:
100 # http://lists.gnu.org/archive/html/bug-coreutils/2007-09/msg00176.html
101 rm -f "$stamp_file"
102 return 0
103 fi
104
105 now=$(date --date=$(date --iso-8601) +%s 2>/dev/null)
106 if [ "$?" != "0" ]; then
107 # As above, due to some timezones returning 'invalid date' for midnight
e9db7e74 108 # on certain dates (e.g. America/Sao_Paulo), if date returns with error
a7c526b6
MV
109 # return 0.
110 return 0
111 fi
112
05f6a46a 113 delta=$(($now-$stamp))
05f6a46a 114
e9db7e74 115 # interval is in days, convert to sec.
8a139d4d 116 interval=$(($interval*60*60*24))
ff7c76f8 117 debug_echo "check_stamp: interval=$interval, now=$now, stamp=$stamp, delta=$delta (sec)"
8a139d4d 118
6e7c6c3f
MV
119 # remove timestamps a day (or more) in the future and force re-check
120 if [ $stamp -gt $(($now+86400)) ]; then
121 echo "WARNING: file $stamp_file has a timestamp in the future: $stamp"
122 rm -f "$stamp_file"
123 return 0
124 fi
125
05f6a46a
MZ
126 if [ $delta -ge $interval ]; then
127 return 0
128 fi
129
130 return 1
131}
132
133update_stamp()
134{
135 stamp="$1"
05f6a46a 136 touch $stamp
0c132682
MZ
137}
138
6cce801a 139# we check here if autoclean was enough sizewise
2e8a92e5 140check_size_constraints()
6cce801a 141{
6cce801a 142 MaxAge=0
6cce801a 143 eval $(apt-config shell MaxAge APT::Archives::MaxAge)
c98870b0
MV
144 eval $(apt-config shell MaxAge APT::Periodic::MaxAge)
145
146 MinAge=2
8a139d4d 147 eval $(apt-config shell MinAge APT::Archives::MinAge)
c98870b0
MV
148 eval $(apt-config shell MinAge APT::Periodic::MinAge)
149
150 MaxSize=0
6cce801a 151 eval $(apt-config shell MaxSize APT::Archives::MaxSize)
c98870b0
MV
152 eval $(apt-config shell MaxSize APT::Periodic::MaxSize)
153
c1cde32e
DK
154 Cache="/var/cache/apt/archives/"
155 eval $(apt-config shell Cache Dir::Cache::archives/d)
6cce801a
MV
156
157 # sanity check
c1cde32e
DK
158 if [ -z "$Cache" ]; then
159 echo "empty Dir::Cache::archives, exiting"
6cce801a
MV
160 exit
161 fi
6cce801a
MV
162
163 # check age
8a139d4d 164 if [ ! $MaxAge -eq 0 ] && [ ! $MinAge -eq 0 ]; then
c98870b0 165 debug_echo "aged: ctime <$MaxAge and mtime <$MaxAge and ctime>$MinAge and mtime>$MinAge"
8e29e348 166 find $Cache -name "*.deb" \( -mtime +$MaxAge -and -ctime +$MaxAge \) -and -not \( -mtime -$MinAge -or -ctime -$MinAge \) -print0 | xargs -r -0 rm -f
8a139d4d 167 elif [ ! $MaxAge -eq 0 ]; then
c98870b0 168 debug_echo "aged: ctime <$MaxAge and mtime <$MaxAge only"
8e29e348 169 find $Cache -name "*.deb" -ctime +$MaxAge -and -mtime +$MaxAge -print0 | xargs -r -0 rm -f
c98870b0
MV
170 else
171 debug_echo "skip aging since MaxAge is 0"
6cce801a
MV
172 fi
173
174 # check size
175 if [ ! $MaxSize -eq 0 ]; then
8a139d4d
MV
176 # maxSize is in MB
177 MaxSize=$(($MaxSize*1024))
178
179 #get current time
180 now=$(date --date=$(date --iso-8601) +%s)
181 MinAge=$(($MinAge*24*60*60))
182
6cce801a 183 # reverse-sort by mtime
3408b58c 184 for file in $(ls -rt $Cache/*.deb 2>/dev/null); do
6cce801a
MV
185 du=$(du -s $Cache)
186 size=${du%%/*}
187 # check if the cache is small enough
188 if [ $size -lt $MaxSize ]; then
c98870b0 189 debug_echo "end remove by archive size: size=$size < $MaxSize"
6cce801a
MV
190 break
191 fi
8a139d4d
MV
192
193 # check for MinAge of the file
c98870b0 194 if [ $MinAge -ne 0 ]; then
8e29e348 195 # check both ctime and mtime
3971f8e8 196 mtime=$(stat -c %Y $file)
8e29e348
MV
197 ctime=$(stat -c %Z $file)
198 if [ $mtime -gt $ctime ]; then
199 delta=$(($now-$mtime))
200 else
201 delta=$(($now-$ctime))
202 fi
8a139d4d 203 if [ $delta -le $MinAge ]; then
e838ca08 204 debug_echo "skip remove by archive size: $file, delta=$delta < $MinAge"
3408b58c 205 break
c98870b0
MV
206 else
207 # delete oldest file
e838ca08 208 debug_echo "remove by archive size: $file, delta=$delta >= $MinAge (sec), size=$size >= $MaxSize"
c98870b0 209 rm -f $file
8a139d4d
MV
210 fi
211 fi
6cce801a
MV
212 done
213 fi
214}
215
c98870b0
MV
216# deal with the Apt::Periodic::BackupArchiveInterval
217do_cache_backup()
218{
219 BackupArchiveInterval="$1"
220 if [ $BackupArchiveInterval -eq 0 ]; then
221 return
222 fi
223
224 # Set default values and normalize
c1cde32e
DK
225 CacheDir="/var/cache/apt"
226 eval $(apt-config shell CacheDir Dir::Cache/d)
c98870b0
MV
227 CacheDir=${CacheDir%/}
228 if [ -z "$CacheDir" ]; then
229 debug_echo "practically empty Dir::Cache, exiting"
230 return 0
231 fi
232
c1cde32e
DK
233 Cache="${CacheDir}/archives/"
234 eval $(apt-config shell Cache Dir::Cache::Archives/d)
235 if [ -z "$Cache" ]; then
c98870b0
MV
236 debug_echo "practically empty Dir::Cache::archives, exiting"
237 return 0
238 fi
239
240 BackupLevel=3
241 eval $(apt-config shell BackupLevel APT::Periodic::BackupLevel)
242 if [ $BackupLevel -le 1 ]; then
243 BackupLevel=2 ;
244 fi
245
c1cde32e
DK
246 Back="${CacheDir}/backup/"
247 eval $(apt-config shell Back Dir::Cache::Backup/d)
248 if [ -z "$Back" ]; then
c98870b0
MV
249 echo "practically empty Dir::Cache::Backup, exiting" 1>&2
250 return
251 fi
252
c1cde32e
DK
253 CacheArchive="$(basename "${Cache}")"
254 test -n "${CacheArchive}" || CacheArchive="archives"
c98870b0
MV
255 BackX="${Back}${CacheArchive}/"
256 for x in $(seq 0 1 $((${BackupLevel}-1))); do
257 eval "Back${x}=${Back}${x}/"
258 done
259
260 # backup after n-days if archive contents changed.
261 # (This uses hardlink to save disk space)
262 BACKUP_ARCHIVE_STAMP=/var/lib/apt/periodic/backup-archive-stamp
263 if check_stamp $BACKUP_ARCHIVE_STAMP $BackupArchiveInterval; then
264 if [ $({(cd $Cache 2>/dev/null; find . -name "*.deb"); (cd $Back0 2>/dev/null;find . -name "*.deb") ;}| sort|uniq -u|wc -l) -ne 0 ]; then
265 mkdir -p $Back
266 rm -rf $Back$((${BackupLevel}-1))
267 for y in $(seq $((${BackupLevel}-1)) -1 1); do
268 eval BackY=${Back}$y
269 eval BackZ=${Back}$(($y-1))
270 if [ -e $BackZ ]; then
271 mv -f $BackZ $BackY ;
272 fi
273 done
274 cp -la $Cache $Back ; mv -f $BackX $Back0
275 update_stamp $BACKUP_ARCHIVE_STAMP
276 debug_echo "backup with hardlinks. (success)"
277 else
278 debug_echo "skip backup since same content."
279 fi
280 else
281 debug_echo "skip backup since too new."
282 fi
283}
284
ff7c76f8 285debug_echo()
6cce801a 286{
ff7c76f8
OA
287 # Display message if $VERBOSE >= 1
288 if [ "$VERBOSE" -ge 1 ]; then
289 echo $1 1>&2
6cce801a 290 fi
ff7c76f8
OA
291}
292
c98870b0 293# ------------------------ main ----------------------------
69c28efc 294
a3b76cde
DK
295if test -r /var/lib/apt/extended_states; then
296 # Backup the 7 last versions of APT's extended_states file
297 # shameless copy from dpkg cron
298 if cd /var/backups ; then
299 if ! cmp -s apt.extended_states.0 /var/lib/apt/extended_states; then
300 cp -p /var/lib/apt/extended_states apt.extended_states
301 savelog -c 7 apt.extended_states >/dev/null
302 fi
a23a7811
DK
303 fi
304fi
305
e9db7e74 306# check apt-config existence
8deda84e 307if ! which apt-config >/dev/null 2>&1; then
18d38975
OS
308 exit 0
309fi
87ddfb96 310
17443d48
JAK
311# check if the user really wants to do something
312AutoAptEnable=1 # default is yes
313eval $(apt-config shell AutoAptEnable APT::Periodic::Enable)
314
9a64707c 315if [ $AutoAptEnable -eq 0 ]; then
17443d48
JAK
316 exit 0
317fi
318
ff7c76f8 319# Set VERBOSE mode from apt-config (or inherit from environment)
6985efb3 320VERBOSE=0
ff7c76f8 321eval $(apt-config shell VERBOSE APT::Periodic::Verbose)
c98870b0 322debug_echo "verbose level $VERBOSE"
ff7c76f8
OA
323if [ "$VERBOSE" -le 2 ]; then
324 # quiet for 0,1,2
325 XSTDOUT=">/dev/null"
326 XSTDERR="2>/dev/null"
327 XAPTOPT="-qq"
328 XUUPOPT=""
329else
330 XSTDOUT=""
331 XSTDERR=""
332 XAPTOPT=""
333 XUUPOPT="-d"
334fi
335if [ "$VERBOSE" -ge 3 ]; then
336 # trace output
337 set -x
338fi
8a139d4d 339
ff7c76f8 340# check if we can lock the cache and if the cache is clean
8deda84e 341if which apt-get >/dev/null 2>&1 && ! eval apt-get check $XAPTOPT $XSTDERR ; then
ff7c76f8
OA
342 debug_echo "error encountered in cron job with \"apt-get check\"."
343 exit 0
344fi
8a139d4d 345
ff7c76f8
OA
346# Global current time in seconds since 1970-01-01 00:00:00 UTC
347now=$(date +%s)
6cce801a 348
ff7c76f8 349# Support old Archive for compatibility.
1e3f4083 350# Document only Periodic for all controlling parameters of this script.
ff7c76f8 351
0c132682 352UpdateInterval=0
ff7c76f8
OA
353eval $(apt-config shell UpdateInterval APT::Periodic::Update-Package-Lists)
354
05f6a46a 355DownloadUpgradeableInterval=0
ff7c76f8 356eval $(apt-config shell DownloadUpgradeableInterval APT::Periodic::Download-Upgradeable-Packages)
0c132682 357
fdd15654
MV
358UnattendedUpgradeInterval=0
359eval $(apt-config shell UnattendedUpgradeInterval APT::Periodic::Unattended-Upgrade)
360
ff7c76f8
OA
361AutocleanInterval=0
362eval $(apt-config shell AutocleanInterval APT::Periodic::AutocleanInterval)
363
73d52d65
MV
364CleanInterval=0
365eval $(apt-config shell CleanInterval APT::Periodic::CleanInterval)
366
c98870b0
MV
367BackupArchiveInterval=0
368eval $(apt-config shell BackupArchiveInterval APT::Periodic::BackupArchiveInterval)
ff7c76f8 369
6b519e42
JAK
370Debdelta=1
371eval $(apt-config shell Debdelta APT::Periodic::Download-Upgradeable-Packages-Debdelta)
372
879cbcc8 373# check if we actually have to do anything that requires locking the cache
4c2dcaa1
MV
374if [ $UpdateInterval -eq 0 ] &&
375 [ $DownloadUpgradeableInterval -eq 0 ] &&
376 [ $UnattendedUpgradeInterval -eq 0 ] &&
2783b261 377 [ $BackupArchiveInterval -eq 0 ] &&
73d52d65
MV
378 [ $AutocleanInterval -eq 0 ] &&
379 [ $CleanInterval -eq 0 ]; then
879cbcc8
DK
380
381 # check cache size
382 check_size_constraints
383
4c2dcaa1
MV
384 exit 0
385fi
fdd15654 386
c98870b0
MV
387# deal with BackupArchiveInterval
388do_cache_backup $BackupArchiveInterval
0c132682 389
966a4c53
MV
390# include default system language so that "apt-get update" will
391# fetch the right translated package descriptions
392if [ -r /etc/default/locale ]; then
393 . /etc/default/locale
6e239830 394 export LANG LANGUAGE LC_MESSAGES LC_ALL
966a4c53
MV
395fi
396
ff7c76f8 397# update package lists
aff278bf 398UPDATED=0
05f6a46a
MZ
399UPDATE_STAMP=/var/lib/apt/periodic/update-stamp
400if check_stamp $UPDATE_STAMP $UpdateInterval; then
ff7c76f8
OA
401 if eval apt-get $XAPTOPT -y update $XSTDERR; then
402 debug_echo "download updated metadata (success)."
8deda84e 403 if which dbus-send >/dev/null 2>&1 && pidof dbus-daemon >/dev/null 2>&1; then
ff7c76f8
OA
404 if dbus-send --system / app.apt.dbus.updated boolean:true ; then
405 debug_echo "send dbus signal (success)"
406 else
407 debug_echo "send dbus signal (error)"
408 fi
409 else
410 debug_echo "dbus signal not send (command not available)"
05f6a46a 411 fi
ff7c76f8 412 update_stamp $UPDATE_STAMP
aff278bf 413 UPDATED=1
ff7c76f8 414 else
c98870b0 415 debug_echo "download updated metadata (error)"
05f6a46a 416 fi
ff7c76f8
OA
417else
418 debug_echo "download updated metadata (not run)."
fdd15654 419fi
c98870b0
MV
420
421# download all upgradeable packages (if it is requested)
422DOWNLOAD_UPGRADEABLE_STAMP=/var/lib/apt/periodic/download-upgradeable-stamp
aff278bf 423if [ $UPDATED -eq 1 ] && check_stamp $DOWNLOAD_UPGRADEABLE_STAMP $DownloadUpgradeableInterval; then
6b519e42
JAK
424 if [ $Debdelta -eq 1 ]; then
425 debdelta-upgrade >/dev/null 2>&1 || true
426 fi
c98870b0
MV
427 if eval apt-get $XAPTOPT -y -d dist-upgrade $XSTDERR; then
428 update_stamp $DOWNLOAD_UPGRADEABLE_STAMP
429 debug_echo "download upgradable (success)"
430 else
431 debug_echo "download upgradable (error)"
432 fi
433else
434 debug_echo "download upgradable (not run)"
435fi
436
437# auto upgrade all upgradeable packages
438UPGRADE_STAMP=/var/lib/apt/periodic/upgrade-stamp
8deda84e 439if which unattended-upgrade >/dev/null 2>&1 && check_stamp $UPGRADE_STAMP $UnattendedUpgradeInterval; then
c98870b0
MV
440 if unattended-upgrade $XUUPOPT; then
441 update_stamp $UPGRADE_STAMP
442 debug_echo "unattended-upgrade (success)"
443 else
444 debug_echo "unattended-upgrade (error)"
445 fi
446else
447 debug_echo "unattended-upgrade (not run)"
448fi
fdd15654 449
73d52d65
MV
450# clean package archive
451CLEAN_STAMP=/var/lib/apt/periodic/clean-stamp
452if check_stamp $CLEAN_STAMP $CleanInterval; then
453 if eval apt-get $XAPTOPT -y clean $XSTDERR; then
454 debug_echo "clean (success)."
455 update_stamp $CLEAN_STAMP
456 else
457 debug_echo "clean (error)"
458 fi
459else
460 debug_echo "clean (not run)"
461fi
462
ff7c76f8 463# autoclean package archive
de15fbae
MV
464AUTOCLEAN_STAMP=/var/lib/apt/periodic/autoclean-stamp
465if check_stamp $AUTOCLEAN_STAMP $AutocleanInterval; then
c98870b0 466 if eval apt-get $XAPTOPT -y autoclean $XSTDERR; then
ff7c76f8
OA
467 debug_echo "autoclean (success)."
468 update_stamp $AUTOCLEAN_STAMP
469 else
c98870b0 470 debug_echo "autoclean (error)"
ff7c76f8
OA
471 fi
472else
c98870b0 473 debug_echo "autoclean (not run)"
de15fbae
MV
474fi
475
0fad7309
MV
476# check cache size
477check_size_constraints
478
ff7c76f8
OA
479#
480# vim: set sts=4 ai :
481#
482