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