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