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 * Add config file editing.
26 * Added Portuguese Brazillian pt_br.pm from Reginaldo Ferreira.
28 * Added Slackware init.d script from Tony Nelson.
30 * Fixed error reporting when restore/archive fail to write the
31 request file to the client directory.
33 * Applied patch from Marc Prewitt for DumpPreShareCmd and DumpPostShareCmd.
35 * Apply patch from Pete Wenzel to add smbClientPath => $Conf{SmbClientPath}
36 to DumpPreUserCmd etc.
38 * Applied Lorenzo Cappelletti's it.pm patch.
40 * Applied patch to bin/BackupPC_sendEmail from Marc Prewitt that
41 ignores any file starting with "." in the pc directory when
42 it is generating warnings about old/unused files/directories.
44 * Applied patch from Marc Prewitt to fix host queue order.
46 * Add NT_STATUS_FILE_LOCK_CONFLICT to pst read error check in
47 BackupPC_sendEmail to fix bug reported by Dale Renton.
49 * Fixed simple but serious bug in bin/BackupPC_tarCreate that prevented
50 hardlinks being saved correctly. Debugged by Michael (mna.news) with
53 * Fixed serious bug in bin/BackupPC_dump reported/debugged by Dan
54 Niles that can happen when multiple full backups are deleted after
55 $Conf{FullKeepCnt} is changed.
57 * Added fixup of $ENV{REMOTE_USER} to lib/BackupPC/CGI/Lib.pm in the
58 case of using mod_authz_ldap; patch submitted by Alain Perrier.
60 * Added env LC_ALL=C to $Conf{TarClientCmd} and $Conf{TarClientRestoreCmd}
61 to avoid locale problems, suggested by Ludovic Drolez.
63 * Changed ping output parsing to pick out average rtt time, based
64 on patch from Ron Bickers.
66 * Changed lib/BackupPC/CGI/Lib.pm so that link to "$TopDir/conf/$host.pl"
67 is displayed if it exists. Patch from Andreas Vögele.
69 * Applied daemonize patch to bin/BackupPC from:
70 http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=301057
72 * It's now a fatal error if $Conf{CompressLevel} is set, but
73 Compress::Zlib is not found. Before $Conf{CompressLevel} was
74 silently set to 0, which made all the backups uncompressed.
75 That meant the user never knew if they forget to install
76 Compress::Zlib but were expecting compression to be on.
78 * Finally increased $Conf{ClientTimeout} to 72000 (20 hours).
80 * Fixed minor documentation typos from Richard Ames, JP Vossen.
82 * Changed bin/BackupPC_archiveHost to use /bin/csh instead of
83 /bin/sh. That way any errors in the pipeline are reported
84 via the exit status, instead of just the last.
86 * Added sleep 1 in restart() function in init.d/src/gentoo-backuppc,
87 suggested by Jon Hood.
89 * Added $DestDir to the path of the CGI image directory in configure.pl.
90 Patch submitted by Andreas Vögele.
92 * Added $Conf{EMailHeaders} for additional email headers, requested
95 * Made shareName argument regexp checking more general to allow parens.
97 * Applied extensive patch to French translation from Frederic Lehobey.
99 * Minor change to Dutch language $Lang{Pool_Stat} from Wander Winkelhorst.
101 * Minor change to French language $Lang{EMailOutlookBackupMesg} and
102 $Lang{EMailOutlookBackupSubj} from Ludovic Gasc.
104 #------------------------------------------------------------------------
105 # Version 2.1.0pl1, 15 Aug 2004
106 #------------------------------------------------------------------------
108 * Added fix to nl.pm from Lieven Bridts.
110 * Added patch from Tony Nelson to remove $Info{pid} before BackupPC
111 writes the status and shuts down.
113 * Changed BackupPC_nightly so that it doesn't call find() if the
114 directory doesn't exist. This avoids errors in certain versions
115 of perl. Reported by Bernd Rilling.
117 * Fixed BackupPC::CGI::Lib to correctly re-load config.pl for mod_perl.
118 Reported by Tony Nelson and Jimmy Liang.
120 * Explicitly untaint $In{host} in BackupPC::CGI::Lib to fix problem
121 reported by Thomas Tempé.
123 * Added newline to "...skipping because of user requested delay..."
124 log message in BackupPC_dump. Reported by Wayne Scott.
126 * Added read file size error checking to BackupPC_tarCreate.
127 Reported by Brandon Evans.
129 * Added check in BackupPC::Xfer::RsyncFileIO to ensure that when
130 compression is toggled on/off, a compressed backup doesn't link
131 to an uncompressed pool file (and an uncompressed backup doesn't
132 link to a compressed pool file). Reported by Brandon Evans.
134 * Updated documentation with new dirvish URL and a typo from
137 * Fix to BackupPC_sendEmail so that it correctly sends admin emails
138 for hosts that have failed backups. Reported by Simon Kuhn.
140 #------------------------------------------------------------------------
141 # Version 2.1.0, 20 Jun 2004
142 #------------------------------------------------------------------------
144 * Added Dutch translation from Lieven Bridts, with tweaks from
147 * Added PC-specific config file read in CGI/Archive.pm. Patch
150 * Added non-zero exit code to BackupPC_zcat when uncompress fails.
151 Patch from Pete Wenzel.
153 * Cosmetic changes to PC Summary and Log file language strings from
156 * BackupPC::Lib tries to be more careful when renaming the backups
157 file to backups.old. There have been reports of backups being
158 empty, perhaps when the BackupPC data file system fills up.
159 Now backups is not renamed to backups.old if backups is empty.
161 * BackupPC now closes stderr and stdout before renaming and
162 re-opening the log file.
164 * Pre/post backup/restore/archive commands now correctly set
165 "type" to either incr/full/restore/archive, and now cmdType
166 is the type of Pre/post backup/restore/archive command.
168 * BackupPC_archive correctly terminates archive processes on
171 * Updates to BackupPC_stnd.css with absolute font sizes instead
174 * BackupPC_dump now makes sure that the $Conf{FullAgeMax} check
175 also ensures the full backup is older than the maximum age
176 expected from $Conf{FullPeriod}.
178 #------------------------------------------------------------------------
179 # Version 2.1.0beta2pl1, 30 May 2004
180 #------------------------------------------------------------------------
182 * Fixed bug in rsync checksum caching code in BackupPC::Xfer::RsyncDigest.
184 * BackupPC_zipCreate now ensures the earliest mtime is 1/1/1980,
185 since zip file formats don't support earlier dates. Reported
188 * CGI restore via zip and tar now makes sure stderr is ignored
189 when BackupPC_tarCreate and BackupPC_zipCreate are run.
190 Previously any stderr output would get mixed in the archive,
191 corrupting it. Reported by Dan Niles.
193 #------------------------------------------------------------------------
194 # Version 2.1.0beta2, 23 May 2004
195 #------------------------------------------------------------------------
197 * $Conf{BackupFilesOnly} and $Conf{BackupFilesExclude} now apply
198 to every share, rather than just the first, in the case where
199 they are arrays and there are multiple shares. Suggested
202 * On the phase 2 retry pass with rsync, verify the cached checksums
203 if checksum caching is turned on. This will catch the case of
204 cached checksums being incorrectly appended to the compressed
205 pool file. Added new config parameter $Conf{RsyncCsumCacheVerifyProb}
206 so that cached checksums are verified with a selectable probability.
207 Also, increased File::RsyncP version number to 0.51.
209 * configure.pl now supports an optional batch mode. Command-line
210 options are used to specify all the information that configure.pl
211 needs. This is useful for building auto-install packages.
212 Also, configure.pl now includes pod documentation, so you can do
213 "perldoc configure.pl" to see all the command-line options.
214 Suggested, tested and tweaked by Stuart Herbert for possible
217 * At each wakeup, clients are now queued based on how old the most
218 recent backup is. Clients with errors are queued first, with
219 the oldest error times going first. The rest of the clients are
220 queued next, with the clients with the oldest backup going first.
221 Previously the clients were simply queued in alphabetic order.
222 Suggested by Mike Trisko and Tony Nelson.
224 * Added config parameter $Conf{PartialAgeMax} that controls whether
225 partials are saved at all, and if so, whether the partial will be
226 ignored at the next full backup if it is too old.
228 * BackupPC_tarExtract now allows empty archives without reporting
229 an error. Reported by Don Silvia.
231 * Removed Browse Backups link from Nav Bar in Archive Info display.
232 Reported by Ralph Paßgang.
234 * Fixed documentation display for regular users. Reported by Ralph Paßgang.
236 * Status and PC Summary now work for regular users and only show
237 that user's hosts. Server general status information only appears
238 for admins. Suggested by Ralph Paßgang.
240 * Moved the last three navigation-bar links (docs, FAQ and SF) to
241 a new config parameter $Conf{CgiNavBarLinks}. This allows
242 these links to be locally configured. Based on a patch
243 submitted by Ralph Paßgang.
245 * Allow the navigation bar search box to be disabled by
246 setting $Conf{CgiSearchBoxEnable} to 0. Based on a patch
247 submitted by Ralph Paßgang.
249 * Updates to de.pm from Ralph Paßgang.
251 * Made the BackupPC icon a link to the SF BackupPC project page.
253 #------------------------------------------------------------------------
254 # Version 2.1.0beta1, 4 Apr 2004
255 #------------------------------------------------------------------------
257 * The CSS definition has been removed from the config.pl file and
258 is now a separate file, BackupPC_stnd.css. A new config variable,
259 $Conf{CgiCSSFile}, gives the name of the CSS file to use.
260 Suggested by Ender Mathias.
262 * Fixed the filling of the host name select box for admins.
263 The default $Conf{CgiNavBarAdminAllHosts} is now 1.
264 Reported by Doug Lytle.
266 * Cleaned up warning message for restore using rsync when checksum
267 caching is on, but when file didn't have cached checksums.
269 * Fixed BackupPC_archiveHost to support par2 (par2cmdline).
270 Patch submitted by Jaco Bongers and adapted by Josh Marshall.
272 * Improved stat() usage in BackupPC_nightly, plus some other cleanup,
273 giving a significant performance improvement. Patch submitted by
276 * Allow several BackupPC_nightly processes to run in parallel based
277 on new $Conf{BackupPCNightlyJobs} setting. This speeds up the
278 traversal of the pool, reducing the overall run time for
281 * Allow BackupPC_nightly to split the pool traversal across several
282 nightly runs. This improves the running time per night, at the expense
283 of a slight increase in disk storage as unused pool files might not
284 be deleted for a couple of days. Controller by new config setting
285 $Conf{BackupPCNightlyPeriod}.
287 #------------------------------------------------------------------------
288 # Version 2.1.0beta0, 20 Mar 2004
289 #------------------------------------------------------------------------
291 * A failed full dump is now saved as a partial (incomplete) dump,
292 provided it includes some files. This can be used for browsing,
293 restoring etc, and will also form the basis of resuming full
294 dumps. Only one partial is kept, and it is removed as soon
295 as a successful full (or a new partial) is done.
297 * Added support for resuming a full dump for rsync. The partial
298 full is kept, and to resume an incremental is done against the
299 partial, and a full is done for the rest.
301 * Added support for Rsync checksum caching. Rsync checksum are
302 appended to the compressed pool files. This means that block
303 and file checksums do not need to be recomputed on the server
304 when using rsync. Requires a patch to rsync to support fixed
305 checksum seeds. This patch is included in the cygwin-rsyncd
306 release on http://backuppc.sourceforge.net.
308 * Major addition of Archive feature from Josh Marshall. Special
309 clients can be configured to be archive targets (eg: tape drives,
310 CD-R). Any subset of the backup clients can be selected and tar
311 archives are created, optionally compressed and split and written
312 to the output device. Logs are maintained and are browsable.
314 * Major changes from Ryan Kucera to add style sheets to the CGI
315 interface, allowing easy customization. Added new icons and
316 BackupPC logo. Numerous navigation improvements.
318 * Added directory history display to BackupPC_Admin, allowing the
319 user to quickly see which files changed between backups on a
322 * Added exponential expiry option for full dumps. This allows you
325 - how many fulls to keep at intervals of $Conf{FullPeriod}, followed by
326 - how many fulls to keep at intervals of 2 * $Conf{FullPeriod},
327 - how many fulls to keep at intervals of 4 * $Conf{FullPeriod},
328 - how many fulls to keep at intervals of 8 * $Conf{FullPeriod},
329 - how many fulls to keep at intervals of 16 * $Conf{FullPeriod},
331 and so on. This allows you, for example, to keep 4 weekly fulls,
332 followed by 6 fulls every 4 weeks (approx 1 month) and 2 fulls at
333 16 weeks, for roughly 1 year of history. This works by deleting
334 every other full as each expiry boundary is crossed. Suggested
337 * Added Italian language translation it.pm from Lorenzo Cappelletti.
339 * Major updates to language files for new features and tags changes.
340 Updated makeDist to do pedantic consistency checking of language
343 * Addition of administration options from Paul Lukins. Initial
344 page allows server to be started/stopped/reloaded. This still
345 needs some i18n work. Currently the server start/stop is
348 * Split BackupPC_Admin into a set of modules, one for each major action.
349 Each action is now a seperate module in lib/BackupPC/CGI.
351 * Allow the blackout period begin/end to span midnight. Adapted
352 from patch submitted by David Smith.
354 * Allow multiple blackout periods, with new config variable
355 $Conf{BlackoutPeriods} that replaces the old variables
356 $Conf{BlackoutHourBegin}, $Conf{BlackoutHourEnd}, and
357 $Conf{BlackoutWeekDays}. Based on patch submitted by
360 * Disabled alarms after forks to avoid timeouts in children that
361 do not reset their alarm. Prompted by ideas from James Leu.
363 * Added options for block size, buffer size and share wild-card to
364 BackupPC_tarCreate. Also added negative backup number options
365 that are relative to the last (so -1 is the last), suggested by
366 William McKee and Carl Soderstrom.
368 * The "Wrong user" message in BackupPC::Lib now goes to stderr, so that
369 the user is more likely to see the error with BackupPC_tarCreate.
370 Reported by Paul Fox.
372 * Add creation of per-PC directory in BackupPC/CGI/Restore.pm in
373 case it doesn't already exist.
375 * Added -q -x to all ssh commands in conf/config.pl. Suggested by
376 SI Reasoning and Niranjan Ghate.
378 * Changed restore code so that option #1 (direct restore) can be
379 disabled if the restore command is undefined. Disabling direct
380 restore is necessary if the share is read-only. Suggested by
383 * Changed regexp in lib/BackupPC/Smb.pm to allow numbers with both
384 a decimal point or comma for international versions of Samba.
385 Patch submitted by Frank Gard.
387 * Browsing and directory history now sort the files in a
388 case-insensitive manner.
390 * Changed exec() syntax to allow executing commands whose path
393 * BackupPC_dump no longer removes backups if $Conf{FullKeepCnt}
394 is zero or undefined. The protects the existing backups in the
395 case of a bad config.pl file. Suggested by Christian Warden.
397 * Swapped the Server and Hosts sections on the Nav bar. Moved the
398 host search text box to the top of the hosts section. This was
399 done to move the variable-length part of the Nav bar (when all
400 hosts are displayed) to the bottom.
402 * Fixed a bug in tar restore related to how the common prefix path is
403 removed. Now ensure that the common path is at a directory boundary.
404 Reported by Patrick Neuner.
406 * Added --chuid ${USER} to init.d/src/gentoo-backuppc. Suggested by
407 SI Reasoning, Pascal Pochol, Michael Evanoff and others.
409 * Added Suse notes to init.d/README from Bruno Vernay.
411 * Added Apache 2 documentation fix from Michael Tuzi.
413 #------------------------------------------------------------------------
414 # Version 2.0.2, 6 Oct 2003
415 #------------------------------------------------------------------------
417 * Fixed stupid last-minute change in octal size conversion in
420 #-----------------------------------------------------------------------
421 # Version 2.0.1, 5 Oct 2003
422 #------------------------------------------------------------------------
424 * Fixed handling of >= 8GB files in BackupPC_tarExtract and >= 4GB
425 files in BackupPC_tarCreate.
427 * Removed smbclient size repair in BackupPC_tarExtract for files
428 between 2GB and 4GB. This means that BackupPC_tarExtract 2.0.1
429 doesn't behave the same as 2.0.0 for file sizes between 2GB and 4GB
430 extacted using smbclient 2.2.x. If you have problems backing up
431 files whose size is between 2GB and 4GB using smbclient 2.2.x
432 you should upgrade smbclient to 3.0, since it now generates
435 * Replace PingClientPath with PingPath in configure.pl.
437 * Removed -T (taint mode) on binaries installed in configure.pl.
439 * Added support for smbclient from samba version 3.0.0.
441 * Fixed $Conf{HardLinkMax} limit check in BackupPC::Lib; reported
444 * In BackupPC_Admin, default REMOTE_USER to $Conf{BackupPCUser}
445 if it is not defined. This allows the CGI interface to work
446 when AdminUsers = '*'. Reported by Quentin Arce.
448 * For SMB, code that detected files with a read-locked region (eg:
449 outlook .pst files), removed them and then tried to link with an
450 earlier version was broken. This code missed a step of mangling
451 the file names. This is now fixed. Reported by Pierre Bourgin.
453 * A backup of a share that has zero files is now considered
454 fatal. This is used to catch miscellaneous Xfer errors that
455 result in no files being backed up. A new config parameter
456 $Conf{BackupZeroFilesIsFatal} (defaults to 1) and can be set to
457 zero to turn off this check. Suggested by Guillaume Filion.
458 Additional change: this check only applies to a full dump.
460 * SMB: now detect NT_STATUS_ACCESS_DENIED on entire share or BackupFilesOnly
461 (also ERRDOS - ERRnoaccess (Access denied.) for older versions of
462 smbclient.) Suggested by Guillaume Filion.
464 * SMB: now detects "tree connect failed: NT_STATUS_BAD_NETWORK_NAME" and
465 the dump is considered failed.
467 * Rsync: Previously BackupFilesOnly = '/' did --include '/' --exclude '/*',
468 which just included the '/' directory and nothing below. Now it
469 does just --include '/', which should include everything.
472 * Add hostError to DumpPostUserCmd variable substitutions for both dump
475 * Verbose output in Lib.pm goes to STDERR, not STDOUT. This now
476 makes BackupPC_dump -v work better.
478 * Don't allow browsing with ".." in directory in case a user tries
479 to trick BackupPC_Admin into displaying directories outside where
482 * Required File::RsyncP version is now 0.44, since File::RsyncP 0.44
483 fixes large file (>2GB) bugs. Large file bugs reported by Steve
486 #------------------------------------------------------------------------
487 # Version 2.0.0, 14 Jun 2003
488 #------------------------------------------------------------------------
490 * Minor tweaks to disable utf8 on utf8-capable machines (eg: RH8+).
491 Added "no utf8" to all programs, and added binmode() to relevant
494 #------------------------------------------------------------------------
495 # Version 2.0.0beta3, 1 Jun 2003
496 #------------------------------------------------------------------------
498 * Several improvements to restore: cancel now reports the correct
499 message and cleans up correctly.
501 * Rsync with whitespace and wildcard excludes fixed by replacing
502 argList with argList+ in config.pl plus a fix to Lib.pm for
503 shell escaping array arguments.
505 * Fixed rsync restore for character and block special devices
506 (major and minor device numbers weren't correctly restored).
508 * Fixed typo in bin/BackupPC_restore (XferLOG -> RestoreLOG).
510 * (Re)-fixed "Bad command" in log file when restore via tar or zip
511 file download is done.
513 * Added untaint to exec in Lib.pm to avoid tainted errors.
515 * Applied additional tweak to hilight patch from Tim Demarest.
517 * $Conf{CgiAdminUsers} = '*' now allows privileged even with REMOTE_USER
520 * Don't display RsyncdPasswd when displaying config.pl files.
522 * Replace pipe with socketpair in bin/BackupPC_dump and bin/BackupPC_restore,
523 which increases typical buffering from 4K to 16K-64K. This improves the
526 * Add check on $ENV{LANG} setting do configure.pl: if LANG includes utf
527 then a warning is printed.
529 #------------------------------------------------------------------------
530 # Version 2.0.0beta2, 11 May 2003
531 #------------------------------------------------------------------------
533 * Added German translation, provided by Manfred Herrmann.
535 * Fixed large-file problem with rsync, reported by Manfred Herrmann.
537 * Fixed zip and tar file download from CGI under mod_perl. Reported
538 by Pierre Bourgin and Paul Lukins.
540 * Fixed directory browsing and top-level directory browsing in 2.0.0beta0.
541 Reported by several users.
543 * Added -v option to BackupPC_dump for verbose output (useful when
544 you run the command manually). Added messages for all exits.
546 * If nmblookup returns multiple IP addresses, NetBiosHostIPFind()
547 now returns the first IP address that matches the subnet mask.
548 Suggested by Tim Demarest.
550 * Fixed BackupPC::View so the top-level directory is handled correctly.
551 This allows the top-level share/directory to be restored via the
552 CGI interface. Reported by several users.
554 * Fixed RsyncFileIO failures on certain large files by replacing seek()
555 with sysseek(). Reported by Manfred Herrmann.
557 * Added configurable highlighting of PC status in the CGI summary
558 screen; submitted by Tim Demarest.
560 * Fixed command queue CGI display; submitted by Tim Demarest.
562 * BackupPC_trashClean now logs an error if it can't remove all the
563 trash and then goes back to sleep, rather than continually trying.
565 * Moved correct user (uid) check into BackupPC::Lib so that all
566 applications do a user check if $Cong{BackupPCUserVerify} is
567 set. The avoids the risk of manually running BackupPC_dump as
570 * Loss of blackout now applies to "host not found" as well as no ping.
571 Reported by Dale Renton.
573 * "Host not found" is now treated in a similar manner to "no ping".
575 * Added suse-linux init.d script from Leon Letto.
577 * Added Gentoo linux init.d script from Tim Demarest.
579 * Applied additional i18n strings from GFK and the translation team.
581 * Fixed option parsing so that getopts errors are reported and we exit.
583 * Changed reporting of Xfer PIDs so that rsync cancel works correctly.
585 #------------------------------------------------------------------------
586 # Version 2.0.0beta1, 30 Mar 2003
587 #------------------------------------------------------------------------
589 * Added Spanish translation es.pm from Javier Gonzalez.
591 * Fixed CGI browse navigation bug that causes BackupPC_Admin to wedge
592 when directories were selected in a certain order.
594 * Fixed BackupPC::PoolWrite so that it can recover when the initial
595 file size is wrong. This is needed since rsync could write a file
596 whose size is different from the initial size returned in the
597 file list when that file is updated while rsync is running.
599 * Added binmode(STDIN) to BackupPC_tarExtract, suggested by Pat LoPresti
600 to fix a problem a RedHat8 with perl 5.8.0. It's unclear why this
601 helps, but it should be benign. See:
602 http://sourceforge.net/mailarchive/forum.php?thread_id=1853018&forum_id=503
604 #------------------------------------------------------------------------
605 # Version 2.0.0beta0, 23 Feb 2003
606 #------------------------------------------------------------------------
608 * Support for rsync and rsyncd backup and restore. Changes to
609 BackupPC_dump, BackupPC_restore, and new modules BackupPC::Xfer::Rsync
610 and BackupPC::Xfer::RsyncFileIO.
612 * Added internationalization (i18n) code from Xavier Nicollet,
613 with additions from Guillaume Filion. Voila! BackupPC_Admin
614 now supports English and French, and adding more languages is
615 now easy. New config paramater $Conf{Language} sets the language.
617 * Added optional user-defined pre/post dump/restore commands, allowing
618 things like database shutdown/startup for dumps.
620 * Changed the way hosts are found.
622 * Added $Conf{ClientNameAlias}, which allows the name of the physical
623 client machine to be set. This allows several different backup
624 "hosts" to all refer to the same physical machine, which is
625 convenient if several different types of data need to be backed
626 up, or if different parameters are needed for different parts of
629 * Replaced $Conf{PingArgs} with $Conf{PingCmd}, added $Conf{DfCmd},
630 $Conf{NmbLookupCmd} allowing all these commands to be fully
631 configured. Also, all commands can also now be fragments of
634 * Moved all smbclient commands into the config.pl file so the specific
635 arguments can be customized. New config parameters are
636 $Conf{SmbClientFullCmd}, $Conf{SmbClientIncrCmd} and
637 $Conf{SmbClientRestoreCmd}.
639 * Added new BackupPC::View module that creates views of backups
640 (handling merging etc). Updated BackupPC_Admin, BackupPC_zipCreate
641 and BackupPC_tarCreate to use BackupPC::View. This removes lots
642 of merging and mangling code from the higher-level code.
644 * Added code from Toby Johnson that allows additional users to be
645 specified in the hosts file; these users can also view/start/stop
646 and restore backups for that host. Also added a new config
647 setting $Conf{CgiNavBarAdminAllHosts} that allows all hosts to
648 be listed in the left nav bar for admins.
650 * Added $Conf{HardLinkMax} (default 31999) which sets the limit on
651 the maximum number of hardlinks per file in the pool. If a file
652 ever gets to this number of links a new pool file is created to
653 handle additional links.
655 * Added $Conf{PerlModuleLoad}, which allows optional additional perl
656 modules to be loaded.
658 * Added $Conf{EMailUserDestDomain} and other EMail config settings to
659 allow language-specific default messages to be overridden.
661 * Added BPC_FTYPE_DELETED to lib/BackupPC/Attrib.pm, allowing deleted
662 files to be represented in the attrib file correctly.
664 * Added support for environment variable BPC_SMB_PASSWD, which is the
665 client's smb password. This overrides the old environment variable
668 * Added taint cleanup for perl5.8 to lib/BackupPC/Lib.pm.
670 * Changed $tar_unpack_header format in BackupPC_tarExtract to correctly
671 handle files with trailing spaces.
673 * Added catching of SIG_PIPE to BackupPC_dump, and changed catch_signal
674 to ignore multiple signals of the same type.
676 * Added reporting of the largest number of hardlinks in the pool to the
679 * Adding reporting of syntax errors in the per-PC config.pl file.
681 * Updated BackupPC_sendEmail to handle language-specific email messages.
683 * Allow client (host) names to contain spaces. Spaces in host names
684 need to be escaped via "\" in the hosts file. The user of spaces in
685 host names is discouraged, but they should work. One feature that
686 doesn't work with host names that contain spaces is the highlighting
687 of that name in the log file display in the CGI interface. There are
688 no plans to fix this.
690 * Renamed $Conf{SmbClientTimeout} to $Conf{ClientTimeout}.
692 * Fixed all open() calls to use 3 argument form to fix handling of file
693 names with trailing whitespace. Also fixed CGI interface so these
694 file names are displayed correctly.
696 * Fixed new 2.0.0 CGI navigation bug that causes the top-level directory
697 to have a URL "&share=//boot&dir=" instead of "&share=/boot&dir=/".
698 Reported by Pascal Schelcher. Fixed similar problem reported by
701 * Added "PerlTaintCheck On" to the mod_perl section in the docs,
702 suggested by Tim Demarest.
704 #------------------------------------------------------------------------
705 # Version 1.5.0, 2 Aug 2002
706 #------------------------------------------------------------------------
708 * Changed conf/config.pl so that $Conf{TarIncrArgs} uses the --newer
709 option instead of --newer-mtime. Also removed --atime-preserve from
710 $Conf{TarClientCmd}. This makes the default settings work better
713 * Fixed configure.pl so it correctly detects a running BackupPC <= v1.4.0
714 so it can correctly warn the user to stop it before upgrading. Reported
717 * Added missing ";" to entity escape in EscapeHTML in BackupPC_Admin.
718 Reported by Guillaume Filion.
720 * Added LDAP setup to documentation from David Holland.
722 * Tar.pm now adds a "." to file paths that start with "/", so that all
723 tar paths are relative. From Ludovic Drolez.
725 #------------------------------------------------------------------------
726 # Version 1.5.0beta0, 30 Jun 2002
727 #------------------------------------------------------------------------
729 * A full set of restore options is now supported, including direct
730 restore via smbclient or tar or downloading a zip or tar file.
732 * Major additions to CGI script to support better directory navigation,
733 restore features and mod_perl. Also, file downloads from the CGI
734 interface now correctly preserve the file name and provide the
735 correct Content-Type for the most common types of files. Improved
736 directory navigation was contributed by Ryan Kucera.
738 * New script BackupPC_zipCreate (contributed by Guillaume Filion) is the
739 zip analog of BackupPC_tarCreate. BackupPC_zipCreate can be used to
740 create a zip archive of any portion of a backup.
742 * Substantial additions to BackupPC_tarCreate to support restore,
743 including modifying path names, handling hardlinks, fixing
744 support of old backups without attributes (pre-v1.4.0). Plus
745 BackupPC_tarCreate is now an offical part of the release.
746 (Lack of support for hardlinks was reported by John Stanley.)
748 * BackupPC_tarExtract now supports hardlinks and fixed pooling of
751 * A unix domain socket is now used for communication between the CGI
752 interface and BackupPC. The original TCP socket is optional. Sockets
753 are correctly re-initialized if config.pl is updated with new socket
756 * For improved security messages over the unix or TCP socket are protected
757 via an MD5 digest based on a shared secret, a sequence number, a time
758 stamp and a unique per-connection number.
760 * Additions to configure.pl to support install of directory navigation
763 * Fixed case where $Conf{BackupFilesOnly} or $Conf{BackupFilesExclude}
764 were set to a single string or list (in v1.4.0 only the case of
765 hash worked correctly). Reported by Phillip Bertolus.
767 * Fixed case of $Conf{BackoutGoodCnt} == 0. This setting now makes the
768 client always subject to blackout, matching the comments in config.pl.
769 Also fixed handling of $Conf{BackoutGoodCnt} < 0 in the CGI script
770 reported by Pascal Schelcher.
772 * Fixed byte and file totals for tar backups, reported by several users.
774 * Fixed --newer-mtime date/timestamp format to make it ISO 8601 compliant,
775 suggested by Erminio Baranzini.
777 * Fixed handling of $Conf{BackupFilesOnly} in BackupPC::Xfer::Tar.pm, as
778 well as shell escaping of tar arguments.
780 * Fixed entity encoding of 8-bit characters in the CGI interface.
782 * Added optional CGI headers in $Conf{CgiHeaders} that by default
783 is set to a no-cache pragma. Suggested by Benno Zuure.
785 #------------------------------------------------------------------------
786 # Version 1.4.0, 16 Mar 2002
787 #------------------------------------------------------------------------
789 * BackupPC now supports tar (in addition to smb) for extracting host
790 data. This is the most convenient option for linux/unix hosts.
791 Tar can be configured to run over ssh, rsh or to backup a local
792 nfs mount from the host.
794 * Support for special files, including symbolic links, fifo, character
795 and block device files has been added, so that all native linux/unix
796 file types can be correctly backed up when using tar transport.
797 Special files are all stored as regular files and the type attributes
798 are used to remember the original file type.
800 * All unix file attributes are now saved (and pooled when possible).
801 This includes user and group ownership, permissions, and modification
802 time. Smbclient also does a reasonable job of emulating unix
803 permissions (such as mtime), and these attributes get saved too.
805 * The new default is to not fill incremental dumps. configure.pl
806 automatically sets $Conf{IncrFill} to 0. The default was 1
807 (incrementals were filled with hardlinks). Since the CGI
808 script does filling at browsing time, there is no need to
809 fill incremental dumps.
811 * Backup file names are now stored in "mangled" form. Each node of a
812 path is preceded by "f", and special characters (\n, \r, % and /) are
813 URI-encoded as "%xx", where xx is the ascii character's hex value. So
814 c:/craig/example.txt is now stored as fc/fcraig/fexample.txt. This
815 was done mainly so meta-data could be stored alongside the backup
816 files without name collisions. In particular, the attributes for the
817 files in a directory are stored in a file called "attrib", and
818 mangling avoids file name collisions (I discarded the idea of having
819 a duplicate directory tree for every backup just to store the
820 attributes). Other meta-data (eg: rsync checksums) could be stored in
821 file names preceded by, eg, "c". There are two other benefits to
822 mangling: the share name might contain "/" (eg: "/home/craig" for tar
823 transport), and I wanted that represented as a single level in the
824 storage tree. Secondly, as files are written to NewFileList for later
825 processing by BackupPC_link, embedded newlines in the file's path
826 will cause problems which are avoided by mangling.
828 The CGI script undoes the mangling, so it is invisibe to the user.
829 Of course, old (unmangled) backups are still supported by the CGI
832 * Various changes to the CGI interface, BackupPC_Admin:
834 + Added button that allows users to manually start a full dump in
835 addition to the existing incremental dump.
837 + Added display of file attributes when browsing backups.
839 + Added an optional holdoff time specified by the user when canceling
840 a backup. BackupPC will not attempt any new backups for at least the
841 specified time. This holdoff time can be changed whether or not a
844 + Added supports for file mangling, and correct merging of unfilled
845 backups from mangled or unmangled (and compressed or uncompressed)
846 fulls when browsing or restoring.
848 + Only displays a "Start Incr Backup" button if there are already some
851 + For DHCP hosts, when a user tries to manually start a backup, add
852 a check for the netbios name of both the host the request came
853 from (REMOTE_ADDR) and the last known DHCP address for that host
854 to see if either address matches the host. If not, an error
855 message is display. The previous behavior was that only requests
856 from the client itself succeeded, and requests from other machines
859 * Changed the version numbering to X.Y.Z, instead of X.0Y. This release
860 is 1.4.0. The first digit is for major new releases, the middle digit
861 is for significant feature releases and improvements, and the last
862 digit is for bug fixes. You should think of the old 1.00, 1.01, 1.02
863 and 1.03 as 1.0.0, ..., 1.3.0.
865 * BackupPC and the CGI script BackupPC_Admin now check that the effective
866 user id is correct to avoid accidentally launching BackupPC as the
867 wrong user or detecting CGI configuration problems. This behavior
868 can be turned off using the $Conf{BackupPCUserVerify} option.
870 * In numerous places changed "Smb" to "Xfer" (eg: log file names) to
871 support generic names for both smb and tar transport methods. The
872 CGI script checks for old names for backward compatibility.
874 * Major changed to Backup_dump to support new tar transport. All transport
875 specific code moved into BackupPC::Xfer::Smb and BackupPC::Xfer::Tar
878 * Added workaround for a bug in Samba's smbclient for files between 2GB
879 and 4GB. The file size in the tar header is incorrect. This allows
880 files up to 4GB to work with smbclient, rather than 2GB. To support
881 files larger than 2GB you must make sure perl is compiled with the
882 uselargefiles option (use "perl -V | egrep largefiles" to check) and
883 the pool directory must be on a file system that supports large files.
885 * Moved the pool writing code into a module BackupPC::PoolWrite. This
886 allows the clever file pool checking (digest, uncompressing, comparing
887 etc with minimum disk IO) to be used easily in multiple places (eg: it
888 is now used for writing attribute files so they can be pooled).
890 * Changed MD5 to Digest::MD5 to avoid use of the depreceated MD5 module.
892 * Shortened default $Conf{MyPath} so that perl's taint mode is more likely
893 to be happy. The old $Conf{MyPath} contained /usr/local/bin, which
894 on one user's machine was world writable and perl -T correctly
897 * Fixed ping command options in Lib.pm so that it works on OpenBSD.
898 Thanks to Kyle Amon for sending the fix. Decided to move the
899 ping options from Lib.pm into config.pl (as $Conf{PingArgs}) and
900 now configure.pl tries to come up with a sensible default based on
903 * Fixed argument checking in BackupPC_tarExtract to allow '$' in the
904 share name (eg: C$). Thanks to Jules Agee for this fix. Also
905 changed the default config.pl so that single quotes are used
906 everywhere so that people don't get tripped up putting '$' inside
907 double-quoted strings.
909 #------------------------------------------------------------------------
910 # Version 1.03, 9 Dec 2001
911 #------------------------------------------------------------------------
913 * BackupPC now has full support for compression. There are now two
914 pool areas, the original pool for uncompressed files, and cpool for
915 compressed files. The compression is done by Compress::Zlib.
916 Compression reduces the pool disk usage by around 40%, although your
917 mileage may vary. Compression is optional and can also be specified on
918 a per-PC basis (although this will cost more pool storage since many
919 backup files will have to be stored in both compressed and
922 * A new script, BackupPC_compressPool, can be run to compress the entire
923 pool. This is used once to migrate all the pool data from uncompressed
924 to compressed on existing installations. Read the documentation
925 (Installing BackupPC/Compressing an existing pool) before running
926 BackupPC_compressPool!
928 Alternatively, compression can simply be turned on and all new backups
929 will be compressed. Both old (uncompressed) and new (compressed)
930 backups can be browsed and viewed. Eventually, the old backups will
931 expire and all the pool data will be compressed. However, until the
932 old backups expire, this approach could require 60% or more additional
933 pool storage space to store both uncompressed and compressed versions
936 * Significant improvements to the cgi interface, BackupPC_Admin:
938 - much better layout navigation
939 - handles compressed backup files and compressed log files
940 - handles unfilled incremental dumps
941 - better backup directory browsing navigation
942 - reports compression statistics
943 - $Conf{CgiDateFormatMMDD} allows you to set date format (MM/DD or DD/MM)
944 - Additional customization with $Conf{CgiHeaderFontType},
945 $Conf{CgiHeaderFontSize}, $Conf{CgiNavBarBgColor}, and
946 $Conf{CgiHeaderBgColor}.
948 * Eliminated BackupPC_queueAll. BackupPC directly reads the hosts
949 file and queues the PCs itself. Like config.pl, BackupPC will
950 re-read the hosts file on each wakeup if its modification time
951 changes, or upon a SIGHUP. This also makes for better behavior
952 when adding a host: if you add hosts, simply send a SIGHUP to
953 BackupPC or wait for the next wakeup.
955 * BackupPC_dump now compresses the SmbLOG file if compression is enabled.
957 * BackupPC_dump keeps track of compressed file sizes so that compression
958 statistics can be reported by the cgi interface.
960 * Aging of old log files now handles compressed log files (.z extension).
962 * Added configuration option $Conf{IncrFill} to specify whether
963 incremental dumps should be filled in. Old behavior was that
964 filling was on. Now it's optional. See config.pl for more
967 * BackupPC_nightly now cleans and generates statistics for both
968 the uncompressed pool and compressed pool (cpool).
970 * Added new utility script BackupPC_zcat that can be used to
971 uncompresses BackupPC files.
973 * configure.pl offers various options related to compression,
974 depending upon whether this is a new install or upgrade,
975 and whether or not Compress::Zlib is installed.
977 * configure.pl now makes a backup copy of config.pl before
978 config.pl is updated.
980 * added three new fields to the backups file to handle optional
981 filling and compression stats.
983 * Added -e option to BackupPC_dump. BackupPC now invokes BackupPC_dump -e
984 on each dhcp host once each night to verify that very old backups are
985 expired. This ensures that very old backups are expired even if
986 the dhcp host has not been on the network for a long time.
988 * fixed bug in BackupPC::FileZIO.pm that required Compress::Zlib,
989 even if compression was off. Thanks to Steve Holmes for reporting
992 * fixed bug that caused a BackupPC queue to get blocked when a backup
993 cancel attempt was made during the BackupPC_link phase.
995 #------------------------------------------------------------------------
996 # Version 1.02, 28 Oct 2001.
997 #------------------------------------------------------------------------
999 * Added new script BackupPC_tarExtract to extract the smbclient tar
1000 archive. This reduces disk writes by perhaps 90-95% and disk reads by
1001 50%. Previously, tar was used to extract and write everything to disk.
1002 Then BackupPC_dump would read enough of each file to compute the MD5
1003 digest, and then compare the full file with candidate pool files. So
1004 for each 1MB file that matches a single file in the pool, there would
1005 be 1MB of disk writes and 2MB of disk reads (to compare two 1MB files).
1007 BackupPC_tarExtract instead extracts the archive using a 1MB memory
1008 buffer. This allows the MD5 digest to be computed without touching the
1009 disk. Next, any potential pool file compares are done by comparing the
1010 pool file against the incoming tar data in memory, which only requires
1011 the pool file to be read. So for each 1MB file that matches a single
1012 file in the pool, there are now no disk writes, and only 1MB of reads.
1013 BackupPC_tarExtract handles arbitrary size files and repeated
1014 potential pool matches. If the incoming file doesn't match the pool
1015 then it is written to disk (once the pool is mature this happens maybe
1018 * Substantial changes to BackupPC_dump:
1020 + BackupPC_tarExtract is now used in place of tar.
1022 + BackupPC_dump now reads the output from both smbclient and
1023 BackupPC_tarExtract and merges them into SmbLOG.
1025 + Named pipes are no longer used to connect smbclient to tar
1026 (now BackupPC_tarExtract). Regular pipes are used instead.
1027 This avoids the need to system mknod or mkfifo.
1029 + Locked files on the client that can't be read by smbclient
1030 previously were filled with 0x0 bytes by smbclient, meaning
1031 tar extracted a useless file filled with 0x0 bytes. Now,
1032 BackupPC_dump watches the output of smbclient and removes
1033 any files that smbclient couldn't read. This avoids storing
1034 useless files. It tries to replace such files with a hard link
1035 to a previous dump. These actions appear in the log file.
1037 * added new module lib/BackupPC/FileZIO.pm. This handles pool file
1038 I/O and is used by BackupPC_tarExtract. BackupPC::FileIO supports
1039 reading and writing compressed and regular files and provides all the
1040 hooks for compression support in BackupPC (should be supported in next
1041 version). BackupPC::FileIO also does efficient writing of files that
1042 contain leading 0x0 bytes (by seeking past the 0x0 bytes). This is
1043 helpful when smbclient reads a locked file, and it fills the tar
1044 output with a file of the correct size but all 0x0. Such files will be
1045 later removed by BackupPC_dump. But in the meantime, BackupPC::FileIO
1046 writes such files efficiently (as sparse files), meaning just a few
1047 blocks of disk space will be needed even if the file is large.
1049 * alive/dead counting for blackout now works correctly for DHCP hosts.
1051 * BackupPC resets activeJob on startup, to fix bug when BackupPC was
1052 killed and restarted with backups running.
1054 * added extra non blocking select() in BackupPC to make sure the socket
1057 * BackupPC avoids queuing multiple BackupPC_queueAll's on the CmdQueue.
1059 * Updated BackupPC_sendEmail to correctly parse the locked file
1060 error from 2.2.1a smbclient, so that missing Outlook file emails
1061 can be correctly sent.
1063 * Changed HostInfoRead() in lib/BackupPC/Lib.pm to lowercase the
1064 hostname read from the hosts file.
1066 * BackupPC_Admin provides general summary when the host name is empty.
1068 * configure.pl (and BackupPC) now requires perl 5.6.0 or later.
1070 * configure.pl complains if BackupPC is already running, reminding you
1071 to stop it before upgrading.
1073 * updated documentation, and fixed auto-insertion of config.pl into
1074 BackupPC.pod (previously the last config parameter was left out of
1077 #------------------------------------------------------------------------
1078 # Version 1.01, 30 Sep 2001
1079 #------------------------------------------------------------------------
1081 * Documentation cleanup in README, doc/BackupPC.pod, conf/config.pl.
1083 * BackupPC_sendMail now reads the optional per-PC config file, allowing
1084 email configuration parameters to be set on a per-PC basis.
1086 * Removed the unused 4096-length MD5 digest code in lib/BackupPC/Lib.pm.
1088 #------------------------------------------------------------------------
1089 # Version 1.00, 21 Sep 2001
1090 #------------------------------------------------------------------------
1092 * Initial release of BackupPC on sourceforge.net.