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