* Added BackupPC::Xfer::Protocol as a common class for each Xfer
[BackupPC.git] / ChangeLog
1 #========================================================================
2 #
3 # ChangeLog - change log for BackupPC.
4 #
5 # DESCRIPTION
6 #   Revision history for BackupPC, detailing significant changes between
7 #   versions, most recent first.
8 #
9 # AUTHOR
10 #   Craig Barratt  <cbarratt@users.sourceforge.net>
11 #
12 #========================================================================
13 #
14 # Version __VERSION__, released __RELEASEDATE__.
15 #
16 # See http://backuppc.sourceforge.net.
17 #
18 #========================================================================
19
20 #------------------------------------------------------------------------
21 # Version __VERSION__, __RELEASEDATE__
22 #------------------------------------------------------------------------
23
24 * Added BackupPC::Xfer::Protocol as a common class for each Xfer
25   method.  This simplifies some of the xfer specific code.
26   Implemented by Paul Mantz.
27
28 * Added FTP xfer method, implemented by Paul Mantz.
29
30 * Added BackupPC::Xfer module to provide a common interface to the
31   different xfer methods.  Implemented by Paul Mantz.
32
33 * Moved setting of $bpc->{PoolDir} and $bpc->{CPoolDir} after the
34   config file is read in BackupPC::Lib. Fix proposed by Tim Taylor
35   and Joe Krahn.
36
37 * Create $TopDir and related data directories in BackupPC_dump
38   prior to hardlink test.  Requested by Les Stott.
39
40 * Modified lib/BackupPC/CGI/RSS.pm to replace \n with \r\n in the RSS
41   http response headers.  Patch submitted by Thomas Eckhardt.
42
43 * Modified bin/BackupPC_archive to allow the archive request file
44   name to contain spaces and dashes, requested by Tim Massey.
45
46 * Fix to configure.pl for --no-fhs case to initialize ConfigDir
47   from Dan Pritts.  Also changed perl path to #!/usr/bin/env perl.
48
49 * Modified bin/BackupPC_archiveHost to shell escape the output file
50   name.  That allows it to contain spaces and other special characters.
51   Requested by Toni Van Remortel.
52
53 * Added --config-override to configure.pl, allow config settings to be
54   set on the command line.  Proposed by Les Stott and Holger Parplies.
55
56 * Minor updates to lib/BackupPC/Lang/fr.pm from Nicolas STRANSKY
57   applied by GFK.
58
59 * Minor updates to lib/BackupPC/Lang/de.pm from Klaus Weidenbach.
60
61 * lib/BackupPC/Xfer/Smb.pm now increments xferErrCnt on NT_STATUS_ACCESS_DENIED
62   and ERRnoaccess errors from smbclient.  Reported by Jesús Martel.
63
64 * Modified bin/BackupPC_sendEmail to not send any per-client email if
65   $Conf{BackupsDisable} is set.
66
67 #------------------------------------------------------------------------
68 # Version 3.1.0, 25 Nov 2007
69 #------------------------------------------------------------------------
70
71 * Fixed config editor bug for case where override is unchecked on
72   an array where the current array is shorter than the main config's
73   array.
74
75 * Fixed missing close quote in BackupPC_archiveHost reported by Franky
76   Van Liedekerke.
77
78 * Replaced "$BinDir/.." with $bpc->InstallDir() for path to BackupPC
79   docs, mentioned by Kenneth Porter.
80
81 * Moved default of $Conf{IncrLevels} from lib/BackupPC/Storage/Text.pm
82   to lib/BackupPC/Lib.pm (after the merge of the config files).  This
83   fixes a bug that caused $Conf{IncrLevels} to get over-ridden if it
84   was only defined in the main config file. Reported by John Rouillard.
85
86 * Fixed the completion status message in BackupPC_dump so that missing
87   error counts appear as 0, rather than empty.  Reported by Bill.
88
89 * Changed lib/BackupPC/Xfer/RsyncFileIO.pm to only increment the error
90   count when the md4 checksum fails on the second phase, not the first.
91   Reported by Adrian Bridgett.
92
93 * Updated a comment in config.pl about BackupPC_nightly, reported by
94   Dan Pritts.
95
96 * Modified lib/BackupPC/CGI/Restore.pm to ensure that the list of hosts
97   presented for direct restore do have direct restore enabled.  Reported
98   by Stephen Joyce.
99
100 * Modified lib/BackupPC/CGI/RestoreFile.pm to replace \n with \r\n in
101   the restore http response headers.  Patch submitted by Thomas Eckhardt.
102
103 #------------------------------------------------------------------------
104 # Version 3.1.0beta1, 21 Oct 2007
105 #------------------------------------------------------------------------
106
107 * When there is an existing partial, a new partials is only saved
108   if it has more files than the existing partial.  Requested by
109   Carl Soderstrom.
110
111 * Fixed handling of $Conf{BackupFilesExclude} for tar XferMethod.
112   Patch supplied by Frans Pop.
113
114 * Fixed numeric column sorting in host summary table, reported by
115   Michael Pellegrino.
116
117 * Fixed host CGI editor so it creates the new host's config.pl file
118   using the lower-case host name, since host names are mapped to
119   lower case when they are read from the hosts file.  Reported by
120   Alexander Onic.
121
122 * Applied documentation patches from Frans Pop.  Also updated
123   Pod::Html to improve documentation formatting.
124
125 * Added Polish translation from Semper.
126
127 * Fixed BackupPC_nightly reporting of repeated pool file hashes.
128
129 * Add run-time check that IO::Dirent is functioning correctly,
130   reported by Doug Lytle.
131
132 * Added comment to Cmd settings in conf/config.pl that they are
133   not executed by a shell, as suggested by Erik van Linstee.
134
135 * Added undefIfEmpty => 1 to lib/BackupPC/Config/Meta.pm for
136   RsyncRestoreArgs, TarClientRestoreCmd and SmbClientRestoreCmd
137   so that restores can be disabled by clear these fields in the
138   CGI editor.  Patch supplied by Stephen Joyce
139
140 * Replaced the FAQ link with Wiki in the navigation bar and added
141   mention of the Wiki to the documentation.  Since these navigation
142   bar links are specified in the config file, upgrades will keep
143   the old FAQ link.  The FAQ opening page will have a prominent
144   link to the Wiki.
145
146 #------------------------------------------------------------------------
147 # Version 3.1.0beta0, 3 Sep 2007
148 #------------------------------------------------------------------------
149
150 * Added new script BackupPC_archiveStart that allows command-line
151   starting of archives.  Based on script written by Sergey Kovzik,
152   which in turn was based on an earlier version by Holger Parplies.
153
154 * Added Simplified Chinese CGI translation from Youlin Feng,
155   plus fixed a couple of cases where utf8 share names were
156   not displayed correctly.
157
158 * Added sorting by column feature to host summary table in CGI
159   interface.  Implemented by Jeremy Tietsort.
160
161 * Added optional support for IO::Dirent which allows inode information
162   to be extracted from the dirent directory structure.  This allows
163   BackupPC to order some directory operations by inode, which on
164   some file systems (eg: ext3) can results in a 20-30% performance
165   gain.  On other file systems there is no real improvement.  This
166   optimization is turned on automatically if IO::Dirent is installed.
167
168 * Added some performance improvements to BackupPC::Xfer::RsyncFileIO
169   for the case of small files with cached checksums.
170
171 * Added check to BackupPC at startup that $TopDir can support
172   hardlinks. Also added check to BackupPC_dump that a hardlink
173   below $TopDir/pc/HOST can be made to below $TopDir/cpool.
174   Also added the need for a hard-link capable file system to
175   the documentation.  Suggested by Nils Breunese.
176
177 * Added FreeBSD init.d file provided by Gabriel Rossetti.
178
179 * Added -l and -L options to BackupPC_tarCreate so that
180   provide a file list (without creating the archive).
181   Requested by Dirk.
182
183 * Made the default charset for BackupPC_zipCreate cp1252, which
184   appears to work correctly with WinZip.  Unfortunately there is
185   no clear standard for charset encoding in zip files.
186
187 * Added support so that pre-3.0 backups with non-utf8 charsets
188   can be viewed and restored correctly.  A new config variable
189   $Conf{ClientCharsetLegacy} specifies the charset used to
190   encode file names in legacy backups.  This is only relevant
191   if you are trying to view or restore a backup made with
192   BackupPC 2.x and some of the file names have non-ascii
193   characters.
194
195 * Added setting of the environment variable BPC_REQUSER to
196   the requesting user name in BackupPC prior to fork(), so
197   each child process inherits the value.  Submitted by
198   Holger Parplies.
199
200 * Fixed bug in rsync incrementals that happens on particular
201   file names when a file being backed up fails in both rsync
202   phases.  Reported by Dan Smisko.
203
204 * Fixed single-restore file name charsets for IE, reported by
205   Francis Lessard.
206
207 * Fixed makeDist so that the --config-dir option to configure.pl
208   works correctly.  Reported by Randy Barlow, Tony Shadwick and others.
209
210 * Removed ConfDir from config editor (since it is hardcoded in
211   lib/BackupPC/Lib.pm).  Also made TopDir and LogDir only visible
212   if useFHS (for non-FHS they are hardcoded in lib/BackupPC/Lib.pm).
213
214 * Applied patch from Holger Parplies that fixes cleanup of early abort
215   in BackupPC_dump.
216
217 * Applied small patch from Sergey to lib/BackupPC/Xfer/Tar.pm that makes
218   it ignore "socket ignored" error on incrementals.
219
220 * Applied small patch from Sergey to bin/BackupPC_archiveHost.
221
222 * Changed BackupPC_sendEmail so that summary admin email doesn't
223   include errors from hosts that have $Conf{BackupsDisable} set.
224   Reported by James Kyle.  Also, per-user email is now disabled
225   when $Conf{BackupsDisable} is set.
226
227 * Added RsyncdUserName to the config editor.  Reported by Vicent Roca Daniel.
228
229 * $Conf{IncrLevels} is now defaulted if it is not defined.
230
231 * configure.pl clears $Conf{ParPath} if it doesn't point to a valid
232   executable.
233
234 * Added documentation for BackupPC_tarPCCopy, including use of -P option
235   to tar suggested by Daniel Berteaud.
236
237 * Config editor now removes white space at start of exec path.
238   Reported by Christoph Iwasjuta.
239
240 * CgiDateFormatMMDD == 2 gives a YYYY-MM-DD format for CGI dates,
241   suggested by Imre.
242
243 #------------------------------------------------------------------------
244 # Version 3.0.0, 28 Jan 2007
245 #------------------------------------------------------------------------
246
247 * BackupPC_sendEmail now correctly sends admin email if backups
248   were skipped because the disk was too full, reported by Dan
249   Pritts.
250
251 * BackupPC_Admin now uses $Conf{UmaskMode}, so config.pl files
252   written by the editor have more restrictive permissions.
253   Reported by Tim Massey.
254
255 * Host summary now shows active backups on disabled hosts,
256   from Jono Woodhouse.
257
258 * Fixed host LOG link and LOG list order, reported by Tim Massey.
259
260 * Moved Encode.pm version check to start of configure.pl so it
261   produces a useful error message if Encode.pm is too old.
262
263 * Fixed hrefs to configuration documentation to handle changes
264   in the way perl generates the anchors.  Reported by Philip
265   Gleghorn.
266
267 * Host name links in LOG files now allow "." in the host name.
268   Reported by Jean-Michel Beuken.
269
270 * Fixes to lib/BackupPC/Xfer/Tar.pm for tar 1.16: allow 1
271   (ie: 256) as a successful exit status and match "Total
272   bytes read" message for restores.  First reported by
273   Torsten Sadowski and debugged by Ralf Gross and Holger
274   Parplies.
275
276 #------------------------------------------------------------------------
277 # Version 3.0.0beta3, 3 Dec 2006
278 #------------------------------------------------------------------------
279
280 * Removed default paths from conf/config.pl so configure.pl will
281   determine the correct ones at install time.  Avoids problem of
282   the config editor complaining about bad executable paths the
283   first time you use it.
284
285 * Changed first byte of compressed files with rsync checksums appended
286   to 0xd7 to allow correct protocol_version >= 27 md4 checksums to be
287   written.  Old cached checksum files have a first byte 0xd6 and are
288   now considered to be uncached.  They will be automatically updated
289   as needed.  This avoids the cached checksum warnings in beta2.
290
291 * BackupPC_tarPCCopy now handles all file types correctly.  Reported
292   by George Avrunin.
293
294 * Fixed BackupPC_nightly to finish pending deletes before renaming
295   pool chains.
296
297 * Fixes for rsync restore where hardlink is to file outside of the
298   top-level restore directory.  Reported by George Avrunin, who helped
299   with debugging.
300
301 * Fixes for checksum mismatch on restore for certain file sizes.
302   Reported by George Avrunin and others.
303
304 * Fix for config.pl writing code to handle multi-line expressions.
305   Reported by David Relson and others.
306
307 * Fix for CGI editor when deleting hash entries whose keys are
308   non alphanumeric.  Report by David Relson and Aaron Ciarlotta.
309
310 * Two fixes to configure.pl from Andreas Vögele.
311
312 #------------------------------------------------------------------------
313 # Version 3.0.0beta2, 18 Nov 2006
314 #------------------------------------------------------------------------
315
316 * Fix for final md4 digest check on rsync transfers >= 512MB when protocol
317   version >= 27 and checksums are not cached.  Reported by Garith Dugmore
318   and Dale Renton.
319
320 * Config Editor "Save" button is now always visible, but greyed out
321   until there are changes to save.
322
323 * Config editor allows other tabs to be selected when there is an
324   error, which allows you to fix an error (eg: missing binary) in
325   an exiting config file.  Errors are now displayed at the top of
326   the page in addition to next to the erroneous setting.
327
328 * configure.pl checks version of Encode.pm.  Reported by Chris Stone.
329
330 * Several fixes to bin/BackupPC_fixupBackupSummary from Stian Jordet.
331
332 * Fixed config.pl editor writing to solve bug with multi-line text
333   strings ending in newline.  Reported and root caused by Les Stott
334   and Jerry Groendyke.
335
336 * Fixed error recovery case in BackupPC::PoolWrite, reported by
337   Samuel Bancal.
338
339 * Fixed table width in backup browsing to avoid Firefox layout anomoly,
340   provided by Jono Woodhouse.
341
342 * CSS file updates from Jono Woodhouse.  Prior (v2) version is included
343   as BackupPC_stnd_orig.css in case people prefer the old skin.
344
345 * More compact host summary, including disabled host indication,
346   from Jono Woodhouse.
347
348 * New directory/file/hardlink and symlink image icons from Sean Cameron
349   and Jono Woodhouse, making directory browse more compact.
350
351 * BackupPC.pid is now world readable, suggested by Casper Thomsen.
352
353 * Reordered the Server navigation bar links, suggested by David Relson.
354
355 * Fixed typos in init.d/src/gentoo-backuppc, configure.pl and config.pl
356   reported by David Relson.
357
358 #------------------------------------------------------------------------
359 # Version 3.0.0beta1, 30 Jul 2006
360 #------------------------------------------------------------------------
361
362 * Fixed several Xfer charset conversions.
363
364 * Added some CGI utf8 conversions from Rodrigo Real and Vincent
365   Fleuranceau.
366
367 * Rsync transfers now correctly handle file names with \n or \r.
368
369 * Host name is forced to lower case, to match 2.x.
370
371 * Fixed LOG file naming in BackupPC_restore and BackupPC_archive.
372
373 * GFK applied fr.pm corrections from Nicolas Stransky.
374
375 * Updated init.d/src scripts for FHS (ie: replaced __TOPDIR__/log
376   with __LOGDIR__ and __TOPDIR__/conf with __CONFDIR__).  Patch
377   provided by Rodrigo Real.
378
379 * Added --log-dir and --conf-dir options to configure.pl.
380   Reported by Vincent Fleuranceau.
381
382 * Updated File::RsyncP version check in configure.pl, reported
383   by Vincent Fleuranceau.  Changed File::RsyncP version to 0.64.
384
385 #------------------------------------------------------------------------
386 # Version 3.0.0beta0, 11 Jul 2006
387 #------------------------------------------------------------------------
388
389 * Added configuration and host CGI editor.
390
391 * Added rsync hardlink support.  Requires latest version of
392   File::RsyncP (0.62).
393
394 * Decoupled BackupPC_dump from BackupPC_nightly by making
395   asynchronous file linking/delete robust to race conditions.
396   Now only BackupPC_nightly and BackupPC_link are mutually
397   exclusive so only one runs at a time, and BackupPC_dump and
398   BackupPC_restore can run anytime.
399
400 * Added support for multi-level incrementals.  In the style of dump(1),
401   the level of each incremental can be specified.  Each incremental
402   backups up everything since the most recent backup of a lower level
403   (fulls are always level 0).  Previous behavior was all incrementals
404   were level 1, meaning they backed up everything since the last full
405   (level 0).  Default configuration is all incrementals are level 1.
406
407 * Server file names are now in utf8 and optional conversion
408   to/from client name charsets can be configured.  All CGI pages
409   now use the utf8 charset.
410
411 * Backup metadata is now additionally saved to pc/HOST/nnn/backupInfo,
412   in addition to pc/HOST/backups.  In case pc/HOST/backups gets trashed,
413   then a new script BackupPC_fixupBackupSummary can read the per-backup
414   metadata from pc/HOST/nnn/backupInfo and reconstruct the backups file.
415   Roberto Moreno also pointed out an early error in the CVS version.
416
417 * Added Storage module and Storage::Text which localizes all the
418   text data file reading/writing (eg: backups, restores, archives
419   and config.pl files).  Added read verify after all write
420   operations for robustness.  Additional backends (eg: SQL)
421   can be added in the future as new subclasses of the Storage
422   module.
423
424 * Added Config module, and Config::Meta that contains meta data
425   about configuration parameters.
426
427 * Added RSS support from Rich Duzenbury.
428
429 * Translations of new 3.0 language strings from Guillaume Filion,
430   Reginaldo Ferreira, Ralph Passgang, Lieven Bridts, Guus Houtzager,
431   Rodrigo Real.
432
433 * Added optional checking of exit status of Dump/Restore/Archive Pre/Post
434   UserCmd, requested by Kiko Jover, Matthias Bertschy and others.
435
436 * For new installations configure.pl tries to comply with the file
437   system hierarchy standard, which means all the configuration files
438   below /etc/BackupPC and log files go below /var/log/BackupPC.
439
440 * Added Slackware init.d script from Tony Nelson.
441
442 * Fixed error reporting when restore/archive fail to write the
443   request file to the client directory.
444
445 * Applied patch from Marc Prewitt for DumpPreShareCmd and DumpPostShareCmd.
446
447 * Apply patch from Pete Wenzel to add smbClientPath => $Conf{SmbClientPath}
448   to DumpPreUserCmd etc.
449
450 * Added Portuguese Brazillian pt_br.pm from Reginaldo Ferreira.
451
452 * Jean-Michel Beuken reported several bugs in configure.pl in CVS 3.0.0.
453
454 * Old backup email warnings now ignore partials requested by Samuel Bancal
455
456 * Applied patch to bin/BackupPC_sendEmail from Marc Prewitt that
457   ignores any file starting with "." in the pc directory when
458   it is generating warnings about old/unused files/directories.
459
460 * Applied patch from Marc Prewitt to fix host queue order.
461  
462 * Applied Lorenzo Cappelletti's it.pm patch.
463
464 * Applied Wander Winkelhorst's nl.pm patch.
465
466 * Applied Alberto Marconi's it.pm patch.
467
468 * Add NT_STATUS_FILE_LOCK_CONFLICT to pst read error check in
469   BackupPC_sendEmail to fix bug reported by Dale Renton.
470
471 * Added fixup of $ENV{REMOTE_USER} to lib/BackupPC/CGI/Lib.pm in the
472   case of using mod_authz_ldap; patch submitted by Alain Perrier.
473
474 * Added env LC_ALL=C to $Conf{TarClientCmd} and $Conf{TarClientRestoreCmd}
475   to avoid locale problems, suggested by Ludovic Drolez.
476
477 * Changed ping output parsing to pick out average rtt time, based
478   on patch from Ron Bickers.
479
480 * Removed leading "./" and top-level "./" directory from
481   zip archives generated by BackupPC_zipCreate.  Reported
482   by Josh (hecktarzuli).
483
484 * BackupPC_tarCreate and BackupPC_zipCreate now allow "@"
485   in share names.  Reported by Robert Waldner.
486
487 * NT_STATUS_INSUFF_SERVER_RESOURCES is now a fatal error for
488   smbclient transfers, suggested by Brian Shand.
489
490 * Changed bin/BackupPC_archiveHost to use /bin/csh instead of
491   /bin/sh.  That way any errors in the pipeline are reported
492   via the exit status, instead of just the last.
493
494 * Added $Conf{EMailHeaders} for additional email headers, requested
495   by Ludovic Gasc.  If the Content-Type charset is set to utf8 then
496   the body of the email is sent in utf8 coding.
497
498 * Made shareName argument regexp checking more general to allow parens.
499
500 * Added some debian init.d instructions to init.d/README from
501   Bob de Wildt.
502
503 * Documentation updates from Richard Ames, JP Vossen, Torsten Finke.
504
505 #------------------------------------------------------------------------
506 # Version 2.1.2pl2, 18 Jun 2006
507 #------------------------------------------------------------------------
508
509 * In conf/config.pl, changed --devices to -D in $Conf{RsyncArgs}
510   and $Conf{RsyncRestoreArgs} to fix "fileListReceive failed" and
511   "Can't open .../f%2f for empty output" errors with rsync 2.6.7+.
512   Fix proposed by Justin Pessa and Vincent Ho, and confirmed by
513   Dan Niles.
514
515 * Added patch from Michael (mna.news) to ignore "file is unchanged"
516   message from tar 1.15.x during incremental backups.
517
518 * Fixed creation of .rsrc directories in bin/BackupPC_tarExtract
519   when used with xtar on MacOS.  Reported by Samuel Bancal and
520   Matthew Radey, who helped with debugging.
521
522 * Fixed bug in BackupPC_tarExtract for files >8GB in size whose
523   lengths are multiples of 256.  Reported by Jamie Myers and
524   Marko Tukiainen, who both helped debugging the problem.
525
526 * Fixed bug in lib/BackupPC/Xfer/RsyncFileIO.pm that caused
527   incorrected deleted attributes to be set in directories
528   where one of the files had an rsync phase 1 retry during
529   an incremental.  Reported by Tony Nelson.
530
531 #------------------------------------------------------------------------
532 # Version 2.1.2, 5 Sep 2005
533 #------------------------------------------------------------------------
534
535 * Fixed simple but serious bug in bin/BackupPC_tarCreate that prevented
536   hardlinks being saved correctly.  Debugged by Michael (mna.news)
537   with several other people.
538
539 * Fixed serious bug in bin/BackupPC_dump reported/debugged by Dan Niles
540   that can happen when multiple full backups are deleted after
541   $Conf{FullKeepCnt} is changed.
542
543 * Changed lib/BackupPC/CGI/Lib.pm so that link to "$TopDir/conf/$host.pl"
544   is displayed if it exists.  Patch from Andreas Vögele.
545
546 * Applied daemonize patch to bin/BackupPC from:
547         http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=301057
548
549 * It's now a fatal error if $Conf{CompressLevel} is set, but
550   Compress::Zlib is not found.  Before $Conf{CompressLevel} was
551   silently set to 0, which made all the backups uncompressed.
552   That meant the user never knew if they forget to install
553   Compress::Zlib but were expecting compression to be on.
554
555 * Finally increased $Conf{ClientTimeout} to 72000 (20 hours).
556
557 * Added sleep 1 in restart() function in init.d/src/gentoo-backuppc,
558   suggested by Jon Hood.
559
560 * Added $DestDir to the path of the CGI image directory in configure.pl.
561   Patch submitted by Andreas Vögele.
562
563 * Applied extensive patch to French translation from Frederic Lehobey.
564
565 * Minor change to Dutch language $Lang{Pool_Stat} from Wander Winkelhorst.
566
567 * Minor change to French language $Lang{EMailOutlookBackupMesg} and
568   $Lang{EMailOutlookBackupSubj} from Ludovic Gasc.
569
570 #------------------------------------------------------------------------
571 # Version 2.1.1, 13 Mar 2005
572 #------------------------------------------------------------------------
573
574  * Fixed bug in top-level restore using rsync XferMethod.
575    BackupPC::View was leaving an extra leading "/" at the start
576    of top-level directories, messing up the FileList sort order.
577    Reported and debugged by Gail Edwards.
578
579  * Added pathCreate() to BackupPC_tarExtract so that new directories
580    are created.  Required for xtar on MacOSX since the virtual resource
581    fork directories (.rsrc) are not explicitly included in the tar
582    archive - just the files below .rsrc are.
583
584  * Changed $host.$bkupNum.tar$fileExt.* to $host.$bkupNum.tar$fileExt*
585    in $parCmd in bin/BackupPC_archiveHost.
586
587  * Fixed HostSortCompare() in BackupPC to correctly sort hosts so
588    those with the oldest backups get queued first.
589
590  * Changed test in BackupPC_sendEmail so that directories/files
591    starting with "." in $TopDir/pc are ignored, rather than
592    just "." and "..".
593
594  * Changed BackupPC_sendEmail to include NT_STATUS_FILE_LOCK_CONFLICT
595    in check for bad outlook files.
596
597  * Ensure that %Status and %StatusHost are empty if requesting
598    status on hosts in lib/BackupPC/CGI/Lib.pm GetStatusInfo().
599    Fixes problem with new hosts under mod_perl.
600
601  * Added images/icon-hardlink.gif so that hardlinks show file type icon.
602
603 #------------------------------------------------------------------------
604 # Version 2.1.0pl1, 15 Aug 2004
605 #------------------------------------------------------------------------
606
607 * Added fix to nl.pm from Lieven Bridts.
608
609 * Added patch from Tony Nelson to remove $Info{pid} before BackupPC
610   writes the status and shuts down.
611
612 * Changed BackupPC_nightly so that it doesn't call find() if the
613   directory doesn't exist.  This avoids errors in certain versions
614   of perl.  Reported by Bernd Rilling.
615
616 * Fixed BackupPC::CGI::Lib to correctly re-load config.pl for mod_perl.
617   Reported by Tony Nelson and Jimmy Liang.
618
619 * Explicitly untaint $In{host} in BackupPC::CGI::Lib to fix problem
620   reported by Thomas Tempé.
621
622 * Added newline to "...skipping because of user requested delay..."
623   log message in BackupPC_dump.  Reported by Wayne Scott.
624
625 * Added read file size error checking to BackupPC_tarCreate.
626   Reported by Brandon Evans.
627
628 * Added check in BackupPC::Xfer::RsyncFileIO to ensure that when
629   compression is toggled on/off, a compressed backup doesn't link
630   to an uncompressed pool file (and an uncompressed backup doesn't
631   link to a compressed pool file).  Reported by Brandon Evans.
632
633 * Updated documentation with new dirvish URL and a typo from
634   Todd Curry.
635
636 * Fix to BackupPC_sendEmail so that it correctly sends admin emails
637   for hosts that have failed backups.  Reported by Simon Kuhn.
638
639 #------------------------------------------------------------------------
640 # Version 2.1.0, 20 Jun 2004
641 #------------------------------------------------------------------------
642
643 * Added Dutch translation from Lieven Bridts, with tweaks from
644   Guus Houtzager.
645
646 * Added PC-specific config file read in CGI/Archive.pm.  Patch
647   from Pete Wenzel.
648
649 * Added non-zero exit code to BackupPC_zcat when uncompress fails.
650   Patch from Pete Wenzel.
651
652 * Cosmetic changes to PC Summary and Log file language strings from
653   Pete Wenzel.
654
655 * BackupPC::Lib tries to be more careful when renaming the backups
656   file to backups.old.  There have been reports of backups being
657   empty, perhaps when the BackupPC data file system fills up.
658   Now backups is not renamed to backups.old if backups is empty.
659
660 * BackupPC now closes stderr and stdout before renaming and
661   re-opening the log file.
662
663 * Pre/post backup/restore/archive commands now correctly set
664   "type" to either incr/full/restore/archive, and now cmdType
665   is the type of Pre/post backup/restore/archive command.
666
667 * BackupPC_archive correctly terminates archive processes on
668   alarm or cancel.
669
670 * Updates to BackupPC_stnd.css with absolute font sizes instead
671   of relative.
672
673 * BackupPC_dump now makes sure that the $Conf{FullAgeMax} check
674   also ensures the full backup is older than the maximum age
675   expected from $Conf{FullPeriod}.
676
677 #------------------------------------------------------------------------
678 # Version 2.1.0beta2pl1, 30 May 2004
679 #------------------------------------------------------------------------
680
681 * Fixed bug in rsync checksum caching code in BackupPC::Xfer::RsyncDigest.
682
683 * BackupPC_zipCreate now ensures the earliest mtime is 1/1/1980,
684   since zip file formats don't support earlier dates.  Reported
685   by Dan Niles.
686
687 * CGI restore via zip and tar now makes sure stderr is ignored
688   when BackupPC_tarCreate and BackupPC_zipCreate are run.
689   Previously any stderr output would get mixed in the archive,
690   corrupting it.  Reported by Dan Niles.
691
692 #------------------------------------------------------------------------
693 # Version 2.1.0beta2, 23 May 2004
694 #------------------------------------------------------------------------
695
696 * $Conf{BackupFilesOnly} and $Conf{BackupFilesExclude} now apply
697   to every share, rather than just the first, in the case where
698   they are arrays and there are multiple shares.  Suggested
699   by Andy Evans.
700
701 * On the phase 2 retry pass with rsync, verify the cached checksums
702   if checksum caching is turned on.  This will catch the case of
703   cached checksums being incorrectly appended to the compressed
704   pool file.  Added new config parameter $Conf{RsyncCsumCacheVerifyProb}
705   so that cached checksums are verified with a selectable probability.
706   Also, increased File::RsyncP version number to 0.51.
707
708 * configure.pl now supports an optional batch mode.  Command-line
709   options are used to specify all the information that configure.pl
710   needs.  This is useful for building auto-install packages.
711   Also, configure.pl now includes pod documentation, so you can do
712   "perldoc configure.pl" to see all the command-line options.
713   Suggested, tested and tweaked by Stuart Herbert for possible
714   Gentoo inclusion.
715
716 * At each wakeup, clients are now queued based on how old the most
717   recent backup is.  Clients with errors are queued first, with
718   the oldest error times going first.  The rest of the clients are
719   queued next, with the clients with the oldest backup going first.
720   Previously the clients were simply queued in alphabetic order.
721   Suggested by Mike Trisko and Tony Nelson.
722
723 * Added config parameter $Conf{PartialAgeMax} that controls whether
724   partials are saved at all, and if so, whether the partial will be
725   ignored at the next full backup if it is too old.
726
727 * BackupPC_tarExtract now allows empty archives without reporting
728   an error.  Reported by Don Silvia.
729
730 * Removed Browse Backups link from Nav Bar in Archive Info display.
731   Reported by Ralph Paßgang.
732
733 * Fixed documentation display for regular users.  Reported by Ralph Paßgang.
734
735 * Status and PC Summary now work for regular users and only show
736   that user's hosts.  Server general status information only appears
737   for admins.  Suggested by Ralph Paßgang.
738
739 * Moved the last three navigation-bar links (docs, FAQ and SF) to
740   a new config parameter $Conf{CgiNavBarLinks}.  This allows
741   these links to be locally configured.  Based on a patch
742   submitted by Ralph Paßgang.
743
744 * Allow the navigation bar search box to be disabled by
745   setting $Conf{CgiSearchBoxEnable} to 0.  Based on a patch
746   submitted by Ralph Paßgang.
747
748 * Updates to de.pm from Ralph Paßgang.
749
750 * Made the BackupPC icon a link to the SF BackupPC project page.
751
752 #------------------------------------------------------------------------
753 # Version 2.1.0beta1, 4 Apr 2004
754 #------------------------------------------------------------------------
755
756 * The CSS definition has been removed from the config.pl file and
757   is now a separate file, BackupPC_stnd.css.  A new config variable,
758   $Conf{CgiCSSFile}, gives the name of the CSS file to use.
759   Suggested by Ender Mathias.
760
761 * Fixed the filling of the host name select box for admins.
762   The default $Conf{CgiNavBarAdminAllHosts} is now 1.
763   Reported by Doug Lytle.
764
765 * Cleaned up warning message for restore using rsync when checksum
766   caching is on, but when file didn't have cached checksums.
767
768 * Fixed BackupPC_archiveHost to support par2 (par2cmdline).
769   Patch submitted by Jaco Bongers and adapted by Josh Marshall.
770
771 * Improved stat() usage in BackupPC_nightly, plus some other cleanup,
772   giving a significant performance improvement.  Patch submitted by
773   Wayne Scott.
774
775 * Allow several BackupPC_nightly processes to run in parallel based
776   on new $Conf{BackupPCNightlyJobs} setting.  This speeds up the
777   traversal of the pool, reducing the overall run time for
778   BackupPC_nightly.
779
780 * Allow BackupPC_nightly to split the pool traversal across several
781   nightly runs.  This improves the running time per night, at the expense
782   of a slight increase in disk storage as unused pool files might not
783   be deleted for a couple of days.  Controller by new config setting
784   $Conf{BackupPCNightlyPeriod}.
785
786 #------------------------------------------------------------------------
787 # Version 2.1.0beta0, 20 Mar 2004
788 #------------------------------------------------------------------------
789
790 * A failed full dump is now saved as a partial (incomplete) dump,
791   provided it includes some files.  This can be used for browsing,
792   restoring etc, and will also form the basis of resuming full
793   dumps.  Only one partial is kept, and it is removed as soon
794   as a successful full (or a new partial) is done.
795
796 * Added support for resuming a full dump for rsync.  The partial
797   full is kept, and to resume an incremental is done against the
798   partial, and a full is done for the rest.
799
800 * Added support for Rsync checksum caching.  Rsync checksum are
801   appended to the compressed pool files.  This means that block
802   and file checksums do not need to be recomputed on the server
803   when using rsync.  Requires a patch to rsync to support fixed
804   checksum seeds.  This patch is included in the cygwin-rsyncd
805   release on http://backuppc.sourceforge.net.
806
807 * Major addition of Archive feature from Josh Marshall.  Special
808   clients can be configured to be archive targets (eg: tape drives,
809   CD-R).  Any subset of the backup clients can be selected and tar
810   archives are created, optionally compressed and split and written
811   to the output device.  Logs are maintained and are browsable.
812
813 * Major changes from Ryan Kucera to add style sheets to the CGI
814   interface, allowing easy customization.  Added new icons and
815   BackupPC logo.  Numerous navigation improvements.
816
817 * Added directory history display to BackupPC_Admin, allowing the
818   user to quickly see which files changed between backups on a
819   per-directory basis.
820
821 * Added exponential expiry option for full dumps.  This allows you
822   to specify
823   
824    - how many fulls to keep at intervals of $Conf{FullPeriod}, followed by
825    - how many fulls to keep at intervals of 2 * $Conf{FullPeriod},
826    - how many fulls to keep at intervals of 4 * $Conf{FullPeriod},
827    - how many fulls to keep at intervals of 8 * $Conf{FullPeriod},
828    - how many fulls to keep at intervals of 16 * $Conf{FullPeriod},
829
830   and so on.  This allows you, for example, to keep 4 weekly fulls,
831   followed by 6 fulls every 4 weeks (approx 1 month) and 2 fulls at
832   16 weeks, for roughly 1 year of history.  This works by deleting
833   every other full as each expiry boundary is crossed.  Suggested
834   by David Cramblett.
835
836 * Added Italian language translation it.pm from Lorenzo Cappelletti.
837
838 * Major updates to language files for new features and tags changes.
839   Updated makeDist to do pedantic consistency checking of language
840   files.
841
842 * Addition of administration options from Paul Lukins.  Initial
843   page allows server to be started/stopped/reloaded.  This still
844   needs some i18n work.  Currently the server start/stop is
845   commented out.
846
847 * Split BackupPC_Admin into a set of modules, one for each major action.
848   Each action is now a seperate module in lib/BackupPC/CGI.
849
850 * Allow the blackout period begin/end to span midnight.  Adapted
851   from patch submitted by David Smith.
852
853 * Allow multiple blackout periods, with new config variable
854   $Conf{BlackoutPeriods} that replaces the old variables
855   $Conf{BlackoutHourBegin}, $Conf{BlackoutHourEnd}, and
856   $Conf{BlackoutWeekDays}.  Based on patch submitted by
857   Lorenzo Cappelletti.
858
859 * Disabled alarms after forks to avoid timeouts in children that
860   do not reset their alarm.  Prompted by ideas from James Leu.
861
862 * Added options for block size, buffer size and share wild-card to
863   BackupPC_tarCreate.  Also added negative backup number options
864   that are relative to the last (so -1 is the last), suggested by
865   William McKee and Carl Soderstrom.
866
867 * The "Wrong user" message in BackupPC::Lib now goes to stderr, so that
868   the user is more likely to see the error with BackupPC_tarCreate.
869   Reported by Paul Fox.
870
871 * Add creation of per-PC directory in BackupPC/CGI/Restore.pm in
872   case it doesn't already exist.
873
874 * Added -q -x to all ssh commands in conf/config.pl.  Suggested by
875   SI Reasoning and Niranjan Ghate.
876
877 * Changed restore code so that option #1 (direct restore) can be
878   disabled if the restore command is undefined.  Disabling direct
879   restore is necessary if the share is read-only.  Suggested by
880   Rich B from SAIC.
881
882 * Changed regexp in lib/BackupPC/Smb.pm to allow numbers with both
883   a decimal point or comma for international versions of Samba.
884   Patch submitted by Frank Gard.
885
886 * Browsing and directory history now sort the files in a
887   case-insensitive manner.
888
889 * Changed exec() syntax to allow executing commands whose path
890   contains spaces.
891
892 * BackupPC_dump no longer removes backups if $Conf{FullKeepCnt}
893   is zero or undefined.  The protects the existing backups in the
894   case of a bad config.pl file.  Suggested by Christian Warden.
895
896 * Swapped the Server and Hosts sections on the Nav bar.  Moved the
897   host search text box to the top of the hosts section.  This was
898   done to move the variable-length part of the Nav bar (when all
899   hosts are displayed) to the bottom.
900
901 * Fixed a bug in tar restore related to how the common prefix path is
902   removed.  Now ensure that the common path is at a directory boundary.
903   Reported by Patrick Neuner.
904
905 * Added --chuid ${USER} to init.d/src/gentoo-backuppc.  Suggested by
906   SI Reasoning, Pascal Pochol, Michael Evanoff and others.
907
908 * Added Suse notes to init.d/README from Bruno Vernay.
909
910 * Added Apache 2 documentation fix from Michael Tuzi.
911
912 #------------------------------------------------------------------------
913 # Version 2.0.2, 6 Oct 2003
914 #------------------------------------------------------------------------
915
916 * Fixed stupid last-minute change in octal size conversion in
917   Backup_tarExtract.
918
919 #-----------------------------------------------------------------------
920 # Version 2.0.1, 5 Oct 2003
921 #------------------------------------------------------------------------
922
923 * Fixed handling of >= 8GB files in BackupPC_tarExtract and >= 4GB
924   files in BackupPC_tarCreate.
925
926 * Removed smbclient size repair in BackupPC_tarExtract for files
927   between 2GB and 4GB.  This means that BackupPC_tarExtract 2.0.1
928   doesn't behave the same as 2.0.0 for file sizes between 2GB and 4GB
929   extacted using smbclient 2.2.x.  If you have problems backing up
930   files whose size is between 2GB and 4GB using smbclient 2.2.x
931   you should upgrade smbclient to 3.0, since it now generates
932   correct file sizes.
933
934 * Replace PingClientPath with PingPath in configure.pl.
935
936 * Removed -T (taint mode) on binaries installed in configure.pl.
937
938 * Added support for smbclient from samba version 3.0.0.
939
940 * Fixed $Conf{HardLinkMax} limit check in BackupPC::Lib; reported
941   by Ross Skaliotis.
942
943 * In BackupPC_Admin, default REMOTE_USER to $Conf{BackupPCUser}
944   if it is not defined.  This allows the CGI interface to work
945   when AdminUsers = '*'.  Reported by Quentin Arce.
946
947 * For SMB, code that detected files with a read-locked region (eg:
948   outlook .pst files), removed them and then tried to link with an
949   earlier version was broken.  This code missed a step of mangling
950   the file names.  This is now fixed.  Reported by Pierre Bourgin.
951
952 * A backup of a share that has zero files is now considered
953   fatal. This is used to catch miscellaneous Xfer errors that
954   result in no files being backed up.  A new config parameter
955   $Conf{BackupZeroFilesIsFatal} (defaults to 1) and can be set to
956   zero to turn off this check.  Suggested by Guillaume Filion.
957   Additional change: this check only applies to a full dump.
958
959 * SMB: now detect NT_STATUS_ACCESS_DENIED on entire share or BackupFilesOnly
960   (also ERRDOS - ERRnoaccess (Access denied.) for older versions of
961   smbclient.)  Suggested by Guillaume Filion.
962
963 * SMB: now detects "tree connect failed: NT_STATUS_BAD_NETWORK_NAME" and
964   the dump is considered failed.
965
966 * Rsync: Previously BackupFilesOnly = '/' did --include '/' --exclude '/*',
967   which just included the '/' directory and nothing below.  Now it
968   does just --include '/', which should include everything.
969   Reported by denon.
970
971 * Add hostError to DumpPostUserCmd variable substitutions for both dump
972   and restore.
973
974 * Verbose output in Lib.pm goes to STDERR, not STDOUT.  This now
975   makes BackupPC_dump -v work better.
976
977 * Don't allow browsing with ".." in directory in case a user tries
978   to trick BackupPC_Admin into displaying directories outside where
979   they are allowed.
980
981 * Required File::RsyncP version is now 0.44, since File::RsyncP 0.44
982   fixes large file (>2GB) bugs.  Large file bugs reported by Steve
983   Waltner.
984
985 #------------------------------------------------------------------------
986 # Version 2.0.0, 14 Jun 2003
987 #------------------------------------------------------------------------
988
989 * Minor tweaks to disable utf8 on utf8-capable machines (eg: RH8+).
990   Added "no utf8" to all programs, and added binmode() to relevant
991   file handles.
992
993 #------------------------------------------------------------------------
994 # Version 2.0.0beta3, 1 Jun 2003
995 #------------------------------------------------------------------------
996
997 * Several improvements to restore: cancel now reports the correct
998   message and cleans up correctly.
999
1000 * Rsync with whitespace and wildcard excludes fixed by replacing
1001   argList with argList+ in config.pl plus a fix to Lib.pm for
1002   shell escaping array arguments.
1003
1004 * Fixed rsync restore for character and block special devices
1005   (major and minor device numbers weren't correctly restored).
1006
1007 * Fixed typo in bin/BackupPC_restore (XferLOG -> RestoreLOG).
1008
1009 * (Re)-fixed "Bad command" in log file when restore via tar or zip
1010   file download is done.
1011
1012 * Added untaint to exec in Lib.pm to avoid tainted errors.
1013
1014 * Applied additional tweak to hilight patch from Tim Demarest.
1015
1016 * $Conf{CgiAdminUsers} = '*' now allows privileged even with REMOTE_USER
1017   not set.
1018
1019 * Don't display RsyncdPasswd when displaying config.pl files.
1020
1021 * Replace pipe with socketpair in bin/BackupPC_dump and bin/BackupPC_restore,
1022   which increases typical buffering from 4K to 16K-64K.  This improves the
1023   performance.
1024
1025 * Add check on $ENV{LANG} setting do configure.pl: if LANG includes utf
1026   then a warning is printed.
1027
1028 #------------------------------------------------------------------------
1029 # Version 2.0.0beta2, 11 May 2003
1030 #------------------------------------------------------------------------
1031
1032 * Added German translation, provided by Manfred Herrmann.
1033
1034 * Fixed large-file problem with rsync, reported by Manfred Herrmann.
1035
1036 * Fixed zip and tar file download from CGI under mod_perl.  Reported
1037   by Pierre Bourgin and Paul Lukins.
1038
1039 * Fixed directory browsing and top-level directory browsing in 2.0.0beta0.
1040   Reported by several users.
1041
1042 * Added -v option to BackupPC_dump for verbose output (useful when
1043   you run the command manually).  Added messages for all exits.
1044
1045 * If nmblookup returns multiple IP addresses, NetBiosHostIPFind()
1046   now returns the first IP address that matches the subnet mask.
1047   Suggested by Tim Demarest.
1048
1049 * Fixed BackupPC::View so the top-level directory is handled correctly.
1050   This allows the top-level share/directory to be restored via the
1051   CGI interface.  Reported by several users.
1052
1053 * Fixed RsyncFileIO failures on certain large files by replacing seek()
1054   with sysseek().  Reported by Manfred Herrmann.
1055
1056 * Added configurable highlighting of PC status in the CGI summary
1057   screen; submitted by Tim Demarest.
1058
1059 * Fixed command queue CGI display; submitted by Tim Demarest.
1060
1061 * BackupPC_trashClean now logs an error if it can't remove all the
1062   trash and then goes back to sleep, rather than continually trying.
1063
1064 * Moved correct user (uid) check into BackupPC::Lib so that all
1065   applications do a user check if $Cong{BackupPCUserVerify} is
1066   set.  The avoids the risk of manually running BackupPC_dump as
1067   the wrong user.
1068
1069 * Loss of blackout now applies to "host not found" as well as no ping.
1070   Reported by Dale Renton.
1071
1072 * "Host not found" is now treated in a similar manner to "no ping".
1073
1074 * Added suse-linux init.d script from Leon Letto.
1075
1076 * Added Gentoo linux init.d script from Tim Demarest.
1077
1078 * Applied additional i18n strings from GFK and the translation team.
1079
1080 * Fixed option parsing so that getopts errors are reported and we exit.
1081
1082 * Changed reporting of Xfer PIDs so that rsync cancel works correctly.
1083
1084 #------------------------------------------------------------------------
1085 # Version 2.0.0beta1, 30 Mar 2003
1086 #------------------------------------------------------------------------
1087
1088 * Added Spanish translation es.pm from Javier Gonzalez.
1089
1090 * Fixed CGI browse navigation bug that causes BackupPC_Admin to wedge
1091   when directories were selected in a certain order.
1092
1093 * Fixed BackupPC::PoolWrite so that it can recover when the initial
1094   file size is wrong.  This is needed since rsync could write a file
1095   whose size is different from the initial size returned in the
1096   file list when that file is updated while rsync is running.
1097
1098 * Added binmode(STDIN) to BackupPC_tarExtract, suggested by Pat LoPresti
1099   to fix a problem a RedHat8 with perl 5.8.0.  It's unclear why this
1100   helps, but it should be benign.  See:
1101     http://sourceforge.net/mailarchive/forum.php?thread_id=1853018&forum_id=503
1102
1103 #------------------------------------------------------------------------
1104 # Version 2.0.0beta0, 23 Feb 2003
1105 #------------------------------------------------------------------------
1106
1107 * Support for rsync and rsyncd backup and restore.  Changes to
1108   BackupPC_dump, BackupPC_restore, and new modules BackupPC::Xfer::Rsync
1109   and BackupPC::Xfer::RsyncFileIO.
1110
1111 * Added internationalization (i18n) code from Xavier Nicollet,
1112   with additions from Guillaume Filion.  Voila!  BackupPC_Admin
1113   now supports English and French, and adding more languages is
1114   now easy.  New config paramater $Conf{Language} sets the language.
1115
1116 * Added optional user-defined pre/post dump/restore commands, allowing
1117   things like database shutdown/startup for dumps.
1118
1119 * Changed the way hosts are found.
1120
1121 * Added $Conf{ClientNameAlias}, which allows the name of the physical
1122   client machine to be set.  This allows several different backup
1123   "hosts" to all refer to the same physical machine, which is
1124   convenient if several different types of data need to be backed
1125   up, or if different parameters are needed for different parts of
1126   the host.
1127
1128 * Replaced $Conf{PingArgs} with $Conf{PingCmd}, added $Conf{DfCmd},
1129   $Conf{NmbLookupCmd} allowing all these commands to be fully
1130   configured.  Also, all commands can also now be fragments of
1131   perl code.
1132
1133 * Moved all smbclient commands into the config.pl file so the specific
1134   arguments can be customized.  New config parameters are
1135   $Conf{SmbClientFullCmd}, $Conf{SmbClientIncrCmd} and
1136   $Conf{SmbClientRestoreCmd}.
1137
1138 * Added new BackupPC::View module that creates views of backups
1139   (handling merging etc).  Updated BackupPC_Admin, BackupPC_zipCreate
1140   and BackupPC_tarCreate to use BackupPC::View.  This removes lots
1141   of merging and mangling code from the higher-level code.
1142
1143 * Added code from Toby Johnson that allows additional users to be
1144   specified in the hosts file; these users can also view/start/stop
1145   and restore backups for that host.  Also added a new config
1146   setting $Conf{CgiNavBarAdminAllHosts} that allows all hosts to
1147   be listed in the left nav bar for admins.
1148
1149 * Added $Conf{HardLinkMax} (default 31999) which sets the limit on
1150   the maximum number of hardlinks per file in the pool.  If a file
1151   ever gets to this number of links a new pool file is created to
1152   handle additional links.
1153
1154 * Added $Conf{PerlModuleLoad}, which allows optional additional perl
1155   modules to be loaded.
1156
1157 * Added $Conf{EMailUserDestDomain} and other EMail config settings to
1158   allow language-specific default messages to be overridden.
1159
1160 * Added BPC_FTYPE_DELETED to lib/BackupPC/Attrib.pm, allowing deleted
1161   files to be represented in the attrib file correctly.
1162
1163 * Added support for environment variable BPC_SMB_PASSWD, which is the
1164   client's smb password.  This overrides the old environment variable
1165   PASSWD.
1166
1167 * Added taint cleanup for perl5.8 to lib/BackupPC/Lib.pm.
1168
1169 * Changed $tar_unpack_header format in BackupPC_tarExtract to correctly
1170   handle files with trailing spaces.
1171
1172 * Added catching of SIG_PIPE to BackupPC_dump, and changed catch_signal
1173   to ignore multiple signals of the same type.
1174
1175 * Added reporting of the largest number of hardlinks in the pool to the
1176   log file.
1177
1178 * Adding reporting of syntax errors in the per-PC config.pl file.
1179
1180 * Updated BackupPC_sendEmail to handle language-specific email messages.
1181
1182 * Allow client (host) names to contain spaces.  Spaces in host names
1183   need to be escaped via "\" in the hosts file.  The user of spaces in
1184   host names is discouraged, but they should work.  One feature that
1185   doesn't work with host names that contain spaces is the highlighting
1186   of that name in the log file display in the CGI interface.  There are
1187   no plans to fix this.
1188
1189 * Renamed $Conf{SmbClientTimeout} to $Conf{ClientTimeout}.
1190
1191 * Fixed all open() calls to use 3 argument form to fix handling of file
1192   names with trailing whitespace.  Also fixed CGI interface so these
1193   file names are displayed correctly.
1194
1195 * Fixed new 2.0.0 CGI navigation bug that causes the top-level directory
1196   to have a URL "&share=//boot&dir=" instead of "&share=/boot&dir=/".
1197   Reported by Pascal Schelcher.  Fixed similar problem reported by
1198   Doug Lytle.
1199
1200 * Added "PerlTaintCheck On" to the mod_perl section in the docs,
1201   suggested by Tim Demarest.
1202
1203 #------------------------------------------------------------------------
1204 # Version 1.5.0, 2 Aug 2002
1205 #------------------------------------------------------------------------
1206
1207 * Changed conf/config.pl so that $Conf{TarIncrArgs} uses the --newer
1208   option instead of --newer-mtime.  Also removed --atime-preserve from
1209   $Conf{TarClientCmd}.  This makes the default settings work better
1210   with tripwire.
1211
1212 * Fixed configure.pl so it correctly detects a running BackupPC <= v1.4.0
1213   so it can correctly warn the user to stop it before upgrading.  Reported
1214   by David Holland.
1215
1216 * Added missing ";" to entity escape in EscapeHTML in BackupPC_Admin.
1217   Reported by Guillaume Filion.
1218
1219 * Added LDAP setup to documentation from David Holland.
1220
1221 * Tar.pm now adds a "." to file paths that start with "/", so that all
1222   tar paths are relative.  From Ludovic Drolez.
1223
1224 #------------------------------------------------------------------------
1225 # Version 1.5.0beta0, 30 Jun 2002
1226 #------------------------------------------------------------------------
1227
1228 * A full set of restore options is now supported, including direct
1229   restore via smbclient or tar or downloading a zip or tar file.
1230
1231 * Major additions to CGI script to support better directory navigation,
1232   restore features and mod_perl.  Also, file downloads from the CGI
1233   interface now correctly preserve the file name and provide the
1234   correct Content-Type for the most common types of files.  Improved
1235   directory navigation was contributed by Ryan Kucera.
1236
1237 * New script BackupPC_zipCreate (contributed by Guillaume Filion) is the
1238   zip analog of BackupPC_tarCreate.  BackupPC_zipCreate can be used to
1239   create a zip archive of any portion of a backup.
1240
1241 * Substantial additions to BackupPC_tarCreate to support restore,
1242   including modifying path names, handling hardlinks, fixing
1243   support of old backups without attributes (pre-v1.4.0).  Plus
1244   BackupPC_tarCreate is now an offical part of the release.
1245   (Lack of support for hardlinks was reported by John Stanley.)
1246
1247 * BackupPC_tarExtract now supports hardlinks and fixed pooling of
1248   attribute files.
1249
1250 * A unix domain socket is now used for communication between the CGI
1251   interface and BackupPC.  The original TCP socket is optional.  Sockets
1252   are correctly re-initialized if config.pl is updated with new socket
1253   settings.
1254
1255 * For improved security messages over the unix or TCP socket are protected
1256   via an MD5 digest based on a shared secret, a sequence number, a time
1257   stamp and a unique per-connection number.
1258
1259 * Additions to configure.pl to support install of directory navigation
1260   images.
1261
1262 * Fixed case where $Conf{BackupFilesOnly} or $Conf{BackupFilesExclude}
1263   were set to a single string or list (in v1.4.0 only the case of
1264   hash worked correctly).  Reported by Phillip Bertolus.
1265
1266 * Fixed case of $Conf{BackoutGoodCnt} == 0.  This setting now makes the
1267   client always subject to blackout, matching the comments in config.pl.
1268   Also fixed handling of $Conf{BackoutGoodCnt} < 0 in the CGI script
1269   reported by Pascal Schelcher.
1270
1271 * Fixed byte and file totals for tar backups, reported by several users.
1272
1273 * Fixed --newer-mtime date/timestamp format to make it ISO 8601 compliant,
1274   suggested by Erminio Baranzini.
1275
1276 * Fixed handling of $Conf{BackupFilesOnly} in BackupPC::Xfer::Tar.pm, as
1277   well as shell escaping of tar arguments.
1278
1279 * Fixed entity encoding of 8-bit characters in the CGI interface.
1280
1281 * Added optional CGI headers in $Conf{CgiHeaders} that by default
1282   is set to a no-cache pragma.  Suggested by Benno Zuure.
1283
1284 #------------------------------------------------------------------------
1285 # Version 1.4.0, 16 Mar 2002
1286 #------------------------------------------------------------------------
1287
1288 * BackupPC now supports tar (in addition to smb) for extracting host    
1289   data.  This is the most convenient option for linux/unix hosts.
1290   Tar can be configured to run over ssh, rsh or to backup a local
1291   nfs mount from the host.
1292
1293 * Support for special files, including symbolic links, fifo, character
1294   and block device files has been added, so that all native linux/unix
1295   file types can be correctly backed up when using tar transport.
1296   Special files are all stored as regular files and the type attributes
1297   are used to remember the original file type.
1298
1299 * All unix file attributes are now saved (and pooled when possible).
1300   This includes user and group ownership, permissions, and modification
1301   time.  Smbclient also does a reasonable job of emulating unix 
1302   permissions (such as mtime), and these attributes get saved too.
1303
1304 * The new default is to not fill incremental dumps.  configure.pl
1305   automatically sets $Conf{IncrFill} to 0.  The default was 1
1306   (incrementals were filled with hardlinks).  Since the CGI
1307   script does filling at browsing time, there is no need to
1308   fill incremental dumps.
1309
1310 * Backup file names are now stored in "mangled" form. Each node of a
1311   path is preceded by "f", and special characters (\n, \r, % and /) are
1312   URI-encoded as "%xx", where xx is the ascii character's hex value. So
1313   c:/craig/example.txt is now stored as fc/fcraig/fexample.txt. This
1314   was done mainly so meta-data could be stored alongside the backup
1315   files without name collisions.  In particular, the attributes for the
1316   files in a directory are stored in a file called "attrib", and
1317   mangling avoids file name collisions (I discarded the idea of having
1318   a duplicate directory tree for every backup just to store the
1319   attributes). Other meta-data (eg: rsync checksums) could be stored in
1320   file names preceded by, eg, "c".  There are two other benefits to
1321   mangling: the share name might contain "/" (eg: "/home/craig" for tar
1322   transport), and I wanted that represented as a single level in the
1323   storage tree.  Secondly, as files are written to NewFileList for later
1324   processing by BackupPC_link, embedded newlines in the file's path
1325   will cause problems which are avoided by mangling.
1326
1327   The CGI script undoes the mangling, so it is invisibe to the user.
1328   Of course, old (unmangled) backups are still supported by the CGI
1329   interface.
1330
1331 * Various changes to the CGI interface, BackupPC_Admin:
1332
1333   + Added button that allows users to manually start a full dump in
1334     addition to the existing incremental dump.
1335
1336   + Added display of file attributes when browsing backups.
1337
1338   + Added an optional holdoff time specified by the user when canceling
1339     a backup. BackupPC will not attempt any new backups for at least the
1340     specified time. This holdoff time can be changed whether or not a
1341     backup is running.
1342
1343   + Added supports for file mangling, and correct merging of unfilled
1344     backups from mangled or unmangled (and compressed or uncompressed)
1345     fulls when browsing or restoring.
1346
1347   + Only displays a "Start Incr Backup" button if there are already some
1348     backups.
1349
1350   + For DHCP hosts, when a user tries to manually start a backup, add
1351     a check for the netbios name of both the host the request came
1352     from (REMOTE_ADDR) and the last known DHCP address for that host
1353     to see if either address matches the host. If not, an error
1354     message is display. The previous behavior was that only requests
1355     from the client itself succeeded, and requests from other machines
1356     quietly failed.
1357
1358 * Changed the version numbering to X.Y.Z, instead of X.0Y. This release
1359   is 1.4.0. The first digit is for major new releases, the middle digit
1360   is for significant feature releases and improvements, and the last
1361   digit is for bug fixes. You should think of the old 1.00, 1.01, 1.02
1362   and 1.03 as 1.0.0, ..., 1.3.0.
1363
1364 * BackupPC and the CGI script BackupPC_Admin now check that the effective
1365   user id is correct to avoid accidentally launching BackupPC as the
1366   wrong user or detecting CGI configuration problems.  This behavior
1367   can be turned off using the $Conf{BackupPCUserVerify} option.
1368
1369 * In numerous places changed "Smb" to "Xfer" (eg: log file names) to
1370   support generic names for both smb and tar transport methods.  The
1371   CGI script checks for old names for backward compatibility.
1372
1373 * Major changed to Backup_dump to support new tar transport.  All transport
1374   specific code moved into BackupPC::Xfer::Smb and BackupPC::Xfer::Tar
1375   objects.
1376
1377 * Added workaround for a bug in Samba's smbclient for files between 2GB
1378   and 4GB.  The file size in the tar header is incorrect.  This allows
1379   files up to 4GB to work with smbclient, rather than 2GB.  To support
1380   files larger than 2GB you must make sure perl is compiled with the
1381   uselargefiles option (use "perl -V | egrep largefiles" to check) and
1382   the pool directory must be on a file system that supports large files.
1383
1384 * Moved the pool writing code into a module BackupPC::PoolWrite.  This
1385   allows the clever file pool checking (digest, uncompressing, comparing
1386   etc with minimum disk IO) to be used easily in multiple places (eg: it
1387   is now used for writing attribute files so they can be pooled).
1388
1389 * Changed MD5 to Digest::MD5 to avoid use of the depreceated MD5 module.
1390
1391 * Shortened default $Conf{MyPath} so that perl's taint mode is more likely
1392   to be happy.  The old $Conf{MyPath} contained /usr/local/bin, which
1393   on one user's machine was world writable and perl -T correctly
1394   complained about it.
1395
1396 * Fixed ping command options in Lib.pm so that it works on OpenBSD.
1397   Thanks to Kyle Amon for sending the fix.  Decided to move the
1398   ping options from Lib.pm into config.pl (as $Conf{PingArgs}) and
1399   now configure.pl tries to come up with a sensible default based on
1400   the OS.
1401
1402 * Fixed argument checking in BackupPC_tarExtract to allow '$' in the
1403   share name (eg: C$).  Thanks to Jules Agee for this fix.  Also
1404   changed the default config.pl so that single quotes are used
1405   everywhere so that people don't get tripped up putting '$' inside
1406   double-quoted strings.
1407
1408 #------------------------------------------------------------------------
1409 # Version 1.03, 9 Dec 2001
1410 #------------------------------------------------------------------------
1411
1412 * BackupPC now has full support for compression.  There are now two
1413   pool areas, the original pool for uncompressed files, and cpool for
1414   compressed files. The compression is done by Compress::Zlib.
1415   Compression reduces the pool disk usage by around 40%, although your
1416   mileage may vary.  Compression is optional and can also be specified on
1417   a per-PC basis (although this will cost more pool storage since many
1418   backup files will have to be stored in both compressed and
1419   uncompressed forms.
1420
1421 * A new script, BackupPC_compressPool, can be run to compress the entire
1422   pool.  This is used once to migrate all the pool data from uncompressed
1423   to compressed on existing installations.  Read the documentation
1424   (Installing BackupPC/Compressing an existing pool) before running
1425   BackupPC_compressPool!
1426
1427   Alternatively, compression can simply be turned on and all new backups
1428   will be compressed. Both old (uncompressed) and new (compressed)
1429   backups can be browsed and viewed. Eventually, the old backups will
1430   expire and all the pool data will be compressed.  However, until the
1431   old backups expire, this approach could require 60% or more additional
1432   pool storage space to store both uncompressed and compressed versions
1433   of the backup files.
1434
1435 * Significant improvements to the cgi interface, BackupPC_Admin:
1436
1437     - much better layout navigation
1438     - handles compressed backup files and compressed log files
1439     - handles unfilled incremental dumps
1440     - better backup directory browsing navigation
1441     - reports compression statistics
1442     - $Conf{CgiDateFormatMMDD} allows you to set date format (MM/DD or DD/MM)
1443     - Additional customization with $Conf{CgiHeaderFontType},
1444       $Conf{CgiHeaderFontSize}, $Conf{CgiNavBarBgColor}, and
1445       $Conf{CgiHeaderBgColor}.
1446
1447 * Eliminated BackupPC_queueAll.  BackupPC directly reads the hosts
1448   file and queues the PCs itself.  Like config.pl, BackupPC will
1449   re-read the hosts file on each wakeup if its modification time
1450   changes, or upon a SIGHUP.  This also makes for better behavior
1451   when adding a host: if you add hosts, simply send a SIGHUP to
1452   BackupPC or wait for the next wakeup.
1453
1454 * BackupPC_dump now compresses the SmbLOG file if compression is enabled.
1455
1456 * BackupPC_dump keeps track of compressed file sizes so that compression
1457   statistics can be reported by the cgi interface.
1458
1459 * Aging of old log files now handles compressed log files (.z extension).
1460
1461 * Added configuration option $Conf{IncrFill} to specify whether
1462   incremental dumps should be filled in.  Old behavior was that
1463   filling was on.  Now it's optional.  See config.pl for more
1464   details.
1465
1466 * BackupPC_nightly now cleans and generates statistics for both
1467   the uncompressed pool and compressed pool (cpool).
1468
1469 * Added new utility script BackupPC_zcat that can be used to
1470   uncompresses BackupPC files.
1471
1472 * configure.pl offers various options related to compression,
1473   depending upon whether this is a new install or upgrade,
1474   and whether or not Compress::Zlib is installed.
1475
1476 * configure.pl now makes a backup copy of config.pl before
1477   config.pl is updated.
1478
1479 * added three new fields to the backups file to handle optional
1480   filling and compression stats.
1481
1482 * Added -e option to BackupPC_dump.  BackupPC now invokes BackupPC_dump -e
1483   on each dhcp host once each night to verify that very old backups are
1484   expired.  This ensures that very old backups are expired even if
1485   the dhcp host has not been on the network for a long time.
1486
1487 * fixed bug in BackupPC::FileZIO.pm that required Compress::Zlib,
1488   even if compression was off.  Thanks to Steve Holmes for reporting
1489   this.
1490
1491 * fixed bug that caused a BackupPC queue to get blocked when a backup
1492   cancel attempt was made during the BackupPC_link phase.
1493
1494 #------------------------------------------------------------------------
1495 # Version 1.02, 28 Oct 2001.
1496 #------------------------------------------------------------------------
1497
1498 * Added new script BackupPC_tarExtract to extract the smbclient tar
1499   archive. This reduces disk writes by perhaps 90-95% and disk reads by
1500   50%. Previously, tar was used to extract and write everything to disk.
1501   Then BackupPC_dump would read enough of each file to compute the MD5
1502   digest, and then compare the full file with candidate pool files.  So
1503   for each 1MB file that matches a single file in the pool, there would
1504   be 1MB of disk writes and 2MB of disk reads (to compare two 1MB files).
1505
1506   BackupPC_tarExtract instead extracts the archive using a 1MB memory
1507   buffer.  This allows the MD5 digest to be computed without touching the
1508   disk.  Next, any potential pool file compares are done by comparing the
1509   pool file against the incoming tar data in memory, which only requires
1510   the pool file to be read.  So for each 1MB file that matches a single
1511   file in the pool, there are now no disk writes, and only 1MB of reads.
1512   BackupPC_tarExtract handles arbitrary size files and repeated
1513   potential pool matches.  If the incoming file doesn't match the pool
1514   then it is written to disk (once the pool is mature this happens maybe
1515   5-10% of the time).
1516
1517 * Substantial changes to BackupPC_dump:
1518
1519     + BackupPC_tarExtract is now used in place of tar.
1520
1521     + BackupPC_dump now reads the output from both smbclient and
1522       BackupPC_tarExtract and merges them into SmbLOG.
1523
1524     + Named pipes are no longer used to connect smbclient to tar
1525       (now BackupPC_tarExtract).  Regular pipes are used instead.
1526       This avoids the need to system mknod or mkfifo.
1527
1528     + Locked files on the client that can't be read by smbclient
1529       previously were filled with 0x0 bytes by smbclient, meaning
1530       tar extracted a useless file filled with 0x0 bytes.  Now,
1531       BackupPC_dump watches the output of smbclient and removes
1532       any files that smbclient couldn't read.  This avoids storing
1533       useless files.  It tries to replace such files with a hard link
1534       to a previous dump.  These actions appear in the log file.
1535
1536 * added new module lib/BackupPC/FileZIO.pm. This handles pool file
1537   I/O and is used by BackupPC_tarExtract.  BackupPC::FileIO supports
1538   reading and writing compressed and regular files and provides all the
1539   hooks for compression support in BackupPC (should be supported in next
1540   version). BackupPC::FileIO also does efficient writing of files that
1541   contain leading 0x0 bytes (by seeking past the 0x0 bytes). This is
1542   helpful when smbclient reads a locked file, and it fills the tar
1543   output with a file of the correct size but all 0x0.  Such files will be
1544   later removed by BackupPC_dump.  But in the meantime, BackupPC::FileIO
1545   writes such files efficiently (as sparse files), meaning just a few
1546   blocks of disk space will be needed even if the file is large.
1547
1548 * alive/dead counting for blackout now works correctly for DHCP hosts.
1549
1550 * BackupPC resets activeJob on startup, to fix bug when BackupPC was
1551   killed and restarted with backups running.
1552
1553 * added extra non blocking select() in BackupPC to make sure the socket
1554   reads don't block.
1555
1556 * BackupPC avoids queuing multiple BackupPC_queueAll's on the CmdQueue.
1557
1558 * Updated BackupPC_sendEmail to correctly parse the locked file
1559   error from 2.2.1a smbclient, so that missing Outlook file emails
1560   can be correctly sent.
1561
1562 * Changed HostInfoRead() in lib/BackupPC/Lib.pm to lowercase the
1563   hostname read from the hosts file.
1564
1565 * BackupPC_Admin provides general summary when the host name is empty.
1566
1567 * configure.pl (and BackupPC) now requires perl 5.6.0 or later.
1568
1569 * configure.pl complains if BackupPC is already running, reminding you
1570   to stop it before upgrading.
1571
1572 * updated documentation, and fixed auto-insertion of config.pl into
1573   BackupPC.pod (previously the last config parameter was left out of
1574   BackupPC.pod).
1575
1576 #------------------------------------------------------------------------
1577 # Version 1.01, 30 Sep 2001
1578 #------------------------------------------------------------------------
1579
1580 * Documentation cleanup in README, doc/BackupPC.pod, conf/config.pl.
1581
1582 * BackupPC_sendMail now reads the optional per-PC config file, allowing
1583   email configuration parameters to be set on a per-PC basis.
1584
1585 * Removed the unused 4096-length MD5 digest code in lib/BackupPC/Lib.pm.
1586
1587 #------------------------------------------------------------------------
1588 # Version 1.00, 21 Sep 2001
1589 #------------------------------------------------------------------------
1590
1591 * Initial release of BackupPC on sourceforge.net.