* Added some performance improvements to BackupPC::Xfer::RsyncFileIO
[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 some performance improvements to BackupPC::Xfer::RsyncFileIO
25   for the case of small files with cached checksums.
26
27 * Added optional support for IO::Dirent which allows inode information
28   to be extracted from the dirent directory structure.  This allows
29   BackupPC to order some directory operations by inode, which on
30   some file systems (eg: ext3) can results in a 20-30% performance
31   gain.  On other file systems there is no real improvement.  This
32   optimization is turned on automatically if IO::Dirent is installed.
33
34 * Added sorting by column feature to host summary table in CGI
35   interface.  Implemented by Jeremy Tietsort.
36
37 * Added FreeBSD init.d file provided by Gabriel Rossetti.
38
39 * Applied small patch from Sergey to lib/BackupPC/Xfer/Tar.pm that makes
40   it ignore "socket ignored" error on incrementals.
41
42 * Applied small patch from Sergey to bin/BackupPC_archiveHost.
43
44 * Added RsyncdUserName to the config editor.  Reported by Vicent Roca Daniel.
45
46 * configure.pl clears $Conf{ParPath} if it doesn't point to a valid
47   executable.
48
49 * Added freebsd-backuppc init.d script from Gabriel Rossetti.
50
51 * Added documentation for BackupPC_tarPCCopy, including use of -P option
52   to tar suggested by Daniel Berteaud.
53
54 * Config editor now removes white space at start of exec path.
55   Reported by Christoph Iwasjuta.
56
57 * CgiDateFormatMMDD == 2 gives a YYYY-MM-DD format for CGI dates,
58   suggested by Imre.
59
60 #------------------------------------------------------------------------
61 # Version 3.0.0, 28 Jan 2007
62 #------------------------------------------------------------------------
63
64 * BackupPC_sendEmail now correctly sends admin email if backups
65   were skipped because the disk was too full, reported by Dan
66   Pritts.
67
68 * BackupPC_Admin now uses $Conf{UmaskMode}, so config.pl files
69   written by the editor have more restrictive permissions.
70   Reported by Tim Massey.
71
72 * Host summary now shows active backups on disabled hosts,
73   from Jono Woodhouse.
74
75 * Fixed host LOG link and LOG list order, reported by Tim Massey.
76
77 * Moved Encode.pm version check to start of configure.pl so it
78   produces a useful error message if Encode.pm is too old.
79
80 * Fixed hrefs to configuration documentation to handle changes
81   in the way perl generates the anchors.  Reported by Philip
82   Gleghorn.
83
84 * Host name links in LOG files now allow "." in the host name.
85   Reported by Jean-Michel Beuken.
86
87 * Fixes to lib/BackupPC/Xfer/Tar.pm for tar 1.16: allow 1
88   (ie: 256) as a successful exit status and match "Total
89   bytes read" message for restores.  First reported by
90   Torsten Sadowski and debugged by Ralf Gross and Holger
91   Parplies.
92
93 #------------------------------------------------------------------------
94 # Version 3.0.0beta3, 3 Dec 2006
95 #------------------------------------------------------------------------
96
97 * Removed default paths from conf/config.pl so configure.pl will
98   determine the correct ones at install time.  Avoids problem of
99   the config editor complaining about bad executable paths the
100   first time you use it.
101
102 * Changed first byte of compressed files with rsync checksums appended
103   to 0xd7 to allow correct protocol_version >= 27 md4 checksums to be
104   written.  Old cached checksum files have a first byte 0xd6 and are
105   now considered to be uncached.  They will be automatically updated
106   as needed.  This avoids the cached checksum warnings in beta2.
107
108 * BackupPC_tarPCCopy now handles all file types correctly.  Reported
109   by George Avrunin.
110
111 * Fixed BackupPC_nightly to finish pending deletes before renaming
112   pool chains.
113
114 * Fixes for rsync restore where hardlink is to file outside of the
115   top-level restore directory.  Reported by George Avrunin, who helped
116   with debugging.
117
118 * Fixes for checksum mismatch on restore for certain file sizes.
119   Reported by George Avrunin and others.
120
121 * Fix for config.pl writing code to handle multi-line expressions.
122   Reported by David Relson and others.
123
124 * Fix for CGI editor when deleting hash entries whose keys are
125   non alphanumeric.  Report by David Relson and Aaron Ciarlotta.
126
127 * Two fixes to configure.pl from Andreas Vögele.
128
129 #------------------------------------------------------------------------
130 # Version 3.0.0beta2, 18 Nov 2006
131 #------------------------------------------------------------------------
132
133 * Fix for final md4 digest check on rsync transfers >= 512MB when protocol
134   version >= 27 and checksums are not cached.  Reported by Garith Dugmore
135   and Dale Renton.
136
137 * Config Editor "Save" button is now always visible, but greyed out
138   until there are changes to save.
139
140 * Config editor allows other tabs to be selected when there is an
141   error, which allows you to fix an error (eg: missing binary) in
142   an exiting config file.  Errors are now displayed at the top of
143   the page in addition to next to the erroneous setting.
144
145 * configure.pl checks version of Encode.pm.  Reported by Chris Stone.
146
147 * Several fixes to bin/BackupPC_fixupBackupSummary from Stian Jordet.
148
149 * Fixed config.pl editor writing to solve bug with multi-line text
150   strings ending in newline.  Reported and root caused by Les Stott
151   and Jerry Groendyke.
152
153 * Fixed error recovery case in BackupPC::PoolWrite, reported by
154   Samuel Bancal.
155
156 * Fixed table width in backup browsing to avoid Firefox layout anomoly,
157   provided by Jono Woodhouse.
158
159 * CSS file updates from Jono Woodhouse.  Prior (v2) version is included
160   as BackupPC_stnd_orig.css in case people prefer the old skin.
161
162 * More compact host summary, including disabled host indication,
163   from Jono Woodhouse.
164
165 * New directory/file/hardlink and symlink image icons from Sean Cameron
166   and Jono Woodhouse, making directory browse more compact.
167
168 * BackupPC.pid is now world readable, suggested by Casper Thomsen.
169
170 * Reordered the Server navigation bar links, suggested by David Relson.
171
172 * Fixed typos in init.d/src/gentoo-backuppc, configure.pl and config.pl
173   reported by David Relson.
174
175 #------------------------------------------------------------------------
176 # Version 3.0.0beta1, 30 Jul 2006
177 #------------------------------------------------------------------------
178
179 * Fixed several Xfer charset conversions.
180
181 * Added some CGI utf8 conversions from Rodrigo Real and Vincent
182   Fleuranceau.
183
184 * Rsync transfers now correctly handle file names with \n or \r.
185
186 * Host name is forced to lower case, to match 2.x.
187
188 * Fixed LOG file naming in BackupPC_restore and BackupPC_archive.
189
190 * GFK applied fr.pm corrections from Nicolas Stransky.
191
192 * Updated init.d/src scripts for FHS (ie: replaced __TOPDIR__/log
193   with __LOGDIR__ and __TOPDIR__/conf with __CONFDIR__).  Patch
194   provided by Rodrigo Real.
195
196 * Added --log-dir and --conf-dir options to configure.pl.
197   Reported by Vincent Fleuranceau.
198
199 * Updated File::RsyncP version check in configure.pl, reported
200   by Vincent Fleuranceau.  Changed File::RsyncP version to 0.64.
201
202 #------------------------------------------------------------------------
203 # Version 3.0.0beta0, 11 Jul 2006
204 #------------------------------------------------------------------------
205
206 * Added configuration and host CGI editor.
207
208 * Added rsync hardlink support.  Requires latest version of
209   File::RsyncP (0.62).
210
211 * Decoupled BackupPC_dump from BackupPC_nightly by making
212   asynchronous file linking/delete robust to race conditions.
213   Now only BackupPC_nightly and BackupPC_link are mutually
214   exclusive so only one runs at a time, and BackupPC_dump and
215   BackupPC_restore can run anytime.
216
217 * Added support for multi-level incrementals.  In the style of dump(1),
218   the level of each incremental can be specified.  Each incremental
219   backups up everything since the most recent backup of a lower level
220   (fulls are always level 0).  Previous behavior was all incrementals
221   were level 1, meaning they backed up everything since the last full
222   (level 0).  Default configuration is all incrementals are level 1.
223
224 * Server file names are now in utf8 and optional conversion
225   to/from client name charsets can be configured.  All CGI pages
226   now use the utf8 charset.
227
228 * Backup metadata is now additionally saved to pc/HOST/nnn/backupInfo,
229   in addition to pc/HOST/backups.  In case pc/HOST/backups gets trashed,
230   then a new script BackupPC_fixupBackupSummary can read the per-backup
231   metadata from pc/HOST/nnn/backupInfo and reconstruct the backups file.
232   Roberto Moreno also pointed out an early error in the CVS version.
233
234 * Added Storage module and Storage::Text which localizes all the
235   text data file reading/writing (eg: backups, restores, archives
236   and config.pl files).  Added read verify after all write
237   operations for robustness.  Additional backends (eg: SQL)
238   can be added in the future as new subclasses of the Storage
239   module.
240
241 * Added Config module, and Config::Meta that contains meta data
242   about configuration parameters.
243
244 * Added RSS support from Rich Duzenbury.
245
246 * Translations of new 3.0 language strings from Guillaume Filion,
247   Reginaldo Ferreira, Ralph Passgang, Lieven Bridts, Guus Houtzager,
248   Rodrigo Real.
249
250 * Added optional checking of exit status of Dump/Restore/Archive Pre/Post
251   UserCmd, requested by Kiko Jover, Matthias Bertschy and others.
252
253 * For new installations configure.pl tries to comply with the file
254   system hierarchy standard, which means all the configuration files
255   below /etc/BackupPC and log files go below /var/log/BackupPC.
256
257 * Added Slackware init.d script from Tony Nelson.
258
259 * Fixed error reporting when restore/archive fail to write the
260   request file to the client directory.
261
262 * Applied patch from Marc Prewitt for DumpPreShareCmd and DumpPostShareCmd.
263
264 * Apply patch from Pete Wenzel to add smbClientPath => $Conf{SmbClientPath}
265   to DumpPreUserCmd etc.
266
267 * Added Portuguese Brazillian pt_br.pm from Reginaldo Ferreira.
268
269 * Jean-Michel Beuken reported several bugs in configure.pl in CVS 3.0.0.
270
271 * Old backup email warnings now ignore partials requested by Samuel Bancal
272
273 * Applied patch to bin/BackupPC_sendEmail from Marc Prewitt that
274   ignores any file starting with "." in the pc directory when
275   it is generating warnings about old/unused files/directories.
276
277 * Applied patch from Marc Prewitt to fix host queue order.
278  
279 * Applied Lorenzo Cappelletti's it.pm patch.
280
281 * Applied Wander Winkelhorst's nl.pm patch.
282
283 * Applied Alberto Marconi's it.pm patch.
284
285 * Add NT_STATUS_FILE_LOCK_CONFLICT to pst read error check in
286   BackupPC_sendEmail to fix bug reported by Dale Renton.
287
288 * Added fixup of $ENV{REMOTE_USER} to lib/BackupPC/CGI/Lib.pm in the
289   case of using mod_authz_ldap; patch submitted by Alain Perrier.
290
291 * Added env LC_ALL=C to $Conf{TarClientCmd} and $Conf{TarClientRestoreCmd}
292   to avoid locale problems, suggested by Ludovic Drolez.
293
294 * Changed ping output parsing to pick out average rtt time, based
295   on patch from Ron Bickers.
296
297 * Removed leading "./" and top-level "./" directory from
298   zip archives generated by BackupPC_zipCreate.  Reported
299   by Josh (hecktarzuli).
300
301 * BackupPC_tarCreate and BackupPC_zipCreate now allow "@"
302   in share names.  Reported by Robert Waldner.
303
304 * NT_STATUS_INSUFF_SERVER_RESOURCES is now a fatal error for
305   smbclient transfers, suggested by Brian Shand.
306
307 * Changed bin/BackupPC_archiveHost to use /bin/csh instead of
308   /bin/sh.  That way any errors in the pipeline are reported
309   via the exit status, instead of just the last.
310
311 * Added $Conf{EMailHeaders} for additional email headers, requested
312   by Ludovic Gasc.  If the Content-Type charset is set to utf8 then
313   the body of the email is sent in utf8 coding.
314
315 * Made shareName argument regexp checking more general to allow parens.
316
317 * Added some debian init.d instructions to init.d/README from
318   Bob de Wildt.
319
320 * Documentation updates from Richard Ames, JP Vossen, Torsten Finke.
321
322 #------------------------------------------------------------------------
323 # Version 2.1.2pl2, 18 Jun 2006
324 #------------------------------------------------------------------------
325
326 * In conf/config.pl, changed --devices to -D in $Conf{RsyncArgs}
327   and $Conf{RsyncRestoreArgs} to fix "fileListReceive failed" and
328   "Can't open .../f%2f for empty output" errors with rsync 2.6.7+.
329   Fix proposed by Justin Pessa and Vincent Ho, and confirmed by
330   Dan Niles.
331
332 * Added patch from Michael (mna.news) to ignore "file is unchanged"
333   message from tar 1.15.x during incremental backups.
334
335 * Fixed creation of .rsrc directories in bin/BackupPC_tarExtract
336   when used with xtar on MacOS.  Reported by Samuel Bancal and
337   Matthew Radey, who helped with debugging.
338
339 * Fixed bug in BackupPC_tarExtract for files >8GB in size whose
340   lengths are multiples of 256.  Reported by Jamie Myers and
341   Marko Tukiainen, who both helped debugging the problem.
342
343 * Fixed bug in lib/BackupPC/Xfer/RsyncFileIO.pm that caused
344   incorrected deleted attributes to be set in directories
345   where one of the files had an rsync phase 1 retry during
346   an incremental.  Reported by Tony Nelson.
347
348 #------------------------------------------------------------------------
349 # Version 2.1.2, 5 Sep 2005
350 #------------------------------------------------------------------------
351
352 * Fixed simple but serious bug in bin/BackupPC_tarCreate that prevented
353   hardlinks being saved correctly.  Debugged by Michael (mna.news)
354   with several other people.
355
356 * Fixed serious bug in bin/BackupPC_dump reported/debugged by Dan Niles
357   that can happen when multiple full backups are deleted after
358   $Conf{FullKeepCnt} is changed.
359
360 * Changed lib/BackupPC/CGI/Lib.pm so that link to "$TopDir/conf/$host.pl"
361   is displayed if it exists.  Patch from Andreas Vögele.
362
363 * Applied daemonize patch to bin/BackupPC from:
364         http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=301057
365
366 * It's now a fatal error if $Conf{CompressLevel} is set, but
367   Compress::Zlib is not found.  Before $Conf{CompressLevel} was
368   silently set to 0, which made all the backups uncompressed.
369   That meant the user never knew if they forget to install
370   Compress::Zlib but were expecting compression to be on.
371
372 * Finally increased $Conf{ClientTimeout} to 72000 (20 hours).
373
374 * Added sleep 1 in restart() function in init.d/src/gentoo-backuppc,
375   suggested by Jon Hood.
376
377 * Added $DestDir to the path of the CGI image directory in configure.pl.
378   Patch submitted by Andreas Vögele.
379
380 * Applied extensive patch to French translation from Frederic Lehobey.
381
382 * Minor change to Dutch language $Lang{Pool_Stat} from Wander Winkelhorst.
383
384 * Minor change to French language $Lang{EMailOutlookBackupMesg} and
385   $Lang{EMailOutlookBackupSubj} from Ludovic Gasc.
386
387 #------------------------------------------------------------------------
388 # Version 2.1.1, 13 Mar 2005
389 #------------------------------------------------------------------------
390
391  * Fixed bug in top-level restore using rsync XferMethod.
392    BackupPC::View was leaving an extra leading "/" at the start
393    of top-level directories, messing up the FileList sort order.
394    Reported and debugged by Gail Edwards.
395
396  * Added pathCreate() to BackupPC_tarExtract so that new directories
397    are created.  Required for xtar on MacOSX since the virtual resource
398    fork directories (.rsrc) are not explicitly included in the tar
399    archive - just the files below .rsrc are.
400
401  * Changed $host.$bkupNum.tar$fileExt.* to $host.$bkupNum.tar$fileExt*
402    in $parCmd in bin/BackupPC_archiveHost.
403
404  * Fixed HostSortCompare() in BackupPC to correctly sort hosts so
405    those with the oldest backups get queued first.
406
407  * Changed test in BackupPC_sendEmail so that directories/files
408    starting with "." in $TopDir/pc are ignored, rather than
409    just "." and "..".
410
411  * Changed BackupPC_sendEmail to include NT_STATUS_FILE_LOCK_CONFLICT
412    in check for bad outlook files.
413
414  * Ensure that %Status and %StatusHost are empty if requesting
415    status on hosts in lib/BackupPC/CGI/Lib.pm GetStatusInfo().
416    Fixes problem with new hosts under mod_perl.
417
418  * Added images/icon-hardlink.gif so that hardlinks show file type icon.
419
420 #------------------------------------------------------------------------
421 # Version 2.1.0pl1, 15 Aug 2004
422 #------------------------------------------------------------------------
423
424 * Added fix to nl.pm from Lieven Bridts.
425
426 * Added patch from Tony Nelson to remove $Info{pid} before BackupPC
427   writes the status and shuts down.
428
429 * Changed BackupPC_nightly so that it doesn't call find() if the
430   directory doesn't exist.  This avoids errors in certain versions
431   of perl.  Reported by Bernd Rilling.
432
433 * Fixed BackupPC::CGI::Lib to correctly re-load config.pl for mod_perl.
434   Reported by Tony Nelson and Jimmy Liang.
435
436 * Explicitly untaint $In{host} in BackupPC::CGI::Lib to fix problem
437   reported by Thomas Tempé.
438
439 * Added newline to "...skipping because of user requested delay..."
440   log message in BackupPC_dump.  Reported by Wayne Scott.
441
442 * Added read file size error checking to BackupPC_tarCreate.
443   Reported by Brandon Evans.
444
445 * Added check in BackupPC::Xfer::RsyncFileIO to ensure that when
446   compression is toggled on/off, a compressed backup doesn't link
447   to an uncompressed pool file (and an uncompressed backup doesn't
448   link to a compressed pool file).  Reported by Brandon Evans.
449
450 * Updated documentation with new dirvish URL and a typo from
451   Todd Curry.
452
453 * Fix to BackupPC_sendEmail so that it correctly sends admin emails
454   for hosts that have failed backups.  Reported by Simon Kuhn.
455
456 #------------------------------------------------------------------------
457 # Version 2.1.0, 20 Jun 2004
458 #------------------------------------------------------------------------
459
460 * Added Dutch translation from Lieven Bridts, with tweaks from
461   Guus Houtzager.
462
463 * Added PC-specific config file read in CGI/Archive.pm.  Patch
464   from Pete Wenzel.
465
466 * Added non-zero exit code to BackupPC_zcat when uncompress fails.
467   Patch from Pete Wenzel.
468
469 * Cosmetic changes to PC Summary and Log file language strings from
470   Pete Wenzel.
471
472 * BackupPC::Lib tries to be more careful when renaming the backups
473   file to backups.old.  There have been reports of backups being
474   empty, perhaps when the BackupPC data file system fills up.
475   Now backups is not renamed to backups.old if backups is empty.
476
477 * BackupPC now closes stderr and stdout before renaming and
478   re-opening the log file.
479
480 * Pre/post backup/restore/archive commands now correctly set
481   "type" to either incr/full/restore/archive, and now cmdType
482   is the type of Pre/post backup/restore/archive command.
483
484 * BackupPC_archive correctly terminates archive processes on
485   alarm or cancel.
486
487 * Updates to BackupPC_stnd.css with absolute font sizes instead
488   of relative.
489
490 * BackupPC_dump now makes sure that the $Conf{FullAgeMax} check
491   also ensures the full backup is older than the maximum age
492   expected from $Conf{FullPeriod}.
493
494 #------------------------------------------------------------------------
495 # Version 2.1.0beta2pl1, 30 May 2004
496 #------------------------------------------------------------------------
497
498 * Fixed bug in rsync checksum caching code in BackupPC::Xfer::RsyncDigest.
499
500 * BackupPC_zipCreate now ensures the earliest mtime is 1/1/1980,
501   since zip file formats don't support earlier dates.  Reported
502   by Dan Niles.
503
504 * CGI restore via zip and tar now makes sure stderr is ignored
505   when BackupPC_tarCreate and BackupPC_zipCreate are run.
506   Previously any stderr output would get mixed in the archive,
507   corrupting it.  Reported by Dan Niles.
508
509 #------------------------------------------------------------------------
510 # Version 2.1.0beta2, 23 May 2004
511 #------------------------------------------------------------------------
512
513 * $Conf{BackupFilesOnly} and $Conf{BackupFilesExclude} now apply
514   to every share, rather than just the first, in the case where
515   they are arrays and there are multiple shares.  Suggested
516   by Andy Evans.
517
518 * On the phase 2 retry pass with rsync, verify the cached checksums
519   if checksum caching is turned on.  This will catch the case of
520   cached checksums being incorrectly appended to the compressed
521   pool file.  Added new config parameter $Conf{RsyncCsumCacheVerifyProb}
522   so that cached checksums are verified with a selectable probability.
523   Also, increased File::RsyncP version number to 0.51.
524
525 * configure.pl now supports an optional batch mode.  Command-line
526   options are used to specify all the information that configure.pl
527   needs.  This is useful for building auto-install packages.
528   Also, configure.pl now includes pod documentation, so you can do
529   "perldoc configure.pl" to see all the command-line options.
530   Suggested, tested and tweaked by Stuart Herbert for possible
531   Gentoo inclusion.
532
533 * At each wakeup, clients are now queued based on how old the most
534   recent backup is.  Clients with errors are queued first, with
535   the oldest error times going first.  The rest of the clients are
536   queued next, with the clients with the oldest backup going first.
537   Previously the clients were simply queued in alphabetic order.
538   Suggested by Mike Trisko and Tony Nelson.
539
540 * Added config parameter $Conf{PartialAgeMax} that controls whether
541   partials are saved at all, and if so, whether the partial will be
542   ignored at the next full backup if it is too old.
543
544 * BackupPC_tarExtract now allows empty archives without reporting
545   an error.  Reported by Don Silvia.
546
547 * Removed Browse Backups link from Nav Bar in Archive Info display.
548   Reported by Ralph Paßgang.
549
550 * Fixed documentation display for regular users.  Reported by Ralph Paßgang.
551
552 * Status and PC Summary now work for regular users and only show
553   that user's hosts.  Server general status information only appears
554   for admins.  Suggested by Ralph Paßgang.
555
556 * Moved the last three navigation-bar links (docs, FAQ and SF) to
557   a new config parameter $Conf{CgiNavBarLinks}.  This allows
558   these links to be locally configured.  Based on a patch
559   submitted by Ralph Paßgang.
560
561 * Allow the navigation bar search box to be disabled by
562   setting $Conf{CgiSearchBoxEnable} to 0.  Based on a patch
563   submitted by Ralph Paßgang.
564
565 * Updates to de.pm from Ralph Paßgang.
566
567 * Made the BackupPC icon a link to the SF BackupPC project page.
568
569 #------------------------------------------------------------------------
570 # Version 2.1.0beta1, 4 Apr 2004
571 #------------------------------------------------------------------------
572
573 * The CSS definition has been removed from the config.pl file and
574   is now a separate file, BackupPC_stnd.css.  A new config variable,
575   $Conf{CgiCSSFile}, gives the name of the CSS file to use.
576   Suggested by Ender Mathias.
577
578 * Fixed the filling of the host name select box for admins.
579   The default $Conf{CgiNavBarAdminAllHosts} is now 1.
580   Reported by Doug Lytle.
581
582 * Cleaned up warning message for restore using rsync when checksum
583   caching is on, but when file didn't have cached checksums.
584
585 * Fixed BackupPC_archiveHost to support par2 (par2cmdline).
586   Patch submitted by Jaco Bongers and adapted by Josh Marshall.
587
588 * Improved stat() usage in BackupPC_nightly, plus some other cleanup,
589   giving a significant performance improvement.  Patch submitted by
590   Wayne Scott.
591
592 * Allow several BackupPC_nightly processes to run in parallel based
593   on new $Conf{BackupPCNightlyJobs} setting.  This speeds up the
594   traversal of the pool, reducing the overall run time for
595   BackupPC_nightly.
596
597 * Allow BackupPC_nightly to split the pool traversal across several
598   nightly runs.  This improves the running time per night, at the expense
599   of a slight increase in disk storage as unused pool files might not
600   be deleted for a couple of days.  Controller by new config setting
601   $Conf{BackupPCNightlyPeriod}.
602
603 #------------------------------------------------------------------------
604 # Version 2.1.0beta0, 20 Mar 2004
605 #------------------------------------------------------------------------
606
607 * A failed full dump is now saved as a partial (incomplete) dump,
608   provided it includes some files.  This can be used for browsing,
609   restoring etc, and will also form the basis of resuming full
610   dumps.  Only one partial is kept, and it is removed as soon
611   as a successful full (or a new partial) is done.
612
613 * Added support for resuming a full dump for rsync.  The partial
614   full is kept, and to resume an incremental is done against the
615   partial, and a full is done for the rest.
616
617 * Added support for Rsync checksum caching.  Rsync checksum are
618   appended to the compressed pool files.  This means that block
619   and file checksums do not need to be recomputed on the server
620   when using rsync.  Requires a patch to rsync to support fixed
621   checksum seeds.  This patch is included in the cygwin-rsyncd
622   release on http://backuppc.sourceforge.net.
623
624 * Major addition of Archive feature from Josh Marshall.  Special
625   clients can be configured to be archive targets (eg: tape drives,
626   CD-R).  Any subset of the backup clients can be selected and tar
627   archives are created, optionally compressed and split and written
628   to the output device.  Logs are maintained and are browsable.
629
630 * Major changes from Ryan Kucera to add style sheets to the CGI
631   interface, allowing easy customization.  Added new icons and
632   BackupPC logo.  Numerous navigation improvements.
633
634 * Added directory history display to BackupPC_Admin, allowing the
635   user to quickly see which files changed between backups on a
636   per-directory basis.
637
638 * Added exponential expiry option for full dumps.  This allows you
639   to specify
640   
641    - how many fulls to keep at intervals of $Conf{FullPeriod}, followed by
642    - how many fulls to keep at intervals of 2 * $Conf{FullPeriod},
643    - how many fulls to keep at intervals of 4 * $Conf{FullPeriod},
644    - how many fulls to keep at intervals of 8 * $Conf{FullPeriod},
645    - how many fulls to keep at intervals of 16 * $Conf{FullPeriod},
646
647   and so on.  This allows you, for example, to keep 4 weekly fulls,
648   followed by 6 fulls every 4 weeks (approx 1 month) and 2 fulls at
649   16 weeks, for roughly 1 year of history.  This works by deleting
650   every other full as each expiry boundary is crossed.  Suggested
651   by David Cramblett.
652
653 * Added Italian language translation it.pm from Lorenzo Cappelletti.
654
655 * Major updates to language files for new features and tags changes.
656   Updated makeDist to do pedantic consistency checking of language
657   files.
658
659 * Addition of administration options from Paul Lukins.  Initial
660   page allows server to be started/stopped/reloaded.  This still
661   needs some i18n work.  Currently the server start/stop is
662   commented out.
663
664 * Split BackupPC_Admin into a set of modules, one for each major action.
665   Each action is now a seperate module in lib/BackupPC/CGI.
666
667 * Allow the blackout period begin/end to span midnight.  Adapted
668   from patch submitted by David Smith.
669
670 * Allow multiple blackout periods, with new config variable
671   $Conf{BlackoutPeriods} that replaces the old variables
672   $Conf{BlackoutHourBegin}, $Conf{BlackoutHourEnd}, and
673   $Conf{BlackoutWeekDays}.  Based on patch submitted by
674   Lorenzo Cappelletti.
675
676 * Disabled alarms after forks to avoid timeouts in children that
677   do not reset their alarm.  Prompted by ideas from James Leu.
678
679 * Added options for block size, buffer size and share wild-card to
680   BackupPC_tarCreate.  Also added negative backup number options
681   that are relative to the last (so -1 is the last), suggested by
682   William McKee and Carl Soderstrom.
683
684 * The "Wrong user" message in BackupPC::Lib now goes to stderr, so that
685   the user is more likely to see the error with BackupPC_tarCreate.
686   Reported by Paul Fox.
687
688 * Add creation of per-PC directory in BackupPC/CGI/Restore.pm in
689   case it doesn't already exist.
690
691 * Added -q -x to all ssh commands in conf/config.pl.  Suggested by
692   SI Reasoning and Niranjan Ghate.
693
694 * Changed restore code so that option #1 (direct restore) can be
695   disabled if the restore command is undefined.  Disabling direct
696   restore is necessary if the share is read-only.  Suggested by
697   Rich B from SAIC.
698
699 * Changed regexp in lib/BackupPC/Smb.pm to allow numbers with both
700   a decimal point or comma for international versions of Samba.
701   Patch submitted by Frank Gard.
702
703 * Browsing and directory history now sort the files in a
704   case-insensitive manner.
705
706 * Changed exec() syntax to allow executing commands whose path
707   contains spaces.
708
709 * BackupPC_dump no longer removes backups if $Conf{FullKeepCnt}
710   is zero or undefined.  The protects the existing backups in the
711   case of a bad config.pl file.  Suggested by Christian Warden.
712
713 * Swapped the Server and Hosts sections on the Nav bar.  Moved the
714   host search text box to the top of the hosts section.  This was
715   done to move the variable-length part of the Nav bar (when all
716   hosts are displayed) to the bottom.
717
718 * Fixed a bug in tar restore related to how the common prefix path is
719   removed.  Now ensure that the common path is at a directory boundary.
720   Reported by Patrick Neuner.
721
722 * Added --chuid ${USER} to init.d/src/gentoo-backuppc.  Suggested by
723   SI Reasoning, Pascal Pochol, Michael Evanoff and others.
724
725 * Added Suse notes to init.d/README from Bruno Vernay.
726
727 * Added Apache 2 documentation fix from Michael Tuzi.
728
729 #------------------------------------------------------------------------
730 # Version 2.0.2, 6 Oct 2003
731 #------------------------------------------------------------------------
732
733 * Fixed stupid last-minute change in octal size conversion in
734   Backup_tarExtract.
735
736 #-----------------------------------------------------------------------
737 # Version 2.0.1, 5 Oct 2003
738 #------------------------------------------------------------------------
739
740 * Fixed handling of >= 8GB files in BackupPC_tarExtract and >= 4GB
741   files in BackupPC_tarCreate.
742
743 * Removed smbclient size repair in BackupPC_tarExtract for files
744   between 2GB and 4GB.  This means that BackupPC_tarExtract 2.0.1
745   doesn't behave the same as 2.0.0 for file sizes between 2GB and 4GB
746   extacted using smbclient 2.2.x.  If you have problems backing up
747   files whose size is between 2GB and 4GB using smbclient 2.2.x
748   you should upgrade smbclient to 3.0, since it now generates
749   correct file sizes.
750
751 * Replace PingClientPath with PingPath in configure.pl.
752
753 * Removed -T (taint mode) on binaries installed in configure.pl.
754
755 * Added support for smbclient from samba version 3.0.0.
756
757 * Fixed $Conf{HardLinkMax} limit check in BackupPC::Lib; reported
758   by Ross Skaliotis.
759
760 * In BackupPC_Admin, default REMOTE_USER to $Conf{BackupPCUser}
761   if it is not defined.  This allows the CGI interface to work
762   when AdminUsers = '*'.  Reported by Quentin Arce.
763
764 * For SMB, code that detected files with a read-locked region (eg:
765   outlook .pst files), removed them and then tried to link with an
766   earlier version was broken.  This code missed a step of mangling
767   the file names.  This is now fixed.  Reported by Pierre Bourgin.
768
769 * A backup of a share that has zero files is now considered
770   fatal. This is used to catch miscellaneous Xfer errors that
771   result in no files being backed up.  A new config parameter
772   $Conf{BackupZeroFilesIsFatal} (defaults to 1) and can be set to
773   zero to turn off this check.  Suggested by Guillaume Filion.
774   Additional change: this check only applies to a full dump.
775
776 * SMB: now detect NT_STATUS_ACCESS_DENIED on entire share or BackupFilesOnly
777   (also ERRDOS - ERRnoaccess (Access denied.) for older versions of
778   smbclient.)  Suggested by Guillaume Filion.
779
780 * SMB: now detects "tree connect failed: NT_STATUS_BAD_NETWORK_NAME" and
781   the dump is considered failed.
782
783 * Rsync: Previously BackupFilesOnly = '/' did --include '/' --exclude '/*',
784   which just included the '/' directory and nothing below.  Now it
785   does just --include '/', which should include everything.
786   Reported by denon.
787
788 * Add hostError to DumpPostUserCmd variable substitutions for both dump
789   and restore.
790
791 * Verbose output in Lib.pm goes to STDERR, not STDOUT.  This now
792   makes BackupPC_dump -v work better.
793
794 * Don't allow browsing with ".." in directory in case a user tries
795   to trick BackupPC_Admin into displaying directories outside where
796   they are allowed.
797
798 * Required File::RsyncP version is now 0.44, since File::RsyncP 0.44
799   fixes large file (>2GB) bugs.  Large file bugs reported by Steve
800   Waltner.
801
802 #------------------------------------------------------------------------
803 # Version 2.0.0, 14 Jun 2003
804 #------------------------------------------------------------------------
805
806 * Minor tweaks to disable utf8 on utf8-capable machines (eg: RH8+).
807   Added "no utf8" to all programs, and added binmode() to relevant
808   file handles.
809
810 #------------------------------------------------------------------------
811 # Version 2.0.0beta3, 1 Jun 2003
812 #------------------------------------------------------------------------
813
814 * Several improvements to restore: cancel now reports the correct
815   message and cleans up correctly.
816
817 * Rsync with whitespace and wildcard excludes fixed by replacing
818   argList with argList+ in config.pl plus a fix to Lib.pm for
819   shell escaping array arguments.
820
821 * Fixed rsync restore for character and block special devices
822   (major and minor device numbers weren't correctly restored).
823
824 * Fixed typo in bin/BackupPC_restore (XferLOG -> RestoreLOG).
825
826 * (Re)-fixed "Bad command" in log file when restore via tar or zip
827   file download is done.
828
829 * Added untaint to exec in Lib.pm to avoid tainted errors.
830
831 * Applied additional tweak to hilight patch from Tim Demarest.
832
833 * $Conf{CgiAdminUsers} = '*' now allows privileged even with REMOTE_USER
834   not set.
835
836 * Don't display RsyncdPasswd when displaying config.pl files.
837
838 * Replace pipe with socketpair in bin/BackupPC_dump and bin/BackupPC_restore,
839   which increases typical buffering from 4K to 16K-64K.  This improves the
840   performance.
841
842 * Add check on $ENV{LANG} setting do configure.pl: if LANG includes utf
843   then a warning is printed.
844
845 #------------------------------------------------------------------------
846 # Version 2.0.0beta2, 11 May 2003
847 #------------------------------------------------------------------------
848
849 * Added German translation, provided by Manfred Herrmann.
850
851 * Fixed large-file problem with rsync, reported by Manfred Herrmann.
852
853 * Fixed zip and tar file download from CGI under mod_perl.  Reported
854   by Pierre Bourgin and Paul Lukins.
855
856 * Fixed directory browsing and top-level directory browsing in 2.0.0beta0.
857   Reported by several users.
858
859 * Added -v option to BackupPC_dump for verbose output (useful when
860   you run the command manually).  Added messages for all exits.
861
862 * If nmblookup returns multiple IP addresses, NetBiosHostIPFind()
863   now returns the first IP address that matches the subnet mask.
864   Suggested by Tim Demarest.
865
866 * Fixed BackupPC::View so the top-level directory is handled correctly.
867   This allows the top-level share/directory to be restored via the
868   CGI interface.  Reported by several users.
869
870 * Fixed RsyncFileIO failures on certain large files by replacing seek()
871   with sysseek().  Reported by Manfred Herrmann.
872
873 * Added configurable highlighting of PC status in the CGI summary
874   screen; submitted by Tim Demarest.
875
876 * Fixed command queue CGI display; submitted by Tim Demarest.
877
878 * BackupPC_trashClean now logs an error if it can't remove all the
879   trash and then goes back to sleep, rather than continually trying.
880
881 * Moved correct user (uid) check into BackupPC::Lib so that all
882   applications do a user check if $Cong{BackupPCUserVerify} is
883   set.  The avoids the risk of manually running BackupPC_dump as
884   the wrong user.
885
886 * Loss of blackout now applies to "host not found" as well as no ping.
887   Reported by Dale Renton.
888
889 * "Host not found" is now treated in a similar manner to "no ping".
890
891 * Added suse-linux init.d script from Leon Letto.
892
893 * Added Gentoo linux init.d script from Tim Demarest.
894
895 * Applied additional i18n strings from GFK and the translation team.
896
897 * Fixed option parsing so that getopts errors are reported and we exit.
898
899 * Changed reporting of Xfer PIDs so that rsync cancel works correctly.
900
901 #------------------------------------------------------------------------
902 # Version 2.0.0beta1, 30 Mar 2003
903 #------------------------------------------------------------------------
904
905 * Added Spanish translation es.pm from Javier Gonzalez.
906
907 * Fixed CGI browse navigation bug that causes BackupPC_Admin to wedge
908   when directories were selected in a certain order.
909
910 * Fixed BackupPC::PoolWrite so that it can recover when the initial
911   file size is wrong.  This is needed since rsync could write a file
912   whose size is different from the initial size returned in the
913   file list when that file is updated while rsync is running.
914
915 * Added binmode(STDIN) to BackupPC_tarExtract, suggested by Pat LoPresti
916   to fix a problem a RedHat8 with perl 5.8.0.  It's unclear why this
917   helps, but it should be benign.  See:
918     http://sourceforge.net/mailarchive/forum.php?thread_id=1853018&forum_id=503
919
920 #------------------------------------------------------------------------
921 # Version 2.0.0beta0, 23 Feb 2003
922 #------------------------------------------------------------------------
923
924 * Support for rsync and rsyncd backup and restore.  Changes to
925   BackupPC_dump, BackupPC_restore, and new modules BackupPC::Xfer::Rsync
926   and BackupPC::Xfer::RsyncFileIO.
927
928 * Added internationalization (i18n) code from Xavier Nicollet,
929   with additions from Guillaume Filion.  Voila!  BackupPC_Admin
930   now supports English and French, and adding more languages is
931   now easy.  New config paramater $Conf{Language} sets the language.
932
933 * Added optional user-defined pre/post dump/restore commands, allowing
934   things like database shutdown/startup for dumps.
935
936 * Changed the way hosts are found.
937
938 * Added $Conf{ClientNameAlias}, which allows the name of the physical
939   client machine to be set.  This allows several different backup
940   "hosts" to all refer to the same physical machine, which is
941   convenient if several different types of data need to be backed
942   up, or if different parameters are needed for different parts of
943   the host.
944
945 * Replaced $Conf{PingArgs} with $Conf{PingCmd}, added $Conf{DfCmd},
946   $Conf{NmbLookupCmd} allowing all these commands to be fully
947   configured.  Also, all commands can also now be fragments of
948   perl code.
949
950 * Moved all smbclient commands into the config.pl file so the specific
951   arguments can be customized.  New config parameters are
952   $Conf{SmbClientFullCmd}, $Conf{SmbClientIncrCmd} and
953   $Conf{SmbClientRestoreCmd}.
954
955 * Added new BackupPC::View module that creates views of backups
956   (handling merging etc).  Updated BackupPC_Admin, BackupPC_zipCreate
957   and BackupPC_tarCreate to use BackupPC::View.  This removes lots
958   of merging and mangling code from the higher-level code.
959
960 * Added code from Toby Johnson that allows additional users to be
961   specified in the hosts file; these users can also view/start/stop
962   and restore backups for that host.  Also added a new config
963   setting $Conf{CgiNavBarAdminAllHosts} that allows all hosts to
964   be listed in the left nav bar for admins.
965
966 * Added $Conf{HardLinkMax} (default 31999) which sets the limit on
967   the maximum number of hardlinks per file in the pool.  If a file
968   ever gets to this number of links a new pool file is created to
969   handle additional links.
970
971 * Added $Conf{PerlModuleLoad}, which allows optional additional perl
972   modules to be loaded.
973
974 * Added $Conf{EMailUserDestDomain} and other EMail config settings to
975   allow language-specific default messages to be overridden.
976
977 * Added BPC_FTYPE_DELETED to lib/BackupPC/Attrib.pm, allowing deleted
978   files to be represented in the attrib file correctly.
979
980 * Added support for environment variable BPC_SMB_PASSWD, which is the
981   client's smb password.  This overrides the old environment variable
982   PASSWD.
983
984 * Added taint cleanup for perl5.8 to lib/BackupPC/Lib.pm.
985
986 * Changed $tar_unpack_header format in BackupPC_tarExtract to correctly
987   handle files with trailing spaces.
988
989 * Added catching of SIG_PIPE to BackupPC_dump, and changed catch_signal
990   to ignore multiple signals of the same type.
991
992 * Added reporting of the largest number of hardlinks in the pool to the
993   log file.
994
995 * Adding reporting of syntax errors in the per-PC config.pl file.
996
997 * Updated BackupPC_sendEmail to handle language-specific email messages.
998
999 * Allow client (host) names to contain spaces.  Spaces in host names
1000   need to be escaped via "\" in the hosts file.  The user of spaces in
1001   host names is discouraged, but they should work.  One feature that
1002   doesn't work with host names that contain spaces is the highlighting
1003   of that name in the log file display in the CGI interface.  There are
1004   no plans to fix this.
1005
1006 * Renamed $Conf{SmbClientTimeout} to $Conf{ClientTimeout}.
1007
1008 * Fixed all open() calls to use 3 argument form to fix handling of file
1009   names with trailing whitespace.  Also fixed CGI interface so these
1010   file names are displayed correctly.
1011
1012 * Fixed new 2.0.0 CGI navigation bug that causes the top-level directory
1013   to have a URL "&share=//boot&dir=" instead of "&share=/boot&dir=/".
1014   Reported by Pascal Schelcher.  Fixed similar problem reported by
1015   Doug Lytle.
1016
1017 * Added "PerlTaintCheck On" to the mod_perl section in the docs,
1018   suggested by Tim Demarest.
1019
1020 #------------------------------------------------------------------------
1021 # Version 1.5.0, 2 Aug 2002
1022 #------------------------------------------------------------------------
1023
1024 * Changed conf/config.pl so that $Conf{TarIncrArgs} uses the --newer
1025   option instead of --newer-mtime.  Also removed --atime-preserve from
1026   $Conf{TarClientCmd}.  This makes the default settings work better
1027   with tripwire.
1028
1029 * Fixed configure.pl so it correctly detects a running BackupPC <= v1.4.0
1030   so it can correctly warn the user to stop it before upgrading.  Reported
1031   by David Holland.
1032
1033 * Added missing ";" to entity escape in EscapeHTML in BackupPC_Admin.
1034   Reported by Guillaume Filion.
1035
1036 * Added LDAP setup to documentation from David Holland.
1037
1038 * Tar.pm now adds a "." to file paths that start with "/", so that all
1039   tar paths are relative.  From Ludovic Drolez.
1040
1041 #------------------------------------------------------------------------
1042 # Version 1.5.0beta0, 30 Jun 2002
1043 #------------------------------------------------------------------------
1044
1045 * A full set of restore options is now supported, including direct
1046   restore via smbclient or tar or downloading a zip or tar file.
1047
1048 * Major additions to CGI script to support better directory navigation,
1049   restore features and mod_perl.  Also, file downloads from the CGI
1050   interface now correctly preserve the file name and provide the
1051   correct Content-Type for the most common types of files.  Improved
1052   directory navigation was contributed by Ryan Kucera.
1053
1054 * New script BackupPC_zipCreate (contributed by Guillaume Filion) is the
1055   zip analog of BackupPC_tarCreate.  BackupPC_zipCreate can be used to
1056   create a zip archive of any portion of a backup.
1057
1058 * Substantial additions to BackupPC_tarCreate to support restore,
1059   including modifying path names, handling hardlinks, fixing
1060   support of old backups without attributes (pre-v1.4.0).  Plus
1061   BackupPC_tarCreate is now an offical part of the release.
1062   (Lack of support for hardlinks was reported by John Stanley.)
1063
1064 * BackupPC_tarExtract now supports hardlinks and fixed pooling of
1065   attribute files.
1066
1067 * A unix domain socket is now used for communication between the CGI
1068   interface and BackupPC.  The original TCP socket is optional.  Sockets
1069   are correctly re-initialized if config.pl is updated with new socket
1070   settings.
1071
1072 * For improved security messages over the unix or TCP socket are protected
1073   via an MD5 digest based on a shared secret, a sequence number, a time
1074   stamp and a unique per-connection number.
1075
1076 * Additions to configure.pl to support install of directory navigation
1077   images.
1078
1079 * Fixed case where $Conf{BackupFilesOnly} or $Conf{BackupFilesExclude}
1080   were set to a single string or list (in v1.4.0 only the case of
1081   hash worked correctly).  Reported by Phillip Bertolus.
1082
1083 * Fixed case of $Conf{BackoutGoodCnt} == 0.  This setting now makes the
1084   client always subject to blackout, matching the comments in config.pl.
1085   Also fixed handling of $Conf{BackoutGoodCnt} < 0 in the CGI script
1086   reported by Pascal Schelcher.
1087
1088 * Fixed byte and file totals for tar backups, reported by several users.
1089
1090 * Fixed --newer-mtime date/timestamp format to make it ISO 8601 compliant,
1091   suggested by Erminio Baranzini.
1092
1093 * Fixed handling of $Conf{BackupFilesOnly} in BackupPC::Xfer::Tar.pm, as
1094   well as shell escaping of tar arguments.
1095
1096 * Fixed entity encoding of 8-bit characters in the CGI interface.
1097
1098 * Added optional CGI headers in $Conf{CgiHeaders} that by default
1099   is set to a no-cache pragma.  Suggested by Benno Zuure.
1100
1101 #------------------------------------------------------------------------
1102 # Version 1.4.0, 16 Mar 2002
1103 #------------------------------------------------------------------------
1104
1105 * BackupPC now supports tar (in addition to smb) for extracting host    
1106   data.  This is the most convenient option for linux/unix hosts.
1107   Tar can be configured to run over ssh, rsh or to backup a local
1108   nfs mount from the host.
1109
1110 * Support for special files, including symbolic links, fifo, character
1111   and block device files has been added, so that all native linux/unix
1112   file types can be correctly backed up when using tar transport.
1113   Special files are all stored as regular files and the type attributes
1114   are used to remember the original file type.
1115
1116 * All unix file attributes are now saved (and pooled when possible).
1117   This includes user and group ownership, permissions, and modification
1118   time.  Smbclient also does a reasonable job of emulating unix 
1119   permissions (such as mtime), and these attributes get saved too.
1120
1121 * The new default is to not fill incremental dumps.  configure.pl
1122   automatically sets $Conf{IncrFill} to 0.  The default was 1
1123   (incrementals were filled with hardlinks).  Since the CGI
1124   script does filling at browsing time, there is no need to
1125   fill incremental dumps.
1126
1127 * Backup file names are now stored in "mangled" form. Each node of a
1128   path is preceded by "f", and special characters (\n, \r, % and /) are
1129   URI-encoded as "%xx", where xx is the ascii character's hex value. So
1130   c:/craig/example.txt is now stored as fc/fcraig/fexample.txt. This
1131   was done mainly so meta-data could be stored alongside the backup
1132   files without name collisions.  In particular, the attributes for the
1133   files in a directory are stored in a file called "attrib", and
1134   mangling avoids file name collisions (I discarded the idea of having
1135   a duplicate directory tree for every backup just to store the
1136   attributes). Other meta-data (eg: rsync checksums) could be stored in
1137   file names preceded by, eg, "c".  There are two other benefits to
1138   mangling: the share name might contain "/" (eg: "/home/craig" for tar
1139   transport), and I wanted that represented as a single level in the
1140   storage tree.  Secondly, as files are written to NewFileList for later
1141   processing by BackupPC_link, embedded newlines in the file's path
1142   will cause problems which are avoided by mangling.
1143
1144   The CGI script undoes the mangling, so it is invisibe to the user.
1145   Of course, old (unmangled) backups are still supported by the CGI
1146   interface.
1147
1148 * Various changes to the CGI interface, BackupPC_Admin:
1149
1150   + Added button that allows users to manually start a full dump in
1151     addition to the existing incremental dump.
1152
1153   + Added display of file attributes when browsing backups.
1154
1155   + Added an optional holdoff time specified by the user when canceling
1156     a backup. BackupPC will not attempt any new backups for at least the
1157     specified time. This holdoff time can be changed whether or not a
1158     backup is running.
1159
1160   + Added supports for file mangling, and correct merging of unfilled
1161     backups from mangled or unmangled (and compressed or uncompressed)
1162     fulls when browsing or restoring.
1163
1164   + Only displays a "Start Incr Backup" button if there are already some
1165     backups.
1166
1167   + For DHCP hosts, when a user tries to manually start a backup, add
1168     a check for the netbios name of both the host the request came
1169     from (REMOTE_ADDR) and the last known DHCP address for that host
1170     to see if either address matches the host. If not, an error
1171     message is display. The previous behavior was that only requests
1172     from the client itself succeeded, and requests from other machines
1173     quietly failed.
1174
1175 * Changed the version numbering to X.Y.Z, instead of X.0Y. This release
1176   is 1.4.0. The first digit is for major new releases, the middle digit
1177   is for significant feature releases and improvements, and the last
1178   digit is for bug fixes. You should think of the old 1.00, 1.01, 1.02
1179   and 1.03 as 1.0.0, ..., 1.3.0.
1180
1181 * BackupPC and the CGI script BackupPC_Admin now check that the effective
1182   user id is correct to avoid accidentally launching BackupPC as the
1183   wrong user or detecting CGI configuration problems.  This behavior
1184   can be turned off using the $Conf{BackupPCUserVerify} option.
1185
1186 * In numerous places changed "Smb" to "Xfer" (eg: log file names) to
1187   support generic names for both smb and tar transport methods.  The
1188   CGI script checks for old names for backward compatibility.
1189
1190 * Major changed to Backup_dump to support new tar transport.  All transport
1191   specific code moved into BackupPC::Xfer::Smb and BackupPC::Xfer::Tar
1192   objects.
1193
1194 * Added workaround for a bug in Samba's smbclient for files between 2GB
1195   and 4GB.  The file size in the tar header is incorrect.  This allows
1196   files up to 4GB to work with smbclient, rather than 2GB.  To support
1197   files larger than 2GB you must make sure perl is compiled with the
1198   uselargefiles option (use "perl -V | egrep largefiles" to check) and
1199   the pool directory must be on a file system that supports large files.
1200
1201 * Moved the pool writing code into a module BackupPC::PoolWrite.  This
1202   allows the clever file pool checking (digest, uncompressing, comparing
1203   etc with minimum disk IO) to be used easily in multiple places (eg: it
1204   is now used for writing attribute files so they can be pooled).
1205
1206 * Changed MD5 to Digest::MD5 to avoid use of the depreceated MD5 module.
1207
1208 * Shortened default $Conf{MyPath} so that perl's taint mode is more likely
1209   to be happy.  The old $Conf{MyPath} contained /usr/local/bin, which
1210   on one user's machine was world writable and perl -T correctly
1211   complained about it.
1212
1213 * Fixed ping command options in Lib.pm so that it works on OpenBSD.
1214   Thanks to Kyle Amon for sending the fix.  Decided to move the
1215   ping options from Lib.pm into config.pl (as $Conf{PingArgs}) and
1216   now configure.pl tries to come up with a sensible default based on
1217   the OS.
1218
1219 * Fixed argument checking in BackupPC_tarExtract to allow '$' in the
1220   share name (eg: C$).  Thanks to Jules Agee for this fix.  Also
1221   changed the default config.pl so that single quotes are used
1222   everywhere so that people don't get tripped up putting '$' inside
1223   double-quoted strings.
1224
1225 #------------------------------------------------------------------------
1226 # Version 1.03, 9 Dec 2001
1227 #------------------------------------------------------------------------
1228
1229 * BackupPC now has full support for compression.  There are now two
1230   pool areas, the original pool for uncompressed files, and cpool for
1231   compressed files. The compression is done by Compress::Zlib.
1232   Compression reduces the pool disk usage by around 40%, although your
1233   mileage may vary.  Compression is optional and can also be specified on
1234   a per-PC basis (although this will cost more pool storage since many
1235   backup files will have to be stored in both compressed and
1236   uncompressed forms.
1237
1238 * A new script, BackupPC_compressPool, can be run to compress the entire
1239   pool.  This is used once to migrate all the pool data from uncompressed
1240   to compressed on existing installations.  Read the documentation
1241   (Installing BackupPC/Compressing an existing pool) before running
1242   BackupPC_compressPool!
1243
1244   Alternatively, compression can simply be turned on and all new backups
1245   will be compressed. Both old (uncompressed) and new (compressed)
1246   backups can be browsed and viewed. Eventually, the old backups will
1247   expire and all the pool data will be compressed.  However, until the
1248   old backups expire, this approach could require 60% or more additional
1249   pool storage space to store both uncompressed and compressed versions
1250   of the backup files.
1251
1252 * Significant improvements to the cgi interface, BackupPC_Admin:
1253
1254     - much better layout navigation
1255     - handles compressed backup files and compressed log files
1256     - handles unfilled incremental dumps
1257     - better backup directory browsing navigation
1258     - reports compression statistics
1259     - $Conf{CgiDateFormatMMDD} allows you to set date format (MM/DD or DD/MM)
1260     - Additional customization with $Conf{CgiHeaderFontType},
1261       $Conf{CgiHeaderFontSize}, $Conf{CgiNavBarBgColor}, and
1262       $Conf{CgiHeaderBgColor}.
1263
1264 * Eliminated BackupPC_queueAll.  BackupPC directly reads the hosts
1265   file and queues the PCs itself.  Like config.pl, BackupPC will
1266   re-read the hosts file on each wakeup if its modification time
1267   changes, or upon a SIGHUP.  This also makes for better behavior
1268   when adding a host: if you add hosts, simply send a SIGHUP to
1269   BackupPC or wait for the next wakeup.
1270
1271 * BackupPC_dump now compresses the SmbLOG file if compression is enabled.
1272
1273 * BackupPC_dump keeps track of compressed file sizes so that compression
1274   statistics can be reported by the cgi interface.
1275
1276 * Aging of old log files now handles compressed log files (.z extension).
1277
1278 * Added configuration option $Conf{IncrFill} to specify whether
1279   incremental dumps should be filled in.  Old behavior was that
1280   filling was on.  Now it's optional.  See config.pl for more
1281   details.
1282
1283 * BackupPC_nightly now cleans and generates statistics for both
1284   the uncompressed pool and compressed pool (cpool).
1285
1286 * Added new utility script BackupPC_zcat that can be used to
1287   uncompresses BackupPC files.
1288
1289 * configure.pl offers various options related to compression,
1290   depending upon whether this is a new install or upgrade,
1291   and whether or not Compress::Zlib is installed.
1292
1293 * configure.pl now makes a backup copy of config.pl before
1294   config.pl is updated.
1295
1296 * added three new fields to the backups file to handle optional
1297   filling and compression stats.
1298
1299 * Added -e option to BackupPC_dump.  BackupPC now invokes BackupPC_dump -e
1300   on each dhcp host once each night to verify that very old backups are
1301   expired.  This ensures that very old backups are expired even if
1302   the dhcp host has not been on the network for a long time.
1303
1304 * fixed bug in BackupPC::FileZIO.pm that required Compress::Zlib,
1305   even if compression was off.  Thanks to Steve Holmes for reporting
1306   this.
1307
1308 * fixed bug that caused a BackupPC queue to get blocked when a backup
1309   cancel attempt was made during the BackupPC_link phase.
1310
1311 #------------------------------------------------------------------------
1312 # Version 1.02, 28 Oct 2001.
1313 #------------------------------------------------------------------------
1314
1315 * Added new script BackupPC_tarExtract to extract the smbclient tar
1316   archive. This reduces disk writes by perhaps 90-95% and disk reads by
1317   50%. Previously, tar was used to extract and write everything to disk.
1318   Then BackupPC_dump would read enough of each file to compute the MD5
1319   digest, and then compare the full file with candidate pool files.  So
1320   for each 1MB file that matches a single file in the pool, there would
1321   be 1MB of disk writes and 2MB of disk reads (to compare two 1MB files).
1322
1323   BackupPC_tarExtract instead extracts the archive using a 1MB memory
1324   buffer.  This allows the MD5 digest to be computed without touching the
1325   disk.  Next, any potential pool file compares are done by comparing the
1326   pool file against the incoming tar data in memory, which only requires
1327   the pool file to be read.  So for each 1MB file that matches a single
1328   file in the pool, there are now no disk writes, and only 1MB of reads.
1329   BackupPC_tarExtract handles arbitrary size files and repeated
1330   potential pool matches.  If the incoming file doesn't match the pool
1331   then it is written to disk (once the pool is mature this happens maybe
1332   5-10% of the time).
1333
1334 * Substantial changes to BackupPC_dump:
1335
1336     + BackupPC_tarExtract is now used in place of tar.
1337
1338     + BackupPC_dump now reads the output from both smbclient and
1339       BackupPC_tarExtract and merges them into SmbLOG.
1340
1341     + Named pipes are no longer used to connect smbclient to tar
1342       (now BackupPC_tarExtract).  Regular pipes are used instead.
1343       This avoids the need to system mknod or mkfifo.
1344
1345     + Locked files on the client that can't be read by smbclient
1346       previously were filled with 0x0 bytes by smbclient, meaning
1347       tar extracted a useless file filled with 0x0 bytes.  Now,
1348       BackupPC_dump watches the output of smbclient and removes
1349       any files that smbclient couldn't read.  This avoids storing
1350       useless files.  It tries to replace such files with a hard link
1351       to a previous dump.  These actions appear in the log file.
1352
1353 * added new module lib/BackupPC/FileZIO.pm. This handles pool file
1354   I/O and is used by BackupPC_tarExtract.  BackupPC::FileIO supports
1355   reading and writing compressed and regular files and provides all the
1356   hooks for compression support in BackupPC (should be supported in next
1357   version). BackupPC::FileIO also does efficient writing of files that
1358   contain leading 0x0 bytes (by seeking past the 0x0 bytes). This is
1359   helpful when smbclient reads a locked file, and it fills the tar
1360   output with a file of the correct size but all 0x0.  Such files will be
1361   later removed by BackupPC_dump.  But in the meantime, BackupPC::FileIO
1362   writes such files efficiently (as sparse files), meaning just a few
1363   blocks of disk space will be needed even if the file is large.
1364
1365 * alive/dead counting for blackout now works correctly for DHCP hosts.
1366
1367 * BackupPC resets activeJob on startup, to fix bug when BackupPC was
1368   killed and restarted with backups running.
1369
1370 * added extra non blocking select() in BackupPC to make sure the socket
1371   reads don't block.
1372
1373 * BackupPC avoids queuing multiple BackupPC_queueAll's on the CmdQueue.
1374
1375 * Updated BackupPC_sendEmail to correctly parse the locked file
1376   error from 2.2.1a smbclient, so that missing Outlook file emails
1377   can be correctly sent.
1378
1379 * Changed HostInfoRead() in lib/BackupPC/Lib.pm to lowercase the
1380   hostname read from the hosts file.
1381
1382 * BackupPC_Admin provides general summary when the host name is empty.
1383
1384 * configure.pl (and BackupPC) now requires perl 5.6.0 or later.
1385
1386 * configure.pl complains if BackupPC is already running, reminding you
1387   to stop it before upgrading.
1388
1389 * updated documentation, and fixed auto-insertion of config.pl into
1390   BackupPC.pod (previously the last config parameter was left out of
1391   BackupPC.pod).
1392
1393 #------------------------------------------------------------------------
1394 # Version 1.01, 30 Sep 2001
1395 #------------------------------------------------------------------------
1396
1397 * Documentation cleanup in README, doc/BackupPC.pod, conf/config.pl.
1398
1399 * BackupPC_sendMail now reads the optional per-PC config file, allowing
1400   email configuration parameters to be set on a per-PC basis.
1401
1402 * Removed the unused 4096-length MD5 digest code in lib/BackupPC/Lib.pm.
1403
1404 #------------------------------------------------------------------------
1405 # Version 1.00, 21 Sep 2001
1406 #------------------------------------------------------------------------
1407
1408 * Initial release of BackupPC on sourceforge.net.