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