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