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