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 * A failed full dump is now saved as a partial (incomplete) dump,
  25   provided it includes some files.  This can be used for browsing,
  26   restoring etc, and will also form the basis of resuming full
  27   dumps.  Only one partial is kept, and it is removed as soon
  28   as a successful full (or a new partial) is done.
  29
  30 * Added support for resuming a full dump for rsync.  The partial
  31   full is kept, and to resume an incremental is done against the
  32   partial, and a full is done for the rest.
  33
  34 * Added support for Rsync checksum caching.  Rsync checksum are
  35   appended to the compressed pool files.  This means that block
  36   and file checksums do not need to be recomputed on the server
  37   when using rsync.  Requires a patch to rsync to support fixed
  38   checksum seeds.  This patch is included in the cygwin-rsyncd
  39   release on http://backuppc.sourceforge.net.
  40
  41 * Major addition of Archive feature from Josh Marshall.  Special
  42   clients can be configured to be archive targets (eg: tape drives,
  43   CD-R).  Any subset of the backup clients can be selected and tar
  44   archives are created, optionally compressed and split and written
  45   to the output device.  Logs are maintained and are browsable.
  46
  47 * Major changes from Ryan Kucera to add style sheets to the CGI
  48   interface, allowing easy customization.  Added new icons and
  49   BackupPC logo.  Numerous navigation improvements.
  50
  51 * Added directory history display to BackupPC_Admin, allowing the
  52   user to quickly see which files changed between backups on a
  53   per-directory basis.
  54
  55 * Added exponential expiry option for full dumps.  This allows you
  56   to specify
  57
  58    - how many fulls to keep at intervals of $Conf{FullPeriod}, followed by
  59    - how many fulls to keep at intervals of 2 * $Conf{FullPeriod},
  60    - how many fulls to keep at intervals of 4 * $Conf{FullPeriod},
  61    - how many fulls to keep at intervals of 8 * $Conf{FullPeriod},
  62    - how many fulls to keep at intervals of 16 * $Conf{FullPeriod},
  63
  64   and so on.  This allows you, for example, to keep 4 weekly fulls,
  65   followed by 6 fulls every 4 weeks (approx 1 month) and 2 fulls at
  66   16 weeks, for roughly 1 year of history.  This works by deleting
  67   every other full as each expiry boundary is crossed.  Suggested
  68   by David Cramblett.
  69
  70 * Added Italian language translation it.pm from Lorenzo Cappelletti.
  71
  72 * Major updates to language files for new features and tags changes.
  73   Updated makeDist to do pedantic consistency checking of language
  74   files.
  75
  76 * Addition of administration options from Paul Lukins.  Initial
  77   page allows server to be started/stopped/reloaded.  This still
  78   needs some i18n work.  Currently the server start/stop is
  79   commented out.
  80
  81 * Split BackupPC_Admin into a set of modules, one for each major action.
  82   Each action is now a seperate module in lib/BackupPC/CGI.
  83
  84 * Allow the blackout period begin/end to span midnight.  Adapted
  85   from patch submitted by David Smith.
  86
  87 * Allow multiple blackout periods, with new config variable
  88   $Conf{BlackoutPeriods} that replaces the old variables
  89   $Conf{BlackoutHourBegin}, $Conf{BlackoutHourEnd}, and
  90   $Conf{BlackoutWeekDays}.  Based on patch submitted by
  91   Lorenzo Cappelletti.
  92
  93 * Disabled alarms after forks to avoid timeouts in children that
  94   do not reset their alarm.  Prompted by ideas from James Leu.
  95
  96 * Added options for block size, buffer size and share wild-card to
  97   BackupPC_tarCreate.  Also added negative backup number options
  98   that are relative to the last (so -1 is the last), suggested by
  99   William McKee and Carl Soderstrom.
 100
 101 * Add creation of per-PC directory in BackupPC/CGI/Restore.pm in
 102   case it doesn't already exist.
 103
 104 * Added -q -x to all ssh commands in conf/config.pl.  Suggested by
 105   SI Reasoning and Niranjan Ghate.
 106
 107 * Changed restore code so that option #1 (direct restore) can be
 108   disabled if the restore command is undefined.  Disabling direct
 109   restore is necessary if the share is read-only.  Suggested by
 110   Rich B from SAIC.
 111
 112 * Changed regexp in lib/BackupPC/Smb.pm to allow numbers with both
 113   a decimal point or comma for international versions of Samba.
 114   Patch submitted by Frank Gard.
 115
 116 * Browsing and directory history now sort the files in a
 117   case-insensitive manner.
 118
 119 * Changed exec() syntax to allow executing commands whose path
 120   contains spaces.
 121
 122 * Swapped the Server and Hosts sections on the Nav bar.  Moved the
 123   host search text box to the top of the hosts section.  This was
 124   done to move the variable-length part of the Nav bar (when all
 125   hosts are displayed) to the bottom.
 126
 127 * Fixed a bug in tar restore related to how the common prefix path is
 128   removed.  Now ensure that the common path is at a directory boundary.
 129   Reported by Patrick Neuner.
 130
 131 * Added --chuid ${USER} to init.d/src/gentoo-backuppc.  Suggested by
 132   SI Reasoning, Pascal Pochol, Michael Evanoff and others.
 133
 134 * Added Suse notes to init.d/README from Bruno Vernay.
 135
 136 * Added Apache 2 documentation fix from Michael Tuzi.
 137
 138 #------------------------------------------------------------------------
 139 # Version 2.0.2, 6 Oct 2003
 140 #------------------------------------------------------------------------
 141
 142 * Fixed stupid last-minute change in octal size conversion in
 143   Backup_tarExtract.
 144
 145 #-----------------------------------------------------------------------
 146 # Version 2.0.1, 5 Oct 2003
 147 #------------------------------------------------------------------------
 148
 149 * Fixed handling of >= 8GB files in BackupPC_tarExtract and >= 4GB
 150   files in BackupPC_tarCreate.
 151
 152 * Removed smbclient size repair in BackupPC_tarExtract for files
 153   between 2GB and 4GB.  This means that BackupPC_tarExtract 2.0.1
 154   doesn't behave the same as 2.0.0 for file sizes between 2GB and 4GB
 155   extacted using smbclient 2.2.x.  If you have problems backing up
 156   files whose size is between 2GB and 4GB using smbclient 2.2.x
 157   you should upgrade smbclient to 3.0, since it now generates
 158   correct file sizes.
 159
 160 * Replace PingClientPath with PingPath in configure.pl.
 161
 162 * Removed -T (taint mode) on binaries installed in configure.pl.
 163
 164 * Added support for smbclient from samba version 3.0.0.
 165
 166 * Fixed $Conf{HardLinkMax} limit check in BackupPC::Lib; reported
 167   by Ross Skaliotis.
 168
 169 * In BackupPC_Admin, default REMOTE_USER to $Conf{BackupPCUser}
 170   if it is not defined.  This allows the CGI interface to work
 171   when AdminUsers = '*'.  Reported by Quentin Arce.
 172
 173 * For SMB, code that detected files with a read-locked region (eg:
 174   outlook .pst files), removed them and then tried to link with an
 175   earlier version was broken.  This code missed a step of mangling
 176   the file names.  This is now fixed.  Reported by Pierre Bourgin.
 177
 178 * A backup of a share that has zero files is now considered
 179   fatal. This is used to catch miscellaneous Xfer errors that
 180   result in no files being backed up.  A new config parameter
 181   $Conf{BackupZeroFilesIsFatal} (defaults to 1) and can be set to
 182   zero to turn off this check.  Suggested by Guillaume Filion.
 183   Additional change: this check only applies to a full dump.
 184
 185 * SMB: now detect NT_STATUS_ACCESS_DENIED on entire share or BackupFilesOnly
 186   (also ERRDOS - ERRnoaccess (Access denied.) for older versions of
 187   smbclient.)  Suggested by Guillaume Filion.
 188
 189 * SMB: now detects "tree connect failed: NT_STATUS_BAD_NETWORK_NAME" and
 190   the dump is considered failed.
 191
 192 * Rsync: Previously BackupFilesOnly = '/' did --include '/' --exclude '/*',
 193   which just included the '/' directory and nothing below.  Now it
 194   does just --include '/', which should include everything.
 195   Reported by denon.
 196
 197 * Add hostError to DumpPostUserCmd variable substitutions for both dump
 198   and restore.
 199
 200 * Verbose output in Lib.pm goes to STDERR, not STDOUT.  This now
 201   makes BackupPC_dump -v work better.
 202
 203 * Don't allow browsing with ".." in directory in case a user tries
 204   to trick BackupPC_Admin into displaying directories outside where
 205   they are allowed.
 206
 207 * Required File::RsyncP version is now 0.44, since File::RsyncP 0.44
 208   fixes large file (>2GB) bugs.  Large file bugs reported by Steve
 209   Waltner.
 210
 211 #------------------------------------------------------------------------
 212 # Version 2.0.0, 14 Jun 2003
 213 #------------------------------------------------------------------------
 214
 215 * Minor tweaks to disable utf8 on utf8-capable machines (eg: RH8+).
 216   Added "no utf8" to all programs, and added binmode() to relevant
 217   file handles.
 218
 219 #------------------------------------------------------------------------
 220 # Version 2.0.0beta3, 1 Jun 2003
 221 #------------------------------------------------------------------------
 222
 223 * Several improvements to restore: cancel now reports the correct
 224   message and cleans up correctly.
 225
 226 * Rsync with whitespace and wildcard excludes fixed by replacing
 227   argList with argList+ in config.pl plus a fix to Lib.pm for
 228   shell escaping array arguments.
 229
 230 * Fixed rsync restore for character and block special devices
 231   (major and minor device numbers weren't correctly restored).
 232
 233 * Fixed typo in bin/BackupPC_restore (XferLOG -> RestoreLOG).
 234
 235 * (Re)-fixed "Bad command" in log file when restore via tar or zip
 236   file download is done.
 237
 238 * Added untaint to exec in Lib.pm to avoid tainted errors.
 239
 240 * Applied additional tweak to hilight patch from Tim Demarest.
 241
 242 * $Conf{CgiAdminUsers} = '*' now allows privileged even with REMOTE_USER
 243   not set.
 244
 245 * Don't display RsyncdPasswd when displaying config.pl files.
 246
 247 * Replace pipe with socketpair in bin/BackupPC_dump and bin/BackupPC_restore,
 248   which increases typical buffering from 4K to 16K-64K.  This improves the
 249   performance.
 250
 251 * Add check on $ENV{LANG} setting do configure.pl: if LANG includes utf
 252   then a warning is printed.
 253
 254 #------------------------------------------------------------------------
 255 # Version 2.0.0beta2, 11 May 2003
 256 #------------------------------------------------------------------------
 257
 258 * Added German translation, provided by Manfred Herrmann.
 259
 260 * Fixed large-file problem with rsync, reported by Manfred Herrmann.
 261
 262 * Fixed zip and tar file download from CGI under mod_perl.  Reported
 263   by Pierre Bourgin and Paul Lukins.
 264
 265 * Fixed directory browsing and top-level directory browsing in 2.0.0beta0.
 266   Reported by several users.
 267
 268 * Added -v option to BackupPC_dump for verbose output (useful when
 269   you run the command manually).  Added messages for all exits.
 270
 271 * If nmblookup returns multiple IP addresses, NetBiosHostIPFind()
 272   now returns the first IP address that matches the subnet mask.
 273   Suggested by Tim Demarest.
 274
 275 * Fixed BackupPC::View so the top-level directory is handled correctly.
 276   This allows the top-level share/directory to be restored via the
 277   CGI interface.  Reported by several users.
 278
 279 * Fixed RsyncFileIO failures on certain large files by replacing seek()
 280   with sysseek().  Reported by Manfred Herrmann.
 281
 282 * Added configurable highlighting of PC status in the CGI summary
 283   screen; submitted by Tim Demarest.
 284
 285 * Fixed command queue CGI display; submitted by Tim Demarest.
 286
 287 * BackupPC_trashClean now logs an error if it can't remove all the
 288   trash and then goes back to sleep, rather than continually trying.
 289
 290 * Moved correct user (uid) check into BackupPC::Lib so that all
 291   applications do a user check if $Cong{BackupPCUserVerify} is
 292   set.  The avoids the risk of manually running BackupPC_dump as
 293   the wrong user.
 294
 295 * Loss of blackout now applies to "host not found" as well as no ping.
 296   Reported by Dale Renton.
 297
 298 * "Host not found" is now treated in a similar manner to "no ping".
 299
 300 * Added suse-linux init.d script from Leon Letto.
 301
 302 * Added Gentoo linux init.d script from Tim Demarest.
 303
 304 * Applied additional i18n strings from GFK and the translation team.
 305
 306 * Fixed option parsing so that getopts errors are reported and we exit.
 307
 308 * Changed reporting of Xfer PIDs so that rsync cancel works correctly.
 309
 310 #------------------------------------------------------------------------
 311 # Version 2.0.0beta1, 30 Mar 2003
 312 #------------------------------------------------------------------------
 313
 314 * Added Spanish translation es.pm from Javier Gonzalez.
 315
 316 * Fixed CGI browse navigation bug that causes BackupPC_Admin to wedge
 317   when directories were selected in a certain order.
 318
 319 * Fixed BackupPC::PoolWrite so that it can recover when the initial
 320   file size is wrong.  This is needed since rsync could write a file
 321   whose size is different from the initial size returned in the
 322   file list when that file is updated while rsync is running.
 323
 324 * Added binmode(STDIN) to BackupPC_tarExtract, suggested by Pat LoPresti
 325   to fix a problem a RedHat8 with perl 5.8.0.  It's unclear why this
 326   helps, but it should be benign.  See:
 327     http://sourceforge.net/mailarchive/forum.php?thread_id=1853018&forum_id=503
 328
 329 #------------------------------------------------------------------------
 330 # Version 2.0.0beta0, 23 Feb 2003
 331 #------------------------------------------------------------------------
 332
 333 * Support for rsync and rsyncd backup and restore.  Changes to
 334   BackupPC_dump, BackupPC_restore, and new modules BackupPC::Xfer::Rsync
 335   and BackupPC::Xfer::RsyncFileIO.
 336
 337 * Added internationalization (i18n) code from Xavier Nicollet,
 338   with additions from Guillaume Filion.  Voila!  BackupPC_Admin
 339   now supports English and French, and adding more languages is
 340   now easy.  New config paramater $Conf{Language} sets the language.
 341
 342 * Added optional user-defined pre/post dump/restore commands, allowing
 343   things like database shutdown/startup for dumps.
 344
 345 * Changed the way hosts are found.
 346
 347 * Added $Conf{ClientNameAlias}, which allows the name of the physical
 348   client machine to be set.  This allows several different backup
 349   "hosts" to all refer to the same physical machine, which is
 350   convenient if several different types of data need to be backed
 351   up, or if different parameters are needed for different parts of
 352   the host.
 353
 354 * Replaced $Conf{PingArgs} with $Conf{PingCmd}, added $Conf{DfCmd},
 355   $Conf{NmbLookupCmd} allowing all these commands to be fully
 356   configured.  Also, all commands can also now be fragments of
 357   perl code.
 358
 359 * Moved all smbclient commands into the config.pl file so the specific
 360   arguments can be customized.  New config parameters are
 361   $Conf{SmbClientFullCmd}, $Conf{SmbClientIncrCmd} and
 362   $Conf{SmbClientRestoreCmd}.
 363
 364 * Added new BackupPC::View module that creates views of backups
 365   (handling merging etc).  Updated BackupPC_Admin, BackupPC_zipCreate
 366   and BackupPC_tarCreate to use BackupPC::View.  This removes lots
 367   of merging and mangling code from the higher-level code.
 368
 369 * Added code from Toby Johnson that allows additional users to be
 370   specified in the hosts file; these users can also view/start/stop
 371   and restore backups for that host.  Also added a new config
 372   setting $Conf{CgiNavBarAdminAllHosts} that allows all hosts to
 373   be listed in the left nav bar for admins.
 374
 375 * Added $Conf{HardLinkMax} (default 31999) which sets the limit on
 376   the maximum number of hardlinks per file in the pool.  If a file
 377   ever gets to this number of links a new pool file is created to
 378   handle additional links.
 379
 380 * Added $Conf{PerlModuleLoad}, which allows optional additional perl
 381   modules to be loaded.
 382
 383 * Added $Conf{EMailUserDestDomain} and other EMail config settings to
 384   allow language-specific default messages to be overridden.
 385
 386 * Added BPC_FTYPE_DELETED to lib/BackupPC/Attrib.pm, allowing deleted
 387   files to be represented in the attrib file correctly.
 388
 389 * Added support for environment variable BPC_SMB_PASSWD, which is the
 390   client's smb password.  This overrides the old environment variable
 391   PASSWD.
 392
 393 * Added taint cleanup for perl5.8 to lib/BackupPC/Lib.pm.
 394
 395 * Changed $tar_unpack_header format in BackupPC_tarExtract to correctly
 396   handle files with trailing spaces.
 397
 398 * Added catching of SIG_PIPE to BackupPC_dump, and changed catch_signal
 399   to ignore multiple signals of the same type.
 400
 401 * Added reporting of the largest number of hardlinks in the pool to the
 402   log file.
 403
 404 * Adding reporting of syntax errors in the per-PC config.pl file.
 405
 406 * Updated BackupPC_sendEmail to handle language-specific email messages.
 407
 408 * Allow client (host) names to contain spaces.  Spaces in host names
 409   need to be escaped via "\" in the hosts file.  The user of spaces in
 410   host names is discouraged, but they should work.  One feature that
 411   doesn't work with host names that contain spaces is the highlighting
 412   of that name in the log file display in the CGI interface.  There are
 413   no plans to fix this.
 414
 415 * Renamed $Conf{SmbClientTimeout} to $Conf{ClientTimeout}.
 416
 417 * Fixed all open() calls to use 3 argument form to fix handling of file
 418   names with trailing whitespace.  Also fixed CGI interface so these
 419   file names are displayed correctly.
 420
 421 * Fixed new 2.0.0 CGI navigation bug that causes the top-level directory
 422   to have a URL "&share=//boot&dir=" instead of "&share=/boot&dir=/".
 423   Reported by Pascal Schelcher.  Fixed similar problem reported by
 424   Doug Lytle.
 425
 426 * Added "PerlTaintCheck On" to the mod_perl section in the docs,
 427   suggested by Tim Demarest.
 428
 429 #------------------------------------------------------------------------
 430 # Version 1.5.0, 2 Aug 2002
 431 #------------------------------------------------------------------------
 432
 433 * Changed conf/config.pl so that $Conf{TarIncrArgs} uses the --newer
 434   option instead of --newer-mtime.  Also removed --atime-preserve from
 435   $Conf{TarClientCmd}.  This makes the default settings work better
 436   with tripwire.
 437
 438 * Fixed configure.pl so it correctly detects a running BackupPC <= v1.4.0
 439   so it can correctly warn the user to stop it before upgrading.  Reported
 440   by David Holland.
 441
 442 * Added missing ";" to entity escape in EscapeHTML in BackupPC_Admin.
 443   Reported by Guillaume Filion.
 444
 445 * Added LDAP setup to documentation from David Holland.
 446
 447 * Tar.pm now adds a "." to file paths that start with "/", so that all
 448   tar paths are relative.  From Ludovic Drolez.
 449
 450 #------------------------------------------------------------------------
 451 # Version 1.5.0beta0, 30 Jun 2002
 452 #------------------------------------------------------------------------
 453
 454 * A full set of restore options is now supported, including direct
 455   restore via smbclient or tar or downloading a zip or tar file.
 456
 457 * Major additions to CGI script to support better directory navigation,
 458   restore features and mod_perl.  Also, file downloads from the CGI
 459   interface now correctly preserve the file name and provide the
 460   correct Content-Type for the most common types of files.  Improved
 461   directory navigation was contributed by Ryan Kucera.
 462
 463 * New script BackupPC_zipCreate (contributed by Guillaume Filion) is the
 464   zip analog of BackupPC_tarCreate.  BackupPC_zipCreate can be used to
 465   create a zip archive of any portion of a backup.
 466
 467 * Substantial additions to BackupPC_tarCreate to support restore,
 468   including modifying path names, handling hardlinks, fixing
 469   support of old backups without attributes (pre-v1.4.0).  Plus
 470   BackupPC_tarCreate is now an offical part of the release.
 471   (Lack of support for hardlinks was reported by John Stanley.)
 472
 473 * BackupPC_tarExtract now supports hardlinks and fixed pooling of
 474   attribute files.
 475
 476 * A unix domain socket is now used for communication between the CGI
 477   interface and BackupPC.  The original TCP socket is optional.  Sockets
 478   are correctly re-initialized if config.pl is updated with new socket
 479   settings.
 480
 481 * For improved security messages over the unix or TCP socket are protected
 482   via an MD5 digest based on a shared secret, a sequence number, a time
 483   stamp and a unique per-connection number.
 484
 485 * Additions to configure.pl to support install of directory navigation
 486   images.
 487
 488 * Fixed case where $Conf{BackupFilesOnly} or $Conf{BackupFilesExclude}
 489   were set to a single string or list (in v1.4.0 only the case of
 490   hash worked correctly).  Reported by Phillip Bertolus.
 491
 492 * Fixed case of $Conf{BackoutGoodCnt} == 0.  This setting now makes the
 493   client always subject to blackout, matching the comments in config.pl.
 494   Also fixed handling of $Conf{BackoutGoodCnt} < 0 in the CGI script
 495   reported by Pascal Schelcher.
 496
 497 * Fixed byte and file totals for tar backups, reported by several users.
 498
 499 * Fixed --newer-mtime date/timestamp format to make it ISO 8601 compliant,
 500   suggested by Erminio Baranzini.
 501
 502 * Fixed handling of $Conf{BackupFilesOnly} in BackupPC::Xfer::Tar.pm, as
 503   well as shell escaping of tar arguments.
 504
 505 * Fixed entity encoding of 8-bit characters in the CGI interface.
 506
 507 * Added optional CGI headers in $Conf{CgiHeaders} that by default
 508   is set to a no-cache pragma.  Suggested by Benno Zuure.
 509
 510 #------------------------------------------------------------------------
 511 # Version 1.4.0, 16 Mar 2002
 512 #------------------------------------------------------------------------
 513
 514 * BackupPC now supports tar (in addition to smb) for extracting host
 515   data.  This is the most convenient option for linux/unix hosts.
 516   Tar can be configured to run over ssh, rsh or to backup a local
 517   nfs mount from the host.
 518
 519 * Support for special files, including symbolic links, fifo, character
 520   and block device files has been added, so that all native linux/unix
 521   file types can be correctly backed up when using tar transport.
 522   Special files are all stored as regular files and the type attributes
 523   are used to remember the original file type.
 524
 525 * All unix file attributes are now saved (and pooled when possible).
 526   This includes user and group ownership, permissions, and modification
 527   time.  Smbclient also does a reasonable job of emulating unix
 528   permissions (such as mtime), and these attributes get saved too.
 529
 530 * The new default is to not fill incremental dumps.  configure.pl
 531   automatically sets $Conf{IncrFill} to 0.  The default was 1
 532   (incrementals were filled with hardlinks).  Since the CGI
 533   script does filling at browsing time, there is no need to
 534   fill incremental dumps.
 535
 536 * Backup file names are now stored in "mangled" form. Each node of a
 537   path is preceded by "f", and special characters (\n, \r, % and /) are
 538   URI-encoded as "%xx", where xx is the ascii character's hex value. So
 539   c:/craig/example.txt is now stored as fc/fcraig/fexample.txt. This
 540   was done mainly so meta-data could be stored alongside the backup
 541   files without name collisions.  In particular, the attributes for the
 542   files in a directory are stored in a file called "attrib", and
 543   mangling avoids file name collisions (I discarded the idea of having
 544   a duplicate directory tree for every backup just to store the
 545   attributes). Other meta-data (eg: rsync checksums) could be stored in
 546   file names preceded by, eg, "c".  There are two other benefits to
 547   mangling: the share name might contain "/" (eg: "/home/craig" for tar
 548   transport), and I wanted that represented as a single level in the
 549   storage tree.  Secondly, as files are written to NewFileList for later
 550   processing by BackupPC_link, embedded newlines in the file's path
 551   will cause problems which are avoided by mangling.
 552
 553   The CGI script undoes the mangling, so it is invisibe to the user.
 554   Of course, old (unmangled) backups are still supported by the CGI
 555   interface.
 556
 557 * Various changes to the CGI interface, BackupPC_Admin:
 558
 559   + Added button that allows users to manually start a full dump in
 560     addition to the existing incremental dump.
 561
 562   + Added display of file attributes when browsing backups.
 563
 564   + Added an optional holdoff time specified by the user when canceling
 565     a backup. BackupPC will not attempt any new backups for at least the
 566     specified time. This holdoff time can be changed whether or not a
 567     backup is running.
 568
 569   + Added supports for file mangling, and correct merging of unfilled
 570     backups from mangled or unmangled (and compressed or uncompressed)
 571     fulls when browsing or restoring.
 572
 573   + Only displays a "Start Incr Backup" button if there are already some
 574     backups.
 575
 576   + For DHCP hosts, when a user tries to manually start a backup, add
 577     a check for the netbios name of both the host the request came
 578     from (REMOTE_ADDR) and the last known DHCP address for that host
 579     to see if either address matches the host. If not, an error
 580     message is display. The previous behavior was that only requests
 581     from the client itself succeeded, and requests from other machines
 582     quietly failed.
 583
 584 * Changed the version numbering to X.Y.Z, instead of X.0Y. This release
 585   is 1.4.0. The first digit is for major new releases, the middle digit
 586   is for significant feature releases and improvements, and the last
 587   digit is for bug fixes. You should think of the old 1.00, 1.01, 1.02
 588   and 1.03 as 1.0.0, ..., 1.3.0.
 589
 590 * BackupPC and the CGI script BackupPC_Admin now check that the effective
 591   user id is correct to avoid accidentally launching BackupPC as the
 592   wrong user or detecting CGI configuration problems.  This behavior
 593   can be turned off using the $Conf{BackupPCUserVerify} option.
 594
 595 * In numerous places changed "Smb" to "Xfer" (eg: log file names) to
 596   support generic names for both smb and tar transport methods.  The
 597   CGI script checks for old names for backward compatibility.
 598
 599 * Major changed to Backup_dump to support new tar transport.  All transport
 600   specific code moved into BackupPC::Xfer::Smb and BackupPC::Xfer::Tar
 601   objects.
 602
 603 * Added workaround for a bug in Samba's smbclient for files between 2GB
 604   and 4GB.  The file size in the tar header is incorrect.  This allows
 605   files up to 4GB to work with smbclient, rather than 2GB.  To support
 606   files larger than 2GB you must make sure perl is compiled with the
 607   uselargefiles option (use "perl -V | egrep largefiles" to check) and
 608   the pool directory must be on a file system that supports large files.
 609
 610 * Moved the pool writing code into a module BackupPC::PoolWrite.  This
 611   allows the clever file pool checking (digest, uncompressing, comparing
 612   etc with minimum disk IO) to be used easily in multiple places (eg: it
 613   is now used for writing attribute files so they can be pooled).
 614
 615 * Changed MD5 to Digest::MD5 to avoid use of the depreceated MD5 module.
 616
 617 * Shortened default $Conf{MyPath} so that perl's taint mode is more likely
 618   to be happy.  The old $Conf{MyPath} contained /usr/local/bin, which
 619   on one user's machine was world writable and perl -T correctly
 620   complained about it.
 621
 622 * Fixed ping command options in Lib.pm so that it works on OpenBSD.
 623   Thanks to Kyle Amon for sending the fix.  Decided to move the
 624   ping options from Lib.pm into config.pl (as $Conf{PingArgs}) and
 625   now configure.pl tries to come up with a sensible default based on
 626   the OS.
 627
 628 * Fixed argument checking in BackupPC_tarExtract to allow '$' in the
 629   share name (eg: C$).  Thanks to Jules Agee for this fix.  Also
 630   changed the default config.pl so that single quotes are used
 631   everywhere so that people don't get tripped up putting '$' inside
 632   double-quoted strings.
 633
 634 #------------------------------------------------------------------------
 635 # Version 1.03, 9 Dec 2001
 636 #------------------------------------------------------------------------
 637
 638 * BackupPC now has full support for compression.  There are now two
 639   pool areas, the original pool for uncompressed files, and cpool for
 640   compressed files. The compression is done by Compress::Zlib.
 641   Compression reduces the pool disk usage by around 40%, although your
 642   mileage may vary.  Compression is optional and can also be specified on
 643   a per-PC basis (although this will cost more pool storage since many
 644   backup files will have to be stored in both compressed and
 645   uncompressed forms.
 646
 647 * A new script, BackupPC_compressPool, can be run to compress the entire
 648   pool.  This is used once to migrate all the pool data from uncompressed
 649   to compressed on existing installations.  Read the documentation
 650   (Installing BackupPC/Compressing an existing pool) before running
 651   BackupPC_compressPool!
 652
 653   Alternatively, compression can simply be turned on and all new backups
 654   will be compressed. Both old (uncompressed) and new (compressed)
 655   backups can be browsed and viewed. Eventually, the old backups will
 656   expire and all the pool data will be compressed.  However, until the
 657   old backups expire, this approach could require 60% or more additional
 658   pool storage space to store both uncompressed and compressed versions
 659   of the backup files.
 660
 661 * Significant improvements to the cgi interface, BackupPC_Admin:
 662
 663     - much better layout navigation
 664     - handles compressed backup files and compressed log files
 665     - handles unfilled incremental dumps
 666     - better backup directory browsing navigation
 667     - reports compression statistics
 668     - $Conf{CgiDateFormatMMDD} allows you to set date format (MM/DD or DD/MM)
 669     - Additional customization with $Conf{CgiHeaderFontType},
 670       $Conf{CgiHeaderFontSize}, $Conf{CgiNavBarBgColor}, and
 671       $Conf{CgiHeaderBgColor}.
 672
 673 * Eliminated BackupPC_queueAll.  BackupPC directly reads the hosts
 674   file and queues the PCs itself.  Like config.pl, BackupPC will
 675   re-read the hosts file on each wakeup if its modification time
 676   changes, or upon a SIGHUP.  This also makes for better behavior
 677   when adding a host: if you add hosts, simply send a SIGHUP to
 678   BackupPC or wait for the next wakeup.
 679
 680 * BackupPC_dump now compresses the SmbLOG file if compression is enabled.
 681
 682 * BackupPC_dump keeps track of compressed file sizes so that compression
 683   statistics can be reported by the cgi interface.
 684
 685 * Aging of old log files now handles compressed log files (.z extension).
 686
 687 * Added configuration option $Conf{IncrFill} to specify whether
 688   incremental dumps should be filled in.  Old behavior was that
 689   filling was on.  Now it's optional.  See config.pl for more
 690   details.
 691
 692 * BackupPC_nightly now cleans and generates statistics for both
 693   the uncompressed pool and compressed pool (cpool).
 694
 695 * Added new utility script BackupPC_zcat that can be used to
 696   uncompresses BackupPC files.
 697
 698 * configure.pl offers various options related to compression,
 699   depending upon whether this is a new install or upgrade,
 700   and whether or not Compress::Zlib is installed.
 701
 702 * configure.pl now makes a backup copy of config.pl before
 703   config.pl is updated.
 704
 705 * added three new fields to the backups file to handle optional
 706   filling and compression stats.
 707
 708 * Added -e option to BackupPC_dump.  BackupPC now invokes BackupPC_dump -e
 709   on each dhcp host once each night to verify that very old backups are
 710   expired.  This ensures that very old backups are expired even if
 711   the dhcp host has not been on the network for a long time.
 712
 713 * fixed bug in BackupPC::FileZIO.pm that required Compress::Zlib,
 714   even if compression was off.  Thanks to Steve Holmes for reporting
 715   this.
 716
 717 * fixed bug that caused a BackupPC queue to get blocked when a backup
 718   cancel attempt was made during the BackupPC_link phase.
 719
 720 #------------------------------------------------------------------------
 721 # Version 1.02, 28 Oct 2001.
 722 #------------------------------------------------------------------------
 723
 724 * Added new script BackupPC_tarExtract to extract the smbclient tar
 725   archive. This reduces disk writes by perhaps 90-95% and disk reads by
 726   50%. Previously, tar was used to extract and write everything to disk.
 727   Then BackupPC_dump would read enough of each file to compute the MD5
 728   digest, and then compare the full file with candidate pool files.  So
 729   for each 1MB file that matches a single file in the pool, there would
 730   be 1MB of disk writes and 2MB of disk reads (to compare two 1MB files).
 731
 732   BackupPC_tarExtract instead extracts the archive using a 1MB memory
 733   buffer.  This allows the MD5 digest to be computed without touching the
 734   disk.  Next, any potential pool file compares are done by comparing the
 735   pool file against the incoming tar data in memory, which only requires
 736   the pool file to be read.  So for each 1MB file that matches a single
 737   file in the pool, there are now no disk writes, and only 1MB of reads.
 738   BackupPC_tarExtract handles arbitrary size files and repeated
 739   potential pool matches.  If the incoming file doesn't match the pool
 740   then it is written to disk (once the pool is mature this happens maybe
 741   5-10% of the time).
 742
 743 * Substantial changes to BackupPC_dump:
 744
 745     + BackupPC_tarExtract is now used in place of tar.
 746
 747     + BackupPC_dump now reads the output from both smbclient and
 748       BackupPC_tarExtract and merges them into SmbLOG.
 749
 750     + Named pipes are no longer used to connect smbclient to tar
 751       (now BackupPC_tarExtract).  Regular pipes are used instead.
 752       This avoids the need to system mknod or mkfifo.
 753
 754     + Locked files on the client that can't be read by smbclient
 755       previously were filled with 0x0 bytes by smbclient, meaning
 756       tar extracted a useless file filled with 0x0 bytes.  Now,
 757       BackupPC_dump watches the output of smbclient and removes
 758       any files that smbclient couldn't read.  This avoids storing
 759       useless files.  It tries to replace such files with a hard link
 760       to a previous dump.  These actions appear in the log file.
 761
 762 * added new module lib/BackupPC/FileZIO.pm. This handles pool file
 763   I/O and is used by BackupPC_tarExtract.  BackupPC::FileIO supports
 764   reading and writing compressed and regular files and provides all the
 765   hooks for compression support in BackupPC (should be supported in next
 766   version). BackupPC::FileIO also does efficient writing of files that
 767   contain leading 0x0 bytes (by seeking past the 0x0 bytes). This is
 768   helpful when smbclient reads a locked file, and it fills the tar
 769   output with a file of the correct size but all 0x0.  Such files will be
 770   later removed by BackupPC_dump.  But in the meantime, BackupPC::FileIO
 771   writes such files efficiently (as sparse files), meaning just a few
 772   blocks of disk space will be needed even if the file is large.
 773
 774 * alive/dead counting for blackout now works correctly for DHCP hosts.
 775
 776 * BackupPC resets activeJob on startup, to fix bug when BackupPC was
 777   killed and restarted with backups running.
 778
 779 * added extra non blocking select() in BackupPC to make sure the socket
 780   reads don't block.
 781
 782 * BackupPC avoids queuing multiple BackupPC_queueAll's on the CmdQueue.
 783
 784 * Updated BackupPC_sendEmail to correctly parse the locked file
 785   error from 2.2.1a smbclient, so that missing Outlook file emails
 786   can be correctly sent.
 787
 788 * Changed HostInfoRead() in lib/BackupPC/Lib.pm to lowercase the
 789   hostname read from the hosts file.
 790
 791 * BackupPC_Admin provides general summary when the host name is empty.
 792
 793 * configure.pl (and BackupPC) now requires perl 5.6.0 or later.
 794
 795 * configure.pl complains if BackupPC is already running, reminding you
 796   to stop it before upgrading.
 797
 798 * updated documentation, and fixed auto-insertion of config.pl into
 799   BackupPC.pod (previously the last config parameter was left out of
 800   BackupPC.pod).
 801
 802 #------------------------------------------------------------------------
 803 # Version 1.01, 30 Sep 2001
 804 #------------------------------------------------------------------------
 805
 806 * Documentation cleanup in README, doc/BackupPC.pod, conf/config.pl.
 807
 808 * BackupPC_sendMail now reads the optional per-PC config file, allowing
 809   email configuration parameters to be set on a per-PC basis.
 810
 811 * Removed the unused 4096-length MD5 digest code in lib/BackupPC/Lib.pm.
 812
 813 #------------------------------------------------------------------------
 814 # Version 1.00, 21 Sep 2001
 815 #------------------------------------------------------------------------
 816
 817 * Initial release of BackupPC on sourceforge.net.