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