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