]> git.sesse.net Git - backup.sh/blob - backup.sh
TODOs fixed, known issues listed
[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 # Known issues:
30 #
31 # o $R has no proper meaning because of the forking subshell stuff. We need a
32 #   more robust way of returning non-zero on errors, which we probably don't
33 #   right now.
34 # o The code around line 211 and downwards is messy.
35 #
36
37 # Configuration
38 LOCKFILE=/home/backup/backuprun.lockfile
39 confdir=/home/backup/conf/           # Configuration files
40 storagedir=/backup                   # Where we keep backups
41 maksantallfulle=3                    # Number of full backups
42 dagermellomfulle=30                  # Days between full backups
43 DATE=`date "+%Y%m%d%H%M"`            #format: touch
44 DATEs=`date "+%Y-%m-%d %H:%M"`       #format: tar
45
46 # Exclude-pattern
47 exclude=$confdir/exclude
48 [ ! -f $exclude ] && printf "tmp\ncore\n" > $exclude
49
50 # Initially, we consider everything to be just fine.
51 R=0
52
53 # Die more or less gracefully (at least notify user)
54 die() {
55         echo `date`": Something nasty happened, and since I fork a lot:"
56         echo `date`": I CANNOT CLEAN UP THE MESS MYSELF."
57         echo `date`": You need to get rid of lost process named stuff like $0, tar and ssh."
58         exit 255
59 }
60
61 # Trap C-c and kill
62 trap die SIGINT SIGTERM
63
64 # Don't start if we're already running
65 if [ -e $LOCKFILE ]; then
66         echo `date`": $LOCKFILE exists, exiting."
67         echo `date`": $LOCKFILE exists, exiting." >&2
68         exit 1
69 fi;
70 touch $LOCKFILE
71
72 #syntax of remotestat:
73 #hostname:/directory/
74 remotestatf=$confdir/remotestat
75 [ -f $remotestatf ] && remotestat=`cat $remotestatf`
76 ###
77
78 PATH=/local/bin:$PATH:/store/bin
79 export PATH
80
81 echo `date`": Backup run starting" >&2
82
83 umask 027
84
85 # The computers we want to back up
86 unixcomputers=`cat $confdir/computers.unix \
87   | grep -v "^#" \
88   | grep -v "^$" `
89
90 # Backup only one computer, from command line?
91 if [ $1 ] ; then 
92   unixcomputers=$1
93 fi;
94
95
96 #selve backupen
97 # krever at noen variabler er satt
98 # krever at vi er i rett katalog
99 backup()
100 {
101
102  echo -n `date` >&2
103  printf " $computer: $computer:$filesystem $backuplevel backup" >&2
104
105  if [ "$backuplevel" = "daglig" ] || [ "$backuplevel" = "incremental" ]
106  then
107   lastd=`cat ../.date`
108   lastcmd="--newer='$lastd'"
109  else
110   lastcmd=""
111  fi
112
113  #if this client has a special tar
114  #we need to find a better solution to this conf-issue
115  if [ -f $confdir/tar.$computer ] ; then
116    tar=`cat $confdir/tar.$computer`
117  else 
118    tar=tar
119  fi
120
121  # expand the exclude-path for use with tar
122  exf=`ssh root@$computer "ls ~/.backup/exclude"`
123
124  # We try to run tar on the remote computer
125  #    z gzip it
126  #    c create archive
127  #    C change to directory first
128  #    . where to start taring (see C)
129  #    $lastcmd only files newer than this
130  #    --one-file-system don't traverse file systems
131  #    --exclude-from file to get exclusion pattern from
132  #    Pipe the stuff over ssh to ourselves, run pee to cat the contents to a
133  #    file and build a file list, respectivly.  
134  TARFILE=$DATE.tmp
135  TARCMD="ssh root@$computer \"$tar --one-file-system -zcf - -C $filesystem . $lastcmd \
136         --exclude-from=$exf\" | pee \"cat > $TARFILE\" \"tar tzvf -\""
137  echo `date`" $computer: Running $TARCMD" >&2
138  eval $TARCMD > $DATE.idx
139
140  if [ -s $TARFILE ]; then
141   # File is >0 in size, we assume it worked.
142
143   # Move tar file in place
144   mv $TARFILE $DATE.tgz
145
146   # Update timestamp
147   echo $DATEs > ../.date && touch -t $DATE ../.date
148
149   # Make a sorted filelist as well
150   sort -k6 < $DATE.sdx > $DATE.sdx
151
152   # Fix permissions
153   chmod 600 *tgz                      #only for us
154   chmod 644 *sdx *idx 2>/dev/null     #everyone can read
155
156  else
157   # Something wrong happened.
158   rm $TARFILE
159   echo `date`" $computer: $TARFILE empty. $backuplevel backup of $computer:$filesystem failed and deleted"
160
161   # We don't want to return 0
162   R=1
163  fi
164
165 }
166
167 for computer in $unixcomputers
168 do
169
170  # Check that the target filesystem is mounted (actually check that it's not
171  # the root filesystem)
172  rootfilesystem=`df -P /`
173  targetfilesystem=`df -P "$storagedir/$computer"`
174  if [ "$rootfilesystem" == "$targetfilesystem" ]; then
175         echo `date`" $computer: Target filesystem ($storagedir/$computer) was mounted on /. Aborting"
176         continue
177  fi
178
179  echo `date`" $computer: Backing up $computer" >&2
180
181  # Try to SSH to the computer without entering a password.
182  if ! `ssh -n -o NumberOfPasswordPrompts=0 root@$computer /bin/true`; then
183   echo `date`" $computer: Could not use passwordless SSH."
184
185   # We don't want to return 0
186   R=1
187   # Do next computer
188   continue;
189  fi
190  
191  filesystems=""
192
193  # Check dump bit in fstab
194  filesystems=`ssh -n root@$computer "cat /etc/fstab" \
195   | grep -v nfs \
196   | grep -v "^#" \
197   | grep -v "^$" \
198   | awk '{ if ( $(NF-1) != "0" ) print $2}' `
199
200  # Clean up our dir at this client
201  if ! ssh root@$computer "rm -r ~/.backup ; mkdir -m 700 ~/.backup"; then
202   echo `date`" $computer: Could not create backup staging area at $computer:~/.backup - skipping backup of $computer"
203   R=1
204   continue;
205  fi
206
207  # Try to copy $exclude to $computer
208  if ! scp $exclude root@$computer:~/.backup/exclude > /dev/null; then
209   echo `date`" $computer: Could not copy exclude.txt to $computer - skipping backup of $computer"
210   R=1
211   continue;
212  fi
213
214  # Try to copy preeexec and postexec if they exist
215 # TODO: Gah, clean this mess!
216  [ -f $confdir/preexec.$computer ] && (
217     scp $confdir/preexec.$computer  root@$computer:~/.backup/preexec >&2 ||
218      ( echo `date`" $computer: Could not copy preexec.$computer to $computer:~/.backup/preexec - skipping backup of $computer"
219        R=1
220        continue
221      )
222     )
223  [ -f $confdir/postexec.$computer ] && (
224     scp $confdir/postexec.$computer root@$computer:~/.backup/postexec >&2 ||
225      ( echo `date`" $computer: Could not copy postexec.$computer to $computer:~/.backup/postexec - skipping backup of $computer"
226        R=1
227        continue
228      )
229     )
230
231  # Try to run preexec if it exist
232  if ! ssh root@$computer "[ ! -f ~/.backup/preexec ] || /bin/bash -x ~/.backup/preexec" >&2; then
233         echo `date`" $computer: Could not run $computer:~/.backup/preexec - skipping backup of $computer"
234         R=1
235         continue
236  fi
237
238
239  for filesystem in $filesystems
240  do
241   # Remove / and $ (for Windows) for path names
242   sfilesystem=`echo $filesystem | tr '\/\$' '__'`
243
244   # Prepare storage area
245   mkdir -m 755 -p $storagedir/$computer/$sfilesystem/{full,daglig} 2>/dev/null
246   echo $filesystem > ${storagedir}/${computer}/.${sfilesystem}.name 
247   chmod 644 ${storagedir}/${computer}/.${sfilesystem}.name
248
249   # Default backuplevel
250   backuplevel=daglig
251
252   if [ ! -f $storagedir/$computer/$sfilesystem/.date ]
253   then
254    # Take the first full backup of this filesystem on this computer
255    backuplevel=full
256    echo $DATEs > $storagedir/$computer/$sfilesystem/.date
257   fi
258
259   # Check if we want a full backup
260   if [ -z "`find $storagedir/$computer/$sfilesystem/full/ -name \*tgz -mtime -$dagermellomfulle`" ]; then
261    backuplevel=full
262   fi
263  
264   # We want to be here
265   cd $storagedir/$computer/$sfilesystem/$backuplevel || die
266
267   # Perform the actual backup
268   backup
269
270   # Check if this box has a custom number of full backups
271   if [ -f $confdir/maksfulle.$computer ] ; then
272     mf=$((`cat $confdir/maksfulle.$computer`+1))
273   else
274     mf=$(($maksantallfulle+1))
275   fi
276
277   # Delete old full backups
278   for full in `ls -1t $storagedir/$computer/$sfilesystem/full/*tgz | tail -n +$mf`
279   do
280    prefix=`echo $full | sed "s/\.[^.]*$//"`
281    echo `date`": $computer:$filesystem Deleting full backup $prefix" >&2
282    rm $prefix*
283   done
284
285   # Delete incremental backups older than the oldest full backup
286   oldf=`ls -t1 $storagedir/$computer/$sfilesystem/full/*tgz | tail -1`
287   find \
288      $storagedir/$computer/$sfilesystem/daglig \
289      -type f \
290      \! -newer $oldf \
291      -printf "`date`: $computer: Deleting old incremental backup: %p\n" \
292      -exec rm {} \; >&2
293  done
294
295  # Try to run postexec if it exist
296  if ! ssh root@$computer "[ ! -f ~/.backup/postexec ] || /bin/bash -x ~/.backup/postexec" >&2; then
297         echo `date`" $computer: Could not run $computer:~/.backup/postexec"
298         R=1
299  fi
300
301 ) &
302 done
303
304 wait
305
306 # Remove lockfile
307 rm $LOCKFILE
308
309 # Did anything go wrong?
310 # (IMPORTANT NOTE: The R-business does not work as expected, since this script
311 # forks itself).
312 if [ $R != 0 ]; then
313         echo `date`": Backup run ended with errors, check logs."
314         exit 1
315 else
316         echo `date`": Backup run ended" >&2
317 fi