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