2.0.1 released with these additional changes since 2.0.1beta1:
[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 * Fixed handling of >= 8GB files in BackupPC_tarExtract and >= 4GB
25   files in BackupPC_tarCreate.
26
27 * Removed smbclient size repair in BackupPC_tarExtract for files
28   between 2GB and 4GB.  This means that BackupPC_tarExtract 2.0.1
29   doesn't behave the same as 2.0.0 for file sizes between 2GB and 4GB
30   extacted using smbclient 2.2.x.  If you have problems backing up
31   files whose size is between 2GB and 4GB using smbclient 2.2.x
32   you should upgrade smbclient to 3.0, since it now generates
33   correct file sizes.
34
35 * Fixed additional print to stdout for BackupPC_dump -v in
36   BackupPC::FileZIO.  Now prints to stderr.
37
38 #------------------------------------------------------------------------
39 # Version 2.0.1beta1, 13 Sep 2003
40 #------------------------------------------------------------------------
41
42 * Fixed handling of $Conf{HardLinkMax} in BackupPC/Lib.pm.  Reported
43   by Ross Skaliotis.
44
45 * Updated BackupPC/Xfer/Smb.pm to handle new messages from
46   smbclient 3.0.0rc2.
47
48 * Fixed $Conf{BackupZeroFilesIsFatal} so that it only applies to full
49   dumps, not incrementals.
50
51 * Replaced typo $Conf{PingClientPath} with $Conf{PingPath} in configure.pl.
52
53 * Removed -T (taint mode) on binaries installed in configure.pl.
54
55 #------------------------------------------------------------------------
56 # Version 2.0.1beta0, July 26th, 2003
57 #------------------------------------------------------------------------
58
59 * In BackupPC_Admin, default REMOTE_USER to $Conf{BackupPCUser}
60   if it is not defined.  This allows the CGI interface to work
61   when AdminUsers = '*'.  Reported by Quentin Arce.
62
63 * For SMB, code that detected files with a read-locked region (eg:
64   outlook .pst files), removed them and then tried to link with an
65   earlier version was broken.  This code missed a step of mangling
66   the file names.  This is now fixed.  Reported by Pierre Bourgin.
67
68 * A backup of a share that has zero files is now considered
69   fatal. This is used to catch miscellaneous Xfer errors that
70   result in no files being backed up.  A new config parameter
71   $Conf{BackupZeroFilesIsFatal} (defaults to 1) and can be set to
72   zero to turn off this check. Suggested by Guillaume Filion.
73
74 * SMB: now detect NT_STATUS_ACCESS_DENIED on entire share or BackupFilesOnly
75   (also ERRDOS - ERRnoaccess (Access denied.) for older versions of
76   smbclient.)  Suggested by Guillaume Filion.
77
78 * SMB: now detects "tree connect failed: NT_STATUS_BAD_NETWORK_NAME" and
79   the dump is considered failed.
80
81 * Rsync: Previously BackupFilesOnly = '/' did --include '/' --exclude '/*',
82   which just included the '/' directory and nothing below.  Now it
83   does just --include '/', which should include everything.
84   Reported by denon.
85
86 * Add hostError to DumpPostUserCmd variable substitutions for both dump
87   and restore.
88
89 * Verbose output in Lib.pm goes to STDERR, not STDOUT.  This now
90   makes BackupPC_dump -v work better.
91
92 * Don't allow browsing with ".." in directory in case a user tries
93   to trick BackupPC_Admin into displaying directories outside where
94   they are allowed.
95
96 * Required File::RsyncP version is now 0.44, since File::RsyncP 0.44
97   fixes large file (>2GB) bugs.  Large file bugs reported by Steve
98   Waltner.
99
100 #------------------------------------------------------------------------
101 # Version 2.0.0, 14 Jun 2003
102 #------------------------------------------------------------------------
103
104 * Minor tweaks to disable utf8 on utf8-capable machines (eg: RH8+).
105   Added "no utf8" to all programs, and added binmode() to relevant
106   file handles.
107
108 #------------------------------------------------------------------------
109 # Version 2.0.0beta3, 1 Jun 2003
110 #------------------------------------------------------------------------
111
112 * Several improvements to restore: cancel now reports the correct
113   message and cleans up correctly.
114
115 * Rsync with whitespace and wildcard excludes fixed by replacing
116   argList with argList+ in config.pl plus a fix to Lib.pm for
117   shell escaping array arguments.
118
119 * Fixed rsync restore for character and block special devices
120   (major and minor device numbers weren't correctly restored).
121
122 * Fixed typo in bin/BackupPC_restore (XferLOG -> RestoreLOG).
123
124 * (Re)-fixed "Bad command" in log file when restore via tar or zip
125   file download is done.
126
127 * Added untaint to exec in Lib.pm to avoid tainted errors.
128
129 * Applied additional tweak to hilight patch from Tim Demarest.
130
131 * $Conf{CgiAdminUsers} = '*' now allows privileged even with REMOTE_USER
132   not set.
133
134 * Don't display RsyncdPasswd when displaying config.pl files.
135
136 * Replace pipe with socketpair in bin/BackupPC_dump and bin/BackupPC_restore,
137   which increases typical buffering from 4K to 16K-64K.  This improves the
138   performance.
139
140 * Add check on $ENV{LANG} setting do configure.pl: if LANG includes utf
141   then a warning is printed.
142
143 #------------------------------------------------------------------------
144 # Version 2.0.0beta2, 11 May 2003
145 #------------------------------------------------------------------------
146
147 * Added German translation, provided by Manfred Herrmann.
148
149 * Fixed large-file problem with rsync, reported by Manfred Herrmann.
150
151 * Fixed zip and tar file download from CGI under mod_perl.  Reported
152   by Pierre Bourgin and Paul Lukins.
153
154 * Fixed directory browsing and top-level directory browsing in 2.0.0beta0.
155   Reported by several users.
156
157 * Added -v option to BackupPC_dump for verbose output (useful when
158   you run the command manually).  Added messages for all exits.
159
160 * If nmblookup returns multiple IP addresses, NetBiosHostIPFind()
161   now returns the first IP address that matches the subnet mask.
162   Suggested by Tim Demarest.
163
164 * Fixed BackupPC::View so the top-level directory is handled correctly.
165   This allows the top-level share/directory to be restored via the
166   CGI interface.  Reported by several users.
167
168 * Fixed RsyncFileIO failures on certain large files by replacing seek()
169   with sysseek().  Reported by Manfred Herrmann.
170
171 * Added configurable highlighting of PC status in the CGI summary
172   screen; submitted by Tim Demarest.
173
174 * Fixed command queue CGI display; submitted by Tim Demarest.
175
176 * BackupPC_trashClean now logs an error if it can't remove all the
177   trash and then goes back to sleep, rather than continually trying.
178
179 * Moved correct user (uid) check into BackupPC::Lib so that all
180   applications do a user check if $Cong{BackupPCUserVerify} is
181   set.  The avoids the risk of manually running BackupPC_dump as
182   the wrong user.
183
184 * Loss of blackout now applies to "host not found" as well as no ping.
185   Reported by Dale Renton.
186
187 * "Host not found" is now treated in a similar manner to "no ping".
188
189 * Added suse-linux init.d script from Leon Letto.
190
191 * Added Gentoo linux init.d script from Tim Demarest.
192
193 * Applied additional i18n strings from GFK and the translation team.
194
195 * Fixed option parsing so that getopts errors are reported and we exit.
196
197 * Changed reporting of Xfer PIDs so that rsync cancel works correctly.
198
199 #------------------------------------------------------------------------
200 # Version 2.0.0beta1, 30 Mar 2003
201 #------------------------------------------------------------------------
202
203 * Added Spanish translation es.pm from Javier Gonzalez.
204
205 * Fixed CGI browse navigation bug that causes BackupPC_Admin to wedge
206   when directories were selected in a certain order.
207
208 * Fixed BackupPC::PoolWrite so that it can recover when the initial
209   file size is wrong.  This is needed since rsync could write a file
210   whose size is different from the initial size returned in the
211   file list when that file is updated while rsync is running.
212
213 * Added binmode(STDIN) to BackupPC_tarExtract, suggested by Pat LoPresti
214   to fix a problem a RedHat8 with perl 5.8.0.  It's unclear why this
215   helps, but it should be benign.  See:
216     http://sourceforge.net/mailarchive/forum.php?thread_id=1853018&forum_id=503
217
218 #------------------------------------------------------------------------
219 # Version 2.0.0beta0, 23 Feb 2003
220 #------------------------------------------------------------------------
221
222 * Support for rsync and rsyncd backup and restore.  Changes to
223   BackupPC_dump, BackupPC_restore, and new modules BackupPC::Xfer::Rsync
224   and BackupPC::Xfer::RsyncFileIO.
225
226 * Added internationalization (i18n) code from Xavier Nicollet,
227   with additions from Guillaume Filion.  Voila!  BackupPC_Admin
228   now supports English and French, and adding more languages is
229   now easy.  New config paramater $Conf{Language} sets the language.
230
231 * Added optional user-defined pre/post dump/restore commands, allowing
232   things like database shutdown/startup for dumps.
233
234 * Changed the way hosts are found.
235
236 * Added $Conf{ClientNameAlias}, which allows the name of the physical
237   client machine to be set.  This allows several different backup
238   "hosts" to all refer to the same physical machine, which is
239   convenient if several different types of data need to be backed
240   up, or if different parameters are needed for different parts of
241   the host.
242
243 * Replaced $Conf{PingArgs} with $Conf{PingCmd}, added $Conf{DfCmd},
244   $Conf{NmbLookupCmd} allowing all these commands to be fully
245   configured.  Also, all commands can also now be fragments of
246   perl code.
247
248 * Moved all smbclient commands into the config.pl file so the specific
249   arguments can be customized.  New config parameters are
250   $Conf{SmbClientFullCmd}, $Conf{SmbClientIncrCmd} and
251   $Conf{SmbClientRestoreCmd}.
252
253 * Added new BackupPC::View module that creates views of backups
254   (handling merging etc).  Updated BackupPC_Admin, BackupPC_zipCreate
255   and BackupPC_tarCreate to use BackupPC::View.  This removes lots
256   of merging and mangling code from the higher-level code.
257
258 * Added code from Toby Johnson that allows additional users to be
259   specified in the hosts file; these users can also view/start/stop
260   and restore backups for that host.  Also added a new config
261   setting $Conf{CgiNavBarAdminAllHosts} that allows all hosts to
262   be listed in the left nav bar for admins.
263
264 * Added $Conf{HardLinkMax} (default 31999) which sets the limit on
265   the maximum number of hardlinks per file in the pool.  If a file
266   ever gets to this number of links a new pool file is created to
267   handle additional links.
268
269 * Added $Conf{PerlModuleLoad}, which allows optional additional perl
270   modules to be loaded.
271
272 * Added $Conf{EMailUserDestDomain} and other EMail config settings to
273   allow language-specific default messages to be overridden.
274
275 * Added BPC_FTYPE_DELETED to lib/BackupPC/Attrib.pm, allowing deleted
276   files to be represented in the attrib file correctly.
277
278 * Added support for environment variable BPC_SMB_PASSWD, which is the
279   client's smb password.  This overrides the old environment variable
280   PASSWD.
281
282 * Added taint cleanup for perl5.8 to lib/BackupPC/Lib.pm.
283
284 * Changed $tar_unpack_header format in BackupPC_tarExtract to correctly
285   handle files with trailing spaces.
286
287 * Added catching of SIG_PIPE to BackupPC_dump, and changed catch_signal
288   to ignore multiple signals of the same type.
289
290 * Added reporting of the largest number of hardlinks in the pool to the
291   log file.
292
293 * Adding reporting of syntax errors in the per-PC config.pl file.
294
295 * Updated BackupPC_sendEmail to handle language-specific email messages.
296
297 * Allow client (host) names to contain spaces.  Spaces in host names
298   need to be escaped via "\" in the hosts file.  The user of spaces in
299   host names is discouraged, but they should work.  One feature that
300   doesn't work with host names that contain spaces is the highlighting
301   of that name in the log file display in the CGI interface.  There are
302   no plans to fix this.
303
304 * Renamed $Conf{SmbClientTimeout} to $Conf{ClientTimeout}.
305
306 * Fixed all open() calls to use 3 argument form to fix handling of file
307   names with trailing whitespace.  Also fixed CGI interface so these
308   file names are displayed correctly.
309
310 * Fixed new 2.0.0 CGI navigation bug that causes the top-level directory
311   to have a URL "&share=//boot&dir=" instead of "&share=/boot&dir=/".
312   Reported by Pascal Schelcher.  Fixed similar problem reported by
313   Doug Lytle.
314
315 * Added "PerlTaintCheck On" to the mod_perl section in the docs,
316   suggested by Tim Demarest.
317
318 #------------------------------------------------------------------------
319 # Version 1.5.0, 2 Aug 2002
320 #------------------------------------------------------------------------
321
322 * Changed conf/config.pl so that $Conf{TarIncrArgs} uses the --newer
323   option instead of --newer-mtime.  Also removed --atime-preserve from
324   $Conf{TarClientCmd}.  This makes the default settings work better
325   with tripwire.
326
327 * Fixed configure.pl so it correctly detects a running BackupPC <= v1.4.0
328   so it can correctly warn the user to stop it before upgrading.  Reported
329   by David Holland.
330
331 * Added missing ";" to entity escape in EscapeHTML in BackupPC_Admin.
332   Reported by Guillaume Filion.
333
334 * Added LDAP setup to documentation from David Holland.
335
336 * Tar.pm now adds a "." to file paths that start with "/", so that all
337   tar paths are relative.  From Ludovic Drolez.
338
339 #------------------------------------------------------------------------
340 # Version 1.5.0beta0, 30 Jun 2002
341 #------------------------------------------------------------------------
342
343 * A full set of restore options is now supported, including direct
344   restore via smbclient or tar or downloading a zip or tar file.
345
346 * Major additions to CGI script to support better directory navigation,
347   restore features and mod_perl.  Also, file downloads from the CGI
348   interface now correctly preserve the file name and provide the
349   correct Content-Type for the most common types of files.  Improved
350   directory navigation was contributed by Ryan Kucera.
351
352 * New script BackupPC_zipCreate (contributed by Guillaume Filion) is the
353   zip analog of BackupPC_tarCreate.  BackupPC_zipCreate can be used to
354   create a zip archive of any portion of a backup.
355
356 * Substantial additions to BackupPC_tarCreate to support restore,
357   including modifying path names, handling hardlinks, fixing
358   support of old backups without attributes (pre-v1.4.0).  Plus
359   BackupPC_tarCreate is now an offical part of the release.
360   (Lack of support for hardlinks was reported by John Stanley.)
361
362 * BackupPC_tarExtract now supports hardlinks and fixed pooling of
363   attribute files.
364
365 * A unix domain socket is now used for communication between the CGI
366   interface and BackupPC.  The original TCP socket is optional.  Sockets
367   are correctly re-initialized if config.pl is updated with new socket
368   settings.
369
370 * For improved security messages over the unix or TCP socket are protected
371   via an MD5 digest based on a shared secret, a sequence number, a time
372   stamp and a unique per-connection number.
373
374 * Additions to configure.pl to support install of directory navigation
375   images.
376
377 * Fixed case where $Conf{BackupFilesOnly} or $Conf{BackupFilesExclude}
378   were set to a single string or list (in v1.4.0 only the case of
379   hash worked correctly).  Reported by Phillip Bertolus.
380
381 * Fixed case of $Conf{BackoutGoodCnt} == 0.  This setting now makes the
382   client always subject to blackout, matching the comments in config.pl.
383   Also fixed handling of $Conf{BackoutGoodCnt} < 0 in the CGI script
384   reported by Pascal Schelcher.
385
386 * Fixed byte and file totals for tar backups, reported by several users.
387
388 * Fixed --newer-mtime date/timestamp format to make it ISO 8601 compliant,
389   suggested by Erminio Baranzini.
390
391 * Fixed handling of $Conf{BackupFilesOnly} in BackupPC::Xfer::Tar.pm, as
392   well as shell escaping of tar arguments.
393
394 * Fixed entity encoding of 8-bit characters in the CGI interface.
395
396 * Added optional CGI headers in $Conf{CgiHeaders} that by default
397   is set to a no-cache pragma.  Suggested by Benno Zuure.
398
399 #------------------------------------------------------------------------
400 # Version 1.4.0, 16 Mar 2002
401 #------------------------------------------------------------------------
402
403 * BackupPC now supports tar (in addition to smb) for extracting host    
404   data.  This is the most convenient option for linux/unix hosts.
405   Tar can be configured to run over ssh, rsh or to backup a local
406   nfs mount from the host.
407
408 * Support for special files, including symbolic links, fifo, character
409   and block device files has been added, so that all native linux/unix
410   file types can be correctly backed up when using tar transport.
411   Special files are all stored as regular files and the type attributes
412   are used to remember the original file type.
413
414 * All unix file attributes are now saved (and pooled when possible).
415   This includes user and group ownership, permissions, and modification
416   time.  Smbclient also does a reasonable job of emulating unix 
417   permissions (such as mtime), and these attributes get saved too.
418
419 * The new default is to not fill incremental dumps.  configure.pl
420   automatically sets $Conf{IncrFill} to 0.  The default was 1
421   (incrementals were filled with hardlinks).  Since the CGI
422   script does filling at browsing time, there is no need to
423   fill incremental dumps.
424
425 * Backup file names are now stored in "mangled" form. Each node of a
426   path is preceded by "f", and special characters (\n, \r, % and /) are
427   URI-encoded as "%xx", where xx is the ascii character's hex value. So
428   c:/craig/example.txt is now stored as fc/fcraig/fexample.txt. This
429   was done mainly so meta-data could be stored alongside the backup
430   files without name collisions.  In particular, the attributes for the
431   files in a directory are stored in a file called "attrib", and
432   mangling avoids file name collisions (I discarded the idea of having
433   a duplicate directory tree for every backup just to store the
434   attributes). Other meta-data (eg: rsync checksums) could be stored in
435   file names preceded by, eg, "c".  There are two other benefits to
436   mangling: the share name might contain "/" (eg: "/home/craig" for tar
437   transport), and I wanted that represented as a single level in the
438   storage tree.  Secondly, as files are written to NewFileList for later
439   processing by BackupPC_link, embedded newlines in the file's path
440   will cause problems which are avoided by mangling.
441
442   The CGI script undoes the mangling, so it is invisibe to the user.
443   Of course, old (unmangled) backups are still supported by the CGI
444   interface.
445
446 * Various changes to the CGI interface, BackupPC_Admin:
447
448   + Added button that allows users to manually start a full dump in
449     addition to the existing incremental dump.
450
451   + Added display of file attributes when browsing backups.
452
453   + Added an optional holdoff time specified by the user when canceling
454     a backup. BackupPC will not attempt any new backups for at least the
455     specified time. This holdoff time can be changed whether or not a
456     backup is running.
457
458   + Added supports for file mangling, and correct merging of unfilled
459     backups from mangled or unmangled (and compressed or uncompressed)
460     fulls when browsing or restoring.
461
462   + Only displays a "Start Incr Backup" button if there are already some
463     backups.
464
465   + For DHCP hosts, when a user tries to manually start a backup, add
466     a check for the netbios name of both the host the request came
467     from (REMOTE_ADDR) and the last known DHCP address for that host
468     to see if either address matches the host. If not, an error
469     message is display. The previous behavior was that only requests
470     from the client itself succeeded, and requests from other machines
471     quietly failed.
472
473 * Changed the version numbering to X.Y.Z, instead of X.0Y. This release
474   is 1.4.0. The first digit is for major new releases, the middle digit
475   is for significant feature releases and improvements, and the last
476   digit is for bug fixes. You should think of the old 1.00, 1.01, 1.02
477   and 1.03 as 1.0.0, ..., 1.3.0.
478
479 * BackupPC and the CGI script BackupPC_Admin now check that the effective
480   user id is correct to avoid accidentally launching BackupPC as the
481   wrong user or detecting CGI configuration problems.  This behavior
482   can be turned off using the $Conf{BackupPCUserVerify} option.
483
484 * In numerous places changed "Smb" to "Xfer" (eg: log file names) to
485   support generic names for both smb and tar transport methods.  The
486   CGI script checks for old names for backward compatibility.
487
488 * Major changed to Backup_dump to support new tar transport.  All transport
489   specific code moved into BackupPC::Xfer::Smb and BackupPC::Xfer::Tar
490   objects.
491
492 * Added workaround for a bug in Samba's smbclient for files between 2GB
493   and 4GB.  The file size in the tar header is incorrect.  This allows
494   files up to 4GB to work with smbclient, rather than 2GB.  To support
495   files larger than 2GB you must make sure perl is compiled with the
496   uselargefiles option (use "perl -V | egrep largefiles" to check) and
497   the pool directory must be on a file system that supports large files.
498
499 * Moved the pool writing code into a module BackupPC::PoolWrite.  This
500   allows the clever file pool checking (digest, uncompressing, comparing
501   etc with minimum disk IO) to be used easily in multiple places (eg: it
502   is now used for writing attribute files so they can be pooled).
503
504 * Changed MD5 to Digest::MD5 to avoid use of the depreceated MD5 module.
505
506 * Shortened default $Conf{MyPath} so that perl's taint mode is more likely
507   to be happy.  The old $Conf{MyPath} contained /usr/local/bin, which
508   on one user's machine was world writable and perl -T correctly
509   complained about it.
510
511 * Fixed ping command options in Lib.pm so that it works on OpenBSD.
512   Thanks to Kyle Amon for sending the fix.  Decided to move the
513   ping options from Lib.pm into config.pl (as $Conf{PingArgs}) and
514   now configure.pl tries to come up with a sensible default based on
515   the OS.
516
517 * Fixed argument checking in BackupPC_tarExtract to allow '$' in the
518   share name (eg: C$).  Thanks to Jules Agee for this fix.  Also
519   changed the default config.pl so that single quotes are used
520   everywhere so that people don't get tripped up putting '$' inside
521   double-quoted strings.
522
523 #------------------------------------------------------------------------
524 # Version 1.03, 9 Dec 2001
525 #------------------------------------------------------------------------
526
527 * BackupPC now has full support for compression.  There are now two
528   pool areas, the original pool for uncompressed files, and cpool for
529   compressed files. The compression is done by Compress::Zlib.
530   Compression reduces the pool disk usage by around 40%, although your
531   mileage may vary.  Compression is optional and can also be specified on
532   a per-PC basis (although this will cost more pool storage since many
533   backup files will have to be stored in both compressed and
534   uncompressed forms.
535
536 * A new script, BackupPC_compressPool, can be run to compress the entire
537   pool.  This is used once to migrate all the pool data from uncompressed
538   to compressed on existing installations.  Read the documentation
539   (Installing BackupPC/Compressing an existing pool) before running
540   BackupPC_compressPool!
541
542   Alternatively, compression can simply be turned on and all new backups
543   will be compressed. Both old (uncompressed) and new (compressed)
544   backups can be browsed and viewed. Eventually, the old backups will
545   expire and all the pool data will be compressed.  However, until the
546   old backups expire, this approach could require 60% or more additional
547   pool storage space to store both uncompressed and compressed versions
548   of the backup files.
549
550 * Significant improvements to the cgi interface, BackupPC_Admin:
551
552     - much better layout navigation
553     - handles compressed backup files and compressed log files
554     - handles unfilled incremental dumps
555     - better backup directory browsing navigation
556     - reports compression statistics
557     - $Conf{CgiDateFormatMMDD} allows you to set date format (MM/DD or DD/MM)
558     - Additional customization with $Conf{CgiHeaderFontType},
559       $Conf{CgiHeaderFontSize}, $Conf{CgiNavBarBgColor}, and
560       $Conf{CgiHeaderBgColor}.
561
562 * Eliminated BackupPC_queueAll.  BackupPC directly reads the hosts
563   file and queues the PCs itself.  Like config.pl, BackupPC will
564   re-read the hosts file on each wakeup if its modification time
565   changes, or upon a SIGHUP.  This also makes for better behavior
566   when adding a host: if you add hosts, simply send a SIGHUP to
567   BackupPC or wait for the next wakeup.
568
569 * BackupPC_dump now compresses the SmbLOG file if compression is enabled.
570
571 * BackupPC_dump keeps track of compressed file sizes so that compression
572   statistics can be reported by the cgi interface.
573
574 * Aging of old log files now handles compressed log files (.z extension).
575
576 * Added configuration option $Conf{IncrFill} to specify whether
577   incremental dumps should be filled in.  Old behavior was that
578   filling was on.  Now it's optional.  See config.pl for more
579   details.
580
581 * BackupPC_nightly now cleans and generates statistics for both
582   the uncompressed pool and compressed pool (cpool).
583
584 * Added new utility script BackupPC_zcat that can be used to
585   uncompresses BackupPC files.
586
587 * configure.pl offers various options related to compression,
588   depending upon whether this is a new install or upgrade,
589   and whether or not Compress::Zlib is installed.
590
591 * configure.pl now makes a backup copy of config.pl before
592   config.pl is updated.
593
594 * added three new fields to the backups file to handle optional
595   filling and compression stats.
596
597 * Added -e option to BackupPC_dump.  BackupPC now invokes BackupPC_dump -e
598   on each dhcp host once each night to verify that very old backups are
599   expired.  This ensures that very old backups are expired even if
600   the dhcp host has not been on the network for a long time.
601
602 * fixed bug in BackupPC::FileZIO.pm that required Compress::Zlib,
603   even if compression was off.  Thanks to Steve Holmes for reporting
604   this.
605
606 * fixed bug that caused a BackupPC queue to get blocked when a backup
607   cancel attempt was made during the BackupPC_link phase.
608
609 #------------------------------------------------------------------------
610 # Version 1.02, 28 Oct 2001.
611 #------------------------------------------------------------------------
612
613 * Added new script BackupPC_tarExtract to extract the smbclient tar
614   archive. This reduces disk writes by perhaps 90-95% and disk reads by
615   50%. Previously, tar was used to extract and write everything to disk.
616   Then BackupPC_dump would read enough of each file to compute the MD5
617   digest, and then compare the full file with candidate pool files.  So
618   for each 1MB file that matches a single file in the pool, there would
619   be 1MB of disk writes and 2MB of disk reads (to compare two 1MB files).
620
621   BackupPC_tarExtract instead extracts the archive using a 1MB memory
622   buffer.  This allows the MD5 digest to be computed without touching the
623   disk.  Next, any potential pool file compares are done by comparing the
624   pool file against the incoming tar data in memory, which only requires
625   the pool file to be read.  So for each 1MB file that matches a single
626   file in the pool, there are now no disk writes, and only 1MB of reads.
627   BackupPC_tarExtract handles arbitrary size files and repeated
628   potential pool matches.  If the incoming file doesn't match the pool
629   then it is written to disk (once the pool is mature this happens maybe
630   5-10% of the time).
631
632 * Substantial changes to BackupPC_dump:
633
634     + BackupPC_tarExtract is now used in place of tar.
635
636     + BackupPC_dump now reads the output from both smbclient and
637       BackupPC_tarExtract and merges them into SmbLOG.
638
639     + Named pipes are no longer used to connect smbclient to tar
640       (now BackupPC_tarExtract).  Regular pipes are used instead.
641       This avoids the need to system mknod or mkfifo.
642
643     + Locked files on the client that can't be read by smbclient
644       previously were filled with 0x0 bytes by smbclient, meaning
645       tar extracted a useless file filled with 0x0 bytes.  Now,
646       BackupPC_dump watches the output of smbclient and removes
647       any files that smbclient couldn't read.  This avoids storing
648       useless files.  It tries to replace such files with a hard link
649       to a previous dump.  These actions appear in the log file.
650
651 * added new module lib/BackupPC/FileZIO.pm. This handles pool file
652   I/O and is used by BackupPC_tarExtract.  BackupPC::FileIO supports
653   reading and writing compressed and regular files and provides all the
654   hooks for compression support in BackupPC (should be supported in next
655   version). BackupPC::FileIO also does efficient writing of files that
656   contain leading 0x0 bytes (by seeking past the 0x0 bytes). This is
657   helpful when smbclient reads a locked file, and it fills the tar
658   output with a file of the correct size but all 0x0.  Such files will be
659   later removed by BackupPC_dump.  But in the meantime, BackupPC::FileIO
660   writes such files efficiently (as sparse files), meaning just a few
661   blocks of disk space will be needed even if the file is large.
662
663 * alive/dead counting for blackout now works correctly for DHCP hosts.
664
665 * BackupPC resets activeJob on startup, to fix bug when BackupPC was
666   killed and restarted with backups running.
667
668 * added extra non blocking select() in BackupPC to make sure the socket
669   reads don't block.
670
671 * BackupPC avoids queuing multiple BackupPC_queueAll's on the CmdQueue.
672
673 * Updated BackupPC_sendEmail to correctly parse the locked file
674   error from 2.2.1a smbclient, so that missing Outlook file emails
675   can be correctly sent.
676
677 * Changed HostInfoRead() in lib/BackupPC/Lib.pm to lowercase the
678   hostname read from the hosts file.
679
680 * BackupPC_Admin provides general summary when the host name is empty.
681
682 * configure.pl (and BackupPC) now requires perl 5.6.0 or later.
683
684 * configure.pl complains if BackupPC is already running, reminding you
685   to stop it before upgrading.
686
687 * updated documentation, and fixed auto-insertion of config.pl into
688   BackupPC.pod (previously the last config parameter was left out of
689   BackupPC.pod).
690
691 #------------------------------------------------------------------------
692 # Version 1.01, 30 Sep 2001
693 #------------------------------------------------------------------------
694
695 * Documentation cleanup in README, doc/BackupPC.pod, conf/config.pl.
696
697 * BackupPC_sendMail now reads the optional per-PC config file, allowing
698   email configuration parameters to be set on a per-PC basis.
699
700 * Removed the unused 4096-length MD5 digest code in lib/BackupPC/Lib.pm.
701
702 #------------------------------------------------------------------------
703 # Version 1.00, 21 Sep 2001
704 #------------------------------------------------------------------------
705
706 * Initial release of BackupPC on sourceforge.net.