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