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