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