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