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