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