]> git.sesse.net Git - backup.sh/blob - backup.sh
now uses pee instead of tee to speed up idx file creation
[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 #  * Sjekk hvorfor .idx-filene til UD er blitt 0 for siste fullbackuper
31 #  * Rydde uleselig kode fra linje 211 og litt nedover
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  #    Pipe the stuff over ssh to ourselves, run pee to cat the contents to a
129  #    file and build a file list, respectivly.  
130  TARFILE=$DATE.tmp
131  TARCMD="ssh root@$computer \"$tar --one-file-system -zcf - -C $filesystem . $lastcmd \
132         --exclude-from=$exf\" | pee \"cat > $TARFILE\" \"tar tvf -\""
133  echo `date`" $computer: Running $TARCMD" >&2
134  eval $TARCMD > $DATE.idx
135
136  if [ -s $TARFILE ]; then
137   # File is >0 in size, we assume it worked.
138
139   # Move tar file in place
140   mv $TARFILE $DATE.tgz
141
142   # Update timestamp
143   echo $DATEs > ../.date && touch -t $DATE ../.date
144
145   # Make a sorted filelist
146   grep -v ^d $DATE.idx | sort -n -r -k 2 > $DATE.sdx
147
148   # Fix permissions
149   chmod 600 *tgz                      #only for us
150   chmod 644 *sdx *idx 2>/dev/null     #everyone can read
151
152  else
153   # Something wrong happened.
154   rm $TARFILE
155   echo `date`" $computer: $TARFILE empty. $backuplevel backup of $computer:$filesystem failed and deleted"
156
157   # We don't want to return 0
158   R=1
159  fi
160
161 }
162
163 for computer in $unixcomputers
164 do
165
166  # Check that the target filesystem is mounted (actually check that it's not
167  # the root filesystem)
168  rootfilesystem=`df -P /`
169  targetfilesystem=`df -P "$storagedir/$computer"`
170  if [ "$rootfilesystem" == "$targetfilesystem" ]; then
171         echo `date`" $computer: Target filesystem ($storagedir/$computer) was mounted on /. Aborting"
172         continue
173  fi
174
175  echo `date`" $computer: Backing up $computer" >&2
176
177  # Try to SSH to the computer without entering a password.
178  if ! `ssh -n -o NumberOfPasswordPrompts=0 root@$computer /bin/true`; then
179   echo `date`" $computer: Could not use passwordless SSH."
180
181   # We don't want to return 0
182   R=1
183   # Do next computer
184   continue;
185  fi
186  
187  filesystems=""
188
189  # Check dump bit in fstab
190  filesystems=`ssh -n root@$computer "cat /etc/fstab" \
191   | grep -v nfs \
192   | grep -v "^#" \
193   | grep -v "^$" \
194   | awk '{ if ( $(NF-1) != "0" ) print $2}' `
195
196  # Clean up our dir at this client
197  if ! ssh root@$computer "rm -r ~/.backup ; mkdir -m 700 ~/.backup"; then
198   echo `date`" $computer: Could not create backup staging area at $computer:~/.backup - skipping backup of $computer"
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   R=1
207   continue;
208  fi
209
210  # Try to copy preeexec and postexec if they exist
211 # TODO: Gah, clean this mess!
212  [ -f $confdir/preexec.$computer ] && (
213     scp $confdir/preexec.$computer  root@$computer:~/.backup/preexec >&2 ||
214      ( echo `date`" $computer: Could not copy preexec.$computer to $computer:~/.backup/preexec - skipping backup of $computer"
215        R=1
216        continue
217      )
218     )
219  [ -f $confdir/postexec.$computer ] && (
220     scp $confdir/postexec.$computer root@$computer:~/.backup/postexec >&2 ||
221      ( echo `date`" $computer: Could not copy postexec.$computer to $computer:~/.backup/postexec - skipping backup of $computer"
222        R=1
223        continue
224      )
225     )
226
227  # Try to run preexec if it exist
228  if ! ssh root@$computer "[ ! -f ~/.backup/preexec ] || /bin/bash -x ~/.backup/preexec" >&2; then
229         echo `date`" $computer: Could not run $computer:~/.backup/preexec - skipping backup of $computer"
230         R=1
231         continue
232  fi
233
234
235  for filesystem in $filesystems
236  do
237   # Remove / and $ (for Windows) for path names
238   sfilesystem=`echo $filesystem | tr '\/\$' '__'`
239
240   # Prepare storage area
241   mkdir -m 755 -p $storagedir/$computer/$sfilesystem/{full,daglig} 2>/dev/null
242   echo $filesystem > ${storagedir}/${computer}/.${sfilesystem}.name 
243   chmod 644 ${storagedir}/${computer}/.${sfilesystem}.name
244
245   # Default backuplevel
246   backuplevel=daglig
247
248   if [ ! -f $storagedir/$computer/$sfilesystem/.date ]
249   then
250    # Take the first full backup of this filesystem on this computer
251    backuplevel=full
252    echo $DATEs > $storagedir/$computer/$sfilesystem/.date
253   fi
254
255   # Check if we want a full backup
256   if [ -z "`find $storagedir/$computer/$sfilesystem/full/ -name \*tgz -mtime -$dagermellomfulle`" ]; then
257    backuplevel=full
258   fi
259  
260   # We want to be here
261   cd $storagedir/$computer/$sfilesystem/$backuplevel || die
262
263   # Perform the actual backup
264   backup
265
266   # Check if this box has a custom number of full backups
267   if [ -f $confdir/maksfulle.$computer ] ; then
268     mf=$((`cat $confdir/maksfulle.$computer`+1))
269   else
270     mf=$(($maksantallfulle+1))
271   fi
272
273   # Delete old full backups
274   for full in `ls -1t $storagedir/$computer/$sfilesystem/full/*tgz | tail -n +$mf`
275   do
276    prefix=`echo $full | sed "s/\.[^.]*$//"`
277    echo `date`": $computer:$filesystem Deleting full backup $prefix" >&2
278    rm $prefix*
279   done
280
281   # Delete incremental backups older than the oldest full backup
282   oldf=`ls -t1 $storagedir/$computer/$sfilesystem/full/*tgz | tail -1`
283   find \
284      $storagedir/$computer/$sfilesystem/daglig \
285      -type f \
286      \! -newer $oldf \
287      -printf "`date`: $computer: Deleting old incremental backup: %p\n" \
288      -exec rm {} \; >&2
289  done
290
291  # Try to run postexec if it exist
292  if ! ssh root@$computer "[ ! -f ~/.backup/postexec ] || /bin/bash -x ~/.backup/postexec" >&2; then
293         echo `date`" $computer: Could not run $computer:~/.backup/postexec"
294         R=1
295  fi
296
297 ) &
298 done
299
300 wait
301
302 # Remove lockfile
303 rm $LOCKFILE
304
305 # Did anything go wrong?
306 # (IMPORTANT NOTE: The R-business does not work as expected, since this script
307 # forks itself).
308 if [ $R != 0 ]; then
309         echo `date`": Backup run ended with errors, check logs."
310         exit 1
311 else
312         echo `date`": Backup run ended" >&2
313 fi