debian/apt.systemd.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/10periodic file to set your preference.
   7 #
   8 #  Dir "/";
   9 #  - RootDir for all configuration files
  10 #
  11 #  Dir::Cache "var/cache/apt/";
  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). Useful 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 oldest 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::CleanInterval "0";
  66 #  - Do "apt-get clean" every n-days (0=disable)
  67 #
  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
  74 #
  75
  76 check_stamp()
  77 {
  78     stamp="$1"
  79     interval="$2"
  80
  81     if [ $interval -eq 0 ]; then
  82         debug_echo "check_stamp: interval=0"
  83         # treat as no time has passed
  84         return 1
  85     fi
  86
  87     if [ ! -f $stamp ]; then
  88         debug_echo "check_stamp: missing time stamp file: $stamp."
  89         # treat as enough time has passed
  90         return 0
  91     fi
  92
  93     # compare midnight today to midnight the day the stamp was updated
  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
  98         # certain dates (e.g. America/Sao_Paulo), if date returns with error
  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
 108         # on certain dates (e.g. America/Sao_Paulo), if date returns with error
 109         # return 0.
 110         return 0
 111     fi
 112
 113     delta=$(($now-$stamp))
 114
 115     # interval is in days, convert to sec.
 116     interval=$(($interval*60*60*24))
 117     debug_echo "check_stamp: interval=$interval, now=$now, stamp=$stamp, delta=$delta (sec)"
 118
 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
 126     if [ $delta -ge $interval ]; then
 127         return 0
 128     fi
 129
 130     return 1
 131 }
 132
 133 update_stamp()
 134 {
 135     stamp="$1"
 136     touch $stamp
 137 }
 138
 139 # we check here if autoclean was enough sizewise
 140 check_size_constraints()
 141 {
 142     MaxAge=0
 143     eval $(apt-config shell MaxAge APT::Archives::MaxAge)
 144     eval $(apt-config shell MaxAge APT::Periodic::MaxAge)
 145
 146     MinAge=2
 147     eval $(apt-config shell MinAge APT::Archives::MinAge)
 148     eval $(apt-config shell MinAge APT::Periodic::MinAge)
 149
 150     MaxSize=0
 151     eval $(apt-config shell MaxSize APT::Archives::MaxSize)
 152     eval $(apt-config shell MaxSize APT::Periodic::MaxSize)
 153
 154     Cache="/var/cache/apt/archives/"
 155     eval $(apt-config shell Cache Dir::Cache::archives/d)
 156
 157     # sanity check
 158     if [ -z "$Cache" ]; then
 159         echo "empty Dir::Cache::archives, exiting"
 160         exit
 161     fi
 162
 163     # check age
 164     if [ ! $MaxAge -eq 0 ] && [ ! $MinAge -eq 0 ]; then
 165         debug_echo "aged: ctime <$MaxAge and mtime <$MaxAge and ctime>$MinAge and mtime>$MinAge"
 166         find $Cache -name "*.deb"  \( -mtime +$MaxAge -and -ctime +$MaxAge \) -and -not \( -mtime -$MinAge -or -ctime -$MinAge \) -print0 | xargs -r -0 rm -f
 167     elif [ ! $MaxAge -eq 0 ]; then
 168         debug_echo "aged: ctime <$MaxAge and mtime <$MaxAge only"
 169         find $Cache -name "*.deb"  -ctime +$MaxAge -and -mtime +$MaxAge -print0 | xargs -r -0 rm -f
 170     else
 171         debug_echo "skip aging since MaxAge is 0"
 172     fi
 173
 174     # check size
 175     if [ ! $MaxSize -eq 0 ]; then
 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
 183         # reverse-sort by mtime
 184         for file in $(ls -rt $Cache/*.deb 2>/dev/null); do
 185             du=$(du -s $Cache)
 186             size=${du%%/*}
 187             # check if the cache is small enough
 188             if [ $size -lt $MaxSize ]; then
 189                 debug_echo "end remove by archive size:  size=$size < $MaxSize"
 190                 break
 191             fi
 192
 193             # check for MinAge of the file
 194             if [ $MinAge -ne 0 ]; then
 195                 # check both ctime and mtime
 196                 mtime=$(stat -c %Y $file)
 197                 ctime=$(stat -c %Z $file)
 198                 if [ $mtime -gt $ctime ]; then
 199                     delta=$(($now-$mtime))
 200                 else
 201                     delta=$(($now-$ctime))
 202                 fi
 203                 if [ $delta -le $MinAge ]; then
 204                     debug_echo "skip remove by archive size:  $file, delta=$delta < $MinAge"
 205                     break
 206                 else
 207                     # delete oldest file
 208                     debug_echo "remove by archive size: $file, delta=$delta >= $MinAge (sec), size=$size >= $MaxSize"
 209                     rm -f $file
 210                 fi
 211             fi
 212         done
 213     fi
 214 }
 215
 216 # deal with the Apt::Periodic::BackupArchiveInterval
 217 do_cache_backup()
 218 {
 219     BackupArchiveInterval="$1"
 220     if [ $BackupArchiveInterval -eq 0 ]; then
 221         return
 222     fi
 223
 224     # Set default values and normalize
 225     CacheDir="/var/cache/apt"
 226     eval $(apt-config shell CacheDir Dir::Cache/d)
 227     CacheDir=${CacheDir%/}
 228     if [ -z "$CacheDir" ]; then
 229         debug_echo "practically empty Dir::Cache, exiting"
 230         return 0
 231     fi
 232
 233     Cache="${CacheDir}/archives/"
 234     eval $(apt-config shell Cache Dir::Cache::Archives/d)
 235     if [ -z "$Cache" ]; then
 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
 246     Back="${CacheDir}/backup/"
 247     eval $(apt-config shell Back Dir::Cache::Backup/d)
 248     if [ -z "$Back" ]; then
 249         echo "practically empty Dir::Cache::Backup, exiting" 1>&2
 250         return
 251     fi
 252
 253     CacheArchive="$(basename "${Cache}")"
 254     test -n "${CacheArchive}" || CacheArchive="archives"
 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
 285 debug_echo()
 286 {
 287     # Display message if $VERBOSE >= 1
 288     if [ "$VERBOSE" -ge 1 ]; then
 289         echo $1 1>&2
 290     fi
 291 }
 292
 293 check_power(){
 294     # laptop check, on_ac_power returns:
 295     #       0 (true)    System is on main power
 296     #       1 (false)   System is not on main power
 297     #       255 (false) Power status could not be determined
 298     # Desktop systems always return 255 it seems
 299     if which on_ac_power >/dev/null 2>&1; then
 300         on_ac_power
 301         POWER=$?
 302         if [ $POWER -eq 1 ]; then
 303             debug_echo "exit: system NOT on main power"
 304             return 1
 305         elif [ $POWER -ne 0 ]; then
 306             debug_echo "power status ($POWER) undetermined, continuing"
 307         fi
 308         debug_echo "system is on main power."
 309     fi
 310     return 0
 311 }
 312
 313 # ------------------------ main ----------------------------
 314
 315 if test -r /var/lib/apt/extended_states; then
 316     # Backup the 7 last versions of APT's extended_states file
 317     # shameless copy from dpkg cron
 318     if cd /var/backups ; then
 319         if ! cmp -s apt.extended_states.0 /var/lib/apt/extended_states; then
 320             cp -p /var/lib/apt/extended_states apt.extended_states
 321             savelog -c 7 apt.extended_states >/dev/null
 322         fi
 323     fi
 324 fi
 325
 326 # check apt-config existence
 327 if ! which apt-config >/dev/null 2>&1; then
 328         exit 0
 329 fi
 330
 331 # check if the user really wants to do something
 332 AutoAptEnable=1  # default is yes
 333 eval $(apt-config shell AutoAptEnable APT::Periodic::Enable)
 334
 335 if [ $AutoAptEnable -eq 0 ]; then
 336     exit 0
 337 fi
 338
 339 # Set VERBOSE mode from  apt-config (or inherit from environment)
 340 VERBOSE=0
 341 eval $(apt-config shell VERBOSE APT::Periodic::Verbose)
 342 debug_echo "verbose level $VERBOSE"
 343 if [ "$VERBOSE" -le 2 ]; then
 344     # quiet for 0,1,2
 345     XSTDOUT=">/dev/null"
 346     XSTDERR="2>/dev/null"
 347     XAPTOPT="-qq"
 348     XUUPOPT=""
 349 else
 350     XSTDOUT=""
 351     XSTDERR=""
 352     XAPTOPT=""
 353     XUUPOPT="-d"
 354 fi
 355 if [ "$VERBOSE" -ge 3 ]; then
 356     # trace output
 357     set -x
 358 fi
 359
 360 check_power || exit 0
 361
 362 # check if we can lock the cache and if the cache is clean
 363 if which apt-get >/dev/null 2>&1 && ! eval apt-get check $XAPTOPT $XSTDERR ; then
 364     debug_echo "error encountered in cron job with \"apt-get check\"."
 365     exit 0
 366 fi
 367
 368 # Global current time in seconds since 1970-01-01 00:00:00 UTC
 369 now=$(date +%s)
 370
 371 # Support old Archive for compatibility.
 372 # Document only Periodic for all controlling parameters of this script.
 373
 374 UpdateInterval=0
 375 eval $(apt-config shell UpdateInterval APT::Periodic::Update-Package-Lists)
 376
 377 DownloadUpgradeableInterval=0
 378 eval $(apt-config shell DownloadUpgradeableInterval APT::Periodic::Download-Upgradeable-Packages)
 379
 380 UnattendedUpgradeInterval=0
 381 eval $(apt-config shell UnattendedUpgradeInterval APT::Periodic::Unattended-Upgrade)
 382
 383 AutocleanInterval=0
 384 eval $(apt-config shell AutocleanInterval APT::Periodic::AutocleanInterval)
 385
 386 CleanInterval=0
 387 eval $(apt-config shell CleanInterval APT::Periodic::CleanInterval)
 388
 389 BackupArchiveInterval=0
 390 eval $(apt-config shell BackupArchiveInterval APT::Periodic::BackupArchiveInterval)
 391
 392 Debdelta=1
 393 eval $(apt-config shell Debdelta APT::Periodic::Download-Upgradeable-Packages-Debdelta)
 394
 395 # check if we actually have to do anything that requires locking the cache
 396 if [ $UpdateInterval -eq 0 ] &&
 397    [ $DownloadUpgradeableInterval -eq 0 ] &&
 398    [ $UnattendedUpgradeInterval -eq 0 ] &&
 399    [ $BackupArchiveInterval -eq 0 ] &&
 400    [ $AutocleanInterval -eq 0 ] &&
 401    [ $CleanInterval -eq 0 ]; then
 402
 403     # check cache size
 404     check_size_constraints
 405
 406     exit 0
 407 fi
 408
 409 # deal with BackupArchiveInterval
 410 do_cache_backup $BackupArchiveInterval
 411
 412 # ensure we don't do this on battery
 413 check_power || exit 0
 414
 415 # include default system language so that "apt-get update" will
 416 # fetch the right translated package descriptions
 417 if [ -r /etc/default/locale ]; then
 418     . /etc/default/locale
 419     export LANG LANGUAGE LC_MESSAGES LC_ALL
 420 fi
 421
 422 # update package lists
 423 UPDATED=0
 424 UPDATE_STAMP=/var/lib/apt/periodic/update-stamp
 425 if check_stamp $UPDATE_STAMP $UpdateInterval; then
 426     if eval apt-get $XAPTOPT -y update $XSTDERR; then
 427         debug_echo "download updated metadata (success)."
 428         if which dbus-send >/dev/null 2>&1 && pidof dbus-daemon >/dev/null 2>&1; then
 429             if dbus-send --system / app.apt.dbus.updated boolean:true ; then
 430                 debug_echo "send dbus signal (success)"
 431             else
 432                 debug_echo "send dbus signal (error)"
 433             fi
 434         else
 435             debug_echo "dbus signal not send (command not available)"
 436         fi
 437         update_stamp $UPDATE_STAMP
 438         UPDATED=1
 439     else
 440         debug_echo "download updated metadata (error)"
 441     fi
 442 else
 443     debug_echo "download updated metadata (not run)."
 444 fi
 445
 446 # download all upgradeable packages (if it is requested)
 447 DOWNLOAD_UPGRADEABLE_STAMP=/var/lib/apt/periodic/download-upgradeable-stamp
 448 if [ $UPDATED -eq 1 ] && check_stamp $DOWNLOAD_UPGRADEABLE_STAMP $DownloadUpgradeableInterval; then
 449     if [ $Debdelta -eq 1 ]; then
 450         debdelta-upgrade >/dev/null 2>&1 || true
 451     fi
 452     if  eval apt-get $XAPTOPT -y -d dist-upgrade $XSTDERR; then
 453         update_stamp $DOWNLOAD_UPGRADEABLE_STAMP
 454         debug_echo "download upgradable (success)"
 455     else
 456         debug_echo "download upgradable (error)"
 457     fi
 458 else
 459     debug_echo "download upgradable (not run)"
 460 fi
 461
 462 # auto upgrade all upgradeable packages
 463 UPGRADE_STAMP=/var/lib/apt/periodic/upgrade-stamp
 464 if which unattended-upgrade >/dev/null 2>&1 && check_stamp $UPGRADE_STAMP $UnattendedUpgradeInterval; then
 465     if unattended-upgrade $XUUPOPT; then
 466         update_stamp $UPGRADE_STAMP
 467         debug_echo "unattended-upgrade (success)"
 468     else
 469         debug_echo "unattended-upgrade (error)"
 470     fi
 471 else
 472     debug_echo "unattended-upgrade (not run)"
 473 fi
 474
 475 # clean package archive
 476 CLEAN_STAMP=/var/lib/apt/periodic/clean-stamp
 477 if check_stamp $CLEAN_STAMP $CleanInterval; then
 478     if  eval apt-get $XAPTOPT -y clean $XSTDERR; then
 479         debug_echo "clean (success)."
 480         update_stamp $CLEAN_STAMP
 481     else
 482         debug_echo "clean (error)"
 483     fi
 484 else
 485     debug_echo "clean (not run)"
 486 fi
 487
 488 # autoclean package archive
 489 AUTOCLEAN_STAMP=/var/lib/apt/periodic/autoclean-stamp
 490 if check_stamp $AUTOCLEAN_STAMP $AutocleanInterval; then
 491     if  eval apt-get $XAPTOPT -y autoclean $XSTDERR; then
 492         debug_echo "autoclean (success)."
 493         update_stamp $AUTOCLEAN_STAMP
 494     else
 495         debug_echo "autoclean (error)"
 496     fi
 497 else
 498     debug_echo "autoclean (not run)"
 499 fi
 500
 501 # check cache size
 502 check_size_constraints
 503
 504 #
 505 #     vim: set sts=4 ai :
 506 #
 507