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