]> git.sesse.net Git - backup.sh/blob - backup.sh
Cosmetic cleanups: Better comments, logging and configuration variables readability
[backup.sh] / backup.sh
1 #!/bin/sh
2 # backup.sh
3
4 # Backup up Unix-like computers
5
6 # itk@samfundet.no
7 #
8 # This script was first checked into RCS in 2000, and has since backed up a few
9 # servers almost every day, whenever not broken.
10
11 # It's a bit peculiar, but quite effective. The following is worth keeping in
12 # mind when hacking:
13 #
14 # KISS. And by that I mean really simple. Only regular Unix commands, please
15 # (but GNU extensions are used).
16 #
17 # Because of the way we run this script from cron, informational logging goes
18 # to stderr and warnings and errors to stdout. This way, we get mail whenever
19 # stuff fails, and other output is redirected to the log file.
20
21 # The computers are backed up in parallell (but the filesystems on each
22 # computer in serial). This is implemented highly simplistic, with forking
23 # subshells. The script has no concept about threads, and stuff might go wrong,
24 # which usually requires manual cleanups.
25 #
26 # The script is halfway Norwegian and halfway English. Newer modifications are
27 # in English, we should probably stick to that.
28
29 # TODO(sesse, 2007-12-16): 
30 #  * Bruk tee i stedet for en separat tar ztvf-prosess
31 #  * Sjekk hvorfor .idx-filene til UD er blitt 0 for siste fullbackuper
32
33 # Configuration
34 LOCKFILE=/home/backup/backuprun.lockfile
35 confdir=/home/backup/conf/           # Configuration files
36 storagedir=/backup                   # Where we keep backups
37 maksantallfulle=3                    # Number of full backups
38 dagermellomfulle=30                  # Days between full backups
39 DATE=`date "+%Y%m%d%H%M"`            #format: touch
40 DATEs=`date "+%Y-%m-%d %H:%M"`       #format: tar
41
42 # Exclude-pattern
43 exclude=$confdir/exclude
44 [ ! -f $exclude ] && printf "tmp\ncore\n" > $exclude
45
46 # Initially, we consider everything to be just fine.
47 R=0
48
49 # Die more or less gracefully (at least notify user)
50 die() {
51         echo `date`": Something nasty happened, and since I fork a lot:"
52         echo `date`": I CANNOT CLEAN UP THE MESS MYSELF."
53         echo `date`": You need to get rid of lost process named stuff like $0, tar and ssh."
54         exit 255
55 }
56
57 # Trap C-c and kill
58 trap die SIGINT SIGTERM
59
60 # Don't start if we're already running
61 if [ -e $LOCKFILE ]; then
62         echo `date`": $LOCKFILE exists, exiting."
63         echo `date`": $LOCKFILE exists, exiting." >&2
64         exit 1
65 fi;
66 touch $LOCKFILE
67
68 #syntax of remotestat:
69 #hostname:/directory/
70 remotestatf=$confdir/remotestat
71 [ -f $remotestatf ] && remotestat=`cat $remotestatf`
72 ###
73
74 PATH=/local/bin:$PATH:/store/bin
75 export PATH
76
77 echo `date`": Backup run starting" >&2
78
79 umask 027
80
81 # The computers we want to back up
82 unixcomputers=`cat $confdir/computers.unix \
83   | grep -v "^#" \
84   | grep -v "^$" `
85
86 # Backup only one computer, from command line?
87 if [ $1 ] ; then 
88   unixcomputers=$1
89 fi;
90
91
92 #selve backupen
93 # krever at noen variabler er satt
94 # krever at vi er i rett katalog
95 backup()
96 {
97
98  echo -n `date` >&2
99  printf " $computer: $computer:$filesystem $backuplevel backup" >&2
100
101  if [ "$backuplevel" = "daglig" ] || [ "$backuplevel" = "incremental" ]
102  then
103   lastd=`cat ../.date`
104   lastcmd="--newer='$lastd'"
105  else
106   lastcmd=""
107  fi
108
109  #if this client has a special tar
110  #we need to find a better solution to this conf-issue
111  if [ -f $confdir/tar.$computer ] ; then
112    tar=`cat $confdir/tar.$computer`
113  else 
114    tar=tar
115  fi
116
117  #expand the exclude-path for use with tar
118  exf=`ssh root@$computer "ls ~/.backup/exclude"`
119
120  #We try to run tar on the remote computer
121  #    z gzip it
122  #    c create archive
123  #    C change to directory first
124  #    . where to start taring (see C)
125  #    $lastcmd only files newer than this
126  #    --one-file-system don't traverse file systems
127  #    --exclude-from file to get exclusion pattern from
128  #    And at last, redirect stdout to stderr, to get output logged.
129  TARFILE=$DATE.tmp
130  TARCMD="ssh root@$computer \"$tar --one-file-system -zcf - -C $filesystem . $lastcmd \
131         --exclude-from=$exf\" > $TARFILE"
132  echo `date`" $computer: Running $TARCMD" >&2
133  eval $TARCMD;
134  if [ -s $TARFILE ]; then
135   mv $TARFILE $DATE.tgz
136   #make a filelist.
137   #update the datefile if the filelist is ok.
138   tar tvfz $DATE.tgz > $DATE.idx 2>&1 &&
139     echo $DATEs > ../.date            &&
140     touch -t $DATE ../.date
141
142   #make a sortet filelist
143   grep -v ^d $DATE.idx | sort -n -r -k 2 > $DATE.sdx
144
145   #fix perm
146   chmod 600 *tgz                      #only for us
147   chmod 644 *sdx *idx 2>/dev/null     #everyone can read
148
149  else
150   #it did not work
151   rm $TARFILE
152   echo `date`" $computer: $TARFILE empty. $backuplevel backup of $computer:$filesystem failed and deleted"
153
154   # We don't want to return 0
155   R=1
156  fi
157
158 }
159
160 #Løper gjennom listen av unixmaskiner som vi skal ta backup av
161 for computer in $unixcomputers
162 do
163
164  # Check that the target filesystem is mounted 
165  # (actually check that it's not the root filesystem)
166  rootfilesystem=`df -P /`
167  targetfilesystem=`df -P "$storagedir/$computer"`
168  if [ "$rootfilesystem" == "$targetfilesystem" ]; then
169         echo `date`" $computer: Target filesystem ($storagedir/$computer) was mounted on /. Aborting"
170         continue
171  fi
172
173  echo `date`" $computer: Backing up $computer" >&2
174
175  # Try to SSH to the computer without entering a password.
176  if ! `ssh -n -o NumberOfPasswordPrompts=0 root@$computer /bin/true`; then
177   echo `date`" $computer: Could not use passwordless SSH."
178
179   # We don't want to return 0
180   R=1
181   # Do next computer
182   continue;
183  fi
184  
185  #tømmer variabelen for sikkerhets skyld
186  filesystems=""
187
188  #Sjekker nest siste felt i fstab. Om det er 0 tar vi ikke backup
189  filesystems=`ssh -n root@$computer "cat /etc/fstab" \
190   | grep -v nfs \
191   | grep -v "^#" \
192   | grep -v "^$" \
193   | awk '{ if ( $(NF-1) != "0" ) print $2}' `
194
195  #clean up our dir at this client
196  if ! ssh root@$computer "rm -r ~/.backup ; mkdir -m 700 ~/.backup"; then
197   echo `date`" $computer: Could not create backup staging area at $computer:~/.backup - skipping backup of $computer"
198   # We don't want to return 0
199   R=1
200   continue;
201  fi
202
203  #try to copy $exclude to $computer
204  if ! scp $exclude root@$computer:~/.backup/exclude > /dev/null; then
205   echo `date`" $computer: Could not copy exclude.txt to $computer - skipping backup of $computer"
206   # We don't want to return 0
207   R=1
208   continue;
209  fi
210
211  #try to copy preeexec and postexec if they exist
212 # TODO: Gah, clean this mess!
213  [ -f $confdir/preexec.$computer ] && (
214     scp $confdir/preexec.$computer  root@$computer:~/.backup/preexec >&2 ||
215      ( echo `date`" $computer: Could not copy preexec.$computer to $computer:~/.backup/preexec - skipping backup of $computer"
216        R=1
217        continue
218      )
219     )
220  [ -f $confdir/postexec.$computer ] && (
221     scp $confdir/postexec.$computer root@$computer:~/.backup/postexec >&2 ||
222      ( echo `date`" $computer: Could not copy postexec.$computer to $computer:~/.backup/postexec - skipping backup of $computer"
223        R=1
224        continue
225      )
226     )
227
228  #try to run preexec if it exist
229  if ! ssh root@$computer "[ ! -f ~/.backup/preexec ] || /bin/bash -x ~/.backup/preexec" >&2; then
230         echo `date`" $computer: Could not run $computer:~/.backup/preexec - skipping backup of $computer"
231         R=1
232         continue
233  fi
234
235
236  for filesystem in $filesystems
237  do
238   #lager en variant uten tegnet "/" eller $ (gjelder NT)
239   sfilesystem=`echo $filesystem | tr '\/\$' '__'`
240
241   #lager det som trengs av kataloger
242   mkdir -m 755 -p $storagedir/$computer/$sfilesystem/{full,daglig} 2>/dev/null
243
244   echo $filesystem > ${storagedir}/${computer}/.${sfilesystem}.name 
245   chmod 644 ${storagedir}/${computer}/.${sfilesystem}.name
246
247   #set default backuplevel
248   backuplevel=daglig
249
250   if [ ! -f $storagedir/$computer/$sfilesystem/.date ]
251   then
252    #take the first full backup of this filesystem on this computer
253    backuplevel=full
254    echo $DATEs > $storagedir/$computer/$sfilesystem/.date
255   fi
256
257   #sjekker om det er på tide med en full
258   if [ -z "`find $storagedir/$computer/$sfilesystem/full/ -name \*tgz -mtime -$dagermellomfulle`" ]; then
259    backuplevel=full
260   fi
261  
262   #gå ned i rett katalog, eller dø 
263   # TODO bør sende mail om dette skjer!
264   cd $storagedir/$computer/$sfilesystem/$backuplevel || die
265
266   #perform the actual backup
267   backup
268
269   # Sjekk om det skal være et annet antall fulle backuper av en boks
270   if [ -f $confdir/maksfulle.$computer ] ; then
271     mf=$((`cat $confdir/maksfulle.$computer`+1))
272   else
273     mf=$(($maksantallfulle+1))
274   fi
275
276   #delete complete backups
277   for full in `ls -1t $storagedir/$computer/$sfilesystem/full/*tgz | tail -n +$mf`
278   do
279    prefix=`echo $full | sed "s/\.[^.]*$//"`
280    echo `date`": $computer:$filesystem Deleting full backup $prefix" >&2
281    rm $prefix*
282   done
283
284   #delete incremental backups older than the oldest complete backup
285   oldf=`ls -t1 $storagedir/$computer/$sfilesystem/full/*tgz | tail -1`
286   find \
287      $storagedir/$computer/$sfilesystem/daglig \
288      -type f \
289      \! -newer $oldf \
290      -printf "`date`: $computer: Deleting old incremental backup: %p\n" \
291      -exec rm {} \; >&2
292  done
293
294  #try to run postexec if it exist
295  if ! ssh root@$computer "[ ! -f ~/.backup/postexec ] || /bin/bash -x ~/.backup/postexec" >&2; then
296         echo `date`" $computer: Could not run $computer:~/.backup/postexec"
297         R=1
298  fi
299
300 ) &
301 done
302
303 wait
304
305 # Remove lockfile
306 rm $LOCKFILE
307
308 # Did anything go wrong?
309 # (IMPORTANT NOTE: The R-business does not work as expected, since this script
310 # forks itself.
311 if [ $R != 0 ]; then
312         echo `date`": Backup run ended with errors, check logs."
313         exit 1
314 else
315         echo `date`": Backup run ended" >&2
316 fi