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