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