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