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