debian/apt.cron.daily

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