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